Merge branch 'release/0.10.4'

Set QueryRule to be static

.travis.yml

@@ -4,6 +4,9 @@ language: python
 
 matrix:
   include:
+    - python: 2.7
+      env: lint
+
     - python: 2.7
       env: TOXENV=py27-django111-wagtail113
 

docs/conf.py

@@ -55,10 +55,10 @@ author = 'Lab Digital BV'
 # built documents.
 #
 # The short X.Y version.
-version = '0.10.3'
+version = '0.10.4'
 
 # The full version, including alpha/beta/rc tags.
-release = '0.10.3'
+release = '0.10.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.10.3
+current_version = 0.10.4
 commit = true
 tag = true
 tag_name = {new_version}

setup.py

@@ -32,7 +32,7 @@ with open('README.rst') as fh:
 
 setup(
     name='wagtail-personalisation-molo',
-    version='0.10.3',
+    version='0.10.4',
     description='A forked version of Wagtail add-on for showing personalized content',
     author='Praekelt.org',
     author_email='dev@praekeltfoundation.org',

src/wagtail_personalisation/adapters.py

@@ -3,7 +3,6 @@ from __future__ import absolute_import, unicode_literals
 from django.conf import settings
 from django.db.models import F
 from django.utils.module_loading import import_string
-from django.utils import timezone
 
 from wagtail_personalisation.models import Segment
 from wagtail_personalisation.rules import AbstractBaseRule

src/wagtail_personalisation/forms.py

@@ -8,15 +8,11 @@ from django.contrib.auth import get_user_model
 from django.contrib.auth.models import AnonymousUser
 from django.contrib.sessions.models import Session
 from django.contrib.staticfiles.templatetags.staticfiles import static
-from django.core.exceptions import ValidationError
 from django.test.client import RequestFactory
-from django.utils import timezone
 from django.utils.lru_cache import lru_cache
 from django.utils.translation import ugettext_lazy as _
 from wagtail.wagtailadmin.forms import WagtailAdminModelForm
 
-
-
 SessionStore = import_module(settings.SESSION_ENGINE).SessionStore
 
 
@@ -29,7 +25,6 @@ def user_from_data(user_id):
         return AnonymousUser()
 
 
-
 class SegmentAdminForm(WagtailAdminModelForm):
     def clean(self):
         cleaned_data = super(SegmentAdminForm, self).clean()
@@ -62,7 +57,6 @@ class SegmentAdminForm(WagtailAdminModelForm):
             if field not in excluded:
                 form.add_error(field, _('Cannot update a static segment'))
 
-
     def save(self, *args, **kwargs):
         is_new = not self.instance.id
 

src/wagtail_personalisation/migrations/0011_personalisablepagemetadata.py

@@ -2,8 +2,8 @@
 # Generated by Django 1.11.1 on 2017-05-31 14:28
 from __future__ import unicode_literals
 
-from django.db import migrations, models
 import django.db.models.deletion
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):

src/wagtail_personalisation/models.py

@@ -2,7 +2,6 @@ from __future__ import absolute_import, unicode_literals
 
 from django import forms
 from django.conf import settings
-from django.contrib.sessions.models import Session
 from django.db import models, transaction
 from django.template.defaultfilters import slugify
 from django.utils.encoding import python_2_unicode_compatible
@@ -11,11 +10,7 @@ from django.utils.safestring import mark_safe
 from django.utils.translation import ugettext_lazy as _
 from modelcluster.models import ClusterableModel
 from wagtail.wagtailadmin.edit_handlers import (
-    FieldPanel,
-    FieldRowPanel,
-    InlinePanel,
-    MultiFieldPanel,
-)
+    FieldPanel, FieldRowPanel, InlinePanel, MultiFieldPanel)
 from wagtail.wagtailcore.models import Page
 
 from wagtail_personalisation.rules import AbstractBaseRule
@@ -125,7 +120,7 @@ class Segment(ClusterableModel):
 
     @classmethod
     def all_static(cls, rules):
-       return all(rule.static for rule in rules)
+        return all(rule.static for rule in rules)
 
     @property
     def all_rules_static(self):

src/wagtail_personalisation/rules.py

@@ -261,6 +261,7 @@ class QueryRule(AbstractBaseRule):
 
     """
     icon = 'fa-link'
+    static = True
 
     parameter = models.SlugField(_("The query parameter to search for"),
                                  max_length=20)

src/wagtail_personalisation/utils.py

@@ -103,9 +103,17 @@ def exclude_variants(pages):
     :return: List of pages that aren't variants
     :rtype: list
     """
-    return [page for page in pages
-            if (hasattr(page, 'personalisation_metadata') is False)
-            or (hasattr(page, 'personalisation_metadata')
-                and page.personalisation_metadata is None)
-            or (hasattr(page, 'personalisation_metadata')
-                and page.personalisation_metadata.is_canonical)]
+    return [
+        page for page in pages
+        if (
+            (
+                hasattr(page, 'personalisation_metadata') is False
+            ) or
+            (
+                hasattr(page, 'personalisation_metadata') and page.personalisation_metadata is None
+            ) or
+            (
+                hasattr(page, 'personalisation_metadata') and page.personalisation_metadata.is_canonical
+            )
+        )
+    ]

src/wagtail_personalisation/wagtail_hooks.py

@@ -7,7 +7,7 @@ from django.core.urlresolvers import reverse
 from django.template.defaultfilters import pluralize
 from django.utils.safestring import mark_safe
 from django.utils.translation import ugettext_lazy as _
-from wagtail.wagtailadmin.site_summary import SummaryItem, PagesSummaryItem
+from wagtail.wagtailadmin.site_summary import PagesSummaryItem, SummaryItem
 from wagtail.wagtailadmin.widgets import Button, ButtonWithDropdownFromHook
 from wagtail.wagtailcore import hooks
 from wagtail.wagtailcore.models import Page

tests/settings.py

@@ -1,10 +1,9 @@
 from __future__ import absolute_import, unicode_literals
 
 import os
-from pkg_resources import parse_version as V
 
 import django
-
+from pkg_resources import parse_version as V
 
 DATABASES = {
     'default': {
@@ -56,6 +55,7 @@ TEMPLATES = [
     },
 ]
 
+
 def get_middleware_settings():
     return (
         'django.middleware.common.CommonMiddleware',
@@ -69,6 +69,7 @@ def get_middleware_settings():
         'wagtail.wagtailcore.middleware.SiteMiddleware',
     )
 
+
 # Django 1.10 started to use "MIDDLEWARE" instead of "MIDDLEWARE_CLASSES".
 if V(django.get_version()) < V('1.10'):
     MIDDLEWARE_CLASSES = get_middleware_settings()

tests/site/pages/migrations/0001_initial.py

@@ -21,7 +21,7 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name='ContentPage',
             fields=[
-                ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.Page')),
+                ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.Page')),  # noqa: E501
                 ('subtitle', models.CharField(blank=True, default='', max_length=255)),
                 ('body', wagtail.wagtailcore.fields.RichTextField(blank=True, default='')),
             ],

tests/site/pages/migrations/0002_regularpage.py

@@ -2,9 +2,9 @@
 # Generated by Django 1.11.1 on 2017-06-02 04:26
 from __future__ import unicode_literals
 
-from django.db import migrations, models
 import django.db.models.deletion
 import wagtail.wagtailcore.fields
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
@@ -18,7 +18,7 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name='RegularPage',
             fields=[
-                ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.Page')),
+                ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.Page')),  # noqa: E501
                 ('subtitle', models.CharField(blank=True, default='', max_length=255)),
                 ('body', wagtail.wagtailcore.fields.RichTextField(blank=True, default='')),
             ],

tests/unit/test_factories.py

@@ -4,16 +4,14 @@ import datetime
 
 import pytest
 
-from tests.factories.page import ContentPageFactory
-from tests.factories.rule import (
-    DayRuleFactory, DeviceRuleFactory, ReferralRuleFactory, TimeRuleFactory)
+from tests.factories.rule import ReferralRuleFactory, QueryRuleFactory
 from tests.factories.segment import SegmentFactory
-from tests.factories.site import SiteFactory
 from wagtail_personalisation.models import Segment
 from wagtail_personalisation.rules import TimeRule
 
 # Factory tests
 
+
 @pytest.mark.django_db
 def test_segment_create():
     factoried_segment = SegmentFactory()
@@ -27,8 +25,6 @@ def test_segment_create():
     assert factoried_segment.status == segment.status
 
 
-
-
 @pytest.mark.django_db
 def test_referral_rule_create():
     segment = SegmentFactory(name='Referral')
@@ -37,3 +33,16 @@ def test_referral_rule_create():
         segment=segment)
 
     assert referral_rule.regex_string == 'test.test'
+
+
+@pytest.mark.django_db
+def test_query_rule_create():
+    segment = SegmentFactory(name='Query')
+    query_rule = QueryRuleFactory(
+        parameter="query",
+        value="value",
+        segment=segment)
+
+    assert query_rule.parameter == 'query'
+    assert query_rule.value == 'value'
+    assert query_rule.static

tests/unit/test_rules_time.py

@@ -16,6 +16,8 @@ def test_time_rule_create():
         segment=segment)
 
     assert time_rule.start_time == datetime.time(8, 0, 0)
+
+
 @pytest.mark.django_db
 @freeze_time("10:00:00")
 def test_requesttime_segment(client, site):

tests/unit/test_static_dynamic_segments.py

@@ -2,15 +2,14 @@ from __future__ import absolute_import, unicode_literals
 
 import datetime
 
-from django.forms.models import model_to_dict
-from django.contrib.sessions.backends.db import SessionStore
 import pytest
+from django.forms.models import model_to_dict
+
+from tests.factories.segment import SegmentFactory
 from wagtail_personalisation.forms import SegmentAdminForm
 from wagtail_personalisation.models import Segment
 from wagtail_personalisation.rules import TimeRule, VisitCountRule
 
-from tests.factories.segment import SegmentFactory
-
 
 def form_with_data(segment, *rules):
     model_fields = ['type', 'status', 'count', 'name', 'match_any']
@@ -63,6 +62,7 @@ def test_anonymous_user_not_added_to_static_segment_at_creation(site, client):
 
     assert not instance.static_users.all()
 
+
 @pytest.mark.django_db
 def test_match_any_correct_populates(site, client, django_user_model):
     user = django_user_model.objects.create(username='first')

tests/unit/test_utils.py

@@ -1,4 +1,5 @@
-from wagtail_personalisation.utils import impersonate_other_page
+from wagtail_personalisation.utils import (
+    exclude_variants, impersonate_other_page)
 
 
 class Page(object):
@@ -19,3 +20,40 @@ def test_impersonate_other_page():
     impersonate_other_page(page, other_page)
 
     assert page == other_page
+
+
+class Metadata(object):
+    def __init__(self, is_canonical=True):
+        self.is_canonical = is_canonical
+
+
+class PersonalisationMetadataPage(object):
+    def __init__(self):
+        self.personalisation_metadata = Metadata()
+
+
+def test_exclude_variants_includes_pages_with_no_metadata_property():
+    page = PersonalisationMetadataPage()
+    del page.personalisation_metadata
+    result = exclude_variants([page])
+    assert result == [page]
+
+
+def test_exclude_variants_includes_pages_with_metadata_none():
+    page = PersonalisationMetadataPage()
+    page.personalisation_metadata = None
+    result = exclude_variants([page])
+    assert result == [page]
+
+
+def test_exclude_variants_includes_pages_with_metadata_canonical():
+    page = PersonalisationMetadataPage()
+    result = exclude_variants([page])
+    assert result == [page]
+
+
+def test_exclude_variants_excludes_pages_with_metadata_not_canonical():
+    page = PersonalisationMetadataPage()
+    page.personalisation_metadata.is_canonical = False
+    result = exclude_variants([page])
+    assert result == []

tox.ini

@@ -20,7 +20,7 @@ commands =
 
 [testenv:lint]
 basepython = python2.7
-deps = flake8
+deps = flake8==3.5.0
 commands =
     flake8 src tests setup.py
     isort -q --recursive --diff src/ tests/