modspec 0.1.0 → 0.1.2

data/spec/modspec/suite_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+RSpec.describe Modspec::Suite do
+  let(:rc_yaml) { File.read("spec/fixtures/basic-ypr-rc.yaml") }
+  let(:cc_yaml) { File.read("spec/fixtures/basic-ypr-cc.yaml") }
+
+  let(:global_rc) { File.read("spec/fixtures/global-rc.yaml") }
+  let(:tangent_point_rc) { File.read("spec/fixtures/tangent-point-rc.yaml") }
+  let(:time_rc) { File.read("spec/fixtures/time-rc.yaml") }
+  let(:frame_spec_rc) { File.read("spec/fixtures/frame-spec-rc.yaml") }
+
+  let(:global_suite) { Modspec::Suite.from_yaml(global_rc) }
+  let(:tangent_point_suite) { Modspec::Suite.from_yaml(tangent_point_rc) }
+  let(:time_suite) { Modspec::Suite.from_yaml(time_rc) }
+  let(:frame_spec_suite) { Modspec::Suite.from_yaml(frame_spec_rc) }
+
+  describe ".from_yaml" do
+    it "parses a requirements class YAML file" do
+      suite = described_class.from_yaml(rc_yaml)
+      expect(suite).to be_a(described_class)
+      expect(suite.normative_statements_classes).not_to be_empty
+    end
+
+    it "parses a conformance class YAML file" do
+      suite = described_class.from_yaml(cc_yaml)
+      expect(suite).to be_a(described_class)
+      expect(suite.conformance_classes).not_to be_empty
+    end
+  end
+
+  describe "#validate" do
+    it "returns no errors for a valid combined suite" do
+      base_suite = described_class.from_yaml(rc_yaml)
+      combined_suite = base_suite
+                       .combine(global_suite)
+                       .combine(tangent_point_suite)
+                       .combine(time_suite)
+                       .combine(frame_spec_suite)
+
+      errors = combined_suite.validate
+      if errors.any?
+        puts "Validation errors:"
+        errors.each { |error| puts "  #{error}" }
+      end
+      expect(errors).to be_empty
+    end
+  end
+
+  describe "#combine" do
+    let(:suite1) { described_class.from_yaml(File.read("spec/fixtures/basic-ypr-rc.yaml")) }
+    let(:suite2) { described_class.from_yaml(File.read("spec/fixtures/basic-quaternion-rc.yaml")) }
+
+    it "combines two suites" do
+      combined_suite = suite1.combine(suite2)
+      expect(combined_suite.name).to eq("#{suite1.name} + #{suite2.name}")
+      expect(combined_suite.normative_statements_classes.count).to eq(
+        suite1.normative_statements_classes.count +
+        suite2.normative_statements_classes.count
+      )
+    end
+
+    it "resolves conflicts when combining suites" do
+      combined_suite = suite1
+                       .combine(suite2)
+                       .combine(global_suite)
+                       .combine(tangent_point_suite)
+                       .combine(time_suite)
+                       .combine(frame_spec_suite)
+
+      errors = combined_suite.validate
+      if errors.any?
+        puts "Validation errors:"
+        errors.each { |error| puts "  #{error}" }
+      end
+      expect(errors).to be_empty
+    end
+  end
+
+  describe ".from_yaml_files" do
+    it "combines all YAML files in spec/fixtures and validates the combined suite" do
+      yaml_files = Dir.glob("spec/fixtures/*.yaml")
+      expect(yaml_files).not_to be_empty
+
+      combined_suite = described_class.from_yaml_files(*yaml_files)
+      expect(combined_suite).to be_a(described_class)
+      expect(combined_suite.name).to eq("Combined Suite")
+
+      # Ensure the combined suite has content
+      expect(combined_suite.normative_statements_classes).not_to be_empty
+      expect(combined_suite.conformance_classes).not_to be_empty
+
+      # Validate the combined suite
+      errors = combined_suite.validate
+
+      if errors.any?
+        puts "Validation errors:"
+        errors.each { |error| puts "  #{error}" }
+      end
+
+      # Check for specific error types
+      expect(errors).not_to include(a_string_matching(/Conformance test .* has no corresponding requirement/))
+      expect(errors).not_to include(a_string_matching(/Cycle detected/))
+      expect(errors).not_to include(a_string_matching(/Requirement .* has an invalid dependency/))
+
+      # If there are still errors, they should be of a different nature
+      expect(errors).to be_empty
+    end
+  end
+end

data/spec/modspec_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+RSpec.describe Modspec do
+  it "has a version number" do
+    expect(Modspec::VERSION).not_to be nil
+  end
+
+  Dir.glob("spec/fixtures/*-rc.yaml").each do |file|
+    it "parses normative statements class #{file}" do
+      yaml = IO.read(file)
+      Modspec::Suite.from_yaml(yaml)
+
+      # TODO: tests
+    end
+  end
+
+  Dir.glob("spec/fixtures/*-cc.yaml").each do |file|
+    it "parses conformance class #{file}" do
+      yaml = IO.read(file)
+      Modspec::Suite.from_yaml(yaml)
+
+      # TODO: tests
+    end
+  end
+end

data/spec/requirements_class.liquid

@@ -0,0 +1,93 @@
+{% assign rc_count = 0 %}
+
+{% for scope in group.scopes %}
+{% assign rc_count = rc_count | plus: 1 %}
+[[rc-{{prefix}}-{{rc_count}}]]
+.{{scope.name}}
+[requirements_class]
+====
+[%metadata]
+identifier:: {{scope.identifier}}
+description::
++
+--
+{{scope.description}}
+--
+
+{% if {{scope.subject}} %}
+subject:: {{scope.subject}}
+{% endif %}
+
+{% if {{scope.source}} %}
+Source:: {{scope.source}}
+{% endif %}
+
+{% for depend in {{scope.dependencies}} %}
+inherit:: {{depend}}
+{% endfor %}
+
+{% for requirement in {{scope.requirements}} %}
+requirement:: {{requirement.identifier}}
+{% endfor %}
+
+{% if {{scope.guidance}} %}
+guidance::
++
+--
+{% for rec in {{scope.guidance}} %}
+* {{rec}}
+{% endfor %}
+--
+{% endif %}
+
+====
+
+{% assign r_count = 0 %}
+{% for requirement in {{scope.requirements}} %}
+{% assign r_count = r_count | plus: 1 %}
+{% if {{requirement.name}} %}
+.{{requirement.name}}
+{% endif %}
+[[r-{{prefix}}-{{rc_count}}-{{r_count}}]]
+[requirement]
+====
+[%metadata]
+identifier:: {{requirement.identifier}}
+description::
++
+--
+{{requirement.description}}
+--
+
+{% for depend in {{requirement.dependencies}} %}
+inherit:: {{depend}}
+{% endfor %}
+
+{% if {{requirement.subject}} %}
+subject:: {{requirement.subject}}
+{% endif %}
+
+{% if {{requirement.uml-source}} %}
+UML source:: {{requirement.uml-source}}
+{% endif %}
+
+{% if {{requirement.uml-package}} %}
+UML package:: {{requirement.uml-package}}
+{% endif %}
+
+
+{% if {{requirement.guidance}} %}
+guidance::
++
+--
+{% for rec in {{requirement.guidance}} %}
+* {{rec}}
+{% endfor %}
+--
+{% endif %}
+
+====
+
+{% endfor %}
+
+{% endfor %}

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "modspec"
+require "yaml"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: modspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Ribose
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-05 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: lutaml-model
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.10
 - !ruby/object:Gem::Dependency
-  name: shale
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,62 +39,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: toml-rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-- !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
-description: 
+        version: '0'
+description:
 email:
 - open.source@ribose.com
 executables: []
@@ -106,6 +64,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.adoc
@@ -120,6 +79,57 @@ files:
 - lib/modspec/version.rb
 - modspec.gemspec
 - sig/modspec.rbs
+- spec/conformance_class.liquid
+- spec/fixtures/advanced-cc.yaml
+- spec/fixtures/advanced-json-cc.yaml
+- spec/fixtures/advanced-json-rc.yaml
+- spec/fixtures/advanced-rc.yaml
+- spec/fixtures/basic-quaternion-cc.yaml
+- spec/fixtures/basic-quaternion-json-cc.yaml
+- spec/fixtures/basic-quaternion-json-rc.yaml
+- spec/fixtures/basic-quaternion-json-strict-cc.yaml
+- spec/fixtures/basic-quaternion-json-strict-rc.yaml
+- spec/fixtures/basic-quaternion-rc.yaml
+- spec/fixtures/basic-ypr-cc.yaml
+- spec/fixtures/basic-ypr-json-cc.yaml
+- spec/fixtures/basic-ypr-json-rc.yaml
+- spec/fixtures/basic-ypr-rc.yaml
+- spec/fixtures/chain-cc.yaml
+- spec/fixtures/chain-json-cc.yaml
+- spec/fixtures/chain-json-rc.yaml
+- spec/fixtures/chain-rc.yaml
+- spec/fixtures/frame-spec-cc.yaml
+- spec/fixtures/frame-spec-rc.yaml
+- spec/fixtures/global-cc.yaml
+- spec/fixtures/global-rc.yaml
+- spec/fixtures/graph-cc.yaml
+- spec/fixtures/graph-json-cc.yaml
+- spec/fixtures/graph-json-rc.yaml
+- spec/fixtures/graph-rc.yaml
+- spec/fixtures/series-irregular-cc.yaml
+- spec/fixtures/series-irregular-json-cc.yaml
+- spec/fixtures/series-irregular-json-rc.yaml
+- spec/fixtures/series-irregular-rc.yaml
+- spec/fixtures/series-regular-cc.yaml
+- spec/fixtures/series-regular-json-cc.yaml
+- spec/fixtures/series-regular-json-rc.yaml
+- spec/fixtures/series-regular-rc.yaml
+- spec/fixtures/stream-cc.yaml
+- spec/fixtures/stream-json-cc.yaml
+- spec/fixtures/stream-json-rc.yaml
+- spec/fixtures/stream-rc.yaml
+- spec/fixtures/tangent-point-cc.yaml
+- spec/fixtures/tangent-point-rc.yaml
+- spec/fixtures/time-cc.yaml
+- spec/fixtures/time-rc.yaml
+- spec/modspec/conformance_class_spec.rb
+- spec/modspec/conformance_test_spec.rb
+- spec/modspec/normative_statement_spec.rb
+- spec/modspec/normative_statements_class_spec.rb
+- spec/modspec/suite_spec.rb
+- spec/modspec_spec.rb
+- spec/requirements_class.liquid
+- spec/spec_helper.rb
 homepage: https://github.com/metanorma/modspec-ruby
 licenses:
 - BSD-2-Clause
@@ -127,7 +137,7 @@ metadata:
   homepage_uri: https://github.com/metanorma/modspec-ruby
   source_code_uri: https://github.com/metanorma/modspec-ruby
   bug_tracker_uri: https://github.com/metanorma/modspec-ruby/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Library to work with OGC ModSpec.
 test_files: []