From: John Glover Date: Wed, 21 Mar 2012 15:47:11 +0000 Subject: [forms] bug fix: update groups schema in db_to_form_schema, whitespace clean up. X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=3f3edb3faad17959b1acf8cc0ed7a50ef9039d82 --- [forms] bug fix: update groups schema in db_to_form_schema, whitespace clean up. --- --- 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 @@ -9,11 +9,13 @@ 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 +from ckan.lib.navl.validators import ignore_missing, keep_extras, not_empty +import ckan.lib.plugins log = logging.getLogger(__name__) -EXAMPLE_VOCAB = u'example_vocab' +GENRE_VOCAB = u'genre_vocab' +COMPOSER_VOCAB = u'composer_vocab' class ExampleGroupForm(SingletonPlugin): @@ -27,15 +29,15 @@ - ``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. + 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 @@ -47,7 +49,7 @@ '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 @@ -73,11 +75,11 @@ 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 + 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 - + return False + def form_to_db_schema(self): """ Returns the schema for mapping group data from a form to a format @@ -91,7 +93,7 @@ format suitable for the form (optional) """ return {} - + def check_data_dict(self, data_dict): """ Check if the return data is correct. @@ -102,10 +104,10 @@ def setup_template_variables(self, context, data_dict): """ Add variables to c just prior to the template being rendered. - """ - - -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. @@ -120,9 +122,9 @@ class will be used. """ implements(IDatasetForm, inherit=True) - implements(IConfigurer, inherit=True) - implements(IGenshiStreamFilter) - + implements(IConfigurer, inherit=True) + implements(IGenshiStreamFilter, inherit=True) + def update_config(self, config): """ This IConfigurer implementation causes CKAN to look in the @@ -135,40 +137,6 @@ config['extra_template_paths'] = ','.join([template_dir, config.get('extra_template_paths', '')]) - # def configure(self, config): - # ''' - # Adds some new vocabularies to the database if they don't already exist. - - # ''' - # # Add a 'genre' vocabulary with some tags. - # self.genre_vocab = model.Vocabulary.get('Genre') - # if not self.genre_vocab: - # log.info("Adding vocab Genre") - # self.genre_vocab = model.Vocabulary('Genre') - # model.Session.add(self.genre_vocab) - # model.Session.commit() - # log.info("Adding example tags to vocab %s" % self.genre_vocab.name) - # jazz_tag = model.Tag('jazz', self.genre_vocab.id) - # soul_tag = model.Tag('soul', self.genre_vocab.id) - # model.Session.add(jazz_tag) - # model.Session.add(soul_tag) - # model.Session.commit() - - # # Add a 'composer' vocabulary with some tags. - # self.composer_vocab = model.Vocabulary.get('Composer') - # if not self.composer_vocab: - # log.info("Adding vocab Composer") - # self.composer_vocab = model.Vocabulary('Composer') - # model.Session.add(self.composer_vocab) - # model.Session.commit() - # log.info("Adding example tags to vocab %s" % - # self.composer_vocab.name) - # mintzer_tag = model.Tag('Bob Mintzer', self.composer_vocab.id) - # lewis_tag = model.Tag('Steve Lewis', self.composer_vocab.id) - # model.Session.add(mintzer_tag) - # model.Session.add(lewis_tag) - # model.Session.commit() - def package_form(self): """ Returns a string representing the location of the template to be @@ -209,11 +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': self.genre_vocab.name}) - # c.composer_tags = get_action('tag_list')(context, {'vocabulary_id': self.composer_vocab.name}) + 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 @@ -229,12 +197,11 @@ 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(self.genre_vocab.name)], - # 'composer_tags': [ignore_missing, convert_to_tags(self.composer_vocab.name)], + 'genre_tags': [ignore_missing, convert_to_tags(GENRE_VOCAB)], + 'composer_tags': [ignore_missing, convert_to_tags(COMPOSER_VOCAB)] }) return schema - + def db_to_form_schema(self): """ Returns the schema for mapping package data from the database into a @@ -245,13 +212,18 @@ 'tags': { '__extras': [keep_extras, free_tags_only] }, - 'vocab_tags_selected': [convert_from_tags(EXAMPLE_VOCAB), ignore_missing], - # 'genre_tags_selected': [convert_from_tags(self.genre_vocab.name), - # ignore_missing], - # 'composer_tags_selected': [ - # convert_from_tags(self.composer_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], }) + schema['groups'].update({ + 'name': [not_empty, unicode], + 'title': [ignore_missing] + }) return schema def check_data_dict(self, data_dict): @@ -261,28 +233,36 @@ 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 - # 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 - --- 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 @@ -9,7 +9,7 @@

    Errors in form

    The form contains invalid entries:

      -
    • ${"%s: %s" % (key, error)} +
    • ${"%s: %s" % (key if not key=='Name' else 'URL', error)}
        @@ -23,6 +23,7 @@
      • +
    @@ -41,9 +42,10 @@
    - ${url(controller='package', action='index')+'/'}  + ${h.url(controller='package', action='search')+'/'} (edit)

     

    +

    Warning: URL is very long. Consider changing it to something shorter.

    ${errors.get('name', '')}
    @@ -62,7 +64,7 @@ -
    The licence under which the dataset is released.
    +
    (Don't worry if you don't know which license the data has been released under).
    @@ -78,107 +80,111 @@
    It is often displayed with the dataset title. In particular, it should start with a short sentence that describes the dataset succinctly, because the first few words alone may be used in some views of the datasets.
    --> - - - -
    -

    Resources: the files and APIs associated with this dataset

    - - - - - - - - - -
    Resource
    - - -
    -
      -

    • Add a resource:

      • -
      • -
      • - -
    -
    -
    - -
    -

    Groups

    -
    - - - -
    - - -
    -
    -     - -
    Group
    -
    - -
    -
    Cannot add any groups.
    -
    -

    Tags

    -
    -
    +
    + Groups +
    +
    +
    + + + +
    + + +
    +
    +     + +
    Add to:
    +
    + +
    +
    Cannot add any groups.
    +
    +
    +
    + Tags +
    -
    Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see this wiki page.
    +
    Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see this wiki page.
    e.g. pollution, rivers, water quality
    ${errors.get('tag_string', '')}
    -

    Tags With Example Vocabulary

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    + +
    +
    +
    + +
    +
    ${errors.get('genre_tag_string', '')}
    +
    + +
    +
    +
    + +
    +
    ${errors.get('composer_tag_string', '')}
    +
    + + +
    +
    +

    Add resources:

    +

    Upload or link data files, APIs and other materials related to your dataset.

    +
    +
    + + + + + + +
    +
      +
    + + +
    +
    @@ -200,31 +206,12 @@
    A number representing the version (if applicable)
    e.g. 1.2.0
    -
    -
    - -
    -
    -
    -
    -
    - -
    -
    The organisation credited with or associated with the publication of this data.
    - +

    Adding custom fields to the dataset such as "location:uk" can help users find it in the search engine. This data will also appear under Additional Information when viewing the dataset.

    +
    @@ -246,14 +233,31 @@
    - - - - -