Fixes for A11y metadata #208
+74
−34
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -205,7 +205,7 @@ func (m MetadataParser) parseMetaElement(element *xmlquery.Node) *MetadataItem { | ||
| id: element.SelectAttr("id"), | ||
| } | ||
| } else { | ||
| propName := strings.TrimSpace(property) | ||
| if propName == "" { | ||
| return nil | ||
| } | ||
| @@ -238,7 +238,7 @@ func (m MetadataParser) parseDcElement(element *xmlquery.Node) *MetadataItem { | ||
| } | ||
|
|
||
| data := strings.ToLower(element.Data) | ||
| propName := VocabularyDCTerms + element.Data | ||
| switch data { | ||
| case "creator": | ||
| fallthrough | ||
| @@ -403,13 +403,18 @@ func (m metadataAdapter) FirstValue(property string) string { | ||
| return item.value | ||
| } | ||
|
|
||
| func itemsValues(items []MetadataItem) []string { | ||
| values := make([]string, len(items)) | ||
| for i, item := range items { | ||
| values[i] = item.value | ||
| } | ||
| return values | ||
| } | ||
|
|
||
| func (m metadataAdapter) Values(property string) []string { | ||
| var values []string | ||
| if items, ok := m.items[property]; ok { | ||
| values = itemsValues(items) | ||
| } | ||
| return values | ||
| } | ||
| @@ -640,18 +645,38 @@ func (m PubMetadataAdapter) LocalizedSortAs() *manifest.LocalizedString { | ||
|
|
||
| func (m PubMetadataAdapter) Accessibility() *manifest.A11y { | ||
| a11y := manifest.NewA11y() | ||
| ct, refinedA11y := m.a11yConformsTo() | ||
| a11y.ConformsTo = ct | ||
|
|
||
| certifierItem, _ := m.First(VocabularyA11Y + "certifiedBy") | ||
| a11y.Certification = m.a11yCertification(certifierItem) | ||
|
|
||
| a11y.Summary = m.FirstValue(VocabularySchema + "accessibilitySummary") | ||
|
|
||
| modeValues := m.Values(VocabularySchema + "accessMode") | ||
| a11y.AccessModes = valuesToAccessModes(modeValues) | ||
|
|
||
| sufficientValues := m.Values(VocabularySchema + "accessModeSufficient") | ||
| a11y.AccessModesSufficient = valuesToAccessModesSufficient(sufficientValues) | ||
|
|
||
| featureValues := m.Values(VocabularySchema + "accessibilityFeature") | ||
| a11y.Features = valuesToA11yFeatures(featureValues) | ||
|
|
||
| hazardValues := m.Values(VocabularySchema + "accessibilityHazard") | ||
| a11y.Hazards = valuesToA11yHazards(hazardValues) | ||
|
|
||
| exemptionValues := m.Values(VocabularyA11Y + "exemption") | ||
| a11y.Exemptions = valuesToA11yExemptions(exemptionValues) | ||
|
|
||
| if a11y.IsEmpty() { | ||
| return nil | ||
| } | ||
|
|
||
| // ConformsTo refinements merge with the main a11y data | ||
| if !refinedA11y.IsEmpty() { | ||
| a11y.Merge(&refinedA11y) | ||
| } | ||
|
|
||
| return &a11y | ||
| } | ||
|
|
||
| @@ -674,13 +699,32 @@ func (m PubMetadataAdapter) TDM() *manifest.TDM { | ||
| return tdm | ||
| } | ||
|
|
||
| func (m PubMetadataAdapter) a11yConformsTo() ([]manifest.A11yProfile, manifest.A11y) { | ||
| profiles := manifest.A11yProfileList{} | ||
| a11y := manifest.NewA11y() | ||
|
|
||
| if items, ok := m.items[VocabularyDCTerms+"conformsTo"]; ok { | ||
| for _, item := range items { | ||
| if profile := a11yProfile(item.value); profile != "" { | ||
| profiles = append(profiles, profile) | ||
| for k, v := range item.children { | ||
|
There was a problem hiding this comment. Do I read correctly that the refined metadata of the last There was a problem hiding this comment. I'm not sure I'm following that one since There was a problem hiding this comment. If I understand the code correctly this will parse the a11y metadata that are refining each @chocolatkey Do you have an OPF example that this is supposed to parse? There was a problem hiding this comment. This is the example that we were using: https://github.com/standardebooks/nathaniel-hawthorne_the-house-of-the-seven-gables/blob/master/src/epub/content.opf#L19 There was a problem hiding this comment. Ha I see, in that case my initial question stands. We can have several conformances with different IDs and their own refinements. <meta id="conformance-statement" property="dcterms:conformsTo">EPUB Accessibility 1.1 - WCAG 2.2 Level AA</meta>There was a problem hiding this comment. Then it's probably a limitation of our model because the I'm hesitant to shake things up though, because it seems quite unlikely that you'd get certified multiple times (in most countries, there won't be a certification process at all). |
||
| switch k { | ||
| case VocabularyA11Y + "certifiedBy": | ||
| a11y.Certification = m.a11yCertification(v[0]) | ||
| case VocabularySchema + "accessibilitySummary": | ||
| a11y.Summary = v[0].value | ||
| case VocabularySchema + "accessMode": | ||
| a11y.AccessModes = valuesToAccessModes(itemsValues(v)) | ||
| case VocabularySchema + "accessModeSufficient": | ||
| a11y.AccessModesSufficient = valuesToAccessModesSufficient(itemsValues(v)) | ||
| case VocabularySchema + "accessibilityFeature": | ||
| a11y.Features = valuesToA11yFeatures(itemsValues(v)) | ||
| case VocabularySchema + "accessibilityHazard": | ||
| a11y.Hazards = valuesToA11yHazards(itemsValues(v)) | ||
| case VocabularyA11Y + "exemption": | ||
| a11y.Exemptions = valuesToA11yExemptions(itemsValues(v)) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| @@ -692,7 +736,7 @@ func (m PubMetadataAdapter) a11yConformsTo() []manifest.A11yProfile { | ||
| } | ||
|
|
||
| profiles.Sort() | ||
| return profiles, a11y | ||
| } | ||
|
|
||
| func a11yProfile(value string) manifest.A11yProfile { | ||
| @@ -726,13 +770,18 @@ func a11yProfile(value string) manifest.A11yProfile { | ||
| return manifest.EPUBA11y11WCAG21AA | ||
| case "EPUB Accessibility 1.1 - WCAG 2.1 Level AAA": | ||
| return manifest.EPUBA11y11WCAG21AAA | ||
| case "EPUB Accessibility 1.1 - WCAG 2.2 Level A": | ||
| return manifest.EPUBA11y11WCAG22A | ||
| case "EPUB Accessibility 1.1 - WCAG 2.2 Level AA": | ||
| return manifest.EPUBA11y11WCAG22AA | ||
| case "EPUB Accessibility 1.1 - WCAG 2.2 Level AAA": | ||
| return manifest.EPUBA11y11WCAG22AAA | ||
| default: | ||
| return "" | ||
| } | ||
| } | ||
|
|
||
| func (m PubMetadataAdapter) a11yCertification(certifierItem MetadataItem) *manifest.A11yCertification { | ||
| c := manifest.A11yCertification{ | ||
| CertifiedBy: certifierItem.value, | ||
| } | ||
| @@ -760,21 +809,15 @@ func (m PubMetadataAdapter) a11yCertification() *manifest.A11yCertification { | ||
| return &c | ||
| } | ||
|
|
||
| func valuesToAccessModes(values []string) []manifest.A11yAccessMode { | ||
| am := make([]manifest.A11yAccessMode, len(values)) | ||
| for i, v := range values { | ||
| am[i] = manifest.A11yAccessMode(v) | ||
| } | ||
| return am | ||
| } | ||
|
|
||
| func valuesToAccessModesSufficient(values []string) [][]manifest.A11yPrimaryAccessMode { | ||
| ams := make([][]manifest.A11yPrimaryAccessMode, 0, len(values)) | ||
| for _, v := range values { | ||
| c := a11yAccessModesSufficient(v) | ||
| @@ -797,26 +840,23 @@ func a11yAccessModesSufficient(value string) []manifest.A11yPrimaryAccessMode { | ||
| return ams | ||
| } | ||
|
|
||
| func valuesToA11yFeatures(values []string) []manifest.A11yFeature { | ||
| features := make([]manifest.A11yFeature, len(values)) | ||
| for i, v := range values { | ||
| features[i] = manifest.A11yFeature(v) | ||
| } | ||
| return features | ||
| } | ||
|
|
||
| func valuesToA11yHazards(values []string) []manifest.A11yHazard { | ||
| hazards := make([]manifest.A11yHazard, len(values)) | ||
| for i, v := range values { | ||
| hazards[i] = manifest.A11yHazard(v) | ||
| } | ||
| return hazards | ||
| } | ||
|
|
||
| func valuesToA11yExemptions(values []string) []manifest.A11yExemption { | ||
| exemptions := make([]manifest.A11yExemption, len(values)) | ||
| for i, v := range values { | ||
| exemptions[i] = manifest.A11yExemption(v) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you be able to add test cases for this new logic with the refined metadata? https://github.com/readium/go-toolkit/blob/develop/pkg/parser/epub/metadata_test.go