metanorma-plugin-lutaml 0.7.30 → 0.7.31

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

@@ -20,39 +20,46 @@ module Metanorma
             File.read(full_path)
           end
 
-          def full_path(template_path)
+          def full_path(template_path) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
             unless %r{\A[^./][a-zA-Z0-9_/]+\z}.match?(template_path)
               raise ::Liquid::FileSystemError,
                     "Illegal template name '#{template_path}'"
             end
 
-            result_path = if template_path.include?('/')
-              roots
-                .map do |root|
-                  patterns.map do |pattern|
-                    File.join(root, File.dirname(template_path), pattern % File.basename(template_path))
-                  end
-                end
-                .flatten
-                .find { |path| File.file?(path) }
-            else
-              roots
-                .map do |root|
-                  patterns.map do |pattern|
-                    File.join(root, pattern % template_path)
-                  end
-                end
-                .flatten
-                .find { |path| File.file?(path) }
-            end
+            result_path = if template_path.include?("/")
+                            roots
+                              .map do |root|
+                                patterns.map do |pattern|
+                                  File.join(
+                                    root,
+                                    File.dirname(template_path),
+                                    pattern % File.basename(template_path),
+                                  )
+                                end
+                              end
+                              .flatten
+                              .find { |path| File.file?(path) }
+                          else
+                            roots
+                              .map do |root|
+                                patterns.map do |pattern|
+                                  File.join(root, pattern % template_path)
+                                end
+                              end
+                              .flatten
+                              .find { |path| File.file?(path) }
+                          end
 
             if result_path.nil?
               raise ::Liquid::FileSystemError,
-                    "No documents in template path '#{File.expand_path(template_path)}'"
+                    "No documents in template path: " \
+                    " #{File.expand_path(template_path)}"
             end
 
             unless roots.any? do |root|
-                     File.expand_path(result_path).start_with?(File.expand_path(root))
+                     File.expand_path(result_path).start_with?(
+                       File.expand_path(root),
+                     )
                    end
               raise ::Liquid::FileSystemError,
                     "Illegal template path '#{File.expand_path(result_path)}'"

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

@@ -8,7 +8,7 @@ class GmlDictionaryDrop < Liquid::Drop
   end
 
   def name
-    @dict.name.join("")
+    @dict.name.join
   end
 
   def file_name

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

@@ -42,7 +42,7 @@ module Metanorma
         end
 
         # if no :imagesdir: leave image file in lutaml
-        def generate_file(parent, _reader, uml_document)
+        def generate_file(parent, _reader, uml_document) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
           formatter = ::Lutaml::Formatter::Graphviz.new
           formatter.type = :png
 

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

@@ -5,7 +5,8 @@ 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_ea_diagram_block_macro.rb

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

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

@@ -6,12 +6,14 @@ require "asciidoctor/reader"
 require "lutaml"
 require "lutaml/uml"
 require "lutaml/formatter"
-require "metanorma/plugin/lutaml/utils"
+require_relative "utils"
 
 module Metanorma
   module Plugin
     module Lutaml
       module LutamlEaXmiBase
+        include Utils
+
         LIQUID_INCLUDE_PATH = File.join(
           Gem.loaded_specs["metanorma-plugin-lutaml"].full_gem_path,
           "lib", "metanorma", "plugin", "lutaml", "liquid_templates"
@@ -27,11 +29,22 @@ module Metanorma
         SUPPORTED_NESTED_MACRO = %w[
           before diagram_include_block after include_block package_text
         ].freeze
-        XMI_INDEX_REGEXP = /^:lutaml-xmi-index:(?<index_name>.+?);(?<index_path>.+?);?(\s*config=(?<config_path>.+))?$/.freeze # rubocop:disable Lint/MixedRegexpCaptureTypes,Layout/LineLength
+        XMI_INDEX_REGEXP = %r{
+          ^:lutaml-xmi-index:  # Start of the pattern
+          (?<index_name>.+?)   # Capture index name
+          ;                    # Separator
+          (?<index_path>.+?)   # Capture index path
+          ;?                   # Optional separator
+          (?<config_group>     # Optional config group
+            \s*config=         # Config prefix
+            (?<config_path>.+) # Capture config path
+          )?                   # End of optional group
+          $                    # End of the pattern
+        }x.freeze
 
         # search document for block `lutaml_ea_xmi`
         # or `lutaml_uml_datamodel_description`
-        # read include derectives that goes after that in block and transform
+        # read include directives that goes after that in block and transform
         # into yaml2text blocks
         def process(document, reader)
           r = Asciidoctor::PreprocessorNoIfdefsReader.new document, reader.lines
@@ -108,14 +121,6 @@ module Metanorma
           lutaml_xmi_index[:path]
         end
 
-        def processed_lines(document, input_lines)
-          result = []
-          loop do
-            result.push(*process_text_blocks(document, input_lines))
-          end
-          result
-        end
-
         def get_macro_regexp
           self.class.const_get(:MACRO_REGEXP)
         end
@@ -160,7 +165,7 @@ module Metanorma
           )
         end
 
-        def load_lutaml_doc_and_config(document, xmi_or_index, config_yaml_path)
+        def load_lutaml_doc_and_config(document, xmi_or_index, config_yaml_path) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
           index = xmi_or_index.match(/index=(.*)/)
 
           if index
@@ -284,32 +289,39 @@ module Metanorma
           package_level(lutaml_document["packages"].first, level - 1)
         end
 
-        def create_context_object(lutaml_document, additional_context, options) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        def create_context_object( # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          lutaml_document, additional_context, options,
+          context_name = "context"
+        )
           root_package = package_level(lutaml_document.to_liquid,
                                        options.package_root_level || 1)
+          contexts = {}
+          contexts[context_name] = {
+            "name" => root_package["name"],
+            "root_packages" => [root_package],
+            "additional_context" => additional_context
+              .merge("external_classes" => options.external_classes),
+          }
+
           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),
-              "name" => root_package["name"],
-            }
+            contexts[context_name]["render_nested_packages"] = true
+            contexts[context_name]["packages"] = root_package["packages"]
+
+            return contexts
           end
 
           all_packages = [root_package, *root_package["children_packages"]]
-          {
-            "packages" => sort_and_filter_out_packages(all_packages, 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),
-            "root_packages" => [root_package],
-            "render_nested_packages" => options.render_nested_packages ||
-              false,
-            "name" => root_package["name"],
-          }
+          contexts[context_name].merge!(
+            {
+              "packages" => sort_and_filter_out_packages(all_packages, options),
+              "package_entities" => package_hash(options, "render_entities"),
+              "package_skip_sections" => package_hash(options, "skip_tables"),
+              "render_nested_packages" => options.render_nested_packages ||
+                false,
+            },
+          )
+
+          contexts
         end
 
         def package_hash(options, key)
@@ -376,10 +388,10 @@ module Metanorma
             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",
+            contexts: create_context_object(lutaml_doc,
+                                            add_context,
+                                            options,
+                                            "context"),
             document: document,
             include_path: template_path(document, options.template_path),
           )

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

@@ -3,7 +3,8 @@
 module Metanorma
   module Plugin
     module Lutaml
-      class LutamlFigureInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
+      class LutamlFigureInlineMacro <
+        ::Asciidoctor::Extensions::InlineMacroProcessor
         include LutamlDiagramBase
 
         use_dsl

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

@@ -3,8 +3,10 @@
 module Metanorma
   module Plugin
     module Lutaml
-      class LutamlGmlDictionaryBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
+      class LutamlGmlDictionaryBlockMacro <
+        ::Asciidoctor::Extensions::BlockMacroProcessor
         include LutamlGmlDictionaryBase
+
         use_dsl
         named :lutaml_gml_dictionary
 

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

@@ -3,7 +3,8 @@
 module Metanorma
   module Plugin
     module Lutaml
-      class LutamlKlassTableBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
+      class LutamlKlassTableBlockMacro <
+        ::Asciidoctor::Extensions::BlockMacroProcessor
         include LutamlEaXmiBase
 
         DEFAULT_TEMPLATE = File.join(

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

@@ -14,6 +14,19 @@ module Metanorma
       # Class for processing Lutaml files
       class LutamlPreprocessor < ::Asciidoctor::Extensions::Preprocessor
         REMARKS_ATTRIBUTE = "remarks"
+        EXPRESS_PREPROCESSOR_REGEX = %r{
+          ^                            # Start of line
+          \[                           # Opening bracket
+          (?:\blutaml\b|               # Match lutaml or
+            \blutaml_express\b|        # lutaml_express or
+            \blutaml_express_liquid\b) # lutaml_express_liquid
+          ,                            # Comma separator
+          (?<index_names>[^,]+)?       # Optional index names
+          ,?                           # Optional comma
+          (?<context_name>[^,]+)?      # Optional context name
+          (?<options>,.*)?             # Optional options
+          \]                           # Closing bracket
+        }x.freeze
 
         def process(document, reader) # rubocop:disable Metrics/MethodLength
           r = Asciidoctor::PreprocessorNoIfdefsReader.new(document,
@@ -47,7 +60,7 @@ module Metanorma
         end
 
         def lutaml_liquid?(line)
-          line.match(/^\[(?:\blutaml\b|\blutaml_express\b|\blutaml_express_liquid\b),(?<index_names>[^,]+)?,?(?<context_name>[^,]+)?(?<options>,.*)?\]/) # rubocop:disable Layout/LineLength
+          line.match(EXPRESS_PREPROCESSOR_REGEX)
         end
 
         def load_express_lutaml_file(document, file_path)
@@ -180,7 +193,7 @@ module Metanorma
           end
         end
 
-        def read_config_yaml_file(document, file_path)
+        def read_config_yaml_file(document, file_path) # rubocop:disable Metrics/MethodLength
           return {} if file_path.nil?
 
           relative_file_path = Utils.relative_file_path(document, file_path)

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

@@ -3,7 +3,8 @@
 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].freeze
 

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative "utils"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class SourceExtractor
+        include Utils
+
+        # example:
+        #   - [[abc]]
+        ANCHOR_REGEX_1 = /^\[\[(?<id>[^\]]*)\]\]\s*$/.freeze
+
+        # examples:
+        #   - [#abc]
+        #   - [source#abc,ruby]
+        ANCHOR_REGEX_2 = /^\[[^#,]*#(?<id>[^,\]]*)[,\]]/.freeze
+
+        # examples:
+        #   - [id=abc]
+        #   - [source,id="abc"]
+        ANCHOR_REGEX_3 = /^\[(?:.+,)?id=['"]?(?<id>[^,\]'"]*)['"]?[,\]]/.freeze
+
+        def initialize(document, input_lines)
+          @document = document
+          @input_lines = input_lines
+
+          @document.attributes["source_blocks"] ||= {}
+        end
+
+        def self.extract(document, input_lines)
+          new(document, input_lines).extract
+        end
+
+        def extract # rubocop:disable Metrics/AbcSize
+          lines = @input_lines.to_enum
+
+          loop do
+            line = lines.next
+
+            if /^embed::|^include::/.match?(line.strip)
+              file_lines = read(filename(@document, line)) or next
+              SourceExtractor.extract(@document, file_lines)
+            elsif m = match_anchor(line)
+              @document.attributes["source_blocks"][m[:id]] = read_section lines
+            end
+          end
+        end
+
+        private
+
+        def match_anchor(line)
+          line.match(ANCHOR_REGEX_1) ||
+            line.match(ANCHOR_REGEX_2) ||
+            line.match(ANCHOR_REGEX_3)
+        end
+
+        def readlines_safe(file)
+          return [] if file.eof?
+
+          file.readlines
+        end
+
+        def read(inc_path)
+          inc_path or return nil
+          ::File.open inc_path, "r" do |fd|
+            readlines_safe(fd).map(&:chomp)
+          end
+        end
+
+        def filename(document, line)
+          m = /(^include::|^embed::)([^\[]+)\[/.match(line)
+          return nil unless m
+
+          file_path = relative_file_path(document, m[2])
+
+          File.exist?(file_path) ? file_path : nil
+        end
+
+        def read_section(lines)
+          m = lines.next.match(/^--+/)
+          return "" unless m
+
+          end_mark = m[0]
+          current_section = []
+
+          while (line = lines.next) != end_mark
+            current_section << line
+          end
+
+          current_section.join("\n")
+        end
+      end
+    end
+  end
+end

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

@@ -1,22 +1,30 @@
 require "expressir"
 require "expressir/express/parser"
 require "expressir/express/cache"
-require "metanorma/plugin/lutaml/liquid/custom_filters"
 require "metanorma/plugin/lutaml/liquid/multiply_local_file_system"
-
-liquid_klass = if Object.const_defined?("Liquid::Environment")
-                 Object.const_get("Liquid::Environment").default
-               else
-                 Object.const_get("Liquid::Template")
-               end
-liquid_klass.register_filter(Metanorma::Plugin::Lutaml::Liquid::CustomFilters)
+require "metanorma/plugin/lutaml/liquid/custom_blocks/key_iterator"
+require "metanorma/plugin/lutaml/liquid/custom_filters/html2adoc"
+require "metanorma/plugin/lutaml/liquid/custom_filters/values"
+require "metanorma/plugin/lutaml/liquid/custom_filters/replace_regex"
+require "metanorma/plugin/lutaml/liquid/custom_filters/loadfile"
 
 module Metanorma
   module Plugin
     module Lutaml
       # Helpers for lutaml macros
       module Utils
-        LUTAML_EXP_IDX_TAG = /^:lutaml-express-index:(?<index_name>.+?);(?<index_path>.+?);?(\s*cache=(?<cache_path>.+))?$/.freeze
+        LUTAML_EXP_IDX_TAG = %r{
+          ^:lutaml-express-index: # Start of the pattern
+          (?<index_name>.+?)      # Capture index name
+          ;                       # Separator
+          (?<index_path>.+?)      # Capture index path
+          ;?                      # Optional separator
+          (?<cache_group>         # Optional cache group
+            \s*cache=             # Cache prefix
+            (?<cache_path>.+)     # Capture cache path
+          )?                      # End of optional group
+          $                       # End of the pattern
+        }x.freeze
 
         module_function
 
@@ -29,29 +37,54 @@ module Metanorma
             .system_path(file_path, docfile_directory)
         end
 
-        def render_liquid_string(template_string:, context_items:,
-                                 context_name:, document:, include_path: nil)
-          liquid_template = ::Liquid::Template.parse(template_string)
-
+        def render_liquid_string( # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+          template_string:, contexts:, document:,
+          include_path: nil, template_path: nil
+        )
           # Allow includes for the template
           include_paths = [
             Utils.relative_file_path(document, ""),
-            include_path,
+            include_path, template_path
           ].compact
 
+          if template_path
+            template_string = File.read(template_path)
+          end
+
+          liquid_template = ::Liquid::Template
+            .parse(template_string, environment: create_liquid_environment)
           liquid_template.registers[:file_system] =
             ::Metanorma::Plugin::Lutaml::Liquid::LocalFileSystem
               .new(include_paths, ["%s.liquid", "_%s.liquid", "_%s.adoc"])
-
           rendered_string = liquid_template
-            .render(context_name => context_items,
-                    strict_variables: true,
+            .render(contexts,
+                    strict_variables: false,
                     error_mode: :warn)
 
           [rendered_string, liquid_template.errors]
         end
 
-        def notify_render_errors(document, errors)
+        def create_liquid_environment
+          ::Liquid::Environment.new.tap do |liquid_env|
+            liquid_env.register_tag(
+              "keyiterator",
+              ::Metanorma::Plugin::Lutaml::Liquid::CustomBlocks::KeyIterator,
+            )
+            liquid_env.register_filter(
+              ::Metanorma::Plugin::Lutaml::Liquid::CustomFilters,
+            )
+          end
+        end
+
+        def processed_lines(document, input_lines)
+          result = []
+          loop do
+            result.push(*process_text_blocks(document, input_lines))
+          end
+          result
+        end
+
+        def notify_render_errors(_document, errors)
           errors.each do |error_obj|
             ::Metanorma::Util.log(
               "[metanorma-plugin-lutaml] Liquid render error: " \
@@ -61,8 +94,9 @@ module Metanorma
           end
         end
 
-        def load_express_repositories(path:, cache_path:, document:,
-force_read: false)
+        def load_express_repositories( # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+          path:, cache_path:, document:, force_read: false
+        )
           cache_full_path = cache_path &&
             Utils.relative_file_path(document, cache_path)
 
@@ -130,7 +164,7 @@ force_read: false)
         end
 
         # TODO: Refactor this using Suma::SchemaConfig
-        def load_express_from_index(_document, path)
+        def load_express_from_index(_document, path) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
           yaml_content = YAML.safe_load(File.read(path))
           schema_yaml_base_path = Pathname.new(File.dirname(path))
 
@@ -153,7 +187,7 @@ force_read: false)
           ::Lutaml::Parser.parse(files_to_load)
         end
 
-        def parse_document_express_indexes(document, input_lines)
+        def parse_document_express_indexes(document, input_lines) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
           express_indexes = {}
           loop do
             line = input_lines.next
@@ -169,7 +203,8 @@ force_read: false)
             cache = match[:cache_path]&.strip
 
             unless name && path
-              raise StandardError.new("No name and path set in `:lutaml-express-index:` attribute.")
+              raise StandardError.new("No name and path set in " \
+                                      "`:lutaml-express-index:` attribute.")
             end
 
             lutaml_expressir_model = load_express_repositories(
@@ -179,9 +214,7 @@ force_read: false)
             )
 
             if lutaml_expressir_model
-              express_indexes[name] = {
-                model: lutaml_expressir_model,
-              }
+              express_indexes[name] = { model: lutaml_expressir_model }
             end
           end
 

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

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

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "content"
+require_relative "base_structured_text_preprocessor"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class Yaml2TextPreprocessor < BaseStructuredTextPreprocessor
+        include Content
+        # search document for block `yaml2text`
+        #   after that take template from block and read file into this template
+        #   example:
+        #     [yaml2text,foobar.yaml]
+        #     ----
+        #     === {item.name}
+        #     {item.desc}
+        #
+        #     {item.symbol}:: {item.symbol_def}
+        #     ----
+        #
+        #   with content of `foobar.yaml` file equal to:
+        #     - name: spaghetti
+        #       desc: wheat noodles of 9mm diameter
+        #       symbol: SPAG
+        #       symbol_def: the situation is message like spaghetti at a kid's
+        #
+        #   will produce:
+        #     === spaghetti
+        #     wheat noodles of 9mm diameter
+        #
+        #     SPAG:: the situation is message like spaghetti at a kid's meal
+
+        def initialize(config = {})
+          super
+          @config[:block_name] = "yaml2text"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma-plugin-lutaml.rb

@@ -1,5 +1,8 @@
 require "metanorma/plugin/lutaml/version"
 require "metanorma/plugin/lutaml/config"
+require "metanorma/plugin/lutaml/json2_text_preprocessor"
+require "metanorma/plugin/lutaml/yaml2_text_preprocessor"
+require "metanorma/plugin/lutaml/data2_text_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_ea_xmi_preprocessor"