Relocate PublishableFluentContentsAdmin into publishing app, re #22

- move `PublishableFluentContentsAdmin` class from `articles` models to
  the central publishing app location that makes more sense
- relocate `FluentLayoutsMixin` admin mixin from `icekit.admin` module
  to the new `admin_mixins` module to avoid circular import problems
- fix imports and document references to models and mixin to refer to
  new location.

Author: jmurty

docs/howto/plugins.md

@@ -81,7 +81,7 @@ with two mixin classes:
 
     # admin.py
 
-    from icekit.admin import FluentLayoutsMixin
+    from icekit.admin_mixins import FluentLayoutsMixin
 
     class MyModelAdmin(FluentLayoutsMixin, MyModelAdminBase):
         ...

docs/topics/publishing.md

@@ -41,6 +41,11 @@ To make a `FluentContentsPage` model publishable:
 * subclass your model from `icekit.publishing.models.PublishableFluentContentsPage`
 * subclass your model's admin from `FluentContentsPageAdmin` and `icekit.publishing.admin.PublishingAdmin`
 
+To make a fluent contents model (see [ContentsPlugins]) publishable:
+
+* subclass your model from `icekit.publishing.models.PublishableFluentContents`
+* subclass your model's admin from `icekit.publishing.admin.PublishableFluentContentsAdmin`
+
 #### Note: Validating slug uniqueness
 
 In publishable models, both the draft and published slugs will be identical,
@@ -225,3 +230,5 @@ rendering related content for the public and for site admins:
 There has been an issue discovered where `ManyToMany` fields referring both
 ways on models have the many to many data cloned for published and
 unpublished objects. This is currently being worked on.
+
+[ContentsPlugins]: ../howto/plugins.md

icekit/admin.py

@@ -10,9 +10,6 @@
 from django.contrib.contenttypes.models import ContentType
 from django.http import JsonResponse
 from django.utils.translation import ugettext_lazy as _
-from fluent_contents.admin import PlaceholderEditorAdmin
-from fluent_contents.analyzer import get_template_placeholder_data
-from fluent_contents.models import PlaceholderData
 from polymorphic.admin import PolymorphicParentModelAdmin
 
 from icekit import models
@@ -44,37 +41,6 @@ def queryset(self, request, queryset):
 # MIXINS ######################################################################
 
 
-class FluentLayoutsMixin(PlaceholderEditorAdmin):
-    """
-    Mixin class for models that have a ``layout`` field and fluent content.
-    """
-
-    change_form_template = 'icekit/admin/fluent_layouts_change_form.html'
-
-    class Media:
-        js = ('icekit/admin/js/fluent_layouts.js', )
-
-    def formfield_for_foreignkey(self, db_field, *args, **kwargs):
-        """
-        Update queryset for ``layout`` field.
-        """
-        formfield = super(FluentLayoutsMixin, self).formfield_for_foreignkey(
-            db_field, *args, **kwargs)
-        if db_field.name == 'layout':
-            formfield.queryset = formfield.queryset.for_model(self.model)
-        return formfield
-
-    def get_placeholder_data(self, request, obj):
-        """
-        Get placeholder data from layout.
-        """
-        if not obj or not obj.layout:
-            data = [PlaceholderData(slot='main', role='m', title='Main')]
-        else:
-            data = obj.layout.get_placeholder_data()
-        return data
-
-
 class ChildModelPluginPolymorphicParentModelAdmin(PolymorphicParentModelAdmin):
     """
     Get child models and choice labels from registered plugins.

icekit/admin_mixins.py

@@ -0,0 +1,33 @@
+from fluent_contents.admin import PlaceholderEditorAdmin
+from fluent_contents.models import PlaceholderData
+
+
+class FluentLayoutsMixin(PlaceholderEditorAdmin):
+    """
+    Mixin class for models that have a ``layout`` field and fluent content.
+    """
+
+    change_form_template = 'icekit/admin/fluent_layouts_change_form.html'
+
+    class Media:
+        js = ('icekit/admin/js/fluent_layouts.js', )
+
+    def formfield_for_foreignkey(self, db_field, *args, **kwargs):
+        """
+        Update queryset for ``layout`` field.
+        """
+        formfield = super(FluentLayoutsMixin, self).formfield_for_foreignkey(
+            db_field, *args, **kwargs)
+        if db_field.name == 'layout':
+            formfield.queryset = formfield.queryset.for_model(self.model)
+        return formfield
+
+    def get_placeholder_data(self, request, obj):
+        """
+        Get placeholder data from layout.
+        """
+        if not obj or not obj.layout:
+            data = [PlaceholderData(slot='main', role='m', title='Main')]
+        else:
+            data = obj.layout.get_placeholder_data()
+        return data

icekit/articles/admin.py

@@ -1,14 +1,6 @@
 from django.contrib import admin
 
-from icekit.admin import FluentLayoutsMixin
-from icekit.publishing.admin import PublishingAdmin
-
-
-class PublishableFluentContentsAdmin(PublishingAdmin, FluentLayoutsMixin):
-    """
-    Add publishing features for non-Page rich content models
-    """
-    pass
+from icekit.publishing.admin import PublishableFluentContentsAdmin
 
 
 class TitleSlugAdmin(admin.ModelAdmin):

icekit/page_types/layout_page/admin.py

@@ -1,6 +1,6 @@
 from fluent_pages.integration.fluent_contents.admin import FluentContentsPageAdmin
 
-from icekit.admin import FluentLayoutsMixin
+from icekit.admin_mixins import FluentLayoutsMixin
 from icekit.publishing.admin import PublishingAdmin
 
 

icekit/publishing/admin.py

@@ -16,9 +16,11 @@
 from django.template import loader, Context
 
 from fluent_pages.models.db import UrlNode
-from fluent_pages.adminui.pageadmin import DefaultPageChildAdmin, \
-    _select_template_name
+from fluent_pages.adminui.pageadmin import _select_template_name
 from fluent_pages.adminui.urlnodeparentadmin import UrlNodeParentAdmin
+
+from icekit.admin_mixins import FluentLayoutsMixin
+
 from .models import PublishingModel
 
 
@@ -636,3 +638,10 @@ class ICEKitFluentPagesParentAdminMixin(
 ):
     """ Add publishing features for FluentPage parent admin (listing) pages """
     list_filter = (PublishingStatusFilter, PublishingPublishedFilter)
+
+
+class PublishableFluentContentsAdmin(PublishingAdmin, FluentLayoutsMixin):
+    """
+    Add publishing admin features for models with Fluent Contents features
+    """
+    pass