modspec 0.1.4 → 0.2.1

data/lib/modspec/suite.rb

@@ -6,14 +6,16 @@ module Modspec
   class Suite < Lutaml::Model::Serializable
     attribute :identifier, Identifier
     attribute :name, :string
-    attribute :normative_statements_classes, NormativeStatementsClass, collection: true
+    attribute :normative_statements_classes, NormativeStatementsClass,
+              collection: true
     attribute :conformance_classes, ConformanceClass, collection: true
 
     xml do
-      root "suite"
+      element "suite"
       map_attribute "identifier", to: :identifier
       map_element "name", to: :name
-      map_element "normative-statements-classes", to: :normative_statements_classes
+      map_element "normative-statements-classes",
+                  to: :normative_statements_classes
       map_element "conformance-classes", to: :conformance_classes
     end
 
@@ -24,13 +26,20 @@ module Modspec
       errors.concat(validate_cycles)
       errors.concat(validate_label_uniqueness)
       errors.concat(validate_dependencies)
-      errors.concat(normative_statements_classes.flat_map { |n| n.validate(self) }) unless normative_statements_classes.nil?
+      unless normative_statements_classes.nil?
+        errors.concat(normative_statements_classes.flat_map do |n|
+          n.validate(self)
+        end)
+      end
       errors.concat(conformance_classes.flat_map(&:validate)) unless conformance_classes.nil?
       errors
     end
 
     def combine(other_suite)
-      raise ArgumentError, "Argument must be a Modspec::Suite" unless other_suite.is_a?(Modspec::Suite)
+      unless other_suite.is_a?(Modspec::Suite)
+        raise ArgumentError,
+              "Argument must be a Modspec::Suite"
+      end
 
       combined_suite = dup
       combined_suite.all_identifiers = nil
@@ -45,9 +54,9 @@ module Modspec
       end
 
       # Ensure uniqueness of identifiers
-      combined_suite.normative_statements_classes.uniq!(&:identifier) if combined_suite.normative_statements_classes
+      combined_suite.normative_statements_classes&.uniq!(&:identifier)
 
-      combined_suite.conformance_classes.uniq!(&:identifier) if combined_suite.conformance_classes
+      combined_suite.conformance_classes&.uniq!(&:identifier)
 
       combined_suite.name = "#{name} + #{other_suite.name}"
 
@@ -69,8 +78,10 @@ module Modspec
     attr_writer :all_identifiers
 
     def resolve_conflicts(other_suite)
-      resolve_conflicts_for(normative_statements_classes, other_suite.normative_statements_classes)
-      resolve_conflicts_for(conformance_classes, other_suite.conformance_classes)
+      resolve_conflicts_for(normative_statements_classes,
+                            other_suite.normative_statements_classes)
+      resolve_conflicts_for(conformance_classes,
+                            other_suite.conformance_classes)
     end
 
     def self.from_yaml_files(*files)
@@ -84,18 +95,17 @@ module Modspec
     end
 
     def setup_relationships
-      all_requirements = if normative_statements_classes
-                           normative_statements_classes.flat_map(&:normative_statements)
-                         else
-                           []
-                         end
+      return unless normative_statements_classes && conformance_classes
 
-      return unless conformance_classes
+      req_index = normative_statements_classes
+        .flat_map(&:normative_statements)
+        .to_h { |r| [r.identifier.to_s, r] }
 
       conformance_classes.each do |cc|
         cc.tests.each do |ct|
-          ct.corresponding_requirements = all_requirements.select do |r|
-            ct.targets.map(&:to_s).include?(r.identifier.to_s)
+          targets = Array(ct.targets).map(&:to_s)
+          ct.corresponding_requirements = targets.filter_map do |t|
+            req_index[t]
           end
           ct.parent_class = cc
         end
@@ -108,7 +118,9 @@ module Modspec
       return if self_collection.nil? || other_collection.nil?
 
       other_collection.each do |other_item|
-        existing_item = self_collection.find { |item| item.identifier == other_item.identifier }
+        existing_item = self_collection.find do |item|
+          item.identifier == other_item.identifier
+        end
         if existing_item
           # Merge attributes of conflicting items
           merge_attributes(existing_item, other_item)
@@ -133,7 +145,7 @@ module Modspec
     def validate_cycles
       graph = build_dependency_graph
       cycles = detect_cycles(graph)
-      cycles.map { |cycle| "Cycle detected: #{cycle.join(" -> ")}" }
+      cycles.map { |cycle| "Cycle detected: #{cycle.join(' -> ')}" }
     end
 
     # Combine all statements into a single array
@@ -158,14 +170,14 @@ module Modspec
 
       all_statements.each do |statement|
         id = statement.identifier.to_s
-        graph[id] = Set.new
+        deps = Set.new
 
-        # Define all dependency-like properties to check
-        dependency_properties = %i[dependencies indirect_dependency implements targets]
-
-        dependency_properties.each do |property|
-          graph[id].merge(statement.send(property).map(&:to_s)) if statement.respond_to?(property) && !statement.send(property).nil?
+        %i[dependencies indirect_dependency implements targets].each do |prop|
+          refs = statement.send(prop) if statement.respond_to?(prop)
+          deps.merge(refs.map(&:to_s)) if refs
         end
+
+        graph[id] = deps
       end
 
       graph
@@ -191,19 +203,14 @@ module Modspec
       recursion_stack.add(node)
       path.push(node)
 
-      # Check if the node exists in the graph and has dependencies
-      if graph[node]
-        graph[node].each do |neighbor|
-          if !visited.include?(neighbor)
-            cycle = detect_cycle_util(neighbor, graph, visited, recursion_stack, path)
-            return cycle if cycle
-          elsif recursion_stack.include?(neighbor)
-            return path[path.index(neighbor)..] + [neighbor]
-          end
+      graph[node]&.each do |neighbor|
+        if !visited.include?(neighbor)
+          cycle = detect_cycle_util(neighbor, graph, visited,
+                                    recursion_stack, path)
+          return cycle if cycle
+        elsif recursion_stack.include?(neighbor)
+          return path[path.index(neighbor)..] + [neighbor]
         end
-      else
-        # If the node doesn't exist in the graph, log a warning
-        puts "Warning: Node #{node} referenced but not found in the graph"
       end
 
       path.pop
@@ -225,24 +232,24 @@ module Modspec
     end
 
     def validate_dependencies
-      all_identifiers = collect_all_identifiers
+      all_ids = collect_all_identifiers
 
       errors = []
-      if normative_statements_classes
-        normative_statements_classes.each do |nsc|
-          errors.concat(validate_class_dependencies(nsc, all_identifiers))
-          nsc.normative_statements.each do |ns|
-            errors.concat(validate_statement_dependencies(ns, all_identifiers))
-          end
+      normative_statements_classes&.each do |nsc|
+        errors.concat(validate_refs(nsc, all_ids, :dependencies))
+        errors.concat(validate_refs(nsc, all_ids, :implements))
+        nsc.normative_statements.each do |ns|
+          errors.concat(validate_refs(ns, all_ids, :dependencies))
+          errors.concat(validate_refs(ns, all_ids, :indirect_dependency))
+          errors.concat(validate_refs(ns, all_ids, :implements))
         end
       end
 
-      if conformance_classes
-        conformance_classes.each do |cc|
-          errors.concat(validate_class_dependencies(cc, all_identifiers))
-          cc.tests.each do |ct|
-            errors.concat(validate_test_targets(ct, all_identifiers))
-          end
+      conformance_classes&.each do |cc|
+        errors.concat(validate_refs(cc, all_ids, :dependencies))
+        cc.tests.each do |ct|
+          errors.concat(validate_refs(ct, all_ids, :dependencies))
+          errors.concat(validate_refs(ct, all_ids, :targets))
         end
       end
 
@@ -252,49 +259,33 @@ module Modspec
     def collect_all_identifiers
       identifiers = {}
 
-      if normative_statements_classes
-        normative_statements_classes.each do |nsc|
-          identifiers[nsc.identifier.to_s] = nsc
-          nsc.normative_statements.each do |ns|
-            identifiers[ns.identifier.to_s] = ns
-          end
+      normative_statements_classes&.each do |nsc|
+        identifiers[nsc.identifier.to_s] = nsc
+        nsc.normative_statements.each do |ns|
+          identifiers[ns.identifier.to_s] = ns
         end
       end
 
-      if conformance_classes
-        conformance_classes.each do |cc|
-          identifiers[cc.identifier.to_s] = cc
-          cc.tests.each do |ct|
-            identifiers[ct.identifier.to_s] = ct
-          end
+      conformance_classes&.each do |cc|
+        identifiers[cc.identifier.to_s] = cc
+        cc.tests.each do |ct|
+          identifiers[ct.identifier.to_s] = ct
         end
       end
 
       identifiers
     end
 
-    def validate_class_dependencies(klass, all_identifiers)
-      errors = []
-      klass.dependencies&.each do |dep|
-        errors << "Invalid dependency #{dep} in #{klass.identifier}" unless all_identifiers.key?(dep.to_s)
-      end
-      errors
-    end
-
-    def validate_statement_dependencies(statement, all_identifiers)
-      errors = []
-      statement.dependencies&.each do |dep|
-        errors << "Invalid dependency #{dep} in #{statement.identifier}" unless all_identifiers.key?(dep.to_s)
-      end
-      errors
-    end
+    def validate_refs(obj, all_ids, property)
+      refs = obj.send(property)
+      return [] unless refs
 
-    def validate_test_targets(test, all_identifiers)
-      errors = []
-      test.targets&.each do |target|
-        errors << "Invalid target #{target} in #{test.identifier}" unless all_identifiers.key?(target.to_s)
+      refs.filter_map do |ref|
+        unless all_ids.key?(ref.to_s)
+          "Invalid #{property.to_s.tr('_',
+                                      ' ')} #{ref} in #{obj.identifier}"
+        end
       end
-      errors
     end
   end
 end

data/lib/modspec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Modspec
-  VERSION = "0.1.4"
+  VERSION = "0.2.1"
 end

data/lib/modspec.rb

@@ -2,28 +2,14 @@
 
 require_relative "modspec/version"
 require "lutaml/model"
+require "set"
 
 module Modspec
-  class Error < StandardError; end
-
-  # Your code goes here...
-end
-
-require_relative "modspec/identifier"
-require_relative "modspec/normative_statement"
-require_relative "modspec/normative_statements_class"
-require_relative "modspec/conformance_test"
-require_relative "modspec/conformance_class"
-require_relative "modspec/suite"
-
-require "lutaml/model/xml_adapter/nokogiri_adapter"
-require "lutaml/model/json_adapter/standard_json_adapter"
-require "lutaml/model/toml_adapter/toml_rb_adapter"
-require "lutaml/model/yaml_adapter/standard_yaml_adapter"
-
-Lutaml::Model::Config.configure do |config|
-  config.xml_adapter = Lutaml::Model::XmlAdapter::NokogiriAdapter
-  config.yaml_adapter = Lutaml::Model::YamlAdapter::StandardYamlAdapter
-  config.json_adapter = Lutaml::Model::JsonAdapter::StandardJsonAdapter
-  config.toml_adapter = Lutaml::Model::TomlAdapter::TomlRbAdapter
+  autoload :Identifier, "modspec/identifier"
+  autoload :NormativeStatement, "modspec/normative_statement"
+  autoload :NormativeStatementPart, "modspec/normative_statement"
+  autoload :NormativeStatementsClass, "modspec/normative_statements_class"
+  autoload :ConformanceTest, "modspec/conformance_test"
+  autoload :ConformanceClass, "modspec/conformance_class"
+  autoload :Suite, "modspec/suite"
 end

data/modspec.gemspec

@@ -20,16 +20,17 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   spec.files = all_files_in_git
-               .reject { |f| f.match(%r{\A(?:test|features|bin|\.)/}) }
+    .reject { |f| f.match(%r{\A(?:test|features|bin|\.)/}) }
 
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "lutaml-model", "~>0.7"
+  spec.add_dependency "lutaml-model", "~> 0.8.0"
   spec.add_dependency "nokogiri"
   spec.add_dependency "toml-rb"
 end

data/spec/conformance_class.liquid

@@ -80,11 +80,11 @@ guidance::
 test-purpose:: {{test.purpose}}
 {% endif %}
 
-{% if {{test.method}} %}
+{% if {{test.test_method}} %}
 test-method::
 +
 --
-{{test.method}}
+{{test.test_method}}
 --
 {% endif %}
 

data/spec/fixtures/advanced-json-rc.yaml

@@ -1,16 +1,14 @@
 ---
 normative_statements_classes:
 - name: JSON encoding of Advanced SDU
-  identifier: /req/advanced-encoding-json
-  description: |
-    Requirements for the JSON encoding of a Advanced SDU.
+  identifier: "/req/advanced-encoding-json"
+  description: 'Requirements for the JSON encoding of a Advanced SDU.'
   implements:
-  - /req/advanced
-
+  - "/req/advanced"
   normative_statements:
-
   - name: Specification as JSON schema
-    identifier: /req/advanced-encoding-json/definition
+    identifier: "/req/advanced-encoding-json/definition"
     statement: |
       A JSON-encoded Advanced GeoPose SHALL conform to the
       Advanced JSON-Schema 2019-9 definition (<<advanced_geopose_json_schema>>).
+    obligation: requirement

data/spec/fixtures/advanced-rc.yaml

@@ -1,37 +1,34 @@
 ---
 normative_statements_classes:
 - name: Advanced logical model SDU
-  identifier: /req/advanced
+  identifier: "/req/advanced"
   description: |
     The Advanced Target has a more general structure than Basic-YPR and
     Basic-Quaternion, supporting flexible specification of Outer Frame and a
     Valid Time.
-
   dependencies:
-  - /req/global
-  - /req/frame-spec
-  - /req/time
+  - "/req/global"
+  - "/req/frame-spec"
+  - "/req/time"
   normative_statements:
-
   - name: Expression of valid time as GeoPose_Instant
-    identifier: /req/advanced/valid-time
+    identifier: "/req/advanced/valid-time"
     dependencies:
-    - /req/time/instant
-
+    - "/req/time/instant"
     statement: |
       The `Advanced.validTime` attribute shall be represented by a
       `GeoPose_Instant` object.
-
+    obligation: requirement
   - name: Expression of outer frame
-    identifier: /req/advanced/frame-spec
+    identifier: "/req/advanced/frame-spec"
     dependencies:
-    - /req/frame-spec
+    - "/req/frame-spec"
     statement: |
       The `Advanced.frameSpecification` attribute shall represent an explicit
       frame specification with the `ExplicitFrameSpec` object.
-
+    obligation: requirement
   - name: Expression of inner frame
-    identifier: /req/advanced/quaternion
+    identifier: "/req/advanced/quaternion"
     statement: |
       The `Advanced.quaternion` attribute shall contain a quaternion expressed
       using the UnitQuaternion datatype value expressed as four real numbers,
@@ -41,3 +38,4 @@ normative_statements_classes:
       SHALL be applied to an initial reference frame oriented East-North-Up
       (ENU) coordinate system where the coordinate axes East, North, and Up
       correspond to the axes X, Y, Z.
+    obligation: requirement

data/spec/fixtures/basic-quaternion-json-rc.yaml

@@ -1,17 +1,15 @@
 ---
 normative_statements_classes:
 - name: Permissive JSON encoding of Basic-Quaternion SDU
-  identifier: /req/basic-quaternion-encoding-json
-  description: |
-    Requirements for the JSON encoding of a Basic-Quaternion SDU.
+  identifier: "/req/basic-quaternion-encoding-json"
+  description: 'Requirements for the JSON encoding of a Basic-Quaternion SDU.'
   implements:
-  - /req/basic-quaternion
-
+  - "/req/basic-quaternion"
   normative_statements:
-
   - name: Specification as JSON schema
-    identifier: /req/basic-quaternion-encoding-json/definition
+    identifier: "/req/basic-quaternion-encoding-json/definition"
     statement: |
       A JSON-encoded Basic-Quaternion GeoPose SHALL conform to the
       Basic-Quaternion JSON-Schema 2019-9 definition
       (<<basic_quaternion_permissive_json_schema>>).
+    obligation: requirement

data/spec/fixtures/basic-quaternion-json-strict-rc.yaml

@@ -1,19 +1,18 @@
 ---
 normative_statements_classes:
 - name: Strict JSON encoding of Basic-Quaternion SDU
-  identifier: /req/basic-quaternion-encoding-json-strict
+  identifier: "/req/basic-quaternion-encoding-json-strict"
   description: |
     Requirements for the JSON encoding of a Basic-Quaternion SDU in strict mode.
     The strict encoding does not allow specification of JSON elements outside of
     the schema.
   implements:
-  - /req/basic-quaternion
-
+  - "/req/basic-quaternion"
   normative_statements:
-
   - name: Specification as JSON schema
-    identifier: /req/basic-quaternion-encoding-json-strict/definition
+    identifier: "/req/basic-quaternion-encoding-json-strict/definition"
     statement: |
       A JSON-encoded Basic-Quaternion GeoPose SHALL conform to the
       strict Basic-Quaternion JSON-Schema 2019-9 definition
       (<<basic_quaternion_strict_json_schema>>).
+    obligation: requirement

data/spec/fixtures/basic-quaternion-rc.yaml

@@ -1,26 +1,24 @@
 ---
 normative_statements_classes:
 - name: Basic-Quaternion logical model SDU
-  identifier: /req/basic-quaternion
+  identifier: "/req/basic-quaternion"
   description: |
     The Basic-Quaternion Target has a simple structure with no options. Position
     is specified as a point in an LTP-ENU frame and rotation is specified as a
     unit quaternion.
-
   dependencies:
-  - /req/global
-  - /req/tangent-point
+  - "/req/global"
+  - "/req/tangent-point"
   normative_statements:
-
   - name: Expression of outer frame
-    identifier: /req/basic-quaternion/position
+    identifier: "/req/basic-quaternion/position"
     statement: |
       The `Basic_Quaternion.position` attribute shall represent the outer frame,
       specified by an implicit WGS-84 CRS and an implicit EPSG 4461-CS (LTP-ENU)
       coordinate system and explicit parameters to define the tangent point.
-
+    obligation: requirement
   - name: Expression of inner frame
-    identifier: /req/basic-quaternion/quaternion
+    identifier: "/req/basic-quaternion/quaternion"
     statement: |
       The `Basic_Quaternion.quaternion` attribute shall represent the inner
       frame, which shall be a rotation-only transformation using a unit
@@ -32,3 +30,4 @@ normative_statements_classes:
       quaternion shall be applied to an initial reference frame oriented
       East-North-Up (ENU) coordinate system where the coordinate axes East,
       North, and Up correspond to the axes X, Y, Z.
+    obligation: requirement

data/spec/fixtures/basic-ypr-json-rc.yaml

@@ -1,21 +1,18 @@
 ---
 normative_statements_classes:
 - name: JSON encoding of Basic-YPR SDU
-  identifier: /req/basic-ypr-encoding-json
-  description: |
-    Requirements for the JSON encoding of a Basic-YPR SDU.
+  identifier: "/req/basic-ypr-encoding-json"
+  description: 'Requirements for the JSON encoding of a Basic-YPR SDU.'
   implements:
-  - /req/basic-ypr
-
+  - "/req/basic-ypr"
   normative_statements:
-
   - name: Specification as JSON schema
-    identifier: /req/basic-ypr-encoding-json/definition
+    identifier: "/req/basic-ypr-encoding-json/definition"
     statement: |
       A JSON-encoded Basic-YPR GeoPose SHALL conform to the Basic-YPR
       JSON-Schema 2019-9 definition (<<basic_ypr_json_schema>>).
-
     guidance:
     - |
       This JSON encoding is extensible because the JSON-Schema
       "additionalProperties" property is set to the default value of *true*.
+    obligation: requirement

data/spec/fixtures/basic-ypr-rc.yaml

@@ -1,25 +1,24 @@
 ---
 normative_statements_classes:
 - name: Basic-YPR logical model SDU
-  identifier: /req/basic-ypr
+  identifier: "/req/basic-ypr"
   description: |
     The Basic-YPR Target has a simple structure with no options. Position is
     specified as a point in an LTP-ENU frame and rotation is specified by yaw,
     pitch, and roll angles specified in decimal degrees.
   dependencies:
-  - /req/global
-  - /req/tangent-point
+  - "/req/global"
+  - "/req/tangent-point"
   normative_statements:
-
   - name: Expression of outer frame
-    identifier: /req/basic-ypr/position
+    identifier: "/req/basic-ypr/position"
     statement: |
       The `Basic_YPR.position` attribute shall represent the outer frame,
       specified by an implicit WGS-84 CRS and an implicit EPSG 4461-CS (LTP-ENU)
       coordinate system and explicit parameters to define the tangent point.
-
+    obligation: requirement
   - name: Expression of inner frame
-    identifier: /req/basic-ypr/angles
+    identifier: "/req/basic-ypr/angles"
     statement: |
       The `Basic_YPR.angles` attribute shall represent the inner frame,
       which is a rotation-only transformation with Yaw, Pitch, and Roll (YPR)
@@ -30,3 +29,4 @@ normative_statements_classes:
       x, applied in that order, corresponding to the conventional Yaw, Pitch,
       and Roll angles. The unit of measure SHALL be the degree and the angles
       represented as signed real number values.
+    obligation: requirement

data/spec/fixtures/chain-json-rc.yaml

@@ -1,16 +1,13 @@
 ---
 normative_statements_classes:
 - name: JSON encoding of Chain SDU
-  identifier: /req/chain-encoding-json
-  description: |
-    Requirements for the JSON encoding of a Chain SDU.
+  identifier: "/req/chain-encoding-json"
+  description: 'Requirements for the JSON encoding of a Chain SDU.'
   implements:
-  - /req/chain
-
+  - "/req/chain"
   normative_statements:
-
   - name: Specification as JSON schema
-    identifier: /req/chain-encoding-json/definition
+    identifier: "/req/chain-encoding-json/definition"
     statement: |
       A JSON-encoded GeoPose Chain SHALL conform to the GeoPose Chain
       JSON-Schema 2019-9 definition (<<chain_json_schema>>).
@@ -18,3 +15,4 @@ normative_statements_classes:
     - |
       This JSON encoding is extensible because the JSON-Schema
       "additionalProperties" property is set to the default value of *true*.
+    obligation: requirement

data/spec/fixtures/chain-rc.yaml

@@ -1,36 +1,34 @@
 ---
 normative_statements_classes:
 - name: Chain logical model SDU
-  identifier: /req/chain
+  identifier: "/req/chain"
   description: |
     The Chain Target supports relationships between a linear sequence of pose
     relationships. The first frame in the sequence must be an Outer Frame.
-
   dependencies:
-  - /req/global
-  - /req/frame-spec
-  - /req/time
-
+  - "/req/global"
+  - "/req/frame-spec"
+  - "/req/time"
   normative_statements:
-
   - name: Expression of valid time as GeoPose_Instant
-    identifier: /req/chain/valid-time
+    identifier: "/req/chain/valid-time"
     dependencies:
-    - /req/time/instant
+    - "/req/time/instant"
     statement: |
       The `Chain.validTime` attribute shall be represented by a
       `GeoPose_Instant` object.
-
+    obligation: requirement
   - name: Specification of initial frame
-    identifier: /req/chain/initial-frame
+    identifier: "/req/chain/initial-frame"
     statement: |
       The `Chain.outerFrame` attribute shall represent the first frame in the
       sequence with the `ExplicitFrameSpec` object.
-
+    obligation: requirement
   - name: Chain of frame specifications
-    identifier: /req/chain/frame-chain
+    identifier: "/req/chain/frame-chain"
     statement: |
       The `Chain.frameChain` attribute shall represent a list of explicit
       frame specifications with an array of `ExplicitFrameSpec` objects.
       Each index value shall be a distinct integer value between 0 and one less
       than the number of elements in the frameChain property.
+    obligation: requirement