modspec 0.1.3 → 0.2.0

data/lib/modspec/suite.rb

@@ -6,40 +6,57 @@ 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
 
     def validate
       setup_relationships
       self.all_identifiers = nil
-      errors = super()
+      errors = super
       errors.concat(validate_cycles)
       errors.concat(validate_label_uniqueness)
       errors.concat(validate_dependencies)
-      errors.concat(normative_statements_classes.flat_map { |n| n.validate(self) })
-      errors.concat(conformance_classes.flat_map(&:validate))
+      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
-      combined_suite.normative_statements_classes += other_suite.normative_statements_classes
-      combined_suite.conformance_classes += other_suite.conformance_classes
+      if other_suite.normative_statements_classes
+        combined_suite.normative_statements_classes ||= []
+        combined_suite.normative_statements_classes += other_suite.normative_statements_classes
+      end
+
+      if other_suite.conformance_classes
+        combined_suite.conformance_classes ||= []
+        combined_suite.conformance_classes += other_suite.conformance_classes
+      end
 
       # Ensure uniqueness of identifiers
-      combined_suite.normative_statements_classes.uniq!(&:identifier)
-      combined_suite.conformance_classes.uniq!(&:identifier)
+      combined_suite.normative_statements_classes&.uniq!(&:identifier)
+
+      combined_suite.conformance_classes&.uniq!(&:identifier)
 
       combined_suite.name = "#{name} + #{other_suite.name}"
 
@@ -47,17 +64,24 @@ module Modspec
     end
 
     def all_identifiers
-      @all_identifiers ||= (normative_statements_classes.flat_map(&:normative_statements) +
-                            conformance_classes.flat_map(&:tests) +
-                            normative_statements_classes +
-                            conformance_classes).map(&:identifier)
+      return @all_identifiers if @all_identifiers
+
+      nsc = normative_statements_classes || []
+      cc = conformance_classes || []
+
+      @all_identifiers = (nsc.flat_map(&:normative_statements) +
+              cc.flat_map(&:tests) +
+              nsc +
+              cc).map(&:identifier)
     end
 
     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)
@@ -71,12 +95,18 @@ module Modspec
     end
 
     def setup_relationships
-      all_requirements = normative_statements_classes.flat_map(&:normative_statements)
+      all_requirements = if normative_statements_classes
+                           normative_statements_classes.flat_map(&:normative_statements)
+                         else
+                           []
+                         end
+
+      return unless conformance_classes
 
       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)
+            Array(ct.targets).map(&:to_s).include?(r.identifier.to_s)
           end
           ct.parent_class = cc
         end
@@ -86,8 +116,12 @@ module Modspec
     private
 
     def resolve_conflicts_for(self_collection, other_collection)
+      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)
@@ -112,21 +146,40 @@ 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
+    # This includes both normative statements and conformance tests
+    def all_statements
+      nsc = if normative_statements_classes
+              normative_statements_classes.flat_map(&:normative_statements)
+            else
+              []
+            end
+      cc = if conformance_classes
+             conformance_classes.flat_map(&:tests)
+           else
+             []
+           end
+
+      nsc + cc
     end
 
     def build_dependency_graph
       graph = {}
-      all_statements = normative_statements_classes.flat_map(&:normative_statements) +
-                       conformance_classes.flat_map(&:tests)
 
       all_statements.each do |statement|
         id = statement.identifier.to_s
         graph[id] = Set.new
-        graph[id].merge(statement.dependencies.map(&:to_s)) if statement.respond_to?(:dependencies)
-        graph[id].merge(statement.indirect_dependency.map(&:to_s)) if statement.respond_to?(:indirect_dependency)
-        graph[id].merge(statement.implements.map(&:to_s)) if statement.respond_to?(:implements)
-        graph[id].merge(statement.targets.map(&:to_s)) if statement.respond_to?(:targets)
+
+        # 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?
+        end
       end
 
       graph
@@ -156,7 +209,8 @@ module Modspec
       if graph[node]
         graph[node].each do |neighbor|
           if !visited.include?(neighbor)
-            cycle = detect_cycle_util(neighbor, graph, visited, recursion_stack, path)
+            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]
@@ -175,8 +229,6 @@ module Modspec
     def validate_label_uniqueness
       labels = {}
       errors = []
-      all_statements = normative_statements_classes.flat_map(&:normative_statements) +
-                       conformance_classes.flat_map(&:tests)
       all_statements.each do |statement|
         if labels[statement.identifier]
           errors << "Duplicate identifier found: #{statement.identifier}"
@@ -191,14 +243,14 @@ module Modspec
       all_identifiers = collect_all_identifiers
 
       errors = []
-      normative_statements_classes.each do |nsc|
+      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
       end
 
-      conformance_classes.each do |cc|
+      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))
@@ -211,14 +263,14 @@ module Modspec
     def collect_all_identifiers
       identifiers = {}
 
-      normative_statements_classes.each do |nsc|
+      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
 
-      conformance_classes.each do |cc|
+      conformance_classes&.each do |cc|
         identifiers[cc.identifier.to_s] = cc
         cc.tests.each do |ct|
           identifiers[ct.identifier.to_s] = ct

data/lib/modspec/version.rb

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

data/lib/modspec.rb

@@ -2,6 +2,7 @@
 
 require_relative "modspec/version"
 require "lutaml/model"
+require "set"
 
 module Modspec
   class Error < StandardError; end
@@ -15,15 +16,3 @@ 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
-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.6"
+  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

data/spec/fixtures/frame-spec-rc.yaml

@@ -1,27 +1,27 @@
 ---
 normative_statements_classes:
 - name: Frame specification requirements
-  identifier: /req/frame-spec
-  description: |
-    Common frame specification requirements for SDUs that include frames.
+  identifier: "/req/frame-spec"
+  description: 'Common frame specification requirements for SDUs that include frames.'
   normative_statements:
-
-  - name: Frame specification authority uniquely specifies source of reference frame specification
-    identifier: /req/frame-spec/authority
+  - name: Frame specification authority uniquely specifies source of reference frame
+      specification
+    identifier: "/req/frame-spec/authority"
     statement: |
       The FrameSpecification.authority attribute SHALL contain a string uniquely
       specifying a source of reference frame specifications.
-
+    obligation: requirement
   - name: Frame specification ID uniquely defines frame within authority
-    identifier: /req/frame-spec/id
+    identifier: "/req/frame-spec/id"
     statement: |
       The FrameSpecification.ID attribute SHALL be a string uniquely defining a
       frame within the authority.
-
+    obligation: requirement
   - name: Frame specification parameter contains all parameters needed
-    identifier: /req/frame-spec/parameters
+    identifier: "/req/frame-spec/parameters"
     statement: |
       The FrameSpecification.parameter attribute SHALL contain all parameters
       needed for the corresponding authority and ID.
     guidance:
     - The definition of these parameters is outside the scope of GeoPose.
+    obligation: requirement