lutaml-xmi 0.1.0

data/spec/fixtures/requirements.wsd

@@ -0,0 +1,98 @@
+@startuml Requirements
+
+/'
+Diagram:     Requirements
+DateCreate:  2019-03-06
+Description: This diagram presents the model used to capture requirements, for use both in standards document markup,
+and as standalone machine-readable artefacts.
+
+History of changes:
+> 2019-03-19: Added RequirementType/filename
+> 2019-0-19: Added subsequence
+> 2020-06-16: Added number
+> 2020-06-16: Added keep-with-next
+'/
+
+
+'******* CLASS DEFINITION *********************************************
+
+together {
+class Requirement {
+  + obligation: "requirement"
+}
+
+class Recommendation {
+  + obligation: "recommendation"
+}
+
+class Permission {
+  + obligation: "permission"
+}
+}
+
+class RequirementType {
+  + obligation: ObligationType[1..*],
+  + id: String,
+  + unnumbered: Boolean[0..1],
+  + number: String[0..1],
+  + subsequence: String[0..1],
+  + keep-with-next: Boolean[0..1],
+  + keep-lines-together: Boolean[0..1],
+  + filename: String[0..1],
+  + title: FormattedString[0..1],
+  + label: String[0..1],
+  + subject: String[0..1],
+  + inherit: String[0..*],
+  + model: String[0..1],
+  + type: String[0..1],
+  + classification: ClassificationType[0..*],
+  + measurement-target: RequirementSubpart[0..*],
+  + specification: RequirementSubpart[0..*],
+  + verification: RequirementSubpart[0..*],
+  + import: RequirementSubpart[0..*],
+  + description: RequirementSubpart[0..*],
+  + references: BibliographicItem[0..1],
+  + subrequirement: RequirementType[0..*]
+}
+
+class RequirementSubpart {
+  + type: String[0..1],
+  + exclude: Boolean[0..1],
+  + content: Block[1..*]
+  + keep-with-next: Boolean[0..1],
+  + keep-lines-together: Boolean[0..1],
+}
+
+class ClassificationType {
+  + tag: String,
+  + value: String
+}
+
+enum ObligationType <<enumeration>> {
+  requirement
+  recommendation
+  permission
+}
+
+class BibliographicItem <<Bibliography>> {
+}
+
+class Block <<BasicDoc>> {
+}
+
+'******* NOTES ********************************************************
+note left of RequirementType: RequirementType is a generic category,\nwhich is agnostic as to obligation.\nRequirement, Recommendation, Permission\nset a specific obligation, although this\ncan be overridden
+note right of RequirementType: description, import, verification,\nmeasurement-target, references\ncan appear in any order.
+
+'******* CLASS RELATIONS **********************************************
+Requirement --down-|> RequirementType
+Recommendation --down-|> RequirementType
+Permission --down-|> RequirementType
+
+RequirementType <-- ObligationType
+RequirementType <-- ClassificationType
+RequirementType <-- BibliographicItem
+RequirementType <-- Block
+RequirementType <-- RequirementSubpart
+
+@enduml

data/spec/lutaml/parsers/xmi_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+RSpec.describe Lutaml::XMI::Parsers::XML do
+  describe '.parse' do
+    subject(:parse) { described_class.parse(file) }
+
+    context 'when simple xmi schema' do
+      let(:file) { File.new(fixtures_path('ea-xmi-2.4.2.xmi')) }
+      let(:expected_class_names) do
+        %w[
+          BibliographicItem
+          Block
+          ClassificationType
+          Permission
+          Recommendation
+          Requirement
+          RequirementSubpart
+          RequirementType
+        ]
+      end
+      let(:expected_class_xmi_ids) do
+        %w[
+          EAID_D832D6D8_0518_43f7_9166_7A4E3E8605AA
+          EAID_10AD8D60_9972_475a_AB7E_FA40212D5297
+          EAID_30B0131C_804F_4f67_8B6F_35DF5ABD8E78
+          EAID_82354CDC_EACB_402f_8C2B_FD627B7416E7
+          EAID_AD7320C2_FEE6_4352_8D56_F2C8562B6153
+          EAID_2AC20C81_1E83_400d_B098_BAB784395E06
+          EAID_035D8176_5E9E_42c8_B447_64411AE96F57
+          EAID_C1155D80_E68B_46d5_ADE5_F5639486163D
+        ]
+      end
+      let(:expected_enum_names) { ["ObligationType"] }
+      let(:expected_enum_xmi_ids) { ["EAID_E497ABDA_05EF_416a_A461_03535864970D"] }
+      let(:expected_attributes_names) do
+        %w[
+          classification
+          description
+          filename
+          id
+          import
+          inherit
+          keep-lines-together
+          keep-with-next
+          label
+          measurement-target
+          model
+          number
+          obligation
+          references
+          specification
+          subject
+          subrequirement
+          subsequence
+          title
+          type
+          unnumbered
+          verification
+        ]
+      end
+
+      it "parses xml file into Lutaml::Uml::Node::Document object" do
+        expect(parse).to(be_instance_of(::Lutaml::Uml::Document))
+      end
+
+      it "correctly parses entities of class type" do
+        expect(parse.classes.map(&:name)).to(eq(expected_class_names))
+        expect(parse.classes.map(&:xmi_id)).to(eq(expected_class_xmi_ids))
+      end
+
+      it "correctly parses entities of enums type" do
+        expect(parse.enums.map(&:name)).to(eq(expected_enum_names))
+        expect(parse.enums.map(&:xmi_id)).to(eq(expected_enum_xmi_ids))
+      end
+
+      it "correctly parses entities and attributes for class" do
+        klass = parse.classes.find { |entity| entity.name == 'RequirementType' }
+        expect(klass.attributes.map(&:name)).to(eq(expected_attributes_names))
+      end
+
+      it "correctly parses associations for class" do
+        klass = parse.classes.find { |entity| entity.name == 'BibliographicItem' }
+        expect(klass.associations.map(&:member_end)).to(eq(['RequirementType']))
+      end
+    end
+  end
+end

data/spec/lutaml/xmi_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Lutaml::XMI do
+  it "has a version number" do
+    expect(Lutaml::XMI::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "lutaml/xmi"
+require "byebug"
+
+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
+
+def fixtures_path(path)
+  File.join(File.expand_path("./fixtures", __dir__), path)
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: lutaml-xmi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: lutaml-uml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+description: XML Metadata Interchange (XMI) Specification parser in Ruby, tools for
+  accessing EXPRESS data models.
+email:
+- open.source@ribose.com'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/macos.yml"
+- ".github/workflows/ubuntu.yml"
+- ".github/workflows/windows.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lutaml/xmi.rb
+- lib/lutaml/xmi/parsers/xml.rb
+- lib/lutaml/xmi/version.rb
+- lutaml-xmi.gemspec
+- spec/fixtures/ea-xmi-2.4.2.xmi
+- spec/fixtures/ea-xmi-2.5.1.xmi
+- spec/fixtures/requirements.wsd
+- spec/lutaml/parsers/xmi_spec.rb
+- spec/lutaml/xmi_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lutaml/lutaml-xmi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lutaml/lutaml-xmi
+  source_code_uri: https://github.com/lutaml/lutaml-xmi
+  changelog_uri: https://github.com/lutaml/lutaml-xmi/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: XML Metadata Interchange (XMI) Specification parser in Ruby, tools for accessing
+  EXPRESS data models.
+test_files: []