lutaml 0.7.6 → 0.8.0

data/exe/lutaml-wsd2uml

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Script to convert plantuml files into LutaML syntax
+# Usage: bin/plantuml2lutaml /path/to/plantuml.wsd
+
+file_path = ARGV[0]
+FILE_NAME = File.basename(file_path, ".wsd")
+wsd_file = File.new(ARGV[0])
+
+def sync_puts(line, level = 0)
+  $stdout.puts("#{''.rjust(level)}#{line}")
+  $stdout.flush
+end
+
+SKIPPED_LINES_REGEXP = /^(@startuml|'\*{7}|note|@enduml|\!|'\/)/
+COMMENT_START = /\/'/
+COMMENT_END = /'\//
+ASSOCIATION_MAPPINGS = {
+  /-\|>/ => ",inheritance",
+  /<\|-/ => "inheritance,",
+  /->/ => ",direct",
+  /<-/ => "direct,",
+}.freeze
+
+in_comment_block = false
+
+def transform_line(line)
+  line = line.gsub(/^\s*'/, '** ').gsub(/\|[\sa-zA-Z]+$/, '').gsub(/\r/, '')
+  return sync_puts(line, 2) if ASSOCIATION_MAPPINGS.keys.none? { |key| line =~ key }
+
+  owner_type, member_type = ASSOCIATION_MAPPINGS.detect { |(key, _value)| line =~ key }.last.split(",")
+  blocks = line.split(" ")
+  owner = blocks.first
+  member = blocks.last
+  sync_puts("association {", 2)
+  sync_puts("owner #{owner}", 4)
+  sync_puts("member #{member}", 4)
+  sync_puts("owner_type #{owner_type}", 4) if !owner_type.to_s.empty?
+  sync_puts("member_type #{member_type}", 4) if !member_type.to_s.empty?
+  sync_puts("}", 2)
+end
+
+sync_puts("diagram #{FILE_NAME} {")
+wsd_file.readlines.each do |line|
+  if line.match?(COMMENT_START)
+    in_comment_block = true
+  end
+
+  if line.match?(COMMENT_END)
+    in_comment_block = false
+  end
+
+  next if in_comment_block || line =~ SKIPPED_LINES_REGEXP
+
+  transform_line(line)
+end
+sync_puts("}")

data/exe/lutaml-yaml2uml

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Script to convert datamodel yaml files into LutaML syntax
+# Usage: bin/yaml2lutaml /path/to/datamodel/view/file.yml
+
+require "yaml"
+
+view_yaml = YAML.safe_load(File.read(ARGV[0]))
+models_path = File.expand_path("../../models", ARGV[0])
+
+def sync_puts(line, level = 0)
+  $stdout.puts("#{''.rjust(level)}#{line}")
+  $stdout.flush
+end
+
+encountered_relations = Hash.new { |h, key| h[key] = [] }
+# relations:
+# - target: AttributeProfile
+#   relationship:
+#     source:
+#       type: aggregation
+#       attribute:
+#         addressClassProfile:
+#     target:
+#       type: direct
+#       attribute:
+#         attributeProfile:
+#           cardinality:
+#             min: 0
+#             max: '*'
+def process_association(owner, values, encountered_relations)
+  target_name = values["target"]
+  return if encountered_relations[owner].include?(target_name)
+
+  encountered_relations[owner].push(target_name)
+  sync_puts("association {", 2)
+
+  relationship_block = values["relationship"] || {}
+
+  if relationship_block["source"] && relationship_block["source"]["type"]
+    source = relationship_block["source"]
+    sync_puts("owner_type #{source['type']}", 4)
+    if source["attribute"]
+      source_attribute_name = source["attribute"].keys.first
+      owner += "##{source_attribute_name}"
+      if source["attribute"][source_attribute_name] && source["attribute"][source_attribute_name]["cardinality"]
+        cardinality = source["attribute"][source_attribute_name]["cardinality"]
+        owner += " [#{cardinality['min']}..#{cardinality['max']}]"
+      end
+    end
+  end
+  sync_puts("owner #{owner}", 4)
+
+  member = target_name
+  if relationship_block["target"]
+    target = relationship_block["target"]
+    type = target["type"] || "direct"
+    sync_puts("member_type #{type}", 4)
+    if target["attribute"]
+      target_attribute_name = target["attribute"].keys.first
+      member += "##{target_attribute_name}"
+      if target["attribute"][target_attribute_name] && target["attribute"][target_attribute_name]["cardinality"]
+        cardinality = target["attribute"][target_attribute_name]["cardinality"]
+        member += " [#{cardinality['min']}..#{cardinality['max']}]"
+      end
+    end
+  else
+    sync_puts("member_type direct", 4)
+  end
+  sync_puts("member #{member}", 4)
+
+  sync_puts("}", 2)
+end
+sync_puts("diagram #{File.basename(ARGV[0], 'yml')[0..-2]} {")
+sync_puts("title '#{view_yaml['title']}'", 2)
+sync_puts("caption '#{view_yaml['caption']}'", 2)
+
+# Class associations notations
+view_yaml["relations"]&.each do |values|
+  process_association(values["source"], values, encountered_relations)
+end
+
+view_yaml["imports"].keys.each do |entry|
+  import = YAML.safe_load(File.read(File.join(models_path, "#{entry}.yml")))
+  import_name = import["name"] || File.basename(entry)
+  # Class notation
+  sync_puts("#{import['modelType']} #{import_name} {", 2)
+  if import["definition"]
+    definition = <<~TEXT
+      definition {
+        #{import['definition']}
+      }
+    TEXT
+    sync_puts(definition, 4)
+  end
+  import["values"]&.each_pair do |key, values|
+    result_string = key
+    if values["definition"]
+      result_string += <<~TEXT
+        {
+          definition {
+          #{values['definition']}
+          }
+        }
+      TEXT
+    end
+    sync_puts(result_string, 4)
+  end
+  import["attributes"]&.each_pair do |key, values|
+    definition = values["definition"]
+    cardinality = if values["cardinality"]
+                    cardinality_val = values["cardinality"]
+                    "[#{cardinality_val['min']}..#{cardinality_val['max']}]"
+                  else
+                    ""
+                  end
+    result_string = "+#{key}"
+    if values["type"]
+      result_string += ": #{values['type']}"
+    end
+    if cardinality
+      result_string += " #{cardinality}"
+    end
+    if definition
+      result_string += <<~TEXT
+        {
+          definition
+          #{definition}
+          end definition
+        }
+      TEXT
+    end
+    sync_puts(result_string, 4)
+  end
+  sync_puts("}", 2)
+
+  # Associations notations
+  import["relations"]&.each do |values|
+    process_association(import_name, values, encountered_relations)
+  end
+end
+sync_puts("}")

data/lib/lutaml/express/README.adoc

@@ -0,0 +1,55 @@
+image:https://img.shields.io/gem/v/lutaml-express.svg["Gem Version", link="https://rubygems.org/gems/lutaml-express"]
+// image:https://codeclimate.com/github/lutaml/lutaml-express/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/lutaml/lutaml-express"]
+image:https://github.com/lutaml/lutaml-express/workflows/rake/badge.svg["Build Status", link="https://github.com/lutaml/lutaml-express/actions?workflow=rake"]
+
+= lutaml-express
+
+== Functionality
+
+Gem-extention for lutaml, works with EXPRESS files
+
+=== Installation
+
+With bundler:
+
+[source,ruby]
+----
+# Gemfile
+gem "lutaml-express"
+----
+
+Then in console:
+
+[source,console]
+----
+$ bundle
+----
+
+With RubyGems:
+
+[source,console]
+----
+$ gem install lutaml-express
+----
+
+=== Usage
+
+[source,ruby]
+----
+Lutaml::Express::Parsers::Exp.parse(File.new('/path/to/file.exp')) # => Expressir::Model::Repository
+----
+
+== 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-express. 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-express/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-express/blob/master/CODE_OF_CONDUCT.md).

data/lib/lutaml/express/parsers/exp.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'expressir'
+require 'expressir/express/parser'
+
+module Lutaml
+  module Express
+    module Parsers
+      # Class for parsing .exp schema files into Expressir::Model::Repository
+      class Exp
+        # @param [String] io - file object with path to .exp file
+        #        [Hash] options - options for parsing
+        #
+        # @return [Expressir::Model::Repository]
+        def self.parse(io, options = {})
+          Expressir::Express::Parser.from_file(io.path)
+        end
+      end
+    end
+  end
+end

data/lib/lutaml/express/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Express
+    VERSION = "0.2.1"
+  end
+end

data/lib/lutaml/express.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "lutaml/express/version"
+require "lutaml/express/parsers/exp"
+
+module Lutaml
+  module Express
+  end
+end

data/lib/lutaml/lutaml_path/document_wrapper.rb

@@ -8,6 +8,10 @@ module Lutaml
       end
 
       def to_liquid
+        serialized_document
+      end
+
+      def serialized_document
         @serialized_document ||= serialize_document(@original_document)
       end
 
@@ -25,9 +29,9 @@ module Lutaml
         serialize_to_hash(attr_value)
       end
 
+      BASE_OBJECTS = [String, Integer, Float, FalseClass, TrueClass, Symbol, NilClass, Hash]
       def serialize_to_hash(object)
-        return object if [String, Integer, Float, FalseClass, TrueClass,
-                          Symbol, NilClass, Hash].include?(object.class)
+        return object if BASE_OBJECTS.include?(object.class)
 
         object.instance_variables.each_with_object({}) do |var, res|
           variable = object.instance_variable_get(var)
@@ -35,7 +39,7 @@ module Lutaml
                                           variable.map do |n|
                                             serialize_to_hash(n)
                                           end
-                                        elsif [String, Integer, Float, FalseClass, TrueClass, Symbol, NilClass, Hash].include?(variable.class) || var == :@parent
+                                        elsif BASE_OBJECTS.include?(variable.class) || var == :@parent
                                           variable
                                         else
                                           serialize_to_hash(variable)

data/lib/lutaml/parser.rb

@@ -1,6 +1,7 @@
 require "lutaml/express"
 require "lutaml/uml"
 require "lutaml/xmi"
+require "lutaml/xml"
 require "lutaml/uml/lutaml_path/document_wrapper"
 require "lutaml/express/lutaml_path/document_wrapper"
 require "expressir/express/cache"
@@ -44,6 +45,8 @@ module Lutaml
         Expressir::Express::Cache.from_file(file_list.first.path)
       when "xmi"
         file_list.map { |file| Lutaml::XMI::Parsers::XML.parse(file) }
+      when "xml"
+        file_list.map { |file| Lutaml::Xml::Parsers::Xml.parse(file) }
       when "lutaml"
         file_list.map { |file| Lutaml::Uml::Parsers::Dsl.parse(file) }
       when "yml"
@@ -60,6 +63,10 @@ module Lutaml
         return Lutaml::Express::LutamlPath::DocumentWrapper.new(document)
       end
 
+      if parse_type == "xml"
+        return Lutaml::Xml::LutamlPath::DocumentWrapper.new(document)
+      end
+
       Lutaml::Uml::LutamlPath::DocumentWrapper.new(document)
     end
   end

data/lib/lutaml/sysml/README.md

@@ -0,0 +1,40 @@
+# Lutaml::Sysml
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lutaml/sysml`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lutaml-sysml'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lutaml-sysml
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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-sysml. 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-sysml/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Lutaml::Sysml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lutaml-sysml/blob/master/CODE_OF_CONDUCT.md).

data/lib/lutaml/sysml/allocate.rb

@@ -0,0 +1,8 @@
+module Lutaml::SysMl
+
+
+class Allocate < Lutaml::Uml::Abstraction
+	attr_accessor :base_abstraction
+end
+
+end

data/lib/lutaml/sysml/allocated.rb

@@ -0,0 +1,7 @@
+module Lutaml::SysMl
+
+class Allocated < Lutaml::Uml::TopElement
+	attr_accessor :base_named_element, :allocated_from, :allocated_to
+end
+
+end

data/lib/lutaml/sysml/binding_connector.rb

@@ -0,0 +1,7 @@
+module Lutaml::SysMl
+
+class BindingConnector < Lutaml::Uml::Connector
+	attr_accessor :base_connector
+end
+
+end

data/lib/lutaml/sysml/block.rb

@@ -0,0 +1,27 @@
+module Lutaml::SysMl
+
+class Block < Lutaml::Uml::Class
+	attr_accessor :base_class
+	def initialize
+		@xmi_id = nil
+		@nested_classifier = []
+		@stereotype = []
+		@namespace = nil
+	end
+	
+  def name
+		if base_class != nil and base_class.name != nil
+ 			return base_class.name
+		end
+		return nil
+	end
+  
+	def full_name
+		if base_class != nil and base_class.name != nil
+ 			return base_class.full_name
+		end
+		return nil
+	end
+end
+
+end

data/lib/lutaml/sysml/constraint_block.rb

@@ -0,0 +1,12 @@
+module Lutaml::SysMl
+
+class ConstraintBlock < Block
+	def initialize
+		@xmi_id = nil
+		@nested_classifier = []
+		@stereotype = []
+		@namespace = nil
+	end
+end
+
+end

data/lib/lutaml/sysml/copy.rb

@@ -0,0 +1,6 @@
+module Lutaml::SysMl
+
+  class Copy < Trace
+  end
+
+end

data/lib/lutaml/sysml/derive_requirement.rb

@@ -0,0 +1,7 @@
+module Lutaml::SysMl
+
+class DeriveRequirement < Lutaml::Uml::TopElement
+	attr_accessor :base_abstraction
+end
+
+end

data/lib/lutaml/sysml/nested_connector_end.rb

@@ -0,0 +1,11 @@
+module Lutaml::SysMl
+
+class NestedConnectorEnd < Lutaml::Uml::ConnectorEnd
+	attr_accessor :base_connectorend, :property_path
+	def initialize
+		@property_path = []
+	end
+end
+
+
+end

data/lib/lutaml/sysml/refine.rb

@@ -0,0 +1,7 @@
+module Lutaml::SysMl
+
+class Refine < Lutaml::Uml::TopElement
+	attr_accessor :base_abstraction
+end
+
+end

data/lib/lutaml/sysml/requirement.rb

@@ -0,0 +1,34 @@
+module Lutaml::Sysml
+
+class Requirement < Lutaml::Uml::Class
+	attr_accessor :id, :text, :base_class, :refined_by, :traced_to, :derived_from, :satisfied_by
+	def initialize
+		@xmi_id = nil
+		@id = nil
+		@nested_classifier = []
+		@stereotype = []
+		@namespace = nil
+	end
+	def name
+		if base_class != nil and base_class.name != nil
+ 			return base_class.name
+		end
+		return nil
+	end
+	def full_name
+		if base_class != nil and base_class.name != nil
+ 			return base_class.full_name
+		end
+		return nil
+	end
+##	def name
+## 		if base_class != nil and base_class.name != nil
+## 			base_class.name
+##		else
+##			nil
+## 		end
+## 	end
+## 	def full_name
+## 		get_base_class_full_name ( self )
+##	end
+end

data/lib/lutaml/sysml/requirement_related.rb

@@ -0,0 +1,7 @@
+module Lutaml::SysMl
+
+class RequirementRelated < Lutaml::Uml::TopElement
+	attr_accessor :base_named_element, :satisfies, :refines
+end
+
+end

data/lib/lutaml/sysml/satisfy.rb

@@ -0,0 +1,7 @@
+module Lutaml::SysMl
+
+class Satisfy < Trace
+	attr_accessor :base_realization
+end
+
+end

data/lib/lutaml/sysml/test_case.rb

@@ -0,0 +1,22 @@
+module Lutaml::SysMl
+
+class TestCase < Lutaml::Uml::TopElement
+	attr_accessor :base_behavior, :verifies
+	
+  def name
+		if base_behavior != nil and base_behavior.name != nil
+ 			return base_behavior.name
+		end
+		return nil
+	end
+  
+	def full_name
+		if base_behavior != nil and base_behavior.name != nil
+ 			return base_behavior.full_name
+		end
+		return nil
+	end
+
+end
+
+end

data/lib/lutaml/sysml/trace.rb

@@ -0,0 +1,7 @@
+module Lutaml::SysMl
+
+class Trace < Lutaml::Uml::TopElement
+	attr_accessor :base_abstraction
+end
+
+end

data/lib/lutaml/sysml/verify.rb

@@ -0,0 +1,6 @@
+module Lutaml::SysMl
+
+class Verify < Trace
+end
+
+end

data/lib/lutaml/sysml/version.rb

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