metanorma-plugin-lutaml 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e0301e71943b66bb50f4fee26b345b9146762beab3c65603a9c05f9a42cbcac
-  data.tar.gz: 34158f6f955d044c1ff8a01f1d4ab8844b39b870bc6439a1bfbc0af4be0c9321
+  metadata.gz: d134d7bb5546dc1d21dabdd8a0611fce32830f4d7942b00f1f8aaf63e40b9eb9
+  data.tar.gz: bb71ead1f2a50bb83908a380cea9f1fb080a57a2205d97271bb902479c093cae
 SHA512:
-  metadata.gz: f27aceca1cd9b9136afd7ba7e5dca7e862b9ae88312bf2ae8f450783128194fd16d8e7358649023531e42d9982938a33f52ebd3dd699274a95b9b0d15d7057df
-  data.tar.gz: fc3a3a2e78f283a4803b5af7485885e3e14d9c4769b05257e4cc2804cb62a05ddccceeaec275eec2338a9d990c712587853274cdb9149e211a47a8eb3a2e9aa2
+  metadata.gz: 2a38a30e6d4c2ef401f224a0f295f43755ed0192d6bd6871ca27e6de3ea67ca0495f054bf8376f558ed0bd22463cdae2c5701f1b169221b49b54374aacec6d77
+  data.tar.gz: a8d3633c7bc481a3063dc2a31fc3d39c783380eea51089b9675487efb7de718b77837f3402b9dea545195d4fe96c5b1806ecae5978fc65a5905ab6ba27fc8500

data/Gemfile

@@ -6,4 +6,10 @@ git_source(:github) { |repo| "https://github.com/#{repo}" }
 
 gemspec
 
-eval_gemfile("Gemfile.devel") rescue nil
+begin
+  eval_gemfile("Gemfile.devel")
+rescue StandardError
+  nil
+end
+
+gem "ogc-gml", github: "lutaml/ogc-gml"

data/README.adoc

@@ -273,6 +273,97 @@ diagram MyView {
 ....
 ----
 
+=== Rendering a LutaML Enterprise Architect diagram from XMI: `lutaml_ea_diagram`
+
+This command allows to quickly render a LutaML diagram as an image file by
+specifying the name of diagram.
+
+[source,adoc]
+-----
+lutaml_ea_diagram::[name="name_of_diagram",base_path="/path/to/xmi-images",format="png"]
+-----
+
+The code will search the diagram with name `name_of_diagram` and then
+render it as:
+
+[source,adoc]
+-----
+[[figure-{{ diagram.xmi_id }}]]
+.{{ diagram.name }}
+image::{{ image_base_path }}/{{ diagram.xmi_id }}.{{ format | default: 'png' }}[]
+-----
+
+=== Rendering a LutaML GML Dictionary: `lutaml_gml_dictionary`
+
+This command allows to render a LutaML GML Dictionary by using Liquid Drop.
+
+GmlDictionaryDrop has the following attributes:
+
+* name
+* file_name
+* dictionary_entry
+
+Each `dictionary_entry` has the following attributes:
+
+* name
+* description
+
+[source,adoc]
+-----
+lutaml_gml_dictionary::/path/to/dictionary.xml[template="/path/to/template.liquid",context=dict]
+-----
+
+The command accepts the options listed below:
+
+* `"/path/to/dictionary.xml` specifies the path of xml file of the
+GML Dictionary.
+
+* `template="/path/to/template.liquid"` specifies the liquid template.
+  For example, you can create a liquid template and link it by `template`.
+
+* `context=dict` define the context in the template.
+
+[source,adoc]
+-----
+[cols="3a,22a"]
+|===
+| Name | {{ dict.file_name }}
+
+h| Code h| Description
+{% for entry in dict.dictionary_entry %}
+| {{ entry.name }} | {{ entry.description }}
+{% endfor %}
+|===
+
+[.source]
+<<source_link>>
+-----
+
+In spite of specifying the path of the template, you can also define an inline
+template within a block by
+`[lutaml_gml_dictionary,"/path/to/dictionary.xml",context=dict]`.
+
+[source,adoc]
+-----
+[lutaml_gml_dictionary,"/path/to/dictionary.xml",context=dict]
+--
+{% capture link %}https://www.test.com/{{ dict.file_name }}{% endcapture %}
+
+[cols="3a,22a"]
+|===
+| File Name | {{ dict.file_name }}
+h| URL | {{ link }}
+h| Help | Description
+{% for entry in dict.dictionary_entry %}
+| {{ entry.name }} | {{ entry.description }}
+{% endfor %}
+|===
+
+[.source]
+<<source_link>>
+--
+-----
+
 === Generating UML class and attributes: `lutaml_uml_class`
 
 This command allows rendering a definition clause for a UML class.
@@ -490,7 +581,7 @@ Where:
 
 * `[.after, package="Another"]` - block text to be inserted before(after in case of `.before` name) the package
 
-* `[.package_text, position="after", package="Another"]` - include custom adoc code into package rendered body, `position` is a arequired attribute which tells where to insert the code.
+* `[.package_text, position="after", package="Another"]` - include custom adoc code into package rendered body, `position` is a a required attribute which tells where to insert the code.
 
 * `[.package_text, package="Another"]` - same as above, but include block will be included only for supplied package name
 

data/lib/metanorma/plugin/lutaml/liquid_drops/gml_dictionary_drop.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "ogc/gml/dictionary"
+
+class GmlDictionaryDrop < Liquid::Drop
+  def initialize(dict) # rubocop:disable Lint/MissingSuper
+    @dict = dict
+  end
+
+  def name
+    @dict.name.join("")
+  end
+
+  def file_name
+    "#{name}.xml"
+  end
+
+  def dictionary_entry
+    @dict.dictionary_entry.map do |entry|
+      GmlDictionaryEntryDrop.new(entry)
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/liquid_drops/gml_dictionary_entry_drop.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "ogc/gml/dictionary"
+
+class GmlDictionaryEntryDrop < Liquid::Drop
+  def initialize(dict_entry) # rubocop:disable Lint/MissingSuper
+    @dict_entry = dict_entry
+  end
+
+  def name
+    @dict_entry.definition.name.first.content
+  end
+
+  def description
+    @dict_entry.definition.description
+  end
+end

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages_class.liquid

@@ -3,7 +3,7 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-[[section-{{ klass.xmi_id }}]]
+[[section-{{ klass.type }}-{{ klass.xmi_id }}]]
 .Elements of “{{ package.name }}::{{ klass.name }}” ({{ klass.stereotype }})
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "metanorma/plugin/lutaml/lutaml_diagram_base"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class LutamlEaDiagramBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
+        include LutamlDiagramBase
+
+        use_dsl
+        named :lutaml_ea_diagram
+
+        def process(parent, _target, attrs)
+          orig_doc = parent.document.attributes["lutaml_xmi_cache"]
+            .values.first.original_document
+          diagram = fetch_diagram_by_name(orig_doc, attrs["name"])
+          return if diagram.nil?
+
+          through_attrs = generate_attrs(attrs)
+          through_attrs["target"] =
+            img_src_path(parent.document, attrs, diagram)
+          through_attrs["title"] = diagram.name
+
+          create_image_block(parent, through_attrs)
+        end
+
+        private
+
+        def img_src_path(document, attrs, diagram)
+          base_path = attrs["base_path"]
+          format = attrs["format"] || "png"
+          img_path = Utils.relative_file_path(document, base_path)
+
+          "#{img_path}/#{diagram.xmi_id}.#{format}"
+        end
+
+        def fetch_diagram_by_name(orig_doc, name)
+          found_diagrams = []
+          loop_sub_packages(orig_doc.packages.first, name, found_diagrams)
+          found_diagrams.first
+        end
+
+        def loop_sub_packages(package, name, found_diagrams)
+          found_diagram = package.diagrams.find { |diag| diag.name == name }
+
+          found_diagrams << found_diagram if found_diagram
+
+          package.packages.each do |sub_package|
+            loop_sub_packages(sub_package, name, found_diagrams)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "ogc/gml/dictionary"
+require "liquid"
+require_relative "liquid_drops/gml_dictionary_drop"
+require_relative "liquid_drops/gml_dictionary_entry_drop"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      module LutamlGmlDictionaryBase
+        private
+
+        def render(tmpl, parent, attrs, orig_gml_path)
+          dict = get_gml_dictionary(parent, orig_gml_path)
+          tmpl.assigns[attrs["context"]] = GmlDictionaryDrop.new(dict)
+          rendered_tmpl = tmpl.render
+          block = create_open_block(parent, "", attrs)
+          parse_content(block, rendered_tmpl, attrs)
+        end
+
+        def get_gml_dictionary(parent, orig_gml_path)
+          gml_path = Utils.relative_file_path(
+            parent.document, orig_gml_path
+          )
+          Ogc::Gml::Dictionary.from_xml(xml_content(gml_path))
+        end
+
+        def xml_content(filepath)
+          File.read(filepath).gsub(
+            'xmlns:gml="http://www.opengis.net/gml"',
+            'xmlns:gml="http://www.opengis.net/gml/3.2"',
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class LutamlGmlDictionaryBlock < ::Asciidoctor::Extensions::BlockProcessor
+        include LutamlGmlDictionaryBase
+        use_dsl
+        named :lutaml_gml_dictionary
+        on_context :open
+        parse_content_as :raw
+
+        def process(parent, reader, attrs)
+          lines = reader.lines
+          tmpl = ::Liquid::Template.parse(lines.join("\n"))
+          render(tmpl, parent, attrs, attrs[2])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class LutamlGmlDictionaryBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
+        include LutamlGmlDictionaryBase
+        use_dsl
+        named :lutaml_gml_dictionary
+
+        def process(parent, target, attrs)
+          tmpl = gml_dictionary_template(
+            parent.document,
+            attrs["template"],
+          )
+
+          render(tmpl, parent, attrs, target)
+        end
+
+        private
+
+        def gml_dictionary_template(document, template_path)
+          if template_path.nil?
+            document.logger.warn("Template not found!")
+          end
+
+          rel_tmpl_path = Utils.relative_file_path(
+            document, template_path
+          )
+
+          ::Liquid::Template.parse(File.read(rel_tmpl_path))
+        end
+      end
+    end
+  end
+end

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

@@ -52,10 +52,11 @@ module Metanorma
             return document.attributes["lutaml_xmi_cache"][full_path]
           end
 
-          if yaml_config["ea_extension"] && !yaml_config["ea_extension"].empty?
-            ea_extension_path = yaml_config["ea_extension"].first
-            ea_extension_full_path = Utils.relative_file_path(document, ea_extension_path)
-            Xmi::EaRoot.load_mdg_extension(ea_extension_full_path)
+          yaml_config["ea_extension"]&.each do |ea_extension_path|
+            ea_extension_full_path = File.expand_path(
+              ea_extension_path, File.dirname(file_path)
+            )
+            Xmi::EaRoot.load_extension(ea_extension_full_path)
           end
 
           result_document = ::Lutaml::Parser
@@ -204,6 +205,8 @@ options)
             "additional_context" => additional_context
               .merge("external_classes" => options["external_classes"]),
             "root_packages" => [root_package],
+            "render_nested_packages" => options["render_nested_packages"] ||
+              false,
             "name" => root_package["name"],
           }
         end

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

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

data/lib/metanorma-plugin-lutaml.rb

@@ -7,6 +7,10 @@ require "metanorma/plugin/lutaml/lutaml_diagram_block"
 require "metanorma/plugin/lutaml/lutaml_diagram_block_macro"
 require "metanorma/plugin/lutaml/lutaml_figure_inline_macro"
 require "metanorma/plugin/lutaml/lutaml_table_inline_macro"
+require "metanorma/plugin/lutaml/lutaml_ea_diagram_block_macro"
+require "metanorma/plugin/lutaml/lutaml_gml_dictionary_base"
+require "metanorma/plugin/lutaml/lutaml_gml_dictionary_block_macro"
+require "metanorma/plugin/lutaml/lutaml_gml_dictionary_block"
 
 module Metanorma
   module Plugin

data/metanorma-plugin-lutaml.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "coradoc"
   spec.add_dependency "expressir", "~> 1.4.0"
   spec.add_dependency "liquid"
-  spec.add_dependency "lutaml"
+  spec.add_dependency "lutaml", ">= 0.9.4"
   spec.add_dependency "relaton-cli"
 
   spec.add_development_dependency "debug"
@@ -37,7 +37,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "metanorma-standoc"
   spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "= 0.54.0"
+  spec.add_development_dependency "rspec-html-matchers"
+  spec.add_development_dependency "rubocop", "~> 1.58"
+  spec.add_development_dependency "rubocop-performance", "~> 1.19"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "vcr", "~> 5.0.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-23 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
   name: relaton-cli
   requirement: !ruby/object:Gem::Requirement
@@ -164,20 +164,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.58'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -274,6 +302,8 @@ files:
 - lib/metanorma/plugin/lutaml/express_remarks_decorator.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
+- lib/metanorma/plugin/lutaml/liquid_drops/gml_dictionary_entry_drop.rb
 - lib/metanorma/plugin/lutaml/liquid_templates/_diagrams_block.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_class.liquid
@@ -289,7 +319,11 @@ files:
 - lib/metanorma/plugin/lutaml/lutaml_diagram_base.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block_macro.rb
+- lib/metanorma/plugin/lutaml/lutaml_ea_diagram_block_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_figure_inline_macro.rb
+- lib/metanorma/plugin/lutaml/lutaml_gml_dictionary_base.rb
+- lib/metanorma/plugin/lutaml/lutaml_gml_dictionary_block.rb
+- lib/metanorma/plugin/lutaml/lutaml_gml_dictionary_block_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_table_inline_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor.rb