#525 Create Tag.get_brands and related tests (#531)

Implement js-part for brand extraction

Self-review fixes

Fix test

Apply linter rules

The first review fixes

Create todo for Products.get_brands()

front/js/components/category.es6

@@ -168,6 +168,7 @@
         name: $product.attr('productName'),
         quantity: parseInt(quantity, 10),
         category: DOM.$h1.data('name'),
+        brand: $product.attr('productBrand'),
       };
     };
 

front/js/components/product.es6

@@ -57,15 +57,17 @@
       name: DOM.$addToCart.data('name'),
       category: DOM.$addToCart.data('category'),
       quantity: parseInt(DOM.$counter.val(), 10),
+      brand: DOM.$addToCart.data('brand'),
     };
   }
 
   /**
    * Publish onProductDetail event.
    */
   function publishDetail() {
-    const { id, name, category } = getProductData();
-    if (id) mediator.publish('onProductDetail', [{ id, name, category }]);
+    const data = getProductData();
+    const { id } = data;
+    if (id) mediator.publish('onProductDetail', [data]);
   }
 
   /**

shopelectro/management/commands/price.py

@@ -60,7 +60,7 @@ def put_utm(product):
             product.prepared_params = list(
                 filter(
                     lambda x: x[0].name != 'Производитель',
-                    product.params
+                    product.get_params()
                 )
             )
 

shopelectro/management/commands/test_db.py

@@ -39,11 +39,15 @@ class Command(BaseCommand):
     def __init__(self):
         super(BaseCommand, self).__init__()
         self._product_id = 0
-        self.group_names = ['Напряжение', 'Сила тока', 'Мощность']
+        self.group_names = [
+            'Напряжение', 'Сила тока',
+            'Мощность', settings.BRAND_TAG_GROUP_NAME,
+        ]
         self.tag_names = [
             ['6 В', '24 В'],
             ['1.2 А', '10 А'],
-            ['7.2 Вт', '240 Вт']
+            ['7.2 Вт', '240 Вт'],
+            ['Apple', 'Microsoft'],
         ]
 
     def handle(self, *args, **options):

shopelectro/models.py

@@ -2,7 +2,7 @@
 import string
 from itertools import chain, groupby
 from operator import attrgetter
-from typing import List, Tuple
+from typing import Dict, List, Optional, Tuple
 from uuid import uuid4
 
 from django.conf import settings
@@ -116,9 +116,8 @@ def feedback_count(self):
     def feedback(self):
         return self.product_feedbacks.all().order_by('-date')
 
-    @property
-    def params(self):
-        return Tag.objects.filter(products=self).get_group_tags_pairs()
+    def get_params(self):
+        return Tag.objects.filter_by_products([self]).get_group_tags_pairs()
 
     # @todo #388:30m Move Product.get_siblings method to refarm-site
     #  And reuse it on STB.
@@ -130,6 +129,10 @@ def get_siblings(self, offset):
             .select_related('page')[:offset]
         )
 
+    def get_brand_name(self) -> str:
+        brand: Optional['Tag'] = Tag.objects.get_brands([self]).get(self)
+        return brand.name if brand else ''
+
 
 class ProductFeedback(models.Model):
     product = models.ForeignKey(
@@ -222,26 +225,36 @@ def __str__(self):
 
 class TagQuerySet(models.QuerySet):
 
-    SLUG_HASH_SIZE = 5
-
-    def get_group_tags_pairs(self) -> List[Tuple[TagGroup, List['Tag']]]:
+    def filter_by_products(self, products: List[Product]):
         ordering = settings.TAGS_ORDER
         distinct = [order.lstrip('-') for order in ordering]
 
-        tags = (
+        return (
             self
-            .all()
-            .prefetch_related('group')
+            .filter(products__in=products)
             .order_by(*ordering)
             .distinct(*distinct, 'id')
         )
 
-        group_tags_pair = [
+    def get_group_tags_pairs(self) -> List[Tuple[TagGroup, List['Tag']]]:
+        grouped_tags = groupby(self.prefetch_related('group'), key=attrgetter('group'))
+        return [
             (group, list(tags_))
-            for group, tags_ in groupby(tags, key=attrgetter('group'))
+            for group, tags_ in grouped_tags
         ]
 
-        return group_tags_pair
+    def get_brands(self, products: List[Product]) -> Dict[Product, 'Tag']:
+        brand_tags = (
+            self.filter(group__name=settings.BRAND_TAG_GROUP_NAME)
+            .prefetch_related('products')
+            .select_related('group')
+        )
+
+        return {
+            product: brand
+            for brand in brand_tags for product in products
+            if product in brand.products.all()
+        }
 
 
 class TagManager(models.Manager.from_queryset(TagQuerySet)):
@@ -255,6 +268,13 @@ def get_queryset(self):
     def get_group_tags_pairs(self):
         return self.get_queryset().get_group_tags_pairs()
 
+    def filter_by_products(self, products):
+        return self.get_queryset().filter_by_products(products)
+
+    def get_brands(self, products):
+        """Get a batch of products' brands."""
+        return self.get_queryset().get_brands(products)
+
 
 class Tag(models.Model):
 

shopelectro/settings/base.py

@@ -482,3 +482,5 @@ def get_robots_content():
 
 # random string to append to doubled slugs
 SLUG_HASH_SIZE = 5
+
+BRAND_TAG_GROUP_NAME = 'Производитель'

shopelectro/sitemaps.py

@@ -50,7 +50,7 @@ def get_categories_with_tags() -> Generator[
     """
     for category in Category.objects.filter(page__is_active=True):
         products = Product.objects.get_by_category(category)
-        tags = Tag.objects.filter(products__in=products).distinct()
+        tags = Tag.objects.filter_by_products(products)
         for group_name, group_tags in tags.get_group_tags_pairs():
             for group_tag in group_tags:
                 yield category, group_tag

shopelectro/tests/tests_models.py

@@ -1,5 +1,9 @@
+from itertools import chain
+from functools import partial
+
+from django.conf import settings
 from django.forms.models import model_to_dict
-from django.test import TestCase
+from django.test import TestCase, TransactionTestCase
 
 from shopelectro.models import Product, Tag, TagGroup
 
@@ -23,10 +27,29 @@ def test_creation_deactivated_product(self):
             self.fail(f'Creation of existing product failed: {{ error }}')
 
 
-class TagTest(TestCase):
+class TagModel(TestCase):
 
     fixtures = ['dump.json']
 
+    def get_products(self):
+        return Product.objects.all()[:3]
+
+    def test_get_brands_content(self):
+        brand_group = TagGroup.objects.get(name=settings.BRAND_TAG_GROUP_NAME)
+        for product, tag in Tag.objects.get_brands(self.get_products()).items():
+            self.assertEquals(tag.group, brand_group)
+            self.assertIn(product, tag.products.all())
+
+    def test_filter_by_products(self):
+        sort_by_id = partial(sorted, key=lambda x: x.id)
+        products = self.get_products()
+        self.assertEquals(
+            sort_by_id(Tag.objects.filter_by_products(products)),
+            sort_by_id(list(set(
+                chain.from_iterable(product.tags.all() for product in products)
+            ))),
+        )
+
     def test_double_named_tag_saving(self):
         """Two tags with the same name should have unique slugs."""
         def save_doubled_tag(tag_from_):
@@ -42,3 +65,35 @@ def save_doubled_tag(tag_from_):
         tag_from = Tag.objects.first()
         tag_to = save_doubled_tag(tag_from)
         self.assertNotEqual(tag_from.slug, tag_to.slug)
+
+
+class QueryQuantities(TransactionTestCase):
+    """Test quantity of db-queries for different methods."""
+
+    fixtures = ['dump.json']
+
+    def test_get_brands_from_tags(self):
+        """Perform two queries to fetch tags, its products."""
+        product = list(Product.objects.all())
+        with self.assertNumQueries(2):
+            Tag.objects.get_brands(product)
+
+    def test_get_brands_from_products(self):
+        """
+        Perform a lot of queries, so we should fetch brands from the Tag model.
+
+        @todo #525:30m Try to implement Product.objects.get_brands()
+         Currently we use Tag.objects.get_brands(), be it seems is not so convenient
+         as it may be.
+         Details:
+         https://github.com/fidals/shopelectro/pull/531#discussion_r211858857
+         https://github.com/fidals/shopelectro/pull/531#discussion_r211962280
+        """
+        products = Product.objects.all().prefetch_related('tags', 'tags__group')
+        products_quantity = products.count() + 3
+
+        with self.assertNumQueries(products_quantity):
+            {
+                p: p.tags.filter(group__name=settings.BRAND_TAG_GROUP_NAME).first()
+                for p in products
+            }

shopelectro/tests/tests_views.py

@@ -242,7 +242,7 @@ def test_pagination_step(self):
         """Category page contains `pagination_step` count of products in list."""
         pagination_step = 25
         response = self.get_category_page(query_string={'step': pagination_step})
-        self.assertEqual(len(response.context['product_image_pairs']), pagination_step)
+        self.assertEqual(len(response.context['products_data']), pagination_step)
 
     def test_pagination_404(self):
         """Category page returns 404 for a nonexistent page number."""

shopelectro/views/catalog.py

@@ -98,16 +98,10 @@ def get_context_data(self, **kwargs):
             # with it's own logic
             return context
 
-        group_tags_pairs = (
-            models.Tag.objects
-            .filter(products=product)
-            .get_group_tags_pairs()
-        )
-
         return {
             **context,
             'price_bounds': settings.PRICE_BOUNDS,
-            'group_tags_pairs': group_tags_pairs,
+            'group_tags_pairs': product.get_params(),
             'tile_products': prepare_tile_products(
                 product.get_siblings(offset=settings.PRODUCT_SIBLINGS_COUNT)
             ),
@@ -164,13 +158,19 @@ def get_context_data(self, **kwargs):
         }
 
 
-def merge_products_and_images(products):
+def merge_products_context(products):
     images = Image.objects.get_main_images_by_pages(
         models.ProductPage.objects.filter(shopelectro_product__in=products)
     )
 
+    brands = (
+        models.Tag.objects
+        .filter_by_products(products)
+        .get_brands(products)
+    )
+
     return [
-        (product, images.get(product.page))
+        (product, images.get(product.page), brands.get(product))
         for product in products
     ]
 
@@ -201,7 +201,7 @@ def get_context_data(self, **kwargs):
 
         group_tags_pairs = (
             models.Tag.objects
-            .filter(products__in=all_products)
+            .filter_by_products(all_products)
             .get_group_tags_pairs()
         )
 
@@ -241,7 +241,7 @@ def template_context(page, tag_titles, tags):
 
         return {
             **context,
-            'product_image_pairs': merge_products_and_images(products),
+            'products_data': merge_products_context(products),
             'group_tags_pairs': group_tags_pairs,
             'total_products': total_products,
             'products_count': (page_number - 1) * products_on_page + products.count(),
@@ -305,7 +305,7 @@ def load_more(request, category_slug, offset=0, limit=0, sorting=0, tags=None):
     view = request.session.get('view_type', 'tile')
 
     return render(request, 'catalog/category_products.html', {
-        'product_image_pairs': merge_products_and_images(products),
+        'products_data': merge_products_context(products),
         'paginated_page': paginated_page,
         'view_type': view,
         'prods': products_on_page,

templates/catalog/category_products.html

@@ -2,7 +2,7 @@
 {% load se_extras %}
 {% load user_agents %}
 
-{% for product, image in product_image_pairs %}
+{% for product, image, brand in products_data %}
   <div class="product-card col-xs-6 col-md-4" productId="{{ product.id }}"
        itemscope itemtype="https://schema.org/Product">
     <meta property="name" itemprop="name" content="{{ product.name }}">
@@ -43,11 +43,12 @@
         {% endcomment %}
         <button class="btn btn-blue btn-category-buy js-product-to-cart"
                 productId="{{ product.id }}" productPrice="{{ product.price }}"
-                productName="{{ product.name }}">
+                productName="{{ product.name }}"
+                productBrand="{% if brand %}{{ brand.name }}{% endif %}">
           Купить
         </button>
       </div>
     </div>
   </div>
 {% endfor %}
-<div class="hidden js-products-loaded">{{ product_image_pairs|length }}</div>
+<div class="hidden js-products-loaded">{{ products_data|length }}</div>

templates/catalog/product.html

@@ -63,7 +63,8 @@ <h1 class="product-h1" itemprop="name">{{ page.display_h1 }}</h1>
 
         <button class="btn btn-blue btn-to-basket js-to-cart-on-product-page" id="btn-to-basket"
                 data-id="{{ product.id }}" data-name="{{ product.name }}"
-                data-category="{{ product.category.name }}">В корзину</button>
+                data-category="{{ product.category.name }}"
+                data-brand="{{ product.get_brand_name }}">В корзину</button>
 
         <p class="product-one-click">Купить в один клик</p>
         <input class="form-control product-one-click-phone js-masked-phone" id="input-one-click-phone"

templates/prices/price.yml

@@ -46,7 +46,7 @@
           {% endif %}
           {# product_type tag in google merchant doc : https://goo.gl/b0UJQp #}
           {% if utm == 'GM' %}<product_type>{{ product.crumbs }}</product_type>{% endif %}
-          {% for name, values in product.params %}
+          {% for name, values in product.get_params %}
             <param name="{{ name }}">{{ values|first }}</param>
           {% endfor %}
         </offer>