xmi 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ac4f03d86ac8abffeaecaf956bcd77ab9a3bb2ed6348a12f3ccb2bd587f2eec
-  data.tar.gz: 7f0051b7bbb867c4c7d82ad95fb435a4f5e5d9bb2b76e1297ded8953682489c1
+  metadata.gz: 2ffa11bdf4fbb9c95493ef25cb5662107d72e1e708d526b7a6240ed3ffcd4f99
+  data.tar.gz: ba939950443a99f5e4c402ec004f4446c9b520486faa0e90aeeaa4bfb4bc679b
 SHA512:
-  metadata.gz: 99a98d34c015c29e2170695e0e3918a98ec9a4308097a32886bd0af401808172b367c2e2da020713dc0ff2db5581c9336b4a4a64e3d3b39b225f4df5cde0296d
-  data.tar.gz: 060447e7ae2275a40e4881616dc104032c491ae4cc3bb0707bcfbcafb7bf93a068ff6cda7da3cbeb62c37c3ef5d8e34f66a1dfd1a11206b509e99d3af27a7d8e
+  metadata.gz: a23e73e4194971d9e3f8b83e3b746195ad227dd812e3777c5e3d33b59498e85448a4dd4ef3177f5e297693e7efb9a8e6a7de0ed59d9c0d6e33a1fea7b58a7290
+  data.tar.gz: 3ec9666b1313e1f5d0cb426739c7add6fea48253e8d51bf72e04323e2a7213b07877af7867e267f73c70d5c6b44e8b898375d11d137a9ac01868feb2c7cd2a22

data/.github/workflows/rake.yml

@@ -9,6 +9,10 @@ on:
 
 jobs:
   rake:
-    uses: metanorma/ci/.github/workflows/graphviz-rake.yml@main
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    with:
+      setup-tools: graphviz
+      submodules: true
+      choco-cache: true
     secrets:
       pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-04-14 03:59:00 UTC using RuboCop version 1.86.1.
+# on 2026-04-20 09:41:00 UTC using RuboCop version 1.86.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,21 +11,55 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'xmi.gemspec'
 
-# Offense count: 72
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'lib/xmi/parser_pipeline.rb'
+    - 'lib/xmi/sparx/index.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLinesAfterModuleInclusion:
+  Exclude:
+    - 'lib/xmi/sparx/gml/shared_attributes.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'lib/xmi/sparx/mappings/base_mapping.rb'
+
+# Offense count: 76
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Enabled: false
 
-# Offense count: 5
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/xmi/parser_pipeline.rb'
+    - 'lib/xmi/sparx/index.rb'
+
+# Offense count: 6
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
 Lint/ConstantDefinitionInBlock:
   Exclude:
+    - 'lib/xmi/sparx/mappings/base_mapping.rb'
     - 'spec/performance/xmi_parsing_spec.rb'
 
-# Offense count: 12
+# Offense count: 15
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
@@ -33,31 +67,34 @@ Metrics/AbcSize:
     - 'lib/tasks/performance_comparator.rb'
     - 'lib/tasks/performance_helpers.rb'
     - 'lib/xmi/ea_root.rb'
+    - 'lib/xmi/sparx/index.rb'
     - 'lib/xmi/version_registry.rb'
     - 'spec/performance/xmi_parsing_spec.rb'
 
-# Offense count: 95
+# Offense count: 96
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 143
+  Max: 98
 
-# Offense count: 1
+# Offense count: 4
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
     - 'lib/tasks/performance_helpers.rb'
+    - 'lib/xmi/sparx/index.rb'
 
-# Offense count: 26
+# Offense count: 29
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 33
 
-# Offense count: 2
+# Offense count: 4
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Exclude:
     - 'lib/tasks/performance_helpers.rb'
+    - 'lib/xmi/sparx/index.rb'
     - 'lib/xmi/version_registry.rb'
 
 # Offense count: 19
@@ -122,6 +159,12 @@ RSpec/MultipleMemoizedHelpers:
 RSpec/NestedGroups:
   Max: 4
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/MultilineIfModifier:
+  Exclude:
+    - 'lib/xmi/sparx/index.rb'
+
 # Offense count: 4
 # Configuration parameters: AllowedClasses.
 Style/OneClassPerFile:

data/lib/xmi/extension.rb

@@ -2,12 +2,8 @@
 
 module Xmi
   class Extension < Lutaml::Model::Serializable
-    attribute :id, ::Xmi::Type::XmiId
-    attribute :label, ::Xmi::Type::XmiLabel
-    attribute :uuid, ::Xmi::Type::XmiUuid
-    attribute :href, :string
-    attribute :idref, ::Xmi::Type::XmiIdRef
-    attribute :type, ::Xmi::Type::XmiType
+    include XmiIdentity::Attributes
+
     attribute :extender, :string
     attribute :extender_id, :string
 
@@ -15,12 +11,8 @@ module Xmi
       root "Extension"
       namespace ::Xmi::Namespace::Omg::Xmi
 
-      map_attribute "id", to: :id
-      map_attribute "label", to: :label
-      map_attribute "uuid", to: :uuid
-      map_attribute "href", to: :href
-      map_attribute "idref", to: :idref
-      map_attribute "type", to: :type
+      XmiIdentity.apply_xml_mappings(self)
+
       map_attribute "extender", to: :extender
       map_attribute "extenderID", to: :extender_id
     end

data/lib/xmi/parser_pipeline.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Xmi
+  # Composable pipeline for XMI parsing.
+  #
+  # Each step receives a context hash and returns an updated context hash.
+  # New concerns (validation, logging, caching) are added by inserting steps
+  # without modifying existing code — Open/Closed Principle.
+  #
+  # @example
+  #   context = { xml: xml_content, root_class: Xmi::Sparx::SparxRoot }
+  #   result = Xmi::ParserPipeline.run(context)
+  #   result[:root]  # => parsed SparxRoot instance
+  #
+  module ParserPipeline
+    module Steps
+      module FixEncoding
+        def self.call(ctx)
+          xml = ctx[:xml]
+          if xml.respond_to?(:valid_encoding?) && !xml.valid_encoding?
+            xml = xml
+              .encode("UTF-16be", invalid: :replace, replace: "?")
+              .encode("UTF-8")
+          end
+          ctx.merge(xml: xml)
+        end
+      end
+
+      module InitVersioning
+        def self.call(ctx)
+          Xmi.init_versioning!
+          ctx
+        end
+      end
+
+      module ParseXml
+        def self.call(ctx)
+          root_class = ctx[:root_class]
+          root = VersionRegistry.parse_with_detected_version(ctx[:xml],
+                                                             root_class)
+          ctx.merge(root: root)
+        end
+      end
+
+      module BuildIndex
+        def self.call(ctx)
+          root = ctx[:root]
+          root.build_index if root.respond_to?(:build_index)
+          ctx
+        end
+      end
+    end
+
+    DEFAULT_STEPS = [
+      Steps::FixEncoding,
+      Steps::InitVersioning,
+      Steps::ParseXml,
+      Steps::BuildIndex,
+    ].freeze
+
+    # Run the pipeline with default or custom steps.
+    #
+    # @param ctx [Hash] Initial context with :xml and :root_class
+    # @param steps [Array<Module>] Pipeline steps (defaults to DEFAULT_STEPS)
+    # @return [Hash] Final context including :root
+    def self.run(ctx, steps: DEFAULT_STEPS)
+      steps.reduce(ctx) { |context, step| step.call(context) }
+    end
+  end
+end

data/lib/xmi/root.rb

@@ -5,12 +5,8 @@ require_relative "uml"
 
 module Xmi
   class Root < Lutaml::Model::Serializable
-    attribute :id, ::Xmi::Type::XmiId
-    attribute :label, ::Xmi::Type::XmiLabel
-    attribute :uuid, ::Xmi::Type::XmiUuid
-    attribute :href, :string
-    attribute :idref, ::Xmi::Type::XmiIdRef
-    attribute :type, ::Xmi::Type::XmiType
+    include XmiIdentity::Attributes
+
     attribute :documentation, Documentation
     attribute :bibliography, CustomProfile::Bibliography, collection: true
     attribute :basic_doc, CustomProfile::BasicDoc, collection: true
@@ -44,12 +40,7 @@ module Xmi
         ::Xmi::Namespace::Sparx::CityGml,
       ]
 
-      map_attribute "id", to: :id
-      map_attribute "label", to: :label
-      map_attribute "uuid", to: :uuid
-      map_attribute "href", to: :href
-      map_attribute "idref", to: :idref
-      map_attribute "type", to: :type
+      XmiIdentity.apply_xml_mappings(self)
 
       map_element "Documentation", to: :documentation
       map_element "Model", to: :model

data/lib/xmi/sparx/connector/appearance.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class Appearance < Lutaml::Model::Serializable
+        attribute :linemode, :integer
+        attribute :linecolor, :integer
+        attribute :linewidth, :integer
+        attribute :seqno, :integer
+        attribute :headStyle, :integer
+        attribute :lineStyle, :integer
+
+        xml do
+          root "appearance"
+
+          map_attribute :linemode, to: :linemode
+          map_attribute :linecolor, to: :linecolor
+          map_attribute :linewidth, to: :linewidth
+          map_attribute :seqno, to: :seqno
+          map_attribute :headStyle, to: :headStyle
+          map_attribute :lineStyle, to: :lineStyle
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/connector.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class Connector < Lutaml::Model::Serializable
+        attribute :name, :string
+        attribute :idref, ::Xmi::Type::XmiIdRef
+        attribute :source, Source
+        attribute :target, Target
+        attribute :model, Model
+        attribute :properties, Properties
+        attribute :documentation, Element::Documentation
+        attribute :appearance, Appearance
+        attribute :labels, Labels
+        attribute :extended_properties, Element::ExtendedProperties
+        attribute :style, Element::Style
+        attribute :tags, Element::Tags
+        attribute :xrefs, Element::Xrefs
+
+        xml do
+          root "element"
+
+          map_attribute "name", to: :name
+          map_attribute "idref", to: :idref
+
+          map_element "source", to: :source
+          map_element "target", to: :target
+          map_element "model", to: :model
+          map_element "properties", to: :properties
+          map_element "documentation", to: :documentation, value_map: VALUE_MAP
+          map_element "appearance", to: :appearance
+          map_element "labels", to: :labels, render_nil: true
+          map_element "extendedProperties", to: :extended_properties
+          map_element "style", to: :style, render_nil: true
+          map_element "xrefs", to: :xrefs, render_nil: true
+          map_element "tags", to: :tags, render_nil: true
+        end
+      end
+
+      class Connectors < Lutaml::Model::Serializable
+        attribute :connector, Connector, collection: true
+
+        xml do
+          root "connectors"
+
+          map_element "connector", to: :connector, value_map: VALUE_MAP
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/end_base.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class End < Lutaml::Model::Serializable
+        attribute :idref, ::Xmi::Type::XmiIdRef
+        attribute :model, Model
+        attribute :role, EndRole
+        attribute :type, EndType
+        attribute :constraints, EndConstraints
+        attribute :modifiers, EndModifiers
+        attribute :style, EndStyle
+        attribute :documentation, Element::Documentation
+        attribute :xrefs, Element::Xrefs
+        attribute :tags, Element::Tags
+      end
+
+      class Source < End
+        xml do
+          root "source"
+
+          map_attribute "idref", to: :idref
+
+          map_element "model", to: :model, render_nil: true
+          map_element "role", to: :role, render_nil: true
+          map_element "type", to: :type, render_nil: true
+          map_element "constraints", to: :constraints, render_nil: true
+          map_element "modifiers", to: :modifiers, render_nil: true
+          map_element "style", to: :style, render_nil: true
+          map_element "documentation", to: :documentation, value_map: VALUE_MAP
+          map_element "xrefs", to: :xrefs, render_nil: true
+          map_element "tags", to: :tags, render_nil: true
+        end
+      end
+
+      class Target < End
+        xml do
+          root "target"
+
+          map_attribute "idref", to: :idref
+
+          map_element "model", to: :model, render_nil: true
+          map_element "role", to: :role, render_nil: true
+          map_element "type", to: :type, render_nil: true
+          map_element "constraints", to: :constraints, render_nil: true
+          map_element "modifiers", to: :modifiers, render_nil: true
+          map_element "style", to: :style, render_nil: true
+          map_element "documentation", to: :documentation, value_map: VALUE_MAP
+          map_element "xrefs", to: :xrefs, render_nil: true
+          map_element "tags", to: :tags, render_nil: true
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/end_constraint.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class EndConstraint < Lutaml::Model::Serializable
+        attribute :name, :string
+        attribute :type, ::Xmi::Type::XmiType
+        attribute :weight, :float
+        attribute :status, :string
+
+        xml do
+          root "constraint"
+
+          map_attribute "name", to: :name
+          map_attribute "type", to: :type
+          map_attribute "weight", to: :weight
+          map_attribute "status", to: :status
+        end
+      end
+
+      class EndConstraints < Lutaml::Model::Serializable
+        attribute :constraint, EndConstraint, collection: true
+
+        xml do
+          root "constraints"
+
+          map_element "constraint", to: :constraint, value_map: VALUE_MAP
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/end_modifiers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class EndModifiers < Lutaml::Model::Serializable
+        attribute :is_ordered, :boolean
+        attribute :is_navigable, :boolean
+
+        xml do
+          root "type"
+
+          map_attribute "isOrdered", to: :is_ordered
+          map_attribute "isNavigable", to: :is_navigable
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/end_role.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class EndRole < Lutaml::Model::Serializable
+        attribute :name, :string
+        attribute :visibility, :string
+        attribute :target_scope, :string
+
+        xml do
+          root "role"
+
+          map_attribute :name, to: :name
+          map_attribute :visibility, to: :visibility
+          map_attribute :targetScope, to: :target_scope
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/end_style.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class EndStyle < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          root "style"
+
+          map_attribute "value", to: :value
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/end_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class EndType < Lutaml::Model::Serializable
+        attribute :aggregation, :string
+        attribute :multiplicity, :string
+        attribute :containment, :string
+
+        xml do
+          root "type"
+
+          map_attribute :aggregation, to: :aggregation
+          map_attribute :multiplicity, to: :multiplicity
+          map_attribute :containment, to: :containment
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/labels.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class Labels < Lutaml::Model::Serializable
+        attribute :rb, :string
+        attribute :lb, :string
+        attribute :mb, :string
+        attribute :rt, :string
+        attribute :lt, :string
+        attribute :mt, :string
+
+        xml do
+          root "labels"
+
+          map_attribute :rb, to: :rb
+          map_attribute :lb, to: :lb
+          map_attribute :mb, to: :mb
+          map_attribute :rt, to: :rt
+          map_attribute :lt, to: :lt
+          map_attribute :mt, to: :mt
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/model.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class Model < Lutaml::Model::Serializable
+        attribute :ea_localid, :string
+        attribute :type, ::Xmi::Type::XmiType
+        attribute :name, :string
+
+        xml do
+          map_attribute "ea_localid", to: :ea_localid
+          map_attribute "type", to: :type
+          map_attribute "name", to: :name
+        end
+      end
+    end
+  end
+end

data/lib/xmi/sparx/connector/properties.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Xmi
+  module Sparx
+    module Connector
+      class Properties < Lutaml::Model::Serializable
+        attribute :ea_type, :string
+        attribute :direction, :string
+
+        xml do
+          root "properties"
+
+          map_attribute :ea_type, to: :ea_type
+          map_attribute :direction, to: :direction
+        end
+      end
+    end
+  end
+end