initial commit

Author: thijstriemstra

.coveragerc

@@ -0,0 +1,9 @@
+# .coveragerc to control coverage.py
+[run]
+omit =
+    setup.py
+    admin_appmenu/tests/*
+    .tox/*
+    doc/*
+    build/*
+    dist/*

.gitignore

@@ -0,0 +1,14 @@
+*.py[co]
+.project
+.pydevproject
+.settings
+*.egg
+*.egg-info
+dist
+build
+.coverage
+*.pid
+.DS_Store
+doc/_build
+htmlcov/
+.tox/

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+sudo: required
+cache:
+  directories:
+  - $HOME/.cache/pip
+install: pip install --upgrade pip tox wheel
+script: tox
+env:
+  - TOXENV=py27-django-19
+  - TOXENV=py34-django-19
+  - TOXENV=coveralls

LICENSE

@@ -0,0 +1,18 @@
+Copyright (C) 2013-2016 Collab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1,10 @@
+include README.rst LICENSE tox.ini .coveragerc
+
+recursive-include admin_appmenu/tests *
+recursive-include admin_appmenu/locale *
+recursive-include admin_appmenu/templates *
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * *~
+recursive-exclude * .coverage

README.rst

@@ -0,0 +1,43 @@
+django-admin-appmenu
+====================
+
+``django-admin-appmenu`` provides a templatetag that renders an application
+menu in the `Django <https://www.djangoproject.com>`_  admin.
+
+.. image:: https://img.shields.io/pypi/v/django-admin-appmenu.svg
+    :target: https://pypi.python.org/pypi/django-admin-appmenu
+.. image:: https://img.shields.io/pypi/pyversions/django-admin-appmenu.svg
+    :target: https://pypi.python.org/pypi/django-admin-appmenu
+.. image:: https://travis-ci.org/collab-project/django-admin-appmenu.svg?branch=master
+    :target: https://travis-ci.org/collab-project/django-admin-appmenu
+.. image:: https://coveralls.io/repos/collab-project/django-admin-appmenu/badge.svg
+    :target: https://coveralls.io/r/collab-project/django-admin-appmenu
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
+    :target: https://raw.githubusercontent.com/collab-project/django-admin-appmenu/master/LICENSE
+
+Installation
+------------
+
+Use pip_ to install the download and install the package from PyPi_::
+
+  pip install django-admin-appmenu
+
+Or checkout the source code from Github_::
+
+  git clone https://github.com/collab-project/django-admin-appmenu.git
+  cd django-admin-appmenu
+  pip install -e .
+
+Add ``admin_appmenu`` to ``INSTALLED_APPS`` in your Django project settings:
+
+.. code-block:: python
+
+  INSTALLED_APPS = (
+      ...
+
+      'admin_appmenu',
+  )
+
+.. _pip: https://pypi.python.org/pypi/pip
+.. _PyPi: https://pypi.python.org/pypi/django-admin-appmenu
+.. _Github: https://github.com/collab-project/django-admin-appmenu

admin_appmenu/__init__.py

@@ -0,0 +1,38 @@
+# Copyright Collab 2013-2016
+# See LICENSE for details.
+
+"""
+`django-admin-appmenu` application.
+"""
+
+from __future__ import unicode_literals
+
+
+#: Application version.
+__version__ = (1, 0, 0, 'b1')
+
+
+def short_version(version=None):
+    """
+    Return short application version. For example: ``1.0.0``.
+    """
+    v = version or __version__
+    return '.'.join([str(x) for x in v[:3]])
+
+
+def get_version(version=None):
+    """
+    Return full version nr, inc. rc, beta etc tags.
+
+    For example: ``2.0.0a1``
+    :rtype: str
+    """
+    v = version or __version__
+    if len(v) == 4:
+        return '{0}{1}'.format(short_version(v), v[3])
+
+    return short_version(v)
+
+
+#: Full version number.
+version = get_version()

admin_appmenu/templates/admin_appmenu/navigation.html

@@ -0,0 +1,23 @@
+<ul>
+{% for app in nav_list %}
+<li id="menu{{ forloop.counter0 }}" class="dropdown"><a href="{{ app.app_url }}">{{ app.app_label }}</a></li>
+
+  {% if app.models|length > 0 %}
+  <ul>
+  {% for model in app.models %}
+
+        {% if model.admin_url %}
+
+            <li><a href="{{ model.admin_url }}">{{ model.name }}</a></li>
+
+        {% else %}
+            <li>&nbsp;</li>
+        {% endif %}
+
+  {% endfor %}
+  </ul>
+  {% endif %}
+
+</li>
+{% endfor %}
+</ul>

admin_appmenu/templatetags/__init__.py

@@ -0,0 +1,56 @@
+# Copyright Collab 2013-2016
+
+"""
+Navigation template tags for the :py:mod:`admin_appmenu` application.
+"""
+
+from __future__ import unicode_literals
+
+import logging
+
+from django import template
+from django.template import base, loader
+
+from ..util import get_admin_site
+
+
+register = template.Library()
+logger = logging.getLogger(__name__)
+
+
+class AdminUserNavigationNode(template.Node):
+    """
+    Build navigation tree with the admin's :py:func:`get_app_list` and render
+    the resulting context into the navigation template.
+    """
+    def render(self, context):
+        data = None
+        try:
+            admin = get_admin_site()
+            data = admin.get_app_list(context['request'])
+        except (ValueError, KeyError):
+            pass
+        except Exception as e:  # pragma: no cover
+            logger.exception(e)
+
+        tpl = loader.get_template('admin_appmenu/navigation.html')
+        return tpl.render({'nav_list': data})
+
+
+@register.tag
+def admin_navigation(parser, token):
+    """
+    Template tag that renders the main admin navigation tree based on the
+    authenticated user's permissions.
+    """
+    # split_contents() knows not to split quoted strings.
+    tag_name = token.split_contents()
+
+    if len(tag_name) > 1:
+        raise base.TemplateSyntaxError(
+            '{} tag does not accept any argument(s): {}'.format(
+            token.contents.split()[0],
+            ', '.join(token.contents.split()[1:])
+    ))
+
+    return AdminUserNavigationNode()

admin_appmenu/templatetags/navigation.py

@@ -0,0 +1,86 @@
+# Copyright Collab 2013-2016
+
+"""
+Custom admin used for testing.
+"""
+
+from __future__ import unicode_literals
+
+from django.conf.urls import url
+from django.core.urlresolvers import reverse
+from django.template.response import TemplateResponse
+from django.utils.translation import ugettext_lazy as _
+
+from django.contrib.admin import AdminSite
+
+from .models import Location
+
+
+class CustomAdminSite(AdminSite):
+    site_header = 'Custom admin site'
+
+    def custom_view(self, request):
+        """
+        An additional admin view.
+        """
+        context = dict(
+           # include common variables for rendering the admin template
+           self.admin_site.each_context(request),
+        )
+        return TemplateResponse(request, 'sometemplate.html', context)
+
+    def get_urls(self):
+        """
+        Extend admin URL patterns.
+        """
+        urls = super(CustomAdminSite, self).get_urls()
+        extra_urls = [
+            url(r'^customview/$', self.custom_view, name='customview')
+        ]
+        return urls + extra_urls
+
+    def get_app_list(self, request):
+        app_list = super(CustomAdminSite, self).get_app_list(request)
+
+        # categorize apps
+        categorized_list = [
+            {'label': _('General'), 'apps': []},
+            {'label': _('Custom'), 'apps': []},
+        ]
+
+        def add_app(key, app):
+            for i, dic in enumerate(categorized_list):
+                if dic['label'] == key:
+                    categorized_list[i]['apps'].append(app)
+                    break
+
+        for category in categorized_list:
+            for app in app_list:
+                name = app['name']
+                label = category['label']
+                if label == _('General'):
+                    if name in ['Admin_Appmenu']:
+                        add_app(label, app)
+
+        # add custom links for superusers
+        if request.user.is_superuser:
+            categorized_list[1]['apps'].append(
+                {
+                    'name': _('Custom views'),
+                    'models': [
+                    {
+                        'name': _('My custom view'),
+                        'admin_url': reverse('admin:customview')
+                    }
+                ]}
+            )
+        else:
+            categorized_list = []
+
+        # from pprint import pprint
+        # pprint(categorized_list)
+        return categorized_list
+
+
+admin_site = CustomAdminSite(name='customadmin')
+admin_site.register(Location)

admin_appmenu/tests/__init__.py

@@ -0,0 +1,17 @@
+# Copyright Collab 2013-2016
+# See LICENSE for details.
+
+"""
+URLConf for custom admin used in tests.
+"""
+
+from __future__ import unicode_literals
+
+from .admin import admin_site
+
+from django.conf.urls import url
+
+
+urlpatterns = [
+    url(r'^', admin_site.urls),
+]

admin_appmenu/tests/admin.py

@@ -0,0 +1,47 @@
+# Copyright Collab 2016
+
+"""
+Models used for testing.
+"""
+
+from __future__ import unicode_literals
+
+from django.db import models
+from django.utils.translation import ugettext as _
+from django.utils.encoding import python_2_unicode_compatible
+
+
+@python_2_unicode_compatible
+class Location(models.Model):
+    """
+    Location.
+    """
+    name = models.CharField(
+        _('name'),
+        help_text=_('Name of the location.'),
+        max_length=255,
+        blank=False,
+        null=False
+    )
+    slug = models.SlugField(
+        _('slug'),
+        help_text=_('Location name as used in links.'),
+        max_length=255,
+        blank=False,
+        null=False,
+        unique=True
+    )
+    address = models.CharField(
+        _('address'),
+        help_text=_('Location address.'),
+        max_length=255,
+        blank=False,
+        null=False
+    )
+
+    class Meta:
+        verbose_name = _('location')
+        verbose_name_plural = _('locations')
+
+    def __str__(self):
+        return self.name

admin_appmenu/tests/custom_admin_urls.py

@@ -0,0 +1,3 @@
+tox
+coverage
+flake8