Port to django-fluent-utils, for better code sharing.

* Soft dependencies to django-taggit and django-fluent-pages are more clearly defined now.

Author: vdboor

fluent_faq/admin/base.py

@@ -5,6 +5,7 @@
 from django.utils.translation import ugettext, ugettext_lazy as _
 from fluent_faq import appsettings
 from fluent_contents.admin import PlaceholderFieldAdmin
+from fluent_utils.softdeps.fluent_pages import mixed_reverse
 from parler.admin import TranslatableAdmin
 from parler.forms import TranslatableModelForm
 from parler.models import TranslationDoesNotExist
@@ -134,7 +135,6 @@ def render_change_form(self, request, context, add=False, change=False, form_url
     def _reverse_faqpage_index(self, request, obj=None):
         # Internal method with "protected access" to handle translation differences.
         # This is only called when 'fluent_pages' is in the INSTALLED_APPS.
-        from fluent_pages.urlresolvers import mixed_reverse
         return mixed_reverse('faqquestion_index')
 
 

fluent_faq/models.py

@@ -1,25 +1,14 @@
 from django.conf import settings
-from django.contrib.contenttypes.models import ContentType
 from django.contrib.sites.models import Site
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
+from fluent_faq import appsettings
 from parler.models import TranslatableModel, TranslatedFields
+from parler.utils.context import switch_language
 from fluent_contents.models import PlaceholderField, ContentItemRelation
 from fluent_faq.urlresolvers import faq_reverse
 from fluent_faq.managers import FaqQuestionManager, FaqCategoryManager
-
-
-
-# Optional tagging support
-from parler.utils.context import switch_language
-
-TaggableManager = None
-if 'taggit_autosuggest' in settings.INSTALLED_APPS:
-    from taggit_autosuggest.managers import TaggableManager
-elif 'taggit_autocomplete_modified' in settings.INSTALLED_APPS:
-    from taggit_autocomplete_modified.managers import TaggableManagerAutocomplete as TaggableManager
-elif 'taggit' in settings.INSTALLED_APPS:
-    from taggit.managers import TaggableManager
+from fluent_utils.softdeps.taggit import TagsMixin
 
 
 class FaqBaseModel(TranslatableModel):
@@ -97,7 +86,7 @@ def get_relative_url(self):
 
 
 
-class FaqQuestion(FaqBaseModel):
+class FaqQuestion(TagsMixin, FaqBaseModel):
     """
     Category in the FAQ.
     """
@@ -119,12 +108,6 @@ class FaqQuestion(FaqBaseModel):
     # Organisation
     category = models.ForeignKey(FaqCategory, verbose_name=_("Category"), related_name='questions')
 
-    # Make association with tags optional.
-    if TaggableManager is not None:
-        tags = TaggableManager(blank=True, help_text=_("Tags are used to find related questions"))
-    else:
-        tags = None
-
     objects = FaqQuestionManager()
 
     class Meta:
@@ -143,70 +126,15 @@ def get_relative_url(self):
         # Return the link style, using the permalink style setting.
         return u'{0}{1}/'.format(self.category.get_relative_url(), self.slug)
 
-
     def similar_objects(self, num=None, **filters):
-        tags = self.tags
-        if not tags:
-            return []
-
-        content_type = ContentType.objects.get_for_model(self.__class__)
-        filters['content_type'] = content_type
-
-        # can't filter, see
-        # - https://github.com/alex/django-taggit/issues/32
-        # - http://django-taggit.readthedocs.org/en/latest/api.html#TaggableManager.similar_objects
-        #
-        # Otherwise this would be possible:
-        # return tags.similar_objects(**filters)
-
-        lookup_kwargs = tags._lookup_kwargs()
-        lookup_keys = sorted(lookup_kwargs)
-        qs = tags.through.objects.values(*lookup_kwargs.keys())
-        qs = qs.annotate(n=models.Count('pk'))
-        qs = qs.exclude(**lookup_kwargs)
-        subq = tags.all()
-        qs = qs.filter(tag__in=list(subq))
-        qs = qs.order_by('-n')
-
-        # from https://github.com/alex/django-taggit/issues/32#issuecomment-1002491
-        if filters is not None:
-            qs = qs.filter(**filters)
-
-        if num is not None:
-            qs = qs[:num]
-
-        # Normal taggit code continues
-
-        # TODO: This all feels like a bit of a hack.
-        items = {}
-        if len(lookup_keys) == 1:
-            # Can we do this without a second query by using a select_related()
-            # somehow?
-            f = tags.through._meta.get_field_by_name(lookup_keys[0])[0]
-            objs = f.rel.to._default_manager.filter(**{
-                "%s__in" % f.rel.field_name: [r["content_object"] for r in qs]
-            })
-            for obj in objs:
-                items[(getattr(obj, f.rel.field_name),)] = obj
-        else:
-            preload = {}
-            for result in qs:
-                preload.setdefault(result['content_type'], set())
-                preload[result["content_type"]].add(result["object_id"])
-
-            for ct, obj_ids in preload.items():
-                ct = ContentType.objects.get_for_id(ct)
-                for obj in ct.model_class()._default_manager.filter(pk__in=obj_ids):
-                    items[(ct.pk, obj.pk)] = obj
-
-        results = []
-        for result in qs:
-            obj = items[
-                tuple(result[k] for k in lookup_keys)
-            ]
-            obj.similar_tags = result["n"]
-            results.append(obj)
-        return results
+        """
+        Find similar objects using related tags.
+        """
+        #TODO: filter appsettings.FLUENT_FAQ_FILTER_SITE_ID:
+        #    filters.setdefault('parent_site', self.parent_site_id)
+
+        # FIXME: Using super() doesn't work, calling directly.
+        return TagsMixin.similar_objects(self, num=num, **filters)
 
 
 def _register_anyurlfield_type():

fluent_faq/urlresolvers.py

@@ -1,22 +1,14 @@
-from django.conf import settings
-from django.core.urlresolvers import reverse
+from fluent_utils.softdeps.fluent_pages import mixed_reverse
 
-_HAS_FLUENT_PAGES = ('fluent_pages' in settings.INSTALLED_APPS)
-if _HAS_FLUENT_PAGES:
-    from fluent_pages.urlresolvers import mixed_reverse
 
-
-def faq_reverse(viewname, args=None, kwargs=None, current_app='fluent_faq', current_page=None, language_code=None, multiple=False, ignore_multiple=False):
+def faq_reverse(viewname, args=None, kwargs=None, current_app='fluent_faq', **page_kwargs):
     """
-    Reverse a URL to the blog, taking various configuration options into account.
+    Reverse a URL to the FAQ, taking various configuration options into account.
 
     This is a compatibility function to allow django-fluent-faq to operate stand-alone.
     Either the app can be hooked in the URLconf directly, or it can be added as a pagetype of *django-fluent-pages*.
     """
-    if _HAS_FLUENT_PAGES:
-        return mixed_reverse(viewname, args=args, kwargs=kwargs, current_page=current_page, language_code=language_code, multiple=multiple, ignore_multiple=ignore_multiple)
-    else:
-        return reverse(viewname, args=args, kwargs=kwargs, current_app=current_app)
+    return mixed_reverse(viewname, args=args, kwargs=kwargs, current_app=current_app, **page_kwargs)
 
 
 __all__ = (

fluent_faq/views.py

@@ -1,18 +1,10 @@
 from django.conf import settings
 from django.http import HttpResponsePermanentRedirect
 from django.views.generic import DetailView, ListView
+from fluent_utils.softdeps.fluent_pages import CurrentPageMixin
 from fluent_faq.models import FaqCategory, FaqQuestion
 from parler.views import TranslatableSlugMixin
 
-if 'fluent_pages' in settings.INSTALLED_APPS:
-    # Optional integration with fluent-pages features
-    from fluent_pages.views import CurrentPageMixin
-else:
-    # Simulate basic features for multilingual improvements!
-    from parler.views import ViewUrlMixin
-    class CurrentPageMixin(ViewUrlMixin):
-        pass
-
 
 class FaqQuestionList(CurrentPageMixin, ListView):
     """