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

feat: no longer check collection role #1427

Merged
merged 2 commits into from
Dec 6, 2022
Merged

Conversation

rdeltour
Copy link
Member

@rdeltour rdeltour commented Dec 5, 2022

This PR suppresses and removes the code of the following checks:

  • OPF-068: checked that a role token were one the defined roles in
    the collection role registry
    (see https://idpf.github.io/epub-registries/roles/)
  • OPF-069: checked that a custom role URL did not contain the string
    "idpf.org".

These restrictions were removed in EPUB 3.3.

The attribute value is still tokenized, and any URL-looking string
(in the shape scheme:something) is checked to be a valid URL string.

Fix #1350.

This commit suppresses and removes the code of the following checks:
- `OPF-068`: checked that a role token were one the defined roles in
  the collection role registry
  (see https://idpf.github.io/epub-registries/roles/)
- `OPF-069`: checked that a custom role URL did not contain the string
  "idpf.org".

These restrictions were removed in EPUB 3.3.

The attribute value is still tokenized, and any URL-looking string
  (in the shape `scheme:something`) is checked to be a valid URL string.

Fix #1350.
@rdeltour rdeltour added this to the v5.0.0-beta milestone Dec 5, 2022
@rdeltour rdeltour requested a review from mattgarrish December 5, 2022 09:59
@rdeltour rdeltour self-assigned this Dec 5, 2022
Copy link
Member

@mattgarrish mattgarrish left a comment

Choose a reason for hiding this comment

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

The comments in the test file are a bit misleading - nothing has changed about how collection roles are validated between 3.2 and 3.3. You don't have to maintain the 3.2 rules anymore as no one uses these anyway, but it's more that collections are being abandoned without deprecating than anything about them has changed.

Base automatically changed from feat/epubtype-restrictions to release/v5.0.0 December 6, 2022 14:42
@rdeltour rdeltour merged commit 8eb8492 into release/v5.0.0 Dec 6, 2022
@rdeltour rdeltour deleted the feat/collection-role branch December 6, 2022 14:43
@rdeltour
Copy link
Member Author

rdeltour commented Dec 6, 2022

Right. I clarified the comments in #1447

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants