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

REFACT: Structure types and more #10

Closed
wants to merge 6 commits into from
Closed

Conversation

carlwilson
Copy link
Member

  • created new module for API model types eark_validator.model that contains types for:
    • Level (requirements level);
    • PackageDetails;
    • Severity (of test result);
    • StructResults (for structural validation results);
    • StructStatus (for structural validation status);
    • TestResult (for validation test results); and
    • ValidationReport (for final validation report);
  • refactored structural validation to use new types;
  • small fix to schematron test for CSIP11 in mets_metsHdr_rules.xml;
  • new eark_validator.packages module for package validation;
  • introduced a PackageHandler type to start abstraction of package parsing (replaces STRUCT.ArchivePackageHandler);
  • introduced a ValidationReport type to handle final aggregation of validation results;
  • added missing __init__.py files with appropriate commenting;
  • removed some defunct types;
  • removed unused imports;
  • introduced light use of pydantic, better use to come; and
  • unit test improvements and fixes.

- created new module for API model types `eark_validator.model` that contains types for:
  - `Level` (requirements level);
  - `PackageDetails`;
  - `Severity` (of test result);
  - `StructResults` (for structural validation results);
  - `StructStatus` (for structural validation status);
  - `TestResult` (for validation test results); and
  - `ValidationReport` (for final validation report);
- refactored structural validation to use new types;
- small fix to schematron test for `CSIP11` in `mets_metsHdr_rules.xml`;
- new `eark_validator.packages` module for package validation;
- introduced a `PackageHandler` type to start abstraction of package parsing (replaces `STRUCT.ArchivePackageHandler`);
- introduced a `ValidationReport` type to handle final aggregation of validation results;
- added missing `__init__.py` files with appropriate commenting;
- removed some defunct types;
- removed unused imports;
- introduced light use of pydantic, better use to come; and
- unit test improvements and fixes.
@carlwilson carlwilson self-assigned this Jan 9, 2024
@carlwilson carlwilson added the enhancement New feature or request label Jan 9, 2024
@darrendignam
Copy link
Collaborator

All checks passed.

Copy link
Collaborator

@darrendignam darrendignam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of good progress here. Checks passed.

@carlwilson carlwilson closed this Feb 16, 2024
@carlwilson carlwilson reopened this Feb 22, 2024
@carlwilson carlwilson closed this Feb 22, 2024
@carlwilson carlwilson deleted the feat/struct-types branch February 22, 2024 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

2 participants