Skip to content

Add optional CommunityRating element to v1.1 schema #85

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.

Sign up for GitHub

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

Merged
bpepple merged 1 commit into from
Jul 18, 2026
Merged

Add optional CommunityRating element to v1.1 schema #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions drafts/v1.1/MetronInfo.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
<xs:element name="Reprints" type="reprintsType" minOccurs="0" />
<xs:element name="GTIN" type="gtinType" minOccurs="0" />
<xs:element name="AgeRating" type="ageRatingType" minOccurs="0" default="Unknown" />
<xs:element name="CommunityRating" type="communityRatingType" minOccurs="0" />
<xs:element name="URLs" type="urlsType" minOccurs="0" />
<xs:element name="Credits" type="creditsType" minOccurs="0" />
<xs:element name="LastModified" type="xs:dateTime" minOccurs="0" />
Expand Down Expand Up @@ -232,6 +233,13 @@
</xs:all>
</xs:complexType>

<xs:complexType name="communityRatingType">
<xs:all>
<xs:element name="AverageRating" type="averageRatingType" />
<xs:element name="RatingCount" type="xs:positiveInteger" minOccurs="0" />
</xs:all>
</xs:complexType>

<!-- Simple Types -->
<xs:simpleType name="formatType">
<xs:restriction base="xs:string">
Expand Down Expand Up @@ -326,6 +334,13 @@
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="averageRatingType">
<xs:restriction base="xs:decimal">
<xs:minInclusive value="0" />
<xs:maxInclusive value="5.0" />
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="countryCode">
<xs:restriction base="xs:string">
<xs:pattern value="[A-Z][A-Z]" />
Expand Down
4 changes: 4 additions & 0 deletions drafts/v1.1/Sample.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@
<UPC>76194130593600111</UPC>
</GTIN>
<AgeRating>Everyone</AgeRating>
<CommunityRating>
<AverageRating>4.5</AverageRating>
<RatingCount>1250</RatingCount>
</CommunityRating>
<Reprints>
<Reprint id="65498">Foo Bar #001 (2002)</Reprint>
<Reprint>Foo Bar #002 (2022)</Reprint>
Expand Down
56 changes: 56 additions & 0 deletions tests/test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,27 @@
'<?xml version="1.0" encoding="UTF-8"?><MetronInfo>'
"<Series><Name>Foo</Name></Series><Number>1</Number><PageCount>0</PageCount></MetronInfo>",
),
(
TEST_V11_XSD,
'<?xml version="1.0" encoding="UTF-8"?><MetronInfo>'
"<Series><Name>Foo</Name></Series><Number />"
"<CommunityRating><AverageRating>4.5</AverageRating><RatingCount>1250</RatingCount></CommunityRating>"
"</MetronInfo>",
),
(
TEST_V11_XSD,
'<?xml version="1.0" encoding="UTF-8"?><MetronInfo>'
"<Series><Name>Foo</Name></Series><Number />"
"<CommunityRating><AverageRating>0</AverageRating></CommunityRating>"
"</MetronInfo>",
),
(
TEST_V11_XSD,
'<?xml version="1.0" encoding="UTF-8"?><MetronInfo>'
"<Series><Name>Foo</Name></Series><Number />"
"<CommunityRating><AverageRating>5.0</AverageRating></CommunityRating>"
"</MetronInfo>",
),
],
ids=[
"valid_xml",
Expand All @@ -54,6 +75,9 @@
"v11_volume_zero",
"v11_alternative_number",
"v11_alternative_number_absent",
"v11_community_rating",
"v11_community_rating_min",
"v11_community_rating_max",
],
)
def test_valid(xsd: Path, xml: Path | str) -> None:
Expand Down Expand Up @@ -92,6 +116,34 @@ def test_valid(xsd: Path, xml: Path | str) -> None:
"<Series><Name>Foo</Name></Series><Number>1</Number>"
"<AlternativeNumber>1A</AlternativeNumber><AlternativeNumber>1B</AlternativeNumber></MetronInfo>",
),
(
TEST_V11_XSD,
'<?xml version="1.0" encoding="UTF-8"?><MetronInfo>'
"<Series><Name>Foo</Name></Series><Number />"
"<CommunityRating><AverageRating>5.1</AverageRating></CommunityRating>"
"</MetronInfo>",
),
(
TEST_V11_XSD,
'<?xml version="1.0" encoding="UTF-8"?><MetronInfo>'
"<Series><Name>Foo</Name></Series><Number />"
"<CommunityRating><AverageRating>-0.1</AverageRating></CommunityRating>"
"</MetronInfo>",
),
(
TEST_V11_XSD,
'<?xml version="1.0" encoding="UTF-8"?><MetronInfo>'
"<Series><Name>Foo</Name></Series><Number />"
"<CommunityRating><RatingCount>100</RatingCount></CommunityRating>"
"</MetronInfo>",
),
(
TEST_V11_XSD,
'<?xml version="1.0" encoding="UTF-8"?><MetronInfo>'
"<Series><Name>Foo</Name></Series><Number />"
"<CommunityRating><AverageRating>4.5</AverageRating><RatingCount>0</RatingCount></CommunityRating>"
"</MetronInfo>",
),
],
ids=[
"dup_primary_attr_xml",
Expand All @@ -101,6 +153,10 @@ def test_valid(xsd: Path, xml: Path | str) -> None:
"v11_negative_page_count",
"v11_negative_volume",
"v11_duplicate_alternative_number",
"v11_community_rating_too_high",
"v11_community_rating_negative",
"v11_community_rating_missing_average",
"v11_community_rating_zero_count",
],
)
def test_invalid(xsd: Path, xml: Path | str) -> None:
Expand Down