bootstrap plugins

Author: Nicolas RAMY

Diff for: .gitignore

@@ -87,3 +87,4 @@ ENV/
 
 # Rope project settings
 .ropeproject
+.idea

Diff for: MANIFEST.in

@@ -0,0 +1,2 @@
+include *.txt
+include LICENSE

Diff for: README.rst

@@ -0,0 +1 @@
+# django-helpers

Diff for: django_helpers/__init__.py

@@ -0,0 +1,3 @@
+__version__ = '0.0.0'
+
+default_app_config = 'django_helpers.apps.DjangoHelpersConfig'

Diff for: django_helpers/api.py

@@ -0,0 +1,8 @@
+def get_pagination(request):
+    """
+    Return the pagination storage on the request if it exists, otherwise return an empty dict.
+    
+    :param request: 
+    :return: 
+    """
+    return getattr(request,  '_pagination', {})

Diff for: django_helpers/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class DjangoHelpersConfig(AppConfig):
+    name = 'django_helpers'

Diff for: django_helpers/constants.py

@@ -0,0 +1 @@
+RANGE_OFFSET = 7

Diff for: django_helpers/context_processors.py

@@ -0,0 +1,14 @@
+from django_helpers.api import get_pagination
+
+
+def pagination(request):
+    """
+    Return a lazy 'pagination' context variable
+    
+    :param request: 
+    :return: dict 
+    """
+
+    return {
+        'pagination': get_pagination(request)
+    }

Diff for: django_helpers/middleware.py

@@ -0,0 +1,77 @@
+from django.conf import settings
+from django.utils.deprecation import MiddleWareMixin
+
+from . import constants
+
+
+class PaginationMiddleware(MiddlewareMixin):
+    """
+    Middleware that handles pagination parameters
+    """
+
+    def process_request(self, request):
+        pagination = {
+            'filters': {},
+            'sort': None,
+            'direction': None,
+            'search': None,
+            'page': 1
+        }
+
+        if request.POST and 'search' in request.POST:
+            pagination['search'] = request.POST.get('search')
+        elif 'search' in request.GET:
+            pagination['search'] = request.GET.get('search')
+
+        if 'page' in request.GET:
+            try:
+                pagination['page'] = int(request.GET.get('page'))
+            except ValueError:
+                pass
+
+        if 'filters' in request.GET:
+            for word in request.GET.get('filters').split(','):
+                filter_key, filter_value = word.split(':')
+                pagination['filters'][filter_key] = filter_value
+
+        if 'direction' in request.GET and 'sort' in request.GET:
+            pagination['direction'] = request.GET.get('direction')
+            pagination['sort'] = request.GET.get('sort')
+
+        request._pagination = pagination
+
+    def process_response(self, request, response):
+        if hasattr(request, '_paginator') and hasattr(request, '_results'):
+            pagination = request._pagination
+            paginator = request._paginator
+            results = request._results
+
+            if hasattr(settings, 'PAGINATOR_RANGE_OFFSET'):
+                range_offset = settings.PAGINATOR_RANGE_OFFSET
+            else:
+                range_offset = constants.PAGINATOR_RANGE_OFFSET
+
+            range_start = pagination['page'] - range_offset
+            range_start = range_start if range_start >= 1 else 1
+
+            range_end = pagination['page'] + range_offset
+            range_end = range_end if range_end <= paginator.num_pages else paginator.num_pages
+
+            pagination['pages'] = {
+                'current': pagination['page'],
+                'last': paginator.num_pages,
+                'first': 1,
+                'range_start': range_start if range_start >= 1 else 1,
+                'range_end': range_end if range_end <= paginator.num_pages else paginator.num_pages,
+                'range': range(range_start, range_end + 1),
+                'has_next': results.has_next,
+                'has_previous': results.has_previous,
+                'previous_page_number': results.previous_page_number,
+                'next_page_number': results.next_page_number
+            }
+
+            request._pagination = pagination
+            del request._paginator
+            del request._results
+
+        return response

Diff for: django_helpers/templatetags/pagination.py

@@ -0,0 +1,56 @@
+from django import template
+from django.utils.http import urlquote
+
+register = template.Library()
+
+
+@register.filter
+def pagination_nav_url(data, page):
+    if page == data['pages']['current']:
+        return '#'
+    else:
+        url = '?page=%d' % page
+
+    if data['filters']:
+        serialized_filters = list()
+        for filter_key in data['filters']:
+            serialized_filters.append('%s:%s' % (filter_key, data['filters'][filter_key]))
+
+        if len(serialized_filters):
+            url += '&filters=%s' % '+'.join(serialized_filters)
+
+    if data['direction']:
+        url += '&direction=%s' % data['direction']
+
+    if data['sort']:
+        url += '&sort=%s' % data['sort']
+
+    if data['search']:
+        url += '&search=%s' % urlquote(data['search'])
+
+    return url
+
+
+@register.filter
+def pagination_filter_url(data, filters):
+
+    current_filter_key, current_filter_value = filters.split(':')
+
+    url = '?filters=%s' % filters
+
+    if data['filters']:
+        for filter_key in data['filters']:
+            if filter_key == current_filter_key:
+                continue
+            url += ',%s:%s' % (filter_key, data['filters'][filter_key])
+
+    if data['direction']:
+        url += '&direction=%s' % data['direction']
+
+    if data['sort']:
+        url += '&sort=%s' % data['sort']
+
+    if data['search']:
+        url += '&search=%s' % urlquote(data['search'])
+
+    return url

Diff for: setup.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from setuptools import setup, find_packages
+
+import django_helpers
+
+setup(
+    name='django-helpers',
+    version=django_helpers.__version__,
+    packages=find_packages(),
+    author='Nicolas RAMY',
+    author_email='[email protected]',
+    license='MIT',
+    description='A set of context_processors, decorators, middlewares and others stuffs to develop quickly with Django',
+    long_description=open('README.rst').read(),
+    include_package_data=True,
+    zip_safe=False,
+    install_requires=['Django', ],
+    url='https://github.com/nicolasramy/django-helpers',
+    classifiers=[
+        'Development Status :: 4 - Alpha',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 2.7'
+    ],
+)