\w+)$")
17 |
18 |
19 | class FeaturesMiddleware(object):
20 |
21 | def process_request(self, request):
22 | panel = FeaturesPanel()
23 | panel.add('site', list(self.features_from_database(request)))
24 |
25 | for plugin in FeatureProvider.plugins:
26 | panel.add(plugin.source, list(plugin.features(request)))
27 |
28 | if getattr(settings, 'FEATURE_FLIPPER_ANONYMOUS_URL_FLIPPING', False) or \
29 | request.user.has_perm('featureflipper.can_flip_with_url'):
30 | if 'session_clear_features' in request.GET:
31 | self.clear_features_from_session(request.session)
32 | for feature in dict(self.session_features_from_url(request)):
33 | self.add_feature_to_session(request.session, feature)
34 |
35 | panel.add('session', list(self.features_from_session(request)))
36 | panel.add('url', list(self.features_from_url(request)))
37 |
38 | request.features = FeatureDict(panel.states())
39 | request.features_panel = panel
40 |
41 | return None
42 |
43 | def features_from_database(self, request):
44 | """Provides an iterator yielding tuples (feature name, True/False)"""
45 | for feature in Feature.objects.all():
46 | yield (feature.name, feature.enabled)
47 |
48 | def features_from_session(self, request):
49 | """Provides an iterator yielding tuples (feature name, True/False)"""
50 | for key in request.session.keys():
51 | m = re.match(_FEATURE_STATUS, key)
52 | if m:
53 | feature = m.groupdict()['feature']
54 | if request.session[key] == 'enabled':
55 | yield (feature, True)
56 | else: # We'll assume it's disabled
57 | yield (feature, False)
58 |
59 | def features_from_url(self, request):
60 | """Provides an iterator yielding tuples (feature name, True/False)"""
61 | for parameter in request.GET:
62 | m = re.match(_REQUEST_ENABLE, parameter)
63 | if m:
64 | yield (m.groupdict()['feature'], True)
65 |
66 | def session_features_from_url(self, request):
67 | """Provides an iterator yielding tuples (feature name, True/False)"""
68 | for parameter in request.GET:
69 | m = re.match(_SESSION_ENABLE, parameter)
70 | if m:
71 | feature = m.groupdict()['feature']
72 | yield (feature, True)
73 |
74 | def add_feature_to_session(self, session, feature):
75 | session["feature_status_" + feature] = 'enabled'
76 |
77 | def clear_features_from_session(self, session):
78 | for key in session.keys():
79 | if re.match(_FEATURE_STATUS, key):
80 | del session[key]
81 |
82 |
83 | class FeatureDict(dict):
84 |
85 | def __getitem__(self, key):
86 | if key in self:
87 | return dict.__getitem__(self, key)
88 | else:
89 | feature_defaulted.send(sender=self, feature=key)
90 | return False
91 |
92 | class FeaturesPanel():
93 |
94 | def __init__(self):
95 | self.features = {}
96 | self.sources = []
97 |
98 | def add(self, source, features):
99 | self.sources.append((source, features))
100 | for (feature, enabled) in features:
101 | self.features[feature] = {'enabled': enabled, 'source': source}
102 |
103 | def enabled(self, name):
104 | return self.features[name]['enabled']
105 |
106 | def source(self, name):
107 | return self.features[name]['source']
108 |
109 | def states(self):
110 | # Returns a dictionary, mapping each feature name to its (final) state.
111 | return dict([(x, y['enabled']) for x, y in self.features.items()])
112 |
--------------------------------------------------------------------------------
/featureflipper/models.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 |
3 |
4 | class Feature(models.Model):
5 | name = models.CharField(max_length=40, db_index=True, unique=True,
6 | help_text="Required. Used in templates (eg {% feature search %}) and URL parameters.")
7 | description = models.TextField(max_length=400, blank=True)
8 | enabled = models.BooleanField(default=False)
9 |
10 | def enable(self):
11 | self.enabled = True
12 |
13 | def disable(self):
14 | self.enabled = False
15 |
16 | def flip(self):
17 | self.enabled = not self.enabled
18 |
19 | def __unicode__(self):
20 | return self.name
21 |
22 | class Meta:
23 | ordering = ['name']
24 | permissions = (
25 | ("can_flip_with_url", "Can flip features using URL parameters"),
26 | )
27 |
28 | @property
29 | def status(self):
30 | return "enabled" if self.enabled else "disabled"
31 |
--------------------------------------------------------------------------------
/featureflipper/signals.py:
--------------------------------------------------------------------------------
1 | from django.dispatch import Signal
2 |
3 | feature_defaulted = Signal(providing_args=["feature"])
4 |
--------------------------------------------------------------------------------
/featureflipper/templatetags/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tobych/django-feature-flipper/0a82db0b456ac3b2f58634c5b2b7af585fddc13c/featureflipper/templatetags/__init__.py
--------------------------------------------------------------------------------
/featureflipper/templatetags/feature_tag.py:
--------------------------------------------------------------------------------
1 | from django import template
2 | from django.template import NodeList
3 |
4 | from featureflipper.models import Feature
5 |
6 |
7 | register = template.Library()
8 |
9 |
10 | @register.tag
11 | def feature(parser, token):
12 |
13 | try:
14 | tag_name, feature = token.split_contents()
15 | except ValueError:
16 | raise template.TemplateSyntaxError, \
17 | "%r tag requires a single argument" % token.contents.split()[0]
18 |
19 | end_tag = 'endfeature'
20 | nodelist_enabled = parser.parse(('disabled', end_tag))
21 | token = parser.next_token()
22 |
23 | if token.contents == 'disabled':
24 | nodelist_disabled = parser.parse((end_tag,))
25 | parser.delete_first_token()
26 | else:
27 | nodelist_disabled = NodeList()
28 |
29 | return FeatureNode(feature, nodelist_enabled, nodelist_disabled)
30 |
31 |
32 | class FeatureNode(template.Node):
33 |
34 | def __init__(self, feature, nodelist_enabled, nodelist_disabled):
35 | self.feature = feature
36 | self.nodelist_enabled = nodelist_enabled
37 | self.nodelist_disabled = nodelist_disabled
38 |
39 | def render(self, context):
40 | if context['features'][self.feature]:
41 | return self.nodelist_enabled.render(context)
42 | else:
43 | return self.nodelist_disabled.render(context)
44 |
--------------------------------------------------------------------------------
/featureflipper/tests.py:
--------------------------------------------------------------------------------
1 | from django.test import TestCase
2 | from django.http import HttpRequest
3 | from django.test.client import Client
4 | from django.contrib.auth.models import User
5 | from django.contrib.auth.models import Permission
6 |
7 | from featureflipper.models import Feature
8 | from featureflipper.middleware import FeaturesMiddleware
9 |
10 | class featureflipperTest(TestCase):
11 | """
12 | Tests for django-feature-flipper
13 | """
14 | def test_something(self):
15 | feature = Feature.objects.create(name='fftestfeature')
16 | user = User.objects.create_user('fftestuser', '', 'password')
17 |
18 | c = Client()
19 | self.assertTrue(c.login(username='fftestuser', password='password'))
20 |
21 | response = c.get('/')
22 | self.assertTrue('features' in response.context)
23 | self.assertTrue('fftestfeature' in response.context['features'])
24 | self.assertFalse(response.context['features']['fftestfeature'])
25 |
26 | response = c.get('/?enable_fftestfeature')
27 | self.assertTrue(response.context['features']['fftestfeature'])
28 |
29 | response = c.get('/')
30 | self.assertFalse(response.context['features']['fftestfeature'])
31 |
32 | response = c.get('/?session_enable_fftestfeature')
33 | self.assertFalse(response.context['features']['fftestfeature'])
34 |
35 | perm = Permission.objects.get(codename='can_flip_with_url')
36 | user.user_permissions.add(perm)
37 |
38 | self.assertTrue(user.has_perm('featureflipper.can_flip_with_url'))
39 | response = c.get('/?session_enable_fftestfeature')
40 |
41 | self.assertTrue(response.context['features']['fftestfeature'])
42 | response = c.get('/')
43 | self.assertTrue(response.context['features']['fftestfeature'])
44 |
45 | response = c.get('/?session_clear_features')
46 | self.assertFalse(response.context['features']['fftestfeature'])
47 |
48 | feature.delete()
49 | user.delete()
50 |
--------------------------------------------------------------------------------
/featureflipper/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf.urls.defaults import *
2 |
--------------------------------------------------------------------------------
/featureflipper/views.py:
--------------------------------------------------------------------------------
1 | from django.shortcuts import render_to_response
2 | from django.http import HttpResponseRedirect, HttpResponseForbidden, Http404
3 | from django.template import RequestContext
4 | from django.utils.translation import ugettext, ugettext_lazy as _
5 |
--------------------------------------------------------------------------------
/featureflipper_example/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tobych/django-feature-flipper/0a82db0b456ac3b2f58634c5b2b7af585fddc13c/featureflipper_example/__init__.py
--------------------------------------------------------------------------------
/featureflipper_example/features.json:
--------------------------------------------------------------------------------
1 | [
2 | {
3 | "name": "profile",
4 | "enabled": true,
5 | "description": "Allow the user to view and edit their profile."
6 | },
7 | {
8 | "name": "search",
9 | "enabled": false,
10 | "description": "Shows the search box on most pages, and the larger one on the home page."
11 | }
12 | ]
13 |
--------------------------------------------------------------------------------
/featureflipper_example/manage.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | from django.core.management import execute_manager
3 | try:
4 | import settings # Assumed to be in the same directory.
5 | except ImportError:
6 | import sys
7 | sys.stderr.write("Error: Can't find the file 'settings.py' in the directory containing %r. It appears you've customized things.\nYou'll have to run django-admin.py, passing it your settings module.\n(If the file settings.py does indeed exist, it's causing an ImportError somehow.)\n" % __file__)
8 | sys.exit(1)
9 |
10 | if __name__ == "__main__":
11 | execute_manager(settings)
12 |
--------------------------------------------------------------------------------
/featureflipper_example/settings.py:
--------------------------------------------------------------------------------
1 | # Django settings for the django-feature-flipper example project.
2 |
3 | DEBUG = True
4 | TEMPLATE_DEBUG = DEBUG
5 | import os, sys
6 | APP = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
7 | PROJ_ROOT = os.path.abspath(os.path.dirname(__file__))
8 | sys.path.append(APP)
9 |
10 | ADMINS = (
11 | # ('Your Name', 'your_email@domain.com'),
12 | )
13 |
14 | MANAGERS = ADMINS
15 |
16 | DATABASE_ENGINE = 'sqlite3' # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
17 | DATABASE_NAME = 'dev.db' # Or path to database file if using sqlite3.
18 | DATABASE_USER = '' # Not used with sqlite3.
19 | DATABASE_PASSWORD = '' # Not used with sqlite3.
20 | DATABASE_HOST = '' # Set to empty string for localhost. Not used with sqlite3.
21 | DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3.
22 |
23 | # Local time zone for this installation. Choices can be found here:
24 | # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
25 | # although not all choices may be available on all operating systems.
26 | # If running in a Windows environment this must be set to the same as your
27 | # system time zone.
28 | TIME_ZONE = 'America/Chicago'
29 |
30 | # Language code for this installation. All choices can be found here:
31 | # http://www.i18nguy.com/unicode/language-identifiers.html
32 | LANGUAGE_CODE = 'en-us'
33 |
34 | SITE_ID = 1
35 |
36 | # If you set this to False, Django will make some optimizations so as not
37 | # to load the internationalization machinery.
38 | USE_I18N = True
39 |
40 | # Absolute path to the directory that holds media.
41 | # Example: "/home/media/media.lawrence.com/"
42 | MEDIA_ROOT = os.path.abspath(os.path.join('media'))
43 |
44 | # URL that handles the media served from MEDIA_ROOT. Make sure to use a
45 | # trailing slash if there is a path component (optional in other cases).
46 | # Examples: "http://media.lawrence.com", "http://example.com/media/"
47 | MEDIA_URL = '/static/'
48 |
49 | # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
50 | # trailing slash.
51 | # Examples: "http://foo.com/media/", "/media/".
52 | ADMIN_MEDIA_PREFIX = '/media/'
53 |
54 | # Make this unique, and don't share it with anybody.
55 | SECRET_KEY = 'g2_39yupn*6j4p*cg2%w643jiq-1n_annua*%i8+rq0dx9p=$n'
56 |
57 | # List of callables that know how to import templates from various sources.
58 | TEMPLATE_LOADERS = (
59 | 'django.template.loaders.filesystem.load_template_source',
60 | 'django.template.loaders.app_directories.load_template_source',
61 | # 'django.template.loaders.eggs.load_template_source',
62 | )
63 |
64 | TEMPLATE_CONTEXT_PROCESSORS = (
65 | 'django.contrib.auth.context_processors.auth',
66 | 'featureflipper.context_processors.features',
67 | )
68 |
69 | MIDDLEWARE_CLASSES = (
70 | 'django.middleware.common.CommonMiddleware',
71 | 'django.contrib.sessions.middleware.SessionMiddleware',
72 | 'django.contrib.auth.middleware.AuthenticationMiddleware',
73 | 'featureflipper.middleware.FeaturesMiddleware',
74 | )
75 |
76 | ROOT_URLCONF = 'featureflipper_example.urls'
77 |
78 | TEMPLATE_DIRS = (
79 | # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
80 | # Always use forward slashes, even on Windows.
81 | # Don't forget to use absolute paths, not relative paths.
82 | os.path.abspath(os.path.dirname(__file__)) + "/templates/",
83 | )
84 |
85 | FEATURE_FLIPPER_FEATURES_FILE = os.path.abspath(os.path.dirname(__file__)) + "/features.json"
86 | FEATURE_FLIPPER_ANONYMOUS_URL_FLIPPING = False
87 |
88 | INSTALLED_APPS = (
89 | 'django.contrib.admin',
90 | 'django.contrib.auth',
91 | 'django.contrib.contenttypes',
92 | 'django.contrib.sessions',
93 | 'django.contrib.sites',
94 | 'featureflipper'
95 | )
96 |
--------------------------------------------------------------------------------
/featureflipper_example/templates/featureflipper_example/index.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 | django-feature-flipper example
8 |
9 |
10 |
11 |
12 | {% if user.is_authenticated %}
13 | {{ user }} Logout
14 | {% else %}
15 | Login
16 | {% endif %}
17 |
18 |
19 | django-feature-flipper example
20 |
21 | Permissions
22 |
23 | {% if perms.featureflipper.can_flip_with_url %}
24 | You have permission to flip features using URL parameters (see below).
25 | {% else %}
26 | You don't have permission to flip features using URL parameters.
27 | {% endif %}
28 |
29 | Using the 'features' context variable
30 |
31 |
32 | {% if features.profile %}
33 | Profile is enabled
34 | {% else %}
35 | Profile is disabled
36 | {% endif %}
37 |
38 | Search is {% if features.search %}enabled{% else %}disabled{% endif %}
39 |
40 | Unknown is {{ features.unknown|yesno:"enabled,disabled" }}
41 |
42 |
43 | Using the 'feature' tag
44 |
45 | {% load feature_tag %}
46 |
47 |
48 | {% feature profile %}Profile is enabled{% disabled %}Profile is disabled{% endfeature %}
49 | {% feature search %}Search is enabled{% disabled %}Search is disabled{% endfeature %}
50 | {% feature unknown %}Unknown is enabled{% disabled %}Unknown is disabled{% endfeature %}
51 |
52 |
53 | Feature.objects.all
54 |
55 | {% for feature in feature_list %}
56 | {{ feature }}: {{ feature.description }}
57 | {% endfor %}
58 |
59 | request.features_panel
60 |
61 | All known features, their final status, and the source of that final status.
62 |
63 |
64 | | Feature | Enabled | Source |
|---|
65 | {% for name, details in features_panel.features.items %}
66 | | {{ name }} | {{ details.enabled|yesno }} | {{ details.source }} |
67 | {% endfor %}
68 |
69 |
70 | Using GET parameters to flip features
71 |
72 |
82 |
83 |
84 |
85 |
--------------------------------------------------------------------------------
/featureflipper_example/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf.urls.defaults import *
2 | from django.conf import settings
3 | from django.contrib import admin
4 |
5 | admin.autodiscover()
6 |
7 | urlpatterns = patterns('',
8 | (r'^admin/', include(admin.site.urls)),
9 | (r'^$', 'featureflipper_example.views.index'),
10 | )
11 |
--------------------------------------------------------------------------------
/featureflipper_example/views.py:
--------------------------------------------------------------------------------
1 | from django.shortcuts import render_to_response
2 | from django.template import RequestContext
3 |
4 | from featureflipper.models import Feature
5 | from featureflipper.signals import feature_defaulted
6 |
7 |
8 | # We use the feature_defaulted signal to print a simple message
9 | # warning that a feature has been defaulted to disabled. You might
10 | # instead raise an exception here (to help avoid bugs in templates),
11 | # or add the feature to the database.
12 |
13 | def my_callback(sender, **kwargs):
14 | print "Feature '%s' defaulted!" % kwargs['feature']
15 |
16 | # Uncomment the following line to enable this:
17 | # feature_defaulted.connect(my_callback)
18 |
19 |
20 | def index(request):
21 | # We'll include all the features, just so we can show all the details in the page
22 | feature_list = Feature.objects.all()
23 | # Below, we'll also include the features_panel in the context.
24 | # 'features' will already be added to the context by the middleware.
25 | return render_to_response('featureflipper_example/index.html',
26 | {'features_panel': request.features_panel, 'feature_list': feature_list},
27 | context_instance=RequestContext(request))
28 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tobych/django-feature-flipper/0a82db0b456ac3b2f58634c5b2b7af585fddc13c/requirements.txt
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | import os
2 | from setuptools import setup, find_packages
3 |
4 | def read_file(filename):
5 | """Read a file into a string"""
6 | path = os.path.abspath(os.path.dirname(__file__))
7 | filepath = os.path.join(path, filename)
8 | try:
9 | return open(filepath).read()
10 | except IOError:
11 | return ''
12 |
13 | # Use the docstring of the __init__ file to be the description
14 | DESC = " ".join(__import__('featureflipper').__doc__.splitlines()).strip()
15 |
16 | setup(
17 | name = "django-feature-flipper",
18 | version = __import__('featureflipper').get_version().replace(' ', '-'),
19 | url = '',
20 | author = 'tobych',
21 | author_email = '',
22 | description = DESC,
23 | long_description = read_file('README'),
24 | packages = find_packages(),
25 | include_package_data = True,
26 | install_requires=read_file('requirements.txt'),
27 | classifiers = [
28 | 'License :: OSI Approved :: Apache Software License',
29 | 'Framework :: Django',
30 | ],
31 | )
32 |
--------------------------------------------------------------------------------