Version 0.3 v0.3
authorEric Mc Sween <eric.mcsween@auf.org>
Tue, 13 Mar 2012 16:20:37 +0000 (12:20 -0400)
committerEric Mc Sween <eric.mcsween@auf.org>
Tue, 13 Mar 2012 16:20:37 +0000 (12:20 -0400)
* Ajouté des vérification de type sur les méthodes Rules.allow() et Rules.deny()

* Ajouté un manager spécifique aux permissions globales avec les méthodes
  add_permission(), remove_permission(), get_permissions()

* Ajouté la classe GuardedModelAdmin qui est un ModelAdmin gérant les row-level
  permissions

* Ajouté le constructeur make_global_permissions_form() qui permet d'ajouter la
  gestion des permissions globales aux formulaires des utilisateurs et des
  groupes.

* Commencé une documentation

18 files changed:
.gitignore
CHANGES
auf/django/permissions/__init__.py
auf/django/permissions/admin.py [new file with mode: 0644]
auf/django/permissions/forms.py [new file with mode: 0644]
auf/django/permissions/models.py
buildout.cfg
doc/Makefile [new file with mode: 0644]
doc/conf.py [new file with mode: 0644]
doc/index.rst [new file with mode: 0644]
doc/installation.rst [new file with mode: 0644]
doc/utilisation.rst [new file with mode: 0644]
setup.py
tests/food/tests.py
tests/settings.py
tests/simple_tests/__init__.py [new file with mode: 0644]
tests/simple_tests/models.py [new file with mode: 0644]
tests/simple_tests/tests.py [new file with mode: 0644]

index 79d9204..92ddee3 100644 (file)
@@ -7,3 +7,4 @@
 /eggs
 /dist
 /parts
+/doc/_build
diff --git a/CHANGES b/CHANGES
index febcc69..a95e953 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,20 @@
+0.3 (2012-03-13)
+================
+
+* Ajouté des vérification de type sur les méthodes Rules.allow() et Rules.deny()
+
+* Ajouté un manager spécifique aux permissions globales avec les méthodes
+  add_permission(), remove_permission(), get_permissions()
+
+* Ajouté la classe GuardedModelAdmin qui est un ModelAdmin gérant les row-level
+  permissions
+
+* Ajouté le constructeur make_global_permissions_form() qui permet d'ajouter la
+  gestion des permissions globales aux formulaires des utilisateurs et des
+  groupes.
+
+* Commencé une documentation
+
 0.2 (2012-03-01)
 ================
 
index d0d5606..effbf7f 100644 (file)
@@ -3,6 +3,7 @@
 from collections import defaultdict
 
 from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
 from django.utils.importlib import import_module
 
 from auf.django.permissions.models import GlobalGroupPermission
@@ -12,7 +13,8 @@ class Predicate(object):
     """
     Wrapper pour une fonction ``f(user, obj, cls)``.
 
-    Le paramètre ``user`` est l'utilisateur pour lequel la permission est testée.
+    Le paramètre ``user`` est l'utilisateur pour lequel la permission est
+    testée.
 
     Si le prédicat est testé sur un seul objet, cet objet est passé dans
     le paramètre ``obj`` et le paramètre ``cls`` est ``None``. Inversement,
@@ -89,15 +91,27 @@ class Predicate(object):
 class Rules(object):
 
     def __init__(self, allow_default=None, deny_default=None):
-        self.allow_rules = defaultdict(lambda: allow_default or Predicate(False))
+        self.allow_rules = defaultdict(
+            lambda: allow_default or Predicate(lambda user: user.is_superuser)
+        )
         self.deny_rules = defaultdict(lambda: deny_default or Predicate(False))
 
     def allow(self, perm, cls, predicate):
+        if not isinstance(perm, basestring):
+            raise TypeError(
+                "the first argument to allow() must be a string"
+            )
         if not isinstance(predicate, Predicate):
-            raise TypeError("the third argument to allow() must be a Predicate")
+            raise TypeError(
+                "the third argument to allow() must be a Predicate"
+            )
         self.allow_rules[(perm, cls)] |= predicate
 
     def deny(self, perm, cls, predicate):
+        if not isinstance(perm, basestring):
+            raise TypeError(
+                "the first argument to deny() must be a string"
+            )
         if not isinstance(predicate, Predicate):
             raise TypeError("the third argument to deny() must be a Predicate")
         self.deny_rules[(perm, cls)] |= predicate
@@ -117,10 +131,14 @@ class Rules(object):
         if isinstance(result, bool):
             return result
         else:
-            return obj._default_manager.filter(pk=obj.pk).filter(result).exists()
+            return obj._default_manager \
+                    .filter(pk=obj.pk) \
+                    .filter(result) \
+                    .exists()
 
     def filter_queryset(self, user, perm, queryset):
-        result = self.predicate_for_perm(perm, queryset.model)(user, cls=queryset.model)
+        predicate = self.predicate_for_perm(perm, queryset.model)
+        result = predicate(user, cls=queryset.model)
         if result is True:
             return queryset
         elif result is False:
@@ -150,7 +168,8 @@ class AuthenticationBackend(object):
             return set()
         if not hasattr(user, '_auf_global_group_perm_cache'):
             user._auf_global_group_perm_cache = set(
-                p.codename for p in GlobalGroupPermission.objects.filter(group__user=user)
+                p.codename
+                for p in GlobalGroupPermission.objects.filter(group__user=user)
             )
         return user._auf_global_group_perm_cache
 
@@ -158,8 +177,12 @@ class AuthenticationBackend(object):
         if user.is_anonymous() or obj is not None:
             return set()
         if not hasattr(user, '_auf_global_user_perm_cache'):
-            user._auf_global_user_perm_cache = set(p.codename for p in user.global_permissions.all())
-            user._auf_global_user_perm_cache.update(self.get_group_permissions(user))
+            user._auf_global_user_perm_cache = set(
+                p.codename for p in user.global_permissions.all()
+            )
+            user._auf_global_user_perm_cache.update(
+                self.get_group_permissions(user)
+            )
         return user._auf_global_user_perm_cache
 
     def authenticate(self, username=None, password=None):
@@ -170,13 +193,17 @@ class AuthenticationBackend(object):
         # We don't authenticate
         return None
 
-_rules = None
+
 def get_rules():
     global _rules
     if _rules is None:
         if not hasattr(settings, 'AUF_PERMISSIONS_RULES'):
-            raise ImproperlyConfigured('Vous devez configurer la variable AUF_PERMISSIONS_RULES')
+            raise ImproperlyConfigured(
+                'Vous devez configurer la variable AUF_PERMISSIONS_RULES'
+            )
         module_name, dot, attr = settings.AUF_PERMISSIONS_RULES.rpartition('.')
         module = import_module(module_name)
         _rules = getattr(module, attr)
     return _rules
+
+_rules = None
diff --git a/auf/django/permissions/admin.py b/auf/django/permissions/admin.py
new file mode 100644 (file)
index 0000000..19f0e09
--- /dev/null
@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+from auf.django.permissions import get_rules
+from django.contrib.admin import ModelAdmin
+
+
+class GuardedModelAdmin(ModelAdmin):
+
+    def has_change_permission(self, request, obj=None):
+        if obj is not None:
+            return request.user.has_perm('change', obj)
+        else:
+            return super(GuardedModelAdmin, self) \
+                    .has_change_permission(request, obj)
+
+    def queryset(self, request):
+        return get_rules().filter_queryset(
+            request.user,
+            'change',
+            super(GuardedModelAdmin, self).queryset(request)
+        )
diff --git a/auf/django/permissions/forms.py b/auf/django/permissions/forms.py
new file mode 100644 (file)
index 0000000..84bca48
--- /dev/null
@@ -0,0 +1,50 @@
+from django import forms
+
+
+def make_global_permissions_form(base_form, global_permissions,
+                                 prefix='global.'):
+
+    class _GlobalPermissionsForm(forms.ModelForm):
+
+        def __init__(self, *args, **kwargs):
+            instance = kwargs.get('instance')
+            initial = kwargs.get('initial', {})
+            if instance:
+                perms = instance.global_permissions.get_permissions()
+            else:
+                perms = []
+            permission_data = {}
+            for field, label in global_permissions:
+                perm = prefix + field
+                permission_data[field] = perm in perms
+            permission_data.update(initial)
+            kwargs['initial'] = permission_data
+            super(_GlobalPermissionsForm, self).__init__(*args, **kwargs)
+
+        def save(self, commit=True):
+            instance = super(_GlobalPermissionsForm, self).save(commit=commit)
+            old_save_m2m = getattr(self, 'save_m2m')
+
+            def save_m2m():
+                if old_save_m2m:
+                    old_save_m2m()
+                for field, label in global_permissions:
+                    perm = prefix + field
+                    if self.cleaned_data[field]:
+                        instance.global_permissions.add_permission(perm)
+                    else:
+                        instance.global_permissions.remove_permission(perm)
+
+            if commit:
+                save_m2m()
+            else:
+                self.save_m2m = save_m2m
+            return instance
+
+    fields = {}
+    for field, label in global_permissions:
+        fields[field] = forms.BooleanField(
+            label=label, required=False
+        )
+    form = type('UserOrGroupForm', (_GlobalPermissionsForm, base_form), fields)
+    return form
index cc4454e..97d681f 100644 (file)
@@ -2,10 +2,25 @@ from django.contrib.auth.models import User, Group
 from django.db import models
 
 
+class GlobalPermissionManager(models.Manager):
+
+    def add_permission(self, codename):
+        self.get_or_create(codename=codename)
+
+    def remove_permission(self, codename):
+        self.filter(codename=codename).delete()
+
+    def get_permissions(self):
+        return set(p.codename for p in self.all())
+
+
 class GlobalUserPermission(models.Model):
     user = models.ForeignKey(User, related_name='global_permissions')
     codename = models.CharField(max_length=100)
+    objects = GlobalPermissionManager()
+
 
 class GlobalGroupPermission(models.Model):
     group = models.ForeignKey(Group, related_name='global_permissions')
     codename = models.CharField(max_length=100)
+    objects = GlobalPermissionManager()
index df20568..4b7651c 100644 (file)
@@ -6,12 +6,12 @@ find-links =
 develop = .
 eggs =
     auf.django.permissions
-versions = versions
 
 [django]
 recipe = auf.recipe.django
 project = tests
 settings = settings
 eggs = ${buildout:eggs}
-
-[versions]
+test =
+    food
+    simple_tests
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644 (file)
index 0000000..df07af4
--- /dev/null
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+       @echo "Please use \`make <target>' where <target> is one of"
+       @echo "  html       to make standalone HTML files"
+       @echo "  dirhtml    to make HTML files named index.html in directories"
+       @echo "  singlehtml to make a single large HTML file"
+       @echo "  pickle     to make pickle files"
+       @echo "  json       to make JSON files"
+       @echo "  htmlhelp   to make HTML files and a HTML help project"
+       @echo "  qthelp     to make HTML files and a qthelp project"
+       @echo "  devhelp    to make HTML files and a Devhelp project"
+       @echo "  epub       to make an epub"
+       @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+       @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+       @echo "  text       to make text files"
+       @echo "  man        to make manual pages"
+       @echo "  texinfo    to make Texinfo files"
+       @echo "  info       to make Texinfo files and run them through makeinfo"
+       @echo "  gettext    to make PO message catalogs"
+       @echo "  changes    to make an overview of all changed/added/deprecated items"
+       @echo "  linkcheck  to check all external links for integrity"
+       @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+       -rm -rf $(BUILDDIR)/*
+
+html:
+       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+       @echo
+       @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+       $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+       @echo
+       @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+       $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+       @echo
+       @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+       $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+       @echo
+       @echo "Build finished; now you can process the pickle files."
+
+json:
+       $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+       @echo
+       @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+       $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+       @echo
+       @echo "Build finished; now you can run HTML Help Workshop with the" \
+             ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+       $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+       @echo
+       @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+             ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+       @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/aufdjangopermissions.qhcp"
+       @echo "To view the help file:"
+       @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/aufdjangopermissions.qhc"
+
+devhelp:
+       $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+       @echo
+       @echo "Build finished."
+       @echo "To view the help file:"
+       @echo "# mkdir -p $$HOME/.local/share/devhelp/aufdjangopermissions"
+       @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/aufdjangopermissions"
+       @echo "# devhelp"
+
+epub:
+       $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+       @echo
+       @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+       @echo
+       @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+       @echo "Run \`make' in that directory to run these through (pdf)latex" \
+             "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+       @echo "Running LaTeX files through pdflatex..."
+       $(MAKE) -C $(BUILDDIR)/latex all-pdf
+       @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+       $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+       @echo
+       @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+       $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+       @echo
+       @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+       $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+       @echo
+       @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+       @echo "Run \`make' in that directory to run these through makeinfo" \
+             "(use \`make info' here to do that automatically)."
+
+info:
+       $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+       @echo "Running Texinfo files through makeinfo..."
+       make -C $(BUILDDIR)/texinfo info
+       @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+       $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+       @echo
+       @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+       $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+       @echo
+       @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+       $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+       @echo
+       @echo "Link check complete; look for any errors in the above output " \
+             "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+       $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+       @echo "Testing of doctests in the sources finished, look at the " \
+             "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644 (file)
index 0000000..a0756da
--- /dev/null
@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+#
+# auf.django.permissions documentation build configuration file, created by
+# sphinx-quickstart on Thu Mar  8 16:29:34 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'auf.django.permissions'
+copyright = u'2012, Eric Mc Sween'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.2'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'aufdjangopermissionsdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'aufdjangopermissions.tex', u'auf.django.permissions Documentation',
+   u'Eric Mc Sween', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'aufdjangopermissions', u'auf.django.permissions Documentation',
+     [u'Eric Mc Sween'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'aufdjangopermissions', u'auf.django.permissions Documentation',
+   u'Eric Mc Sween', 'aufdjangopermissions', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644 (file)
index 0000000..90f5c4b
--- /dev/null
@@ -0,0 +1,22 @@
+.. auf.django.permissions documentation master file, created by
+   sphinx-quickstart on Thu Mar  8 16:29:34 2012.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Documentation d'auf.django.permissions
+======================================
+
+.. toctree::
+   :maxdepth: 2
+
+   installation
+   utilisation
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/doc/installation.rst b/doc/installation.rst
new file mode 100644 (file)
index 0000000..e5ccc7c
--- /dev/null
@@ -0,0 +1,31 @@
+Installation
+============
+
+Installez l'app dans votre configuration Django::
+
+    INSTALLED_APPS = {
+        ...
+        'auf.django.permissions',
+        ...
+    }
+
+Puis, configurez le backend d'authentification::
+
+    AUTHENTICATION_BACKENDS = (
+        ...
+        'auf.django.permissions.AuthenticationBackend',
+        ...
+    )
+
+Vous devez maintenant créer un module qui contiendra vos règles d'accès. Par
+exemple: ``monprojet/permissions.py``. Au départ, il contiendra un jeu de règles
+vide::
+
+    from auf.django.permissions import Rules
+
+    rules = Rules()
+
+Vous pouvez maintenant retourner dans votre configuration Django et indiquer où
+se trouve votre jeu de règles::
+
+    AUF_PERMISSIONS_RULES = 'monprojet.permissions.rules'
diff --git a/doc/utilisation.rst b/doc/utilisation.rst
new file mode 100644 (file)
index 0000000..e39d3cf
--- /dev/null
@@ -0,0 +1,31 @@
+Utilisation
+===========
+
+Permissions globales
+--------------------
+
+``auf.django.permissions`` ajoute un système de permissions globales distinct de
+celui de Django. C'est un système très simple qui permet d'associer globalement
+une permission à un utilisateur. Ces permissions globales sont identifiées par
+une chaîne de caractères et, contrairement aux permissions Django, ne sont
+associées ni à une app, ni à un modèle.
+
+Ces permissions globales sont disponibles à partir du manager
+``global_permissions`` des objets ``User`` et ``Group`` de Django. Les objets
+gérés par ce manager ont un seul attribut, ``codename``, qui contient le nom de
+la permission à donner à l'utilisateur ou au groupe. On gère donc les
+permissions globales de la façon suivante::
+
+    user = User.objects.get(username='alice')
+
+    # Ajouter une permission
+    user.global_permissions.create(codename='monapp.voir_les_documents_confidentiels')
+
+    # Supprimer une permission
+    user.global_permissions.filter(codename='monapp.voir_les_fichiers_top_secret').delete()
+
+    # Afficher une liste de toutes les permissions
+    for p in user.global_permissions.all():
+        print p.codename
+
+
index 5086473..571345f 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -3,7 +3,7 @@
 from setuptools import setup, find_packages
 
 name = 'auf.django.permissions'
-version = '0.2'
+version = '0.3'
 
 setup(name=name,
       version=version,
@@ -16,4 +16,5 @@ setup(name=name,
       namespace_packages=['auf', 'auf.django'],
       include_package_data=True,
       zip_safe=False,
+      install_requires=['setuptools'],
      )
index 6f09729..b57cdaa 100644 (file)
@@ -5,13 +5,13 @@ from django.db.models import Q
 from django.http import HttpRequest
 from django.template import Template, RequestContext
 from django.utils import unittest
-from django.utils.text import normalize_newlines
 
-from auf.django.permissions import Predicate, AuthenticationBackend
+from auf.django.permissions import Predicate
 
 from tests.food.models import Food
 from tests.permissions import rules
 
+
 @Predicate
 def is_allergic(user, obj, cls):
     return Q(allergic_users=user)
@@ -66,10 +66,14 @@ class RulesTestCase(FoodTestCase):
 
     def test_q_rules(self):
         rules.allow('eat', Food, ~is_allergic)
-        self.assertListEqual(list(rules.filter_queryset(self.alice, 'eat', Food.objects.all())),
-                             [self.apple])
-        self.assertListEqual(list(rules.filter_queryset(self.bob, 'eat', Food.objects.all())),
-                             [self.apple, self.banana])
+        self.assertListEqual(
+            list(rules.filter_queryset(self.alice, 'eat', Food.objects.all())),
+            [self.apple]
+        )
+        self.assertListEqual(
+            list(rules.filter_queryset(self.bob, 'eat', Food.objects.all())),
+            [self.apple, self.banana]
+        )
         self.assertTrue(self.alice.has_perm('eat', self.apple))
         self.assertFalse(self.alice.has_perm('eat', self.banana))
 
@@ -122,5 +126,3 @@ Smoke {{ fruit.name }}: {{ fruit_perms.smoke|yesno }}
                                      "Smoke banana: no"
                                  ])
                                 )
-
-
index bbd9ede..eacd61b 100644 (file)
@@ -1,26 +1,27 @@
-DATABASES={
+DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.sqlite3',
         'NAME': ':memory:',
     }
 }
 
-INSTALLED_APPS=(
+INSTALLED_APPS = (
     'django.contrib.auth',
     'django.contrib.contenttypes',
     'auf.django.permissions',
     'tests.food',
+    'tests.simple_tests'
 )
 
-AUTHENTICATION_BACKENDS=(
+AUTHENTICATION_BACKENDS = (
     'auf.django.permissions.AuthenticationBackend',
 )
 
-TEMPLATE_LOADERS=(
+TEMPLATE_LOADERS = (
     'django.template.loaders.app_directories.Loader',
 )
 
-TEMPLATE_CONTEXT_PROCESSORS=(
+TEMPLATE_CONTEXT_PROCESSORS = (
     'django.core.context_processors.request',
 )
 
diff --git a/tests/simple_tests/__init__.py b/tests/simple_tests/__init__.py
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/tests/simple_tests/models.py b/tests/simple_tests/models.py
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/tests/simple_tests/tests.py b/tests/simple_tests/tests.py
new file mode 100644 (file)
index 0000000..03c78d7
--- /dev/null
@@ -0,0 +1,37 @@
+from __future__ import absolute_import
+
+from django.contrib.auth.models import User, Group
+from django.utils import unittest
+
+
+class GlobalPermsTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.alice = User.objects.create_user('alice', 'alice@example.com')
+
+    def test_add_remove_user_permissions(self):
+        self.alice.global_permissions.add_permission('open_door')
+        self.assertSetEqual(
+            self.alice.global_permissions.get_permissions(),
+            set(['open_door'])
+        )
+        self.alice.global_permissions.add_permission('close_door')
+        self.assertSetEqual(
+            self.alice.global_permissions.get_permissions(),
+            set(['open_door', 'close_door'])
+        )
+        self.alice.global_permissions.remove_permission('open_door')
+        self.assertSetEqual(
+            self.alice.global_permissions.get_permissions(),
+            set(['close_door'])
+        )
+        self.alice.global_permissions.add_permission('close_door')
+        self.assertSetEqual(
+            self.alice.global_permissions.get_permissions(),
+            set(['close_door'])
+        )
+        self.alice.global_permissions.remove_permission('open_door')
+        self.assertSetEqual(
+            self.alice.global_permissions.get_permissions(),
+            set(['close_door'])
+        )