projects / ckanext-datagovau.git / commitdiff
search:
summary | shortlog | log | commit | commitdiff | tree
unified | plain
Update ExampleDatasetForm, was broken by recent changes to IDatasetForm
Update ExampleDatasetForm, was broken by recent changes to IDatasetForm

file:b/.gitignore (new)
  *.egg-info
  *.pyc
  *.swp
  *.swo
  *~
  #*
  .#*
  build/
  dist/
  distribute-*
file:a/.hgignore (deleted)
syntax: glob  
*.egg-info  
*.pyc  
*.swp  
*.swo  
*~  
#*  
.#*  
build/  
dist/  
 
file:b/README.rst (new)
  This CKAN Extension demonstrates some common patterns for customising a CKAN instance.
 
  It comprises:
 
  * A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when
  loaded, overrides various settings in the core ``ini``-file to provide:
 
  * A path to local customisations of the core templates and stylesheets
  * A "stream filter" that replaces arbitrary strings in rendered templates
  * A "route" to override and extend the default behaviour of a core CKAN page
 
  * 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 custom User registration and edition form
 
  * Some simple template customisations
 
  Installation
  ============
 
  To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::
 
  pip install -e git+https://github.com/okfn/ckanext-example#egg=ckanext-example
 
  Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file.
 
  Orientation
  ===========
 
  * Examine the source code, starting with ``ckanext/example/plugin.py``
 
  * To understand the nuts and bolts of this file, which is a CKAN
  *Extension*, read in conjunction with the "Extension
  documentation": http://docs.ckan.org/en/latest/extensions.html
 
  * One thing the extension does is set the values of
  ``extra_public_paths`` and ``extra_template_paths`` in the CKAN
  config, which are "documented
  here": http://docs.ckan.org/en/latest/configuration.html#extra-template-paths
 
  * These are set to point at directories within
  ``ckanext/example/theme/`` (in this package). Here we:
  * override the home page HTML ``ckanext/example/theme/templates/home/index.html``
  * provide some extra style by serving ``extra.css`` (which is loaded using the ``ckan.template_head_end`` option
  * customise the navigation and header of the main template in the file ``layout.html``.
 
  The latter file is a great place to make global theme alterations.
  It uses the _layout template_ pattern "described in the Genshi
  documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate.
  This allows you to use Xpath selectors to override snippets of HTML
  globally.
 
  * The custom package edit form at ``package_form.py`` follows a deprecated
  way to make a form (using FormAlchemy). This part of the Example Theme needs
  updating. In the meantime, follow the instructions at:
  http://docs.ckan.org/en/latest/forms.html
 
  Example Tags With Vocabularies
  ==============================
 
  To add example tag vocabulary data to the database, from the ckanext-example directory run:
 
  ::
 
  paster example create-example-vocabs -c <path to your ckan config file>
 
  This data can be removed with
 
  ::
 
  paster example clean -c <path to your ckan config file>
 
 
file:a/README.txt (deleted)
This CKAN Extension demonstrates some common patterns for customising a CKAN instance.  
 
It comprises:  
 
* A CKAN Extension "plugin" at ``ckanext/exampletheme/plugin.py``  
which, when loaded, overrides various settings in the core  
``ini``-file to provide:  
 
* A path to local customisations of the core templates and stylesheets  
* A "stream filter" that replaces arbitrary strings in rendered templates  
* A "route" to override and extend the default behaviour of a core CKAN page  
 
* A custom Pylons controller for overriding some core CKAN behaviour  
 
* A custom Package edit form  
 
* Some simple template customisations  
 
Installation  
============  
 
To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::  
 
pip install -e hg+https://bitbucket.org/okfn/ckanext-exampletheme#egg=ckanext-exampletheme  
 
Then activate it by setting ``ckan.plugins = exampletheme`` in your main ``ini``-file.  
 
 
Orientation  
===========  
 
* Examine the source code, starting with ``ckanext/exampletheme/plugin.py``  
 
* To understand the nuts and bolts of this file, which is a CKAN  
*Extension*, read in conjunction with the "Extension  
documentation":http://packages.python.org/ckan/plugins.html  
 
* One thing the extension does is set the values of  
``extra_public_paths`` and ``extra_template_paths`` in the CKAN  
config, which are "documented  
here":http://packages.python.org/ckan/configuration.html#extra-template-paths  
 
* These are set to point at directories within  
`ckanext/exampletheme/theme/`` (in this package). Here, we override  
the home page, provide some extra style with an ``extra.css``, and  
customise the navigation and header of the main template in the file ``layout.html``.  
 
The latter file is a great place to make global theme alterations.  
It uses the _layout template_ pattern "described in the Genshi  
documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate.  
This allows you to use Xpath selectors to override snippets of HTML  
globally.  
 
* The custom package edit form at ``package_form.py`` follows the  
conventions in the "main CKAN  
documentation":http://packages.python.org/ckan/forms.html  
 
file:b/ckanext/example/__init__.py (new)
  # package
 
file:b/ckanext/example/commands.py (new)
  from ckan import model
  from ckan.lib.cli import CkanCommand
  from ckan.logic import get_action, NotFound
  import forms
 
  import logging
  log = logging.getLogger()
 
 
  class ExampleCommand(CkanCommand):
  '''
  CKAN Example Extension
 
  Usage::
 
  paster example create-example-vocabs -c <path to config file>
 
  paster example clean -c <path to config file>
  - Remove all data created by ckanext-example
 
  The commands should be run from the ckanext-example directory.
  '''
  summary = __doc__.split('\n')[0]
  usage = __doc__
 
  def command(self):
  '''
  Parse command line arguments and call appropriate method.
  '''
  if not self.args or self.args[0] in ['--help', '-h', 'help']:
  print ExampleCommand.__doc__
  return
 
  cmd = self.args[0]
  self._load_config()
 
  if cmd == 'create-example-vocabs':
  self.create_example_vocabs()
  if cmd == 'clean':
  self.clean()
  else:
  log.error('Command "%s" not recognized' % (cmd,))
 
  def create_example_vocabs(self):
  '''
  Adds example vocabularies to the database if they don't already exist.
  '''
  user = get_action('get_site_user')({'model': model, 'ignore_auth': True}, {})
  context = {'model': model, 'session': model.Session, 'user': user['name']}
 
  try:
  data = {'id': forms.GENRE_VOCAB}
  get_action('vocabulary_show')(context, data)
  log.info("Example genre vocabulary already exists, skipping.")
  except NotFound:
  log.info("Creating vocab %s" % forms.GENRE_VOCAB)
  data = {'name': forms.GENRE_VOCAB}
  vocab = get_action('vocabulary_create')(context, data)
  log.info("Adding tag %s to vocab %s" % ('jazz', forms.GENRE_VOCAB))
  data = {'name': 'jazz', 'vocabulary_id': vocab['id']}
  get_action('tag_create')(context, data)
  log.info("Adding tag %s to vocab %s" % ('soul', forms.GENRE_VOCAB))
  data = {'name': 'soul', 'vocabulary_id': vocab['id']}
  get_action('tag_create')(context, data)
 
  try:
  data = {'id': forms.COMPOSER_VOCAB}
  get_action('vocabulary_show')(context, data)
  log.info("Example composer vocabulary already exists, skipping.")
  except NotFound:
  log.info("Creating vocab %s" % forms.COMPOSER_VOCAB)
  data = {'name': forms.COMPOSER_VOCAB}
  vocab = get_action('vocabulary_create')(context, data)
  log.info("Adding tag %s to vocab %s" % ('Bob Mintzer', forms.COMPOSER_VOCAB))
  data = {'name': 'Bob Mintzer', 'vocabulary_id': vocab['id']}
  get_action('tag_create')(context, data)
  log.info("Adding tag %s to vocab %s" % ('Steve Lewis', forms.COMPOSER_VOCAB))
  data = {'name': 'Steve Lewis', 'vocabulary_id': vocab['id']}
  get_action('tag_create')(context, data)
 
  def clean(self):
  log.error("Clean command not yet implemented")
 
file:b/ckanext/example/controller.py (new)
  import sys
  from ckan.lib.base import request
  from ckan.lib.base import c, g, h
  from ckan.lib.base import model
  from ckan.lib.base import render
  from ckan.lib.base import _
 
  from ckan.lib.navl.validators import not_empty
 
  from ckan.controllers.user import UserController
 
 
  class CustomUserController(UserController):
  """This controller is an example to show how you might extend or
  override core CKAN behaviour from an extension package.
 
  It overrides 2 method hooks which the base class uses to create the
  validation schema for the creation and editing of a user; to require
  that a fullname is given.
  """
 
  new_user_form = 'user/register.html'
 
  def _add_requires_full_name_to_schema(self, schema):
  """
  Helper function that modifies the fullname validation on an existing schema
  """
  schema['fullname'] = [not_empty, unicode]
 
  def _new_form_to_db_schema(self):
  """
  Defines a custom schema that requires a full name to be supplied
 
  This method is a hook that the base class calls for the validation
  schema to use when creating a new user.
  """
  schema = super(CustomUserController, self)._new_form_to_db_schema()
  self._add_requires_full_name_to_schema(schema)
  return schema
 
  def _edit_form_to_db_schema(self):
  """
  Defines a custom schema that requires a full name cannot be removed
  when editing the user.
 
  This method is a hook that the base class calls for the validation
  schema to use when editing an exiting user.
  """
  schema = super(CustomUserController, self)._edit_form_to_db_schema()
  self._add_requires_full_name_to_schema(schema)
  return schema
 
 
file:b/ckanext/example/forms.py (new)
  import os
  import logging
  from pylons import tmpl_context as c
  from ckan.authz import Authorizer
  from ckan.logic.converters import convert_to_extras,\
  convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only
  from ckan.logic import get_action, NotFound
  from ckan.logic.schema import package_form_schema, group_form_schema
  from ckan.lib.base import c, model
  from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer
  from ckan.plugins import IGenshiStreamFilter
  from ckan.plugins import implements, SingletonPlugin
  from ckan.lib.navl.validators import ignore_missing, keep_extras
  import ckan.lib.plugins
 
  log = logging.getLogger(__name__)
 
  GENRE_VOCAB = u'genre_vocab'
  COMPOSER_VOCAB = u'composer_vocab'
 
 
  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):
  """