lutaml 0.9.27 → 0.9.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc816228e490e9cba017c32c1e0d863e5432b3a8f94ebb1ac35661f6e740ef0a
-  data.tar.gz: 00bb2cdbd8067e59e4b72917277bb885d9e33431b34e657237d8d22388d85776
+  metadata.gz: 9906a661e00ac7afb79f61a10c4d73e07ee9103028aab33e7364d50e1e5a45c0
+  data.tar.gz: eebdee0a0418f2de61317e2f320f7fc15a1ab79eb32200bccce98c2dc3b55cfd
 SHA512:
-  metadata.gz: 6d51dd0a085c47f51970c4c3145f9209c0674a86b85960c61735041a63e852486df8b602bee695495093d9630d77508ef2b4fbaab64ab617c5a1a91f2ebf2467
-  data.tar.gz: 895128a6a8e4b0cc5cf8f14c8a5a23fc0913dd8d77dfc378147535c68ecf9f2e17b16c530dd36c9af008b5845b9872590e76162091b5f24c93c8887b6701233a
+  metadata.gz: 07ad5d9a28f2e5dd7df6b836d810028f4bccfa194ae46dfa95a1d4f923e07707249a0b60f1e05ec80130fc4ecbb9ed626651a63599629deb4da23a68740631e8
+  data.tar.gz: 9da4230858d7876cdd83d2748020e4400d14245ab26623d1d18e15422e03a0c7fdaf447ed70328310efd0b396e662027d766c3b832d8a13513812fca6af8c798

data/README.adoc

@@ -31,52 +31,53 @@ $ gem install lutaml
 === Parsing
 
 The `Lutaml::Parser.parse` method provides a single point of entry for parsing
-data model files.
+data model files, such as:
 
-The return object is always a `Lutaml::LutamlPath::DocumentWrapper` object,
-where `#original_document` returns the native parsed models.
+* EXPRESS files with `.exp` extension
+* YAML Compressed EXPRESS CACHE files
+* XMI files with `.xmi` extension
+* XML files with `.xml` extension
+* LutaML files with `.lutaml` extension
+* LutaML YAML files with `.yml` extension
+
+Depending on the input file type, `Lutaml::Parser.parse` returns:
+
+* `Expressir::Express::Model::Repository` for EXPRESS files
+* `Expressir::Express::Cache` for EXPRESS CACHE files
+* `Lutaml::Uml::Document` for XMI files
+* `Lutaml::Uml::Document` for XML files
+* `Lutaml::Uml::Document` for LutaML files
+* `Lutaml::Uml::Document` for LutaML YAML files
+
+Examples to use the `Lutaml::Parser.parse`:
 
 [source,ruby]
 ----
+require "lutaml"
+
 # example.exp is an EXPRESS schema file
-wrapper = Lutaml::Parser.parse([File.new("example.exp")])
-# => returns a Lutaml::LutamlPath::DocumentWrapper object
-wrapper.original_document
-# => returns the original Expressir::Repository object
-----
+model = Lutaml::Parser.parse([File.new("example.exp")])
+# => returns Expressir::Express::Model::Repository model
 
-[source,ruby]
-----
 # example.exp.yaml is an EXPRESS cache file created with Expressir
-wrapper = Lutaml::Parser.parse([File.new("example.exp.yaml")], ::Lutaml::Parser::EXPRESS_CACHE_PARSE_TYPE)
-# => returns the DocumentWrapper but with the repository loaded from the Expressir cache file
-----
-
+model = Lutaml::Parser.parse([File.new("example.exp.yaml")], ::Lutaml::Parser::EXPRESS_CACHE_PARSE_TYPE)
+# => returns Expressir::Express::Cache model
 
-=== Selecting EXPRESS schemas
+# example.xmi is an XMI file
+model = Lutaml::Parser.parse([File.new("example.xmi")])
+# => returns Lutaml::Uml::Document model
 
-LutaML supports the `ModelElement#to_hash(..., select_proc:)` functionality
-of Expressir, allowing Expressir to only call `to_hash` on schemas that
-fit a dynamic criteria.
+# example.xml is an XML file
+model = Lutaml::Parser.parse([File.new("example.xml")])
+# => returns Lutaml::Uml::Document model
 
-The criteria is set via a Ruby `Proc` object, as follows.
+# example.lutaml is an LutaML file
+model = Lutaml::Parser.parse([File.new("example.lutaml")])
+# => returns Lutaml::Uml::Document model
 
-[source,ruby]
-----
-# Sets the filter
-filtered_schemas = ["action_schema", "date_time_schema"]
-
-# Sets the Proc
-wrapper.select_proc = Proc.new do |value|
-  if value.is_a?(Expressir::Model::Declarations::Schema)
-    filtered_schemas.include?(value.id)
-  else
-    true
-  end
-end
-
-serialized = wrapper.to_liquid
-# => returns the filtered to_hash method
+# example.yaml is an LutaML YAML file
+model = Lutaml::Parser.parse([File.new("example.yaml")])
+# => returns Lutaml::Uml::Document model
 ----
 
 

data/bin/plantuml2lutaml

@@ -14,9 +14,9 @@ def sync_puts(line, level = 0)
   $stdout.flush
 end
 
-SKIPPED_LINES_REGEXP = /^(@startuml|'\*{7}|note|@enduml|\!|'\/)/
-COMMENT_START = /\/'/
-COMMENT_END = /'\//
+SKIPPED_LINES_REGEXP = /^(@startuml|'\*{7}|note|@enduml|!|'\/)/.freeze
+COMMENT_START = /\/'/.freeze
+COMMENT_END = /'\//.freeze
 ASSOCIATION_MAPPINGS = {
   /-\|>/ => ",inheritance",
   /<\|-/ => "inheritance,",
@@ -27,11 +27,15 @@ ASSOCIATION_MAPPINGS = {
 in_comment_block = false
 
 def transform_line(line)
-  line = line.gsub(/^\s*'/, '** ').gsub(/\|[\sa-zA-Z]+$/, '')
-  return sync_puts(line, 2) if ASSOCIATION_MAPPINGS.keys.none? { |key| line =~ key }
+  line = line.gsub(/^\s*'/, "** ").gsub(/\|[\sa-zA-Z]+$/, "")
+  return sync_puts(line, 2) if ASSOCIATION_MAPPINGS.keys.none? do |key|
+    line =~ key
+  end
 
-  owner_type, member_type = ASSOCIATION_MAPPINGS.detect { |(key, _value)| line =~ key }.last.split(",")
-  blocks = line.split(" ")
+  owner_type, member_type = ASSOCIATION_MAPPINGS.detect do |(key, _value)|
+    line =~ key
+  end.last.split(",")
+  blocks = line.split
   owner = blocks.first
   member = blocks.last
   sync_puts("association {", 2)

data/bin/yaml2lutaml

@@ -82,7 +82,7 @@ view_yaml["relations"]&.each do |values|
   process_association(values["source"], values, encountered_relations)
 end
 
-view_yaml["imports"].keys.each do |entry|
+view_yaml["imports"].each_key do |entry|
   import = YAML.safe_load(File.read(File.join(models_path, "#{entry}.yml")))
   import_name = import["name"] || File.basename(entry)
   # Class notation

data/exe/lutaml-sysml

@@ -11,8 +11,10 @@ $:.unshift File.expand_path("../../lib", bin_file)
 # Fixes https://github.com/rubygems/rubygems/issues/1420
 require "rubygems/specification"
 
-class Gem::Specification
-  def this; self; end
+module Gem
+  class Specification
+    def this; self; end
+  end
 end
 
 # start up the CLI

data/exe/lutaml-wsd2uml

@@ -14,9 +14,9 @@ def sync_puts(line, level = 0)
   $stdout.flush
 end
 
-SKIPPED_LINES_REGEXP = /^(@startuml|'\*{7}|note|@enduml|\!|'\/)/
-COMMENT_START = /\/'/
-COMMENT_END = /'\//
+SKIPPED_LINES_REGEXP = /^(@startuml|'\*{7}|note|@enduml|!|'\/)/.freeze
+COMMENT_START = /\/'/.freeze
+COMMENT_END = /'\//.freeze
 ASSOCIATION_MAPPINGS = {
   /-\|>/ => ",inheritance",
   /<\|-/ => "inheritance,",
@@ -27,11 +27,15 @@ ASSOCIATION_MAPPINGS = {
 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 }
+  line = line.gsub(/^\s*'/, "** ").gsub(/\|[\sa-zA-Z]+$/, "").delete("\r")
+  return sync_puts(line, 2) if ASSOCIATION_MAPPINGS.keys.none? do |key|
+    line =~ key
+  end
 
-  owner_type, member_type = ASSOCIATION_MAPPINGS.detect { |(key, _value)| line =~ key }.last.split(",")
-  blocks = line.split(" ")
+  owner_type, member_type = ASSOCIATION_MAPPINGS.detect do |(key, _value)|
+    line =~ key
+  end.last.split(",")
+  blocks = line.split
   owner = blocks.first
   member = blocks.last
   sync_puts("association {", 2)

data/exe/lutaml-yaml2uml

@@ -82,7 +82,7 @@ view_yaml["relations"]&.each do |values|
   process_association(values["source"], values, encountered_relations)
 end
 
-view_yaml["imports"].keys.each do |entry|
+view_yaml["imports"].each_key do |entry|
   import = YAML.safe_load(File.read(File.join(models_path, "#{entry}.yml")))
   import_name = import["name"] || File.basename(entry)
   # Class notation

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'expressir'
-require 'expressir/express/parser'
+require "expressir"
+require "expressir/express/parser"
 
 module Lutaml
   module Express
@@ -12,10 +12,10 @@ module Lutaml
         #        [Hash] options - options for parsing
         #
         # @return [Expressir::Model::Repository]
-        def self.parse(io, options = {})
+        def self.parse(io, _options = {})
           Expressir::Express::Parser.from_file(io.path)
         end
       end
     end
   end
-end
+end

data/lib/lutaml/formatter/graphviz.rb

@@ -81,10 +81,10 @@ module Lutaml
 
       def escape_html_chars(text)
         text
-          .gsub(/</, "&#60;")
-          .gsub(/>/, "&#62;")
-          .gsub(/\[/, "&#91;")
-          .gsub(/\]/, "&#93;")
+          .gsub("<", "&#60;")
+          .gsub(">", "&#62;")
+          .gsub("[", "&#91;")
+          .gsub("]", "&#93;")
       end
 
       def format_field(node)
@@ -197,7 +197,7 @@ module Lutaml
       end
 
       def format_member_rows(members, hide_members)
-        unless !hide_members && members && members.length.positive?
+        unless !hide_members && members&.length&.positive?
           return <<~HEREDOC.chomp
             <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
               <TR><TD ALIGN="LEFT"></TD></TR>
@@ -210,10 +210,10 @@ module Lutaml
         end
         field_table = <<~HEREDOC.chomp
           <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
-            #{field_rows.map { |row| ' ' * 10 + row }.join("\n")}
+            #{field_rows.map { |row| (' ' * 10) + row }.join("\n")}
           </TABLE>
         HEREDOC
-        field_table << "\n" << " " * 6
+        field_table << "\n" << (" " * 6)
         field_table
       end
 

data/lib/lutaml/parser.rb

@@ -2,8 +2,6 @@ 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"
 
 module Lutaml
@@ -14,14 +12,10 @@ module Lutaml
 
     class << self
       def parse(file_list, input_type = nil)
-        file_list = file_list.is_a?(Array) ? file_list : [file_list]
-        new(Array(file_list), input_type).parse
-      end
-
-      def parse_into_document(file_list, input_type = nil)
-        file_list = file_list.is_a?(Array) ? file_list : [file_list]
+        file_list = [file_list] unless file_list.is_a?(Array)
         new(Array(file_list), input_type).parse_into_document
       end
+      alias_method :parse_into_document, :parse
     end
 
     def initialize(file_list, input_type)
@@ -29,15 +23,7 @@ module Lutaml
       @file_list = file_list
     end
 
-    def parse
-      documents = parse_into_document
-      return document_wrapper(documents) if ["exp",
-                                             EXPRESS_CACHE_PARSE_TYPE].include?(parse_type)
-
-      documents.map { |doc| document_wrapper(doc) }
-    end
-
-    def parse_into_document
+    def parse_into_document # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
       case parse_type
       when "exp"
         Expressir::Express::Parser.from_files(file_list.map(&:path))
@@ -55,19 +41,5 @@ module Lutaml
         raise ArgumentError, "Unsupported file format"
       end
     end
-
-    private
-
-    def document_wrapper(document)
-      if ["exp", EXPRESS_CACHE_PARSE_TYPE].include?(parse_type)
-        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
 end

data/lib/lutaml/sysml/allocate.rb

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

data/lib/lutaml/sysml/allocated.rb

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

data/lib/lutaml/sysml/binding_connector.rb

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

data/lib/lutaml/sysml/block.rb

@@ -1,27 +1,30 @@
-module Lutaml::SysMl
+module Lutaml
+  module SysMl
+    class Block < Lutaml::Uml::Class
+      attr_accessor :base_class
 
-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
+      def initialize
+        @xmi_id = nil
+        @nested_classifier = []
+        @stereotype = []
+        @namespace = nil
+      end
+
+      def name
+        if !base_class.nil? && !base_class.name.nil?
+          return base_class.name
+        end
+
+        nil
+      end
 
-end
+      def full_name
+        if !base_class.nil? && !base_class.name.nil?
+          return base_class.full_name
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/lutaml/sysml/constraint_block.rb

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

data/lib/lutaml/sysml/copy.rb

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

data/lib/lutaml/sysml/derive_requirement.rb

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

data/lib/lutaml/sysml/nested_connector_end.rb

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

data/lib/lutaml/sysml/refine.rb

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

data/lib/lutaml/sysml/requirement_related.rb

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

data/lib/lutaml/sysml/satisfy.rb

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

data/lib/lutaml/sysml/test_case.rb

@@ -1,22 +1,23 @@
-module Lutaml::SysMl
+module Lutaml
+  module SysMl
+    class TestCase < Lutaml::Uml::TopElement
+      attr_accessor :base_behavior, :verifies
 
-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
+      def name
+        if !base_behavior.nil? && !base_behavior.name.nil?
+          return base_behavior.name
+        end
 
-end
+        nil
+      end
+
+      def full_name
+        if !base_behavior.nil? && !base_behavior.name.nil?
+          return base_behavior.full_name
+        end
 
-end
+        nil
+      end
+    end
+  end
+end

data/lib/lutaml/sysml/trace.rb

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

data/lib/lutaml/sysml/verify.rb

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

data/lib/lutaml/sysml/version.rb

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