lutaml 0.9.16 → 0.9.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9ce0b2a08e394c3bc780813f6757140e853bf55538c9037f1878e5fc6e48e75
-  data.tar.gz: 53c686e02bf1062116952910781b6076c8226d465b7794014e28dd2d5d81420a
+  metadata.gz: a78a8cd7a54dcb75279728cff484e7a8bfcbc3258f8a8ee155a2368ce21ade87
+  data.tar.gz: 823a52c70df804f61e430d143471daf3580f271331e02306501f06925ed55346
 SHA512:
-  metadata.gz: 571d7dee97ae2dd44fe3591a61605d1049894a5a6a35e92e4b41fec70e8a758e999646a3b2719c167f15a4ef6ed710f9dc1d83b8050abc74282443dce9a0c0c2
-  data.tar.gz: 8784ca132a325ace2142d9eb16599209a060f6e62b7015172bc64a831b44656effb18f11a91bc9247b4ae10f97148d458b281290cf17efc604efc2919b7cc862
+  metadata.gz: 0466df4efa98e478bbfdb1e5739425bd02b59e20d8c780d3caea203ce87e99183a5c8f003c6418a76be7dc0abb0346a57403b7b7fde9b6d11f2810186f24ce4f
+  data.tar.gz: 2c342890469f5022c5d3040e9ca7f2c7dbe302f339356458fb62558c6da382c7281133acc344a1de9649815bca5ea0175265aae1eaf7373c44c87ed3f51acd57

data/lib/lutaml/formatter/graphviz.rb

@@ -189,7 +189,7 @@ module Lutaml
       def format_label(name, cardinality = {})
         res = "+#{name}"
         if cardinality.nil? ||
-            (cardinality["min"].nil? || cardinality["max"].nil?)
+            (cardinality[:min].nil? || cardinality[:max].nil?)
           return res
         end
 

data/lib/lutaml/uml/formatter/graphviz.rb

@@ -148,13 +148,13 @@ module Lutaml
           if node.owner_end_attribute_name
             attributes["headlabel"] = format_label(
               node.owner_end_attribute_name,
-              node.owner_end_cardinality
+              node.owner_end_cardinality,
             )
           end
           if node.member_end_attribute_name
             attributes["taillabel"] = format_label(
               node.member_end_attribute_name,
-              node.member_end_cardinality
+              node.member_end_cardinality,
             )
           end
 
@@ -192,7 +192,7 @@ module Lutaml
         def format_label(name, cardinality = {})
           res = "+#{name}"
           if cardinality.nil? ||
-              (cardinality["min"].nil? || cardinality["max"].nil?)
+              (cardinality[:min].nil? || cardinality[:max].nil?)
             return res
           end
 

data/lib/lutaml/version.rb

@@ -1,3 +1,3 @@
 module Lutaml
-  VERSION = "0.9.16".freeze
+  VERSION = "0.9.18".freeze
 end

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

@@ -8,11 +8,11 @@ module Lutaml
       end
 
       def min
-        @model["min"]
+        @model[:min]
       end
 
       def max
-        @model["max"]
+        @model[:max]
       end
     end
   end

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

@@ -3,15 +3,11 @@
 module Lutaml
   module XMI
     class GeneralizationAttributeDrop < Liquid::Drop
-      LOWER_VALUE_MAPPINGS = {
-        "C" => "0",
-        "M" => "1",
-      }.freeze
-
-      def initialize(attr, upper_klass, gen_name) # rubocop:disable Lint/MissingSuper
+      def initialize(attr, upper_klass, gen_name, guidance = nil) # rubocop:disable Lint/MissingSuper
         @attr = attr
         @upper_klass = upper_klass
         @gen_name = gen_name
+        @guidance = guidance
       end
 
       def id
@@ -35,18 +31,7 @@ module Lutaml
       end
 
       def cardinality
-        min = @attr[:cardinality]["min"]
-        min = min.nil? ? nil : LOWER_VALUE_MAPPINGS[min]
-
-        "#{min}..#{@attr[:cardinality]['max']}"
-      end
-
-      def min_cardinality
-        @attr[:cardinality]["min"]
-      end
-
-      def max_cardinality
-        @attr[:cardinality]["max"]
+        ::Lutaml::XMI::CardinalityDrop.new(@attr[:cardinality])
       end
 
       def definition
@@ -84,6 +69,25 @@ module Lutaml
         name_ns = upper_klass if name_ns.nil?
         name_ns
       end
+
+      def used?
+        if @guidance
+          col_name = "#{name_ns}:#{name}"
+          attr = @guidance["attributes"].find { |a| a["name"] == col_name }
+          return attr["used"] if attr
+        end
+
+        true
+      end
+
+      def guidance
+        if @guidance
+          col_name = "#{name_ns}:#{name}"
+          attr = @guidance["attributes"].find { |a| a["name"] == col_name }
+
+          attr["guidance"] if attr
+        end
+      end
     end
   end
 end

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

@@ -3,11 +3,12 @@
 module Lutaml
   module XMI
     class GeneralizationDrop < Liquid::Drop
-      def initialize(gen) # rubocop:disable Lint/MissingSuper
+      def initialize(gen, guidance = nil) # rubocop:disable Lint/MissingSuper
         @gen = gen
         @looped_general_item = false
         @inherited_props = []
         @inherited_assoc_props = []
+        @guidance = guidance
       end
 
       def id
@@ -23,7 +24,7 @@ module Lutaml
       end
 
       def general
-        GeneralizationDrop.new(@gen[:general]) if @gen[:general]
+        GeneralizationDrop.new(@gen[:general], @guidance) if @gen[:general]
       end
 
       def has_general?
@@ -54,7 +55,7 @@ module Lutaml
         attributes.select do |attr|
           attr[:association].nil?
         end.map do |attr|
-          GeneralizationAttributeDrop.new(attr, upper_klass, name)
+          GeneralizationAttributeDrop.new(attr, upper_klass, name, @guidance)
         end
       end
 
@@ -63,7 +64,7 @@ module Lutaml
         attributes.select do |attr|
           attr[:association]
         end.map do |attr|
-          GeneralizationAttributeDrop.new(attr, upper_klass, name)
+          GeneralizationAttributeDrop.new(attr, upper_klass, name, @guidance)
         end
       end
 
@@ -89,7 +90,7 @@ module Lutaml
           # reverse the order to show super class first
           general_item.attributes.reverse_each do |attr|
             attr_drop = GeneralizationAttributeDrop.new(attr, gen_upper_klass,
-                                                        gen_name)
+                                                        gen_name, @guidance)
             if attr[:association]
               @inherited_assoc_props << attr_drop
             else

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

@@ -3,8 +3,17 @@
 module Lutaml
   module XMI
     class KlassDrop < Liquid::Drop
-      def initialize(model) # rubocop:disable Lint/MissingSuper
+      def initialize(model, guidance = nil) # rubocop:disable Lint/MissingSuper
         @model = model
+        @guidance = guidance
+
+        if guidance && guidance["classes"].map do |c|
+          c["name"]
+        end.include?(@model[:name])
+          @klass_guidance = guidance["classes"].find do |klass|
+            klass["name"] == @model[:name]
+          end
+        end
       end
 
       def xmi_id
@@ -16,7 +25,7 @@ module Lutaml
       end
 
       def package
-        ::Lutaml::XMI::PackageDrop.new(@model[:package])
+        ::Lutaml::XMI::PackageDrop.new(@model[:package], @guidance)
       end
 
       def type
@@ -50,7 +59,8 @@ module Lutaml
       def generalization
         return {} if @model[:generalization].nil?
 
-        ::Lutaml::XMI::GeneralizationDrop.new(@model[:generalization])
+        ::Lutaml::XMI::GeneralizationDrop.new(@model[:generalization],
+                                              @klass_guidance)
       end
 
       def is_abstract

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

@@ -3,8 +3,9 @@
 module Lutaml
   module XMI
     class PackageDrop < Liquid::Drop
-      def initialize(model) # rubocop:disable Lint/MissingSuper
+      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
@@ -20,7 +21,7 @@ module Lutaml
 
       def klasses
         @model[:classes].map do |klass|
-          ::Lutaml::XMI::KlassDrop.new(klass)
+          ::Lutaml::XMI::KlassDrop.new(klass, @guidance)
         end
       end
       alias classes klasses
@@ -45,7 +46,7 @@ module Lutaml
 
       def packages
         @model[:packages].map do |package|
-          ::Lutaml::XMI::PackageDrop.new(package)
+          ::Lutaml::XMI::PackageDrop.new(package, @guidance)
         end
       end
 

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

@@ -3,8 +3,9 @@
 module Lutaml
   module XMI
     class RootDrop < Liquid::Drop
-      def initialize(model) # rubocop:disable Lint/MissingSuper
+      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
@@ -16,7 +17,7 @@ module Lutaml
 
       def packages
         @model[:packages].map do |package|
-          ::Lutaml::XMI::PackageDrop.new(package)
+          ::Lutaml::XMI::PackageDrop.new(package, @guidance)
         end
       end
 

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

@@ -10,10 +10,6 @@ module Lutaml
     module Parsers
       # Class for parsing .xmi schema files into ::Lutaml::Uml::Document
       class XML
-        LOWER_VALUE_MAPPINGS = {
-          "0" => "C",
-          "1" => "M",
-        }.freeze
         attr_reader :xmi_cache, :xmi_root_model
 
         class << self
@@ -35,17 +31,17 @@ module Lutaml
 
           # @param xml [String] path to xml
           # @return [Liquid::Drop]
-          def serialize_xmi_to_liquid(xml)
+          def serialize_xmi_to_liquid(xml, guidance = nil)
             xmi_model = get_xmi_model(xml)
-            new.serialize_xmi_to_liquid(xmi_model)
+            new.serialize_xmi_to_liquid(xmi_model, guidance)
           end
 
           # @param xml [String] path to xml
           # @param name [String]
           # @return [Hash]
-          def serialize_generalization_by_name(xml, name)
+          def serialize_generalization_by_name(xml, name, guidance = nil)
             xmi_model = get_xmi_model(xml)
-            new.serialize_generalization_by_name(xmi_model, name)
+            new.serialize_generalization_by_name(xmi_model, name, guidance)
           end
 
           private
@@ -81,23 +77,32 @@ module Lutaml
 
         # @param xmi_model [Shale::Mapper]
         # return [Liquid::Drop]
-        def serialize_xmi_to_liquid(xmi_model)
+        def serialize_xmi_to_liquid(xmi_model, guidance_yaml = nil)
           set_xmi_model(xmi_model)
           serialized_hash = serialize_xmi(xmi_model, with_gen: true)
+          guidance = get_guidance(guidance_yaml)
+          ::Lutaml::XMI::RootDrop.new(serialized_hash, guidance)
+        end
+
+        # @param yaml [String]
+        # @return [Hash]
+        def get_guidance(yaml)
+          return unless yaml
 
-          ::Lutaml::XMI::RootDrop.new(serialized_hash)
+          YAML.safe_load(File.read(yaml, encoding: "UTF-8"))
         end
 
         # @param xmi_model [Shale::Mapper]
         # @param name [String]
         # @return [Hash]
-        def serialize_generalization_by_name(xmi_model, name)
+        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)
           serialized_hash = build_klass_hash(klass, model, with_gen: true)
-
-          ::Lutaml::XMI::KlassDrop.new(serialized_hash)
+          guidance = get_guidance(guidance_yaml)
+          ::Lutaml::XMI::KlassDrop.new(serialized_hash, guidance)
         end
 
         private
@@ -255,11 +260,10 @@ module Lutaml
         end
 
         # @param general_node [Shale::Mapper]
-        # # @return [Hash]
+        # @return [Hash]
         def get_general_attributes(general_node)
-          serialize_class_attributes(general_node, with_assoc: true)
-          # turn on sorting if necessary
-          # attrs.sort_by { |i| i[:name] }
+          attrs = serialize_class_attributes(general_node, with_assoc: true)
+          attrs.sort_by { |i| i[:name].to_s }
         end
 
         # @param general_node [Shale::Mapper]
@@ -767,20 +771,11 @@ module Lutaml
         # @return [Hash]
         def cardinality_min_max_value(min, max)
           {
-            "min" => cardinality_value(min, true),
-            "max" => cardinality_value(max, false),
+            min: min,
+            max: max,
           }
         end
 
-        # @param value [String]
-        # @param is_min [Boolean]
-        # @return [String]
-        def cardinality_value(value, is_min = false)
-          return unless value
-
-          is_min ? LOWER_VALUE_MAPPINGS[value.to_s] : value
-        end
-
         # @node [Shale::Mapper]
         # @attr_name [String]
         # @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lutaml
 version: !ruby/object:Gem::Version
-  version: 0.9.16
+  version: 0.9.18
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-04 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid