lutaml 0.9.21 → 0.9.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa2001799c50e05bc06d6f3f916a58ebb637c0ec5f2179b93d32b9983018c2f3
-  data.tar.gz: 482a18f5e8b462b23621d05e8790b1d6f650f2ac8ac3169f40915f2f88e8212a
+  metadata.gz: bc862e1c9607a9696f2104ebcd0b3fc32fabe504c910612013be0e3e6a9a1e69
+  data.tar.gz: 41613d1428429a6e629406d1d755745146f0f34ca78af7373a967bec3338ebbd
 SHA512:
-  metadata.gz: 91e3ded5751df8d330c86fb909c3124ddc386c2f4a1fadd9e3f0a0ecfd4f60276c3e98d67f09e4819e585bf65c401c0a6173ad406b3227d9ebec4726f00103fd
-  data.tar.gz: 36668d33ab9be1528af87c4433e51ca73ce9f137bce9dd58c511aaf0ec3b3e410556097c2df5d0f35d34db970809b3c625a413c931dd01cb845b34ecf2f963c9
+  metadata.gz: 9ea914bab620f52b038b5c0c7778eac2b257e3fafceb1b4ca5d75d198c3f53d763943f808a22d5d0561874d059fe1f1b4a819ec614c23a873f01685049b0362a
+  data.tar.gz: 4b0f439ac81fbdc1239833dd92288cc213ce7b78f53050acabf443b4e87bc4e795ca89cbc56cac8b783bb037de8fc3afa2f10aede1a03069328d4b9530dd91b8

data/lib/lutaml/version.rb

@@ -1,3 +1,3 @@
 module Lutaml
-  VERSION = "0.9.21".freeze
+  VERSION = "0.9.23".freeze
 end

data/lib/lutaml/xmi/liquid_drops/klass_drop.rb

@@ -7,11 +7,9 @@ module Lutaml
         @model = model
         @guidance = guidance
 
-        if guidance && guidance["classes"].map do |c|
-          c["name"]
-        end.include?(@model[:name])
+        if guidance
           @klass_guidance = guidance["classes"].find do |klass|
-            klass["name"] == @model[:name]
+            klass["name"] == name || klass["name"] == absolute_path
           end
         end
       end
@@ -24,6 +22,10 @@ module Lutaml
         @model[:name]
       end
 
+      def absolute_path
+        "#{@model[:absolute_path]}::#{name}"
+      end
+
       def package
         ::Lutaml::XMI::PackageDrop.new(@model[:package], @guidance)
       end

data/lib/lutaml/xmi/liquid_drops/package_drop.rb

@@ -6,6 +6,7 @@ module Lutaml
       def initialize(model, guidance = nil) # rubocop:disable Lint/MissingSuper
         @model = model
         @guidance = guidance
+
         @children_packages ||= packages.map do |pkg|
           [pkg, pkg.packages, pkg.packages.map(&:children_packages)]
         end.flatten.uniq
@@ -19,6 +20,10 @@ module Lutaml
         @model[:name]
       end
 
+      def absolute_path
+        @model[:absolute_path]
+      end
+
       def klasses
         @model[:classes].map do |klass|
           ::Lutaml::XMI::KlassDrop.new(klass, @guidance)

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

@@ -38,6 +38,7 @@ module Lutaml
 
           # @param xml [String] path to xml
           # @param name [String]
+          # @param guidance [String]
           # @return [Hash]
           def serialize_generalization_by_name(xml, name, guidance = nil)
             xmi_model = get_xmi_model(xml)
@@ -69,17 +70,28 @@ module Lutaml
         end
 
         # @param xmi_model [Shale::Mapper]
+        # @param with_gen: [Boolean]
+        # @param with_absolute_path: [Boolean]
         # return [Hash]
-        def serialize_xmi(xmi_model, with_gen: false)
+        def serialize_xmi(xmi_model, with_gen: false, with_absolute_path: false)
           set_xmi_model(xmi_model)
-          serialize_to_hash(xmi_model, with_gen: with_gen)
+          serialize_to_hash(
+            xmi_model,
+            with_gen: with_gen,
+            with_absolute_path: with_absolute_path,
+          )
         end
 
         # @param xmi_model [Shale::Mapper]
+        # @param guidance_yaml [String]
         # return [Liquid::Drop]
         def serialize_xmi_to_liquid(xmi_model, guidance_yaml = nil)
           set_xmi_model(xmi_model)
-          serialized_hash = serialize_xmi(xmi_model, with_gen: true)
+          serialized_hash = serialize_xmi(
+            xmi_model,
+            with_gen: true,
+            with_absolute_path: true,
+          )
           guidance = get_guidance(guidance_yaml)
           ::Lutaml::XMI::RootDrop.new(serialized_hash, guidance)
         end
@@ -94,12 +106,13 @@ module Lutaml
 
         # @param xmi_model [Shale::Mapper]
         # @param name [String]
+        # @param guidance_yaml [String]
         # @return [Hash]
         def serialize_generalization_by_name(xmi_model, name,
                                              guidance_yaml = nil)
           set_xmi_model(xmi_model)
           model = xmi_model.model
-          klass = find_klass_packaged_element_by_name(name)
+          klass = find_klass_packaged_element(name)
           serialized_hash = build_klass_hash(klass, model, with_gen: true)
           guidance = get_guidance(guidance_yaml)
           ::Lutaml::XMI::KlassDrop.new(serialized_hash, guidance)
@@ -108,39 +121,73 @@ module Lutaml
         private
 
         # @param xmi_model [Shale::Mapper]
+        # @param with_gen: [Boolean]
+        # @param with_absolute_path: [Boolean]
         # @return [Hash]
         # @note xpath: //uml:Model[@xmi:type="uml:Model"]
-        def serialize_to_hash(xmi_model, with_gen: false)
+        def serialize_to_hash(xmi_model,
+          with_gen: false, with_absolute_path: false)
           model = xmi_model.model
           {
             name: model.name,
-            packages: serialize_model_packages(model, with_gen: with_gen),
+            packages: serialize_model_packages(
+              model,
+              with_gen: with_gen,
+              with_absolute_path: with_absolute_path,
+            ),
           }
         end
 
         # @param model [Shale::Mapper]
+        # @param with_gen: [Boolean]
+        # @param with_absolute_path: [Boolean]
+        # @param absolute_path: [String]
         # @return [Array<Hash>]
         # @note xpath ./packagedElement[@xmi:type="uml:Package"]
-        def serialize_model_packages(model, with_gen: false)
-          model.packaged_element.select do |e|
+        def serialize_model_packages(model, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          with_gen: false, with_absolute_path: false, absolute_path: "")
+          packages = model.packaged_element.select do |e|
             e.type?("uml:Package")
-          end.map do |package|
-            {
+          end
+
+          if with_absolute_path
+            absolute_path = "#{absolute_path}::#{model.name}"
+          end
+
+          packages.map do |package|
+            h = {
               xmi_id: package.id,
               name: get_package_name(package),
-              classes: serialize_model_classes(package, model,
-                                               with_gen: with_gen),
+              classes: serialize_model_classes(
+                package, model,
+                with_gen: with_gen,
+                with_absolute_path: with_absolute_path,
+                absolute_path: "#{absolute_path}::#{package.name}"
+              ),
               enums: serialize_model_enums(package),
               data_types: serialize_model_data_types(package),
               diagrams: serialize_model_diagrams(package.id),
-              packages: serialize_model_packages(package, with_gen: with_gen),
+              packages: serialize_model_packages(
+                package,
+                with_gen: with_gen,
+                with_absolute_path: with_absolute_path,
+                absolute_path: absolute_path,
+              ),
               definition: doc_node_attribute_value(package.id, "documentation"),
               stereotype: doc_node_attribute_value(package.id, "stereotype"),
             }
+
+            if with_absolute_path
+              h[:absolute_path] = "#{absolute_path}::#{package.name}"
+            end
+
+            h
           end
         end
 
-        def get_package_name(package)
+        # @param package [Shale::Mapper]
+        # @return [String]
+        def get_package_name(package) # rubocop:disable Metrics/AbcSize
           return package.name unless package.name.nil?
 
           connector = fetch_connector(package.id)
@@ -154,22 +201,37 @@ module Lutaml
 
         # @param package [Shale::Mapper]
         # @param model [Shale::Mapper]
+        # @param with_gen: [Boolean]
+        # @param with_absolute_path: [Boolean]
         # @return [Array<Hash>]
         # @note xpath ./packagedElement[@xmi:type="uml:Class" or
         #                               @xmi:type="uml:AssociationClass"]
-        def serialize_model_classes(package, model, with_gen: false)
-          package.packaged_element.select do |e|
+        def serialize_model_classes(package, model, # rubocop:disable Metrics/MethodLength
+          with_gen: false, with_absolute_path: false, absolute_path: "")
+          klasses = package.packaged_element.select do |e|
             e.type?("uml:Class") || e.type?("uml:AssociationClass") ||
               e.type?("uml:Interface")
-          end.map do |klass|
-            build_klass_hash(klass, model, with_gen: with_gen)
+          end
+
+          klasses.map do |klass|
+            h = build_klass_hash(
+              klass, model,
+              with_gen: with_gen
+            )
+
+            h[:absolute_path] = absolute_path if with_absolute_path
+
+            h
           end
         end
 
         # @param klass [Shale::Mapper]
         # @param model [Shale::Mapper]
+        # @param with_gen: [Boolean]
+        # @param with_absolute_path: [Boolean]
         # @return [Hash]
-        def build_klass_hash(klass, model, with_gen: false) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        def build_klass_hash(klass, model, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          with_gen: false, with_absolute_path: false, absolute_path: "")
           klass_hash = {
             xmi_id: klass.id,
             name: klass.name,
@@ -184,6 +246,8 @@ module Lutaml
             stereotype: doc_node_attribute_value(klass.id, "stereotype"),
           }
 
+          klass_hash[:absolute_path] = absolute_path if with_absolute_path
+
           if with_gen && klass.type?("uml:Class")
             klass_hash[:generalization] = serialize_generalization(klass)
           end
@@ -308,6 +372,65 @@ module Lutaml
           upper_klass&.name
         end
 
+        # @param path [String]
+        # @return [Shale::Mapper]
+        def find_klass_packaged_element(path)
+          lutaml_path = Lutaml::Path.parse(path)
+          if lutaml_path.segments.count == 1
+            return find_klass_packaged_element_by_name(path)
+          end
+
+          find_klass_packaged_element_by_path(lutaml_path)
+        end
+
+        # @param path [Lutaml::Path::ElementPath]
+        # @return [Shale::Mapper]
+        def find_klass_packaged_element_by_path(path)
+          if path.absolute?
+            iterate_packaged_element(
+              @xmi_root_model.model, path.segments.map(&:name)
+            )
+          else
+            iterate_relative_packaged_element(path.segments.map(&:name))
+          end
+        end
+
+        # @param name_array [Array<String>]
+        # @return [Shale::Mapper]
+        def iterate_relative_packaged_element(name_array)
+          # match the first element in the name_array
+          matched_elements = all_packaged_elements.select do |e|
+            e.type?("uml:Package") && e.name == name_array[0]
+          end
+
+          # match the rest elements in the name_array
+          result = matched_elements.map do |e|
+            iterate_packaged_element(e, name_array, type: "uml:Class")
+          end
+
+          result.compact.first
+        end
+
+        # @param model [Shale::Mapper]
+        # @param name_array [Array<String>]
+        # @param index: [Integer]
+        # @param type: [String]
+        # @return [Shale::Mapper]
+        def iterate_packaged_element(model, name_array,
+          index: 1, type: "uml:Package")
+          return model if index == name_array.count
+
+          model = model.packaged_element.find do |p|
+            p.name == name_array[index] && p.type?(type)
+          end
+
+          return nil if model.nil?
+
+          index += 1
+          type = index == name_array.count - 1 ? "uml:Class" : "uml:Package"
+          iterate_packaged_element(model, name_array, index: index, type: type)
+        end
+
         # @param name [String]
         # @return [Shale::Mapper]
         def find_klass_packaged_element_by_name(name)

data/lib/lutaml/xmi.rb

@@ -1,6 +1,7 @@
 require "lutaml/xmi/version"
 require "lutaml/xmi/parsers/xml"
 require "liquid"
+require "lutaml/path"
 
 Dir["#{File.dirname(__FILE__)}/xmi/liquid_drops/**/*.rb"].sort.each do |f|
   require f

data/lutaml.gemspec

@@ -29,15 +29,16 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.7.0"
 
-  spec.add_runtime_dependency "liquid"
-  spec.add_runtime_dependency "expressir", "~> 1.3"
-  spec.add_runtime_dependency "hashie", "~> 4.1.0"
-  spec.add_runtime_dependency "htmlentities"
-  spec.add_runtime_dependency "nokogiri", "~> 1.10"
-  spec.add_runtime_dependency "parslet", "~> 2.0.0"
-  spec.add_runtime_dependency "ruby-graphviz", "~> 1.2"
-  spec.add_runtime_dependency "thor", "~> 1.0"
-  spec.add_runtime_dependency "xmi", "~> 0.3.10"
+  spec.add_dependency "expressir", "~> 1.3"
+  spec.add_dependency "hashie", "~> 4.1.0"
+  spec.add_dependency "htmlentities"
+  spec.add_dependency "liquid"
+  spec.add_dependency "lutaml-path"
+  spec.add_dependency "nokogiri", "~> 1.10"
+  spec.add_dependency "parslet", "~> 2.0.0"
+  spec.add_dependency "ruby-graphviz", "~> 1.2"
+  spec.add_dependency "thor", "~> 1.0"
+  spec.add_dependency "xmi", "~> 0.3.10"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6.0"
@@ -46,4 +47,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.11"
   spec.add_development_dependency "rubocop", "~> 1.58"
   spec.add_development_dependency "rubocop-performance", "~> 1.19"
-end
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lutaml
 version: !ruby/object:Gem::Version
-  version: 0.9.21
+  version: 0.9.23
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-04 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: liquid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: expressir
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lutaml-path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -396,6 +410,7 @@ metadata:
   homepage_uri: https://github.com/lutaml/lutaml
   source_code_uri: https://github.com/lutaml/lutaml
   changelog_uri: https://github.com/lutaml/lutaml/releases
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: