modspec 0.1.0 → 0.1.1

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

@@ -0,0 +1,32 @@
+---
+normative_statements_classes:
+- name: JSON encoding of Stream SDUs
+  identifier: /req/stream-encoding-json
+  description: |
+    Requirements for the JSON encoding of Stream SDUs.
+  implements:
+  - /req/stream
+
+  normative_statements:
+
+  - name: Stream Element specification as JSON schema
+    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>>).
+
+  - name: Stream Header specification as JSON schema
+    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>>).
+    guidance:
+    - |
+      This JSON encoding is extensible because the JSON-Schema
+      "additionalProperties" property is set to the default value of *true*.
+
+  - name: Stream Record specification as JSON schema
+    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>>).

data/spec/fixtures/stream-rc.yaml

@@ -0,0 +1,36 @@
+---
+normative_statements_classes:
+- name: StreamHeader and StreamElement logical model SDUs
+  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
+
+  normative_statements:
+
+  - name: Expression of outer frame in StreamHeader
+    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.
+
+  - name: Expression of transition model in StreamHeader
+    identifier: /req/stream/header-transition-model
+    statement: |
+      The `StreamHeader.transitionModel` attribute shall have a value that is
+      an instance of the `TransitionModel` enumeration.
+
+  - name: Expression of stream elements in StreamElement
+    identifier: /req/stream/element
+    dependencies:
+    - /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.

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

@@ -0,0 +1,43 @@
+---
+conformance_classes:
+- name: Tangent point conformance
+  identifier: /conf/tangent-point
+  target:
+  - /req/tangent-point
+  classification: "Target Type: SDU"
+  description: Conformance with tangent point requirements
+
+  tests:
+  - name: Verify tangent point height value meets specification
+    identifier: /conf/tangent-point/height
+    targets:
+    - /req/tangent-point/height
+    description: |
+      To confirm that a GeoPose `tangentPoint.h` attribute is expressed as a
+      height in meters above the WGS-84 ellipsoid and represented as a signed
+      real number.
+    purpose: |
+      Verify that this requirement is satisfied.
+    method: Inspection
+
+  - name: Verify tangent point latitude value meets specification
+    identifier: /conf/tangent-point/latitude
+    targets:
+    - /req/tangent-point/latitude
+    description: |
+      To confirm that a GeoPose `tangentPoint.latitude` attribute is expressed
+      as an angle in decimal degrees.
+    purpose: |
+      Verify that this requirement is satisfied
+    method: Inspection
+
+  - name: Verify tangent point longitude value meets specification
+    identifier: /conf/tangent-point/longitude
+    targets:
+    - /req/tangent-point/longitude
+    description: |
+      To confirm that a GeoPose `tangentPoint.longitude` attribute is expressed
+      as an angle in decimal degrees.
+    purpose: |
+      Verify that this requirement is satisfied
+    method: Inspection

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

@@ -0,0 +1,38 @@
+---
+normative_statements_classes:
+- name: Tangent point requirements
+  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
+    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.
+
+  - name: Tangent point latitude value specification
+    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.
+
+  - name: Tangent point longitude value specification
+    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.

data/spec/fixtures/time-cc.yaml

@@ -0,0 +1,32 @@
+---
+conformance_classes:
+- name: Time specification requirements
+  identifier: /conf/time
+  target:
+  - /req/time
+  description: Conformance with GeoPose time-related requirements
+
+  tests:
+  - name: Verify values of GeoPose_Instant
+    identifier: /conf/time/instant
+    targets:
+    - /req/time/instant
+    description: |
+      Verify that a `GeoPose_Instant` object expresses Unix time in seconds multiplied
+      by 1,000, with the unit of measure in milliseconds.
+    purpose: |
+      To confirm the correct properties of a GeoPose_Instant object.
+    method: Inspection
+
+  - name: Verify values of GeoPose_Duration
+    identifier: /conf/time/duration
+    targets:
+    - /req/time/duration
+    description: |
+      Verify that a `GeoPose_Duration` object expresses time in seconds multiplied
+      by 1,000, with the unit of measure in milliseconds.
+    purpose: |
+      To confirm that a FrameSpecification.id attribute contains a string
+      uniquely specifying the identity of a reference frame specification as
+      defined by that authority.
+    method: Inspection

data/spec/fixtures/time-rc.yaml

@@ -0,0 +1,20 @@
+---
+normative_statements_classes:
+- name: Time specification requirements
+  identifier: /req/time
+  description: |
+    Requirements on GeoPose time-related objects.
+
+  normative_statements:
+
+  - name: Implementation of GeoPose_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.
+
+  - name: Implementation of GeoPose_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.

data/spec/modspec/conformance_class_spec.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+RSpec.describe Modspec::ConformanceClass do
+  let(:normative_statements_class) do
+    Modspec::NormativeStatementsClass.new(
+      identifier: "/req/basic-ypr",
+      name: "Basic-YPR logical model SDU",
+      description: "The Basic-YPR Target has a simple structure with no options.",
+      dependencies: ["/req/global", "/req/tangent-point"],
+      normative_statements: [
+        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."
+        ),
+        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."
+        )
+      ]
+    )
+  end
+
+  let(:conformance_class) do
+    Modspec::ConformanceClass.new(
+      identifier: "/conf/basic-ypr",
+      name: "Basic-YPR logical model SDU conformance",
+      target: ["/req/basic-ypr"],
+      classification: "Target Type: SDU",
+      description: "Conformance with Basic-YPR logical model SDU",
+      dependencies: ["/conf/global", "/conf/tangent-point"],
+      tests: [
+        Modspec::ConformanceTest.new(
+          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.",
+          purpose: "Verify that this requirement is satisfied.",
+          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.",
+          purpose: "Verify that this requirement is satisfied.",
+          method: "Inspection"
+        )
+      ]
+    )
+  end
+
+  let(:global_class) do
+    Modspec::NormativeStatementsClass.new(
+      identifier: "/req/global",
+      name: "Global requirements",
+      normative_statements: [
+        Modspec::NormativeStatement.new(
+          identifier: "/req/global/sdu",
+          name: "SDU conformance",
+          statement: "SDUs shall conform to the logical model."
+        )
+      ]
+    )
+  end
+
+  let(:tangent_point_class) do
+    Modspec::NormativeStatementsClass.new(
+      identifier: "/req/tangent-point",
+      name: "Tangent point requirements",
+      normative_statements: [
+        Modspec::NormativeStatement.new(
+          identifier: "/req/tangent-point/height",
+          name: "Tangent point height",
+          statement: "Tangent point height shall be specified."
+        )
+      ]
+    )
+  end
+
+  let(:global_conf_class) do
+    Modspec::ConformanceClass.new(
+      identifier: "/conf/global",
+      name: "Global conformance",
+      tests: [
+        Modspec::ConformanceTest.new(
+          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.",
+          purpose: "Verify that this requirement is satisfied.",
+          method: "Inspection"
+        )
+      ]
+    )
+  end
+
+  let(:tangent_point_conf_class) do
+    Modspec::ConformanceClass.new(
+      identifier: "/conf/tangent-point",
+      name: "Tangent point conformance",
+      tests: [
+        Modspec::ConformanceTest.new(
+          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.",
+          purpose: "Verify that this requirement is satisfied.",
+          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.setup_relationships
+    suite
+  end
+
+  it "has an identifier" do
+    expect(conformance_class.identifier).to eq("/conf/basic-ypr")
+  end
+
+  it "has a name" do
+    expect(conformance_class.name).to eq("Basic-YPR logical model SDU conformance")
+  end
+
+  it "has conformance tests" do
+    expect(conformance_class.tests).not_to be_empty
+    expect(conformance_class.tests.length).to eq(2)
+  end
+
+  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
+    end
+  end
+end

data/spec/modspec/conformance_test_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+RSpec.describe Modspec::ConformanceTest do
+  let(:normative_statement) 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."
+    )
+  end
+
+  let(:normative_statements_class) do
+    Modspec::NormativeStatementsClass.new(
+      identifier: "/req/basic-ypr",
+      name: "Basic-YPR logical model SDU",
+      normative_statements: [normative_statement]
+    )
+  end
+
+  let(:conformance_test) do
+    Modspec::ConformanceTest.new(
+      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.",
+      purpose: "Verify that this requirement is satisfied.",
+      method: "Inspection"
+    )
+  end
+
+  let(:conformance_class) do
+    Modspec::ConformanceClass.new(
+      identifier: "/conf/basic-ypr",
+      name: "Basic-YPR logical model SDU conformance",
+      tests: [conformance_test]
+    )
+  end
+
+  let(:suite) do
+    suite = Modspec::Suite.new
+    suite.normative_statements_classes = [normative_statements_class]
+    suite.conformance_classes = [conformance_class]
+    suite.setup_relationships
+    suite
+  end
+
+  before do
+    suite # Ensure the suite is created and relationships are set up
+  end
+
+  it "has an identifier" do
+    expect(conformance_test.identifier).to eq("/conf/basic-ypr/position")
+  end
+
+  it "has a description" do
+    expect(conformance_test.description).not_to be_nil
+  end
+
+  it "has targets" do
+    expect(conformance_test.targets).to eq(["/req/basic-ypr/position"])
+  end
+
+  describe "#validate" do
+    it "returns no errors for a valid conformance test" do
+      errors = conformance_test.validate
+      expect(errors).to be_empty
+    end
+  end
+  it "has a corresponding requirement" do
+    expect(conformance_test.corresponding_requirements).to include(normative_statement)
+  end
+
+  it "belongs to a conformance class" do
+    expect(conformance_test.parent_class).to eq(conformance_class)
+  end
+end

data/spec/modspec/normative_statement_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+RSpec.describe Modspec::NormativeStatement do
+  let(:global_sdu_statement) do
+    Modspec::NormativeStatement.new(
+      identifier: "/req/global/sdu",
+      name: "SDU conforms to the 'Structural Data Unit - SDU' stereotype",
+      statement: "Implementations using encoded SDUs SHALL conform to the logical description of the Logical Model elements with the 'Structural Data Unit - SDU' stereotype."
+    )
+  end
+
+  let(:tangent_point_statement) do
+    Modspec::NormativeStatement.new(
+      identifier: "/req/tangent-point",
+      name: "Tangent point requirements",
+      statement: "Common tangent point requirements for SDUs that include tangent points."
+    )
+  end
+
+  let(:normative_statement) 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.",
+      obligation: "requirement",
+      subject: "Basic_YPR.position",
+      inherit: ["/req/global/sdu"],
+      dependencies: ["/req/tangent-point"],
+      guidance: ["Ensure the coordinate system is correctly specified."]
+    )
+  end
+
+  let(:suite) do
+    suite = Modspec::Suite.new
+    global_class = Modspec::NormativeStatementsClass.new(
+      identifier: "/req/global",
+      normative_statements: [global_sdu_statement]
+    )
+    tangent_point_class = Modspec::NormativeStatementsClass.new(
+      identifier: "/req/tangent-point",
+      normative_statements: [tangent_point_statement]
+    )
+    basic_ypr_class = Modspec::NormativeStatementsClass.new(
+      identifier: "/req/basic-ypr",
+      normative_statements: [normative_statement]
+    )
+    suite.normative_statements_classes = [global_class, tangent_point_class, basic_ypr_class]
+    suite
+  end
+
+  it "has an identifier" do
+    expect(normative_statement.identifier).to eq("/req/basic-ypr/position")
+  end
+
+  it "has a name" do
+    expect(normative_statement.name).to eq("Expression of outer frame")
+  end
+
+  it "has a statement" do
+    expect(normative_statement.statement).not_to be_nil
+  end
+
+  it "has a valid obligation" do
+    expect(%w[requirement recommendation permission]).to include(normative_statement.obligation)
+  end
+
+  describe "#validate" do
+    it "returns no errors for a valid normative statement" do
+      errors = normative_statement.validate
+      expect(errors).to be_empty
+    end
+
+    it "returns errors for an invalid obligation" do
+      normative_statement.obligation = "invalid"
+      expect { normative_statement.validate! }.to raise_error(Lutaml::Model::ValidationError) do |error|
+        expect(error).to include(Lutaml::Model::InvalidValueError)
+        expect(error.error_messages).to include("obligation is `invalid`, must be one of the following [recommendation, permission, requirement]")
+      end
+    end
+  end
+end

data/spec/modspec/normative_statements_class_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+RSpec.describe Modspec::NormativeStatementsClass do
+  let(:normative_statement1) 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."
+    )
+  end
+
+  let(:normative_statement2) do
+    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."
+    )
+  end
+
+  let(:normative_statements_class) do
+    Modspec::NormativeStatementsClass.new(
+      identifier: "/req/basic-ypr",
+      name: "Basic-YPR logical model SDU",
+      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"],
+      normative_statements: [normative_statement1, normative_statement2]
+    )
+  end
+
+  let(:suite) do
+    suite = Modspec::Suite.new
+    suite.normative_statements_classes = [normative_statements_class]
+    suite
+  end
+
+  it "has an identifier" do
+    expect(normative_statements_class.identifier).to eq("/req/basic-ypr")
+  end
+
+  it "has a name" do
+    expect(normative_statements_class.name).to eq("Basic-YPR logical model SDU")
+  end
+
+  it "has normative statements" do
+    expect(normative_statements_class.normative_statements).not_to be_empty
+    expect(normative_statements_class.normative_statements.length).to eq(2)
+  end
+
+  describe "#validate" do
+    it "returns no errors for a valid normative statements class" do
+      errors = normative_statements_class.validate
+      expect(errors).to be_empty
+    end
+
+    it "returns errors if there are no normative statements" do
+      normative_statements_class.normative_statements = []
+      errors = normative_statements_class.validate
+      expect(errors).not_to be_empty
+    end
+  end
+end