projects / ckanext-datagovau.git / commitdiff
search:
summary | shortlog | log | commit | commitdiff | tree
side by side | plain
[forms] bug fix: update groups schema in db_to_form_schema, whitespace clean up.
[forms] bug fix: update groups schema in db_to_form_schema, whitespace clean up.

file:a/README.rst -> file:b/README.rst 
--- a/README.rst
+++ b/README.rst
@@ -38,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
@@ -60,7 +60,7 @@
 * 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
 ==============================
file:a/ckanext/example/forms.py -> file:b/ckanext/example/forms.py 
--- a/ckanext/example/forms.py
+++ b/ckanext/example/forms.py
@@ -1,6 +1,5 @@
 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,7 +9,8 @@
 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__)
 
@@ -29,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
@@ -49,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
@@ -75,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
@@ -93,7 +93,7 @@
         format suitable for the form (optional)
         """
         return {}
-        
+
     def check_data_dict(self, data_dict):
         """
         Check if the return data is correct.
@@ -104,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.
 
@@ -122,9 +122,9 @@
         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):
         """
         This IConfigurer implementation causes CKAN to look in the
@@ -201,7 +201,7 @@
             '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
@@ -219,6 +219,10 @@
                 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
 
@@ -249,7 +253,10 @@
                         continue
 
                     html = '<li class="sidebar-section">'
-                    html = html + '<h3>%s</h3>' % vocab['name']
+                    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']
file:a/ckanext/example/plugin.py -> file:b/ckanext/example/plugin.py 
--- 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', '')])
file:a/ckanext/example/theme/templates/forms/dataset_form.html -> file:b/ckanext/example/theme/templates/forms/dataset_form.html 
--- a/ckanext/example/theme/templates/forms/dataset_form.html
+++ b/ckanext/example/theme/templates/forms/dataset_form.html
@@ -9,7 +9,7 @@
 <h2>Errors in form</h2>
 <p>The form contains invalid entries:</p>
 <ul>
-  <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}
+  <li py:for="key, error in error_summary.items()">${"%s: %s" % (key if not key=='Name' else 'URL', error)}
     <py:if test="key=='Resources'">
       <ul>
         <py:for each="idx, errordict in enumerate(errors.get('resources', []))">
@@ -23,6 +23,7 @@
       </ul>
     </py:if>
   </li>
+  <script>var global_form_errors = ${h.dump_json(errors)};</script>
 </ul>
 </div>
 
@@ -41,9 +42,10 @@
 
     <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">&nbsp;</span><a href="#" style="display: none;" class="url-edit js-url-editlink js-url-viewmode">(edit)</a></span>
+      <span class="url-text">${h.url(controller='package', action='search')+'/'}<span class="js-url-viewmode js-url-suffix">&nbsp;</span><a href="#" class="url-edit 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">&nbsp;</p>
+      <p class="url-is-long">Warning: URL is very long. Consider changing it to something shorter.</p>
     </dd>
     <dd style="display: none;" class="js-url-editmode name-instructions basic">2+ characters, lowercase, using only 'a-z0-9' and '-_'</dd>
     <dd class="js-url-editmode name-instructions field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd>
@@ -62,7 +64,7 @@
         </py:for>
       </select>
     </dd>
-    <dd class="license-instructions instructions basic">The licence under which the dataset is released.</dd>
+    <dd class="license-instructions instructions basic">(Don't worry if you don't know which license the data has been released under).</dd>
 
     <dt class="description-label"><label class="field_opt" for="notes">Description</label></dt>
     <dd class="description-field"><div class="markdown-editor">
@@ -78,76 +80,51 @@
       <dd class="instructions further">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.</dd>
       -->
     </div></dd>
-  </dl>
-</fieldset>
-
-<fieldset id="resources">
-  <div class="instructions basic"><h3>Resources: the files and APIs associated with this dataset</h3></div>
-  <table class="resource-table-edit">
-    <thead>
-      <tr>
-        <th class="field_req resource-url">Resource</th>
-        <th class="resource-delete-link"></th>
-      </tr>
-    </thead>
-    <tbody class="js-resource-editor">
-    </tbody>
-  </table>
-
-
-  <div class="resource-add">
-    <ul class="button-row">
-      <li><h4>Add a resource:</h4></li>
-      <li><button class="pretty-button js-link-file">Link to a file</button></li>
-      <li><button class="pretty-button js-link-api">Link to an API</button></li>
-      <li class="js-upload-file ckan-logged-in" style="display: none;"><button class="pretty-button js-upload-file">Upload a file</button></li>
-    </ul>
-  </div>
-</fieldset>
-
-<fieldset id="groups">
-  <h3>Groups</h3>
-  <dl>
-    <py:for each="num, group in enumerate(data.get('groups', []))">
-        <?python
-        authorized_group = [group_authz for group_authz in c.groups_authz if group_authz['id'] == group['id']]
-        authorized_group = authorized_group[0] if authorized_group else None
-        ?>
-
-      <dt py:if="'id' in group">
-      <input type="${'checkbox' if authorized_group else 'hidden'}" name="groups__${num}__id" checked="checked" value="${group['id']}" />
-      <input type="hidden" name="groups__${num}__name" value="${group.get('name', authorized_group['name'] if authorized_group else '')}" />
-      </dt>     
-      <dd py:if="'id' in group"><label for="groups__${num}__checked">${group.get('name', authorized_group['name'] if authorized_group else '')}</label></dd>
-    </py:for>
-
-    <dt>Group</dt>
-    <dd py:if="c.groups_available"> 
-      <select id="groups__${len(data.get('groups', []))}__id" name="groups__${len(data.get('groups', []))}__id">
-        <option selected="selected" value="">(None)</option>
-        <py:for each="group in c.groups_available">
-        <option value="${group['id']}" >${group['name']}</option>
-        </py:for>
-      </select>
-    </dd> 
-    <dd py:if="not c.groups_available"><em>Cannot add any groups.</em></dd>
-  </dl>
-  <h3>Tags</h3>
-  <dl>
-    <dt class="tags-label"><label class="field_opt" for="tags">Tags</label></dt>
+    <dt class="groups-label">
+      Groups
+    </dt>
+    <dd class="groups-field">
+      <dl>
+        <py:for each="num, group in enumerate(data.get('groups', []))">
+            <?python
+            authorized_group = [group_authz for group_authz in c.groups_authz if group_authz['id'] == group['id']]
+            authorized_group = authorized_group[0] if authorized_group else None
+            ?>
+
+          <dt py:if="'id' in group">
+          <input type="${'checkbox' if authorized_group else 'hidden'}" name="groups__${num}__id" checked="checked" value="${group['id']}" />
+          <input type="hidden" name="groups__${num}__name" value="${group.get('name', authorized_group['name'] if authorized_group else '')}" />
+          </dt>     
+          <dd py:if="'id' in group"><label for="groups__${num}__checked">${group.get('name', authorized_group['name'] if authorized_group else '')}</label></dd>
+        </py:for>
+
+        <dt>Add to:</dt>
+        <dd py:if="c.groups_available"> 
+          <select id="groups__${len(data.get('groups', []))}__id" name="groups__${len(data.get('groups', []))}__id">
+            <option selected="selected" value="">(None)</option>
+            <py:for each="group in c.groups_available">
+            <option value="${group['id']}" >${group['name']}</option>
+            </py:for>
+          </select>
+        </dd> 
+        <dd py:if="not c.groups_available"><em>Cannot add any groups.</em></dd>
+      </dl>
+    </dd>
+    <dt class="tags-label">
+      Tags
+    </dt>
     <dd class="tags-field">
       <input class="long autocomplete-tag" id="tag_string" name="tag_string" size="60" type="text" 
                value="${data.get('tag_string') or ', '.join([tag['name'] for tag in data.get('tags', []) if not tag.get('vocabulary_id')])}" />
     </dd>
-    <dd class="tags-instructions instructions basic" i18n:msg="">Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see <a href="http://wiki.okfn.org/ckan/doc/faq#TagConventions">this wiki page</a>.</dd>
+    <dd class="tags-instructions instructions basic" i18n:msg="">Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see <a href="http://wiki.ckan.org/Managing_Datasets#Tag_Conventions">this wiki page</a>.</dd>
     <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.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">
+    <dt><label class="field_opt" for="tags_vocab">Musical Genre</label></dt>
+    <dd>
       <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="">
@@ -160,10 +137,9 @@
     <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">
+    <dt><label class="field_opt" for="tags_vocab">Composer</label></dt>
+    <dd>
       <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="">
@@ -175,8 +151,40 @@
     </dd>
     <dd class="tags-instructions field_error" py:if="errors.get('composer_tag_string', '')">${errors.get('composer_tag_string', '')}</dd>
   </dl>
-
-</fieldset>
+</fieldset>
+
+<fieldset id="resources">
+  <div class="instructions">
+    <h3>Add resources:</h3>
+    <p>Upload or link data files, APIs and other materials related to your dataset.</p>
+  </div>
+  <div class="js-resource-edit-barebones">
+    <!-- The resource editor deletes these fields and replaces them with a dynamic editor.
+         They are required for the form to render correctly when not in resource-edit mode. -->
+    <py:for each="num,res in enumerate(data.get('resources', []))">
+      <py:for each="field in res.keys()">
+      <input type="hidden" name="resources__${res.get('position')}__${field}" value="${res.get(field)}" />
+      </py:for>
+    </py:for>
+  </div>
+  <ul class="resource-list resource-list-edit drag-drop-list">
+  </ul>
+  <ul class="resource-list resource-list-add">
+    <li><a href="#" class="js-resource-add">${h.icon('page_white_add')}New resource...</a></li>
+  </ul>
+  <div style="display: none;" class="resource-panel">
+    <button class="pretty-button danger resource-panel-close">x</button>
+    <div class="resource-details resource-add">
+      <ul class="button-row">
+        <li><h4>Add a resource:</h4></li>
+        <li><button class="pretty-button js-link-file">Link to a file</button></li>
+        <li><button class="pretty-button js-link-api">Link to an API</button></li>
+        <li class="js-upload-file ckan-logged-in" style="display: none;"><button class="pretty-button js-upload-file">Upload a file</button></li>
+      </ul>
+    </div>
+  </div>
+</fieldset>
+
 <fieldset id='further-information'>
   <dl>
     <dt><label class="field_opt" for="author">Author</label></dt>
@@ -198,31 +206,12 @@
     <dd class="instructions basic">A number representing the version (if applicable)</dd>
     <dd class="hints">e.g. 1.2.0</dd>
 
-    <dt py:if="c.is_sysadmin or c.auth_for_change_state"><label class="field_opt" for="state">State</label></dt>
-    <dd py:if="c.is_sysadmin or c.auth_for_change_state">
-    <select id="state" name="state" >
-      <option py:attrs="{'selected': 'selected' if data.get('state') == 'active' else None}" value="active">active</option>
-      <option py:attrs="{'selected': 'selected' if data.get('state') == 'deleted' else None}" value="deleted">deleted</option>
-    </select>
-    </dd>
-
   </dl>
 </fieldset>
 
 <fieldset id='extras'>
-  <dl>
-    <dt><label class="field_req" for="published_by">Published by *</label></dt>
-    <dd>
-      <select id="published_by" name="published_by">
-        <py:for each="published_name, published_desc in c.publishers">
-          <option value="${published_name}" py:attrs="{'selected': 'selected' if data.get('published_by', '') == published_name else None}" >
-            ${published_desc}
-          </option>
-        </py:for>
-      </select>
-    </dd>
-    <dd class="instructions basic">The organisation credited with or associated with the publication of this data.</dd>
-
+  <p>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 <strong>Additional Information</strong> when viewing the dataset.</p>
+  <dl>
     <py:with vars="extras = data.get('extras', [])">
     <py:for each="num, extra in enumerate(data.get('extras', []))">
     <dt><label for="extras__${num}__value">${extra.get('key')}</label></dt>
@@ -244,14 +233,31 @@
     </py:with>
   </dl>
 </fieldset>
-
-<label for="log_message" class="edit-summary">Edit summary (briefly describe the changes you have made)</label>
-<textarea id="log_message" name="log_message" class="edit-summary short wide">${data.get('log_message', '')}</textarea>
-
-<div class="ckan-logged-in" style="display: none;">
+<fieldset id='delete' py:if="c.is_sysadmin or c.auth_for_change_state">
+  <dl>
+    <dt>Delete</dt>
+    <dd>
+      <p>Do you really want to change the state of this dataset? &nbsp;&nbsp;<button class="dataset-delete pretty-button">Yes!</button></p>
+      <span>
+      This dataset is&nbsp;&nbsp; 
+      <select id="state" class="dataset-delete" name="state" style="display:inline;">
+        <option py:attrs="{'selected': 'selected' if data.get('state') == 'active' else None}" value="active">active</option>
+        <option py:attrs="{'selected': 'selected' if data.get('state') == 'deleted' else None}" value="deleted">deleted</option>
+      </select>
+      </span>
+    </dd>
+  </dl>
+</fieldset>
+
+<div id="unsaved-warning"></div>
+
+<label for="log_message" class="edit-summary">Edit summary (briefly describe the changes you have made)...</label>
+<textarea id="log_message" name="log_message" class="edit-summary short wide">${data.get('log_message', h.auto_log_message(c))}</textarea>
+
+<div class="author-box ckan-logged-in" style="display: none;">
   <p>Author: ${c.author}</p>
 </div>
-<div class="ckan-logged-out">
+<div class="author-box ckan-logged-out">
   <label>Author: ${c.author}</label>
   <p i18n:msg="" class="hints">
     Since you have not signed in this will just be your IP address.
@@ -270,5 +276,7 @@
   <div class="clear"></div>
 </div>
 
+
+
 </form>
file:a/ckanext/example/theme/templates/layout.html -> file:b/ckanext/example/theme/templates/layout.html 
--- 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>
Unnamed repository; edit this file 'description' to name the repository.
GitPHP by Chris Han