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

Update to use EPUB 5.1.0 #892

Merged

Conversation

karenhanson
Copy link
Contributor

This change updates the EPUB module to use the latest EPUBCheck version 5.1.0. Biggest thing to note is that CREATION_DATE is currently missing from the report due to a bug, but will return in the future when fixed. I wasn't sure if that was significant enough to hold back this PR any longer since other things are fixed in this version. For example, we have seen this issue at Portico and it is fixed in the latest version.

Changes made include:

  1. EPUB is now managed by W3C. The latest release is still in conjunction with IDPF, so for now they continue to be included in the agent name. Next iteration might require that we switch the agent information to W3C only.
  2. As mentioned, CREATION_DATE is currently missing from the report, I've logged an issue and commented out the relevant lines in tests that are now failing. It will be fixed in the next maintenance release and I will move to 5.1.1 when available to add creation date back in. I'm not sure if this will happen before or after the next JHOVE release, I'm keeping an eye out for an update.
  3. The new version lists resources with fragments making the resource list much longer without reflecting new files in the package. Added logic to remove resources with fragments and only list base URL.
  4. EPUBLocation changed slightly, updated code to support that change.
  5. Some redundant messages were removed, which changed some message counts in tests - fixed message counts to reflect correct output.
  6. Update validation version to 3.3 - there is no way to determine the minor version number in an EPUB, so validation is always against whatever the latest is.
  7. A file that was being used to test title has flipped from Well Formed and Valid to Well Formed and Not Valid according to current criteria - updated the test to reflect this.

This closes issue #857

karenhanson and others added 4 commits June 12, 2023 17:50
EPUB now managed by W3C. Latest release is still in conjunction with IDPF, so for now they continue to be included in the agent name. Next iteration might switch to W3C only.
The following changes were made to support EPUBCheck 5.1.0:
1. New version lists resources with fragments making resource list much longer without reflecting new files in the package. Added logic to remove resources with fragments and only list base URL.
2. EPUBLocation changed slightly, updated code to manage support that change.
3. Some redundant messages were removed, which changed some message counts in tests - fixed message counts to reflect correct output.
4. Update validation version to 3.3 - there is no way to determine the minor version number in an EPUB, so validation is always against whatever the latest is.
5. CREATION_DATE is missing from the report, I've logged an issue and commented out the relevant lines in tests. It will be fixed in the next maintenance release and I will move to 5.1.1 when available to add creation date back in.
6. A file that was being used to test title has flipped from Well Formed and Valid to Well Formed and Not Valid according to current criteria - updated the test to reflect this.
@carlwilson carlwilson merged commit d7693a1 into openpreserve:integration Mar 4, 2024
3 of 4 checks passed
@carlwilson carlwilson added this to the JHOVE 1.30 milestone Mar 6, 2024
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