From: Sean Hammond Date: Tue, 20 Mar 2012 16:24:48 +0000 Subject: Update ExampleDatasetForm, was broken by recent changes to IDatasetForm X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=1e8edbb4cb8d89c64e2272d60816bee01a7f6cd9 --- Update ExampleDatasetForm, was broken by recent changes to IDatasetForm --- --- a/README.rst +++ b/README.rst @@ -31,7 +31,6 @@ Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file. - Orientation =========== @@ -39,7 +38,7 @@ * 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/plugins.html + 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 @@ -61,6 +60,21 @@ * 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://readthedocs.org/docs/ckan/en/latest/forms.html + 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 + +This data can be removed with + +:: + + paster example clean -c --- /dev/null +++ b/ckanext/example/commands.py @@ -1,1 +1,83 @@ +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 + + paster example clean -c + - 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") + --- a/ckanext/example/forms.py +++ b/ckanext/example/forms.py @@ -1,22 +1,30 @@ -import os, logging +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 +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, IConfigurable +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, not_empty, keep_extras +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 + In this case, we implement two extension interfaces to provide custom forms for specific types of group. - ``IConfigurer`` allows us to override configuration normally @@ -29,7 +37,7 @@ class will be used. """ implements(IGroupForm, inherit=True) - implements(IConfigurer, inherit=True) + implements(IConfigurer, inherit=True) def update_config(self, config): """ @@ -47,7 +55,7 @@ """ 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): @@ -100,7 +108,7 @@ """ -class ExampleDatasetForm(SingletonPlugin): +class ExampleDatasetForm(SingletonPlugin, ckan.lib.plugins.DefaultDatasetForm): """This plugin demonstrates how a theme packaged as a CKAN extension might extend CKAN behaviour. @@ -110,13 +118,13 @@ found in the ``ini``-file. Here we use it to specify where the form templates can be found. - ``IDatasetForm`` allows us to provide a custom form for a dataset - based on the type_name that may be set for a package. Where the - type_name matches one of the values in package_types then this - class will be used. + based on the type_name that may be set for a package. Where the + type_name matches one of the values in package_types then this + class will be used. """ implements(IDatasetForm, inherit=True) implements(IConfigurer, inherit=True) - implements(IConfigurable) + implements(IGenshiStreamFilter, inherit=True) def update_config(self, config): """ @@ -130,30 +138,11 @@ config['extra_template_paths'] = ','.join([template_dir, config.get('extra_template_paths', '')]) - def configure(self, config): - """ - Adds our new vocabulary to the database if it doesn't - already exist. - """ - self.vocab_name = u'example_vocab' - v = model.Vocabulary.get(self.vocab_name) - if not v: - log.info("Adding vocab %s" % self.vocab_name) - vocab = model.Vocabulary(self.vocab_name) - model.Session.add(vocab) - model.Session.commit() - log.info("Adding example tags to vocab %s" % self.vocab_name) - vocab_tag_1 = model.Tag('vocab-tag-example-1', vocab.id) - vocab_tag_2 = model.Tag('vocab-tag-example-2', vocab.id) - model.Session.add(vocab_tag_1) - model.Session.add(vocab_tag_2) - model.Session.commit() - def package_form(self): """ Returns a string representing the location of the template to be rendered. e.g. "package/new_package_form.html". - """ + """ return 'forms/dataset_form.html' def is_fallback(self): @@ -161,7 +150,7 @@ Returns true iff this provides the fallback behaviour, when no other plugin instance matches a package's type. - As this is not the fallback controller we should return False. If + 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 True @@ -183,12 +172,17 @@ """ Adds variables to c just prior to the template being rendered that can then be used within the form - """ + """ c.licences = [('', '')] + model.Package.get_license_options() c.publishers = [('Example publisher', 'Example publisher 2')] c.is_sysadmin = Authorizer().is_sysadmin(c.user) c.resource_columns = model.Resource.get_columns() - c.vocab_tags = get_action('tag_list')(context, {'vocabulary_id': self.vocab_name}) + try: + c.genre_tags = get_action('tag_list')(context, {'vocabulary_id': GENRE_VOCAB}) + c.composer_tags = get_action('tag_list')(context, {'vocabulary_id': COMPOSER_VOCAB}) + except NotFound: + c.vocab_tags = None + c.composer_tags = None ## This is messy as auths take domain object not data_dict pkg = context.get('package') or c.pkg @@ -203,8 +197,9 @@ """ schema = package_form_schema() schema.update({ - 'published_by': [not_empty, unicode, convert_to_extras], - 'vocab_tags': [ignore_missing, convert_to_tags(self.vocab_name)], + 'published_by': [ignore_missing, unicode, convert_to_extras], + 'genre_tags': [ignore_missing, convert_to_tags(GENRE_VOCAB)], + 'composer_tags': [ignore_missing, convert_to_tags(COMPOSER_VOCAB)] }) return schema @@ -218,7 +213,12 @@ 'tags': { '__extras': [keep_extras, free_tags_only] }, - 'vocab_tags_selected': [convert_from_tags(self.vocab_name), ignore_missing], + 'genre_tags_selected': [ + convert_from_tags(GENRE_VOCAB), ignore_missing + ], + 'composer_tags_selected': [ + convert_from_tags(COMPOSER_VOCAB), ignore_missing + ], 'published_by': [convert_from_extras, ignore_missing], }) return schema @@ -229,4 +229,37 @@ """ return - + def filter(self, stream): + # Add vocab tags to the bottom of the sidebar. + from pylons import request + from genshi.filters import Transformer + from genshi.input import HTML + routes = request.environ.get('pylons.routes_dict') + context = {'model': model} + if routes.get('controller') == 'package' \ + and routes.get('action') == 'read': + for vocab in (GENRE_VOCAB, COMPOSER_VOCAB): + try: + vocab = get_action('vocabulary_show')(context, {'id': vocab}) + vocab_tags = [t for t in c.pkg_dict.get('tags', []) + if t.get('vocabulary_id') == vocab['id']] + except NotFound: + vocab_tags = None + + if not vocab_tags: + continue + + html = '
  • ' + if vocab['name'] == GENRE_VOCAB: + html = html + '

    Musical Genre

    ' + elif vocab['name'] == COMPOSER_VOCAB: + html = html + '

    Composer

    ' + html = html + '
      ' + for tag in vocab_tags: + html = html + '
    • %s
      • ' % tag['name'] + html = html + "
    • " + stream = stream | Transformer( + "//div[@id='sidebar']//ul[@class='widget-list']" + ).append(HTML(html)) + return stream + --- a/ckanext/example/plugin.py +++ b/ckanext/example/plugin.py @@ -51,8 +51,7 @@ our_public_dir = os.path.join(rootdir, 'ckanext', 'example', 'theme', 'public') template_dir = os.path.join(rootdir, 'ckanext', - 'example', 'theme', - 'templates') + 'example', 'theme', 'templates') # set our local template and resource overrides config['extra_public_paths'] = ','.join([our_public_dir, config.get('extra_public_paths', '')]) --- a/ckanext/example/theme/templates/forms/dataset_form.html +++ b/ckanext/example/theme/templates/forms/dataset_form.html @@ -41,7 +41,7 @@
    - ${url(controller='package', action='index')+'/'}  + ${h.url(controller='package', action='search')+'/'} 

     

    @@ -143,22 +143,39 @@
    e.g. pollution, rivers, water quality
    ${errors.get('tag_string', '')}
    -

    Tags with Vocabulary

    -
    + +

    Musical Genre

    +
    - + - +
    -
    Similar to standard CKAN tags, but these use a fixed vocabulary.
    -
    ${errors.get('vocab_tag_string', '')}
    -
    +
    ${errors.get('genre_tag_string', '')}
    +
    + +

    Composer

    +
    +
    +
    + +
    +
    ${errors.get('composer_tag_string', '')}
    +
    +
    --- a/ckanext/example/theme/templates/layout.html +++ b/ckanext/example/theme/templates/layout.html @@ -10,7 +10,7 @@
    ${h.nav_link(c, _('Home'), controller='home', action='index')} - ${h.nav_link(c, _('Data'), controller='package', action='index')} + ${h.nav_link(c, _('Data'), controller='package', action='search')} ${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 @@ -17,9 +17,7 @@ namespace_packages=['ckanext', 'ckanext.example'], include_package_data=True, zip_safe=False, - install_requires=[ - # -*- Extra requirements: -*- - ], + install_requires=[], entry_points=\ """ [ckan.plugins] @@ -29,6 +27,9 @@ [ckan.forms] example_form = ckanext.example.package_form:get_example_fieldset + + [paste.paster_command] + example=ckanext.example.commands:ExampleCommand """, )