metanorma-plugin-datastruct 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9afcd660bc9aa57c185e892b9654545e5665ca4fd1dfe6766936929e4103788f
-  data.tar.gz: 027c3feec5d5f497a814aa8a6326b15256055cc18c8e148bd823f9d7b5d8a2e5
+  metadata.gz: dab2d2b2496a73636d10696dc5324749bfeb054dbeb5cf5944dac0a857327b17
+  data.tar.gz: d4790331414d8f4f3f02a3e14e21be2a2d70c4684df658cc329816a5e02b2709
 SHA512:
-  metadata.gz: f1d96b5d3628b6995799de038d408df8c6ae26867fac238166f386c3de63ada247154275e7dd42122a2a8493ca5ef7479ec40581d4bc76aa91e9bcd8c8a7d6fc
-  data.tar.gz: d131b05dcb593a958d1de557a66ea960a6bf412fbe922ab7c19b054efa2fb5e453d162468d0d6cd41817d8f95099c7947e772189688709ea3889e795335db719
+  metadata.gz: abb03b267186c6860c7c99d141e179fc5bd8528fcc031e4117a4395b7a197d0ef2e6dbd3e97c87ab2f38211df1e483832477ea19a743e7253532b8dbeec91192
+  data.tar.gz: 8e00dceace62d6c6384d8d8c2576ec7185d0930e7f75ea1f11ba20655a6896cf6bc457a60867c8c96a927a17e839a60ac8a84fb789d0786bef74aeaf3b3daa26

data/Gemfile

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

data/README.adoc

@@ -427,7 +427,7 @@ And the block:
 Where:
 
 * file path is `strings.yaml`
-* `limit` - how many items we shoudl take from the array
+* `limit` - how many items we should take from the array
 * `offset` - zero-based offset of item from which start the loop
 * `{{item}}` gives the value of item in the array
 
@@ -578,3 +578,117 @@ Last item is dolor.
 ------
 
 --
+
+
+=== Multiple contexts
+
+Multiple contexts can be defined in a single block.
+
+EXAMPLE:
+--
+Given:
+
+strings1.yaml
+[source,yaml]
+----
+---
+foo: bar
+dead: beef
+----
+
+strings2.yaml
+[source,yaml]
+----
+---
+hello: world
+color: red
+shape: square
+----
+
+And the block:
+[source,asciidoc]
+------
+[yaml2text,data1=strings1.yaml,data2=strings2.yaml]
+----
+I'm heading to the {{data1.foo}} for {{data1.dead}}.
+
+This is hello {{data2.hello}}.
+The color is {{data2.color}} and the shape is {{data2.shape}}.
+
+----
+------
+
+The file path is `strings1.yaml`, and context name is `data1`.
+`{{data1.foo}}` evaluates to the value of the key `foo` in `data1`.
+
+The file path is `strings2.yaml`, and context name is `data2`.
+`{{data2.hello}}` evaluates to the value of the key `hello` in `data2`.
+
+Will render as:
+[source,asciidoc]
+----
+I'm heading to the bar for beef.
+
+This is hello world.
+The color is red and the shape is square.
+----
+
+--
+
+
+=== Multiple contexts with mixed json files and yaml files (data2text)
+
+Multiple contexts can be mixed with json files and yaml files by using
+`data2text`.
+
+EXAMPLE:
+--
+Given:
+
+strings1.json
+[source,json]
+----
+{
+  "foo": "bar",
+  "dead": "beef"
+}
+----
+
+strings2.yaml
+[source,yaml]
+----
+---
+hello: world
+color: red
+shape: square
+----
+
+And the block:
+[source,asciidoc]
+------
+[data2text,my_json=strings1.json,my_yaml=strings2.yaml]
+----
+I'm heading to the {{my_json.foo}} for {{my_json.dead}}.
+
+This is hello {{my_yaml.hello}}.
+The color is {{my_yaml.color}} and the shape is {{my_yaml.shape}}.
+
+----
+------
+
+The file path is `strings1.json`, and context name is `my_json`.
+`{{my_json.foo}}` evaluates to the value of the key `foo` in `my_json`.
+
+The file path is `strings2.yaml`, and context name is `my_yaml`.
+`{{my_yaml.hello}}` evaluates to the value of the key `hello` in `my_yaml`.
+
+Will render as:
+[source,asciidoc]
+----
+I'm heading to the bar for beef.
+
+This is hello world.
+The color is red and the shape is square.
+----
+
+--

data/lib/liquid/custom_blocks/key_iterator.rb

@@ -6,9 +6,13 @@ module Liquid
         @context_name, @var_name = markup.split(",").map(&:strip)
       end
 
-      def render(context)
+      def render(context) # rubocop:disable Metrics/MethodLength
         res = ""
-        iterator = context[@context_name].is_a?(Hash) ? context[@context_name].keys : context[@context_name]
+        iterator = if context[@context_name].is_a?(Hash)
+                     context[@context_name].keys
+                   else
+                     context[@context_name]
+                   end
         iterator.each.with_index do |key, index|
           context["index"] = index
           context[@var_name] = key

data/lib/liquid/custom_blocks/with_json_nested_context.rb

@@ -9,7 +9,7 @@ module Liquid
       def render(context)
         context_file = context[@context_file_variable].to_s.strip
         context[@context_name] = JSON.parse(
-          File.read(context_file, encoding: "utf-8")
+          File.read(context_file, encoding: "utf-8"),
         )
         super
       end

data/lib/liquid/custom_blocks/with_yaml_nested_context.rb

@@ -12,7 +12,7 @@ module Liquid
           File.read(context_file, encoding: "utf-8"),
           permitted_classes: [Date, Time],
           permitted_symbols: [],
-          aliases: true
+          aliases: true,
         )
         super
       end

data/lib/metanorma/plugin/datastruct/base_structured_text_preprocessor.rb

@@ -91,7 +91,7 @@ module Metanorma
                          block_match)
         end
 
-        def collect_internal_block_lines(document, input_lines, end_mark)
+        def collect_internal_block_lines(document, input_lines, end_mark) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
           current_block = []
           nested_marks = []
           while (block_line = input_lines.next) != end_mark
@@ -105,7 +105,9 @@ module Metanorma
             end
 
             if nested_marks.include?(block_line)
-              current_block.push("{% endwith_#{data_file_type}_nested_context %}")
+              current_block.push(
+                "{% endwith_#{data_file_type}_nested_context %}",
+              )
               next nested_marks.delete(block_line)
             end
             current_block.push(block_line)
@@ -127,9 +129,16 @@ module Metanorma
           TEMPLATE
         end
 
-        def parse_template(document, current_block, block_match)
-          transformed_liquid_lines = current_block
-            .map(&method(:transform_line_liquid))
+        def parse_template(document, current_block, block_match) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          transformed_liquid_lines = current_block.map do |x|
+            transform_line_liquid(x)
+          end
+
+          if block_match[1].include?("=")
+            return content_from_multiple_contexts(
+              document, block_match, transformed_liquid_lines
+            )
+          end
 
           context_items = if block_match[1].start_with?("#")
                             content_from_anchor(document, block_match[1][1..-1])
@@ -139,17 +148,37 @@ module Metanorma
 
           return if context_items.nil?
 
+          contexts = { block_match[2].strip => context_items }
+
           parse_context_block(document: document,
                               context_lines: transformed_liquid_lines,
-                              context_items: context_items,
-                              context_name: block_match[2].strip)
+                              contexts: contexts)
         rescue StandardError => e
           ::Metanorma::Util.log("Failed to parse #{config[:block_name]} \
               block: #{e.message}", :error)
           []
         end
 
-        def transform_line_liquid(line)
+        def content_from_multiple_contexts(document, block_match, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          transformed_liquid_lines)
+          contexts = {}
+          (1..block_match.size - 1).each do |i|
+            context_and_path = block_match[i].strip
+            context_name, path = context_and_path.split("=")
+            context_items = content_from_file(document, path)
+            contexts[context_name] = context_items
+          end
+
+          parse_context_block(document: document,
+                              context_lines: transformed_liquid_lines,
+                              contexts: contexts)
+        rescue StandardError => e
+          ::Metanorma::Util.log("Failed to parse #{config[:block_name]} \
+            block: #{e.message}", :error)
+          []
+        end
+
+        def transform_line_liquid(line) # rubocop:disable Metrics/MethodLength
           if line.match?(BLOCK_START_REGEXP)
             line.gsub!(BLOCK_START_REGEXP, '{% keyiterator \1, \2 %}')
           end
@@ -166,28 +195,23 @@ module Metanorma
                   '{% assign custom_value = \1 | values %}{{custom_value\2}}')
         end
 
-        def parse_context_block(context_lines:,
-                                context_items:,
-                                context_name:,
-                                document:)
+        def parse_context_block(context_lines:, contexts:, document:)
           render_result, errors = render_liquid_string(
             template_string: context_lines.join("\n"),
-            context_items: context_items,
-            context_name: context_name,
+            contexts: contexts,
             document: document,
           )
           notify_render_errors(document, errors)
           render_result.split("\n")
         end
 
-        def render_liquid_string(template_string:, context_items:,
-                                 context_name:, document:)
+        def render_liquid_string(template_string:, contexts:, document:)
           liquid_template = Liquid::Template.parse(template_string)
           # Allow includes for the template
           liquid_template.registers[:file_system] =
             ::Liquid::LocalFileSystem.new(relative_file_path(document, ""))
           rendered_string = liquid_template
-            .render(context_name => context_items,
+            .render(contexts,
                     strict_variables: true,
                     error_mode: :warn)
           [rendered_string, liquid_template.errors]

data/lib/metanorma/plugin/datastruct/content.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "json"
+require "yaml"
+
+module Metanorma
+  module Plugin
+    module Datastruct
+      module Content
+        protected
+
+        # https://ruby-doc.org/stdlib-2.5.1/libdoc/psych/rdoc/Psych.html#method-c-safe_load
+        def yaml_content_from_file(document, file_path) # rubocop:disable Metrics/MethodLength
+          resolved_file_path = relative_file_path(document, file_path)
+
+          unless File.exist?(resolved_file_path)
+            ::Metanorma::Util.log(
+              "YAML file referenced in [yaml2text] block not found: " \
+              "#{resolved_file_path}", :error
+            )
+            return
+          end
+
+          YAML.safe_load(
+            File.read(resolved_file_path, encoding: "UTF-8"),
+            permitted_classes: [Date, Time],
+            permitted_symbols: [],
+            aliases: true,
+          )
+        end
+
+        def yaml_content_from_anchor(document, anchor)
+          YAML.safe_load(
+            document.attributes["source_blocks"][anchor],
+            permitted_classes: [Date, Time],
+            permitted_symbols: [],
+            aliases: true,
+          )
+        end
+
+        def json_content_from_file(document, file_path)
+          JSON.parse(File.read(relative_file_path(document, file_path),
+                               encoding: "UTF-8"))
+        end
+
+        def json_content_from_anchor(document, anchor)
+          JSON.parse(document.attributes["source_blocks"][anchor])
+        end
+
+        def content_from_file(document, file_path)
+          if json_file?(file_path)
+            json_content_from_file(document, file_path)
+          else
+            yaml_content_from_file(document, file_path)
+          end
+        end
+
+        def content_from_anchor(document, anchor)
+          if json_content?(document.attributes["source_blocks"][anchor])
+            json_content_from_anchor(document, anchor)
+          else
+            yaml_content_from_anchor(document, anchor)
+          end
+        end
+
+        def json_file?(file_path)
+          file_path.end_with?(".json")
+        end
+
+        def json_content?(content)
+          content.start_with?("{", "[")
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/datastruct/data2_text_preprocessor.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "content"
+require "metanorma/plugin/datastruct/base_structured_text_preprocessor"
+
+module Metanorma
+  module Plugin
+    module Datastruct
+      class Data2TextPreprocessor < BaseStructuredTextPreprocessor
+        include Content
+        # search document for block `data2text`
+        #   after that take template from block and read file into this template
+        #   example:
+        #     [data2text,my_yaml=foobar.yaml,my_json=foobar.json]
+        #     ----
+        #     === {foobar.name}
+        #     {foobar.desc}
+        #
+        #     {my_json.symbol}:: {my_json.symbol_def}
+        #     ----
+        #
+        #   with content of `foobar.yaml` file equal to:
+        #     - name: spaghetti
+        #       desc: wheat noodles of 9mm diameter
+        #
+        #   and content of `foobar.json` file equal to:
+        #     {
+        #       "symbol": "SPAG",
+        #       "symbol_def": "the situation is message like spaghetti",
+        #     }
+        #
+        #   will produce:
+        #     === spaghetti
+        #     wheat noodles of 9mm diameter
+        #
+        #     SPAG:: the situation is message like spaghetti
+
+        def initialize(config = {})
+          super
+          @config[:block_name] = "data2text"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/datastruct/json2_text_preprocessor.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
-require "json"
+require_relative "content"
 require "metanorma/plugin/datastruct/base_structured_text_preprocessor"
 
 module Metanorma
   module Plugin
     module Datastruct
       class Json2TextPreprocessor < BaseStructuredTextPreprocessor
-        # search document for block `yaml2text`
+        include Content
+        # search document for block `json2text`
         #   after that take template from block and read file into this template
         #   example:
-        #     [yaml2text,foobar.yaml]
+        #     [json2text,foobar.json]
         #     ----
         #     === {item.name}
         #     {item.desc}
@@ -18,33 +19,24 @@ module Metanorma
         #     {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
+        #   with content of `foobar.json` file equal to:
+        #     {
+        #       "name": "spaghetti",
+        #       "desc": "wheat noodles of 9mm diameter".
+        #       "symbol": "SPAG",
+        #       "symbol_def": "the situation is message like spaghetti",
+        #     }
         #
         #   will produce:
         #     === spaghetti
         #     wheat noodles of 9mm diameter
         #
-        #     SPAG:: the situation is message like spaghetti at a kid's meal
+        #     SPAG:: the situation is message like spaghetti
 
         def initialize(config = {})
           super
           @config[:block_name] = "json2text"
         end
-
-        protected
-
-        def content_from_file(document, file_path)
-          JSON.parse(File.read(relative_file_path(document, file_path),
-                               encoding: "UTF-8"))
-        end
-
-        def content_from_anchor(document, anchor)
-          JSON.parse(document.attributes["source_blocks"][anchor])
-        end
       end
     end
   end

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

@@ -27,7 +27,7 @@ module Metanorma
           new(document, input_lines).extract
         end
 
-        def extract
+        def extract # rubocop:disable Metrics/AbcSize
           lines = @input_lines.to_enum
 
           loop do

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

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Datastruct
-      VERSION = "0.3.1".freeze
+      VERSION = "0.3.2".freeze
     end
   end
 end

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

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-require "yaml"
+require_relative "content"
 require "metanorma/plugin/datastruct/base_structured_text_preprocessor"
 
 module Metanorma
   module Plugin
     module Datastruct
       class Yaml2TextPreprocessor < BaseStructuredTextPreprocessor
+        include Content
         # search document for block `yaml2text`
         #   after that take template from block and read file into this template
         #   example:
@@ -34,34 +35,6 @@ module Metanorma
           super
           @config[:block_name] = "yaml2text"
         end
-
-        protected
-
-        # https://ruby-doc.org/stdlib-2.5.1/libdoc/psych/rdoc/Psych.html#method-c-safe_load
-        def content_from_file(document, file_path)
-          resolved_file_path = relative_file_path(document, file_path)
-
-          unless File.exist?(resolved_file_path)
-            ::Metanorma::Util.log("YAML file referenced in [yaml2text] block not found: #{resolved_file_path}", :error)
-            return
-          end
-
-          YAML.safe_load(
-            File.read(resolved_file_path, encoding: "UTF-8"),
-            permitted_classes: [Date, Time],
-            permitted_symbols: [],
-            aliases: true,
-          )
-        end
-
-        def content_from_anchor(document, anchor)
-          YAML.safe_load(
-            document.attributes["source_blocks"][anchor],
-            permitted_classes: [Date, Time],
-            permitted_symbols: [],
-            aliases: true,
-          )
-        end
       end
     end
   end

data/lib/metanorma-plugin-datastruct.rb

@@ -1,6 +1,7 @@
 require "metanorma/plugin/datastruct/version"
 require "metanorma/plugin/datastruct/json2_text_preprocessor"
 require "metanorma/plugin/datastruct/yaml2_text_preprocessor"
+require "metanorma/plugin/datastruct/data2_text_preprocessor"
 
 module Metanorma
   module Plugin

data/metanorma-plugin-datastruct.gemspec

@@ -15,7 +15,8 @@ Gem::Specification.new do |spec|
   spec.license       = "BSD-2-Clause"
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       f.match(%r{^(test|spec|features)/})
@@ -25,6 +26,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.7.0" # rubocop:disable Gemspec/RequiredRubyVersion
+
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "isodoc"
   spec.add_dependency "relaton-cli"
@@ -35,7 +38,8 @@ 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 "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", "~> 6.1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-datastruct
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -140,16 +140,30 @@ dependencies:
   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: 0.54.0
+        version: '1.58'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
@@ -247,6 +261,8 @@ files:
 - lib/liquid/custom_filters/values.rb
 - lib/metanorma-plugin-datastruct.rb
 - lib/metanorma/plugin/datastruct/base_structured_text_preprocessor.rb
+- lib/metanorma/plugin/datastruct/content.rb
+- lib/metanorma/plugin/datastruct/data2_text_preprocessor.rb
 - lib/metanorma/plugin/datastruct/json2_text_preprocessor.rb
 - lib/metanorma/plugin/datastruct/source_extractor.rb
 - lib/metanorma/plugin/datastruct/version.rb
@@ -265,7 +281,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="