Updates include:

- Add badges to README
- Add docs for current items
- Add testing support in tox and a travis build file
- Fixed some import calls in tests
- Added a new test for active tag where class_name can be set
- Added template dict to settings of testapp so it works correctly

Author: dansackett

.travis.yml

@@ -0,0 +1,33 @@
+language: python
+
+python:
+    - 3.5
+
+sudo: false
+
+env:
+    - TOX_ENV=py27-dj18
+    - TOX_ENV=py27-dj19
+    - TOX_ENV=py27-djmaster
+    - TOX_ENV=py34-dj18
+    - TOX_ENV=py34-dj19
+    - TOX_ENV=py34-djmaster
+    - TOX_ENV=py35-dj18
+    - TOX_ENV=py35-dj19
+    - TOX_ENV=py35-djmaster
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - env: TOX_ENV=py27-djmaster
+    - env: TOX_ENV=py35-djmaster
+    - env: TOX_ENV=py34-djmaster
+
+install:
+  - pip install "virtualenv<14.0.0" tox coveralls
+
+script:
+  - tox -e $TOX_ENV
+
+after_success:
+  - coveralls

README.rst

@@ -2,10 +2,33 @@
 Django Toolset
 ==============
 
+.. image:: https://img.shields.io/pypi/l/django-toolset.svg
+   :target: https://raw.githubusercontent.com/codezeus/django-toolset/master/LICENSE
+
+.. image:: https://secure.travis-ci.org/codezeus/django-toolset.png?branch=master
+    :alt: Build Status
+    :target: http://travis-ci.org/codezeus/django-toolset
+
+.. image:: https://img.shields.io/pypi/v/django-toolset.svg
+    :target: https://pypi.python.org/pypi/django-toolset/
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/django-toolset.svg
+    :target: https://pypi.python.org/pypi/django-toolset/
+    :alt: Number of PyPI downloads
+
+.. image:: https://coveralls.io/repos/github/codezeus/django-toolset/badge.svg?branch=master
+   :target: https://coveralls.io/github/codezeus/django-toolset?branch=master
+   :alt: Coverage
+
 Django Toolset is a simple package with a few useful models, views,
 templatetags, and other functions that can be used to save time when writing a
 Django application.
 
+For specific information about what's included, view the `docs`_.
+
+.. _docs: docs/
+
 Requirements
 ============
 
@@ -14,11 +37,9 @@ Django Toolset requires Django 1.8 or later.
 Getting It
 ==========
 
-You can get Django Toolset by using pip or easy_install::
+You can get Django Toolset by using pip::
 
     $ pip install django-toolset
-    or
-    $ easy_install django-toolset
 
 If you want to install it from source, grab the git repository from GitHub and run setup.py::
 

django_toolset/templatetags/custom_tags.py

@@ -17,10 +17,21 @@ def active(context, pattern_or_urlname, class_name='active'):
     Usage:
 
         {% load custom_tags %}
-        <nav><ul>
-          <li class="nav-home {% active 'url-name' %}"><a href="#">Home</a></li>
-          <li class="nav-blog {% active '^/regex/' %}"><a href="#">Blog</a></li>
-        </ul></nav>
+        <nav>
+          <ul>
+            <li class="nav-home {% active 'url-name' %}"><a href="#">Home</a></li>
+            <li class="nav-blog {% active '^/regex/' %}"><a href="#">Blog</a></li>
+          </ul>
+        </nav>
+
+        or
+
+        <nav>
+          <ul>
+            <li class="nav-home {% active 'url-name' class_name='current' %}"><a href="#">Home</a></li>
+            <li class="nav-blog {% active '^/regex/' class_name='current' %}"><a href="#">Blog</a></li>
+          </ul>
+        </nav>
 
     """
     request = context.dicts[1].get('request')

docs/decorators.rst

@@ -0,0 +1,26 @@
+Decorators
+==========
+
+* *authenticated_redirect* - authenticated_redirect provides a way to redirect
+  a user from pages they shouldn't visit when they have been authenticated.
+  For instance, if a user is logged in then they shouldn't visit the "login"
+  page. By default, this will redirect users to a URL named "dashboard" but
+  this can be overwritten with the settings variable
+  `DEFAULT_AUTHENTICATED_PATH`. If you wish to set the path explicitly for
+  each view you can do so by passing the `path` kwarg to the decorator::
+
+    settings.py
+
+    DEFAULT_AUTHENTICATED_PATH = 'admin'
+
+    views.py
+
+    @authenticated_redirect
+    def my_view(request):
+        """This redirects to `admin` if logged in"""
+        ...
+
+    @authenticated_redirect(path='some_other_page')
+    def my_other_view(request):
+        """This redirects to `some_other_page` if logged in"""
+        ...

docs/template_filters.rst

@@ -0,0 +1,13 @@
+Template Filters
+================
+
+* *Method Calling* - A set of filters are provided for calling a method on an
+  object in the template. This is useful for cases where you want to run a
+  method from the template itself and act on it rather than in the view. While
+  it's best practice to not put this type of logic in the template, there are
+  cases where you may want to do so.::
+
+    {% load custom_filters %}
+    {% if foo|method:"has_access"|with:user|with:group|call %}
+
+    This will invoke foo.has_access(user, group)

docs/template_tags.rst

@@ -0,0 +1,24 @@
+Template Tags
+=============
+
+* *active* - The active template tag is an easy way to output a class name for
+  the currently active link. This is useful if you're creating a navigation
+  component and want to give the active URL a specific class for UI purposes.
+  It will accept a named URL or a regex pattern.::
+
+    {% load custom_tags %}
+    <nav>
+      <ul>
+        <li class="nav-home {% active 'url-name' %}"><a href="#">Home</a></li>
+        <li class="nav-blog {% active '^/regex/' %}"><a href="#">Blog</a></li>
+      </ul>
+    </nav>
+
+    or
+
+    <nav>
+      <ul>
+        <li class="nav-home {% active 'url-name' class_name='current' %}"><a href="#">Home</a></li>
+        <li class="nav-blog {% active '^/regex/' class_name='current' %}"><a href="#">Blog</a></li>
+      </ul>
+    </nav>

setup.py

@@ -1,9 +1,37 @@
-import os
+import os, sys
 from setuptools import find_packages, setup
 
 with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
     README = readme.read()
 
+try:
+    from setuptools.command.test import test as TestCommand
+
+    class PyTest(TestCommand):
+        user_options = [('pytest-args=', 'a', "Arguments to pass into py.test")]
+
+        def initialize_options(self):
+            TestCommand.initialize_options(self)
+            self.pytest_args = []
+
+        def finalize_options(self):
+            TestCommand.finalize_options(self)
+            self.test_args = []
+            self.test_suite = True
+
+        def run_tests(self):
+            import pytest
+
+            errno = pytest.main(self.pytest_args)
+            sys.exit(errno)
+
+except ImportError:
+    PyTest = None
+
+cmdclasses = {}
+if PyTest:
+    cmdclasses['test'] = PyTest
+
 # allow setup.py to be run from any path
 os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
 
@@ -18,10 +46,12 @@
     description='A set of helper functions and utilities for a Django application',
     download_url = 'https://github.com/codezeus/django-toolset/tarball/0.1.3',
     long_description=README,
+    cmdclass=cmdclasses,
     url='https://github.com/codezeus/django-toolset',
-    author='Dan Sackett',
-    author_email='danesackett@gmail.com',
-    tests_require=['Django', 'pytest', 'coverage', 'mock'],
+    author='CodeZeus',
+    maintainer='Dan Sackett',
+    maintainer_email='danesackett@gmail.com',
+    tests_require=['Django', 'pytest', 'pytest-cov', 'coverage', 'mock'],
     classifiers=[
         'Environment :: Web Environment',
         'Framework :: Django',
@@ -32,7 +62,6 @@
         'Programming Language :: Python',
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 2.7',
-        'Topic :: Internet :: WWW/HTTP',
-        'Topic :: Internet :: WWW/HTTP :: Dynamic Content'
+        'Topic :: Utilities',
     ],
 )

tests/test_decorators.py

@@ -1,22 +1,22 @@
 import pytest
-import mock
+from mock import Mock, MagicMock
 
 from django_toolset.decorators import authenticated_redirect
 
-@pytest.mark.urls('utils.tests.test_urls')
+@pytest.mark.urls('tests.testapp.urls')
 class DescribeAuthenticatedRedirect:
     """Test the authenticated_redirect decorator"""
     @classmethod
     def setup_class(cls):
-        cls.request = mock.Mock()
+        cls.request = Mock()
         cls.request.path = '/login/'
 
     def it_works_without_kwargs(self):
         @authenticated_redirect
         def my_function(request):
             return True
 
-        self.request.user.is_authenticated = mock.MagicMock(return_value=True)
+        self.request.user.is_authenticated = MagicMock(return_value=True)
         result = my_function(self.request)
         assert result.url == '/dashboard/'
 
@@ -25,7 +25,7 @@ def it_works_with_kwargs_authenticated(self):
         def my_function(request):
             return True
 
-        self.request.user.is_authenticated = mock.MagicMock(return_value=True)
+        self.request.user.is_authenticated = MagicMock(return_value=True)
         result = my_function(self.request)
         assert result.url == '/'
 
@@ -34,7 +34,7 @@ def it_works_with_kwargs_unauthenticated(self):
         def my_function(request):
             return True
 
-        self.request.user.is_authenticated = mock.MagicMock(return_value=False)
+        self.request.user.is_authenticated = MagicMock(return_value=False)
         result = my_function(self.request)
         assert result is True
 
@@ -43,6 +43,6 @@ def it_avoids_redirect_loop(self):
         def my_function(request):
             return True
 
-        self.request.user.is_authenticated = mock.MagicMock(return_value=True)
+        self.request.user.is_authenticated = MagicMock(return_value=True)
         result = my_function(self.request)
         assert result.url == '/dashboard/'

tests/test_filters.py

@@ -1,13 +1,13 @@
 import pytest
-import mock
+from mock import Mock
 
 from django.template import Template, Context
 
 class DescribeMethodFilter:
     """Tests for the `method` filter"""
     @classmethod
     def setup_class(cls):
-        cls.request = mock.Mock()
+        cls.request = Mock()
         cls.template = Template('''
             {% load custom_filters %}
             {{ test|method:"test_method" }}
@@ -20,7 +20,7 @@ def test_method(self):
 
         context = Context({ 'test': Test() })
         template = self.template.render(context)
-        assert 'bound method Test.test_method' in template
+        assert 'Test.test_method' in template
 
     def it_recognizes_not_callable(self):
         class Test:
@@ -34,7 +34,7 @@ class DescribeWithFilter:
     """Tests for the `with` filter"""
     @classmethod
     def setup_class(cls):
-        cls.request = mock.Mock()
+        cls.request = Mock()
         cls.template = Template('''
             {% load custom_filters %}
             {{ test|method:"test_method"|with:my_string }}
@@ -62,7 +62,7 @@ class DescribeCallFilter:
     """Tests for the `call` filter"""
     @classmethod
     def setup_class(cls):
-        cls.request = mock.Mock()
+        cls.request = Mock()
         cls.template = Template('''
             {% load custom_filters %}
             {{ test|method:"test_method"|call }}

tests/test_tags.py

@@ -1,15 +1,15 @@
 import pytest
-import mock
+from mock import Mock
 
 from django.core.urlresolvers import NoReverseMatch
 from django.template import Template, Context
 
-@pytest.mark.urls('utils.tests.test_urls')
+@pytest.mark.urls('tests.testapp.urls')
 class DescribeActiveTag:
     """Tests for the `active` templatetag"""
     @classmethod
     def setup_class(cls):
-        cls.request = mock.Mock()
+        cls.request = Mock()
         cls.request.path = '/login/'
         cls.context = Context({ 'request': cls.request, })
 
@@ -28,6 +28,7 @@ def it_knows_page_is_current_from_regex(self):
         template = self.make_template_for('^/login/$').render(self.context)
         assert template == 'active'
 
-    def it_knows_page_is_current_from_regex(self):
-        template = self.make_template_for('^/login/$').render(self.context)
-        assert template == 'active'
+    def it_can_customize_class_name(self):
+        template = Template("{% load custom_tags %}{% active 'login' class_name='current' %}")
+        template = template.render(self.context)
+        assert template == 'current'