0.1.0 Version initial commit.

Author: Alexandr Shurigin

.gitignore

@@ -0,0 +1,2 @@
+*.egg-info/
+.idea/

README.markdown

@@ -0,0 +1,103 @@
+# [Django Macros Url](https://github.com/phpdude/django-macros-url/) v0.1.0 - Routing must be simple as possible
+
+Django Macros Url makes it easy to write (and read) url patterns in your django applications by using macros.
+
+You can combine your prefixes with macro names with underscope, for example you can use macro `:slug` and `:product_slug`. They both will be compiled to same regex pattern with their group names of course. Multiple underscopes accepted too.
+
+### Supported macros by default
+
+```
+slug - [\w-]+
+year - \d{4}
+month - (0?([1-9])|10|11|12)
+day - ((0|1|2)?([1-9])|[1-3]0|31)
+id - \d+
+uuid - [a-fA-F0-9]{8}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{12}
+```
+
+If you want to offer more macros by default, you can fork and make pull request.
+
+### Usage
+
+Django Macros Urls used same way as django standart urls. You just import this and declare your patterns with macros.
+
+Also you can register new macro (or maybe you want to replace default macro with your like regex pattern) with `macrosurl.register(macro, pattern)` method.
+
+Example of registration.
+
+```python
+import macrosurl
+
+macrosurl.register('myhash', '[a-f0-9]{9}')
+
+urlpatterns = patterns(
+    'yourapp.views',
+    url('^:myhash/$', 'myhash_main'),
+    url('^news/:news_myhash/$', 'myhash_news'),
+)
+```
+
+You free to register custom macro anywhere (i do it in main urls.py file). Macros Urls uses lazy initiazation. Macros will be compiled only on first request.
+
+### Urls normalization
+
+Once Macros Url finished compile regex pattern, it makes normalization of it by rules:
+
+- Strip from left side all whitespace and ^
+- Strip from right side of pattern all whitespace and $
+- Add to left side ^
+- Add to right side $
+
+This makes your urls always very strong to adding any unexpected params into path.
+
+### Examples
+
+Macro Url example urls.py file
+
+```python
+from django.conf.urls import patterns
+from project.apps.portal import views
+from project.apps.macrosurl import url
+
+
+urlpatterns = patterns(
+    'yourapp.views',
+    url('^:category_slug/$', 'category'),
+    url('^:category_slug/:product_slug/$', 'category_product'),
+    url('^:category_slug/:product_slug/:variant_id$', 'category_product_variant'),
+    url('^news/$', 'news'),
+    url('^news/:year/:month/:day$', 'news_date'),
+    url('^news/:slug$', 'news_entry'),
+    url('^order/:id$', 'order'),
+)
+```
+
+Django way urls example
+
+```python
+from django.conf.urls import patterns
+from project.apps.portal import views
+from project.apps.macrosurl import url
+
+
+urlpatterns = patterns(
+    'yourapp.views',
+    url('^(?P<category_slug>[\w-]+>)/$', 'category'),
+    url('^(?P<category_slug>[\w-]+>)/(?P<product_slug>[\w-]+>)/$', 'category_product'),
+    url('^(?P<category_slug>[\w-]+>)/(?P<product_slug>[\w-]+>)/(?P<variant_id>\d+>)$', 'category_product_variant'),
+    url('^news/$', 'news'),
+    url('^news/(?P<year>\d{4}>)/(?P<month>(0?([1-9])|10|11|12)>)/(?P<day>((0|1|2)?([1-9])|[1-3]0|31)>)$', 'news_date'),
+    url('^news/(?P<slug>[\w-]+>)$', 'news_entry'),
+    url('^order/(?P<id>\d+>)$', 'order'),
+)
+```
+
+I think you simple understand the difference of ways :)
+
+#### Routing must be simple! ;-)
+
+I think real raw url regexp patterns need in 1% case only. Prefer simple way to write (and read, this is important) fancy clean urls.
+
+### Contributor
+
+Alexandr Shurigin (aka [phpdude](https://github.com/phpdude/))

macrosurl/__init__.py

@@ -0,0 +1,68 @@
+import re
+
+from django.conf.urls import url as baseurl
+
+VERSION = (0, 1, 0)
+
+_macros_library = {
+    'id': r'\d+',
+    'slug': r'[\w-]+',
+    'year': r'\d{4}',
+    'month': r'(0?([1-9])|10|11|12)',
+    'day': r'((0|1|2)?([1-9])|[1-3]0|31)',
+    'date': r'\d{4}-(0?([1-9])|10|11|12)-((0|1|2)?([1-9])|[1-3]0|31)',
+    'uuid': r'[a-fA-F0-9]{8}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{12}'
+}
+
+
+def get_version(*args, **kwargs):
+    return ".".join(map(str, VERSION))
+
+
+def register(macros, pattern):
+    _macros_library[macros] = pattern
+
+
+def regex_group(macro, pattern):
+    return '(?P<%s>%s)' % (macro, pattern)
+
+
+def normalize_pattern(url):
+    return '^%s$' % url.lstrip("^ \n").rstrip("$ \n")
+
+
+class MacroUrlPattern(object):
+    def __init__(self, pattern):
+        self.pattern = pattern
+
+
+    def compile(self):
+        pattern = self.pattern
+        macros = re.findall('(:([a-z_\d]+))', pattern)
+        for match, macro in macros:
+            if macro in _macros_library:
+                pattern = pattern.replace(match, regex_group(macro, _macros_library[macro]))
+            else:
+                for _macro in _macros_library:
+                    if macro.endswith("_%s" % _macro):
+                        pattern = pattern.replace(match, regex_group(macro, _macros_library[_macro]))
+                        continue
+
+        return normalize_pattern(pattern)
+
+    @property
+    def compiled(self):
+        if not hasattr(self, '_compiled'):
+            setattr(self, '_compiled', self.compile())
+
+        return getattr(self, '_compiled')
+
+    def __str__(self):
+        return self.compiled
+
+    def __unicode__(self):
+        return self.__str__()
+
+
+def url(regex, view, kwargs=None, name=None, prefix=''):
+    return baseurl(MacroUrlPattern(regex), view, kwargs=kwargs, name=name, prefix=prefix)

setup.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+import os
+
+from setuptools import setup, find_packages
+
+
+def read(filename):
+    return open(os.path.join(os.path.dirname(__file__), filename)).read()
+
+
+setup(
+    name='django-macros-url',
+    version=__import__('macrosurl').get_version(),
+    author='Alexandr Shurigin',
+    author_email='alexandr.shurigin@gmail.com',
+    description='Macros Url library for django',
+    license='BSD',
+    keywords='django macros url pattern regex',
+    url='https://github.com/phpdude/django-macros-url',
+    packages=find_packages(exclude=['tests']),
+    include_package_data=True,
+    test_suite='tests',
+    long_description=read("README.markdown"),
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Console',
+        'Environment :: Plugins',
+        'Framework :: Django',
+        'Intended Audience :: Developers',
+        'Intended Audience :: System Administrators',
+        'Intended Audience :: Information Technology',
+        'License :: OSI Approved :: MIT License',
+        'Natural Language :: English',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Internet :: WWW/HTTP :: WSGI',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Topic :: Software Development :: Pre-processors'
+    ],
+    requires=['django']
+)

tests/__init__.py

@@ -0,0 +1 @@
+__author__ = 'dude'

tests/urls.py

@@ -0,0 +1,117 @@
+import unittest
+import uuid
+
+from django.conf import settings
+
+from macrosurl import MacroUrlPattern, url
+
+
+class TestRegexCompilation(unittest.TestCase):
+    def test_nomacro(self):
+        self.assertEqual(MacroUrlPattern('^$').compiled, '^$')
+        self.assertEqual(MacroUrlPattern('^news/all/$').compiled, '^news/all/$')
+        self.assertEqual(MacroUrlPattern('^news/all/$').compiled, '^news/all/$')
+        self.assertEqual(MacroUrlPattern('^news/all/$').compiled, '^news/all/$')
+        self.assertEqual(MacroUrlPattern('^news/:news/$').compiled, '^news/:news/$')
+
+    def test_normalize_url(self):
+        self.assertEqual(MacroUrlPattern('').compiled, '^$')
+        self.assertEqual(MacroUrlPattern('news/all/').compiled, '^news/all/$')
+        self.assertEqual(MacroUrlPattern('^news/all/$').compiled, '^news/all/$')
+        self.assertEqual(MacroUrlPattern('^news/all/').compiled, '^news/all/$')
+
+    def test_strip_whitespace(self):
+        self.assertEqual(MacroUrlPattern('').compiled, '^$')
+        self.assertEqual(MacroUrlPattern(' news/all/').compiled, '^news/all/$')
+        self.assertEqual(MacroUrlPattern('^news/all/$ ').compiled, '^news/all/$')
+        self.assertEqual(MacroUrlPattern(' ^news/all/ ').compiled, '^news/all/$')
+        self.assertEqual(MacroUrlPattern(' ^news/all/ \n').compiled, '^news/all/$')
+
+    def test_id(self):
+        self.assertEqual(MacroUrlPattern('page/:id').compiled, '^page/(?P<id>\d+)$')
+        self.assertEqual(MacroUrlPattern('product/:product_id').compiled, '^product/(?P<product_id>\d+)$')
+        self.assertEqual(MacroUrlPattern('product/:id/:product_id').compiled,
+                         '^product/(?P<id>\d+)/(?P<product_id>\d+)$')
+        self.assertEqual(MacroUrlPattern('product/:id/:product_id/:news_id').compiled,
+                         '^product/(?P<id>\d+)/(?P<product_id>\d+)/(?P<news_id>\d+)$')
+
+    def test_slug(self):
+        self.assertEqual(MacroUrlPattern('page/:slug').compiled, '^page/(?P<slug>[\w-]+)$')
+        self.assertEqual(MacroUrlPattern('page/:category_slug/:slug').compiled,
+                         '^page/(?P<category_slug>[\w-]+)/(?P<slug>[\w-]+)$')
+
+    def test_year(self):
+        self.assertEqual(MacroUrlPattern('news/:year').compiled, '^news/(?P<year>\d{4})$')
+
+    def test_year_month(self):
+        self.assertEqual(MacroUrlPattern('news/:year/:month').compiled,
+                         '^news/(?P<year>\d{4})/(?P<month>(0?([1-9])|10|11|12))$')
+
+    def test_year_month_day(self):
+        self.assertEqual(MacroUrlPattern('news/:year/:month/:day/').compiled,
+                         '^news/(?P<year>\d{4})/(?P<month>(0?([1-9])|10|11|12))/(?P<day>((0|1|2)?([1-9])|[1-3]0|31))/$')
+
+    def test_date(self):
+        self.assertEqual(MacroUrlPattern('news/:date/').compiled,
+                         '^news/(?P<date>\d{4}-(0?([1-9])|10|11|12)-((0|1|2)?([1-9])|[1-3]0|31))/$')
+
+    def test_uid(self):
+        self.assertEqual(MacroUrlPattern('invoice/:uuid').compiled,
+                         '^invoice/(?P<uuid>[a-fA-F0-9]{8}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{12})$')
+
+    def test_strongurl(self):
+        self.assertEqual(MacroUrlPattern('orders/:date/:uuid/products/:slug/:variant_id').compiled,
+                         '^orders/(?P<date>\\d{4}-(0?([1-9])|10|11|12)-((0|1|2)?([1-9])|[1-3]0|31))/(?P<uuid>[a-fA-F0-9]{8}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{12})/products/(?P<slug>[\\w-]+)/(?P<variant_id>\\d+)$')
+
+
+class TestRegexUrlResolving(unittest.TestCase):
+    def setUp(self):
+        if not settings.configured:
+            settings.configure(USE_I18N=False)
+
+    def test_id(self):
+        self.assertIsNone(url('product/:id', 'view').resolve('product/test'))
+        self.assertIsNotNone(url('product/:id', 'view').resolve('product/10'))
+        self.assertEqual(url('product/:id', 'view').resolve('product/10').kwargs['id'], '10')
+        self.assertEqual(url('product/:product_id', 'view').resolve('product/10').kwargs['product_id'], '10')
+
+    def test_slug(self):
+        self.assertIsNone(url('product/:slug', 'view').resolve('product/test/ouch'))
+        self.assertIsNotNone(url('product/:slug', 'view').resolve('product/test'))
+        self.assertIsNotNone(url('product/:slug/:other_slug', 'view').resolve('product/test/other'))
+
+    def test_year(self):
+        self.assertIsNone(url('news/:year', 'view').resolve('news/last'))
+        for y in range(1970, 2025):
+            self.assertIsNotNone(url('news/:year', 'view').resolve('news/%s' % y))
+        self.assertIsNone(url('news/:year/last', 'view').resolve('news/2014/other'))
+        self.assertIsNotNone(url('news/:year/last', 'view').resolve('news/2014/last'))
+
+    def test_year_month(self):
+        self.assertIsNone(url('news/:year/:month', 'view').resolve('news/2014/last'))
+        self.assertIsNone(url('news/:year/:month', 'view').resolve('news/2014/2012'))
+        for y in range(1970, 2025):
+            for m in range(1, 12):
+                self.assertIsNotNone(url('news/:year/:month', 'view').resolve('news/%s/%s' % (y, m)))
+
+        self.assertIsNotNone(url('news/:year/:month/last', 'view').resolve('news/2014/12/last'))
+
+    def test_year_month_day(self):
+        self.assertIsNone(url('news/:year/:month/:day', 'view').resolve('news/2014/12/last'))
+        self.assertIsNone(url('news/:year/:month/:day', 'view').resolve('news/2014/2012/31'))
+        for y in range(2000, 2020):
+            for m in range(1, 12):
+                for d in range(1, 31):
+                    self.assertIsNotNone(url('news/:year/:month/:day', 'view').resolve('news/%s/%s/%s' % (y, m, d)))
+
+    def test_date(self):
+        self.assertIsNone(url('news/:date', 'view').resolve('news/2014/12/12'))
+        for y in range(2000, 2020):
+            for m in range(1, 12):
+                for d in range(1, 31):
+                    self.assertIsNotNone(url('news/:date', 'view').resolve('news/%s-%s-%s' % (y, m, d)))
+
+    def test_uuid(self):
+        self.assertIsNone(url("invoice/:uuid", 'view').resolve('invoice/123123-123123-1231231-1231312-3-1312312-'))
+        for i in range(1, 1000):
+            self.assertIsNotNone(url("invoice/:uuid", 'view').resolve('invoice/%s' % uuid.uuid4()))