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 --- a/ckanext/example/commands.py +++ b/ckanext/example/commands.py @@ -36,6 +36,8 @@ if cmd == 'create-example-vocabs': self.create_example_vocabs() + if cmd == 'clean': + self.clean() else: log.error('Command "%s" not recognized' % (cmd,)) @@ -76,3 +78,6 @@ 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,5 +1,6 @@ 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 @@ -7,8 +8,10 @@ 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__) @@ -105,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. @@ -121,6 +124,7 @@ """ implements(IDatasetForm, inherit=True) implements(IConfigurer, inherit=True) + implements(IGenshiStreamFilter, inherit=True) def update_config(self, config): """ @@ -225,26 +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') - # if routes.get('controller') == 'package' \ - # and routes.get('action') == 'read': - # for vocab in (self.genre_vocab, self.composer_vocab): - # vocab_tags = [tag for tag in c.pkg_dict.get('tags', []) - # if tag.get('vocabulary_id') == vocab.id] - # if not vocab_tags: - # continue - # html = '
  • ' - # html = html + '

    %s

    ' % vocab.name - # html = html + '
      ' - # for tag in vocab_tags: - # html = html + '
    • %s
      • ' % tag.get('name') - # html = html + "
    • " - # stream = stream | Transformer("//div[@id='sidebar']")\ - # .append(HTML(html)) - # return stream - + 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')+'/'} 

     

    --- 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')}