Add example to the sandbox

sandbox/sandbox/apps/home/migrations/0001_initial.py

@@ -12,7 +12,7 @@ class Migration(migrations.Migration):
     initial = True
 
     dependencies = [
-        ('wagtailcore', '0033_remove_golive_expiry_help_text'),
+        ('wagtailcore', '0001_initial'),
         ('wagtail_personalisation', '0011_personalisablepagemetadata'),
     ]
 

tests/sandbox/pages/migrations/0003_personalisedfieldspage.py → sandbox/sandbox/apps/home/migrations/0004_create_personalised_fields_page.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Generated by Django 1.11.1 on 2017-05-31 11:29
+# Generated by Django 1.11.1 on 2017-05-31 16:15
 from __future__ import unicode_literals
 
 from django.db import migrations, models
@@ -13,8 +13,8 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('wagtailcore', '0033_remove_golive_expiry_help_text'),
-        ('pages', '0002_auto_20170531_0915'),
+        ('wagtailcore', '0001_initial'),
+        ('home', '0003_homepage_text_content'),
     ]
 
     operations = [

sandbox/sandbox/apps/home/models.py

@@ -1,13 +1,16 @@
 from __future__ import absolute_import, unicode_literals
 
-from wagtail.wagtailadmin.edit_handlers import RichTextFieldPanel, StreamFieldPanel
+from django.utils.translation import ugettext_lazy as _
+
+from wagtail.wagtailadmin.edit_handlers import RichTextFieldPanel,StreamFieldPanel
 from wagtail.wagtailcore import blocks
 from wagtail.wagtailcore.fields import RichTextField, StreamField
 from wagtail.wagtailcore.models import Page
 
+from wagtail_personalisation.blocks import (PersonalisedCharBlock,
+    PersonalisedImageChooserBlock, PersonalisedRichTextBlock,
+    PersonalisedStructBlock, PersonalisedTextBlock)
 from wagtail_personalisation.models import PersonalisablePageMixin
-from wagtail_personalisation.blocks import PersonalisedStructBlock
-
 
 class HomePage(PersonalisablePageMixin, Page):
     intro = RichTextField()
@@ -21,3 +24,24 @@ class HomePage(PersonalisablePageMixin, Page):
         RichTextFieldPanel('intro'),
         StreamFieldPanel('body'),
     ]
+
+
+class PersonalisedFieldsPage(Page):
+    body = StreamField([
+        ('personalised_block', PersonalisedStructBlock([
+            ('heading', blocks.CharBlock()),
+            ('paragraph', blocks.RichTextBlock())
+        ], render_fields=['heading', 'paragraph'])),
+        ('personalised_block_template', PersonalisedStructBlock([
+            ('heading', blocks.CharBlock()),
+            ('paragraph', blocks.RichTextBlock())
+        ], template='blocks/personalised_block_template.html', label=_('Block with template'))),
+        ('personalised_rich_text_block', PersonalisedRichTextBlock()),
+        ('personalised_image', PersonalisedImageChooserBlock()),
+        ('personalised_char', PersonalisedCharBlock()),
+        ('personalised_text', PersonalisedTextBlock()),
+    ])
+
+    content_panels = Page.content_panels + [
+        StreamFieldPanel('body')
+    ]

tests/sandbox/templates/blocks/personalised_block_template.html → sandbox/sandbox/apps/home/templates/blocks/personalised_block_template.html

@@ -1,6 +1,6 @@
 {% load wagtailcore_tags %}
 
-<div class="personalisation-block-template">
+<div class="personalisation-block-template" style="background-color: cornsilk;">
     <p>This is a block with <strong>template</strong>.</p>
     <h2>Heading: {{ value.heading }}</h2>
     <div>

src/wagtail_personalisation/blocks.py

@@ -34,12 +34,15 @@ def __init__(self, *args, **kwargs):
 
         Keyword Arguments:
             render_fields: List with field names to be rendered or None to use
-                the default block rendering.
+                the default block rendering. Please set to None if using block
+                with template since then it's the template that takes care
+                of what fields are rendered.
         """
         render_fields = kwargs.pop('render_fields',
                                    self._meta_class.render_fields)
         super(BasePersonalisedStructBlock, self).__init__(*args, **kwargs)
 
+        # Check "render_fields" are either a list or None.
         if isinstance(render_fields, tuple):
             render_fields = list(render_fields)
 
@@ -51,7 +54,13 @@ def __init__(self, *args, **kwargs):
             raise ValueError('"render_fields" has to contain name(s) of the '
                              'specified blocks.')
         else:
-            setattr(self._meta_class, 'render_fields', render_fields)
+            setattr(self.meta, 'render_fields', render_fields)
+
+        # Template can be used only when "render_fields" is set to None.
+        if self.meta.render_fields is not None \
+                and getattr(self.meta, 'template', None):
+            raise ValueError('"render_fields" has to be set to None when using '
+                             'template.')
 
 
     def is_visible(self, value, request):
@@ -87,13 +96,13 @@ def render(self, value, context=None):
         if not self.is_visible(value, context['request']):
             return ""
 
-        if self._meta_class.render_fields is None:
+        if self.meta.render_fields is None:
             return super(BasePersonalisedStructBlock, self).render(
                 value, context)
 
-        if isinstance(self._meta_class.render_fields, list):
+        if isinstance(self.meta.render_fields, list):
             render_value = ''
-            for field_name in self._meta_class.render_fields:
+            for field_name in self.meta.render_fields:
                 if hasattr(value.bound_blocks[field_name], 'render_as_block'):
                     block_value = value.bound_blocks[field_name] \
                                          .render_as_block(context=context)