[ckan-changes] [okfn/ckan] 9a56e8: [#2750] Add ckanext/example_idatasetform

Wed Mar 20 09:51:05 UTC 2013

  Branch: refs/heads/617-source-install-doc
  Home:   https://github.com/okfn/ckan
  Commit: 9a56e8e6f5b53b2e2b0e8a7fe2842e2716700319
      https://github.com/okfn/ckan/commit/9a56e8e6f5b53b2e2b0e8a7fe2842e2716700319
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-11 (Mon, 11 Mar 2013)

  Changed paths:
    A ckanext/example_idatasetform/__init__.py
    A ckanext/example_idatasetform/plugin.py
    A ckanext/example_idatasetform/templates/package/new_package_metadata.html
    A ckanext/example_idatasetform/templates/package/read.html
    A ckanext/example_idatasetform/templates/package/snippets/package_form.html
    A ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html
    A ckanext/example_idatasetform/templates/package/snippets/package_metadata_form.html
    M setup.py

  Log Message:
  -----------
  [#2750] Add ckanext/example_idatasetform

  Commit: 5f21ec9596af67c1dd9282d3b9628fd642d0bce8
      https://github.com/okfn/ckan/commit/5f21ec9596af67c1dd9282d3b9628fd642d0bce8
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-11 (Mon, 11 Mar 2013)

  Changed paths:
    M ckan/lib/plugins.py
    M ckan/plugins/interfaces.py
    M doc/conf.py

  Log Message:
  -----------
  [#2750] Improve IDatasetForm docstrings

- Rewrite the IDatasetForm docstrings to make them clearer,
  and conform to PEP257
- Reorder methods in IDatasetForm and DefaultDatasetForm
  so that they're 1. in a more logical order and 2. in the
  same order as eachother
- Tell autodoc to put the methods in source-code order,
  not alphabetical, in the sphinx docs
- Remove docstrings from DefaultDatasetForm that are
  exact repeats of corresponding docstrings in IDatasetForm
- Add edit_template() to IDatasetForm, it was missing

db_to_form_schema_options() and form_to_db_schema_options() and some
other schema methods in DefaultDatasetForm are still missing from
IDatasetForm but I'm leaving it that way for now, consider them
unofficial.

  Commit: 8e0604217112ed7a95856cea723d2f551aac6341
      https://github.com/okfn/ckan/commit/8e0604217112ed7a95856cea723d2f551aac6341
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-11 (Mon, 11 Mar 2013)

  Changed paths:
    R doc/forms.rst
    M doc/index.rst

  Log Message:
  -----------
  [#2750] Delete 'Customizing Forms' docs

They are out of date, and we have ckanext/example_idatasetform instead
now.

  Commit: bd44895179ef576ba624c64c88453e269461d26d
      https://github.com/okfn/ckan/commit/bd44895179ef576ba624c64c88453e269461d26d
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-11 (Mon, 11 Mar 2013)

  Changed paths:
    M doc/tag-vocabularies.rst

  Log Message:
  -----------
  [#2750] Rewrite tag vocabularies docs

Change the tag vocabularies docs to refer to the working example in
ckanext/example_idatasetform instead of providing their own detailed
instructions.

Also add some more general explanation at the start about what tag
vocabularies are for/why you might want to use them/what you can do with
them, it was all a bit mysterious.

Remove some false claims from the Properties section, I don't think that
the restricted/free vocabulary types are implemented (they are either
always restricted or always free, can't remember), vocabularies do not
have descriptions.

  Commit: ff05a0abf795c623660d4c77f0bc124a0905ac17
      https://github.com/okfn/ckan/commit/ff05a0abf795c623660d4c77f0bc124a0905ac17
  Author: tobes <toby.junk at gmail.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    M ckan/controllers/group.py
    M ckan/controllers/package.py
    M ckan/new_authz.py

  Log Message:
  -----------
  [#638] Clean up some imports and remove OrderedDict redefine

  Commit: b2930026c5af646ffcf97a886714d5fab5dc6285
      https://github.com/okfn/ckan/commit/b2930026c5af646ffcf97a886714d5fab5dc6285
  Author: tobes <toby.junk at gmail.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    M ckan/controllers/package.py

  Log Message:
  -----------
  [#638] Use correct function

  Commit: 00c2898c804399608e38f970e12f53db5767e77c
      https://github.com/okfn/ckan/commit/00c2898c804399608e38f970e12f53db5767e77c
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    M ckan/controllers/package.py
    M ckan/lib/plugins.py
    M ckan/logic/action/create.py
    M ckan/logic/action/update.py
    M ckan/plugins/interfaces.py
    M ckan/tests/functional/test_package.py
    M ckanext/example_idatasetform/plugin.py

  Log Message:
  -----------
  [#602] Deprecate IDatasetForm's check_data_dict

With the new three-stage dataset creation form in CKAN 2.0
check_data_dict() no longer works as intended. For example,
DefaultDatasetForm's check_data_dict() breaks any IDatasetForm plugins
that are trying to use convert_to_extras() (if they inherit from
DefaultDatasetForm).

Remove the method from IDatasetForm and DefaultDatasetForm, but still
call the method in all the places it would previously have been called
_if_ the active IDatasetForm plugin has the method.

Also remove three tests that seem to be testing check_data_dict()'s
behaviours.

Note that in the existing code, check_data_dict() seems to be called
twice when creating a package, once by the package controller and once
by package_create(), and the two are inconsistent in the number of
params they expect check_data_dict() to take! On updating a package it's
called just once, by package_update(). I have preserved these "legacy"
behaviours.

Also note that IGroupForm and IOrganizationForm still have
check_data_dict() methods, we probably want to get rid of them in the
future as well.

  Commit: 119800723cbdd865674ecaf38e31a9c1dc24bd70
      https://github.com/okfn/ckan/commit/119800723cbdd865674ecaf38e31a9c1dc24bd70
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    A ckan/common.py
    M ckan/controllers/feed.py
    M ckan/controllers/group.py
    M ckan/controllers/package.py
    M ckan/lib/base.py
    M ckan/lib/dumper.py
    M ckan/lib/field_types.py
    M ckan/lib/helpers.py
    M ckan/lib/jsonp.py
    M ckan/lib/mailer.py
    M ckan/lib/repoze_patch.py
    M ckan/lib/search/index.py
    M ckan/lib/search/query.py
    M ckan/logic/action/create.py
    M ckan/logic/action/get.py
    M ckan/logic/action/update.py
    M ckan/logic/schema.py
    M ckan/logic/validators.py
    M ckan/migration/versions/022_add_group_extras.py
    M ckan/migration/versions/029_version_groups.py
    M ckan/plugins/interfaces.py
    M ckan/public/base/css/main.css
    M ckan/public/base/less/dataset.less
    M ckan/public/base/less/forms.less
    M ckan/templates/ajax_snippets/api_info.html
    M ckan/templates/organization/bulk_process.html
    M ckan/templates/package/search.html
    M ckan/templates/snippets/simple_search.html
    M ckan/tests/__init__.py
    M ckan/tests/functional/api/base.py
    M ckan/tests/functional/api/model/test_vocabulary.py
    M ckan/tests/functional/api/test_activity.py
    M ckan/tests/functional/api/test_dashboard.py
    M ckan/tests/functional/api/test_util.py
    M ckan/tests/functional/test_search.py
    M ckan/tests/lib/test_cli.py
    M ckan/tests/lib/test_dictization_schema.py
    M ckan/tests/lib/test_solr_search_index.py
    M ckan/tests/logic/test_action.py
    M ckan/tests/misc/test_sync.py
    M ckan/tests/test_dumper.py
    R doc/api-tutorial.rst
    R doc/api-util.rst
    R doc/api-v2.rst
    M doc/api.rst
    R doc/apiv3.rst
    M doc/architecture.rst
    A doc/ckan.logic.action.create.rst
    A doc/ckan.logic.action.delete.rst
    A doc/ckan.logic.action.get.rst
    A doc/ckan.logic.action.update.rst
    M doc/conf.py
    M doc/datastore-api.rst
    A doc/filestore-api.rst
    M doc/filestore.rst
    M doc/index.rst
    M doc/install-from-source.rst
    A doc/legacy-api.rst
    M doc/loading-data.rst
    M doc/multilingual.rst
    M doc/python-coding-standards.rst
    M pip-requirements.txt

  Log Message:
  -----------
  Merge branch 'master' of github.com:okfn/ckan into example_idatasetform_without_tests_second_try

Conflicts:
	doc/tag-vocabularies.rst

  Commit: 0221455e6f1caede611881d155acfc7d5eb69815
      https://github.com/okfn/ckan/commit/0221455e6f1caede611881d155acfc7d5eb69815
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    M ckan/plugins/toolkit.py
    M ckanext/example_idatasetform/plugin.py

  Log Message:
  -----------
  [#2750] Add DefaultDatasetForm to plugins toolkit

At DefaultDatasetForm to the plugins toolkit. This means that
IDatasetForm plugins based on DefaultDatasetForm no longer need to
import ckan.lib.plugins.

Also change ExampleIDatasetForm to no longer import ckan.lib.plugins.

  Commit: 4d455686b57bf94e7bb81dbd916f2b43b09cfbe7
      https://github.com/okfn/ckan/commit/4d455686b57bf94e7bb81dbd916f2b43b09cfbe7
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    M ckanext/example_idatasetform/plugin.py
    R ckanext/example_idatasetform/templates/package/new_package_metadata.html
    R ckanext/example_idatasetform/templates/package/snippets/package_form.html
    M ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html
    R ckanext/example_idatasetform/templates/package/snippets/package_metadata_form.html

  Log Message:
  -----------
  [#2750] Use ITemplateHelpers not setup_template_variables()

In ExampleIDatasetForm use ITemplateHelpers not
setup_template_variables() to pass the list of available country codes
to the template. This greatly reduces the number of templates that need
to be overridden!

  Commit: dbc15266b966e0eac091d24b08787e9203dc2873
      https://github.com/okfn/ckan/commit/dbc15266b966e0eac091d24b08787e9203dc2873
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    M ckanext/example_idatasetform/plugin.py

  Log Message:
  -----------
  [#2750] Move create_country_codes() to a better place

Move example_idatasetform's create_country_codes() to a better place.

  Commit: 9fc9c0fd5855e620c99ac7c2835a1d6afd76c985
      https://github.com/okfn/ckan/commit/9fc9c0fd5855e620c99ac7c2835a1d6afd76c985
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    M ckanext/example_idatasetform/plugin.py

  Log Message:
  -----------
  [#2750] Add setup_template_variables() back

Add setup_template_variables() back into ExampleIDatasetFormPlugin, just
counts how many times it gets called, for testing purposes.

  Commit: d7ca27fddad1506829bca620780d464a87850317
      https://github.com/okfn/ckan/commit/d7ca27fddad1506829bca620780d464a87850317
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    M ckanext/example_idatasetform/plugin.py

  Log Message:
  -----------
  [#2750] Use super()

Seems like the right thing to do

  Commit: fb09c310a595f65dbde922acfc875d1ed1cb48d8
      https://github.com/okfn/ckan/commit/fb09c310a595f65dbde922acfc875d1ed1cb48d8
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-15 (Fri, 15 Mar 2013)

  Changed paths:
    M ckanext/example_idatasetform/templates/package/read.html

  Log Message:
  -----------
  [#2750] Change an HTML comment into a Jinja comment

  Commit: 71119013dc7f78c471fbe6305457eafdc6276e55
      https://github.com/okfn/ckan/commit/71119013dc7f78c471fbe6305457eafdc6276e55
  Author: John Martin <me at johnmart.in>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckan/templates/package/snippets/package_metadata_fields.html
    M ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html

  Log Message:
  -----------
  [#2750] Tweaks base package_metadata_fields.html and then {% ckan_extends %} from it.

  Commit: 7ab3d44eb788331d623c57994f47de083cf6f3a0
      https://github.com/okfn/ckan/commit/7ab3d44eb788331d623c57994f47de083cf6f3a0
  Author: John Martin <me at johnmart.in>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html

  Log Message:
  -----------
  [#2750] Simplify the template yet more

  Commit: 41684e58e917bdc710beea07b895b795addb1a53
      https://github.com/okfn/ckan/commit/41684e58e917bdc710beea07b895b795addb1a53
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html

  Log Message:
  -----------
  [#2750] Add custom_text_field back into example idatasetform templates

This field accidentally got removed from the templates in a previous
commit

  Commit: 4483c53137a5099bcbdc7e701e92a2e2f236c9fd
      https://github.com/okfn/ckan/commit/4483c53137a5099bcbdc7e701e92a2e2f236c9fd
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html

  Log Message:
  -----------
  [#2750] Remove 'free extras' from package form in example idatasetform

This is necessary to make convert_to/from_extras() work

  Commit: 307c89efc1cab1674eea2eb503627ccf7f1e6a0f
      https://github.com/okfn/ckan/commit/307c89efc1cab1674eea2eb503627ccf7f1e6a0f
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckan/controllers/group.py
    M ckan/lib/app_globals.py
    M ckan/lib/dictization/model_dictize.py
    M ckan/lib/search/index.py
    M ckan/logic/action/get.py
    M ckan/logic/auth/create.py
    M ckan/logic/auth/update.py
    M ckan/public/base/less/module.less
    M ckan/templates/organization/bulk_process.html
    M ckan/templates/organization/members.html

  Log Message:
  -----------
  Merge branch 'master' of github.com:okfn/ckan into example_idatasetform_without_tests_second_try

  Commit: dce07c1de1b02a243b299e241f99fb4eb7faf231
      https://github.com/okfn/ckan/commit/dce07c1de1b02a243b299e241f99fb4eb7faf231
  Author: John Glover <j at johnglover.net>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckan/controllers/group.py

  Log Message:
  -----------
  [#638] PEP8

  Commit: 0716121287e699f085efab684146b4409e09887d
      https://github.com/okfn/ckan/commit/0716121287e699f085efab684146b4409e09887d
  Author: John Glover <j at johnglover.net>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckan/controllers/group.py
    M ckan/lib/app_globals.py
    M ckan/lib/dictization/model_dictize.py
    M ckan/lib/plugins.py
    M ckan/lib/search/index.py
    M ckan/logic/action/get.py
    M ckan/logic/auth/create.py
    M ckan/logic/auth/update.py
    M ckan/plugins/interfaces.py
    M ckan/public/base/less/module.less
    M ckan/templates/organization/bulk_process.html
    M ckan/templates/organization/members.html
    A ckanext/example_idatasetform/__init__.py
    A ckanext/example_idatasetform/plugin.py
    A ckanext/example_idatasetform/templates/package/new_package_metadata.html
    A ckanext/example_idatasetform/templates/package/read.html
    A ckanext/example_idatasetform/templates/package/snippets/package_form.html
    A ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html
    A ckanext/example_idatasetform/templates/package/snippets/package_metadata_form.html
    A ckanext/example_idatasetform/tests/test_example_idatasetform_plugin.py
    M doc/conf.py
    R doc/forms.rst
    M doc/index.rst
    M doc/tag-vocabularies.rst
    M setup.py

  Log Message:
  -----------
  Merge remote-tracking branch 'origin/master' into 638-code-clean

  Commit: fca50036635c8dfeffca8d7163b150b22efc1112
      https://github.com/okfn/ckan/commit/fca50036635c8dfeffca8d7163b150b22efc1112
  Author: John Glover <glover.john at gmail.com>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckan/controllers/group.py
    M ckan/controllers/package.py
    M ckan/new_authz.py

  Log Message:
  -----------
  Merge pull request #638 from okfn/638-code-clean

Minor code clean OrderedDict

  Commit: cfddd3c5ff2cb7cbc38ce0bb7453cbe39edd21e1
      https://github.com/okfn/ckan/commit/cfddd3c5ff2cb7cbc38ce0bb7453cbe39edd21e1
  Author: tobes <toby.junk at gmail.com>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckan/lib/plugins.py
    M ckan/plugins/interfaces.py
    R ckanext/example_idatasetform/__init__.py
    R ckanext/example_idatasetform/plugin.py
    R ckanext/example_idatasetform/templates/package/new_package_metadata.html
    R ckanext/example_idatasetform/templates/package/read.html
    R ckanext/example_idatasetform/templates/package/snippets/package_form.html
    R ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html
    R ckanext/example_idatasetform/templates/package/snippets/package_metadata_form.html
    R ckanext/example_idatasetform/tests/test_example_idatasetform_plugin.py
    M doc/conf.py
    A doc/forms.rst
    M doc/index.rst
    M doc/tag-vocabularies.rst
    M setup.py

  Log Message:
  -----------
  Revert "Merge branch 'example_idatasetform_without_tests'"

This reverts commit 0ce63eee311a371bfcda603a01da5657f9f6892e, reversing
changes made to 579ee38be17426d023d698bff8025c4f5849b824.

  Commit: 7f24242bbd2de9345d343c22bab6b84a125bedee
      https://github.com/okfn/ckan/commit/7f24242bbd2de9345d343c22bab6b84a125bedee
  Author: tobes <toby.junk at gmail.com>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckan/controllers/group.py
    M ckan/controllers/package.py
    M ckan/new_authz.py

  Log Message:
  -----------
  Merge branch 'master' of github.com:okfn/ckan

  Commit: 3efeda6fb0cd5a381d288d728e03a8a5ea988868
      https://github.com/okfn/ckan/commit/3efeda6fb0cd5a381d288d728e03a8a5ea988868
  Author: tobes <toby.junk at gmail.com>
  Date:   2013-03-19 (Tue, 19 Mar 2013)

  Changed paths:
    M ckan/controllers/package.py
    M ckan/lib/plugins.py
    M ckan/logic/action/create.py
    M ckan/logic/action/update.py
    M ckan/plugins/interfaces.py
    M ckan/plugins/toolkit.py
    M ckan/templates/package/snippets/package_metadata_fields.html
    M ckan/tests/functional/test_package.py
    A ckanext/example_idatasetform/__init__.py
    A ckanext/example_idatasetform/plugin.py
    A ckanext/example_idatasetform/templates/package/read.html
    A ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html
    M doc/conf.py
    R doc/forms.rst
    M doc/index.rst
    M doc/tag-vocabularies.rst
    M setup.py

  Log Message:
  -----------
  Merge branch 'example_idatasetform_without_tests_second_try'

  Commit: 01c9553834fa915fe2f232260748318a90fca74e
      https://github.com/okfn/ckan/commit/01c9553834fa915fe2f232260748318a90fca74e
  Author: tobes <toby.junk at gmail.com>
  Date:   2013-03-20 (Wed, 20 Mar 2013)

  Changed paths:
    M ckan/controllers/group.py
    M ckan/controllers/package.py
    M ckan/lib/plugins.py
    M ckan/logic/action/create.py
    M ckan/logic/action/update.py
    M ckan/new_authz.py
    M ckan/plugins/interfaces.py
    M ckan/plugins/toolkit.py
    M ckan/templates/package/snippets/package_metadata_fields.html
    M ckan/tests/functional/test_package.py
    M ckanext/example_idatasetform/plugin.py
    R ckanext/example_idatasetform/templates/package/new_package_metadata.html
    M ckanext/example_idatasetform/templates/package/read.html
    R ckanext/example_idatasetform/templates/package/snippets/package_form.html
    M ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html
    R ckanext/example_idatasetform/templates/package/snippets/package_metadata_form.html
    R ckanext/example_idatasetform/tests/test_example_idatasetform_plugin.py

  Log Message:
  -----------
  Merge branch 'master' into 617-source-install-doc

Compare: https://github.com/okfn/ckan/compare/ffdde52fffd6...01c9553834fa