Skip to content

Commit

Permalink
Rename series dataset type for better humanization support
Browse files Browse the repository at this point in the history
  • Loading branch information
amercader committed Jan 28, 2025
1 parent 343b867 commit 845fd19
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 10 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ Dataset Series can be ordered or unordered.

## How does it work?

This extension uses a custom dataset type (`dataset-series`) to define the parent series entities. These are
This extension uses a custom dataset type (`dataset_series`) to define the parent series entities. These are
just datasets and can have any of the standard dataset fields defined.

If the series is ordered, the only mandatory fields they need
are the following (shown in the [ckanext-scheming](https://github.com/ckan/ckanext-scheming) schema file definition):

```yaml
scheming_version: 2
dataset_type: dataset-series
dataset_type: dataset_series

dataset_fields:

Expand Down Expand Up @@ -113,7 +113,7 @@ Querying the series dataset will also return a `series_navigation` link if order
```json
{
"name": "test-dataset-series",
"type": "dataset-series",
"type": "dataset_series",
"series_navigation": {
"first": {
"id": "826bd499-40e5-4d92-bfa1-f777775f0d76",
Expand Down
4 changes: 3 additions & 1 deletion ckanext/dataset_series/actions.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@


log = logging.getLogger(__name__)


@toolkit.side_effect_free
@toolkit.chained_action
def package_show(up_func, context, data_dict):
Expand All @@ -17,7 +19,7 @@ def package_show(up_func, context, data_dict):
)

if not for_indexing:
if dataset_dict.get("type") == "dataset-series":
if dataset_dict.get("type") == "dataset_series":
dataset_dict = _add_series_navigation(dataset_dict)

elif dataset_dict.get("in_series"):
Expand Down
2 changes: 1 addition & 1 deletion ckanext/dataset_series/schemas/dataset_series.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
scheming_version: 2
dataset_type: dataset-series
dataset_type: dataset_series
about: A standard CKAN dataset schema with the Dataset Series fields
about_url: http://github.com/ckan/ckanext-dataset-series

Expand Down
2 changes: 1 addition & 1 deletion ckanext/dataset_series/schemas/dcat_ap_dataset_series.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
scheming_version: 2
dataset_type: dataset-series
dataset_type: dataset_series
about: A Dataset Series schema based on the DCAT AP v3 spec
about_url: http://github.com/ckan/ckanext-dataset-series

Expand Down
8 changes: 4 additions & 4 deletions ckanext/dataset_series/tests/test_action.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

@pytest.fixture
def series_fixtures():
dataset_series = factories.Dataset(type="dataset-series", series_order_field="name")
dataset_series = factories.Dataset(type="dataset_series", series_order_field="name")

dataset1 = factories.Dataset(
name="test-series-member-1", in_series=dataset_series["id"]
Expand Down Expand Up @@ -61,7 +61,7 @@ def test_series_navigation(series_fixtures):
)
def test_empty_series_navigation(series_fixtures):

dataset_series = factories.Dataset(type="dataset-series", series_order_field="name")
dataset_series = factories.Dataset(type="dataset_series", series_order_field="name")
series_dict = call_action("package_show", id=dataset_series["id"])

assert series_dict["series_navigation"]["count"] == 0
Expand Down Expand Up @@ -163,7 +163,7 @@ def test_series_last_dataset(series_fixtures):
)
def test_series_only_dataset():

dataset_series = factories.Dataset(type="dataset-series", series_order_field="name")
dataset_series = factories.Dataset(type="dataset_series", series_order_field="name")

dataset_only = factories.Dataset(
name="test-series-only-member", in_series=dataset_series["id"]
Expand All @@ -189,7 +189,7 @@ def test_series_only_dataset():
def test_series_date_field():

dataset_series = factories.Dataset(
type="dataset-series",
type="dataset_series",
series_order_field="metadata_created",
series_order_type="date",
)
Expand Down

0 comments on commit 845fd19

Please sign in to comment.