metanorma-plugin-lutaml 0.4.20 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e771e99cf0ac118f04aa3b40610b0e071ff98d78ebaa34b7ac4516636a2e1808
-  data.tar.gz: 17ae5e488c425071a80aaa0799736b1f336611ef0caa68e2eebaa0788df86383
+  metadata.gz: 7e9b3ce23d274ff457c34d3c5a9e2bf73d12d8cd4de898a061f6a3522bb45439
+  data.tar.gz: 79a063b985b79fa7b835bbc73acd0ada7761c496f058bcfc8d455882cb6d95ea
 SHA512:
-  metadata.gz: 8260ba15824b2e1838e34e3ba3f5d954ee3dfaf6b697821ce55972aa8b428ea12a932b6eafb71275e5958b971f65a30481431c86a34f1de9e6b1a28d7c68010c
-  data.tar.gz: '008027e782ef69b19b6132a6fd139b8f04cd7dd5cc6e7ada361ef4c70c36923023213d3eccc4b30118c64421574700d1cf83677969047d99bceaf440e08bd8e4'
+  metadata.gz: 20896ef23b4b4a2258e3803a9d07bca26778f495aa57dfdd5bcd878ac6db1c09d139a066b7e6dde086e25b1c4a77b74266ae7f51f251613c783a4be7d38771da
+  data.tar.gz: b10b0ce496d8ac08e4cd83d85065c94292f4846dcaf27544fdc122fba228c9303395076d42e2fd5eecc12090f16faeb564b0300c7bc40ea37f3648dae433ec25

data/.github/workflows/release.yml

@@ -7,11 +7,12 @@ on:
     inputs:
       next_version:
         description: |
-          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
         required: true
         default: 'skip'
-  push:
-    tags: [ v* ]
+  repository_dispatch:
+    types: [ do-release ]
 
 jobs:
   release:

data/Gemfile

@@ -1,4 +1,9 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
 source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}" }
 
-# Specify your gem's dependencies in metanorma-plugin-lutaml.gemspec
 gemspec
+
+eval_gemfile("Gemfile.devel") rescue nil

data/README.adoc

@@ -646,4 +646,4 @@ render.
 
 == Documentation
 
-Please refer to https://www.metanorma.oeg.
+Please refer to https://www.metanorma.org.

data/lib/metanorma/plugin/lutaml/asciidoctor/preprocessor.rb

@@ -0,0 +1,14 @@
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Asciidoctor
+        class PreprocessorNoIfdefsReader < ::Asciidoctor::PreprocessorReader
+          def preprocess_conditional_directive(_keyword, _target, _delimiter,
+_text)
+            false # decline to resolve idefs
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -45,7 +45,8 @@ module Metanorma
         def prefix_relative_paths(line, path_prefix)
           line.gsub(RELATIVE_PREFIX_MACRO_REGEXP) do |_match|
             prefixed_path = File.join(path_prefix, $3.strip)
-            # When we are dealing with arelative path of a template: ../path/to/file we need to transform it into
+            # When we are dealing with a relative path of a template:
+            # ../path/to/file we need to transform it into
             # the absolute one because `image::` macro wont understand it other way
             prefixed_path = File.absolute_path(prefixed_path) if prefixed_path.start_with?('../')
             full_path = File.expand_path(prefixed_path)

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

@@ -13,7 +13,8 @@ module Metanorma
     module Lutaml
       module LutamlDiagramBase
         def process(parent, reader, attrs)
-          uml_document = ::Lutaml::Uml::Parsers::Dsl.parse(lutaml_file(parent.document, reader))
+          uml_document = ::Lutaml::Uml::Parsers::Dsl
+            .parse(lutaml_file(parent.document, reader))
           filename = generate_file(parent, reader, uml_document)
           through_attrs = generate_attrs(attrs)
           through_attrs["target"] = filename
@@ -23,8 +24,8 @@ module Metanorma
           abort(parent, reader, attrs, e.message)
         end
 
-        def lutaml_file(reader)
-          raise 'Implement me!'
+        def lutaml_file(_reader)
+          raise "Implement me!"
         end
 
         protected
@@ -36,7 +37,7 @@ module Metanorma
           create_listing_block(
             parent,
             source,
-            attrs.reject { |k, _v| k == 1 }
+            attrs.reject { |k, _v| k == 1 },
           )
         end
 
@@ -47,14 +48,16 @@ module Metanorma
 
           path_lutaml = "lutaml"
           imagesdir = if parent.document.attr("imagesdir")
-                        File.join(parent.document.attr("imagesdir"), path_lutaml)
+                        File.join(parent.document.attr("imagesdir"),
+                                  path_lutaml)
                       else
                         path_lutaml
                       end
           result_path = Utils.relative_file_path(parent.document, imagesdir)
           result_pathname = Pathname.new(result_path)
           result_pathname.mkpath
-          File.writable?(result_pathname) || raise("Destination path #{result_path} not writable for Lutaml!")
+          File.writable?(result_pathname) ||
+            raise("Destination path #{result_path} not writable for Lutaml!")
 
           outfile = Tempfile.new(["lutaml", ".png"])
           outfile.binmode
@@ -67,7 +70,7 @@ module Metanorma
           filename = File.basename(outfile.path)
           FileUtils.cp(outfile, result_pathname) && outfile.unlink
 
-          #File.join(result_pathname, filename)
+          # File.join(result_pathname, filename)
           File.join(path_lutaml, filename)
         end
 

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

@@ -5,7 +5,7 @@ require "metanorma/plugin/lutaml/lutaml_diagram_base"
 module Metanorma
   module Plugin
     module Lutaml
-      class LutamlDiagramBlock < Asciidoctor::Extensions::BlockProcessor
+      class LutamlDiagramBlock < ::Asciidoctor::Extensions::BlockProcessor
         include LutamlDiagramBase
 
         use_dsl
@@ -14,14 +14,14 @@ module Metanorma
         parse_content_as :raw
 
         def lutaml_file(document, reader)
-
           lutaml_temp(document, reader)
         end
 
         private
 
         def lutaml_temp(document, reader)
-          temp_file = Tempfile.new(["lutaml", ".lutaml"], Utils.relative_file_path(document, ''))
+          temp_file = Tempfile.new(["lutaml", ".lutaml"],
+                                   Utils.relative_file_path(document, ""))
           temp_file.puts(reader.read)
           temp_file.rewind
           temp_file

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

@@ -5,7 +5,7 @@ require "metanorma/plugin/lutaml/lutaml_diagram_base"
 module Metanorma
   module Plugin
     module Lutaml
-      class LutamlDiagramBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
+      class LutamlDiagramBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
         include LutamlDiagramBase
 
         use_dsl

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

@@ -3,7 +3,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      class LutamlFigureInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      class LutamlFigureInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
         include LutamlDiagramBase
 
         use_dsl
@@ -11,11 +11,12 @@ module Metanorma
 
         def process(parent, _target, attrs)
           diagram_key = [attrs["package"], attrs["name"]].compact.join(":")
-          return if parent.document.attributes['lutaml_figure_id'].nil?
-          xmi_id = parent.document.attributes['lutaml_figure_id'][diagram_key]
+          return if parent.document.attributes["lutaml_figure_id"].nil?
+
+          xmi_id = parent.document.attributes["lutaml_figure_id"][diagram_key]
           return unless xmi_id
 
-          %Q(<xref target="figure-#{xmi_id}"></xref>)
+          %(<xref target="figure-#{xmi_id}"></xref>)
         end
       end
     end

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

@@ -6,25 +6,26 @@ require "asciidoctor/reader"
 require "lutaml"
 require "metanorma/plugin/lutaml/utils"
 require "metanorma/plugin/lutaml/express_remarks_decorator"
+require "metanorma/plugin/lutaml/asciidoctor/preprocessor"
 
 module Metanorma
   module Plugin
     module Lutaml
       # Class for processing Lutaml files
-      class LutamlPreprocessor < Asciidoctor::Extensions::Preprocessor
+      class LutamlPreprocessor < ::Asciidoctor::Extensions::Preprocessor
         REMARKS_ATTRIBUTE = "remarks"
 
         def process(document, reader)
-          input_lines = reader.readlines.to_enum
+          r = Asciidoctor::PreprocessorNoIfdefsReader.new document, reader.lines
+          input_lines = r.readlines.to_enum
           has_lutaml = !input_lines.select { |x| lutaml?(x) }.empty?
           express_indexes = Utils.parse_document_express_indexes(
-            document,
-            input_lines,
+            document, input_lines
           )
           result_content = processed_lines(document, input_lines,
                                            express_indexes)
           has_lutaml and log(document, result_content)
-          Asciidoctor::PreprocessorReader.new(document, result_content)
+          Asciidoctor::PreprocessorNoIfdefsReader.new(document, result_content)
         end
 
         protected

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

@@ -3,21 +3,23 @@
 module Metanorma
   module Plugin
     module Lutaml
-      class LutamlTableInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      class LutamlTableInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
         include LutamlDiagramBase
-        SUPPORTED_OPTIONS = %w[class enum data_type]
+        SUPPORTED_OPTIONS = %w[class enum data_type].freeze
 
         use_dsl
         named :lutaml_table
 
         def process(parent, _target, attrs)
           keyword = SUPPORTED_OPTIONS.find { |n| attrs[n] }
-          entity_key = [keyword, attrs["package"], attrs[keyword]].compact.join(":")
-          return if parent.document.attributes['lutaml_entity_id'].nil?
-          xmi_id = parent.document.attributes['lutaml_entity_id'][entity_key]
+          entity_key = [keyword, attrs["package"],
+                        attrs[keyword]].compact.join(":")
+          return if parent.document.attributes["lutaml_entity_id"].nil?
+
+          xmi_id = parent.document.attributes["lutaml_entity_id"][entity_key]
           return unless xmi_id
 
-          %Q(<xref target="section-#{xmi_id}"/>)
+          %(<xref target="section-#{xmi_id}"/>)
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./lutaml_uml_class_preprocessor.rb"
+require "metanorma/plugin/lutaml/asciidoctor/preprocessor"
 
 module Metanorma
   module Plugin
@@ -16,36 +16,35 @@ module Metanorma
           skip_headers = options[:skip_headers]
 
           <<~TEMPLATE
-          #{"=== {{ definition.name }}" unless skip_headers}
-          {{ definition.definition }}
-
-          {% if definition.attributes %}
-          {% if definition.keyword == 'enumeration' %}
-          .{{ definition.name }} values
-          |===
-          |Name |Definition
-
-          {% for item in definition.attributes %}
-          |{{ item.name }} |{{ item.definition }}
-          {% endfor %}
-          |===
-          {% else %}
-          .{{ definition.name }} attributes
-          |===
-          |Name |Definition |Mandatory / Optional / Conditional |Max Occur |Data Type
-
-          {% for item in definition.attributes %}
-          |{{ item.name }} |{% if item.definition %}{{ item.definition }}{% endif %} |{% if item.cardinality.min == "0" %}O{% else %}M{% endif %} |{% if item.cardinality.max == "*" %}N{% else %}1{% endif %} |{% if item.origin %}<<{{ item.origin }}>>{% endif %} `{{ item.type }}`
-          {% endfor %}
-          |===
-          {% endif %}
-          {% endif %}
+            #{'=== {{ definition.name }}' unless skip_headers}
+            {{ definition.definition }}
+
+            {% if definition.attributes %}
+            {% if definition.keyword == 'enumeration' %}
+            .{{ definition.name }} values
+            |===
+            |Name |Definition
+
+            {% for item in definition.attributes %}
+            |{{ item.name }} |{{ item.definition }}
+            {% endfor %}
+            |===
+            {% else %}
+            .{{ definition.name }} attributes
+            |===
+            |Name |Definition |Mandatory / Optional / Conditional |Max Occur |Data Type
+
+            {% for item in definition.attributes %}
+            |{{ item.name }} |{% if item.definition %}{{ item.definition }}{% endif %} |{% if item.cardinality.min == "0" %}O{% else %}M{% endif %} |{% if item.cardinality.max == "*" %}N{% else %}1{% endif %} |{% if item.origin %}<<{{ item.origin }}>>{% endif %} `{{ item.type }}`
+            {% endfor %}
+            |===
+            {% endif %}
+            {% endif %}
 
           TEMPLATE
         end
         # rubocop:enable Layout/IndentHeredoc
       end
-
     end
   end
 end

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

@@ -6,13 +6,14 @@ require "asciidoctor/reader"
 require "lutaml"
 require "lutaml/uml"
 require "metanorma/plugin/lutaml/utils"
+require "metanorma/plugin/lutaml/asciidoctor/preprocessor"
 
 module Metanorma
   module Plugin
     module Lutaml
       #  Macro for quick rendering of datamodel attributes/values table
       #  @example [lutaml_uml_class,path/to/lutaml,EntityName]
-      class LutamlUmlClassPreprocessor < Asciidoctor::Extensions::Preprocessor
+      class LutamlUmlClassPreprocessor < ::Asciidoctor::Extensions::Preprocessor
         MACRO_REGEXP =
           /\[lutaml_uml_class,([^,]+),?([^,]+),?(.+?)?\]/
 
@@ -24,8 +25,10 @@ module Metanorma
         #  read include derectives that goes after that in block and transform
         #  into yaml2text blocks
         def process(document, reader)
-          input_lines = reader.readlines.to_enum
-          Asciidoctor::Reader.new(processed_lines(document, input_lines))
+          r = Asciidoctor::PreprocessorNoIfdefsReader.new document, reader.lines
+          input_lines = r.readlines.to_enum
+          Asciidoctor::PreprocessorNoIfdefsReader
+            .new(document, processed_lines(document, input_lines))
         end
 
         private
@@ -34,17 +37,18 @@ module Metanorma
           ::Lutaml::Parser.parse(
             File.new(
               Utils.relative_file_path(document, file_path),
-              encoding: "UTF-8")
-            ).first
+              encoding: "UTF-8",
+            ),
+          ).first
         end
 
-        DEFAULT_OPTIONS = {
-          depth: 2
-        }
+        DEFAULT_OPTIONS = { depth: 2 }.freeze
+
         def parse_options_to_hash(options_string)
-          return DEFAULT_OPTIONS.dup if options_string.nil? || options_string.empty?
+          return DEFAULT_OPTIONS.dup if options_string.nil? ||
+            options_string.empty?
 
-          opts = options_string.split(",").inject({}) do |acc,pair|
+          opts = options_string.split(",").inject({}) do |acc, pair|
             key, value = pair.split("=")
             key = key.to_sym
             value = true if value.nil?
@@ -63,7 +67,8 @@ module Metanorma
               entity_name = match[2]
               options = parse_options_to_hash(match[3])
 
-              result.push(*parse_marco(lutaml_path, entity_name, document, options))
+              result.push(*parse_marco(lutaml_path, entity_name, document,
+                                       options))
             else
               result.push(line)
             end
@@ -87,7 +92,7 @@ module Metanorma
             template_string: template(options),
             context_items: entity_definition,
             context_name: "definition",
-            document: document
+            document: document,
           )
           Utils.notify_render_errors(document, errors)
           render_result.split("\n")
@@ -103,56 +108,56 @@ module Metanorma
           depth = options[:depth]
 
           <<~TEMPLATE
-          {% if definition.keyword == 'enumeration' %}
-          #{equalsigns(depth) + " Enumeration: {{ definition.name }}" unless skip_headers}
-          {% else %}
-          #{equalsigns(depth) + " Class: {{ definition.name }}" unless skip_headers}
-          {% endif %}
+            {% if definition.keyword == 'enumeration' %}
+            #{equalsigns(depth) + ' Enumeration: {{ definition.name }}' unless skip_headers}
+            {% else %}
+            #{equalsigns(depth) + ' Class: {{ definition.name }}' unless skip_headers}
+            {% endif %}
 
-          #{equalsigns(depth+1)} Description
+            #{equalsigns(depth + 1)} Description
 
-          {{ definition.definition }}
+            {{ definition.definition }}
 
-          {% if definition.attributes %}
-          {% if definition.keyword == 'enumeration' %}
-          {% for item in definition.attributes %}
-          #{equalsigns(depth+1)} Enumeration value: {{item.name}}
+            {% if definition.attributes %}
+            {% if definition.keyword == 'enumeration' %}
+            {% for item in definition.attributes %}
+            #{equalsigns(depth + 1)} Enumeration value: {{item.name}}
 
-          {% if item.definition %}
-          {{ item.definition }}
-          {% endif %}
+            {% if item.definition %}
+            {{ item.definition }}
+            {% endif %}
 
-          {% endfor %}
+            {% endfor %}
 
-          {% else %}
+            {% else %}
 
-          {% for item in definition.attributes %}
-          #{equalsigns(depth+1)} Attribute: {{item.name}}
+            {% for item in definition.attributes %}
+            #{equalsigns(depth + 1)} Attribute: {{item.name}}
 
-          {% if item.definition %}
-          {{ item.definition }}
-          {% endif %}
+            {% if item.definition %}
+            {{ item.definition }}
+            {% endif %}
 
-          Value type and multiplicity:
-          {% if item.type -%}{{ item.type }}{% else -%}(no type specified){% endif %}
-          {% if item.cardinality.min -%}
-          {% if item.cardinality.max -%}
-          {blank}[{{item.cardinality.min}}..{{item.cardinality.max}}]
-          {% else -%}
-          {blank}[{{item.cardinality.min}}]
-          {% endif -%}
-          {% else -%}
-          (multiplicity unspecified)
-          {% endif %}
+            Value type and multiplicity:
+            {% if item.type -%}{{ item.type }}{% else -%}(no type specified){% endif %}
+            {% if item.cardinality.min -%}
+            {% if item.cardinality.max -%}
+            {blank}[{{item.cardinality.min}}..{{item.cardinality.max}}]
+            {% else -%}
+            {blank}[{{item.cardinality.min}}]
+            {% endif -%}
+            {% else -%}
+            (multiplicity unspecified)
+            {% endif %}
 
-          {% if item.origin %}
-          Origin: <<{{ item.origin }}>>
-          {% endif %}
+            {% if item.origin %}
+            Origin: <<{{ item.origin }}>>
+            {% endif %}
 
-          {% endfor %}
+            {% endfor %}
 
-          {% endif %}
-          {% endif %}
+            {% endif %}
+            {% endif %}
 
           TEMPLATE
         end

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

@@ -6,6 +6,7 @@ require "asciidoctor/reader"
 require "lutaml"
 require "lutaml/uml"
 require "metanorma/plugin/lutaml/utils"
+require "metanorma/plugin/lutaml/asciidoctor/preprocessor"
 
 module Metanorma
   module Plugin
@@ -13,45 +14,48 @@ module Metanorma
       #  Macro for quick rendering of datamodel attributes/values table
       #  @example [lutaml_uml_attributes_table,path/to/lutaml,EntityName]
       class LutamlUmlDatamodelDescriptionPreprocessor <
-          Asciidoctor::Extensions::Preprocessor
+          ::Asciidoctor::Extensions::Preprocessor
         MACRO_REGEXP =
           /\[lutaml_uml_datamodel_description,([^,]+),?(.+)?\]/
         LIQUID_INCLUDE_PATH = File.join(
           Gem.loaded_specs["metanorma-plugin-lutaml"].full_gem_path,
           "lib", "metanorma", "plugin", "lutaml", "liquid_templates"
         )
-        DEFAULT_RENDER_INCLUDE = 'packages'.freeze
+        DEFAULT_RENDER_INCLUDE = "packages"
         RENDER_STYLES_INCLUDES = {
-          'default' => 'packages',
-          'entity_list' => 'packages_entity_list',
-          'entity_list_class' => 'packages_entity_list_class',
-          'data_dictionary' => 'packages_data_dictionary'
+          "default" => "packages",
+          "entity_list" => "packages_entity_list",
+          "entity_list_class" => "packages_entity_list_class",
+          "data_dictionary" => "packages_data_dictionary",
         }.freeze
-        RENDER_STYLE_ATTRIBUTE = 'render_style'.freeze
+        RENDER_STYLE_ATTRIBUTE = "render_style"
         SUPPORTED_NESTED_MACRO = %w[
-          before diagram_include_block after include_block package_text].freeze
+          before diagram_include_block after include_block package_text
+        ].freeze
         # search document for block `lutaml_uml_datamodel_description`
         #  read include derectives that goes after that in block and transform
         #  into yaml2text blocks
         def process(document, reader)
-          input_lines = reader.readlines.to_enum
-          Asciidoctor::Reader.new(processed_lines(document, input_lines))
+          r = Asciidoctor::PreprocessorNoIfdefsReader.new document, reader.lines
+          input_lines = r.readlines.to_enum
+          Asciidoctor::PreprocessorNoIfdefsReader
+            .new(document, processed_lines(document, input_lines))
         end
 
         private
 
         def lutaml_document_from_file_or_cache(document, file_path)
           full_path = Utils.relative_file_path(document, file_path)
-          if document.attributes['lutaml_xmi_cache'] &&
-              document.attributes['lutaml_xmi_cache'][full_path]
-            return document.attributes['lutaml_xmi_cache'][full_path]
+          if document.attributes["lutaml_xmi_cache"] &&
+              document.attributes["lutaml_xmi_cache"][full_path]
+            return document.attributes["lutaml_xmi_cache"][full_path]
           end
-          result_document = ::Lutaml::Parser.parse(File.new(full_path,
-                                encoding: "UTF-8"))
-                              .first
-                              result_document
-          document.attributes['lutaml_xmi_cache'] ||= {}
-          document.attributes['lutaml_xmi_cache'][full_path] = result_document
+
+          result_document = ::Lutaml::Parser
+            .parse(File.new(full_path, encoding: "UTF-8")).first
+          result_document
+          document.attributes["lutaml_xmi_cache"] ||= {}
+          document.attributes["lutaml_xmi_cache"][full_path] = result_document
           result_document
         end
 
@@ -59,7 +63,7 @@ module Metanorma
           return {} if file_path.nil?
 
           relative_file_path = Utils.relative_file_path(document, file_path)
-          YAML.load(File.read(relative_file_path, encoding: "UTF-8"))
+          YAML.safe_load(File.read(relative_file_path, encoding: "UTF-8"))
         end
 
         def processed_lines(document, input_lines)
@@ -75,19 +79,22 @@ module Metanorma
           block_match = line.match(MACRO_REGEXP)
           return [line] if block_match.nil?
 
-          lutaml_document = lutaml_document_from_file_or_cache(document, block_match[1])
+          lutaml_document = lutaml_document_from_file_or_cache(document,
+                                                               block_match[1])
           fill_in_diagrams_attributes(document, lutaml_document)
           model_representation(
-            lutaml_document,
-            document,
+            lutaml_document, document,
             collect_additional_context(document, input_lines, input_lines.next),
-            parse_yaml_config_file(document, block_match[2]))
+            parse_yaml_config_file(document, block_match[2])
+          )
         end
 
-        def fill_in_entities_refs_attributes(document, lutaml_document_wrapper, options)
+        def fill_in_entities_refs_attributes(document, lutaml_document_wrapper,
+options)
           lutaml_document = lutaml_document_wrapper.original_document
-          render_style = options.fetch(RENDER_STYLE_ATTRIBUTE, 'default')
-          all_children_packages = lutaml_document.packages.map(&:children_packages).flatten
+          render_style = options.fetch(RENDER_STYLE_ATTRIBUTE, "default")
+          all_children_packages = lutaml_document.packages
+            .map(&:children_packages).flatten
           package_flat_packages = lambda do |pks|
             pks.each_with_object({}) do |package, res|
               res[package.name] = package.xmi_id
@@ -95,7 +102,7 @@ module Metanorma
           end
           children_pks = package_flat_packages.call(all_children_packages)
           ref_dictionary = package_flat_packages.call(lutaml_document.packages)
-                            .merge(children_pks)
+            .merge(children_pks)
           %w[class enum data_type].each do |type|
             package_flat = lambda do |pks|
               pks.each_with_object({}) do |package, res|
@@ -106,46 +113,57 @@ module Metanorma
               end
             end
             children_pks_daigs = package_flat.call(all_children_packages)
-              ref_dictionary = ref_dictionary
-                                .merge(package_flat.call(lutaml_document.packages)
-                                        .merge(children_pks_daigs))
+            ref_dictionary = ref_dictionary
+              .merge(package_flat.call(lutaml_document.packages)
+                                      .merge(children_pks_daigs))
           end
-          document.attributes['lutaml_entity_id'] = ref_dictionary
+          document.attributes["lutaml_entity_id"] = ref_dictionary
         end
 
         def fill_in_diagrams_attributes(document, lutaml_document_wrapper)
           lutaml_document = lutaml_document_wrapper.original_document
           package_flat_diagrams = lambda do |pks|
             pks.each_with_object({}) do |package, res|
-              package.diagrams.map { |diag| res["#{package.name}:#{diag.name}"] = diag.xmi_id }
+              package.diagrams.map do |diag|
+                res["#{package.name}:#{diag.name}"] = diag.xmi_id
+              end
             end
           end
-          children_pks_daigs = package_flat_diagrams.call(lutaml_document.packages.map(&:children_packages).flatten)
-          document.attributes['lutaml_figure_id'] = package_flat_diagrams.call(lutaml_document.packages)
-                                                      .merge(children_pks_daigs)
+          children_pks_daigs = package_flat_diagrams.call(
+            lutaml_document.packages.map(&:children_packages).flatten,
+          )
+          document.attributes["lutaml_figure_id"] = package_flat_diagrams
+            .call(lutaml_document.packages)
+            .merge(children_pks_daigs)
         end
 
         def collect_additional_context(document, input_lines, end_mark)
           additional_context = Hash.new { |hash, key| hash[key] = [] }
-          additional_context['all_macros'] = []
+          additional_context["all_macros"] = []
           block_lines = []
           while (block_line = input_lines.next) != end_mark
             block_lines.push(block_line)
           end
-          processed_lines = self
-                              .process(document, Asciidoctor::Reader.new(block_lines))
-                              .read_lines
-          block_document = (Asciidoctor::Document.new(processed_lines, {})).parse
+          processed_lines =
+            process(document, ::Asciidoctor::PreprocessorReader.new(
+                                document, block_lines
+                              ))
+              .read_lines
+          block_document = ::Asciidoctor::Document
+            .new(processed_lines, {}).parse
           block_document.blocks.each do |block|
-            next unless SUPPORTED_NESTED_MACRO.include?(block.attributes['role'])
+            next unless SUPPORTED_NESTED_MACRO.include?(block.attributes["role"])
 
             attrs = block.attributes
-            name = attrs.delete('role')
-            package = attrs.delete('package')
+            name = attrs.delete("role")
+            package = attrs.delete("package")
             macro_keyword = [name, package].compact.join(";")
-            block_text = block.lines.length > 0 ? block.lines.join("\n") : ''
-            additional_context[macro_keyword].push({ 'text' => block_text }.merge(attrs))
-            additional_context['all_macros'].push({ 'text' => block_text, 'type' => name, 'package' => package }.merge(attrs))
+            block_text = block.lines.length.positive? ? block.lines.join("\n") : ""
+            additional_context[macro_keyword]
+              .push({ "text" => block_text }.merge(attrs))
+            additional_context["all_macros"]
+              .push({ "text" => block_text,
+                      "type" => name, "package" => package }.merge(attrs))
           end
           additional_context
         end
@@ -153,71 +171,80 @@ module Metanorma
         def package_level(lutaml_document, level)
           return lutaml_document if level <= 0
 
-          package_level(lutaml_document['packages'].first, level - 1)
+          package_level(lutaml_document["packages"].first, level - 1)
         end
 
         def create_context_object(lutaml_document, additional_context, options)
-          root_package = package_level(lutaml_document.to_liquid, options['package_root_level'] || 1)
-          if options.length.zero? || options['packages'].nil?
+          root_package = package_level(lutaml_document.to_liquid,
+                                       options["package_root_level"] || 1)
+          if options.empty? || options["packages"].nil?
             return {
-              'render_nested_packages' => true,
-              "packages" => root_package['packages'],
+              "render_nested_packages" => true,
+              "packages" => root_package["packages"],
               "root_packages" => [root_package],
-              "additional_context" => additional_context.merge("external_classes" => options["external_classes"]),
-              "name" => root_package['name']
+              "additional_context" => additional_context
+                  .merge("external_classes" => options["external_classes"]),
+              "name" => root_package["name"],
             }
           end
 
-          all_packages = [root_package, *root_package['children_packages']]
+          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),
-            "additional_context" => additional_context.merge("external_classes" => options["external_classes"]),
+            "additional_context" => additional_context
+              .merge("external_classes" => options["external_classes"]),
             "root_packages" => [root_package],
-            "name" => root_package['name']
+            "name" => root_package["name"],
           }
         end
 
         def package_entities(options)
-          return {} unless options['packages']
-
-          options['packages']
-            .find_all { |entity| entity.is_a?(Hash) && entity.values.first['render_entities'] }
-            .map { |entity| [entity.keys.first, entity.values.first['render_entities'].map { |n| [n, true] }.to_h] }.to_h
+          options["packages"] or return {}
+          options["packages"]
+            .find_all { |entity| entity.is_a?(Hash) && entity.values.first["render_entities"] }
+            .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)
-          return {} unless options['packages']
+          return {} unless options["packages"]
 
-          options['packages']
-            .find_all { |entity| entity.is_a?(Hash) && entity.values.first['skip_tables'] }
-            .map { |entity| [entity.keys.first, entity.values.first['skip_tables'].map { |n| [n, true] }.to_h] }.to_h
+          options["packages"]
+            .find_all { |entity| entity.is_a?(Hash) && entity.values.first["skip_tables"] }
+            .map do |entity|
+            [entity.keys.first, entity.values.first["skip_tables"].map do |n|
+                                  [n, true]
+                                end.to_h]
+          end.to_h
         end
 
         def sort_and_filter_out_packages(all_packages, options)
-          return all_packages if options['packages'].nil?
+          return all_packages if options["packages"].nil?
 
           result = []
           # Step one - filter out all skipped packages
-          options['packages']
-            .find_all { |entity| entity.is_a?(Hash) && entity['skip'] }
+          options["packages"]
+            .find_all { |entity| entity.is_a?(Hash) && entity["skip"] }
             .each do |entity|
-              entity_regexp = config_entity_regexp(entity['skip'])
+              entity_regexp = config_entity_regexp(entity["skip"])
               all_packages
-                .delete_if {|package| package['name'] =~ entity_regexp }
+                .delete_if { |package| package["name"] =~ entity_regexp }
             end
           # Step two - select supplied packages by pattern
-          options['packages']
-            .find_all { |entity| entity.is_a?(String) || (entity.is_a?(Hash) && !entity['skip']) }
+          options["packages"]
+            .find_all { |entity| entity.is_a?(String) || (entity.is_a?(Hash) && !entity["skip"]) }
             .each do |entity_obj|
               entity = entity_obj.is_a?(String) ? entity_obj : entity_obj.keys.first
               entity_regexp = config_entity_regexp(entity)
-              all_packages.each.with_index do |package|
-                if package['name'] =~ entity_regexp
+              all_packages.each do |package|
+                if package["name"]&.match?(entity_regexp)
                   result.push(package)
                   all_packages
-                    .delete_if {|nest_package| nest_package['name'] == package['name'] }
+                    .delete_if { |nest_package| nest_package["name"] == package["name"] }
                 end
               end
             end
@@ -225,34 +252,38 @@ module Metanorma
         end
 
         def config_entity_regexp(entity)
-          additional_sym = '.*' if entity =~ /\*$/
+          additional_sym = ".*" if /\*$/.match?(entity)
           %r{^#{Regexp.escape(entity.gsub('*', ''))}#{additional_sym}$}
         end
 
-        def model_representation(lutaml_document, document, additional_context, options)
+        def model_representation(lutaml_document, document, additional_context,
+options)
           fill_in_entities_refs_attributes(document, lutaml_document, 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_document,
-                              additional_context,
-                              options),
+                                                 additional_context,
+                                                 options),
             context_name: "context",
             document: document,
-            include_path: LIQUID_INCLUDE_PATH
+            include_path: LIQUID_INCLUDE_PATH,
           )
           Utils.notify_render_errors(document, errors)
           render_result.split("\n")
         end
 
         def template(section_depth, render_style, include_root)
-          include_name = RENDER_STYLES_INCLUDES.fetch(render_style, DEFAULT_RENDER_INCLUDE)
+          include_name = RENDER_STYLES_INCLUDES.fetch(render_style,
+                                                      DEFAULT_RENDER_INCLUDE)
           result = ""
           if include_root
             result += <<~LIQUID
               {% include "#{include_name}", package_skip_sections: context.package_skip_sections, package_entities: context.package_entities, context: context.root_packages, additional_context: context.additional_context, render_nested_packages: false %}
             LIQUID
           end
-          result += <<~LIQUID
+          result + <<~LIQUID
             {% include "#{include_name}", depth: #{section_depth}, package_skip_sections: context.package_skip_sections, package_entities: context.package_entities, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
           LIQUID
         end

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

@@ -17,7 +17,7 @@ module Metanorma
 
         def relative_file_path(document, file_path)
           docfile_directory = File.dirname(
-            document.attributes["docfile"] || "."
+            document.attributes["docfile"] || ".",
           )
           document
             .path_resolver
@@ -28,8 +28,11 @@ module Metanorma
                                  context_name:, document:, include_path: nil)
           liquid_template = ::Liquid::Template.parse(template_string)
           # Allow includes for the template
-          include_paths = [Utils.relative_file_path(document, ""), include_path].compact
-          liquid_template.registers[:file_system] = ::Metanorma::Plugin::Lutaml::Liquid::LocalFileSystem.new(include_paths, ["_%s.liquid", "_%s.adoc"])
+          include_paths = [Utils.relative_file_path(document, ""),
+                           include_path].compact
+          liquid_template.registers[:file_system] =
+            ::Metanorma::Plugin::Lutaml::Liquid::LocalFileSystem
+              .new(include_paths, ["_%s.liquid", "_%s.adoc"])
           rendered_string = liquid_template
             .render(context_name => context_items,
                     strict_variables: true,
@@ -45,8 +48,12 @@ module Metanorma
           end
         end
 
-        def process_express_index(path, cache_path, document, force_read = false)
-          cache_full_path = Utils.relative_file_path(document, cache_path) if cache_path
+        def process_express_index(path, cache_path, document,
+force_read = false)
+          if cache_path
+            cache_full_path = Utils.relative_file_path(document,
+                                                       cache_path)
+          end
           if !force_read && cache_full_path && File.file?(cache_full_path)
             return express_from_cache(cache_full_path)
           end
@@ -54,7 +61,8 @@ module Metanorma
           full_path = Utils.relative_file_path(document, path)
           wrapper = express_from_path(document, full_path)
           if cache_full_path && !File.file?(cache_full_path)
-            express_write_cache(cache_full_path, wrapper.original_document, document)
+            express_write_cache(cache_full_path, wrapper.original_document,
+                                document)
           end
           wrapper
         rescue Expressir::Error
@@ -87,14 +95,21 @@ module Metanorma
         end
 
         def express_from_folder(folder)
-          files = Dir["#{folder}/*.exp"].map { |nested_path| File.new(nested_path, encoding: "UTF-8") }
+          files = Dir["#{folder}/*.exp"].map do |nested_path|
+            File.new(nested_path, encoding: "UTF-8")
+          end
           ::Lutaml::Parser.parse(files)
         end
 
         def express_decorate_wrapper(wrapper, document)
           serialized = wrapper.to_liquid
-          serialized["schemas"] = serialized["schemas"].map do |j|
-            j.merge("relative_path_prefix" => Utils.relative_file_path(document, File.dirname(j["file"])))
+          serialized["schemas"].map! do |j|
+            j.merge(
+              "relative_path_prefix" => Utils
+                .relative_file_path(document, File.dirname(j["file"])),
+              "formatted" => wrapper.original_document
+                .schemas.detect {|s| s.id == j["id"] }.to_s(no_remarks: true)
+            )
           end
           serialized
         end
@@ -105,14 +120,12 @@ module Metanorma
           schemas_paths = yaml_content
             .fetch("schemas")
             .map do |(schema_name, schema_values)|
-            if schema_values["path"]
-              schema_values["path"]
-            else
-              File.join(root_path.to_s, "#{schema_name}.exp")
-            end
+            schema_values["path"] || File.join(root_path.to_s,
+                                               "#{schema_name}.exp")
           end
           files_to_load = schemas_paths.map do |path|
-            File.new(Utils.relative_file_path(document, path), encoding: "UTF-8")
+            File.new(Utils.relative_file_path(document, path),
+                     encoding: "UTF-8")
           end
           ::Lutaml::Parser.parse(files_to_load)
         end
@@ -121,7 +134,7 @@ module Metanorma
           express_indexes = {}
           loop do
             line = input_lines.next
-            break if line.length.zero?
+            break if line.empty?
 
             match = line.match(LUTAML_EXP_IDX_TAG)
             if match
@@ -130,7 +143,8 @@ module Metanorma
               cache = match[:cache_path]
               repositories = process_express_index(path.strip, cache, document)
               if repositories
-                express_indexes[name.strip] = express_decorate_wrapper(repositories, document)
+                express_indexes[name.strip] =
+                  express_decorate_wrapper(repositories, document)
               end
             end
           end

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

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

data/lib/metanorma-plugin-lutaml.rb

@@ -13,15 +13,4 @@ module Metanorma
     module Lutaml
     end
   end
-
-  Asciidoctor::Extensions.register do
-    preprocessor Metanorma::Plugin::Lutaml::LutamlPreprocessor
-    preprocessor Metanorma::Plugin::Lutaml::LutamlUmlAttributesTablePreprocessor
-    preprocessor Metanorma::Plugin::Lutaml::LutamlUmlDatamodelDescriptionPreprocessor
-    preprocessor Metanorma::Plugin::Lutaml::LutamlUmlClassPreprocessor
-    inline_macro Metanorma::Plugin::Lutaml::LutamlFigureInlineMacro
-    inline_macro Metanorma::Plugin::Lutaml::LutamlTableInlineMacro
-    block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
-    block Metanorma::Plugin::Lutaml::LutamlDiagramBlock
-  end
 end

data/metanorma-plugin-lutaml.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "asciidoctor"
-  spec.add_dependency "expressir"
+  spec.add_dependency "expressir", "~> 1.4.0"
   spec.add_dependency "liquid"
   spec.add_dependency "lutaml"
   spec.add_dependency "relaton-cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.4.20
+  version: 0.6.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -28,16 +28,16 @@ dependencies:
   name: expressir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
@@ -256,6 +256,7 @@ files:
 - bin/console
 - bin/setup
 - lib/metanorma-plugin-lutaml.rb
+- lib/metanorma/plugin/lutaml/asciidoctor/preprocessor.rb
 - 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
@@ -302,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Metanorma plugin for LutaML