Merge pull request #16 from agiliq/16-admin

Allow easy inclusion with Admin

README.md

@@ -17,7 +17,7 @@ Parsley plays well with `crispy-forms` et all.
 ### Installation
 
 1. pip install `parsley` (or add to your requirements.txt)
-2. Because we do not add any models, add `parsley` to your `INSTALLED_APPS` is not necessary.
+2. add `parsley` to your `INSTALLED_APPS` (required for static files added by mixin)
 
 ### Usage
 
@@ -64,6 +64,16 @@ Put this form inside a
 
 Include the parsleyjs and you are good to go.
 
+
+### Admin
+
+To add parsley validations to admin, use the `ParsleyAdminMixin` with your `ModelAdmin` like so:
+
+    class StudentAdmin(ParsleyAdminMixin, admin.ModelAdmin):
+        pass
+
+Note that the above mixin adds two scripts: `parsley-standalone.min.js` and `parsley.django-admin.js` to the admin media.
+
 ### Advanced Usage
 
 In addition to the default validators if you want to add extra client side validations

example/core/admin.py

@@ -0,0 +1,14 @@
+from django.contrib import admin
+
+from django.contrib.auth.models import User
+from django.contrib.auth.admin import UserAdmin
+
+from parsley.mixins import ParsleyAdminMixin
+
+
+class MyUserAdmin(ParsleyAdminMixin, UserAdmin):
+    pass
+
+
+admin.site.unregister(User)
+admin.site.register(User, MyUserAdmin)

example/example/settings/common.py

@@ -62,7 +62,7 @@
 
 # URL prefix for static files.
 # Example: "http://media.lawrence.com/static/"
-STATIC_URL = '/static/django_parsley/'
+STATIC_URL = '/static/'
 
 # Additional locations of static files
 STATICFILES_DIRS = (
@@ -118,9 +118,10 @@
     'django.contrib.sites',
     'django.contrib.messages',
     'django.contrib.staticfiles',
+    'django.contrib.admin',
     'core',
+    'parsley',
     # Uncomment the next line to enable the admin:
-    # 'django.contrib.admin',
     # Uncomment the next line to enable admin documentation:
     # 'django.contrib.admindocs',
 )

example/example/urls.py

@@ -1,9 +1,12 @@
-from django.conf.urls import patterns, url
+from django.contrib import admin
+from django.conf.urls import patterns, url, include
 
 from core.views import HomeView
 
+admin.autodiscover()
 
-urlpatterns = patterns(
-    'core.views',
+
+urlpatterns = patterns('core.views',
+    url(r'^admin/', include(admin.site.urls)),
     url(r'^$', HomeView.as_view(), name='home'),
 )

parsley/mixins.py

@@ -0,0 +1,14 @@
+from parsley.decorators import parsleyfy
+
+
+class ParsleyAdminMixin(object):
+
+    def get_form(self, *args, **kwargs):
+        form = super(ParsleyAdminMixin, self).get_form(*args, **kwargs)
+        return parsleyfy(form)
+
+    class Media:
+        js = (
+            "parsley/js/parsley-standalone.min.js",
+            "parsley/js/parsley.django-admin.js",
+        )

parsley/static/parsley/js/parsley.django-admin.js

@@ -0,0 +1,29 @@
+/*
+ * Parsley.js - django admin helper
+*/
+
+!function ($) {
+  'use strict';
+
+  $( window ).on( 'load', function () {
+    $( 'form' ).each( function () {
+      $( this ).parsley({
+          animate: false,
+          errors: {
+              errorsWrapper: '<ul class="errorlist"></ul>',
+              container: function (element, isRadioOrCheckbox) {
+                  return $("<div />").prependTo(element.closest(".form-row"));
+              }
+          },
+          listeners: {
+              onFieldError: function (element) {
+                  var container = element.closest(".form-row");
+                  if (container.not(".errors")) {
+                      container.addClass("errors");
+                  }
+              }
+          }
+      });
+    } );
+  } );
+}(window.jQuery || window.Zepto);