Fix a bug in the 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
===========
@@ -63,4 +62,19 @@
updating. In the meantime, follow the instructions at:
http://readthedocs.org/docs/ckan/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>
+
+
--- /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 <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")
+
--- a/ckanext/example/forms.py
+++ b/ckanext/example/forms.py
@@ -1,23 +1,29 @@
-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
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
@@ -30,7 +36,7 @@
class will be used.
"""
implements(IGroupForm, inherit=True)
- implements(IConfigurer, inherit=True)
+ implements(IConfigurer, inherit=True)
def update_config(self, config):
"""
@@ -48,7 +54,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):
@@ -111,14 +117,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)
+ implements(IGenshiStreamFilter, inherit=True)
def update_config(self, config):
"""
@@ -132,45 +137,11 @@
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
rendered. e.g. "package/new_package_form.html".
- """
+ """
return 'forms/dataset_form.html'
def is_fallback(self):
@@ -178,7 +149,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
@@ -200,13 +171,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.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})
+ 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
@@ -221,9 +196,9 @@
"""
schema = package_form_schema()
schema.update({
- 'published_by': [not_empty, unicode, convert_to_extras],
- 'genre_tags': [ignore_missing, convert_to_tags(self.genre_vocab.name)],
- 'composer_tags': [ignore_missing, convert_to_tags(self.composer_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
@@ -237,10 +212,12 @@
'tags': {
'__extras': [keep_extras, free_tags_only]
},
- 'genre_tags_selected': [convert_from_tags(self.genre_vocab.name),
- ignore_missing],
+ 'genre_tags_selected': [
+ convert_from_tags(GENRE_VOCAB), ignore_missing
+ ],
'composer_tags_selected': [
- convert_from_tags(self.composer_vocab.name), ignore_missing],
+ convert_from_tags(COMPOSER_VOCAB), ignore_missing
+ ],
'published_by': [convert_from_extras, ignore_missing],
})
return schema
@@ -257,20 +234,28 @@
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 (self.genre_vocab, self.composer_vocab):
- vocab_tags = [tag for tag in c.pkg_dict.get('tags', [])
- if tag.get('vocabulary_id') == vocab.id]
+ 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 = '<li class="sidebar-section">'
- html = html + '<h3>%s</h3>' % vocab.name
+ html = html + '<h3>%s</h3>' % vocab['name']
html = html + '<ul class="tags clearfix">'
for tag in vocab_tags:
- html = html + '<li>%s</li>' % tag.get('name')
+ html = html + '<li>%s</li>' % tag['name']
html = html + "</ul></li>"
- stream = stream | Transformer("//div[@id='sidebar']")\
- .append(HTML(html))
+ stream = stream | Transformer(
+ "//div[@id='sidebar']//ul[@class='widget-list']"
+ ).append(HTML(html))
return stream
--- a/ckanext/example/theme/templates/forms/dataset_form.html
+++ b/ckanext/example/theme/templates/forms/dataset_form.html
@@ -41,7 +41,7 @@
<dt class="name-label"><label class="field_req" for="name">Url</label></dt>
<dd class="name-field">
- <span class="js-url-text url-text">${url(controller='package', action='index')+'/'}<span class="js-url-viewmode js-url-suffix"> </span><a href="#" style="display: none;" class="url-edit js-url-editlink js-url-viewmode">(edit)</a></span>
+ <span class="js-url-text url-text">${h.url(controller='package', action='index')+'/'}<span class="js-url-viewmode js-url-suffix"> </span><a href="#" style="display: none;" class="url-edit js-url-editlink js-url-viewmode">(edit)</a></span>
<input style="display: none;" id="name" maxlength="100" name="name" type="text" class="url-input js-url-editmode js-url-input" value="${data.get('name', '')}" />
<p class="js-url-is-valid"> </p>
</dd>
@@ -144,8 +144,8 @@
<dd class="tags-instructions field_error" py:if="errors.get('tag_string', '')">${errors.get('tag_string', '')}</dd>
</dl>
- <h3>Musical Genre</h3>
- <dl>
+ <h3 py:if="c.genre_tags">Musical Genre</h3>
+ <dl py:if="c.genre_tags">
<dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt>
<dd class="tags-field">
<select id="genre_tags" class="chzn-select" name="genre_tags" size="60" multiple="multiple">
@@ -160,8 +160,8 @@
<dd class="tags-instructions field_error" py:if="errors.get('genre_tag_string', '')">${errors.get('genre_tag_string', '')}</dd>
</dl>
- <h3>Composer</h3>
- <dl>
+ <h3 py:if="c.composer_tags">Composer</h3>
+ <dl py:if="c.composer_tags">
<dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt>
<dd class="tags-field">
<select id="composer_tags" class="chzn-select" name="composer_tags" size="60" multiple="multiple">
--- 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
""",
)