Extend the vocabularies example
Extend the vocabularies example

Add two example vocabularies: Genre and Composer

Show a dataset's vocabulary tags in the sidebar on the dataset read page

Vocabulary tags cannot be linked to the tag's page, because their aren't
URLs for showing tags with vocabularies yet.

--- a/ckanext/example/forms.py
+++ b/ckanext/example/forms.py
@@ -6,6 +6,7 @@
 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 IGenshiStreamFilter
 from ckan.plugins import implements, SingletonPlugin
 from ckan.lib.navl.validators import ignore_missing, not_empty, keep_extras
 
@@ -117,6 +118,7 @@
     implements(IDatasetForm, inherit=True)
     implements(IConfigurer, inherit=True)    
     implements(IConfigurable)
+    implements(IGenshiStreamFilter)
     
     def update_config(self, config):
         """
@@ -131,22 +133,37 @@
                 config.get('extra_template_paths', '')])
 
     def configure(self, config):
-        """
-        Adds our new vocabulary to the database if it doesn't
-        already exist.
-        """
-        self.vocab_name = u'example_vocab'
-        v = model.Vocabulary.get(self.vocab_name)
-        if not v:
-            log.info("Adding vocab %s" % self.vocab_name)
-            vocab = model.Vocabulary(self.vocab_name)
-            model.Session.add(vocab)
-            model.Session.commit()
-            log.info("Adding example tags to vocab %s" % self.vocab_name)
-            vocab_tag_1 = model.Tag('vocab-tag-example-1', vocab.id)
-            vocab_tag_2 = model.Tag('vocab-tag-example-2', vocab.id)
-            model.Session.add(vocab_tag_1)
-            model.Session.add(vocab_tag_2)
+        '''
+        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):
@@ -188,7 +205,8 @@
         c.publishers = [('Example publisher', 'Example publisher 2')]
         c.is_sysadmin = Authorizer().is_sysadmin(c.user)
         c.resource_columns = model.Resource.get_columns()
-        c.vocab_tags = get_action('tag_list')(context, {'vocabulary_id': self.vocab_name})
+        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})
 
         ## This is messy as auths take domain object not data_dict
         pkg = context.get('package') or c.pkg
@@ -204,7 +222,8 @@
         schema = package_form_schema()
         schema.update({
             'published_by': [not_empty, unicode, convert_to_extras],
-            'vocab_tags': [ignore_missing, convert_to_tags(self.vocab_name)],
+            'genre_tags': [ignore_missing, convert_to_tags(self.genre_vocab.name)],
+            'composer_tags': [ignore_missing, convert_to_tags(self.composer_vocab.name)],
         })
         return schema
     
@@ -218,7 +237,10 @@
             'tags': {
                 '__extras': [keep_extras, free_tags_only]
             },
-            'vocab_tags_selected': [convert_from_tags(self.vocab_name), 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],
             'published_by': [convert_from_extras, ignore_missing],
         })
         return schema
@@ -229,4 +251,26 @@
         """
         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 = '<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/theme/templates/forms/dataset_form.html
+++ b/ckanext/example/theme/templates/forms/dataset_form.html
@@ -143,22 +143,39 @@
     <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>Tags with Vocabulary</h3>
+
+  <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="vocab_tags" class="chzn-select" name="vocab_tags" size="60" multiple="multiple">
-        <py:for each="tag in c.vocab_tags">
+      <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('vocab_tags_selected', [])" selected="selected" value="${tag}">${tag}</option>
+          <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 instructions basic" i18n:msg="">Similar to standard CKAN tags, but these use a fixed vocabulary.</dd>
-    <dd class="tags-instructions field_error" py:if="errors.get('vocab_tag_string', '')">${errors.get('vocab_tag_string', '')}</dd>
-  </dl>
+    <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>
+
 </fieldset>
 <fieldset id='further-information'>
   <dl>