From: Sean Hammond Date: Tue, 20 Mar 2012 15:18:42 +0000 Subject: Replace obsolete route (package/index) in dataset form X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=20e68e71e7e9bdc872dcfccb920712e3fa424522 --- Replace obsolete route (package/index) in dataset form --- --- 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 @@ -13,7 +13,7 @@ Usage:: - paster example create-example-vocab -c + paster example create-example-vocabs -c paster example clean -c - Remove all data created by ckanext-example @@ -34,33 +34,50 @@ cmd = self.args[0] self._load_config() - if cmd == 'create-example-vocab': - self.create_example_vocab() + 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_vocab(self): + def create_example_vocabs(self): ''' - Adds an example vocabulary to the database if it doesn't - already exist. + 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']} - data = {'id': forms.EXAMPLE_VOCAB} try: + data = {'id': forms.GENRE_VOCAB} get_action('vocabulary_show')(context, data) - log.info("Example tag vocabulary already exists, skipping.") + log.info("Example genre vocabulary already exists, skipping.") except NotFound: - log.info("Creating example vocab %s" % forms.EXAMPLE_VOCAB) - data = {'name': forms.EXAMPLE_VOCAB} + 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" % ('vocab-tag-example-1', forms.EXAMPLE_VOCAB)) - data = {'name': 'vocab-tag-example-1', 'vocabulary_id': vocab['id']} + 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) - log.info("Adding tag %s to vocab %s" % ('vocab-tag-example-2', forms.EXAMPLE_VOCAB)) - data = {'name': 'vocab-tag-example-2', 'vocabulary_id': vocab['id']} + 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,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,12 +8,14 @@ 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 log = logging.getLogger(__name__) -EXAMPLE_VOCAB = u'example_vocab' +GENRE_VOCAB = u'genre_vocab' +COMPOSER_VOCAB = u'composer_vocab' class ExampleGroupForm(SingletonPlugin): @@ -119,7 +122,8 @@ class will be used. """ implements(IDatasetForm, inherit=True) - implements(IConfigurer, inherit=True) + implements(IConfigurer, inherit=True) + implements(IGenshiStreamFilter, inherit=True) def update_config(self, config): """ @@ -173,9 +177,11 @@ c.is_sysadmin = Authorizer().is_sysadmin(c.user) c.resource_columns = model.Resource.get_columns() try: - c.vocab_tags = get_action('tag_list')(context, {'vocabulary_id': EXAMPLE_VOCAB}) + 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 @@ -191,7 +197,8 @@ schema = package_form_schema() schema.update({ 'published_by': [ignore_missing, unicode, convert_to_extras], - 'vocab_tags': [ignore_missing, convert_to_tags(EXAMPLE_VOCAB)], + 'genre_tags': [ignore_missing, convert_to_tags(GENRE_VOCAB)], + 'composer_tags': [ignore_missing, convert_to_tags(COMPOSER_VOCAB)] }) return schema @@ -205,7 +212,12 @@ 'tags': { '__extras': [keep_extras, free_tags_only] }, - 'vocab_tags_selected': [convert_from_tags(EXAMPLE_VOCAB), 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 @@ -216,4 +228,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 Example 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')}