Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metastore code refactor for clearer naming and flow #3736

Open
dafeder opened this issue Jan 8, 2022 · 0 comments
Open

Metastore code refactor for clearer naming and flow #3736

dafeder opened this issue Jan 8, 2022 · 0 comments
Assignees

Comments

@dafeder
Copy link
Member

dafeder commented Jan 8, 2022

Proposal to tighten up the naming and typing conventions in the metastore module. Some changes are simply renaming or separating existing classes/methods, but others change the types being passed around. The current code is difficult to understand and maintain.

This assumes that the metastore module has been merged into the dkan module (see #3746).

Drupal\dkan\Metastore\Item

Classes and interfaces for defining Metastore item objects. These will be the primary metadata objects passed around the system.

Class Description
Drupal\dkan\Metastore\Item\MetastoreItemInterface Interface for a metastore item object
Drupal\dkan\Metastore\Item\MetastoreEntityItemInterface Extension interface for entity-based items
Drupal\dkan\Metastore\Item\MetastoreNodeItem Metastore item class based on a node.

Drupal\dkan\Metastore\Schema

Classes for defining, retrieving and validating against metastore schemas. Note that SchemaManager replaces the old SchemaRetriever service. Assumes completion of #3761.

Class Description
Drupal\dkan\Metastore\Schema\MetadataValidator Utility class for validating metadata against a schema in the system.
Drupal\dkan\Metastore\Schema\MetastoreSchema Schema plugin definition, for schemas that will be defined in YAML.
Drupal\dkan\Metastore\Schema\MetastoreSchemaInterface Interface for schema plugins.
Drupal\dkan\Metastore\Schema\SchemaManager Plugin manager to gather definitions and retrieve schemas.
@github-actions github-actions bot added this to Incoming/Triage in DKAN 2 Issue Triage Jan 8, 2022
@dafeder dafeder removed this from Incoming/Triage in DKAN 2 Issue Triage Jan 30, 2022
@dafeder dafeder added this to To-do in High-level roadmap Jan 30, 2022
@dafeder dafeder changed the title Metastore class rename/refactor Metastore code refactor for clearer naming and flow Aug 23, 2022
@dafeder dafeder self-assigned this Aug 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging a pull request may close this issue.

1 participant