Skip to content

Add <response> element validation for SPS 1.10 compliance #1138

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

Open
Copilot wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add <response> element validation for SPS 1.10 compliance #1138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3156335
Initial plan
Copilot Mar 19, 2026
ff87d85
Add response element validation for SPS 1.10 compliance
Copilot Mar 19, 2026
760a362
Address code review feedback: clean URL and grammar fix
Copilot Mar 19, 2026
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
294 changes: 294 additions & 0 deletions packtools/sps/validation/response.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
"""
Validations for the <response> element according to SPS 1.10 specification.

This module implements validations for the <response> element, which identifies
a set of responses related to a letter or commentary, mandatorily published
alongside the letter/commentary.

Reference: https://docs.google.com/document/d/1GTv4Inc2LS_AXY-ToHT3HmO66UT0VAHWJNOIqzBNSgA/edit#heading=h.response
"""

from packtools.sps.validation.utils import build_response


XML_LANG = "{http://www.w3.org/XML/1998/namespace}lang"


class ResponseValidation:
"""
Validates <response> elements according to SPS 1.10 rules.

Validation rules:
- Presence of @response-type attribute
- Value of @response-type must be "reply"
- Presence of @xml:lang attribute
- Presence of @id attribute
- Uniqueness of @id across all <response> elements
- Presence of <front-stub> child element
- Presence of <body> child element
"""

def __init__(self, xmltree, params=None):
self.xmltree = xmltree
self.params = params or {}

def _get_response_elements(self):
"""
Yield context dicts for each <response> element found in the document.

Searches for <response> elements as children of <article> and
<sub-article>.
"""
root = self.xmltree.find(".")
if root is None:
return

for response_node in root.xpath(".//response"):
parent_node = response_node.getparent()
if parent_node is not None:
parent_tag = parent_node.tag
if parent_tag == "article":
parent_id = None
parent_article_type = parent_node.get("article-type")
parent_lang = parent_node.get(XML_LANG)
elif parent_tag == "sub-article":
parent_id = parent_node.get("id")
parent_article_type = parent_node.get("article-type")
parent_lang = parent_node.get(XML_LANG)
else:
Comment on lines +35 to +58
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

_get_response_elements() docstring says it searches for as children of

/, but the XPath .//response matches any descendant. Since parent info is derived from the direct parent tag, a nested would be attributed to the wrong parent (or lose article-type/lang context). Either restrict the XPath to the intended locations (e.g., direct children of article/sub-article) or, if descendants are intended, resolve the nearest ancestor / for parent metadata and update the docstring accordingly.

Copilot uses AI. Check for mistakes.
parent_id = None
parent_article_type = None
parent_lang = None
else:
parent_tag = None
parent_id = None
parent_article_type = None
parent_lang = None

yield {
"node": response_node,
"parent": parent_tag,
"parent_id": parent_id,
"parent_article_type": parent_article_type,
"parent_lang": parent_lang,
"response_type": (response_node.get("response-type") or "").strip() or None,
"xml_lang": (response_node.get(XML_LANG) or "").strip() or None,
"id": (response_node.get("id") or "").strip() or None,
"has_front_stub": response_node.find("front-stub") is not None,
"has_body": response_node.find("body") is not None,
}

def _build_parent_info(self, ctx):
return {
"parent": ctx["parent"],
"parent_id": ctx["parent_id"],
"parent_article_type": ctx["parent_article_type"],
"parent_lang": ctx["parent_lang"],
}

def validate(self):
yield from self.validate_response_type_presence()
yield from self.validate_response_type_value()
yield from self.validate_xml_lang_presence()
yield from self.validate_id_presence()
yield from self.validate_id_uniqueness()
yield from self.validate_front_stub_presence()
yield from self.validate_body_presence()

def validate_response_type_presence(self):
"""
Rule 1: Validate that @response-type attribute is present in <response>.
"""
error_level = self.params.get(
"response_type_presence_error_level", "CRITICAL"
)
for ctx in self._get_response_elements():
response_type = ctx["response_type"]
is_valid = bool(response_type)
yield build_response(
title="response @response-type presence",
parent=self._build_parent_info(ctx),
item="response",
sub_item="@response-type",
validation_type="exist",
is_valid=is_valid,
expected="reply",
obtained=response_type,
advice='Add @response-type="reply" to <response>.',
data=ctx.get("id"),
error_level=error_level,
element_name="response",
attribute_name="response-type",
Comment on lines +120 to +121
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

In build_response(), format_advice() will auto-generate/override the provided advice when validation_type="exist" and any of element_name/attribute_name/sub_element_name are provided. As a result, this rule’s custom guidance (notably the required value reply) won’t appear in the output; you’ll get a generic ...="VALUE" suggestion instead. Consider either (a) omitting element_name/attribute_name for these exist validations so your custom advice is preserved, or (b) adjusting the utils helper to only auto-generate advice when advice is None (then keep the structured names).

Suggested change
element_name="response",
attribute_name="response-type",

Copilot uses AI. Check for mistakes.
)

def validate_response_type_value(self):
"""
Rule 2: Validate that @response-type value is "reply".
"""
error_level = self.params.get(
"response_type_value_error_level", "ERROR"
)
for ctx in self._get_response_elements():
response_type = ctx["response_type"]
if not response_type:
continue
is_valid = response_type == "reply"
yield build_response(
title="response @response-type value",
parent=self._build_parent_info(ctx),
item="response",
sub_item="@response-type",
validation_type="value",
is_valid=is_valid,
expected="reply",
obtained=response_type,
advice='Replace @response-type with "reply" in <response>.',
data=ctx.get("id"),
error_level=error_level,
element_name="response",
attribute_name="response-type",
)

def validate_xml_lang_presence(self):
"""
Rule 3: Validate that @xml:lang attribute is present in <response>.
"""
error_level = self.params.get(
"xml_lang_presence_error_level", "CRITICAL"
)
for ctx in self._get_response_elements():
xml_lang = ctx["xml_lang"]
is_valid = bool(xml_lang)
yield build_response(
title="response @xml:lang presence",
parent=self._build_parent_info(ctx),
item="response",
sub_item="@xml:lang",
validation_type="exist",
is_valid=is_valid,
expected="a valid xml:lang value",
obtained=xml_lang,
advice="Add @xml:lang to <response>.",
data=ctx.get("id"),
error_level=error_level,
element_name="response",
attribute_name="xml:lang",
)

def validate_id_presence(self):
"""
Rule 4: Validate that @id attribute is present in <response>.
"""
error_level = self.params.get(
"id_presence_error_level", "CRITICAL"
)
for ctx in self._get_response_elements():
response_id = ctx["id"]
is_valid = bool(response_id)
yield build_response(
title="response @id presence",
parent=self._build_parent_info(ctx),
item="response",
sub_item="@id",
validation_type="exist",
is_valid=is_valid,
expected="a unique id value",
obtained=response_id,
advice="Add @id to <response>.",
data=ctx.get("id"),
error_level=error_level,
element_name="response",
attribute_name="id",
)

def validate_id_uniqueness(self):
"""
Rule 5: Validate that each <response> has a unique @id value.
"""
error_level = self.params.get(
"id_uniqueness_error_level", "ERROR"
)
seen_ids = {}
contexts = list(self._get_response_elements())
for ctx in contexts:
response_id = ctx["id"]
if not response_id:
continue
if response_id in seen_ids:
seen_ids[response_id] += 1
else:
seen_ids[response_id] = 1

duplicates = {k for k, v in seen_ids.items() if v > 1}
if not duplicates:
return

for ctx in contexts:
response_id = ctx["id"]
if response_id not in duplicates:
continue
yield build_response(
title="response @id uniqueness",
parent=self._build_parent_info(ctx),
item="response",
sub_item="@id",
validation_type="unique",
is_valid=False,
expected="a unique @id for each <response>",
obtained=response_id,
advice=f'Replace duplicate @id="{response_id}" with a unique value in <response>.',
data=response_id,
error_level=error_level,
element_name="response",
attribute_name="id",
)

def validate_front_stub_presence(self):
"""
Rule 6: Validate that <front-stub> is present in <response>.
"""
error_level = self.params.get(
"front_stub_presence_error_level", "WARNING"
)
for ctx in self._get_response_elements():
is_valid = ctx["has_front_stub"]
yield build_response(
title="response front-stub presence",
parent=self._build_parent_info(ctx),
item="response",
sub_item="front-stub",
validation_type="exist",
is_valid=is_valid,
expected="<front-stub> element",
obtained="front-stub" if is_valid else None,
advice="Add <front-stub> with response metadata inside <response>.",
data=ctx.get("id"),
error_level=error_level,
element_name="response",
sub_element_name="front-stub",
)

def validate_body_presence(self):
"""
Rule 7: Validate that <body> is present in <response>.
"""
error_level = self.params.get(
"body_presence_error_level", "WARNING"
)
for ctx in self._get_response_elements():
is_valid = ctx["has_body"]
yield build_response(
title="response body presence",
parent=self._build_parent_info(ctx),
item="response",
sub_item="body",
validation_type="exist",
is_valid=is_valid,
expected="<body> element",
obtained="body" if is_valid else None,
advice="Add <body> with response content inside <response>.",
data=ctx.get("id"),
error_level=error_level,
element_name="response",
sub_element_name="body",
)
17 changes: 17 additions & 0 deletions packtools/sps/validation/xml_validations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
from packtools.sps.validation.history import HistoryValidation
from packtools.sps.validation.ext_link import ExtLinkValidation
from packtools.sps.validation.graphic import XMLGraphicValidation
from packtools.sps.validation.response import ResponseValidation


def validate_affiliations(xmltree, params):
Expand Down Expand Up @@ -374,3 +375,19 @@ def validate_graphics(xmltree, params):
graphic_rules = params["graphic_rules"]
validator = XMLGraphicValidation(xmltree, graphic_rules)
yield from validator.validate()


def validate_response(xmltree, params):
"""
Validates <response> elements according to SPS 1.10 specification.

Validates:
- @response-type presence and value ("reply")
- @xml:lang presence
- @id presence and uniqueness
- <front-stub> presence
- <body> presence
"""
response_rules = params.get("response_rules", {})
validator = ResponseValidation(xmltree, response_rules)
yield from validator.validate()
4 changes: 4 additions & 0 deletions packtools/sps/validation/xml_validator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,3 +157,7 @@ def validate_xml_content(xmltree, rules):
"group": "graphic",
"items": xml_validations.validate_graphics(xmltree, params),
}
yield {
"group": "response",
"items": xml_validations.validate_response(xmltree, params),
}
11 changes: 11 additions & 0 deletions packtools/sps/validation_rules/response_rules.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"response_rules": {
"response_type_presence_error_level": "CRITICAL",
"response_type_value_error_level": "ERROR",
"xml_lang_presence_error_level": "CRITICAL",
"id_presence_error_level": "CRITICAL",
"id_uniqueness_error_level": "ERROR",
"front_stub_presence_error_level": "WARNING",
"body_presence_error_level": "WARNING"
}
}
Loading
Loading