lutaml 0.8.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a582c930c66da4590b8f707825f61e407bbe2492c95aa6f6a61725e95e62d4
-  data.tar.gz: cb3045bd11c726aa0d9462f72216e783545c37e2a701c223c5dc335eb1fb8213
+  metadata.gz: c3bdc3f066879a36efeca4609e9aca838d50a6708a1112b403da3c67a2e1d4dc
+  data.tar.gz: '085cc25361b1aff8bd5ee4910230ceb5420a9830fbaeaa811b60c85b20de8f18'
 SHA512:
-  metadata.gz: 57aecd47776c51bafead92eaa4a245639d5b38999b04b5a12343e23c0ee97141605e4b723eb0663e4b88e775d9aba6c7458a125f4d011495d26cb0e6d17e714c
-  data.tar.gz: 6ae62810f1212d029efbc6829a29a7fee18306e8a672c5d8ab08d6907979dfaa6db2743763400d35f3f8d4c5551ab57db53dae8c88577703ddac7869e9adfc28
+  metadata.gz: a29744b9dabc937dd635e33b93270a3cdbd28c3735fd8975fd459b0193e98db38cc6e15ad499185135294f4a8fcb10ce0f52c8ecade9ed9ad81dffef23e8245a
+  data.tar.gz: bbb498bc86c6752dfdbde5a54737cd522d20c2e04e4a6a1a59737c95b2c3c7600d452049412c6338a7dc028b0d33314f606a0fd3af98623e962ef68193d21f00

data/.github/workflows/rake.yml

@@ -10,5 +10,3 @@ on:
 jobs:
   rake:
     uses: metanorma/ci/.github/workflows/graphviz-rake.yml@main
-    secrets:
-      pat_token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}

data/lib/lutaml/version.rb

@@ -1,3 +1,3 @@
 module Lutaml
-  VERSION = "0.8.1".freeze
+  VERSION = "0.9.1".freeze
 end

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

@@ -20,8 +20,15 @@ module Lutaml
         # @param options [Hash] options for parsing
         # @return [Lutaml::Uml::Document]
         def self.parse(xml, _options = {})
+          sparx_root = Xmi::Sparx::SparxRoot
+          xmi_doc = Nokogiri::XML(File.read(xml))
+          namespace = xmi_doc.at_xpath("//xmi:XMI").namespaces
+          if namespace["xmlns:uml"].split("/").last == "20131001"
+            sparx_root = Xmi::Sparx::SparxRoot2013
+          end
+
           xml_content = File.read(xml)
-          xmi_model = Xmi::Sparx::SparxRoot2013.from_xml(xml_content)
+          xmi_model = sparx_root.from_xml(xml_content)
           new.parse(xmi_model)
         end
 
@@ -42,7 +49,7 @@ module Lutaml
           model = xmi_model.model
           {
             name: model.name,
-            packages: serialize_model_packages(model)
+            packages: serialize_model_packages(model),
           }
         end
 
@@ -50,30 +57,45 @@ module Lutaml
         # @return [Array<Hash>]
         # @note xpath ./packagedElement[@xmi:type="uml:Package"]
         def serialize_model_packages(model)
-          model.packaged_element.map do |package|
+          model.packaged_element.select do |e|
+            e.type?("uml:Package")
+          end.map do |package|
             {
               xmi_id: package.id,
-              name: package.name,
+              name: get_package_name(package),
               classes: serialize_model_classes(package, model),
               enums: serialize_model_enums(package),
               data_types: serialize_model_data_types(package),
               diagrams: serialize_model_diagrams(package.id),
               packages: serialize_model_packages(package),
               definition: doc_node_attribute_value(package.id, "documentation"),
-              stereotype: doc_node_attribute_value(package.id, "stereotype")
+              stereotype: doc_node_attribute_value(package.id, "stereotype"),
             }
           end
         end
 
+        def get_package_name(package)
+          return package.name unless package.name.nil?
+
+          connector = fetch_connector(package.id)
+          if connector.target&.model && connector.target.model&.name
+            return "#{connector.target.model.name} " \
+                   "(#{package.type.split(':').last})"
+          end
+
+          "unnamed"
+        end
+
         # @param package [Shale::Mapper]
         # @param model [Shale::Mapper]
         # @return [Array<Hash>]
         # @note xpath ./packagedElement[@xmi:type="uml:Class" or
         #                               @xmi:type="uml:AssociationClass"]
         def serialize_model_classes(package, model)
-          package.packaged_element.select { |e|
-            e.type?("uml:Class") || e.type?("uml:AssociationClass")
-          }.map do |klass|
+          package.packaged_element.select do |e|
+            e.type?("uml:Class") || e.type?("uml:AssociationClass") ||
+              e.type?("uml:Interface")
+          end.map do |klass|
             {
               xmi_id: klass.id,
               name: klass.name,
@@ -84,7 +106,7 @@ module Lutaml
               constraints: serialize_class_constraints(klass.id),
               is_abstract: doc_node_attribute_value(klass.id, "isAbstract"),
               definition: doc_node_attribute_value(klass.id, "documentation"),
-              stereotype: doc_node_attribute_value(klass.id, "stereotype")
+              stereotype: doc_node_attribute_value(klass.id, "stereotype"),
             }
           end
         end
@@ -93,12 +115,12 @@ module Lutaml
         # @return [Array<Hash>]
         # @note xpath ./packagedElement[@xmi:type="uml:Enumeration"]
         def serialize_model_enums(package)
-          package.packaged_element
-            .select { |e| e.type?("uml:Enumeration") }.map do |enum|
-              # xpath .//ownedLiteral[@xmi:type="uml:EnumerationLiteral"]
-              owned_literals = enum.owned_literal.map do |owned_literal|
-                owned_literal.to_hash.transform_keys(&:to_sym)
-              end
+          package.packaged_element.select { |e| e.type?("uml:Enumeration") }
+            .map do |enum|
+            # xpath .//ownedLiteral[@xmi:type="uml:EnumerationLiteral"]
+            owned_literals = enum.owned_literal.map do |owned_literal|
+              owned_literal.to_hash.transform_keys(&:to_sym)
+            end
 
             {
               xmi_id: enum.id,
@@ -116,7 +138,7 @@ module Lutaml
         def serialize_model_data_types(model)
           all_data_type_elements = []
           select_all_packaged_elements(all_data_type_elements, model,
-            "uml:DataType")
+                                       "uml:DataType")
           all_data_type_elements.map do |klass|
             {
               xmi_id: klass.id,
@@ -144,7 +166,7 @@ module Lutaml
             {
               xmi_id: diagram.id,
               name: diagram.properties.name,
-              definition: diagram.properties.documentation
+              definition: diagram.properties.documentation,
             }
           end
         end
@@ -156,26 +178,25 @@ module Lutaml
           matched_element = @xmi_root_model.extension.elements.element
             .find { |e| e.idref == xmi_id }
 
-          return if !matched_element.links ||
+          return if !matched_element ||
+            !matched_element.links ||
             matched_element.links.association.empty?
 
           matched_element.links.association.map do |assoc|
-            link_member_name = assoc.start == xmi_id ? "end" : "start"
-            linke_owner_name = link_member_name == "start" ? "end" : "start"
+            link_member = assoc.start == xmi_id ? "end" : "start"
+            linke_owner_name = link_member == "start" ? "end" : "start"
 
             member_end, member_end_type, member_end_cardinality,
               member_end_attribute_name, member_end_xmi_id =
-              serialize_member_type(xmi_id, assoc, link_member_name)
+              serialize_member_type(xmi_id, assoc, link_member)
 
             owner_end = serialize_owned_type(xmi_id, assoc, linke_owner_name)
 
-            if member_end && ((member_end_type != 'aggregation') ||
-              (member_end_type == 'aggregation' && member_end_attribute_name))
+            if member_end && ((member_end_type != "aggregation") ||
+              (member_end_type == "aggregation" && member_end_attribute_name))
 
-              doc_node_name = (link_member_name == "start" ?
-                "source" : "target")
-              definition = fetch_definition_node_value(assoc.id,
-                doc_node_name)
+              doc_node_name = (link_member == "start" ? "source" : "target")
+              definition = fetch_definition_node_value(assoc.id, doc_node_name)
 
               {
                 xmi_id: assoc.id,
@@ -186,7 +207,7 @@ module Lutaml
                 member_end_xmi_id: member_end_xmi_id,
                 owner_end: owner_end,
                 owner_end_xmi_id: xmi_id,
-                definition: definition
+                definition: definition,
               }
             end
           end
@@ -239,7 +260,7 @@ module Lutaml
           if connector_node
             # In ea-xmi-2.5.1, constraints are moved to source/target under
             # connectors
-            constraints = [:source, :target].map do |st|
+            constraints = %i[source target].map do |st|
               connector_node.send(st).constraints.constraint
             end.flatten
 
@@ -267,8 +288,7 @@ module Lutaml
           end
 
           xmi_id = link.send(linke_owner_name.to_sym)
-          owner_end = lookup_entity_name(xmi_id) ||
-            connector_source_name(xmi_id)
+          lookup_entity_name(xmi_id) || connector_source_name(xmi_id)
 
           # not necessary
           # if link.name == "Association"
@@ -279,14 +299,13 @@ module Lutaml
           #     fetch_owned_attribute_node(xmi_id)
           # end
           # [owner_end, owned_cardinality, owned_attribute_name]
-          owner_end
+          # owner_end
         end
 
         # @param owner_xmi_id [String]
         # @param link [Shale::Mapper]
-        # @param link_member_name [String]
         # @return [Array<String, String>]
-        def serialize_member_end(owner_xmi_id, link, link_member_name)
+        def serialize_member_end(owner_xmi_id, link)
           case link.name
           when "NoteLink"
             return
@@ -313,8 +332,7 @@ module Lutaml
         # @param link_member_name [String]
         # @return [Array<String, String, Hash, String, String>]
         def serialize_member_type(owner_xmi_id, link, link_member_name)
-          member_end, xmi_id = serialize_member_end(
-            owner_xmi_id, link, link_member_name)
+          member_end, xmi_id = serialize_member_end(owner_xmi_id, link)
 
           if link.name == "Association"
             connector_type = link_member_name == "start" ? "source" : "target"
@@ -326,7 +344,7 @@ module Lutaml
           end
 
           [member_end, "aggregation", member_end_cardinality,
-            member_end_attribute_name, xmi_id]
+           member_end_attribute_name, xmi_id]
         end
 
         # @param link_id [String]
@@ -338,9 +356,9 @@ module Lutaml
 
           if assoc_connector
             assoc_connector_type = assoc_connector.type
-            if assoc_connector_type && assoc_connector_type.multiplicity
-              cardinality = assoc_connector_type.multiplicity.split('..')
-              cardinality.unshift('1') if cardinality.length == 1
+            if assoc_connector_type&.multiplicity
+              cardinality = assoc_connector_type.multiplicity.split("..")
+              cardinality.unshift("1") if cardinality.length == 1
               min, max = cardinality
             end
             assoc_connector_role = assoc_connector.role
@@ -385,15 +403,14 @@ module Lutaml
         def fetch_owned_attribute_node(xmi_id)
           all_elements = all_packaged_elements
 
-          owned_attributes = all_elements.map { |e| e.owned_attribute }.flatten
+          owned_attributes = all_elements.map(&:owned_attribute).flatten
           oa = owned_attributes.select do |a|
             !!a.association && a.uml_type && a.uml_type.idref == xmi_id
           end.first
 
           if oa
             cardinality = cardinality_min_max_value(
-              oa.lower_value&.value,
-              oa.upper_value&.value
+              oa.lower_value&.value, oa.upper_value&.value
             )
             oa_name = oa.name
           end
@@ -416,22 +433,23 @@ module Lutaml
         def serialize_class_attributes(klass)
           klass.owned_attribute.select { |attr| attr.type?("uml:Property") }
             .map do |oa|
-              uml_type = oa.uml_type
-              uml_type_idref = uml_type.idref if uml_type
-
-              if oa.association.nil?
-                {
-                  id: oa.id,
-                  name: oa.name,
-                  type: lookup_entity_name(uml_type_idref) || uml_type_idref,
-                  xmi_id: uml_type_idref,
-                  is_derived: oa.is_derived,
-                  cardinality: cardinality_min_max_value(
-                    oa.lower_value&.value,
-                    oa.upper_value&.value),
-                  definition: lookup_attribute_documentation(oa.id),
-                }
-              end
+            uml_type = oa.uml_type
+            uml_type_idref = uml_type.idref if uml_type
+
+            if oa.association.nil?
+              {
+                id: oa.id,
+                name: oa.name,
+                type: lookup_entity_name(uml_type_idref) || uml_type_idref,
+                xmi_id: uml_type_idref,
+                is_derived: oa.is_derived,
+                cardinality: cardinality_min_max_value(
+                  oa.lower_value&.value,
+                  oa.upper_value&.value,
+                ),
+                definition: lookup_attribute_documentation(oa.id),
+              }
+            end
           end.compact
         end
 
@@ -441,7 +459,7 @@ module Lutaml
         def cardinality_min_max_value(min, max)
           {
             "min" => cardinality_value(min, true),
-            "max" => cardinality_value(max, false)
+            "max" => cardinality_value(max, false),
           }
         end
 
@@ -451,7 +469,7 @@ module Lutaml
         def cardinality_value(value, is_min = false)
           return unless value
 
-          is_min ? LOWER_VALUE_MAPPINGS[value] : value
+          is_min ? LOWER_VALUE_MAPPINGS[value.to_s] : value
         end
 
         # @node [Shale::Mapper]
@@ -523,12 +541,11 @@ module Lutaml
         # @return [Array<Xmi::Uml::PackagedElement>]
         def all_packaged_elements
           all_elements = []
-          [
-            @xmi_root_model.model.packaged_element +
+          packaged_element_roots = @xmi_root_model.model.packaged_element +
             @xmi_root_model.extension.primitive_types.packaged_element +
-            @xmi_root_model.extension.profiles.profile
-              .map {|p| p.packaged_element }
-          ].flatten.each do |e|
+            @xmi_root_model.extension.profiles.profile.map(&:packaged_element)
+
+          packaged_element_roots.flatten.each do |e|
             select_all_packaged_elements(all_elements, e, nil)
           end
 
@@ -589,7 +606,7 @@ module Lutaml
               result[node.id] = node.name
             end
 
-            attrs.each_pair do |k, v|
+            attrs.each_pair do |k, _v|
               map_id_name(result, node.send(k))
             end
           end

data/lutaml.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_runtime_dependency "xmi", ">= 0.3.0"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lutaml
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expressir
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement