Updated category creation code.

docs/source/recipes.rst

@@ -10,6 +10,11 @@ Customisation
 * :doc:`recipes/how_to_customise_models`
 * :doc:`recipes/how_to_override_a_core_class`
 
+Catalogue
+---------
+
+* :doc:`recipes/how_to_create_categories.rst`
+
 Checkout
 --------
 

docs/source/recipes/how_to_create_categories.rst

@@ -0,0 +1,17 @@
+========================
+How to create categories
+========================
+
+The simplest way is to use a string which represents the breadcrumbs::
+
+    from oscar.apps.catalogue.categories import create_from_breadcrumbs
+
+    categories = (
+        'Food > Cheese',
+        'Food > Meat',
+        'Clothes > Man > Jackets',
+        'Clothes > Womam > Skirts',
+    )
+    for breadcrumbs in categories:
+        create_from_breadcrumbs(breadcrumbs)
+

oscar/apps/catalogue/categories.py

@@ -0,0 +1,29 @@
+from django.db.models import get_model
+
+Category = get_model('catalogue', 'category')
+
+
+def create_from_sequence(bits):
+    if len(bits) == 1:
+        # Get or create root node
+        try:
+            root = Category.objects.get(depth=1, name=bits[0])
+        except Category.DoesNotExist:
+            root = Category.add_root(name=bits[0])
+        return [root]
+    else:
+        parents = create_from_sequence(bits[:-1])
+        try:
+            child = parents[-1].get_children().get(name=bits[-1])
+        except Category.DoesNotExist:
+            child = parents[-1].add_child(name=bits[-1])
+        parents.append(child)
+        return parents
+
+def create_from_breadcrumbs(breadcrumb_str, separator='>'):
+    """
+    Create categories from a breadcrumb string
+    """
+    category_names = [x.strip() for x in breadcrumb_str.split(separator)]
+    categories = create_from_sequence(category_names)
+    return categories[-1]

oscar/apps/catalogue/tests.py

@@ -4,21 +4,24 @@ from django.core.exceptions import ValidationError
 from django.core.urlresolvers import reverse
 
 from oscar.apps.catalogue.models import Product, ProductClass, Category
-from oscar.apps.catalogue.utils import breadcrumbs_to_category
+from oscar.apps.catalogue.categories import create_from_breadcrumbs
 
 
 class CategoryTests(TestCase):
+
+    def setUp(self):
+        Category.objects.all().delete()
     
-    def test_create_category_root(self):
+    def test_creating_category_root(self):
         trail = 'Books'
-        category = breadcrumbs_to_category(trail)
+        category = create_from_breadcrumbs(trail)
         self.assertIsNotNone(category)
         self.assertEquals(category.name, 'Books')
         self.assertEquals(category.slug, 'books')      
     
-    def test_subcategory(self):
+    def test_creating_parent_and_child_categories(self):
         trail = 'Books > Science-Fiction'
-        category = breadcrumbs_to_category(trail)
+        category = create_from_breadcrumbs(trail)
         
         self.assertIsNotNone(category)
         self.assertEquals(category.name, 'Science-Fiction')
@@ -27,11 +30,11 @@ class CategoryTests(TestCase):
         self.assertEquals(2, Category.objects.count())
         self.assertEquals(category.slug, 'books/science-fiction')
         
-    def test_subsubcategory(self):
+    def test_creating_multiple_categories(self):
         trail = 'Books > Science-Fiction > Star Trek'
-        breadcrumbs_to_category(trail)
+        create_from_breadcrumbs(trail)
         trail = 'Books > Factual > Popular Science'
-        category = breadcrumbs_to_category(trail)        
+        category = create_from_breadcrumbs(trail)        
         
         self.assertIsNotNone(category)
         self.assertEquals(category.name, 'Popular Science')
@@ -40,6 +43,10 @@ class CategoryTests(TestCase):
         self.assertEquals(5, Category.objects.count())
         self.assertEquals(category.slug, 'books/factual/popular-science', )        
 
+    def test_alternative_separator_can_be_used(self):
+        trail = 'Food|Cheese|Blue'
+        create_from_breadcrumbs(trail, separator='|')
+        self.assertEquals(3, len(Category.objects.all()))
 
 class ItemTests(TestCase):
 

oscar/apps/catalogue/utils.py

@@ -18,29 +18,6 @@ Product = get_model('catalogue', 'product')
 ProductImage = get_model('catalogue', 'productimage')
 
 
-def create_categories(bits):
-    if len(bits) == 1:
-        # Get or create root node
-        try:
-            root = Category.objects.get(depth=1, name=bits[0])
-        except Category.DoesNotExist:
-            root = Category.add_root(name=bits[0])
-        return [root]
-    else:
-        parents = create_categories(bits[:-1])
-        try:
-            child = parents[-1].get_children().get(name=bits[-1])
-        except Category.DoesNotExist:
-            child = parents[-1].add_child(name=bits[-1])
-        parents.append(child)
-        return parents
-
-def breadcrumbs_to_category(breadcrumbs, separator='>'):
-    bits = [x.strip() for x in breadcrumbs.split(separator)]
-    categories = create_categories(bits)
-    return categories[-1]
-
-
 class Importer(object):
     
     allowed_extensions = ['.jpeg','.jpg','.gif','.png']