metanorma-plugin-lutaml 0.7.24 → 0.7.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca6fb652af0690c22f2677cfe39f2546cecf24a46f539fe190b5d56023d942da
-  data.tar.gz: 99b7de7844b8e9f3e2fce736f7c931a8dd2a5b1c95bf93b57520b3261f5c2b3e
+  metadata.gz: 3f52cc174af4c2cd486067a47ca4c2d48093f2bc9a4030ddbc55d9bd0629b60c
+  data.tar.gz: f657c5a57479b998913adce1a8147cbd53cdfe10b52d97d7a2a9dfc4198b21af
 SHA512:
-  metadata.gz: 754f952fbbad357aab40b9ab7e6d53af6e8195a797f8d3d4086265cfbb5d0360502b5f03bb68ce0ef02eeb51ff457931116e586273c60e2186fab49103dd33cc
-  data.tar.gz: '08cf1a352e910912d8d1c4323f5336e1e05da8fb30746a730ebd830e85e5adc07c55b23f8a01c048f4781de2b85f9295940c383b3057c2d502ec16fd0bef9745'
+  metadata.gz: 3677d003d961777f01889f4d7db189d43f236aa8a8fd0a29dfd29fbb765bb79dd101aa9fb00bc844986f1f09d23a8b3746f3c8eca88d4da5b9ed4532c3314605
+  data.tar.gz: 6f2562fa121c7b33e699412bdd70a3b68eb56916254c83b6baba1ab8cac4e286079f21b65b34213774eff761989c0d01c1e2e158a3b54ce3b0387df455c99dbf

data/lib/metanorma/plugin/lutaml/config/guidance.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Config
+        class Guidance < ::Lutaml::Model::Serializable
+          attribute :classes, GuidanceKlass, collection: true,
+                                             initialize_empty: true
+
+          yaml do
+            map "classes", to: :classes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/config/guidance_attribute.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Config
+        class GuidanceAttribute < ::Lutaml::Model::Serializable
+          attribute :name, :string
+          attribute :used, :boolean
+          attribute :guidance, :string
+
+          yaml do
+            map "name", to: :name
+            map "used", to: :used
+            map "guidance", to: :guidance
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/config/guidance_klass.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Config
+        class GuidanceKlass < ::Lutaml::Model::Serializable
+          attribute :name, :string
+          attribute :attributes, GuidanceAttribute, collection: true,
+                                                    initialize_empty: true
+
+          yaml do
+            map "name", to: :name
+            map "attributes", to: :attributes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/config/package.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Config
+        class Package < ::Lutaml::Model::Serializable
+          attribute :name, :string
+          attribute :skip_tables, :string, collection: true
+          attribute :render_entities, :string, collection: true
+
+          yaml do
+            map "name", to: :name
+            map "skip_tables", to: :skip_tables
+            map "render_entities", to: :render_entities
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/config/root.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Config
+        class Root < ::Lutaml::Model::Serializable
+          attribute :packages, Package, collection: true
+          attribute :render_style, :string
+          attribute :ea_extension, :string, collection: true
+          attribute :template_path, :string
+          attribute :section_depth, :integer
+          attribute :guidance, :string
+          attribute :skip, :string, collection: true
+          attribute :include_root, :boolean
+          attribute :package_root_level, :integer
+          attribute :render_nested_packages, :boolean
+          attribute :external_classes, :hash
+
+          yaml do
+            map "packages", to: :packages,
+                            with: {
+                              from: :packages_from_yaml,
+                              to: :packages_to_yaml,
+                            }
+            map "render_style", to: :render_style
+            map "ea_extension", to: :ea_extension
+            map "template_path", to: :template_path
+            map "section_depth", to: :section_depth
+            map "guidance", to: :guidance
+            map "include_root", to: :include_root
+            map "package_root_level", to: :package_root_level
+            map "render_nested_packages", to: :render_nested_packages
+            map "external_classes", to: :external_classes
+          end
+
+          def packages_from_yaml(model, values) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+            values.each do |value|
+              if value.is_a?(Hash)
+                if value.keys.first == "skip"
+                  # contains skip key
+                  model.skip ||= []
+                  model.skip << value["skip"]
+                else
+                  # contains skip_tables or render_entities key
+                  package = create_package_from_value(value)
+
+                  model.packages ||= []
+                  model.packages << package
+                end
+              else
+                # only contains package name
+                model.packages ||= []
+                model.packages << Package.new(name: value)
+              end
+            end
+          end
+
+          def packages_to_yaml(model, doc) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+            doc["packages"] = []
+            model.packages.each do |package|
+              if package.skip_tables || package.render_entities # rubocop:disable Style/ConditionalAssignment
+                doc["packages"] << {
+                  package.name => package.to_yaml_hash
+                    .reject { |k| k == "name" },
+                }
+              else
+                doc["packages"] << package.name
+              end
+            end
+
+            model.skip.each do |skip_package|
+              doc["packages"] << { "skip" => skip_package }
+            end
+          end
+
+          private
+
+          def create_package_from_value(value) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
+            package = Package.new
+            package.name = value.keys.first
+            package_options = value[package.name]
+
+            if package_options.key?("skip_tables")
+              package_options["skip_tables"].each do |table|
+                package.skip_tables ||= []
+                package.skip_tables << table
+              end
+            end
+
+            if package_options.key?("render_entities")
+              package_options["render_entities"].each do |entity|
+                package.render_entities ||= []
+                package.render_entities << entity
+              end
+            end
+
+            package
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "lutaml"
+require "lutaml/model"
+require_relative "config/package"
+require_relative "config/root"
+require_relative "config/guidance_attribute"
+require_relative "config/guidance_klass"
+require_relative "config/guidance"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Config
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/liquid/custom_filters.rb

@@ -7,7 +7,7 @@ module Metanorma
         module CustomFilters
           def html2adoc(input)
             # Coradoc::ReverseAdoc.convert(input)
-            Coradoc::Input::HTML.convert(input)
+            Coradoc::Input::Html.convert(input)
           end
 
           def interpolate(input)

data/lib/metanorma/plugin/lutaml/lutaml_ea_diagram_block_macro.rb

@@ -38,7 +38,10 @@ module Metanorma
           path = get_path_from_index(parent, index) if index
 
           if index && path
-            doc = lutaml_document_from_file_or_cache(parent.document, path, {})
+            doc = lutaml_document_from_file_or_cache(
+              parent.document, path,
+              Metanorma::Plugin::Lutaml::Config::Root.new
+            )
           end
 
           doc ||= parent.document.attributes["lutaml_xmi_cache"].values.first

data/lib/metanorma/plugin/lutaml/lutaml_ea_xmi_base.rb

@@ -49,7 +49,7 @@ module Metanorma
             return document.attributes["lutaml_xmi_cache"][full_path]
           end
 
-          yaml_config["ea_extension"]&.each do |ea_extension_path|
+          yaml_config.ea_extension&.each do |ea_extension_path|
             # resolve paths of ea extensions based on the location of
             # config yaml file
             ea_extension_full_path = File.expand_path(
@@ -58,29 +58,31 @@ module Metanorma
             Xmi::EaRoot.load_extension(ea_extension_full_path)
           end
 
-          guidance = get_guidance_file(document, yaml_config["guidance"])
+          guidance = get_guidance(document, yaml_config.guidance)
           result_document = parse_result_document(full_path, guidance)
           document.attributes["lutaml_xmi_cache"] ||= {}
           document.attributes["lutaml_xmi_cache"][full_path] = result_document
           result_document
         end
 
-        def get_guidance_file(document, guidance_config)
-          guidance = nil
+        def get_guidance(document, guidance_config)
+          return unless guidance_config
 
-          if guidance_config
-            guidance = Utils.relative_file_path(document,
-                                                guidance_config)
-          end
-
-          guidance
+          guidance_yaml = Utils.relative_file_path(document, guidance_config)
+          guidance = Metanorma::Plugin::Lutaml::Config::Guidance.from_yaml(
+            File.read(guidance_yaml, encoding: "UTF-8"),
+          )
+          guidance.to_yaml_hash
         end
 
         def parse_yaml_config_file(document, file_path)
-          return {} if file_path.nil?
+          return Metanorma::Plugin::Lutaml::Config::Root.new if file_path.nil?
 
           relative_file_path = Utils.relative_file_path(document, file_path)
-          YAML.safe_load(File.read(relative_file_path, encoding: "UTF-8"))
+
+          Metanorma::Plugin::Lutaml::Config::Root.from_yaml(
+            File.read(relative_file_path, encoding: "UTF-8"),
+          )
         end
 
         def processed_lines(document, input_lines)
@@ -261,14 +263,14 @@ module Metanorma
 
         def create_context_object(lutaml_document, additional_context, options) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
           root_package = package_level(lutaml_document.to_liquid,
-                                       options["package_root_level"] || 1)
-          if options.empty? || options["packages"].nil?
+                                       options.package_root_level || 1)
+          if options.packages.nil?
             return {
               "render_nested_packages" => true,
               "packages" => root_package["packages"],
               "root_packages" => [root_package],
               "additional_context" => additional_context
-                  .merge("external_classes" => options["external_classes"]),
+                  .merge("external_classes" => options.external_classes),
               "name" => root_package["name"],
             }
           end
@@ -276,41 +278,30 @@ module Metanorma
           all_packages = [root_package, *root_package["children_packages"]]
           {
             "packages" => sort_and_filter_out_packages(all_packages, options),
-            "package_entities" => package_entities(options),
-            "package_skip_sections" => package_skip_sections(options),
+            "package_entities" => package_hash(options, "render_entities"),
+            "package_skip_sections" => package_hash(options, "skip_tables"),
             "additional_context" => additional_context
-              .merge("external_classes" => options["external_classes"]),
+              .merge("external_classes" => options.external_classes),
             "root_packages" => [root_package],
-            "render_nested_packages" => options["render_nested_packages"] ||
+            "render_nested_packages" => options.render_nested_packages ||
               false,
             "name" => root_package["name"],
           }
         end
 
-        def package_entities(options) # rubocop:disable Metrics/AbcSize
-          return {} unless options["packages"]
+        def package_hash(options, key)
+          return {} unless options.packages
 
-          options["packages"].find_all do |entity|
-            entity.is_a?(Hash) && entity.values.first["render_entities"]
-          end.map do |entity|
-            [entity.keys.first,
-             entity.values.first["render_entities"].map { |n| [n, true] }.to_h]
-          end.to_h
-        end
-
-        def package_skip_sections(options) # rubocop:disable Metrics/AbcSize
-          return {} unless options["packages"]
-
-          options["packages"].find_all do |entity|
-            entity.is_a?(Hash) && entity.values.first["skip_tables"]
-          end.map do |entity|
-            [entity.keys.first,
-             entity.values.first["skip_tables"].map { |n| [n, true] }.to_h]
-          end.to_h
+          result = {}
+          packages = options.packages.reject { |p| p.send(key.to_sym).nil? }
+          packages.each do |p|
+            result[p.name] = p.send(key.to_sym).map { |n| [n, true] }.to_h
+          end
+          result
         end
 
         def sort_and_filter_out_packages(all_packages, options) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
-          return all_packages if options["packages"].nil?
+          return all_packages if options.packages.nil?
 
           result = []
           # Step one - filter out all skipped packages
@@ -322,11 +313,11 @@ module Metanorma
                                               result)
         end
 
-        def filter_out_all_skipped_packages(options, all_packages)
-          options["packages"].find_all do |entity|
-            entity.is_a?(Hash) && entity["skip"]
-          end.each do |entity|
-            entity_regexp = config_entity_regexp(entity["skip"])
+        def filter_out_all_skipped_packages(options, all_packages) # rubocop:disable Metrics/AbcSize
+          return all_packages if options.skip.nil?
+
+          options.skip.each do |skip_package|
+            entity_regexp = config_entity_regexp(skip_package)
             all_packages.delete_if do |package|
               package["name"] =~ entity_regexp
             end
@@ -335,21 +326,14 @@ module Metanorma
           all_packages
         end
 
-        def select_supplied_packages_by_pattern(options, all_packages, result) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
-          options["packages"].find_all do |entity|
-            entity.is_a?(String) || (entity.is_a?(Hash) && !entity["skip"])
-          end.each do |entity_obj|
-            entity = if entity_obj.is_a?(String)
-                       entity_obj
-                     else
-                       entity_obj.keys.first
-                     end
-            entity_regexp = config_entity_regexp(entity)
-            all_packages.each do |package|
-              if package["name"]&.match?(entity_regexp)
-                result.push(package)
+        def select_supplied_packages_by_pattern(options, all_packages, result) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          options.packages.each do |package|
+            entity_regexp = config_entity_regexp(package.name)
+            all_packages.each do |p|
+              if p["name"]&.match?(entity_regexp)
+                result.push(p)
                 all_packages.delete_if do |nest_package|
-                  nest_package["name"] == package["name"]
+                  nest_package["name"] == p["name"]
                 end
               end
             end
@@ -366,15 +350,15 @@ module Metanorma
         def model_representation(lutaml_doc, document, add_context, options) # rubocop:disable Metrics/MethodLength
           fill_in_entities_refs_attributes(document, lutaml_doc, options)
           render_result, errors = Utils.render_liquid_string(
-            template_string: template(options["section_depth"] || 2,
-                                      options["render_style"],
-                                      options["include_root"]),
+            template_string: template(options.section_depth || 2,
+                                      options.render_style,
+                                      options.include_root),
             context_items: create_context_object(lutaml_doc,
                                                  add_context,
                                                  options),
             context_name: "context",
             document: document,
-            include_path: template_path(document, options["template_path"]),
+            include_path: template_path(document, options.template_path),
           )
           Utils.notify_render_errors(document, errors)
           render_result.split("\n")

data/lib/metanorma/plugin/lutaml/lutaml_klass_table_block_macro.rb

@@ -4,6 +4,8 @@ module Metanorma
   module Plugin
     module Lutaml
       class LutamlKlassTableBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
+        include LutamlEaXmiBase
+
         DEFAULT_TEMPLATE = File.join(
           Gem::Specification.find_by_name("metanorma-plugin-lutaml").gem_dir,
           "lib", "metanorma", "plugin", "lutaml", "liquid_templates",
@@ -22,10 +24,9 @@ module Metanorma
             )
           end
 
+          guidance = nil
           if attrs["guidance"]
-            attrs["guidance"] = Utils.relative_file_path(
-              parent.document, attrs["guidance"]
-            )
+            guidance = get_guidance(parent.document, attrs["guidance"])
           end
 
           path = if !attrs["path"].nil?
@@ -37,7 +38,7 @@ module Metanorma
                  end
 
           klass = ::Lutaml::XMI::Parsers::XML.serialize_generalization_by_name(
-            xmi_path, path, attrs["guidance"]
+            xmi_path, path, guidance
           )
 
           render(klass, parent, attrs)

data/lib/metanorma/plugin/lutaml/version.rb

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      VERSION = "0.7.24".freeze
+      VERSION = "0.7.25".freeze
     end
   end
 end

data/lib/metanorma-plugin-lutaml.rb

@@ -1,4 +1,5 @@
 require "metanorma/plugin/lutaml/version"
+require "metanorma/plugin/lutaml/config"
 require "metanorma/plugin/lutaml/lutaml_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_ea_xmi_preprocessor"

data/metanorma-plugin-lutaml.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "coradoc", "~> 1.1.1"
   spec.add_dependency "expressir", "~> 2.1.13"
   spec.add_dependency "liquid"
-  spec.add_dependency "lutaml", "~> 0.9.25"
+  spec.add_dependency "lutaml", "~> 0.9.32"
   spec.add_dependency "ogc-gml", "~>1.0.0"
   spec.add_dependency "relaton-cli"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.24
+  version: 0.7.25
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.25
+        version: 0.9.32
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.25
+        version: 0.9.32
 - !ruby/object:Gem::Dependency
   name: ogc-gml
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +129,12 @@ files:
 - bin/setup
 - lib/metanorma-plugin-lutaml.rb
 - lib/metanorma/plugin/lutaml/asciidoctor/preprocessor.rb
+- lib/metanorma/plugin/lutaml/config.rb
+- lib/metanorma/plugin/lutaml/config/guidance.rb
+- lib/metanorma/plugin/lutaml/config/guidance_attribute.rb
+- lib/metanorma/plugin/lutaml/config/guidance_klass.rb
+- lib/metanorma/plugin/lutaml/config/package.rb
+- lib/metanorma/plugin/lutaml/config/root.rb
 - lib/metanorma/plugin/lutaml/liquid/custom_filters.rb
 - lib/metanorma/plugin/lutaml/liquid/multiply_local_file_system.rb
 - lib/metanorma/plugin/lutaml/liquid_drops/gml_dictionary_drop.rb