modspec 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cd4badc4f810933f2fec27871086eefcc0158e211e13330fb254c6c6b434eb0
-  data.tar.gz: b43653c35d01208efe9fb99114397488428904549deb1a10db84394b9bdd1b0a
+  metadata.gz: 925062f2457c7aa978de3d2eabc679f4a33b9177e8ba2f3a80494c46377ff0b8
+  data.tar.gz: '083c357ffd578b297ae28753e48dccacd08a10d202f336299b037d1d6b08fe9a'
 SHA512:
-  metadata.gz: 2767799e906ee065a3df1eb05b74f53acb839a0e34e37ed70a1a1418a0f80bdfc0de90e0b3155a958da6f5f35dfcb090c06657e882e17f4f86b0c72b4f42a293
-  data.tar.gz: '08f9a6974ea4726b0d062338f0e687c8c99a74494ff4a62f56b481c01bd72aa62fda8ef164840d1acef0d5b178e3cc9a4f59d51d137cba9cad10280e559d8b03'
+  metadata.gz: ce9246f0f6b4ce811bf498d52a59c25949ad0016b024ab215c332ce7e1e34fa311c2a78267a3a1b07cb1a2f0f468559c1aeaedb638c4552e9500016ad8a3235b
+  data.tar.gz: 7132a3d0194c87222d077752784d1d1d7197481d1db1ae356c9f959d8cccd8163f3ef268a2e4e6b75812095768e133ab6da81c629fd3d33b0122f7f2789079fe

data/.github/workflows/rake.yml

@@ -2,6 +2,10 @@
 # See https://github.com/metanorma/cimas
 name: rake
 
+permissions:
+  contents: write
+  packages: write
+
 on:
   push:
     branches: [ master, main ]

data/.github/workflows/release.yml

@@ -2,6 +2,11 @@
 # See https://github.com/metanorma/cimas
 name: release
 
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+
 on:
   workflow_dispatch:
     inputs:

data/.rubocop.yml

@@ -1,10 +1,19 @@
-inherit_from: .rubocop_todo.yml
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  - .rubocop_todo.yml
 
-AllCops:
-  TargetRubyVersion: 3.0
+inherit_mode:
+  merge:
+    - Exclude
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+# local repo-specific modifications
+# ...
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+AllCops:
+  TargetRubyVersion: 3.0

data/.rubocop_todo.yml

@@ -1,118 +1,105 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-09-11 00:07:51 UTC using RuboCop version 1.66.1.
+# on 2026-05-05 14:09:35 UTC using RuboCop version 1.86.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
-# Include: **/*.gemfile, **/Gemfile, **/gems.rb
-Bundler/OrderedGems:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 1
-# Configuration parameters: Severity, Include.
-# Include: **/*.gemspec
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'modspec.gemspec'
 
-# Offense count: 10
+# Offense count: 33
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: aligned, indented, indented_relative_to_receiver
-Layout/MultilineMethodCallIndentation:
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
   Exclude:
-    - 'modspec.gemspec'
+    - 'lib/modspec/conformance_class.rb'
+    - 'lib/modspec/conformance_test.rb'
+    - 'lib/modspec/normative_statement.rb'
+    - 'lib/modspec/normative_statements_class.rb'
+    - 'lib/modspec/suite.rb'
+    - 'spec/modspec/conformance_class_spec.rb'
+    - 'spec/modspec/conformance_test_spec.rb'
+    - 'spec/modspec/normative_statement_spec.rb'
+    - 'spec/modspec/normative_statements_class_spec.rb'
     - 'spec/modspec/suite_spec.rb'
 
 # Offense count: 4
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 33
-
-# Offense count: 6
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 138
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/modspec/conformance_class_spec.rb'
+    - 'spec/modspec/suite_spec.rb'
 
 # Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 204
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
+# NotImplementedExceptions: NotImplementedError
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/modspec/normative_statement.rb'
 
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 12
+# Offense count: 7
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/modspec/suite.rb'
 
 # Offense count: 5
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/modspec/suite.rb'
+
+# Offense count: 9
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 18
+  Max: 21
 
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns.
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
-  Max: 12
-
-# Offense count: 1
-# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
-# NamePrefix: is_, has_, have_
-# ForbiddenPrefixes: is_, has_, have_
-# AllowedMethods: is_a?
-# MethodDefinitionMacros: define_method, define_singleton_method
-Naming/PredicateName:
   Exclude:
-    - 'spec/**/*'
-    - 'lib/modspec/normative_statement.rb'
+    - 'lib/modspec/suite.rb'
 
-# Offense count: 6
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
+# Offense count: 1
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
   Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/modspec/conformance_class.rb'
-    - 'lib/modspec/conformance_test.rb'
-    - 'lib/modspec/normative_statement.rb'
-    - 'lib/modspec/normative_statements_class.rb'
     - 'lib/modspec/suite.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/modspec/conformance_class.rb'
-    - 'lib/modspec/normative_statements_class.rb'
+# Offense count: 5
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 15
 
-# Offense count: 27
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArguments:
+RSpec/ExpectActual:
   Exclude:
-    - 'spec/modspec/conformance_class_spec.rb'
-    - 'spec/modspec/conformance_test_spec.rb'
     - 'spec/modspec/normative_statement_spec.rb'
-    - 'spec/modspec/normative_statements_class_spec.rb'
 
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
+# Offense count: 4
+# Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
+RSpec/IndexedLet:
   Exclude:
-    - 'spec/modspec/conformance_class_spec.rb'
+    - 'spec/modspec/normative_statements_class_spec.rb'
+    - 'spec/modspec/suite_spec.rb'
 
-# Offense count: 13
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 247
+# Offense count: 7
+RSpec/MultipleExpectations:
+  Max: 9
+
+# Offense count: 7
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 12
+
+# Offense count: 2
+RSpec/RepeatedExample:
+  Exclude:
+    - 'spec/modspec_spec.rb'

data/CLAUDE.md

@@ -0,0 +1,61 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+`modspec` is a Ruby gem for working with OGC ModSpec — a specification format (OGC 08-131r3) for defining requirements and conformance tests for standards. All models use `lutaml-model` (`Lutaml::Model::Serializable`) for serialization to/from YAML, JSON, and XML.
+
+## Commands
+
+- **Run all tests:** `bundle exec rake` or `bundle exec rspec`
+- **Run a single test file:** `bundle exec rspec spec/modspec/suite_spec.rb`
+- **Run a single example:** `bundle exec rspec spec/modspec/suite_spec.rb:42`
+- **Lint:** RuboCop is configured but not in the default rake task. Run with `bundle exec rubocop` if needed.
+- **Console:** `bin/console` (loads IRB with the gem)
+
+## Architecture
+
+All model classes inherit from `Lutaml::Model::Serializable` and define attributes via the `attribute` DSL with serialization mappings in `xml do` blocks. YAML/JSON serialization comes from lutaml-model automatically.
+
+### Identifier convention (critical)
+
+Identifiers are URIs with a specific structure:
+- Class-level: `/<type>/<class>` (e.g., `/req/example`, `/conf/example`)
+- Instance-level: `/<type>/<class>/<name>` (e.g., `/req/example/foo`)
+- Type prefix: `req` = normative statements, `conf` = conformance tests
+
+Validation enforces that children share their parent's identifier prefix.
+
+### Model hierarchy
+
+```
+Suite
+├── NormativeStatementsClass (collection) → groups normative statements
+│   └── NormativeStatement (collection)
+│       └── NormativeStatementPart (collection) → sub-parts of a statement
+├── ConformanceClass (collection) → groups conformance tests
+│   └── ConformanceTest (collection)
+```
+
+- `NormativeStatement` has obligation (`requirement`/`recommendation`/`permission`), dependencies, inherit, indirect_dependency, implements, parts
+- `ConformanceTest` has targets (referencing normative statement identifiers), abstract flag, method, purpose
+- `ConformanceTest` uses runtime-only `corresponding_requirements` and `parent_class` attrs set by `Suite#setup_relationships`
+
+### Validation
+
+Each model class has a `validate` method that returns an array of error strings. `Suite#validate` orchestrates full validation: cycles (dependency graph via DFS), label uniqueness, dependency resolution, and delegating to child class validators.
+
+### Key Suite operations
+
+- `combine(other_suite)` — merges two suites, deduplicating by identifier
+- `from_yaml_files(*files)` — loads and combines multiple YAML files
+- `setup_relationships` — cross-links conformance tests to their target normative statements
+
+### Custom types
+
+`Modspec::Identifier` extends `Lutaml::Model::Type::String` — used as the type for all identifier attributes and reference fields (dependencies, targets, inherit, etc.).
+
+## Key dependency
+
+`lutaml-model ~> 0.7.7` — provides the `Serializable` base class, attribute DSL, and serialization adapters. Breaking changes in lutaml-model may affect this gem.

data/Gemfile

@@ -2,10 +2,12 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in modspec.gemspec
 gemspec
 
-gem "equivalent-xml"
-gem "pry"
+gem "canon"
 gem "rake"
 gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/lib/modspec/conformance_class.rb

@@ -18,7 +18,7 @@ module Modspec
     attribute :reference, :string
 
     xml do
-      root "conformance-class"
+      element "conformance-class"
       map_attribute "identifier", to: :identifier
       map_element "name", to: :name
       map_element "dependencies", to: :dependencies
@@ -32,7 +32,7 @@ module Modspec
     end
 
     def validate
-      errors = super()
+      errors = super
       errors.concat(validate_identifier_prefix)
       errors.concat(validate_class_children_mapping)
       errors.concat(tests.flat_map(&:validate))
@@ -42,7 +42,7 @@ module Modspec
     private
 
     def validate_class_children_mapping
-      if tests.empty?
+      if tests.nil? || tests.empty?
         ["Conformance class #{identifier} has no child conformance tests"]
       else
         []
@@ -52,7 +52,7 @@ module Modspec
     def validate_identifier_prefix
       errors = []
       expected_prefix = "#{identifier}/"
-      tests.each do |test|
+      tests&.each do |test|
         errors << "Conformance test #{test.identifier} does not share the expected prefix #{expected_prefix}" unless test.identifier.to_s.start_with?(expected_prefix)
       end
       errors

data/lib/modspec/conformance_test.rb

@@ -13,13 +13,13 @@ module Modspec
     attribute :description, :string
     attribute :guidance, :string, collection: true
     attribute :purpose, :string
-    attribute :method, :string # Inspection, etc.
+    attribute :test_method, :string
     attribute :type, :string
     attribute :reference, :string
     attribute :abstract, :boolean
 
     xml do
-      root "conformance-test"
+      element "conformance-test"
       map_attribute "identifier", to: :identifier
       map_attribute "abstract", to: :abstract
       map_element "name", to: :name
@@ -29,15 +29,30 @@ module Modspec
       map_element "description", to: :description
       map_element "guidance", to: :guidance
       map_element "purpose", to: :purpose
-      map_element "method", to: :method
+      map_element "method", to: :test_method
       map_element "type", to: :type
       map_element "reference", to: :reference
     end
 
+    key_value do
+      map "identifier", to: :identifier
+      map "name", to: :name
+      map "dependencies", to: :dependencies
+      map "targets", to: :targets
+      map "belongs_to", to: :belongs_to
+      map "description", to: :description
+      map "guidance", to: :guidance
+      map "purpose", to: :purpose
+      map "method", to: :test_method
+      map "type", to: :type
+      map "reference", to: :reference
+      map "abstract", to: :abstract
+    end
+
     attr_accessor :corresponding_requirements, :parent_class
 
     def validate
-      errors = super()
+      errors = super
       errors.concat(validate_requirement_mapping)
       errors.concat(validate_class_mapping)
       errors
@@ -46,7 +61,7 @@ module Modspec
     private
 
     def validate_requirement_mapping
-      if corresponding_requirements.empty?
+      if corresponding_requirements.nil? || corresponding_requirements.empty?
         ["Conformance test #{identifier} has no corresponding requirements"]
       else
         []
@@ -54,7 +69,7 @@ module Modspec
     end
 
     def validate_class_mapping
-      if parent_class.nil? || !parent_class.tests.include?(self)
+      if parent_class.nil? || parent_class.tests.nil? || !parent_class.tests.include?(self)
         ["Conformance test #{identifier} does not belong to its parent class"]
       else
         []

data/lib/modspec/normative_statement.rb

@@ -29,7 +29,7 @@ module Modspec
               default: -> { "requirement" }
 
     xml do
-      root "normative-statement"
+      element "normative-statement"
       map_attribute "identifier", to: :identifier
       map_element "name", to: :name
       map_element "subject", to: :subject
@@ -46,7 +46,7 @@ module Modspec
       map_element "parts", to: :parts
     end
 
-    def validate(suite = nil)
+    def validate(suite = nil, register: Lutaml::Model::Config.default_register)
       errors = super()
       errors.concat(validate_dependencies(suite)) if suite
       errors.concat(validate_nested_requirement)
@@ -55,9 +55,16 @@ module Modspec
 
     private
 
+    def all_dependencies
+      (
+        (dependencies || []) +
+        (indirect_dependency || []) +
+        (implements || [])
+      ).flatten.compact
+    end
+
     def validate_dependencies(suite)
       errors = []
-      all_dependencies = (dependencies + indirect_dependency + implements).flatten.compact.map(&:to_s)
       all_identifiers = suite.all_identifiers.map(&:to_s)
       all_dependencies.each do |dep|
         errors << "Requirement #{identifier} has an invalid dependency: #{dep}" unless all_identifiers.include?(dep)

data/lib/modspec/normative_statements_class.rb

@@ -12,19 +12,21 @@ module Modspec
     attribute :subject, :string
     attribute :guidance, :string, collection: true
     attribute :dependencies, Identifier, collection: true
+    attribute :implements, Identifier, collection: true
     attribute :normative_statements, NormativeStatement, collection: true
     attribute :belongs_to, Identifier, collection: true
     attribute :reference, :string
     attribute :source, :string
 
     xml do
-      root "normative-statements-class"
+      element "normative-statements-class"
       map_attribute "identifier", to: :identifier
       map_element "name", to: :name
       map_element "description", to: :description
       map_element "subject", to: :subject
       map_element "guidance", to: :guidance
       map_element "dependencies", to: :dependencies
+      map_element "implements", to: :implements
       map_element "normative-statements", to: :normative_statements
       map_element "belongs_to", to: :belongs_to
       map_element "reference", to: :reference
@@ -42,16 +44,16 @@ module Modspec
     private
 
     def validate_identifier_prefix
-      errors = []
+      return [] if normative_statements.nil? || normative_statements.empty?
+
       expected_prefix = "#{identifier}/"
-      normative_statements.each do |statement|
+      normative_statements.each_with_object([]) do |statement, errors|
         errors << "Normative statement #{statement.identifier} does not share the expected prefix #{expected_prefix}" unless statement.identifier.to_s.start_with?(expected_prefix)
       end
-      errors
     end
 
     def validate_class_children_mapping
-      if normative_statements.empty?
+      if normative_statements.nil? || normative_statements.empty?
         ["Requirement class #{identifier} has no child requirements"]
       else
         []