-
+
diff --git a/ckan/tests/functional/test_tracking.py b/ckan/tests/functional/test_tracking.py
index 44393036f5f..ec95547822d 100644
--- a/ckan/tests/functional/test_tracking.py
+++ b/ckan/tests/functional/test_tracking.py
@@ -61,14 +61,14 @@ def _post_to_tracking(self, app, url, type_='page', ip='199.204.138.90',
'''
params = {'url': url, 'type': type_}
- app.post('/_tracking', params=params,
- extra_environ={
- # The tracking middleware crashes if these aren't present.
- 'HTTP_USER_AGENT': browser,
- 'REMOTE_ADDR': ip,
- 'HTTP_ACCEPT_LANGUAGE': 'en',
- 'HTTP_ACCEPT_ENCODING': 'gzip, deflate',
- })
+ extra_environ = {
+ # The tracking middleware crashes if these aren't present.
+ 'HTTP_USER_AGENT': browser,
+ 'REMOTE_ADDR': ip,
+ 'HTTP_ACCEPT_LANGUAGE': 'en',
+ 'HTTP_ACCEPT_ENCODING': 'gzip, deflate',
+ }
+ app.post('/_tracking', params=params, extra_environ=extra_environ)
def _update_tracking_summary(self):
'''Update CKAN's tracking summary data.
diff --git a/ckan/tests/test_coding_standards.py b/ckan/tests/test_coding_standards.py
index 19a37aea8f3..eab5d5ae9e2 100644
--- a/ckan/tests/test_coding_standards.py
+++ b/ckan/tests/test_coding_standards.py
@@ -767,9 +767,7 @@ class TestPep8(object):
'ckan/tests/lib/test_accept.py',
'ckan/tests/lib/test_alphabet_pagination.py',
'ckan/tests/lib/test_cli.py',
- 'ckan/tests/lib/test_datapreview.py',
'ckan/tests/lib/test_dictization.py',
- 'ckan/tests/lib/test_dictization_schema.py',
'ckan/tests/lib/test_email_notifications.py',
'ckan/tests/lib/test_field_types.py',
'ckan/tests/lib/test_hash.py',
@@ -788,7 +786,6 @@ class TestPep8(object):
'ckan/tests/logic/test_action.py',
'ckan/tests/logic/test_auth.py',
'ckan/tests/logic/test_tag.py',
- 'ckan/tests/logic/test_tag_vocab.py',
'ckan/tests/logic/test_validators.py',
'ckan/tests/misc/test_format_text.py',
'ckan/tests/misc/test_mock_mail_server.py',
@@ -817,9 +814,7 @@ class TestPep8(object):
'ckanext/datastore/bin/datastore_setup.py',
'ckanext/datastore/logic/action.py',
'ckanext/datastore/plugin.py',
- 'ckanext/datastore/tests/test_configure.py',
'ckanext/datastore/tests/test_create.py',
- 'ckanext/datastore/tests/test_delete.py',
'ckanext/datastore/tests/test_search.py',
'ckanext/datastore/tests/test_upsert.py',
'ckanext/example_idatasetform/plugin.py',
@@ -868,12 +863,19 @@ def test_pep8_pass(self):
msg = 'The following files passed pep8 but are blacklisted'
show_passing(msg, self.passes)
- @staticmethod
- def find_pep8_errors(filename=None, lines=None):
-
+ @classmethod
+ def find_pep8_errors(cls, filename=None, lines=None):
try:
sys.stdout = cStringIO.StringIO()
- checker = pep8.Checker(filename=filename, lines=lines)
+ config = {}
+
+ # Ignore long lines on test files, as the test names can get long
+ # when following our test naming standards.
+ if cls._is_test(filename):
+ config['ignore'] = ['E501']
+
+ checker = pep8.Checker(filename=filename, lines=lines,
+ **config)
checker.check_all()
output = sys.stdout.getvalue()
finally:
@@ -888,6 +890,10 @@ def find_pep8_errors(filename=None, lines=None):
errors.append('%s ln:%s %s' % (error, line_no, desc))
return errors
+ @classmethod
+ def _is_test(cls, filename):
+ return bool(re.search('(^|\W)test_.*\.py$', filename, re.IGNORECASE))
+
class TestActionAuth(object):
''' These tests check the logic auth/action functions are compliant. The
diff --git a/ckanext/datastore/bin/datastore_setup.py b/ckanext/datastore/bin/datastore_setup.py
index 3a5564fbb1a..d27af1cba70 100644
--- a/ckanext/datastore/bin/datastore_setup.py
+++ b/ckanext/datastore/bin/datastore_setup.py
@@ -21,15 +21,16 @@ def _run_cmd(command_line, inputstring=''):
sys.exit(1)
-def _run_sql(sql, as_sql_user, database='postgres'):
+def _run_sql(sql, as_sql_user, pgport, database='postgres'):
logging.debug("Executing: \n#####\n", sql, "\n####\nOn database:", database)
- _run_cmd("sudo -u '{username}' psql --dbname='{database}' --no-password --set ON_ERROR_STOP=1".format(
+ _run_cmd("sudo -u '{username}' psql -p {pgport} --dbname='{database}' --no-password --set ON_ERROR_STOP=1".format(
+ pgport=pgport or '5432',
username=as_sql_user,
database=database
), inputstring=sql)
-def set_permissions(pguser, ckandb, datastoredb, ckanuser, writeuser, readonlyuser):
+def set_permissions(pguser, pgport, ckandb, datastoredb, ckanuser, writeuser, readonlyuser):
__dir__ = os.path.dirname(os.path.abspath(__file__))
filepath = os.path.join(__dir__, 'set_permissions.sql')
with open(filepath) as f:
@@ -44,6 +45,7 @@ def set_permissions(pguser, ckandb, datastoredb, ckanuser, writeuser, readonlyus
_run_sql(sql,
as_sql_user=pguser,
+ pgport=pgport,
database=datastoredb)
@@ -53,6 +55,8 @@ def set_permissions(pguser, ckandb, datastoredb, ckanuser, writeuser, readonlyus
description='Set the permissions on the CKAN datastore. ',
epilog='"The ships hung in the sky in much the same way that bricks don\'t."')
+ argparser.add_argument('-P', '--pg_port', dest='pgport', default='5432', type=str,
+ help="the postgres port")
argparser.add_argument('-p', '--pg_super_user', dest='pguser', default='postgres', type=str,
help="the postgres super user")
@@ -71,6 +75,7 @@ def set_permissions(pguser, ckandb, datastoredb, ckanuser, writeuser, readonlyus
set_permissions(
pguser=args.pguser,
+ pgport=args.pgport,
ckandb=args.ckandb,
datastoredb=args.datastoredb,
ckanuser=args.ckanuser,
diff --git a/ckanext/datastore/commands.py b/ckanext/datastore/commands.py
index 37866cb7ed5..c1171058628 100644
--- a/ckanext/datastore/commands.py
+++ b/ckanext/datastore/commands.py
@@ -59,6 +59,7 @@ def command(self):
if cmd == 'set-permissions':
setup.set_permissions(
pguser=self.args[1],
+ pgport=self.db_ckan_url_parts['db_port'],
ckandb=self.db_ckan_url_parts['db_name'],
datastoredb=self.db_write_url_parts['db_name'],
ckanuser=self.db_ckan_url_parts['db_user'],
diff --git a/ckanext/datastore/logic/auth.py b/ckanext/datastore/logic/auth.py
index d002d106fda..73d78e03b84 100644
--- a/ckanext/datastore/logic/auth.py
+++ b/ckanext/datastore/logic/auth.py
@@ -4,6 +4,7 @@
def datastore_auth(context, data_dict, privilege='resource_update'):
if not 'id' in data_dict:
data_dict['id'] = data_dict.get('resource_id')
+
user = context.get('user')
authorized = p.toolkit.check_access(privilege, context, data_dict)
@@ -19,7 +20,14 @@ def datastore_auth(context, data_dict, privilege='resource_update'):
def datastore_create(context, data_dict):
- return datastore_auth(context, data_dict)
+
+ if 'resource' in data_dict and data_dict['resource'].get('package_id'):
+ data_dict['id'] = data_dict['resource'].get('package_id')
+ privilege = 'package_update'
+ else:
+ privilege = 'resource_update'
+
+ return datastore_auth(context, data_dict, privilege=privilege)
def datastore_upsert(context, data_dict):
diff --git a/ckanext/datastore/tests/test_create.py b/ckanext/datastore/tests/test_create.py
index f2db232af8a..c1f464b48a9 100644
--- a/ckanext/datastore/tests/test_create.py
+++ b/ckanext/datastore/tests/test_create.py
@@ -538,6 +538,43 @@ def test_create_basic(self):
assert res_dict['success'] is True, res_dict
+ def test_create_datastore_resource_on_dataset(self):
+ pkg = model.Package.get('annakarenina')
+
+ data = {
+ 'resource': {
+ 'package_id': pkg.id,
+ },
+ 'fields': [{'id': 'boo%k', 'type': 'text'}, # column with percent
+ {'id': 'author', 'type': 'json'}],
+ 'indexes': [['boo%k', 'author'], 'author'],
+ 'records': [{'boo%k': 'crime', 'author': ['tolstoy', 'dostoevsky']},
+ {'boo%k': 'annakarenina', 'author': ['tolstoy', 'putin']},
+ {'boo%k': 'warandpeace'}] # treat author as null
+ }
+
+ postparams = '%s=1' % json.dumps(data)
+ auth = {'Authorization': str(self.normal_user.apikey)}
+ res = self.app.post('/api/action/datastore_create', params=postparams,
+ extra_environ=auth)
+ res_dict = json.loads(res.body)
+
+ assert res_dict['success'] is True
+ res = res_dict['result']
+ assert res['fields'] == data['fields'], res['fields']
+ assert res['records'] == data['records']
+
+ # Get resource details
+ data = {
+ 'id': res['resource_id']
+ }
+ postparams = '%s=1' % json.dumps(data)
+ res = self.app.post('/api/action/resource_show', params=postparams)
+ res_dict = json.loads(res.body)
+
+ assert res_dict['result']['datastore_active'] is True
+
+
def test_guess_types(self):
resource = model.Package.get('annakarenina').resources[1]
diff --git a/ckanext/example_idatasetform/plugin.py b/ckanext/example_idatasetform/plugin.py
index de3aa86692b..12542a3f252 100644
--- a/ckanext/example_idatasetform/plugin.py
+++ b/ckanext/example_idatasetform/plugin.py
@@ -92,6 +92,10 @@ def _modify_package_schema(self, schema):
'custom_text': [tk.get_validator('ignore_missing'),
tk.get_converter('convert_to_extras')]
})
+ # Add our custom_resource_text metadata field to the schema
+ schema['resources'].update({
+ 'custom_resource_text' : [ tk.get_validator('ignore_missing') ]
+ })
return schema
def create_package_schema(self):
@@ -124,6 +128,9 @@ def show_package_schema(self):
tk.get_validator('ignore_missing')]
})
+ schema['resources'].update({
+ 'custom_resource_text' : [ tk.get_validator('ignore_missing') ]
+ })
return schema
# These methods just record how many times they're called, for testing
diff --git a/ckanext/example_idatasetform/plugin_v1.py b/ckanext/example_idatasetform/plugin_v1.py
new file mode 100644
index 00000000000..183e12ff28e
--- /dev/null
+++ b/ckanext/example_idatasetform/plugin_v1.py
@@ -0,0 +1,43 @@
+import ckan.plugins as p
+import ckan.plugins.toolkit as tk
+
+
+class ExampleIDatasetFormPlugin(p.SingletonPlugin, tk.DefaultDatasetForm):
+ p.implements(p.IDatasetForm)
+
+ def create_package_schema(self):
+ # let's grab the default schema in our plugin
+ schema = super(ExampleIDatasetFormPlugin, self).create_package_schema()
+ #our custom field
+ schema.update({
+ 'custom_text': [tk.get_validator('ignore_missing'),
+ tk.get_converter('convert_to_extras')]
+ })
+ return schema
+
+ def update_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).update_package_schema()
+ #our custom field
+ schema.update({
+ 'custom_text': [tk.get_validator('ignore_missing'),
+ tk.get_converter('convert_to_extras')]
+ })
+ return schema
+
+ def show_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).show_package_schema()
+ schema.update({
+ 'custom_text': [tk.get_converter('convert_from_extras'),
+ tk.get_validator('ignore_missing')]
+ })
+ return schema
+
+ def is_fallback(self):
+ # Return True to register this plugin as the default handler for
+ # package types not handled by any other IDatasetForm plugin.
+ return True
+
+ def package_types(self):
+ # This plugin doesn't handle any special package types, it just
+ # registers itself as the default (above).
+ return []
diff --git a/ckanext/example_idatasetform/plugin_v2.py b/ckanext/example_idatasetform/plugin_v2.py
new file mode 100644
index 00000000000..9741d8be7ff
--- /dev/null
+++ b/ckanext/example_idatasetform/plugin_v2.py
@@ -0,0 +1,50 @@
+import ckan.plugins as p
+import ckan.plugins.toolkit as tk
+
+
+class ExampleIDatasetFormPlugin(p.SingletonPlugin, tk.DefaultDatasetForm):
+ p.implements(p.IDatasetForm)
+ p.implements(p.IConfigurer)
+
+ def create_package_schema(self):
+ # let's grab the default schema in our plugin
+ schema = super(ExampleIDatasetFormPlugin, self).create_package_schema()
+ #our custom field
+ schema.update({
+ 'custom_text': [tk.get_validator('ignore_missing'),
+ tk.get_converter('convert_to_extras')]
+ })
+ return schema
+
+ def update_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).update_package_schema()
+ #our custom field
+ schema.update({
+ 'custom_text': [tk.get_validator('ignore_missing'),
+ tk.get_converter('convert_to_extras')]
+ })
+ return schema
+
+ def show_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).show_package_schema()
+ schema.update({
+ 'custom_text': [tk.get_converter('convert_from_extras'),
+ tk.get_validator('ignore_missing')]
+ })
+ return schema
+
+ #is fall back
+ def is_fallback(self):
+ # Return True to register this plugin as the default handler for
+ # package types not handled by any other IDatasetForm plugin.
+ return True
+
+ def package_types(self):
+ # This plugin doesn't handle any special package types, it just
+ # registers itself as the default (above).
+ return []
+
+ def update_config(self, config):
+ # Add this plugin's templates dir to CKAN's extra_template_paths, so
+ # that CKAN will use this plugin's custom templates.
+ tk.add_template_directory(config, 'templates')
diff --git a/ckanext/example_idatasetform/plugin_v3.py b/ckanext/example_idatasetform/plugin_v3.py
new file mode 100644
index 00000000000..a80d26a46db
--- /dev/null
+++ b/ckanext/example_idatasetform/plugin_v3.py
@@ -0,0 +1,42 @@
+'''Example IDatasetFormPlugin'''
+import ckan.plugins as p
+import ckan.plugins.toolkit as tk
+
+
+class ExampleIDatasetFormPlugin(p.SingletonPlugin, tk.DefaultDatasetForm):
+ p.implements(p.IDatasetForm)
+
+ def _modify_package_schema(self, schema):
+ schema.update({
+ 'custom_text': [tk.get_validator('ignore_missing'),
+ tk.get_converter('convert_to_extras')]
+ })
+ return schema
+
+ def create_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).create_package_schema()
+ schema = self._modify_package_schema(schema)
+ return schema
+
+ def update_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).update_package_schema()
+ schema = self._modify_package_schema(schema)
+ return schema
+
+ def show_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).show_package_schema()
+ schema.update({
+ 'custom_text': [tk.get_converter('convert_from_extras'),
+ tk.get_validator('ignore_missing')]
+ })
+ return schema
+
+ def is_fallback(self):
+ # Return True to register this plugin as the default handler for
+ # package types not handled by any other IDatasetForm plugin.
+ return True
+
+ def package_types(self):
+ # This plugin doesn't handle any special package types, it just
+ # registers itself as the default (above).
+ return []
diff --git a/ckanext/example_idatasetform/plugin_v4.py b/ckanext/example_idatasetform/plugin_v4.py
new file mode 100644
index 00000000000..01f6ce5c430
--- /dev/null
+++ b/ckanext/example_idatasetform/plugin_v4.py
@@ -0,0 +1,89 @@
+import ckan.plugins as p
+import ckan.plugins.toolkit as tk
+
+
+def create_country_codes():
+ user = tk.get_action('get_site_user')({'ignore_auth': True}, {})
+ context = {'user': user['name']}
+ try:
+ data = {'id': 'country_codes'}
+ tk.get_action('vocabulary_show')(context, data)
+ except tk.ObjectNotFound:
+ data = {'name': 'country_codes'}
+ vocab = tk.get_action('vocabulary_create')(context, data)
+ for tag in (u'uk', u'ie', u'de', u'fr', u'es'):
+ data = {'name': tag, 'vocabulary_id': vocab['id']}
+ tk.get_action('tag_create')(context, data)
+
+
+def country_codes():
+ create_country_codes()
+ try:
+ tag_list = tk.get_action('tag_list')
+ country_codes = tag_list(data_dict={'vocabulary_id': 'country_codes'})
+ return country_codes
+ except tk.ObjectNotFound:
+ return None
+
+
+class ExampleIDatasetFormPlugin(p.SingletonPlugin, tk.DefaultDatasetForm):
+ p.implements(p.IDatasetForm)
+ p.implements(p.IConfigurer)
+ p.implements(p.ITemplateHelpers)
+
+ def get_helpers(self):
+ return {'country_codes': country_codes}
+
+ def _modify_package_schema(self, schema):
+ schema.update({
+ 'custom_text': [tk.get_validator('ignore_missing'),
+ tk.get_converter('convert_to_extras')]
+ })
+ schema.update({
+ 'country_code': [
+ tk.get_validator('ignore_missing'),
+ tk.get_converter('convert_to_tags')('country_codes')
+ ]
+ })
+ return schema
+
+ def show_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).show_package_schema()
+ schema.update({
+ 'custom_text': [tk.get_converter('convert_from_extras'),
+ tk.get_validator('ignore_missing')]
+ })
+
+ schema['tags']['__extras'].append(tk.get_converter('free_tags_only'))
+ schema.update({
+ 'country_code': [
+ tk.get_converter('convert_from_tags')('country_codes'),
+ tk.get_validator('ignore_missing')]
+ })
+ return schema
+
+ def create_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).create_package_schema()
+ schema = self._modify_package_schema(schema)
+ return schema
+
+ def update_package_schema(self):
+ schema = super(ExampleIDatasetFormPlugin, self).update_package_schema()
+ schema = self._modify_package_schema(schema)
+ return schema
+
+ def is_fallback(self):
+ # Return True to register this plugin as the default handler for
+ # package types not handled by any other IDatasetForm plugin.
+ return True
+
+ def package_types(self):
+ # This plugin doesn't handle any special package types, it just
+ # registers itself as the default (above).
+ return []
+
+ #update config
+ def update_config(self, config):
+ # Add this plugin's templates dir to CKAN's extra_template_paths, so
+ # that CKAN will use this plugin's custom templates.
+ tk.add_template_directory(config, 'templates')
diff --git a/ckanext/example_idatasetform/templates/package/search.html b/ckanext/example_idatasetform/templates/package/search.html
new file mode 100644
index 00000000000..67cfe5229f1
--- /dev/null
+++ b/ckanext/example_idatasetform/templates/package/search.html
@@ -0,0 +1,21 @@
+{% ckan_extends %}
+
+{% block form %}
+ {% set facets = {
+ 'fields': c.fields_grouped,
+ 'search': c.search_facets,
+ 'titles': c.facet_titles,
+ 'translated_fields': c.translated_fields,
+ 'remove_field': c.remove_field }
+ %}
+ {% set sorting = [
+ (_('Relevance'), 'score desc, metadata_modified desc'),
+ (_('Name Ascending'), 'title_string asc'),
+ (_('Name Descending'), 'title_string desc'),
+ (_('Last Modified'), 'metadata_modified desc'),
+ (_('Custom Field Ascending'), 'custom_text asc'),
+ (_('Custom Field Descending'), 'custom_text desc'),
+ (_('Popular'), 'views_recent desc') if g.tracking_enabled else (false, false) ]
+ %}
+ {% snippet 'snippets/search_form.html', type='dataset', query=c.q, sorting=sorting, sorting_selected=c.sort_by_selected, count=c.page.item_count, facets=facets, show_empty=request.params, error=c.query_error %}
+{% endblock %}
diff --git a/ckanext/example_idatasetform/templates/package/snippets/additional_info.html b/ckanext/example_idatasetform/templates/package/snippets/additional_info.html
new file mode 100644
index 00000000000..c48488e5cc4
--- /dev/null
+++ b/ckanext/example_idatasetform/templates/package/snippets/additional_info.html
@@ -0,0 +1,10 @@
+{% ckan_extends %}
+
+{% block extras %}
+ {% if pkg_dict.custom_text %}
+
+ | {{ _("Custom Text") }} |
+ {{ pkg_dict.custom_text }} |
+
+ {% endif %}
+{% endblock %}
diff --git a/ckanext/example_idatasetform/templates/package/snippets/resource_form.html b/ckanext/example_idatasetform/templates/package/snippets/resource_form.html
new file mode 100644
index 00000000000..5e36126ac62
--- /dev/null
+++ b/ckanext/example_idatasetform/templates/package/snippets/resource_form.html
@@ -0,0 +1,7 @@
+{% ckan_extends %}
+
+{% block basic_fields_url %}
+{{ super() }}
+
+ {{ form.input('custom_resource_text', label=_('Custom Text'), id='field-custom_resource_text', placeholder=_('custom resource text'), value=data.custom_resource_text, error=errors.custom_resource_text, classes=['control-medium']) }}
+{% endblock %}
diff --git a/ckanext/example_idatasetform/tests/__init__.py b/ckanext/example_idatasetform/tests/__init__.py
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/ckanext/example_idatasetform/tests/test_example_idatasetform.py b/ckanext/example_idatasetform/tests/test_example_idatasetform.py
new file mode 100644
index 00000000000..cbe34059e92
--- /dev/null
+++ b/ckanext/example_idatasetform/tests/test_example_idatasetform.py
@@ -0,0 +1,248 @@
+import nose.tools as nt
+
+import pylons.config as config
+
+import ckan.model as model
+import ckan.plugins as plugins
+import ckan.new_tests.helpers as helpers
+import ckanext.example_idatasetform as idf
+import ckan.lib.search
+
+
+class ExampleIDatasetFormPluginBase(object):
+ '''Version 1, 2 and 3 of the plugin are basically the same, so this class
+ provides the tests that all three versions of the plugins will run'''
+ @classmethod
+ def setup_class(cls):
+ cls.original_config = config.copy()
+
+ def teardown(self):
+ model.repo.rebuild_db()
+ ckan.lib.search.clear()
+
+ @classmethod
+ def teardown_class(cls):
+ helpers.reset_db()
+ model.repo.rebuild_db()
+ ckan.lib.search.clear()
+
+ config.clear()
+ config.update(cls.original_config)
+
+ def test_package_create(self):
+ result = helpers.call_action('package_create', name='test_package',
+ custom_text='this is my custom text')
+ nt.assert_equals('this is my custom text', result['custom_text'])
+
+ def test_package_update(self):
+ helpers.call_action('package_create', name='test_package',
+ custom_text='this is my custom text')
+ result = helpers.call_action('package_update', name='test_package',
+ custom_text='this is my updated text')
+ nt.assert_equals('this is my updated text', result['custom_text'])
+
+ def test_package_show(self):
+ helpers.call_action('package_create', name='test_package',
+ custom_text='this is my custom text')
+ result = helpers.call_action('package_show', name_or_id='test_package')
+ nt.assert_equals('this is my custom text', result['custom_text'])
+
+
+class TestVersion1(ExampleIDatasetFormPluginBase):
+ @classmethod
+ def setup_class(cls):
+ super(TestVersion1, cls).setup_class()
+ plugins.load('example_idatasetform_v1')
+
+ @classmethod
+ def teardown_class(cls):
+ plugins.unload('example_idatasetform_v1')
+ super(TestVersion1, cls).teardown_class()
+
+
+class TestVersion2(ExampleIDatasetFormPluginBase):
+ @classmethod
+ def setup_class(cls):
+ super(TestVersion2, cls).setup_class()
+ plugins.load('example_idatasetform_v2')
+
+ @classmethod
+ def teardown_class(cls):
+ plugins.unload('example_idatasetform_v2')
+ super(TestVersion2, cls).teardown_class()
+
+
+class TestVersion3(ExampleIDatasetFormPluginBase):
+ @classmethod
+ def setup_class(cls):
+ super(TestVersion3, cls).setup_class()
+ plugins.load('example_idatasetform_v3')
+
+ @classmethod
+ def teardown_class(cls):
+ plugins.unload('example_idatasetform_v3')
+ super(TestVersion3, cls).teardown_class()
+
+
+class TestIDatasetFormPluginVersion4(object):
+ @classmethod
+ def setup_class(cls):
+ cls.original_config = config.copy()
+ plugins.load('example_idatasetform_v4')
+
+ def teardown(self):
+ model.repo.rebuild_db()
+
+ @classmethod
+ def teardown_class(cls):
+ plugins.unload('example_idatasetform_v4')
+ helpers.reset_db()
+ ckan.lib.search.clear()
+
+ config.clear()
+ config.update(cls.original_config)
+
+ def test_package_create(self):
+ idf.plugin_v4.create_country_codes()
+ result = helpers.call_action('package_create', name='test_package',
+ custom_text='this is my custom text',
+ country_code='uk')
+ nt.assert_equals('this is my custom text', result['custom_text'])
+ nt.assert_equals([u'uk'], result['country_code'])
+
+ def test_package_create_wrong_country_code(self):
+ idf.plugin_v4.create_country_codes()
+ nt.assert_raises(plugins.toolkit.ValidationError,
+ helpers.call_action,
+ 'package_create',
+ name='test_package',
+ custom_text='this is my custom text',
+ country_code='notcode')
+
+ def test_package_update(self):
+ idf.plugin_v4.create_country_codes()
+ helpers.call_action('package_create', name='test_package',
+ custom_text='this is my custom text',
+ country_code='uk')
+ result = helpers.call_action('package_update', name='test_package',
+ custom_text='this is my updated text',
+ country_code='ie')
+ nt.assert_equals('this is my updated text', result['custom_text'])
+ nt.assert_equals([u'ie'], result['country_code'])
+
+
+class TestIDatasetFormPlugin(object):
+ @classmethod
+ def setup_class(cls):
+ cls.original_config = config.copy()
+ plugins.load('example_idatasetform')
+
+ def teardown(self):
+ model.repo.rebuild_db()
+ ckan.lib.search.clear()
+
+ @classmethod
+ def teardown_class(cls):
+ plugins.unload('example_idatasetform')
+ helpers.reset_db()
+ ckan.lib.search.clear()
+
+ config.clear()
+ config.update(cls.original_config)
+
+ def test_package_create(self):
+ idf.plugin.create_country_codes()
+ result = helpers.call_action(
+ 'package_create', name='test_package',
+ custom_text='this is my custom text', country_code='uk',
+ resources=[{
+ 'url': 'http://test.com/',
+ 'custom_resource_text': 'my custom resource',
+ }])
+ nt.assert_equals('my custom resource',
+ result['resources'][0]['custom_resource_text'])
+
+ def test_package_update(self):
+ idf.plugin.create_country_codes()
+ helpers.call_action(
+ 'package_create', name='test_package',
+ custom_text='this is my custom text', country_code='uk',
+ resources=[{
+ 'url': 'http://test.com/',
+ 'custom_resource_text': 'my custom resource',
+ }])
+ result = helpers.call_action(
+ 'package_update',
+ name='test_package',
+ custom_text='this is my updated text',
+ country_code='ie',
+ resources=[{
+ 'url': 'http://test.com/',
+ 'custom_resource_text': 'updated custom resource',
+ }]
+ )
+ nt.assert_equals('this is my updated text', result['custom_text'])
+ nt.assert_equals([u'ie'], result['country_code'])
+ nt.assert_equals('updated custom resource',
+ result['resources'][0]['custom_resource_text'])
+
+ def test_package_show(self):
+ idf.plugin.create_country_codes()
+ helpers.call_action(
+ 'package_create', name='test_package',
+ custom_text='this is my custom text', country_code='uk',
+ resources=[{
+ 'url': 'http://test.com/',
+ 'custom_resource_text': 'my custom resource',
+ }]
+ )
+ result = helpers.call_action('package_show', name_or_id='test_package')
+ nt.assert_equals('my custom resource',
+ result['resources'][0]['custom_resource_text'])
+ nt.assert_equals('my custom resource',
+ result['resources'][0]['custom_resource_text'])
+
+
+class TestCustomSearch(object):
+ @classmethod
+ def setup_class(cls):
+ cls.original_config = config.copy()
+ cls.app = helpers._get_test_app()
+ plugins.load('example_idatasetform')
+
+ def teardown(self):
+ model.repo.rebuild_db()
+ ckan.lib.search.clear()
+
+ @classmethod
+ def teardown_class(cls):
+ plugins.unload('example_idatasetform')
+ helpers.reset_db()
+ ckan.lib.search.clear()
+
+ config.clear()
+ config.update(cls.original_config)
+
+ def test_custom_search(self):
+ helpers.call_action('package_create', name='test_package_a',
+ custom_text='z')
+ helpers.call_action('package_create', name='test_package_b',
+ custom_text='y')
+
+ response = self.app.get('/dataset')
+
+ # change the sort by form to our custom_text ascending
+ response.forms[1].fields['sort'][0].value = 'custom_text asc'
+ response = response.forms[1].submit()
+ # check that package_b appears before package a (y < z)
+ a = response.body.index('test_package_a')
+ b = response.body.index('test_package_b')
+ nt.assert_true(b < a)
+
+ response.forms[1].fields['sort'][0].value = 'custom_text desc'
+ # check that package_a appears before package b (z is first in
+ # descending order)
+ response = response.forms[1].submit()
+ a = response.body.index('test_package_a')
+ b = response.body.index('test_package_b')
+ nt.assert_true(a < b)
diff --git a/ckanext/resourceproxy/controller.py b/ckanext/resourceproxy/controller.py
index 0e8fd9bfd11..c0bd4db47a0 100644
--- a/ckanext/resourceproxy/controller.py
+++ b/ckanext/resourceproxy/controller.py
@@ -5,6 +5,7 @@
import ckan.logic as logic
import ckan.lib.base as base
+from ckan.common import _
log = getLogger(__name__)
@@ -20,7 +21,11 @@ def proxy_resource(context, data_dict):
than the maximum file size. '''
resource_id = data_dict['resource_id']
log.info('Proxify resource {id}'.format(id=resource_id))
- resource = logic.get_action('resource_show')(context, {'id': resource_id})
+ try:
+ resource = logic.get_action('resource_show')(context, {'id':
+ resource_id})
+ except logic.NotFound:
+ base.abort(404, _('Resource not found'))
url = resource['url']
parts = urlparse.urlsplit(url)
diff --git a/ckanext/resourceproxy/tests/test_proxy.py b/ckanext/resourceproxy/tests/test_proxy.py
index dac7c747606..7de6e965436 100644
--- a/ckanext/resourceproxy/tests/test_proxy.py
+++ b/ckanext/resourceproxy/tests/test_proxy.py
@@ -170,3 +170,12 @@ def test_resource_url_doesnt_proxy_non_http_or_https_urls_by_default(self):
proxied_url = proxy.get_proxified_resource_url(data_dict, scheme)
assert non_proxied_url == url, non_proxied_url
assert proxied_url != url, proxied_url
+
+ def test_non_existent_resource(self):
+ self.data_dict = {'package': {'name': 'doesnotexist'},
+ 'resource': {'id': 'doesnotexist'}}
+
+ proxied_url = proxy.get_proxified_resource_url(self.data_dict)
+ result = self.app.get(proxied_url, status='*')
+ assert result.status == 404, result.status
+ assert 'Resource not found' in result.body, result.body
diff --git a/ckanext/stats/__init__.py b/ckanext/stats/__init__.py
index b646540d6be..de40ea7ca05 100644
--- a/ckanext/stats/__init__.py
+++ b/ckanext/stats/__init__.py
@@ -1 +1 @@
-# empty file needed for pylons to find templates in this directory
+__import__('pkg_resources').declare_namespace(__name__)
diff --git a/doc/contributing/architecture.rst b/doc/contributing/architecture.rst
index 50114ff53d4..be571c13b3a 100644
--- a/doc/contributing/architecture.rst
+++ b/doc/contributing/architecture.rst
@@ -160,21 +160,32 @@ the helper functions found in ``ckan.lib.helpers.__allowed_functions__``.
Deprecation
-----------
-- Anything that may be used by extensions (see :doc:`/extensions/index`) needs
- to maintain backward compatibility at call-site. ie - template helper
- functions and functions defined in the plugins toolkit.
+- Anything that may be used by :doc:`extensions `,
+ :doc:`themes ` or :doc:`API clients ` needs to
+ maintain backward compatibility at call-site. For example: action functions,
+ template helper functions and functions defined in the plugins toolkit.
- The length of time of deprecation is evaluated on a function-by-function
- basis. At minimum, a function should be marked as deprecated during a point
+ basis. At minimum, a function should be marked as deprecated during a point
release.
-- To mark a helper function, use the ``deprecated`` decorator found in
- ``ckan.lib.maintain`` eg: ::
-
- @deprecated()
- def facet_items(*args, **kwargs):
- """
- DEPRECATED: Use the new facet data structure, and `unselected_facet_items()`
- """
- # rest of function definition.
-
+- To deprecate a function use the :py:func:`ckan.lib.maintain.deprecated`
+ decorator and add "deprecated" to the function's docstring::
+
+ @maintain.deprecated("helpers.get_action() is deprecated and will be removed "
+ "in a future version of CKAN. Instead, please use the "
+ "extra_vars param to render() in your controller to pass "
+ "results from action functions to your templates.")
+ def get_action(action_name, data_dict=None):
+ '''Calls an action function from a template. Deprecated in CKAN 2.3.'''
+ if data_dict is None:
+ data_dict = {}
+ return logic.get_action(action_name)({}, data_dict)
+
+- Any deprecated functions should be added to an *API changes and deprecations*
+ section in the :doc:`/changelog` entry for the next release (do this before
+ merging the deprecation into master)
+
+- Keep the deprecation messages passed to the decorator short, they appear in
+ logs. Put longer explanations of why something was deprecated in the
+ changelog.
diff --git a/doc/contributing/pull-requests.rst b/doc/contributing/pull-requests.rst
index 6909657b5c3..8452e0a5c53 100644
--- a/doc/contributing/pull-requests.rst
+++ b/doc/contributing/pull-requests.rst
@@ -64,7 +64,11 @@ This section will walk you through the steps for making a pull request.
- Your branch should contain new or changed tests for any new or changed
code, and all the CKAN tests should pass on your branch, see
- :doc:`test`.
+ `Testing CKAN `_.
+
+ - Your pull request shouldn't lower our test coverage. You can check it at
+ our `coveralls page `. If for some
+ reason you can't avoid lowering it, explain why on the pull request.
- Your branch should contain new or updated documentation for any new or
updated code, see :doc:`documentation`.
diff --git a/doc/extensions/adding-custom-fields.rst b/doc/extensions/adding-custom-fields.rst
new file mode 100644
index 00000000000..f7a5131f737
--- /dev/null
+++ b/doc/extensions/adding-custom-fields.rst
@@ -0,0 +1,316 @@
+===================================================================
+Customizing dataset and resource metadata fields using IDatasetForm
+===================================================================
+
+Storing additional metadata for a dataset beyond the default metadata in CKAN
+is a common use case. CKAN provides a simple way to do this by allowing you to
+store arbitrary key/value pairs against a dataset when creating or updating the
+dataset. These appear under the "Additional Information" section on the web
+interface and in 'extras' field of the JSON when accessed via the API.
+
+Default extras can only take strings for their keys and values, no
+validation is applied to the inputs and you cannot make them mandatory or
+restrict the possible values to a defined list. By using CKAN's IDatasetForm
+plugin interface, a CKAN plugin can add custom, first-class metadata fields to
+CKAN datasets, and can do custom validation of these fields.
+
+.. seealso::
+ In this tutorial we are assuming that you have read the
+ :doc:`/extensions/tutorial`
+
+CKAN schemas and validation
+---------------------------
+When a dataset is created, updated or viewed, the parameters passed to CKAN
+(e.g. via the web form when creating or updating a dataset, or posted to an API
+end point) are validated against a schema. For each parameter, the schema will
+contain a corresponding list of functions that will be run against the value of
+the parameter. Generally these functions are used to validate the value
+(and raise an error if the value fails validation) or convert the value to a
+different value.
+
+For example, the schemas can allow optional values by using the
+:func:`~ckan.lib.navl.validators.ignore_missing` validator or check that a
+dataset exists using :func:`~ckan.logic.validators.package_id_exists`. A list
+of available validators and converters can be found at the :doc:`validators`
+and :doc:`converters`. You can also define your own validators for custom
+validation.
+
+We will be customizing these schemas to add our additional fields. The
+:py:class:`~ckan.plugins.interfaces.IDatasetForm` interface allows us to
+override the schemas for creation, updating and displaying of datasets.
+
+.. autosummary::
+
+ ~ckan.plugins.interfaces.IDatasetForm.create_package_schema
+ ~ckan.plugins.interfaces.IDatasetForm.update_package_schema
+ ~ckan.plugins.interfaces.IDatasetForm.show_package_schema
+ ~ckan.plugins.interfaces.IDatasetForm.is_fallback
+ ~ckan.plugins.interfaces.IDatasetForm.package_types
+
+CKAN allows you to have multiple IDatasetForm plugins, each handling different
+dataset types. So you could customize the CKAN web front end, for different
+types of datasets. In this tutorial we will be defining our plugin as the
+fallback plugin. This plugin is used if no other IDatasetForm plugin is found
+that handles that dataset type.
+
+The IDatasetForm also has other additional functions that allow you to
+provide a custom template to be rendered for the CKAN frontend, but we will
+not be using them for this tutorial.
+
+Adding custom fields to datasets
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Create a new plugin named ``ckanext-extrafields`` and create a class named
+``ExampleIDatasetFormPlugins`` inside
+``ckanext-extrafields/ckanext/extrafields/plugins.py`` that implements the
+``IDatasetForm`` interface and inherits from ``SingletonPlugin`` and
+``DefaultDatasetForm``.
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v1.py
+ :end-before: def create_package_schema(self):
+
+Updating the CKAN schema
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+The :py:meth:`~ckan.plugins.interfaces.IDatasetForm.create_package_schema`
+function is used whenever a new dataset is created, we'll want update the
+default schema and insert our custom field here. We will fetch the default
+schema defined in
+:py:func:`~ckan.logic.schema.default_create_package_schema` by running
+:py:meth:`~ckan.plugins.interfaces.IDatasetForm.create_package_schema`'s
+super function and update it.
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v1.py
+ :pyobject: ExampleIDatasetFormPlugin.create_package_schema
+
+The CKAN schema is a dictionary where the key is the name of the field and the
+value is a list of validators and converters. Here we have a validator to tell
+CKAN to not raise a validation error if the value is missing and a converter to
+convert the value to and save as an extra. We will want to change the
+:py:meth:`~ckan.plugins.interfaces.IDatasetForm.update_package_schema` function
+with the same update code.
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v1.py
+ :pyobject: ExampleIDatasetFormPlugin.update_package_schema
+
+The :py:meth:`~ckan.plugins.interfaces.IDatasetForm.show_package_schema` is used
+when the :py:func:`~ckan.logic.action.get.package_show` action is called, we
+want the default_show_package_schema to be updated to include our custom field.
+This time, instead of converting to an extras field, we want our field to be
+converted *from* an extras field. So we want to use the
+:py:meth:`~ckan.logic.converters.convert_from_extras` converter.
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v1.py
+ :emphasize-lines: 4
+ :pyobject: ExampleIDatasetFormPlugin.show_package_schema
+
+
+Dataset types
+^^^^^^^^^^^^^
+
+The :py:meth:`~ckan.plugins.interfaces.IDatasetForm.package_types` function
+defines a list of dataset types that this plugin handles. Each dataset has a
+field containing its type. Plugins can register to handle specific types of
+dataset and ignore others. Since our plugin is not for any specific type of
+dataset and we want our plugin to be the default handler, we update the plugin
+code to contain the following:
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v1.py
+ :lines: 34-
+
+Updating templates
+^^^^^^^^^^^^^^^^^^
+
+In order for our new field to be visible on the CKAN front-end, we need to
+update the templates. Add an additional line to make the plugin implement the
+IConfigurer interface
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v2.py
+ :emphasize-lines: 3
+ :start-after: import ckan.plugins.toolkit as tk
+ :end-before: def create_package_schema(self):
+
+This interface allows to implement a function
+:py:meth:`~ckan.plugins.interfaces.IDatasetForm.update_config` that allows us
+to update the CKAN config, in our case we want to add an additional location
+for CKAN to look for templates. Add the following code to your plugin.
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v2.py
+ :pyobject: ExampleIDatasetFormPlugin.update_config
+
+You will also need to add a directory under your extension directory to store
+the templates. Create a directory called
+``ckanext-extrafields/ckanext/extrafields/templates/`` and the subdirectories
+``ckanext-extrafields/ckanext/extrafields/templates/package/snippets/``.
+
+We need to override a few templates in order to get our custom field rendered.
+Firstly we need to remove the default custom field handling. Create a template
+file in our templates directory called
+``package/snippets/package_metadata_fields.html`` containing
+
+
+.. literalinclude:: ../../ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html
+ :language: jinja
+ :end-before: {% block package_metadata_fields %}
+
+This overrides the custom_fields block with an empty block so the default CKAN
+custom fields form does not render. Next add a template in our template
+directory called ``package/snippets/package_basic_fields.html`` containing
+
+.. literalinclude:: ../../ckanext/example_idatasetform/templates/package/snippets/package_basic_fields.html
+ :language: jinja
+
+This adds our custom_text field to the editing form. Finally we want to display
+our custom_text field on the dataset page. Add another file called
+``package/snippets/additional_info.html`` containing
+
+
+.. literalinclude:: ../../ckanext/example_idatasetform/templates/package/snippets/additional_info.html
+ :language: jinja
+
+This template overrides the default extras rendering on the dataset page
+and replaces it to just display our custom field.
+
+You're done! Make sure you have your plugin installed and setup as in the
+`extension/tutorial`. Then run a development server and you should now have
+an additional field called "Custom Text" when displaying and adding/editing a
+dataset.
+
+Cleaning up the code
+^^^^^^^^^^^^^^^^^^^^
+
+Before we continue further, we can clean up the
+:py:meth:`~ckan.plugins.interfaces.IDatasetForm.create_package_schema`
+and :py:meth:`~ckan.plugins.interfaces.IDatasetForm.update_package_schema`.
+There is a bit of duplication that we could remove. Replace the two functions
+with:
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v3.py
+ :start-after: p.implements(p.IDatasetForm)
+ :end-before: def show_package_schema(self):
+
+Tag vocabularies
+----------------
+If you need to add a custom field where the input options are restricted to a
+provided list of options, you can use tag vocabularies :doc:`/tag-vocabularies`.
+We will need to create our vocabulary first. By calling
+:func:`~ckan.logic.action.vocabulary_create`. Add a function to your plugin.py
+above your plugin class.
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v4.py
+ :pyobject: create_country_codes
+
+This code block is taken from the ``example_idatsetform plugin``.
+``create_country_codes`` tries to fetch the vocabulary country_codes using
+:func:`~ckan.logic.action.get.vocabulary_show`. If it is not found it will
+create it and iterate over the list of countries 'uk', 'ie', 'de', 'fr', 'es'.
+For each of these a vocabulary tag is created using
+:func:`~ckan.logic.action.create.tag_create`, belonging to the vocabulary
+``country_code``.
+
+Although we have only defined five tags here, additional tags can be created
+at any point by a sysadmin user by calling
+:func:`~ckan.logic.action.create.tag_create` using the API or action functions.
+Add a second function below ``create_country_codes``
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v4.py
+ :pyobject: country_codes
+
+country_codes will call ``create_country_codes`` so that the ``country_codes``
+vocabulary is created if it does not exist. Then it calls
+:func:`~ckan.logic.action.get.tag_list` to return all of our vocabulary tags
+together. Now we have a way of retrieving our tag vocabularies and creating
+them if they do not exist. We just need our plugin to call this code.
+
+Adding tags to the schema
+^^^^^^^^^^^^^^^^^^^^^^^^^
+Update :py:meth:`~ckan.plugins.interfaces.IDatasetForm._modify_package_schema`
+and :py:meth:`~ckan.plugins.interfaces.IDatasetForm.show_package_schema`
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v4.py
+ :start-after: return {'country_codes': country_codes}
+ :end-before: def create_package_schema(self):
+ :emphasize-lines: 9,21-26
+
+We are adding our tag to our plugin's schema. A converter is required to
+convert the field in to our tag in a similar way to how we converted our field
+to extras earlier. In
+:py:meth:`~ckan.plugins.interfaces.IDatasetForm.show_package_schema` we convert
+from the tag back again but we have an additional line with another converter
+containing
+:py:func:`~ckan.logic.converters.free_tags_only`. We include this line so that
+vocab tags are not shown mixed with normal free tags.
+
+Adding tags to templates
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Add an additional plugin.implements line to to your plugin
+to implement the :py:class:`~ckan.plugins.interfaces.ITemplateHelpers`, we will
+need to add a :py:meth:`~ckan.plugins.interfaces.ITemplateHelpers.get_helpers`
+function defined for this interface.
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin_v4.py
+ :start-after: p.implements(p.IConfigurer)
+ :end-before: def _modify_package_schema(self, schema):
+
+Our intention here is to tie our country_code fetching/creation to when they
+are used in the templates. Add the code below to
+``package/snippets/package_metadata_fields.html``
+
+.. literalinclude:: ../../ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html
+ :language: jinja
+ :start-after: {% endblock %}
+
+
+This adds our country code to our template, here we are using the additional
+helper country_codes that we defined in our get_helpers function in our plugin.
+
+Adding custom fields to resources
+---------------------------------
+
+In order to customize the fields in a resource the schema for resources needs
+to be modified in a similar way to the datasets. The resource schema
+is nested in the dataset dict as package['resources']. We modify this dict in
+a similar way to the dataset schema. Change ``_modify_package_schema`` to the
+following.
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin.py
+ :pyobject: ExampleIDatasetFormPlugin._modify_package_schema
+ :emphasize-lines: 14-16
+
+Update :py:meth:`~ckan.plugins.interfaces.IDatasetForm.show_package_schema`
+similarly
+
+.. literalinclude:: ../../ckanext/example_idatasetform/plugin.py
+ :pyobject: ExampleIDatasetFormPlugin.show_package_schema
+ :emphasize-lines: 20-23
+
+Save and reload your development server CKAN will take any additional keys from
+the resource schema and save them the its extras field. The templates will
+automatically check this field and display them in the resource_read page.
+
+Sorting by custom fields on the dataset search page
+---------------------------------------------------
+Now that we've added our custom field, we can customize the CKAN web front end
+search page to sort datasets by our custom field. Add a new file called
+``ckanext-extrafields/ckanext/extrafields/templates/package/search.html`` containing:
+
+.. literalinclude:: ../../ckanext/example_idatasetform/templates/package/search.html
+ :language: jinja
+ :emphasize-lines: 16-17
+
+This overrides the search ordering drop down code block, the code is the
+same as the default dataset search block but we are adding two additional lines
+that define the display name of that search ordering (e.g. Custom Field
+Ascending) and the SOLR sort ordering (e.g. custom_text asc). If you reload your
+development server you should be able to see these two additional sorting options
+on the dataset search page.
+
+The SOLR sort ordering can define arbitrary functions for custom sorting, but
+this is beyond the scope of this tutorial for further details see
+http://wiki.apache.org/solr/CommonQueryParameters#sort and
+http://wiki.apache.org/solr/FunctionQuery
+
+
+You can find the complete source for this tutorial at
+https://github.com/ckan/ckan/tree/master/ckanext/example_idatasetform
diff --git a/doc/extensions/index.rst b/doc/extensions/index.rst
index 4c45c918cf8..c932b4ddd66 100644
--- a/doc/extensions/index.rst
+++ b/doc/extensions/index.rst
@@ -33,6 +33,7 @@ features by developing your own CKAN extensions.
custom-config-settings
testing-extensions
best-practices
+ adding-custom-fields
plugin-interfaces
plugins-toolkit
converters
diff --git a/doc/images/add_dataset_3.jpg b/doc/images/add_dataset_3.jpg
index 4f46594a1b6..eee2f6b3f29 100644
Binary files a/doc/images/add_dataset_3.jpg and b/doc/images/add_dataset_3.jpg differ
diff --git a/doc/theming/best-practices.rst b/doc/theming/best-practices.rst
index 6ff17d5c044..91b9bc5f44e 100644
--- a/doc/theming/best-practices.rst
+++ b/doc/theming/best-practices.rst
@@ -9,8 +9,23 @@ Don't use ``c``
---------------
As much as possible, avoid accessing the Pylons template context :py:data:`c`
-(or :py:data:`tmpl_context`). Use
+(or :py:data:`tmpl_context`). :py:data:`c` is a thread-global variable, which
+encourages spaghetti code that's difficult to understand and to debug.
+
+Instead, have controller methods add variables to the :py:data:`extra_vars`
+parameter of :py:func:`~ckan.lib.base.render`, or have the templates
+call
:doc:`template helper functions ` instead.
+
+:py:data:`extra_vars` has the advantage that it allows templates, which are
+difficult to debug, to be simpler and shifts logic into the easier-to-test and
+easier-to-debug Python code. On the other hand, template helper functions are
+easier to reuse as they're available to all templates and they avoid
+inconsistencies between the namespaces of templates that are rendered by
+different controllers (e.g. one controller method passes the package dict as an
+extra var named ``package``, another controller method passes the same thing
+but calls it ``pkg``, a third calls it ``pkg_dict``).
+
You can use the :py:class:`~ckan.plugins.interfaces.ITemplateHelpers` plugin
interface to add custom helper functions, see
:ref:`custom template helper functions`.
diff --git a/doc/theming/static-files.rst b/doc/theming/static-files.rst
index 271ebd1d8ac..9ce61a7ea38 100644
--- a/doc/theming/static-files.rst
+++ b/doc/theming/static-files.rst
@@ -25,8 +25,10 @@ First, create a ``public`` directory in your extension with a
``promoted-image.jpg`` file in it::
ckanext-example_theme/
- public/
- promoted-image.jpg
+ ckanext/
+ example_theme/
+ public/
+ promoted-image.jpg
``promoted-image.jpg`` should be a 420x220px JPEG image file. You could use
this image file for example:
diff --git a/doc/user-guide.rst b/doc/user-guide.rst
index a51180f15ec..997b28e6e62 100644
--- a/doc/user-guide.rst
+++ b/doc/user-guide.rst
@@ -239,9 +239,6 @@ select "Next: Additional Info".
talk to your site administrator about changing the default schema and dataset
forms.
-* *Group* -- Moderated collection of datasets. You can add the dataset to
- an existing group here.
-
.. image:: /images/add_dataset_3.jpg
.. note::
@@ -250,6 +247,11 @@ select "Next: Additional Info".
"Visibility" is set correctly. It is also good practice to ensure an Author is
named.
+.. versionchanged:: 2.2
+ Previous versions of CKAN used to allow adding the dataset to existing
+ groups in this step. This was changed. To add a dataset to an existing group
+ now, go to the "Group" tab in the Dataset's page.
+
**Step 8**. Select the 'Finish' button. CKAN creates the dataset and shows you
the result. You have finished!
diff --git a/setup.py b/setup.py
index 21eb8a92fd8..f2047cff5ea 100644
--- a/setup.py
+++ b/setup.py
@@ -79,6 +79,10 @@
'recline_map=ckanext.reclinepreview.plugin:ReclineMap',
'example_itemplatehelpers = ckanext.example_itemplatehelpers.plugin:ExampleITemplateHelpersPlugin',
'example_idatasetform = ckanext.example_idatasetform.plugin:ExampleIDatasetFormPlugin',
+ 'example_idatasetform_v1 = ckanext.example_idatasetform.plugin_v1:ExampleIDatasetFormPlugin',
+ 'example_idatasetform_v2 = ckanext.example_idatasetform.plugin_v2:ExampleIDatasetFormPlugin',
+ 'example_idatasetform_v3 = ckanext.example_idatasetform.plugin_v3:ExampleIDatasetFormPlugin',
+ 'example_idatasetform_v4 = ckanext.example_idatasetform.plugin_v4:ExampleIDatasetFormPlugin',
'example_iauthfunctions_v1 = ckanext.example_iauthfunctions.plugin_v1:ExampleIAuthFunctionsPlugin',
'example_iauthfunctions_v2 = ckanext.example_iauthfunctions.plugin_v2:ExampleIAuthFunctionsPlugin',
'example_iauthfunctions_v3 = ckanext.example_iauthfunctions.plugin_v3:ExampleIAuthFunctionsPlugin',