Remove Product.related_products

Oscar already has child products to model tightly coupled products, and
"recommended products" to model products that are related (which we
expect to mostly be used for upselling). Product.related_products was a
third option that sat somewhere inbetween, and which I think will often
not be needed, has a mediocre interface in the dashboard and beyond that
no special treatment in the codebase. Furthermore, I see it being
confusing when trying to model a catalogue, and it's easily added back
if necessary.

docs/source/releases/v0.8.rst

@@ -119,6 +119,14 @@ Backwards incompatible changes in 0.8
   just extend the ``Calculator`` class and adjust the weights.
 * ``Product.score`` was just duplicating ``ProductRecord.score`` and has been
   removed. Use ``Product.stats.score`` instead.
+* Oscar has child products to model tightly coupled products, and
+  ``Product.recommended_products`` to model products that are loosely related
+  (e.g. used for upselling). ``Product.related_products`` was a
+  third option that sat somewhere in between, and which was not well supported.
+  We fear it adds confusion, and in the spirit of keeping Oscare core lean,
+  has been removed. If you're using it, switch to
+  ``Product.recommended_products`` or just add the field back to your
+  custom Product instance and ``ProductForm`` when migrating.
 
 .. _rewritten: https://github.com/tangentlabs/django-oscar/commit/d8b4dbfed17be90846ea4bc47b5f7b39ad944c24
 

oscar/apps/catalogue/abstract_models.py

@@ -241,16 +241,12 @@ class AbstractProduct(models.Model):
                     "something like a personalised message to be printed on "
                     "a T-shirt."))
 
-    related_products = models.ManyToManyField(
-        'catalogue.Product', related_name='relations', blank=True,
-        verbose_name=_("Related Products"),
-        help_text=_("Related items are things like different formats of the "
-                    "same book.  Grouping them together allows better linking "
-                    "between products on the site."))
-
     recommended_products = models.ManyToManyField(
         'catalogue.Product', through='ProductRecommendation', blank=True,
-        verbose_name=_("Recommended Products"))
+        verbose_name=_("Recommended Products"),
+        help_text=_("These products are products that are in some way related"
+                    "to the product. They can be a different version of the"
+                    "same product, or e.g. accessories for upselling."))
 
     # Denormalised product rating - used by reviews app.
     # Product has no ratings if rating is None
@@ -505,7 +501,7 @@ class AbstractProduct(models.Model):
             status=self.reviews.model.APPROVED).count()
 
 
-class ProductRecommendation(models.Model):
+class AbstractProductRecommendation(models.Model):
     """
     'Through' model for product recommendations
     """
@@ -520,6 +516,7 @@ class ProductRecommendation(models.Model):
                     ' value will appear before one with a lower ranking.'))
 
     class Meta:
+        abstract = True
         verbose_name = _('Product Recommendation')
         verbose_name_plural = _('Product Recomendations')
         ordering = ['primary', '-ranking']

oscar/apps/catalogue/migrations/0023_auto.py

@@ -0,0 +1,148 @@
+# -*- coding: utf-8 -*-
+from south.utils import datetime_utils as datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        # Removing M2M table for field related_products on 'Product'
+        db.delete_table(db.shorten_name(u'catalogue_product_related_products'))
+
+
+    def backwards(self, orm):
+        # Adding M2M table for field related_products on 'Product'
+        m2m_table_name = db.shorten_name(u'catalogue_product_related_products')
+        db.create_table(m2m_table_name, (
+            ('id', models.AutoField(verbose_name='ID', primary_key=True, auto_created=True)),
+            ('from_product', models.ForeignKey(orm[u'catalogue.product'], null=False)),
+            ('to_product', models.ForeignKey(orm[u'catalogue.product'], null=False))
+        ))
+        db.create_unique(m2m_table_name, ['from_product_id', 'to_product_id'])
+
+
+    models = {
+        u'catalogue.attributeentity': {
+            'Meta': {'object_name': 'AttributeEntity'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'max_length': '255', 'blank': 'True'}),
+            'type': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'entities'", 'to': u"orm['catalogue.AttributeEntityType']"})
+        },
+        u'catalogue.attributeentitytype': {
+            'Meta': {'object_name': 'AttributeEntityType'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'max_length': '255', 'blank': 'True'})
+        },
+        u'catalogue.attributeoption': {
+            'Meta': {'object_name': 'AttributeOption'},
+            'group': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'options'", 'to': u"orm['catalogue.AttributeOptionGroup']"}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'option': ('django.db.models.fields.CharField', [], {'max_length': '255'})
+        },
+        u'catalogue.attributeoptiongroup': {
+            'Meta': {'object_name': 'AttributeOptionGroup'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '128'})
+        },
+        u'catalogue.category': {
+            'Meta': {'ordering': "['full_name']", 'object_name': 'Category'},
+            'depth': ('django.db.models.fields.PositiveIntegerField', [], {}),
+            'description': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
+            'full_name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'image': ('django.db.models.fields.files.ImageField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}),
+            'numchild': ('django.db.models.fields.PositiveIntegerField', [], {'default': '0'}),
+            'path': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '255'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'max_length': '255'})
+        },
+        u'catalogue.option': {
+            'Meta': {'object_name': 'Option'},
+            'code': ('oscar.models.fields.autoslugfield.AutoSlugField', [], {'allow_duplicates': 'False', 'max_length': '128', 'separator': "u'-'", 'blank': 'True', 'unique': 'True', 'populate_from': "'name'", 'overwrite': 'False'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'type': ('django.db.models.fields.CharField', [], {'default': "'Required'", 'max_length': '128'})
+        },
+        u'catalogue.product': {
+            'Meta': {'ordering': "['-date_created']", 'object_name': 'Product'},
+            'attributes': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['catalogue.ProductAttribute']", 'through': u"orm['catalogue.ProductAttributeValue']", 'symmetrical': 'False'}),
+            'categories': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['catalogue.Category']", 'through': u"orm['catalogue.ProductCategory']", 'symmetrical': 'False'}),
+            'date_created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'date_updated': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'db_index': 'True', 'blank': 'True'}),
+            'description': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'is_discountable': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'parent': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'variants'", 'null': 'True', 'to': u"orm['catalogue.Product']"}),
+            'product_class': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'products'", 'null': 'True', 'on_delete': 'models.PROTECT', 'to': u"orm['catalogue.ProductClass']"}),
+            'product_options': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['catalogue.Option']", 'symmetrical': 'False', 'blank': 'True'}),
+            'rating': ('django.db.models.fields.FloatField', [], {'null': 'True'}),
+            'recommended_products': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['catalogue.Product']", 'symmetrical': 'False', 'through': u"orm['catalogue.ProductRecommendation']", 'blank': 'True'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'max_length': '255'}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
+            'upc': ('oscar.models.fields.NullCharField', [], {'max_length': '64', 'unique': 'True', 'null': 'True', 'blank': 'True'})
+        },
+        u'catalogue.productattribute': {
+            'Meta': {'ordering': "['code']", 'object_name': 'ProductAttribute'},
+            'code': ('django.db.models.fields.SlugField', [], {'max_length': '128'}),
+            'entity_type': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['catalogue.AttributeEntityType']", 'null': 'True', 'blank': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'option_group': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['catalogue.AttributeOptionGroup']", 'null': 'True', 'blank': 'True'}),
+            'product_class': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'attributes'", 'null': 'True', 'to': u"orm['catalogue.ProductClass']"}),
+            'required': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'type': ('django.db.models.fields.CharField', [], {'default': "'text'", 'max_length': '20'})
+        },
+        u'catalogue.productattributevalue': {
+            'Meta': {'unique_together': "(('attribute', 'product'),)", 'object_name': 'ProductAttributeValue'},
+            'attribute': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['catalogue.ProductAttribute']"}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'product': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'attribute_values'", 'to': u"orm['catalogue.Product']"}),
+            'value_boolean': ('django.db.models.fields.NullBooleanField', [], {'null': 'True', 'blank': 'True'}),
+            'value_date': ('django.db.models.fields.DateField', [], {'null': 'True', 'blank': 'True'}),
+            'value_entity': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['catalogue.AttributeEntity']", 'null': 'True', 'blank': 'True'}),
+            'value_file': ('django.db.models.fields.files.FileField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
+            'value_float': ('django.db.models.fields.FloatField', [], {'null': 'True', 'blank': 'True'}),
+            'value_image': ('django.db.models.fields.files.ImageField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
+            'value_integer': ('django.db.models.fields.IntegerField', [], {'null': 'True', 'blank': 'True'}),
+            'value_option': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['catalogue.AttributeOption']", 'null': 'True', 'blank': 'True'}),
+            'value_richtext': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'value_text': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'})
+        },
+        u'catalogue.productcategory': {
+            'Meta': {'ordering': "['product', 'category']", 'unique_together': "(('product', 'category'),)", 'object_name': 'ProductCategory'},
+            'category': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['catalogue.Category']"}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'product': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['catalogue.Product']"})
+        },
+        u'catalogue.productclass': {
+            'Meta': {'ordering': "['name']", 'object_name': 'ProductClass'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'options': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['catalogue.Option']", 'symmetrical': 'False', 'blank': 'True'}),
+            'requires_shipping': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'slug': ('oscar.models.fields.autoslugfield.AutoSlugField', [], {'allow_duplicates': 'False', 'max_length': '128', 'separator': "u'-'", 'blank': 'True', 'unique': 'True', 'populate_from': "'name'", 'overwrite': 'False'}),
+            'track_stock': ('django.db.models.fields.BooleanField', [], {'default': 'True'})
+        },
+        u'catalogue.productimage': {
+            'Meta': {'ordering': "['display_order']", 'unique_together': "(('product', 'display_order'),)", 'object_name': 'ProductImage'},
+            'caption': ('django.db.models.fields.CharField', [], {'max_length': '200', 'blank': 'True'}),
+            'date_created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'display_order': ('django.db.models.fields.PositiveIntegerField', [], {'default': '0'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'original': ('django.db.models.fields.files.ImageField', [], {'max_length': '255'}),
+            'product': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'images'", 'to': u"orm['catalogue.Product']"})
+        },
+        u'catalogue.productrecommendation': {
+            'Meta': {'ordering': "['primary', '-ranking']", 'unique_together': "(('primary', 'recommendation'),)", 'object_name': 'ProductRecommendation'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'primary': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'primary_recommendations'", 'to': u"orm['catalogue.Product']"}),
+            'ranking': ('django.db.models.fields.PositiveSmallIntegerField', [], {'default': '0'}),
+            'recommendation': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['catalogue.Product']"})
+        }
+    }
+
+    complete_apps = ['catalogue']

oscar/apps/catalogue/models.py

@@ -20,6 +20,10 @@ class Product(AbstractProduct):
     pass
 
 
+class ProductRecommendation(AbstractProductRecommendation):
+    pass
+
+
 class ProductAttribute(AbstractProductAttribute):
     pass
 

oscar/apps/dashboard/catalogue/forms.py

@@ -13,7 +13,6 @@ ProductClass = get_model('catalogue', 'ProductClass')
 Category = get_model('catalogue', 'Category')
 StockRecord = get_model('partner', 'StockRecord')
 Partner = get_model('partner', 'Partner')
-ProductClass = get_model('catalogue', 'ProductClass')
 ProductAttributeValue = get_model('catalogue', 'ProductAttributeValue')
 ProductCategory = get_model('catalogue', 'ProductCategory')
 ProductImage = get_model('catalogue', 'ProductImage')
@@ -278,7 +277,6 @@ class ProductForm(forms.ModelForm):
                    'attributes', 'categories')
         widgets = {
             'parent': ProductSelect,
-            'related_products': ProductSelectMultiple,
         }
 
     def __init__(self, product_class, data=None, *args, **kwargs):
@@ -301,13 +299,10 @@ class ProductForm(forms.ModelForm):
         is_parent = data and data.get('is_group', '') == 'on'
         self.add_attribute_fields(is_parent)
 
-        related_products = self.fields.get('related_products', None)
         parent = self.fields.get('parent', None)
 
         if parent is not None:
             parent.queryset = self.get_parent_products_queryset()
-        if related_products is not None:
-            related_products.queryset = self.get_related_products_queryset()
         if 'title' in self.fields:
             self.fields['title'].widget = forms.TextInput(
                 attrs={'autocomplete': 'off'})
@@ -337,9 +332,6 @@ class ProductForm(forms.ModelForm):
     def get_attribute_field(self, attribute):
         return self.FIELD_FACTORIES[attribute.type](attribute)
 
-    def get_related_products_queryset(self):
-        return Product.browsable.order_by('title')
-
     def get_parent_products_queryset(self):
         """
         :return: Canonical products excluding this product

oscar/templates/oscar/catalogue/detail.html

@@ -206,21 +206,6 @@
         {% endblock product_review %}
     {% endiffeature %}
 
-    {% with related_products=product.related_products.all|slice:":6" %}
-        {% if related_products %}
-            <div class="sub-header">
-                <h2>{% trans "Related items" %}</h2>
-            </div>
-            <ul class="row-fluid">
-                {% for product in related_products %}
-                <li class="span2 {% if forloop.counter0|divisibleby:"6" %}no-margin{% endif %}">
-                    {% render_product product %}
-                </li>
-                {% endfor %}
-            </ul>
-        {% endif %}
-    {% endwith %}
-
     {% with recommended_products=product.recommended_products.all|slice:":6" %}
         {% if recommended_products %}
             <div class="sub-header">

sites/demo/templates/catalogue/detail.html

@@ -169,19 +169,6 @@
         </div><!-- /span6 -->
     </div><!-- /row-fluid -->
     
-    {% with products=product.related_products.all|slice:":6" %}
-        {% if products %}
-            <div class="sub-header">
-                <h2>{% trans "Related items" %}</h2>
-            </div>
-            <ol class="row-fluid">
-                {% for product in products %}
-                <li class="span2 {% if forloop.counter0|divisibleby:"6" %}no-margin{% endif %}">{% render_product product %}</li>
-                {% endfor %}
-            </ol>
-        {% endif %}
-    {% endwith %}
-
     {% with products=product.recommended_products.all|slice:":6" %}
         {% if products %}
             <div class="sub-header">

sites/sandbox/fixtures/multi-stockrecord-product.json

@@ -41,9 +41,7 @@
         "parent": null,
         "title": "David's book",
         "date_updated": "2013-07-18T12:23:50.102Z",
-        "related_products": [],
         "upc": "",
-        "score": 0.0,
         "is_discountable": true,
         "date_created": "2013-07-18T12:23:29.804Z",
         "product_options": [],
@@ -60,9 +58,7 @@
         "parent": null,
         "title": "Other book",
         "date_updated": "2013-07-18T14:35:52.484Z",
-        "related_products": [],
         "upc": "ABC",
-        "score": 0.0,
         "is_discountable": true,
         "date_created": "2013-07-18T14:35:52.484Z",
         "product_options": [],

sites/sandbox/fixtures/variants.json

@@ -57,9 +57,7 @@
         "parent": null, 
         "title": "Oscar T-shirt", 
         "date_updated": "2013-12-12T16:33:57.426Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-12T16:33:57.426Z", 
         "product_options": [], 
@@ -76,9 +74,7 @@
         "parent": 1, 
         "title": "", 
         "date_updated": "2013-12-12T16:34:14.023Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-12T16:34:14.023Z", 
         "product_options": [], 
@@ -95,9 +91,7 @@
         "parent": 1, 
         "title": "", 
         "date_updated": "2013-12-12T16:34:32.170Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-12T16:34:32.170Z", 
         "product_options": [], 
@@ -114,9 +108,7 @@
         "parent": 1, 
         "title": "", 
         "date_updated": "2013-12-12T17:32:15.016Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-12T17:32:15.016Z", 
         "product_options": [], 
@@ -133,9 +125,7 @@
         "parent": null, 
         "title": "commandlinefu T-shirt", 
         "date_updated": "2013-12-13T11:34:21.810Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-13T11:34:21.810Z", 
         "product_options": [], 
@@ -152,9 +142,7 @@
         "parent": 5, 
         "title": "", 
         "date_updated": "2013-12-13T11:37:08.138Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-13T11:37:08.138Z", 
         "product_options": [], 
@@ -171,9 +159,7 @@
         "parent": 5, 
         "title": "", 
         "date_updated": "2013-12-13T11:37:45.834Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-13T11:37:45.834Z", 
         "product_options": [], 
@@ -190,9 +176,7 @@
         "parent": null, 
         "title": "Tangent T-shirt", 
         "date_updated": "2013-12-13T11:38:15.107Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-13T11:38:15.107Z", 
         "product_options": [], 
@@ -209,9 +193,7 @@
         "parent": 8, 
         "title": "", 
         "date_updated": "2013-12-13T11:38:49.769Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-13T11:38:49.769Z", 
         "product_options": [], 
@@ -228,9 +210,7 @@
         "parent": 8, 
         "title": "", 
         "date_updated": "2013-12-13T11:39:12.859Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-13T11:39:12.859Z", 
         "product_options": [], 
@@ -247,9 +227,7 @@
         "parent": 8, 
         "title": "", 
         "date_updated": "2013-12-13T11:39:53.073Z", 
-        "related_products": [], 
         "upc": null, 
-        "score": 0.0, 
         "is_discountable": true, 
         "date_created": "2013-12-13T11:39:53.073Z", 
         "product_options": [], 

tests/functional/dashboard/product_tests.py

@@ -144,14 +144,9 @@ class TestProductUpdate(ProductWebTest):
         product_form = page.form
         product_form['title'] = 'Nice T-Shirt'
 
-        # ProductSelectMultiple widget expects comma separated ids:
-        product_form['related_products'] = ','.join((str(a.id), str(b.id)))
-
         page = product_form.submit()
 
         product = Product.objects.get(id=self.product.id)
 
         self.assertEqual(page.context['product'], self.product)
         self.assertEqual(product.title, 'Nice T-Shirt')
-        self.assertEqual(list(product.related_products.all().order_by('title')),
-                         [a, b])