modspec 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c39d089400518c8882fa0cfc55582fa27cd73c9358faf2224aeb5535a238fc55
-  data.tar.gz: c7b5fcf2a9c36ab12751ac964b6d95528a21330228872c75851bdf2211a8d885
+  metadata.gz: 74bb2806f9ebad2c91453ba473103f5e581c76b78223d9eeba79f4580e8858db
+  data.tar.gz: cb2903e0b33726419f118c65f64ad5463a2bef0b385643f877de977bc447f8d9
 SHA512:
-  metadata.gz: d8e4371eea18c40f1b660841ff6d1723b8a8536acd248a65d87d6d4526bba35ea0b00970e7199bdeaee51114c1cd214233859c2265d1f43fb742831f19c71568
-  data.tar.gz: 7f6f7f555aaa1ce91e300240ce57f37e69d77e1fb4f1ff0fb020e8afc69c195c3a287f2540bbcce31019481915a2fb2d1ba748670f1c9f6ce622eb6d4b720e58
+  metadata.gz: d31ab6413761a379a95aa692e94471538daa63cb507ecfcf25ab6e4b3bc34cdfc22d8234ca4239e0159921bdd203ce4e8bec8bec3e4d99323222c34d49d59ac0
+  data.tar.gz: 615225d2adf7b489e0d627147b3a3dbdd43009ed0c96df174f690b9ebeec6c7c752eb5a684505f6822af40d7ee9710ef2a165e9aa601ba6144d82b52a2192a38

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,22 @@
-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
+
+inherit_mode:
+  merge:
+    - Exclude
+
+# local repo-specific modifications
+# ...
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
 
 AllCops:
   TargetRubyVersion: 3.0
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+RSpec/ExampleLength:
+  Max: 30

data/.rubocop_todo.yml

@@ -1,118 +1,150 @@
 # 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-06 00:19:18 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: 7
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: aligned, indented, indented_relative_to_receiver
-Layout/MultilineMethodCallIndentation:
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
   Exclude:
-    - 'modspec.gemspec'
+    - 'lib/modspec/suite.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
-
 # Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 204
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'lib/modspec/suite.rb'
 
 # Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 12
-
-# Offense count: 5
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-Metrics/MethodLength:
-  Max: 18
+# This cop supports safe autocorrection (--autocorrect).
+Layout/BlockEndNewline:
+  Exclude:
+    - 'lib/modspec/suite.rb'
 
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/PerceivedComplexity:
-  Max: 12
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'spec/modspec/suite_spec.rb'
 
-# 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:
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Width, EnforcedStyleAlignWith, AllowedPatterns.
+# SupportedStylesAlignWith: start_of_line, relative_to_receiver
+Layout/IndentationWidth:
   Exclude:
-    - 'spec/**/*'
-    - 'lib/modspec/normative_statement.rb'
+    - 'lib/modspec/suite.rb'
 
-# Offense count: 6
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
+# Offense count: 36
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
   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'
+    - '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: 2
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
-Style/IfUnlessModifier:
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
   Exclude:
-    - 'lib/modspec/conformance_class.rb'
-    - 'lib/modspec/normative_statements_class.rb'
+    - 'lib/modspec/suite.rb'
+    - 'spec/modspec/suite_spec.rb'
+
+# Offense count: 5
+# 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: 19
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/modspec/suite.rb'
 
-# Offense count: 27
+# Offense count: 2
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'lib/modspec/suite.rb'
+
+# 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'
+
+# Offense count: 4
+# Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
+RSpec/IndexedLet:
+  Exclude:
     - 'spec/modspec/normative_statements_class_spec.rb'
+    - 'spec/modspec/suite_spec.rb'
 
-# Offense count: 6
+# Offense count: 8
+RSpec/MultipleExpectations:
+  Max: 9
+
+# Offense count: 7
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 12
+
+# Offense count: 2
+RSpec/RepeatedExample:
+  Exclude:
+    - 'spec/modspec_spec.rb'
+
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# AllowedMethods: lambda, proc, it
+Style/BlockDelimiters:
   Exclude:
-    - 'spec/modspec/conformance_class_spec.rb'
+    - 'lib/modspec/suite.rb'
 
-# Offense count: 13
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 247
+Style/MultilineIfModifier:
+  Exclude:
+    - 'lib/modspec/suite.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,11 +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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
-require_relative "conformance_test"
-require_relative "identifier"
 
 module Modspec
   class ConformanceClass < Lutaml::Model::Serializable
@@ -18,7 +16,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 +30,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))
@@ -52,10 +50,8 @@ module Modspec
     def validate_identifier_prefix
       errors = []
       expected_prefix = "#{identifier}/"
-      if tests
-        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
+      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
     end

data/lib/modspec/conformance_test.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
-require_relative "identifier"
 
 module Modspec
   class ConformanceTest < Lutaml::Model::Serializable
@@ -13,13 +12,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 +28,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

data/lib/modspec/identifier.rb

@@ -4,6 +4,5 @@ require "lutaml/model"
 
 module Modspec
   class Identifier < Lutaml::Model::Type::String
-    # attribute :identifier, :string
   end
 end

data/lib/modspec/normative_statement.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
-require_relative "identifier"
 
 module Modspec
   class NormativeStatementPart < Lutaml::Model::Serializable
@@ -29,7 +28,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,43 +45,8 @@ module Modspec
       map_element "parts", to: :parts
     end
 
-    def validate(suite = nil)
-      errors = super()
-      errors.concat(validate_dependencies(suite)) if suite
-      errors.concat(validate_nested_requirement)
-      errors
-    end
-
-    private
-
-    def all_dependencies
-      (
-        (dependencies || []) +
-        (indirect_dependency || []) +
-        (implements || [])
-      ).flatten.compact
-    end
-
-    def validate_dependencies(suite)
-      errors = []
-      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)
-      end
-      errors
-    end
-
-    def validate_nested_requirement
-      if has_parent_requirement?
-        ["Nested requirement detected: #{identifier}"]
-      else
-        []
-      end
-    end
-
-    def has_parent_requirement?
-      # Implementation depends on how you determine if a requirement is nested
-      false
+    def validate(_suite = nil, register: Lutaml::Model::Config.default_register)
+      super(register: register)
     end
   end
 end

data/lib/modspec/normative_statements_class.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
-require_relative "normative_statement"
-require_relative "identifier"
 
 module Modspec
   class NormativeStatementsClass < Lutaml::Model::Serializable
@@ -12,19 +10,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