Add is_public field to Product model (#2935)

.gitignore

@@ -6,6 +6,13 @@ __pycache__
 /build/
 /node_modules/
 
+# venv
+/bin/
+/lib/
+/share
+/pyvenv.cfg
+/pip-selfcheck.json
+
 # Vagrant
 .vagrant
 

src/oscar/apps/catalogue/abstract_models.py

@@ -263,6 +263,11 @@ class AbstractProduct(models.Model):
         _("Product structure"), max_length=10, choices=STRUCTURE_CHOICES,
         default=STANDALONE)
 
+    is_public = models.BooleanField(
+        _('Is public'),
+        default=True,
+        help_text=_("Show this product in search results and catalogue listings."))
+
     upc = NullCharField(
         _("UPC"), max_length=64, blank=True, null=True, unique=True,
         help_text=_("Universal Product Code (UPC) is an identifier for "

src/oscar/apps/catalogue/managers.py

@@ -99,7 +99,15 @@ class ProductQuerySet(models.query.QuerySet):
 
     def browsable(self):
         """
-        Excludes non-canonical products.
+        Excludes non-canonical products and non-public products
+        """
+        return self.filter(parent=None, is_public=True)
+
+    def browsable_dashboard(self):
+        """
+        Products that should be browsable in the dashboard.
+
+        Excludes non-canonical products, but includes non-public products.
         """
         return self.filter(parent=None)
 

src/oscar/apps/catalogue/migrations/0015_product_is_public.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.1.5 on 2019-02-11 11:55
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('catalogue', '0014_auto_20181115_1953'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='product',
+            name='is_public',
+            field=models.BooleanField(default=True, help_text='Show this product in search results and catalogue listings.', verbose_name='Is public'),
+        ),
+    ]

src/oscar/apps/catalogue/views.py

@@ -1,6 +1,6 @@
 from django.contrib import messages
 from django.core.paginator import InvalidPage
-from django.http import HttpResponsePermanentRedirect
+from django.http import Http404, HttpResponsePermanentRedirect
 from django.shortcuts import get_object_or_404, redirect
 from django.utils.http import urlquote
 from django.utils.translation import gettext_lazy as _
@@ -41,10 +41,17 @@ class ProductDetailView(DetailView):
         if redirect is not None:
             return redirect
 
+        # Do allow staff members so they can test layout etc.
+        if not self.is_viewable(product, request):
+            raise Http404()
+
         response = super().get(request, **kwargs)
         self.send_signal(request, response, product)
         return response
 
+    def is_viewable(self, product, request):
+        return product.is_public or request.user.is_staff
+
     def get_object(self, queryset=None):
         # Check if self.object is already set to prevent unnecessary DB calls
         if hasattr(self, 'object'):

src/oscar/apps/dashboard/catalogue/forms.py

@@ -187,7 +187,7 @@ class ProductForm(forms.ModelForm):
     class Meta:
         model = Product
         fields = [
-            'title', 'upc', 'description', 'is_discountable', 'structure']
+            'title', 'upc', 'description', 'is_public', 'is_discountable', 'structure']
         widgets = {
             'structure': forms.HiddenInput()
         }

src/oscar/apps/dashboard/catalogue/views.py

@@ -124,7 +124,7 @@ class ProductListView(SingleTableView):
         """
         Build the queryset for this list
         """
-        queryset = Product.objects.browsable().base_queryset()
+        queryset = Product.objects.browsable_dashboard().base_queryset()
         queryset = self.filter_queryset(queryset)
         queryset = self.apply_search(queryset)
         return queryset

tests/_site/apps/catalogue/migrations/0014_auto_20181115_1953.py

@@ -0,0 +1,28 @@
+# Generated by Django 2.0.7 on 2018-11-15 19:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('catalogue', '0013_auto_20170821_1548'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='product',
+            name='date_created',
+            field=models.DateTimeField(auto_now_add=True, db_index=True, verbose_name='Date created'),
+        ),
+        migrations.AlterField(
+            model_name='productimage',
+            name='display_order',
+            field=models.PositiveIntegerField(db_index=True, default=0, help_text='An image with a display order of zero will be the primary image for a product', verbose_name='Display order'),
+        ),
+        migrations.AlterField(
+            model_name='productrecommendation',
+            name='ranking',
+            field=models.PositiveSmallIntegerField(db_index=True, default=0, help_text='Determines order of the products. A product with a higher value will appear before one with a lower ranking.', verbose_name='Ranking'),
+        ),
+    ]

tests/_site/apps/catalogue/migrations/0015_product_is_public.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.1.5 on 2019-02-11 11:55
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('catalogue', '0014_auto_20181115_1953'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='product',
+            name='is_public',
+            field=models.BooleanField(default=True, help_text='Show this product in search results and catalogue listings.', verbose_name='Is public'),
+        ),
+    ]

tests/functional/catalogue/test_catalogue.py

@@ -46,6 +46,24 @@ class TestProductDetailView(WebTestCase):
         response = self.app.get(child_url)
         self.assertEqual(http_client.MOVED_PERMANENTLY, response.status_code)
 
+    def test_is_public_on(self):
+        product = create_product(upc="kleine-bats", is_public=True)
+
+        kwargs = {'product_slug': product.slug, 'pk': product.id}
+        url = reverse('catalogue:detail', kwargs=kwargs)
+        response = self.app.get(url)
+
+        self.assertTrue(response.status_code, 200)
+
+    def test_is_public_off(self):
+        product = create_product(upc="kleine-bats", is_public=False)
+
+        kwargs = {'product_slug': product.slug, 'pk': product.id}
+        url = reverse('catalogue:detail', kwargs=kwargs)
+        response = self.app.get(url, expect_errors=True)
+
+        self.assertTrue(response.status_code, 404)
+
 
 class TestProductListView(WebTestCase):
 
@@ -73,6 +91,18 @@ class TestProductListView(WebTestCase):
 
         self.assertContains(page, "Page 1 of 2")
 
+    def test_is_public_on(self):
+        product = create_product(upc="grote-bats", is_public=True)
+        page = self.app.get(reverse('catalogue:index'))
+        products_on_page = list(page.context['products'].all())
+        self.assertEqual(products_on_page, [product])
+
+    def test_is_public_off(self):
+        create_product(upc="kleine-bats", is_public=False)
+        page = self.app.get(reverse('catalogue:index'))
+        products_on_page = list(page.context['products'].all())
+        self.assertEqual(products_on_page, [])
+
 
 class TestProductCategoryView(WebTestCase):
 

tests/functional/dashboard/test_catalogue.py

@@ -84,6 +84,15 @@ class TestCatalogueViews(WebTestCase):
         self.assertIn(product2, products_on_page)
         self.assertNotIn(product3, products_on_page)
 
+    def test_is_public(self):
+        # Can I still find non-public products in dashboard?
+        product = create_product(is_public=False, upc="kleine-bats")
+        page = self.get("%s?upc=%s" % (
+            reverse('dashboard:catalogue-product-list'), product.upc
+        ))
+        products_on_page = [row.record for row in page.context['products'].page.object_list]
+        self.assertEqual(products_on_page, [product])
+
 
 class TestAStaffUser(WebTestCase):
     is_staff = True