lutaml-xmi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3945e4e96c67e7436534710a4509f1840c27ce886b3b214493e1a50bbc11e673
+  data.tar.gz: adbef1d7784d7aa82ae7341966ed2d44fce3a6a800f64d584d93a3b903dd35ff
+SHA512:
+  metadata.gz: 3d3865a7cbb8d8d0ca56ac26e662d0edc63677f8579e59d36a521c8d945f64a2579dd6b4c646b140f3f45c2f7d843ed1a19617a2076e95c40985cae5a2a3b862
+  data.tar.gz: 5fdb6a5c25badd0e82c0d2292d406801af7c88add9e5f1bd9b98c0c1b56e3856d604e48b3f65b69cc6212228adc3447bd10638ea87d378749655540a47d043fa

data/.github/workflows/macos.yml

@@ -0,0 +1,36 @@
+name: macos
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
+
+jobs:
+  test-macos:
+    name: Test on Ruby ${{ matrix.ruby }} macOS
+    runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update gems
+        run: |
+          sudo gem install bundler --force
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,38 @@
+name: ubuntu
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+  pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
+
+jobs:
+  test-linux:
+    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/windows.yml

@@ -0,0 +1,41 @@
+name: windows
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
+
+jobs:
+  test-windows:
+    name: Test on Ruby ${{ matrix.ruby }} Windows
+    runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5' ]
+        experimental: [false]
+        # Does not supported yet:
+        # Ruby (< 2.7.dev, >= 2.3), which is required by gem 'nokogiri (~> 1.10)', is not
+        #   available in the local ruby installation
+        # include:
+        #   - ruby: '2.7'
+        #     experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Update gems
+        shell: pwsh
+        run: |
+          gem install bundler
+          bundle config --local path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ronald.tse@ribose.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lutaml-uml.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/README.adoc

@@ -0,0 +1,24 @@
+# Lutaml::Uml
+
+Lutaml-xmi is a parser for XML Metadata Interchange (XMI) Specification files.
+
+## Install
+
+### Bundler: `gem "lutaml-xmi"`
+
+### RubyGems: `gem install lutaml-xmi`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lutaml-xmi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/lutaml-xmi/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Lutaml::Uml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lutaml-xmi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "lutaml/xmi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lutaml/xmi.rb

@@ -0,0 +1,7 @@
+require "lutaml/xmi/version"
+require "lutaml/xmi/parsers/xml"
+
+module Lutaml
+  module XMI
+  end
+end

data/lib/lutaml/xmi/parsers/xml.rb

@@ -0,0 +1,111 @@
+require "nokogiri"
+require "lutaml/uml/has_attributes"
+require "lutaml/uml/document"
+
+module Lutaml
+  module XMI
+    module Parsers
+      # Class for parsing .xmi schema files into ::Lutaml::Uml::Document
+      class XML
+        ATTRIBUTE_MAPPINGS = {
+          "uml:LiteralInteger" => "1",
+          "uml:LiteralUnlimitedNatural" => "*"
+        }
+        attr_reader :main_model
+
+        # @param [String] io - file object with path to .xmi file
+        #        [Hash] options - options for parsing
+        #
+        # @return [Lutaml::XMI::Model::Document]
+        def self.parse(io, options = {})
+          new.parse(Nokogiri::XML(io.read))
+        end
+
+        def parse(xmi_doc)
+          @main_model = xmi_doc
+          ::Lutaml::Uml::Document
+            .new(serialize_to_hash(xmi_doc))
+        end
+
+        private
+
+        def serialize_to_hash(xmi_doc)
+          main_model = xmi_doc.xpath('//uml:Model[@xmi:type="uml:Model"]').first
+          {
+            name: main_model["name"],
+            classes: serialize_model_classes(main_model),
+            enums: serialize_model_enums(main_model)
+            # associations: serialize_model_associations(main_model)
+          }
+        end
+
+        def serialize_model_classes(model)
+          model.xpath('.//packagedElement[@xmi:type="uml:Class"]').map do |klass|
+            {
+              xmi_id: klass['xmi:id'],
+              xmi_uuid: klass['xmi:uuid'],
+              name: klass['name'],
+              attributes: serialize_class_attributes(klass),
+              associations: serialize_model_associations(klass)
+            }
+          end
+        end
+
+        def serialize_model_enums(model)
+          model.xpath('.//packagedElement[@xmi:type="uml:Enumeration"]').map do |enum|
+            attributes = enum
+                          .xpath('.//ownedLiteral[@xmi:type="uml:EnumerationLiteral"]')
+                          .map do |attribute|
+                            {
+                              # TODO: xmi_id
+                              # xmi_id: enum['xmi:id'],
+                              type: attribute['name'],
+                            }
+                          end
+            {
+              xmi_id: enum['xmi:id'],
+              xmi_uuid: enum['xmi:uuid'],
+              name: enum['name'],
+              attributes: attributes
+            }
+          end
+        end
+
+        def serialize_model_associations(klass)
+          return unless klass.attributes['name']
+
+          klass.xpath('.//ownedAttribute/type').map do |assoc|
+            if assoc.attributes && assoc.attributes['idref']
+              id_ref = assoc.attributes['idref'].value
+              linked_class = main_model.xpath(%Q(//packagedElement[@xmi:type="uml:Class" and @xmi:id="#{id_ref}"])).first
+              member_end = linked_class.attributes['name'].value if linked_class
+            end
+            if member_end
+              {
+                xmi_id: assoc['xmi:id'],
+                xmi_uuid: assoc['xmi:uuid'],
+                name: assoc['name'],
+                member_end: member_end
+              }
+            end
+          end.compact
+        end
+
+        def serialize_class_attributes(klass)
+          klass.xpath('.//ownedAttribute[@xmi:type="uml:Property"]').map do |attribute|
+            type = attribute.xpath('.//type').first || {}
+            lowerValue = attribute.xpath('.//lowerValue').first || {}
+            upperValue = attribute.xpath('.//upperValue').first || {}
+            {
+              # TODO: xmi_id
+              # xmi_id: klass['xmi:id'],
+              name: attribute['name'],
+              type: type['xmi:idref'],
+              cardinality: [ATTRIBUTE_MAPPINGS[lowerValue["xmi:type"]], ATTRIBUTE_MAPPINGS[upperValue["xmi:type"]]].compact
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lutaml/xmi/version.rb

@@ -0,0 +1,5 @@
+module Lutaml
+  module XMI
+    VERSION = "0.1.0"
+  end
+end

data/lutaml-xmi.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/lutaml/xmi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lutaml-xmi"
+  spec.version       = Lutaml::XMI::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com'"]
+
+  spec.summary       = "XML Metadata Interchange (XMI) Specification parser in Ruby, tools for accessing EXPRESS data models."
+  spec.description   = "XML Metadata Interchange (XMI) Specification parser in Ruby, tools for accessing EXPRESS data models."
+  spec.homepage      = "https://github.com/lutaml/lutaml-xmi"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/lutaml/lutaml-xmi/releases"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+
+  spec.bindir        = "exe"
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "hashie", "~> 4.1.0"
+  spec.add_runtime_dependency "thor", "~> 1.0"
+  spec.add_runtime_dependency "lutaml-uml", "~> 0.2"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "nokogiri", "~> 1.10"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.54.0"
+end