Add <product> element validation for SPS 1.10 compliance#1134
Draft
Add <product> element validation for SPS 1.10 compliance#1134
Conversation
- Create product model (packtools/sps/models/product.py) - Create product validation (packtools/sps/validation/product.py) - Create product rules JSON (packtools/sps/validation_rules/product_rules.json) - Create comprehensive tests (tests/sps/validation/test_product.py) - Integrate into orchestrator (xml_validations.py, xml_validator.py) Implements 7 validation rules: - @product-type presence (CRITICAL) - @product-type value (ERROR) - <source> presence (CRITICAL) - article-type consistency (ERROR) - Author presence (WARNING) - Publisher name presence (WARNING) - Year presence (WARNING) All 53 tests pass. Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add validations for the <product> element according to SPS 1.10
Add <product> element validation for SPS 1.10 compliance
Mar 19, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
O que esse PR faz?
Implementa 7 das 10 regras de validação para o elemento
<product>(70% de conformidade SPS 1.10), cobrindo resenhas de livros (book-review).Regras implementadas:
@product-typepresença@product-typevalor"book"<source>presençaarticle-type"book-review"quando<product>presente<person-group person-group-type="author">recomendado<publisher-name>recomendado<year>recomendadoArquivos criados:
packtools/sps/models/product.py— modelo de extração de dados do XMLpacktools/sps/validation/product.py—ProductValidationeArticleProductValidationpacktools/sps/validation_rules/product_rules.json— níveis de erro configuráveistests/sps/validation/test_product.py— 53 testes unitáriosArquivos modificados:
packtools/sps/validation/xml_validations.py—validate_products()+ importpacktools/sps/validation/xml_validator.py— grupo"product"no orquestradorOnde a revisão poderia começar?
packtools/sps/validation/product.py— contém toda a lógica de validação. O modelo empacktools/sps/models/product.pyextrai os dados do XML.Como este poderia ser testado manualmente?
Testes unitários:
Algum cenário de contexto que queira dar?
Segue o padrão estabelecido por
ext_link.pyetablewrap.py: usabuild_response()com suporte completo a i18n (advice_text/advice_params), modelo separado da validação, regras configuráveis via JSON, e integração no orquestrador viaxml_validations.py+xml_validator.py.Todas as mensagens usam
gettext.gettext(_()) para internacionalização. Validações condicionais retornamNonequando não aplicáveis (ex:validate_product_type_valueretornaNonese o atributo está ausente).Screenshots
N/A — sem impacto em UI.
Quais são tickets relevantes?
Criar validações para o elemento
<product>.Referências
<product><product>Original prompt
This section details on the original issue you should resolve
<issue_title>Criar validações para o elemento </issue_title>
<issue_description>## Objetivo
Implementar validações para o elemento
<product>conforme a especificação SPS 1.10, aumentando a conformidade de X% para 70% (7 de 10 regras).Nota: Algumas validações para
<product>podem já estar parcialmente implementadas no repositório. Este Issue visa reavaliar, complementar e garantir cobertura completa das regras SPS 1.10.Contexto
O elemento
<product>é usado para marcação da referência de resenha quando relacionada a um livro ou capítulo de livro. Deve aparecer em artigos com@article-type="book-review". Validações corretas garantem que o atributo obrigatório esteja presente, que elementos essenciais da referência bibliográfica estejam completos, e que haja consistência com o tipo de artigo.Conformidade atual: X de 10 regras implementadas (X%)
Meta após implementação: 7 de 10 regras (70%)
Documentação SPS
Referência oficial: https://docs.google.com/document/d/1GTv4Inc2LS_AXY-ToHT3HmO66UT0VAHWJNOIqzBNSgA/edit?tab=t.0#heading=h.product
Regras principais conforme SPS 1.10:
Ocorrência:
<product>pode aparecer zero ou mais vezes em<article-meta>Atributo obrigatório:
@product-type="book"é obrigatório em<product>Contexto de uso:
<product>deve aparecer em artigos com@article-type="book-review"Elementos tipicamente presentes:
<person-group person-group-type="author">- Autor(es) do livro resenhado<source>- Título do livro<publisher-name>- Editora<publisher-loc>- Local de publicação<year>- Ano de publicação<isbn>- ISBN do livro<size units="pages">- Número de páginas<person-group person-group-type="translator">- Tradutor(es) quando aplicávelElementos essenciais para referência bibliográfica:
<source>), editora, ano são elementos fundamentaisRegras a Implementar
P0 – Críticas (implementar obrigatoriamente)
@product-type@product-typeé obrigatório em<product>@product-type@product-typedeve ser"book"para resenhas de livros<source><source>(título do livro) é obrigatório em<product><product>está presente,<article>deve ter@article-type="book-review"P1 – Importantes (implementar se possível)
<product>contenha<person-group person-group-type="author">com informações do(s) autor(es)<product>contenha<publisher-name><product>contenha<year>P2 – Futuras (fora do escopo deste Issue)
<product>quando@article-typenão é "book-review"Arquivos a Criar/Modificar
Avaliar existentes (podem ter validações parciais):
packtools/sps/models/product.pyou similar – Verificar se modelo existepacktools/sps/validation/product.py– Verificar validações existentespacktools/sps/validation/rules/product_rules.jsonou similar – Verificar configuraçãoCriar (se não existirem):
packtools/sps/models/product.py– Modelo de extração de dadospacktools/sps/validation/product.py– Validaçõespacktools/sps/validation/rules/product_rules.json– Configuração de níveis de errotests/sps/validation/test_product.py– Testes unitáriosReferenciar (implementações similares):
packtools/sps/validation/article_contribs.py– Validação de person-grouppacktools/sps/validation/utils.py– Funções auxiliares (build_response)Exemplos de XML
XML Válido (deve passar sem erros):