metanorma-plugin-lutaml 0.7.17 → 0.7.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f680f88df78449b51a5edc5344da198ca126fa9d2dd5400dfe309ed456cd32a
-  data.tar.gz: ea9831bdfae3d53412f5581ae82a8ee79f18d3a81ce78e40295d1eacb5394614
+  metadata.gz: 3ded8b84232dfbf3542afb4dc3da354df981b92ff64ed11e095f12545d1f9a0a
+  data.tar.gz: 86f209fd978241a799baac34ee851e1770e41dac4406d39c25666b524f9e1c41
 SHA512:
-  metadata.gz: c3a5caabd987904ed65645ed49a343cac93aa2ce6d250dc521d1c51a5d5c52e43fcf9d381a6961976654dfaa892a266bf33d14ef6275e9b58d33c0387fdbbd41
-  data.tar.gz: 6bf56d6a0f8be8a79e9fdc643ceeec22acd3f3327550dfa7295a72dbfcac6647456d194fd43be0cb3bdd02c665dae6ea5d8400d8b309741e8d23889edc7a6175
+  metadata.gz: '09d55bf946a368225e301bf893d68dd27bd585ecd56c6c785c396f659c81cc38d663eb3fdfde2eec4814038c022c16cb01e61d05533a7af39b1ac87b649603fa'
+  data.tar.gz: 2b864cc9a7e32e7643f9aaf33a8e217eef709c2b2df7ecdff820f656f8860ad33569b457b18b9b765689556322b6a8330047c6dba4fd7d60f307638f8995b08c

data/README.adoc

@@ -145,7 +145,11 @@ And the `lutaml_express` block:
 
 [source,adoc]
 -----
+<<<<<<< HEAD
 [lutaml_express,example.exp,my_context]
+=======
+[lutaml_express_liquid,example.exp,my_context]
+>>>>>>> accd8ee (Remove obsolete codes of macros "lutaml" and "lutaml_express")
 ----
 {% for schema in my_context.schemas %}
 == {{schema.id}}
@@ -169,9 +173,9 @@ Where:
 
 * `{example.exp}` is the location of the EXPRESS schema file (`*.exp`) that
 contains data to be loaded. Location of the file is computed relative to the
-source directory that `[lutaml]` is used (e.g., if
-`[lutaml,example.exp,my_context]` is invoked in an `.adoc` file located at
-`/foo/bar/doc.adoc`, the data file is expected to be found at
+source directory that `[lutaml_express_liquid]` is used (e.g., if
+`[lutaml_express_liquid,example.exp,my_context]` is invoked in an `.adoc` file
+located at `/foo/bar/doc.adoc`, the data file is expected to be found at
 `/foo/bar/example.exp`);
 
 * `{my_context}` is the name where the EXPRESS Repository read from the `.exp`
@@ -225,7 +229,7 @@ Example of usage:
 Author
 :lutaml-express-index: index_name; /path/to/express_files; cache=/path/to/cache_file.yaml
 
-[lutaml,index_name,context]
+[lutaml_express_liquid,index_name,context]
 ----
 {% for schema in context.schemas %}
 == {{schema.id}}
@@ -233,9 +237,16 @@ Author
 ----
 -----
 
-=== Filtering EXPRESS schemas defined in an index for `lutaml_express`
+* The `lutaml_express_liquid` macro processes the EXPRESS files specified by
+  the `index_name` and makes them available in the `context` as
+  Liquid Drops object.
 
-This functionality allows `[lutaml_express]` blocks to load a full set of
+* The Liquid template inside the macro block iterates over the `schemas` in
+  the `context` and renders the attributes of each schema such as `id`.
+
+=== Using `config_yaml`
+
+This functionality allows `[lutaml_express_liquid]` blocks to load a full set of
 EXPRESS schemas in one index, and then provide a select ("filter") option
 per-block via a separate YAML file.
 
@@ -243,8 +254,8 @@ per-block via a separate YAML file.
 -----
 :lutaml-express-index: all_schemas; ../schemas_all.yaml;
 
-[lutaml_express,all_schemas,context,leveloffset=+1,config_yaml=schemas.yaml]
-----
+[lutaml_express_liquid,all_schemas,context,config_yaml=schemas.yaml]
+---
 {% assign selected = context.schemas | where: "selected" %}
 {% render "templates/resources/schema" for selected as schema %}
 ----
@@ -282,9 +293,9 @@ The resulting block adds the `select` attribute to every schema of the the
 via Liquid:
 
 [source,liquid]
------
-[lutaml_express,schemas_1,repo,leveloffset=+1,config_yaml=select.yaml]
 ----
+[lutaml_express_liquid,schemas_1,repo,config_yaml=select.yaml]
+---
 {% assign selected = repo.schemas | where: "selected" %}
 ... do things with `selected` ...
 ---

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

@@ -5,7 +5,6 @@ require "asciidoctor"
 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
@@ -15,12 +14,12 @@ module Metanorma
       class LutamlPreprocessor < ::Asciidoctor::Extensions::Preprocessor
         REMARKS_ATTRIBUTE = "remarks"
 
-        def process(document, reader)
+        def process(document, reader) # rubocop:disable Metrics/MethodLength
           r = Asciidoctor::PreprocessorNoIfdefsReader.new(document,
                                                           reader.lines)
           input_lines = r.readlines.to_enum
 
-          has_lutaml = input_lines.any? { |line| lutaml?(line) }
+          has_lutaml_liquid = input_lines.any? { |line| lutaml_liquid?(line) }
 
           express_indexes = Utils.parse_document_express_indexes(
             document,
@@ -33,7 +32,7 @@ module Metanorma
             express_indexes: express_indexes,
           )
 
-          log(document, result_content) if has_lutaml
+          log(document, result_content) if has_lutaml_liquid
 
           Asciidoctor::PreprocessorNoIfdefsReader.new(document, result_content)
         end
@@ -46,8 +45,8 @@ module Metanorma
           end
         end
 
-        def lutaml?(line)
-          line.match(/^\[(?:\blutaml\b|\blutaml_express\b),(?<index_names>[^,]+)?,?(?<context_name>[^,]+)?(?<options>,.*)?\]/)
+        def lutaml_liquid?(line)
+          line.match(/^\[(?:\blutaml\b|\blutaml_express\b|\blutaml_express_liquid\b),(?<index_names>[^,]+)?,?(?<context_name>[^,]+)?(?<options>,.*)?\]/) # rubocop:disable Layout/LineLength
         end
 
         def load_lutaml_file(document, file_path)
@@ -61,28 +60,19 @@ module Metanorma
 
         private
 
-        def process_input_lines(
-          document:,
-            input_lines:,
-            express_indexes:
-        )
-
+        def process_input_lines(document:, input_lines:, express_indexes:)
           result = []
           loop do
             result.push(
-              *process_text_blocks(
-                document,
-                input_lines,
-                express_indexes,
-              ),
+              *process_text_blocks(document, input_lines, express_indexes),
             )
           end
           result
         end
 
-        def process_text_blocks(document, input_lines, express_indexes)
+        def process_text_blocks(document, input_lines, express_indexes) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
           line = input_lines.next
-          block_header_match = lutaml?(line)
+          block_header_match = lutaml_liquid?(line)
 
           return [line] if block_header_match.nil?
 
@@ -94,7 +84,7 @@ module Metanorma
 
           end_mark = input_lines.next
 
-          render_template(
+          render_liquid_template(
             document: document,
             lines: extract_block_lines(input_lines, end_mark),
             index_names: index_names,
@@ -112,19 +102,16 @@ module Metanorma
           block
         end
 
-        def gather_context_items(index_names:, document:, indexes:)
+        def gather_context_liquid_items(index_names:, document:, indexes:, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+selected_schemas:, options:)
           index_names.map do |path|
-            # TODO: Rephrase of the below TODO message.
-            # ::Lutaml::Parser.parse(file_list) can return an Array or just one.
-            # TODO: decide how to handle expressir multiply file parse as one
-            # object and lutaml
-
-            # Does this condition ever happen? That is only if the
-            # `lutaml-express-index` condition is not set
             if indexes[path]
-              indexes[path][:serialized_hash] ||= indexes[path][:wrapper].to_liquid
+              indexes[path][:liquid_drop] ||=
+                indexes[path][:wrapper].original_document.to_liquid(
+                  selected_schemas: selected_schemas,
+                  options: options,
+                )
             else
-
               full_path = Utils.relative_file_path(document, path)
               unless File.file?(full_path)
                 raise StandardError.new(
@@ -135,8 +122,10 @@ module Metanorma
               end
               wrapper = load_lutaml_file(document, path)
               indexes[path] = {
-                wrapper: wrapper,
-                serialized_hash: wrapper.to_liquid,
+                liquid_drop: wrapper.original_document.to_liquid(
+                  selected_schemas: selected_schemas,
+                  options: options,
+                ),
               }
             end
 
@@ -144,7 +133,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)
@@ -156,8 +145,8 @@ module Metanorma
           if config_yaml["schemas"]
             unless config_yaml["schemas"].is_a?(Hash)
               raise StandardError.new(
-                "[lutaml_express] attribute `config_yaml` must point to a YAML " \
-                "file that has the `schema` key containing a hash.",
+                "[lutaml_express_liquid] attribute `config_yaml` must point " \
+                "to a YAML file that has the `schema` key containing a hash.",
               )
             end
 
@@ -167,35 +156,6 @@ module Metanorma
           options
         end
 
-        def decorate_schema_object(schema:, document:, indexes:, index_names:, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/ParameterLists
-selected:, options:)
-          # Mark a schema as "selected" with `.selected`
-          schema["selected"] = true if selected
-
-          # Provide pretty-formatted code under `.formatted`
-          _index_found_key, index_found_value = indexes.detect do |k, v|
-            _found = get_original_document(v[:wrapper]).schemas.detect do |s|
-              s.id == schema["id"]
-            end
-          end
-
-          schema["formatted"] = get_original_document(
-            index_found_value[:wrapper],
-          ).schemas.detect do |s|
-            s.id == schema["id"]
-          end.to_s(no_remarks: true)
-
-          # Decorate the remaining things
-          decorate_context_items(
-            schema,
-            options.merge(
-              "relative_path_prefix" =>
-                Utils.relative_file_path(document,
-                                         File.dirname(schema["file"])),
-            ),
-          ) || {}
-        end
-
         def get_original_document(wrapper)
           doc = wrapper
           return doc if doc.instance_of?(::Lutaml::XMI::RootDrop)
@@ -203,38 +163,26 @@ selected:, options:)
           doc.original_document
         end
 
-        def render_template(document:, lines:, context_name:, index_names:, # rubocop:disable Metrics/ParameterLists,Metrics/AbcSize,Metrics/MethodLength
-options:, indexes:)
+        def render_liquid_template(document:, lines:, context_name:, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/ParameterLists
+index_names:, options:, indexes:)
           config_yaml_path = options.delete("config_yaml")
           config = read_config_yaml_file(document, config_yaml_path)
           selected_schemas = config["selected_schemas"]
 
-          gather_context_items(
+          all_items = gather_context_liquid_items(
             index_names: index_names,
             document: document,
             indexes: indexes,
-          ).map do |items|
-            serialized_hash = items[:serialized_hash]
-
-            serialized_hash["schemas"]&.map! do |schema|
-              decorate_schema_object(
-                schema: schema,
-                document: document,
-                index_names: index_names,
-                indexes: indexes,
-                selected: selected_schemas && selected_schemas.include?(
-                  schema["id"],
-                ),
-                options: options,
-              )
-            end
+            selected_schemas: selected_schemas,
+            options: options.merge("document" => document),
+          )
 
-            render_block(
-              document: document,
-              block_lines: lines,
-              context_items: serialized_hash,
-              context_name: context_name,
-            )
+          all_items.map do |item|
+            repo_drop = item[:liquid_drop]
+            template = ::Liquid::Template.parse(lines.join("\n"))
+            template.assigns[context_name] = repo_drop
+            template.assigns["selected_schemas"] = selected_schemas
+            template.render
           end.flatten
         rescue StandardError => e
           ::Metanorma::Util.log(
@@ -252,48 +200,6 @@ options:, indexes:)
             .map { |elem| elem.map(&:strip) }
             .to_h
         end
-
-        def decorate_context_item(key, val, options)
-          if key == REMARKS_ATTRIBUTE
-            return [
-              key,
-              val&.map do |remark|
-                Metanorma::Plugin::Lutaml::ExpressRemarksDecorator
-                    .call(remark, options)
-              end,
-            ]
-          end
-
-          case val
-          when Hash
-            [key, decorate_context_items(val, options)]
-          when Array
-            [key, val.map { |n| decorate_context_items(n, options) }]
-          else
-            [key, val]
-          end
-        end
-
-        def decorate_context_items(item, options)
-          return item unless item.is_a?(Hash)
-
-          item.map do |(key, val)|
-            decorate_context_item(key, val, options)
-          end.to_h
-        end
-
-        def render_block(block_lines:, context_items:, context_name:, document:)
-          render_result, errors = Utils.render_liquid_string(
-            template_string: block_lines.join("\n"),
-            context_items: context_items,
-            context_name: context_name,
-            document: document,
-          )
-
-          Utils.notify_render_errors(document, errors)
-
-          render_result.split("\n")
-        end
       end
     end
   end

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

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

data/metanorma-plugin-lutaml.gemspec

@@ -27,9 +27,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor"
   spec.add_dependency "coradoc", "~> 1.1.1"
-  spec.add_dependency "expressir", "~> 2.1.0"
+  spec.add_dependency "expressir", "~> 2.1.6"
   spec.add_dependency "liquid"
-  spec.add_dependency "lutaml", ">= 0.9.18"
+  spec.add_dependency "lutaml", "~> 0.9.25"
   spec.add_dependency "ogc-gml", "1.0.0"
   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.7.17
+  version: 0.7.18
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.1.6
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: lutaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.25
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.25
 - !ruby/object:Gem::Dependency
   name: ogc-gml
   requirement: !ruby/object:Gem::Requirement
@@ -313,7 +313,6 @@ files:
 - 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
 - lib/metanorma/plugin/lutaml/liquid_drops/gml_dictionary_drop.rb

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

@@ -1,78 +0,0 @@
-module Metanorma
-  module Plugin
-    module Lutaml
-      class ExpressRemarksDecorator
-        RELATIVE_PREFIX_MACRO_REGEXP = /^(link|image|video|audio|include)(:+)?(?![^\/:]+:\/\/|[A-Z]:\/|\/)([^:\[]+)(\[.*\])?$/.freeze
-
-        attr_reader :remark, :options
-
-        def self.call(remark, options)
-          new(remark, options).call
-        end
-
-        def initialize(remark, options)
-          @remark = remark
-          @options = options
-        end
-
-        def call
-          result = remark
-          if options["leveloffset"]
-            result = process_remark_offsets(result, options["leveloffset"].to_i)
-          end
-          if options["relative_path_prefix"]
-            result = update_relative_paths(result,
-                                           options["relative_path_prefix"])
-          end
-          result
-        end
-
-        private
-
-        def update_relative_paths(string, path_prefix)
-          string
-            .split("\n")
-            .map do |line|
-              if line.match?(RELATIVE_PREFIX_MACRO_REGEXP)
-                prefix_relative_paths(line, path_prefix)
-              else
-                line
-              end
-            end
-            .join("\n")
-        end
-
-        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 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)
-            "#{$1}#{$2}#{full_path}#{$4}"
-          end
-        end
-
-        def process_remark_offsets(string, offset)
-          string
-            .split("\n")
-            .map do |line|
-              if line.match?(/^=/)
-                set_string_offsets(line, offset)
-              else
-                line
-              end
-            end
-            .join("\n")
-        end
-
-        def set_string_offsets(string, offset)
-          return "#{'=' * offset}#{string}" if offset.positive?
-
-          string.gsub(/^={#{offset * -1}}/, "")
-        end
-      end
-    end
-  end
-end