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 <path to your ckan config file>
+
+This data can be removed with
+
+::
+
+ paster example clean -c <path to your ckan config file>
--- a/ckanext/example/commands.py
+++ b/ckanext/example/commands.py
@@ -13,7 +13,7 @@
Usage::
- paster example create-example-vocab -c <path to config file>
+ 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
@@ -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
@@ -10,10 +11,12 @@
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__)
-EXAMPLE_VOCAB = u'example_vocab'
+GENRE_VOCAB = u'genre_vocab'
+COMPOSER_VOCAB = u'composer_vocab'
class ExampleGroupForm(SingletonPlugin):
@@ -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,7 +124,7 @@
"""
implements(IDatasetForm, inherit=True)
implements(IConfigurer, inherit=True)
- implements(IGenshiStreamFilter)
+ implements(IGenshiStreamFilter, inherit=True)
def update_config(self, config):
"""
@@ -135,40 +138,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 +178,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,9 +198,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(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
@@ -245,11 +213,12 @@
'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],
})
return schema
@@ -261,28 +230,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 = '<li class="sidebar-section">'
+ if vocab['name'] == GENRE_VOCAB:
+ html = html + '<h3>Musical Genre</h3>'
+ elif vocab['name'] == COMPOSER_VOCAB:
+ html = html + '<h3>Composer</h3>'
+ html = html + '<ul class="tags clearfix">'
+ for tag in vocab_tags:
+ html = html + '<li>%s</li>' % tag['name']
+ html = html + "</ul></li>"
+ 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 = '<li class="sidebar-section">'
- # 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 + "</ul></li>"
- # 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
@@ -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='search')+'/'}<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>
@@ -143,40 +143,38 @@
<dd class="tags-instructions hints">e.g. pollution, rivers, water quality</dd>
<dd class="tags-instructions field_error" py:if="errors.get('tag_string', '')">${errors.get('tag_string', '')}</dd>
</dl>
- <h3 py:if="c.vocab_tags">Tags With Example Vocabulary</h3>
- <dl py:if="c.vocab_tags">
-
- <!-- <h3>Musical Genre</h3> -->
- <!-- <dl> -->
- <!-- <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"> -->
- <!-- <py:for each="tag in c.genre_tags"> -->
- <!-- <py:choose test=""> -->
- <!-- <option py:when="tag in data.get('genre_tags_selected', [])" selected="selected" value="${tag}">${tag}</option> -->
- <!-- <option py:otherwise="" value="${tag}">${tag}</option> -->
- <!-- </py:choose> -->
- <!-- </py:for> -->
- <!-- </select> -->
- <!-- </dd> -->
- <!-- <dd class="tags-instructions field_error" py:if="errors.get('genre_tag_string', '')">${errors.get('genre_tag_string', '')}</dd> -->
- <!-- </dl> -->
-
- <!-- <h3>Composer</h3> -->
- <!-- <dl> -->
- <!-- <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"> -->
- <!-- <py:for each="tag in c.composer_tags"> -->
- <!-- <py:choose test=""> -->
- <!-- <option py:when="tag in data.get('composer_tags_selected', [])" selected="selected" value="${tag}">${tag}</option> -->
- <!-- <option py:otherwise="" value="${tag}">${tag}</option> -->
- <!-- </py:choose> -->
- <!-- </py:for> -->
- <!-- </select> -->
- <!-- </dd> -->
- <!-- <dd class="tags-instructions field_error" py:if="errors.get('composer_tag_string', '')">${errors.get('composer_tag_string', '')}</dd> -->
- <!-- </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">
+ <py:for each="tag in c.genre_tags">
+ <py:choose test="">
+ <option py:when="tag in data.get('genre_tags_selected', [])" selected="selected" value="${tag}">${tag}</option>
+ <option py:otherwise="" value="${tag}">${tag}</option>
+ </py:choose>
+ </py:for>
+ </select>
+ </dd>
+ <dd class="tags-instructions field_error" py:if="errors.get('genre_tag_string', '')">${errors.get('genre_tag_string', '')}</dd>
+ </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">
+ <py:for each="tag in c.composer_tags">
+ <py:choose test="">
+ <option py:when="tag in data.get('composer_tags_selected', [])" selected="selected" value="${tag}">${tag}</option>
+ <option py:otherwise="" value="${tag}">${tag}</option>
+ </py:choose>
+ </py:for>
+ </select>
+ </dd>
+ <dd class="tags-instructions field_error" py:if="errors.get('composer_tag_string', '')">${errors.get('composer_tag_string', '')}</dd>
+ </dl>
</fieldset>
<fieldset id='further-information'>
--- a/ckanext/example/theme/templates/layout.html
+++ b/ckanext/example/theme/templates/layout.html
@@ -10,7 +10,7 @@
<py:match path="//div[@class='menu']">
<div class="menu">
${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')}
</div>