Add support for django-jinja.

.travis.yml

@@ -6,17 +6,20 @@ python:
  - "3.3"
  - "3.4"
 env:
- - DJANGO_VERSION=1.4
- - DJANGO_VERSION=1.6
- - DJANGO_VERSION=1.7
+ - DJANGO_VERSION=1.4 JINJA_WITH="jingo==0.7.1"
+ - DJANGO_VERSION=1.6 JINJA_WITH="jingo==0.7.1"
+ - DJANGO_VERSION=1.7 JINJA_WITH="jingo==0.7.1"
+ - DJANGO_VERSION=1.8 JINJA_WITH="django-jinja==1.4.1"
 install:
- - pip install -q "Django>=${DJANGO_VERSION},<${DJANGO_VERSION}.99" -r travis.txt
+ - pip install -q "Django>=${DJANGO_VERSION},<${DJANGO_VERSION}.99" "${JINJA_WITH}" -r travis.txt
 script: ./run.sh test
 matrix:
   exclude:
     - python: "2.6"
-      env: DJANGO_VERSION=1.7
+      env: DJANGO_VERSION=1.7 JINJA_WITH="jingo==0.7.1"
+    - python: "2.6"
+      env: DJANGO_VERSION=1.8 JINJA_WITH="django-jinja==1.4.1"
     - python: "3.3"
-      env: DJANGO_VERSION=1.4
+      env: DJANGO_VERSION=1.4 JINJA_WITH="jingo==0.7.1"
     - python: "3.4"
-      env: DJANGO_VERSION=1.4
+      env: DJANGO_VERSION=1.4 JINJA_WITH="jingo==0.7.1"

docs/usage/templates.rst

@@ -8,10 +8,11 @@ Using Waffle in templates
 Waffle makes it easy to test :ref:`flags <types-flag>`, :ref:`switches
 <types-switch>`, and :ref:`samples <types-sample>` in templates to flip
 features on the front-end. It includes support for both Django's
-built-in templates and for Jinja2_ via jingo_.
+built-in templates and for Jinja2_ via jingo_ (for Django < 1.8) or
+django_jinja_ (for Django >= 1.8).
 
 .. warning::
-    
+
     Before using samples in templates, see the warning in the
     :ref:`Sample chapter <types-sample>`.
 
@@ -68,10 +69,10 @@ Samples
 Jinja Templates
 ===============
 
-When used with jingo_, Waffle provides a ``waffle`` object in the Jinja
-template context that can be used with normal ``if`` statements. Because
-these are normal ``if`` statements, you can use ``else`` or ``if not``
-as normal.
+When used with jingo_ or django_jinja_, Waffle provides a ``waffle``
+object in the Jinja template context that can be used with normal
+``if`` statements. Because these are normal ``if`` statements, you
+can use ``else`` or ``if not`` as normal.
 
 
 Flags
@@ -88,7 +89,7 @@ Switches
 --------
 
 ::
-    
+
     {% if waffle.switch('switch_name') %}
         switch_name is active!
     {% endif %}
@@ -106,3 +107,4 @@ Samples
 
 .. _Jinja2: http://jinja.pocoo.org/
 .. _jingo: http://github.com/jbalogh/jingo
+.. _django_jinja: http://niwinz.github.io/django-jinja/

test_settings.py

@@ -45,22 +45,6 @@
 
 ROOT_URLCONF = 'test_app.urls'
 
-TEMPLATE_LOADERS = (
-    'jingo.Loader',
-    'django.template.loaders.filesystem.Loader',
-    'django.template.loaders.app_directories.Loader',
-)
-
-JINGO_EXCLUDE_APPS = (
-    'django',
-    'waffle',
-)
-
-TEMPLATE_CONTEXT_PROCESSORS = (
-    'django.contrib.auth.context_processors.auth',
-    'django.core.context_processors.request',
-)
-
 WAFFLE_FLAG_DEFAULT = False
 WAFFLE_SWITCH_DEFAULT = False
 WAFFLE_SAMPLE_DEFAULT = False
@@ -73,3 +57,68 @@
     SOUTH_MIGRATION_MODULES = {
         'waffle': 'waffle.south_migrations'
     }
+
+if django.VERSION < (1,8):
+    # Old style TEMPLATE_* settings.
+    # Use jingo.
+
+    TEMPLATE_LOADERS = (
+        'jingo.Loader',
+        'django.template.loaders.filesystem.Loader',
+        'django.template.loaders.app_directories.Loader',
+    )
+
+    TEMPLATE_CONTEXT_PROCESSORS = (
+        'django.contrib.auth.context_processors.auth',
+        'django.core.context_processors.request',
+    )
+
+    JINGO_EXCLUDE_APPS = (
+        'django',
+        'waffle',
+    )
+
+else:
+    # New style TEMPLATES setting.
+    # Use django-jinja
+
+    INSTALLED_APPS += ('django_jinja', )
+
+    TEMPLATES = [
+        # Configure the Jinja2 template engine
+        {
+            'BACKEND': 'django_jinja.backend.Jinja2',
+            'DIRS': [],
+            'APP_DIRS': True,
+            'OPTIONS': {
+                "match_regex": r"jingo.*",
+                'match_extension': '',
+                'context_processors': [
+                    'django.template.context_processors.debug',
+                    'django.template.context_processors.request',
+                    'django.contrib.auth.context_processors.auth',
+                    'django.contrib.messages.context_processors.messages',
+                ],
+                'extensions': [
+                    'jinja2.ext.i18n',
+                    'jinja2.ext.autoescape',
+                    'jinja2.ext.with_',
+                    'jinja2.ext.do'
+                ]
+            }
+        },
+        # Configure the Django template engine
+        {
+            'BACKEND': 'django.template.backends.django.DjangoTemplates',
+            'DIRS': [],
+            'APP_DIRS': True,
+            'OPTIONS': {
+                'context_processors': [
+                    'django.template.context_processors.debug',
+                    'django.template.context_processors.request',
+                    'django.contrib.auth.context_processors.auth',
+                    'django.contrib.messages.context_processors.messages',
+                ],
+            },
+        },
+    ]

tox.ini

@@ -15,6 +15,10 @@ envlist = py2.6-django1.4,
           py3.2-django1.7,
           py3.3-django1.7,
           py3.4-django1.7,
+          py2.7-django1.8,
+          py3.2-django1.8,
+          py3.3-django1.8,
+          py3.4-django1.8,
 
 [testenv]
 commands=./run.sh test
@@ -98,3 +102,23 @@ deps = Django>=1.7,<1.8
 basepython = python3.4
 deps = Django>=1.7,<1.8
        -rtravis.txt
+
+[testenv:py2.7-django1.8]
+basepython = python2.7
+deps = Django>=1.8,<1.9
+       -rtravis.txt
+
+[testenv:py3.2-django1.8]
+basepython = python3.2
+deps = Django>=1.8,<1.9
+       -rtravis.txt
+
+[testenv:py3.3-django1.8]
+basepython = python3.3
+deps = Django>=1.8,<1.9
+       -rtravis.txt
+
+[testenv:py3.4-django1.8]
+basepython = python3.4
+deps = Django>=1.8,<1.9
+       -rtravis.txt

travis.txt

@@ -2,6 +2,5 @@
 # versions.
 mock==1.0.1
 Jinja2>=2.7.1
-jingo==0.7
 South==0.8.3
 django-discover-runner==1.0

waffle/helpers.py

@@ -1,23 +1 @@
-import jingo
-import jinja2
-
-from waffle import flag_is_active, sample_is_active, switch_is_active
-from waffle.views import _generate_waffle_js
-
-
-@jinja2.contextfunction
-def flag_helper(context, flag_name):
-    return flag_is_active(context['request'], flag_name)
-
-
-@jinja2.contextfunction
-def inline_wafflejs_helper(context):
-    return _generate_waffle_js(context['request'])
-
-
-jingo.env.globals['waffle'] = {
-    'flag': flag_helper,
-    'switch': switch_is_active,
-    'sample': sample_is_active,
-    'wafflejs': inline_wafflejs_helper
-}
+from waffle.templatetags import jinja_waffle_tags

waffle/templatetags/jinja_waffle_tags.py

@@ -0,0 +1,39 @@
+import jinja2
+
+from waffle import flag_is_active, sample_is_active, switch_is_active
+from waffle.views import _generate_waffle_js
+
+
+@jinja2.contextfunction
+def flag_helper(context, flag_name):
+    return flag_is_active(context['request'], flag_name)
+
+
+@jinja2.contextfunction
+def inline_wafflejs_helper(context):
+    return _generate_waffle_js(context['request'])
+
+
+helpers = {
+    'flag': flag_helper,
+    'switch': switch_is_active,
+    'sample': sample_is_active,
+    'wafflejs': inline_wafflejs_helper
+}
+
+try:
+    import jingo
+
+    jingo.env.globals['waffle'] = helpers
+except ImportError:
+    # jingo isn't being used. Move on.
+    pass
+
+
+try:
+    from django_jinja.library import global_function
+
+    global_function('waffle', helpers)
+except ImportError:
+    # django-jinja isn't being used. Move on.
+    pass

waffle/tests/test_templates.py

@@ -48,19 +48,7 @@ def test_no_request_context(self):
         assert 'switch off' in content
         assert 'sample' in content
 
-    @override_settings(TEMPLATE_LOADERS=(
-        'jingo.Loader',
-        'django.template.loaders.filesystem.Loader',
-        'django.template.loaders.app_directories.Loader',
-    ))
-    @mock.patch.object(template.loader, 'template_source_loaders', None)
-    def test_jingo_tags(self):
-        """
-            We're manually changing default TEMPLATE_LOADERS to enable jingo
-
-            template_source_loaders needs to be patched to None, otherwise
-            TEMPLATE_LOADERS won't be overriden.
-        """
+    def test_jinja_tags(self):
         request = get()
         response = process_request(request, views.flag_in_jingo)
         self.assertContains(response, 'flag off')