Made a few adjustments to recently added products code / just tidying up slightly

docs/source/reference/settings.rst

@@ -26,12 +26,20 @@ Default: 604800 (1 week in seconds)
 The time to live for the basket cookie in seconds
 
 OSCAR_IMAGE_FOLDER
----------------------------
+------------------
 
 Default: images/products-fullsize/%Y/%m/ 
 
 The path for uploading images to.
 
+OSCAR_RECENTLY_VIEWED_PRODUCTS
+------------------------------
+
+Default: 5
+
+The number of recently viewed products to store
+
+
 
 Deprecated settings
 ===================

oscar/customer/history_helpers.py

@@ -1,18 +1,18 @@
+import json
+
 from django.dispatch import receiver
 from django.conf import settings
 
 from oscar.services import import_module
-
-import json
-
 product_signals = import_module('product.signals', ['product_viewed'])
-max_products = settings.OSCAR_RECENTLY_VIEWED_PRODUCTS
+
+MAX_PRODUCTS = getattr(settings, 'OSCAR_RECENTLY_VIEWED_PRODUCTS', 5)
 
 # Helpers
 
 def get_recently_viewed_product_ids(request):
     u"""
-    The list of ids of the last products browsed by the user
+    Returns the list of ids of the last products browsed by the user
     
     Limited to the max number defined in settings.py
     under OSCAR_RECENTLY_VIEWED_PRODUCTS.
@@ -22,7 +22,7 @@ def get_recently_viewed_product_ids(request):
         try:
             product_ids = _get_list_from_json_string(request.COOKIES['oscar_recently_viewed_products'])
         except ValueError:
-            # This can occure if something messes up the cookie
+            # This can occur if something messes up the cookie
             pass
     return product_ids
 
@@ -35,11 +35,9 @@ def _update_recently_viewed_products(product, request, response):
     if product.id in product_ids:
         product_ids.remove(product.id)
     product_ids.append(product.id)
-    if (len(product_ids) > max_products):
-        assert False
-        del product_ids[max_products:]
+    if (len(product_ids) > MAX_PRODUCTS):
+        del product_ids[MAX_PRODUCTS:]
     response.set_cookie('oscar_recently_viewed_products', _get_json_string_from_list(product_ids))
-    return
 
 def _get_list_from_json_string(cookie_value):
     u""" Simple function to convert lists to json """

oscar/customer/templatetags/history_tags.py

@@ -1,13 +1,11 @@
 from django import template
 
 from oscar.services import import_module
-
 product_models = import_module('product.models', ['Item', 'ItemClass'])
 history_helpers = import_module('customer.history_helpers', ['get_recently_viewed_product_ids'])
 
 register = template.Library()
 
-
 @register.inclusion_tag('customer/history/recently-viewed-products.html', takes_context=True)
 def recently_viewed_products(context):
     u"""
@@ -16,7 +14,8 @@ def recently_viewed_products(context):
     request = context['request']
     product_ids = history_helpers.get_recently_viewed_product_ids(request)
     product_dict = product_models.Item.browsable.in_bulk(product_ids)
-    u"""Reordering as the id order gets messed up in the query"""
+    
+    # Reordering as the id order gets messed up in the query
     product_ids.reverse()
     products = [product_dict[id] for id in product_ids]
     return {'products': products}

oscar/customer/tests.py

@@ -3,28 +3,21 @@ from django.test.client import Client
 from django.core.urlresolvers import reverse
 from django.http import HttpRequest
 
-from oscar.product.models import Item, ItemClass
 from oscar.customer.history_helpers import get_recently_viewed_product_ids
+from oscar.utils import create_product
 
 class HistoryHelpersTest(unittest.TestCase):
     
     def setUp(self):
         self.client = Client()
-        
-        # Create a dummy product
-        ic,_ = ItemClass.objects.get_or_create(name='Dummy class')
-        self.dummy_product = Item.objects.create(title='Dummy product', item_class=ic)
-        args = {'item_class_slug': self.dummy_product.get_item_class().slug, 
-                'item_slug': self.dummy_product.slug,
-                'item_id': self.dummy_product.id}
-        self.dummy_product_url = reverse('oscar-product-item', kwargs=args)
+        self.product = create_product()
     
     def test_viewing_product_creates_cookie(self):
-        response = self.client.get(self.dummy_product_url)
+        response = self.client.get(self.product.get_absolute_url())
         self.assertTrue('oscar_recently_viewed_products' in response.cookies)
         
     def test_id_gets_added_to_cookie(self):
-        response = self.client.get(self.dummy_product_url)
+        response = self.client.get(self.product.get_absolute_url())
         request = HttpRequest()
         request.COOKIES['oscar_recently_viewed_products'] = response.cookies['oscar_recently_viewed_products'].value
-        self.assertTrue(self.dummy_product.id in get_recently_viewed_product_ids(request))
+        self.assertTrue(self.product.id in get_recently_viewed_product_ids(request))