Merge branch 'feature-add-recommendations-to-article' into master

Author: maciejSamerdak

blog/migrations/0013_blogarticlepage_recommended_articles.py

@@ -0,0 +1,20 @@
+# Generated by Django 2.2.14 on 2020-08-04 18:28
+
+from django.db import migrations
+import wagtail.core.blocks
+import wagtail.core.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('blog', '0012_auto_20200625_1631'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='blogarticlepage',
+            name='recommended_articles',
+            field=wagtail.core.fields.StreamField([('page', wagtail.core.blocks.PageChooserBlock(can_choose_root=False, page_type=['blog.BlogArticlePage']))], blank=True, null=True),
+        ),
+    ]

blog/models.py

@@ -12,6 +12,7 @@
 from wagtail.admin.edit_handlers import StreamFieldPanel
 from wagtail.contrib.table_block.blocks import TableBlock
 from wagtail.core import blocks
+from wagtail.core.blocks import PageChooserBlock
 from wagtail.core.fields import StreamField
 from wagtail.core.models import Page
 from wagtail.core.query import PageQuerySet
@@ -88,7 +89,7 @@ class BlogArticlePage(MixinSeoFields, Page, MixinPageMethods, GoogleAdsMixin):
             ("paragraph", blocks.RichTextBlock()),
             ("table", TableBlock()),
             ("image", ImageChooserBlock()),
-        ]
+        ],
     )
 
     search_fields = Page.search_fields + [index.SearchField("intro"), index.SearchField("body")]
@@ -97,6 +98,10 @@ class BlogArticlePage(MixinSeoFields, Page, MixinPageMethods, GoogleAdsMixin):
 
     read_time = models.PositiveIntegerField()
 
+    recommended_articles = StreamField(
+        [("page", PageChooserBlock(can_choose_root=False, page_type="blog.BlogArticlePage"))], null=True, blank=True,
+    )
+
     views = models.PositiveIntegerField(default=0)
 
     cover_photo = models.ForeignKey(
@@ -114,6 +119,7 @@ class BlogArticlePage(MixinSeoFields, Page, MixinPageMethods, GoogleAdsMixin):
         FieldPanel("intro"),
         FieldPanel("author"),
         FieldPanel("read_time"),
+        StreamFieldPanel("recommended_articles"),
         FieldPanel("views"),
         FieldPanel("is_main_article"),
         ImageChooserPanel("cover_photo"),
@@ -156,6 +162,7 @@ def save(self, *args: Any, **kwargs: Any) -> None:  # pylint: disable=signature-
     def clean(self) -> None:
         super().clean()
         self._validate_title_length()
+        self._validate_recommended_articles_uniqueness()
 
     def _validate_parent_page(self) -> None:
         if not isinstance(self.get_parent().specific, BlogIndexPage):
@@ -164,3 +171,11 @@ def _validate_parent_page(self) -> None:
     def _validate_title_length(self) -> None:
         if self.title is not None and len(self.title) > MAX_BLOG_ARTICLE_TITLE_LENGTH:
             raise ValidationError({"title": f"Title must be less than {MAX_BLOG_ARTICLE_TITLE_LENGTH} characters."})
+
+    def _validate_recommended_articles_uniqueness(self) -> None:
+        article_pages_set = set()
+        for stream_child in self.recommended_articles:  # pylint: disable=not-an-iterable
+            if stream_child.value in article_pages_set:
+                raise ValidationError(message=f"'{stream_child.value}' is listed more than once!")
+            else:
+                article_pages_set.add(stream_child.value)

blog/static/blog_post/blog_post.sass

@@ -123,3 +123,6 @@ $width-to-change-details: 500px
         @media only screen and (min-width: $post-width-in-px)
             width: $post-width-in-px
             margin: 25px auto
+
+    .recommendations
+        margin-bottom: 25px

blog/templates/blog/post.haml

@@ -30,6 +30,15 @@
         .article-content
             {{ page.specific.body }}
 
+        {% if page.specific.recommended_articles %}
+            .recommendations
+                %h4 See also:
+                %ul
+                    {% for article in page.specific.recommended_articles %}
+                        %li {{ article }}
+                    {% endfor %}
+        {% endif %}
+
         .comment-section{:id => "disqus_thread"}
             %script{:type => "text/javascript"}
                 var blog_page_url = {{ request.build_absolute_uri }}

blog/tests/test_blog_article_page.py

@@ -2,6 +2,7 @@
 from django.test import TestCase
 from django.utils.datetime_safe import datetime
 from parameterized import parameterized
+from wagtail.core.blocks import PageChooserBlock
 from wagtail.core.blocks import StreamBlock
 from wagtail.core.blocks import StreamValue
 from wagtailmarkdown.blocks import MarkdownBlock
@@ -27,8 +28,8 @@ def test_that_new_article_page_can_be_only_index_blog_page_child(self):
     )
     def test_that_new_article_page_should_has_all_mandatory_parameters(self, parameter_name, parameter_value):
         author = BossFactory()
-        block = StreamBlock([("markdown", MarkdownBlock())])
-        body = StreamValue(block, [("markdown", "Hello, World")])
+        body_block = StreamBlock([("markdown", MarkdownBlock())])
+        body = StreamValue(body_block, [("markdown", "Hello, World")])
         blog_article_parameter = {
             "title": "Simple Article Title",
             "date": datetime.now(),
@@ -67,3 +68,42 @@ def test_that_title_should_not_be_longer_than_custom_specified_amount_of_charact
         title_that_is_way_too_long = "f" * (MAX_BLOG_ARTICLE_TITLE_LENGTH + 1)
         with self.assertRaises(ValidationError):
             self._create_blog_article_page(title=title_that_is_way_too_long)
+
+    def test_that_recommended_articles_should_not_contain_duplicates(self):
+        other_article = self._create_blog_article_page()
+        articles_block = StreamBlock([("page", PageChooserBlock())])
+        recommended_articles_with_duplicates = StreamValue(
+            articles_block, [("page", other_article), ("page", other_article)]
+        )
+        with self.assertRaises(ValidationError):
+            self._create_blog_article_page(recommended_articles=recommended_articles_with_duplicates)
+
+    def test_that_existing_article_should_not_be_given_duplicated_article_in_recommendations(self):
+        other_article = self._create_blog_article_page()
+        articles_block = StreamBlock([("page", PageChooserBlock())])
+        recommended_articles = StreamValue(articles_block, [("page", other_article)])
+        article = self._create_blog_article_page(recommended_articles=recommended_articles)
+        article.recommended_articles.stream_data.append(("page", other_article))
+        with self.assertRaises(ValidationError):
+            article.full_clean()
+
+    def test_that_article_with_no_recommended_articles_should_be_valid(self):
+        author = BossFactory()
+        body_block = StreamBlock([("markdown", MarkdownBlock())])
+        body = StreamValue(body_block, [("markdown", "Hello, World")])
+        blog_article_parameter = {
+            "title": "Simple Article Title",
+            "date": datetime.now(),
+            "intro": "Simple Article Intro",
+            "body": body,
+            "author": author,
+            "read_time": 7,
+            "views": 0,
+        }
+        articles_block = StreamBlock([("page", PageChooserBlock())])
+
+        blog_article_page = BlogArticlePage(**blog_article_parameter)
+        self.blog_index_page.add_child(instance=blog_article_page)
+        blog_article_page.save()
+
+        self.assertEqual(blog_article_page.recommended_articles, StreamValue(articles_block, []))

blog/tests/test_helpers.py

@@ -49,6 +49,7 @@ def _create_blog_article_page(
         body=None,
         author=None,
         read_time=7,
+        recommended_articles=None,
         views=0,
         cover_photo=None,
         article_photo=None,
@@ -66,6 +67,7 @@ def _create_blog_article_page(
             body=body,
             author=author,
             read_time=read_time,
+            recommended_articles=recommended_articles,
             views=views,
             cover_photo=cover_photo,
             article_photo=article_photo,

project_liberation/management/commands/load_initial_data.py

@@ -6,6 +6,7 @@
 from django.db import transaction
 from django.utils.datetime_safe import datetime
 from faker import Faker
+from wagtail.core.blocks import PageChooserBlock
 from wagtail.core.blocks import StreamBlock
 from wagtail.core.blocks import StreamValue
 from wagtail.core.models import Page
@@ -90,13 +91,23 @@ def handle(self, *args, **options):
 
         employees = Employees.objects.all()
         # Create articles
+        last_id = 0
         for article_number in range(0, self.articles_limit):
             blog_index_page = BlogIndexPage.objects.get(**blog_index_page_parameters)
             # base article parameters
             index = article_number % employees.count()
             author = employees[index]
             block = StreamBlock([("markdown", MarkdownBlock())])
             body = StreamValue(block, [("markdown", fake.sentence(nb_words=1000))])
+            # recommended articles
+            if article_number > 3:
+                articles_block = StreamBlock([("page", PageChooserBlock())])
+                articles_data = []
+                for i in range(3):
+                    articles_data.append(("page", BlogArticlePage.objects.get(id=(last_id - i))))
+                recommended_articles = StreamValue(articles_block, articles_data)
+            else:
+                recommended_articles = None
             # article images
             rgb_color = (random.randint(0, 255), random.randint(0, 255), random.randint(0, 255))
             wagtail_cover_photo = self._generate_wagtail_image(
@@ -113,13 +124,15 @@ def handle(self, *args, **options):
                 body=body,
                 author=author,
                 read_time=random.randint(1, 10),
+                recommended_articles=recommended_articles,
                 views=0,
                 cover_photo=wagtail_cover_photo,
                 article_photo=wagtail_article_photo,
                 is_main_article=True,
             )
             blog_index_page.add_child(instance=blog_article_page)
             blog_article_page.save()
+            last_id = blog_article_page.id
 
     @staticmethod
     def _generate_wagtail_image(resolution: Dict[str, int], name: str, rgb_color=None) -> WagtailImage: