From: John Glover Date: Tue, 31 Jan 2012 12:18:46 +0000 Subject: [setup] tidy up X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=151a4adc8543f668c797eeb26d469aa81cde1fb1 --- [setup] tidy up --- --- a/README.rst +++ b/README.rst @@ -12,6 +12,8 @@ * A custom Pylons controller for overriding some core CKAN behaviour * A custom Package edit form + +* A custom Group edit form * A plugin that allows for custom forms to be used for datasets based on their "type". --- a/ckanext/example/forms.py +++ b/ckanext/example/forms.py @@ -7,6 +7,7 @@ from ckan.logic import NotFound, NotAuthorized, ValidationError from ckan.logic import tuplize_dict, clean_dict, parse_params import ckan.logic.schema as default_schema +from ckan.logic.schema import group_form_schema from ckan.logic.schema import package_form_schema import ckan.logic.validators as val from ckan.lib.base import BaseController, render, c, model, abort, request @@ -16,7 +17,7 @@ from ckan.lib.navl.dictization_functions import Invalid from ckan.lib.navl.dictization_functions import validate, missing from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten -from ckan.plugins import IDatasetForm, IConfigurer +from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer from ckan.plugins import implements, SingletonPlugin from ckan.lib.navl.validators import (ignore_missing, @@ -28,7 +29,94 @@ log = logging.getLogger(__name__) - +class ExampleGroupForm(SingletonPlugin): + """This plugin demonstrates how a class packaged as a CKAN + extension might extend CKAN behaviour by providing custom forms + based on the type of a Group. + + In this case, we implement two extension interfaces to provide custom + forms for specific types of group. + + - ``IConfigurer`` allows us to override configuration normally + found in the ``ini``-file. Here we use it to specify where the + form templates can be found. + + - ``IGroupForm`` allows us to provide a custom form for a dataset + based on the 'type' that may be set for a group. Where the + 'type' matches one of the values in group_types then this + class will be used. + """ + implements(IGroupForm, inherit=True) + implements(IConfigurer, inherit=True) + + def update_config(self, config): + """ + This IConfigurer implementation causes CKAN to look in the + ```templates``` directory when looking for the group_form() + """ + here = os.path.dirname(__file__) + rootdir = os.path.dirname(os.path.dirname(here)) + template_dir = os.path.join(rootdir, 'ckanext', + 'example', 'theme', 'templates') + config['extra_template_paths'] = ','.join([template_dir, + config.get('extra_template_paths', '')]) + + def group_form(self): + """ + Returns a string representing the location of the template to be + rendered. e.g. "forms/group_form.html". + """ + return 'forms/group_form.html' + + def group_types(self): + """ + Returns an iterable of group type strings. + + If a request involving a group of one of those types is made, then + this plugin instance will be delegated to. + + There must only be one plugin registered to each group type. Any + attempts to register more than one plugin instance to a given group + type will raise an exception at startup. + """ + return ["testgroup"] + + def is_fallback(self): + """ + Returns true iff this provides the fallback behaviour, when no other + plugin instance matches a group's type. + + As this is not the fallback controller we should return False. If + we were wanting to act as the fallback, we'd return True + """ + return False + + def form_to_db_schema(self): + """ + Returns the schema for mapping group data from a form to a format + suitable for the database. + """ + return group_form_schema() + + def db_to_form_schema(self): + """ + Returns the schema for mapping group data from the database into a + format suitable for the form (optional) + """ + return {} + + def check_data_dict(self, data_dict): + """ + Check if the return data is correct. + + raise a DataError if not. + """ + + def setup_template_variables(self, context, data_dict): + """ + Add variables to c just prior to the template being rendered. + """ + class ExampleDatasetForm(SingletonPlugin): """This plugin demonstrates how a theme packaged as a CKAN @@ -64,7 +152,7 @@ Returns a string representing the location of the template to be rendered. e.g. "package/new_package_form.html". """ - return 'controller/package_plugin.html' + return 'forms/dataset_form.html' def is_fallback(self): """ @@ -87,7 +175,7 @@ attempts to register more than one plugin instance to a given package type will raise an exception at startup. """ - return ["example"] + return ["example_dataset_form"] def setup_template_variables(self, context, data_dict=None): """ @@ -113,7 +201,6 @@ schema = { 'title': [not_empty, unicode], 'name': [not_empty, unicode, val.name_validator, val.package_name_validator], - 'notes': [not_empty, unicode], 'date_released': [date_to_db, convert_to_extras], 'date_updated': [date_to_db, convert_to_extras], --- a/ckanext/example/plugin.py +++ b/ckanext/example/plugin.py @@ -21,9 +21,11 @@ found in the ``ini``-file. Here we use it to specify the site title, and to tell CKAN to look in this package for templates and resources that customise the core look and feel. + - ``IGenshiStreamFilter`` allows us to filter and transform the HTML stream just before it is rendered. In this case we use it to rename "frob" to "foobar" + - ``IRoutes`` allows us to add new URLs, or override existing URLs. In this example we use it to override the default ``/register`` behaviour with a custom controller --- a/ckanext/example/theme/templates/forms/dataset_form.html +++ b/ckanext/example/theme/templates/forms/dataset_form.html @@ -12,7 +12,7 @@ -
+
Basic information
@@ -37,7 +37,7 @@
-
+
Details
@@ -95,7 +95,7 @@
${errors.get('taxonomy_url', '')}
-
+
Resources @@ -125,7 +125,7 @@
Package resource(s) incomplete.
-
+
More details
--- /dev/null +++ b/ckanext/example/theme/templates/forms/group_form.html @@ -1,1 +1,102 @@ +
+
+

Errors in form

+

The form contains invalid entries:

+
    +
  • ${"%s: %s" % (key, error)}
    • +
+
+ +
+
+
+
+ +
+
+ ${g.site_url+h.url_for(controller='group', action='index')+'/'}  + +

 

+
+ +
${errors.get('name', '')}
+ +
+
+
    +
    • +
    • +
+ + + You can use Markdown formatting here. +
+ + +
+
+ +
+
+
+ +
+

Extras

+
+ + +
+
+ + + Delete +
+ + + +
+
+ + with value + +
+ + +
+
+ +
+

Datasets

+
+ +
+
+ +
+ +
+

There are no datasets currently in this group.

+ +

Add datasets

+
+
+
+
+
+ +
+ + + + +
+ + --- a/ckanext/example/theme/templates/home/index.html +++ b/ckanext/example/theme/templates/home/index.html @@ -22,6 +22,7 @@

Here is the frob

+ ${select("*")} --- a/ckanext/example/theme/templates/layout.html +++ b/ckanext/example/theme/templates/layout.html @@ -9,9 +9,10 @@
- ${h.nav_link(c, _('Home'), controller='home', action='index', id=None)} - ${h.nav_link(c, _('Data'), controller='package', action='index', id=None)} - ${h.nav_link(c, _('New dataset'), controller='package', action='new', id=None)} + ${h.nav_link(c, _('Home'), controller='home', action='index')} + ${h.nav_link(c, _('Data'), controller='package', action='index')} + ${h.nav_link(c, _('New dataset'), controller='package', action='new')} + ${h.nav_link(c, _('New group'), controller='group', action='new')}
--- a/setup.py +++ b/setup.py @@ -1,14 +1,12 @@ from setuptools import setup, find_packages -import sys, os version = '0.2' setup( name='ckanext-example', version=version, - description="Example extension for customising CKAN", - long_description="""\ - """, + description='Example extension for customising CKAN', + long_description='', classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers keywords='', author='Seb Bacon', @@ -27,6 +25,7 @@ [ckan.plugins] example=ckanext.example.plugin:ExamplePlugin example_datasetform=ckanext.example.forms:ExampleDatasetForm + example_groupform=ckanext.example.forms:ExampleGroupForm [ckan.forms] example_form = ckanext.example.package_form:get_example_fieldset