modspec 0.1.4 → 0.2.1

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

data/spec/fixtures/global-rc.yaml

@@ -1,23 +1,26 @@
 ---
 normative_statements_classes:
 - name: Global SDU requirements
-  identifier: /req/global
+  identifier: "/req/global"
   description: Global requirements apply to all SDUs and Standardization Targets.
   normative_statements:
   - name: Individual standardization targets are independent
-    identifier: /req/global/target-independence
+    identifier: "/req/global/target-independence"
     statement: |
       There shall be no dependency between or among the individual
       Standardization Targets.
+    obligation: requirement
   - name: Implementation conforms to the logical model
-    identifier: /req/global/logical-model
+    identifier: "/req/global/logical-model"
     statement: |
       Implementations of concrete data conforming to this standard SHALL
       conform to all dependent or inherited classes, attributes, and
       associations, multiplicities, and data types in the Logical Model.
+    obligation: requirement
   - name: SDU conforms to the "Structural Data Unit - SDU" stereotype
-    identifier: /req/global/sdu
+    identifier: "/req/global/sdu"
     statement: |
       Implementations using encoded SDUs SHALL conform to the logical
       description of the Logical Model elements with the
       "Structural Data Unit - SDU" stereotype.
+    obligation: requirement

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

@@ -1,16 +1,13 @@
 ---
 normative_statements_classes:
 - name: JSON encoding of Graph SDU
-  identifier: /req/graph-encoding-json
-  description: |
-    Requirements for the JSON encoding of a Graph SDU.
+  identifier: "/req/graph-encoding-json"
+  description: 'Requirements for the JSON encoding of a Graph SDU.'
   implements:
-  - /req/graph
-
+  - "/req/graph"
   normative_statements:
-
   - name: Specification as JSON schema
-    identifier: /req/graph-encoding-json/definition
+    identifier: "/req/graph-encoding-json/definition"
     statement: |
       A JSON-encoded GeoPose Graph SHALL conform to the GeoPose Chain
       JSON-Schema 2019-9 definition (<<graph_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/graph-rc.yaml

@@ -1,38 +1,36 @@
 ---
 normative_statements_classes:
 - name: Graph logical model SDU
-  identifier: /req/graph
+  identifier: "/req/graph"
   description: |
     The Graph Target supports a network of object relative poses. The graph is a
     directed acyclic graph, each node must either be an Extrinsic Frame or
     reachable from an Extrinsic 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/graph/valid-time
+    identifier: "/req/graph/valid-time"
     dependencies:
-    - /req/time/instant
+    - "/req/time/instant"
     statement: |
       The `Graph.validTime` attribute shall be represented by a
       `GeoPose_Instant` object.
-
+    obligation: requirement
   - name: List of frame specifications
-    identifier: /req/graph/frame-list
+    identifier: "/req/graph/frame-list"
     statement: |
       The `Graph.frameList` attribute shall represent a list of explicit
       frame specifications with an array of `ExplicitFrameSpec` objects.
-
+    obligation: requirement
   - name: Transforms for frame specification list
-    identifier: /req/graph/transform-list
+    identifier: "/req/graph/transform-list"
     statement: |
       The `Graph.transformList` attribute shall have a value of type
       `FrameTransformIndexPair`.
       Each index value in a `FrameListTransformPair` SHALL be a distinct integer
       value between 0 and one less than the number of elements in the
       `frameList` property.
+    obligation: requirement

data/spec/fixtures/series-irregular-json-rc.yaml

@@ -1,16 +1,13 @@
 ---
 normative_statements_classes:
 - name: JSON encoding of Irregular Series SDU
-  identifier: /req/series-irregular-encoding-json
-  description: |
-    Requirements for the JSON encoding of a Irregular Series SDU.
+  identifier: "/req/series-irregular-encoding-json"
+  description: 'Requirements for the JSON encoding of a Irregular Series SDU.'
   implements:
-  - /req/series-irregular
-
+  - "/req/series-irregular"
   normative_statements:
-
   - name: Specification as JSON schema
-    identifier: /req/series-irregular-encoding-json/definition
+    identifier: "/req/series-irregular-encoding-json/definition"
     statement: |
       A JSON-encoded GeoPose Irregular Series SHALL conform to the GeoPose Chain
       JSON-Schema 2019-9 definition (<<irregular_series_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/series-irregular-rc.yaml

@@ -1,41 +1,39 @@
 ---
 normative_statements_classes:
 - name: Irregular_Series logical model SDU
-  identifier: /req/series-irregular
+  identifier: "/req/series-irregular"
   description: |
     The Irregular_Series Target represents the time evolution of a single
     GeoPose, with a variable time duration between successive inner frames.
-
   dependencies:
-  - /req/global
-  - /req/frame-spec
-  - /req/time
-
+  - "/req/global"
+  - "/req/frame-spec"
+  - "/req/time"
   normative_statements:
-
   - name: Expression of inner frames and time series
-    identifier: /req/series-irregular/inner-frame-and-time
+    identifier: "/req/series-irregular/inner-frame-and-time"
     dependencies:
-    - /req/time/instant
+    - "/req/time/instant"
     statement: |
       The `Irregular_Series.innerFrameAndTime` attribute SHALL be implemented as
       an array of `FrameAndTimeElement` objects, each of which is a pair of
       `ExplicitFrameSpec` and `GeoPoseInstant` objects.
-
+    obligation: requirement
   - name: Expression of outer frame
-    identifier: /req/series-irregular/outer-frame
+    identifier: "/req/series-irregular/outer-frame"
     statement: |
       The `Irregular_Series.outerFrame` attribute shall represent the first
       frame in the series expressed by the `innerFrameAndTime` attribute.
-
+    obligation: requirement
   - name: Expression of series header
-    identifier: /req/series-irregular/header
+    identifier: "/req/series-irregular/header"
     statement: |
       The `Irregular_Series.header` attribute shall be implemented as an instance
       of SeriesHeader.
-
+    obligation: requirement
   - name: Expression of series trailer
-    identifier: /req/series-irregular/trailer
+    identifier: "/req/series-irregular/trailer"
     statement: |
       The `Irregular_Series.trailer` attribute shall be implemented as an instance
       of SeriesTrailer.
+    obligation: requirement

data/spec/fixtures/series-regular-json-rc.yaml

@@ -1,16 +1,13 @@
 ---
 normative_statements_classes:
 - name: JSON encoding of Regular Series SDU
-  identifier: /req/series-regular-encoding-json
-  description: |
-    Requirements for the JSON encoding of a Regular Series SDU.
+  identifier: "/req/series-regular-encoding-json"
+  description: 'Requirements for the JSON encoding of a Regular Series SDU.'
   implements:
-  - /req/series-regular
-
+  - "/req/series-regular"
   normative_statements:
-
   - name: Specification as JSON schema
-    identifier: /req/series-regular-encoding-json/definition
+    identifier: "/req/series-regular-encoding-json/definition"
     statement: |
       A JSON-encoded GeoPose Regular Series SHALL conform to the GeoPose Chain
       JSON-Schema 2019-9 definition (<<regular_series_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/series-regular-rc.yaml

@@ -1,46 +1,44 @@
 ---
 normative_statements_classes:
 - name: Regular_Series logical model SDU
-  identifier: /req/series-regular
+  identifier: "/req/series-regular"
   description: |
     The Regular_Series Target represents the time evolution of a single GeoPose,
     with a constant time duration between successive inner frames.
-
   dependencies:
-  - /req/global
-  - /req/frame-spec
-  - /req/time
-
+  - "/req/global"
+  - "/req/frame-spec"
+  - "/req/time"
   normative_statements:
-
   - name: Expression of duration as GeoPose_Duration
-    identifier: /req/series-regular/duration
+    identifier: "/req/series-regular/duration"
     dependencies:
-    - /req/time/duration
+    - "/req/time/duration"
     statement: |
       The `Regular_Series.interPoseDuration` attribute shall be represented by
       an instance of the `GeoPose_Duration` object.
-
+    obligation: requirement
   - name: Expression of outer frame
-    identifier: /req/series-regular/outer-frame
+    identifier: "/req/series-regular/outer-frame"
     statement: |
       The `Regular_Series.outerFrame` attribute shall represent the first frame
       in the series with the `ExplicitFrameSpec` object.
-
+    obligation: requirement
   - name: Expression of inner frames
-    identifier: /req/series-regular/inner-frame-series
+    identifier: "/req/series-regular/inner-frame-series"
     statement: |
       The `Regular_Series.innerFrameSeries` attribute shall represent the
       succession of inner frames as an array of `ExplicitFrameSpec` objects.
-
+    obligation: requirement
   - name: Expression of series header
-    identifier: /req/series-regular/header
+    identifier: "/req/series-regular/header"
     statement: |
       The `Regular_Series.header` attribute shall be implemented as an instance
       of SeriesHeader.
-
+    obligation: requirement
   - name: Expression of series trailer
-    identifier: /req/series-regular/trailer
+    identifier: "/req/series-regular/trailer"
     statement: |
       The `Regular_Series.trailer` attribute shall be implemented as an instance
       of SeriesTrailer.
+    obligation: requirement

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

@@ -1,22 +1,19 @@
 ---
 normative_statements_classes:
 - name: JSON encoding of Stream SDUs
-  identifier: /req/stream-encoding-json
-  description: |
-    Requirements for the JSON encoding of Stream SDUs.
+  identifier: "/req/stream-encoding-json"
+  description: 'Requirements for the JSON encoding of Stream SDUs.'
   implements:
-  - /req/stream
-
+  - "/req/stream"
   normative_statements:
-
   - name: Stream Element specification as JSON schema
-    identifier: /req/stream-encoding-json/element
+    identifier: "/req/stream-encoding-json/element"
     statement: |
       A JSON-encoded GeoPose Stream Element SHALL conform to the GeoPose Stream Element
       JSON-Schema 2019-9 definition (<<streamelement_json_schema>>).
-
+    obligation: requirement
   - name: Stream Header specification as JSON schema
-    identifier: /req/stream-encoding-json/header
+    identifier: "/req/stream-encoding-json/header"
     statement: |
       A JSON-encoded GeoPose Stream Element SHALL conform to the GeoPose Stream Header
       JSON-Schema 2019-9 definition (<<streamheader_json_schema>>).
@@ -24,9 +21,10 @@ normative_statements_classes:
     - |
       This JSON encoding is extensible because the JSON-Schema
       "additionalProperties" property is set to the default value of *true*.
-
+    obligation: requirement
   - name: Stream Record specification as JSON schema
-    identifier: /req/stream-encoding-json/record
+    identifier: "/req/stream-encoding-json/record"
     statement: |
       A JSON-encoded GeoPose Stream Record (a recorded Stream) SHALL conform to the GeoPose Stream Record
       JSON-Schema 2019-9 definition (<<streamrecord_json_schema>>).
+    obligation: requirement

data/spec/fixtures/stream-rc.yaml

@@ -1,36 +1,34 @@
 ---
 normative_statements_classes:
 - name: StreamHeader and StreamElement logical model SDUs
-  identifier: /req/stream
+  identifier: "/req/stream"
   description: |
     The Stream target supports a network of object relative poses. The graph is a
     directed acyclic graph, each node must either be an Extrinsic Frame or
     reachable from an Extrinsic Frame.
-
   dependencies:
-  - /req/global
-  - /req/frame-spec
-
+  - "/req/global"
+  - "/req/frame-spec"
   normative_statements:
-
   - name: Expression of outer frame in StreamHeader
-    identifier: /req/stream/header-initial-frame
+    identifier: "/req/stream/header-initial-frame"
     statement: |
       The `StreamHeader.outerFrame` attribute shall represent the initial frame
       of the stream with a value that is an instant of the `ExplicitFrameSpec`
       object.
-
+    obligation: requirement
   - name: Expression of transition model in StreamHeader
-    identifier: /req/stream/header-transition-model
+    identifier: "/req/stream/header-transition-model"
     statement: |
       The `StreamHeader.transitionModel` attribute shall have a value that is
       an instance of the `TransitionModel` enumeration.
-
+    obligation: requirement
   - name: Expression of stream elements in StreamElement
-    identifier: /req/stream/element
+    identifier: "/req/stream/element"
     dependencies:
-    - /req/time/instant
+    - "/req/time/instant"
     statement: |
       The `StreamElement.streamElement` attribute shall be implemented as an
       array of `FrameAndTimeElement` objects, each of which is a pair of
       `ExplicitFrameSpec` and `GeoPoseInstant` objects.
+    obligation: requirement

data/spec/fixtures/tangent-point-rc.yaml

@@ -1,38 +1,37 @@
 ---
 normative_statements_classes:
 - name: Tangent point requirements
-  identifier: /req/tangent-point
-  description: |
-    Common tangent point requirements for SDUs that include tangent points.
-  guidance: |
+  identifier: "/req/tangent-point"
+  description: 'Common tangent point requirements for SDUs that include tangent points.'
+  guidance:
+  - |-
     The tangent plane `longitude`, `latitude`, and `h` parameters are
     specified without any conditions or constraints on precision to be used in
     an implementation. Any such constraints would be found as requirements on a
     specific implementation as an encoding.
-
   normative_statements:
-
   - name: Tangent point height value specification
-    identifier: /req/tangent-point/height
+    identifier: "/req/tangent-point/height"
     statement: |
       An instance of a GeoPose `tangentPoint.h` attribute SHALL be expressed as
       a height in meters above the WGS-84 ellipsoid, represented as a signed as
       a signed floating point value conforming to IEEE 754. If the tangent point
       is above the WGS-84 ellipsoid, the value SHALL be positive. If the tangent
       point is below the WGS-84 ellipsoid, the value SHALL be negative.
-
+    obligation: requirement
   - name: Tangent point latitude value specification
-    identifier: /req/tangent-point/latitude
+    identifier: "/req/tangent-point/latitude"
     statement: |
       An instance of GeoPose tangentPoint.latitude attribute SHALL be expressed
       as decimal degrees and represented as a signed floating point
       value conforming to IEEE 754.. The minimum value shall be 90.0 degrees
       and the maximum value shall be 90.0 degrees.
-
+    obligation: requirement
   - name: Tangent point longitude value specification
-    identifier: /req/tangent-point/longitude
+    identifier: "/req/tangent-point/longitude"
     statement: |
       An instance of a GeoPose tangentPoint.longitude attribute SHALL be
       expressed as decimal degrees and represented as a signed floating point
       value conforming to IEEE 754. The minimum value shall be -180.0 degrees
       and the maximum value shall be 180.0 degrees.
+    obligation: requirement

data/spec/fixtures/time-rc.yaml

@@ -1,20 +1,18 @@
 ---
 normative_statements_classes:
 - name: Time specification requirements
-  identifier: /req/time
-  description: |
-    Requirements on GeoPose time-related objects.
-
+  identifier: "/req/time"
+  description: 'Requirements on GeoPose time-related objects.'
   normative_statements:
-
   - name: Implementation of GeoPose_Instant
-    identifier: /req/time/instant
+    identifier: "/req/time/instant"
     statement: |
       The `GeoPose_Instant` object shall express Unix Time in seconds multiplied
       by 1,000, with the unit of measure in milliseconds.
-
+    obligation: requirement
   - name: Implementation of GeoPose_Duration
-    identifier: /req/time/duration
+    identifier: "/req/time/duration"
     statement: |
       The `GeoPose_Duration` object shall express time in seconds multiplied by
       1,000, with the unit of measure in milliseconds.
+    obligation: requirement

data/spec/modspec/conformance_class_spec.rb

@@ -11,19 +11,19 @@ RSpec.describe Modspec::ConformanceClass do
         Modspec::NormativeStatement.new(
           identifier: "/req/basic-ypr/position",
           name: "Expression of outer frame",
-          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."
+          statement: "The `Basic_YPR.position` attribute shall represent the outer frame.",
         ),
         Modspec::NormativeStatement.new(
           identifier: "/req/basic-ypr/angles",
           name: "Expression of inner frame",
-          statement: "The `Basic_YPR.angles` attribute shall represent the inner frame, which is a rotation-only transformation with Yaw, Pitch, and Roll (YPR) angles."
-        )
-      ]
+          statement: "The `Basic_YPR.angles` attribute shall represent the inner frame.",
+        ),
+      ],
     )
   end
 
   let(:conformance_class) do
-    Modspec::ConformanceClass.new(
+    described_class.new(
       identifier: "/conf/basic-ypr",
       name: "Basic-YPR logical model SDU conformance",
       target: ["/req/basic-ypr"],
@@ -35,19 +35,19 @@ RSpec.describe Modspec::ConformanceClass do
           identifier: "/conf/basic-ypr/position",
           name: "Verify expression of outer frame",
           targets: ["/req/basic-ypr/position"],
-          description: "To confirm that an implementation of a Basic-YPR consists of an 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.",
+          description: "To confirm outer frame.",
           purpose: "Verify that this requirement is satisfied.",
-          method: "Inspection"
+          test_method: "Inspection",
         ),
         Modspec::ConformanceTest.new(
           identifier: "/conf/basic-ypr/angles",
           name: "Verify expression of inner frame",
           targets: ["/req/basic-ypr/angles"],
-          description: "To confirm that the Inner Frame is expressed as a rotation-only transformation using Yaw, Pitch, and Roll angles.",
+          description: "To confirm inner frame.",
           purpose: "Verify that this requirement is satisfied.",
-          method: "Inspection"
-        )
-      ]
+          test_method: "Inspection",
+        ),
+      ],
     )
   end
 
@@ -59,9 +59,9 @@ RSpec.describe Modspec::ConformanceClass do
         Modspec::NormativeStatement.new(
           identifier: "/req/global/sdu",
           name: "SDU conformance",
-          statement: "SDUs shall conform to the logical model."
-        )
-      ]
+          statement: "SDUs shall conform to the logical model.",
+        ),
+      ],
     )
   end
 
@@ -73,14 +73,14 @@ RSpec.describe Modspec::ConformanceClass do
         Modspec::NormativeStatement.new(
           identifier: "/req/tangent-point/height",
           name: "Tangent point height",
-          statement: "Tangent point height shall be specified."
-        )
-      ]
+          statement: "Tangent point height shall be specified.",
+        ),
+      ],
     )
   end
 
   let(:global_conf_class) do
-    Modspec::ConformanceClass.new(
+    described_class.new(
       identifier: "/conf/global",
       name: "Global conformance",
       tests: [
@@ -88,16 +88,16 @@ RSpec.describe Modspec::ConformanceClass do
           identifier: "/conf/global/sdu",
           name: "Verify SDU conformance",
           targets: ["/req/global/sdu"],
-          description: "To confirm that an implementation of an SDU conforms to the logical model.",
+          description: "To confirm SDU conformance.",
           purpose: "Verify that this requirement is satisfied.",
-          method: "Inspection"
-        )
-      ]
+          test_method: "Inspection",
+        ),
+      ],
     )
   end
 
   let(:tangent_point_conf_class) do
-    Modspec::ConformanceClass.new(
+    described_class.new(
       identifier: "/conf/tangent-point",
       name: "Tangent point conformance",
       tests: [
@@ -105,19 +105,20 @@ RSpec.describe Modspec::ConformanceClass do
           identifier: "/conf/tangent-point/height",
           name: "Verify tangent point height",
           targets: ["/req/tangent-point/height"],
-          description: "To confirm that an implementation of a Tangent Point specifies the height of the Tangent Point.",
+          description: "To confirm tangent point height.",
           purpose: "Verify that this requirement is satisfied.",
-          method: "Inspection"
-        )
-
-      ]
+          test_method: "Inspection",
+        ),
+      ],
     )
   end
 
   let(:suite) do
     suite = Modspec::Suite.new
-    suite.conformance_classes = [conformance_class, global_conf_class, tangent_point_conf_class]
-    suite.normative_statements_classes = [normative_statements_class, global_class, tangent_point_class]
+    suite.conformance_classes = [conformance_class, global_conf_class,
+                                 tangent_point_conf_class]
+    suite.normative_statements_classes = [normative_statements_class,
+                                          global_class, tangent_point_class]
     suite.setup_relationships
     suite
   end
@@ -138,17 +139,25 @@ RSpec.describe Modspec::ConformanceClass do
   describe "#validate" do
     it "returns no errors for a valid conformance class" do
       errors = suite.validate
-      if errors.any?
-        puts "Validation errors:"
-        errors.each { |error| puts "  #{error}" }
-      end
       expect(errors).to be_empty
     end
 
     it "returns errors if there are no conformance tests" do
       conformance_class.tests = []
       errors = conformance_class.validate
-      expect(errors).not_to be_empty
+      expect(errors).to include(a_string_matching(/no child conformance tests/))
+    end
+
+    it "returns errors if test identifier does not share prefix" do
+      conformance_class.tests = [
+        Modspec::ConformanceTest.new(
+          identifier: "/conf/other/test",
+          name: "Mismatched test",
+          targets: ["/req/basic-ypr/position"],
+        ),
+      ]
+      errors = conformance_class.validate
+      expect(errors).to include(a_string_matching(/does not share the expected prefix/))
     end
   end
 end