metanorma-plugin-datastruct 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed19e5b25fb509b816c567e7e274739ce9dd2e734814ccf77c3e68f1e45775ad
-  data.tar.gz: b57e630d156f1f604d370842cd26431e63ed68a27ec58f4cd89ca78409110372
+  metadata.gz: c8ea0d4bb0e67f7932f2f1e1a9e4753c55fe2e42f0dfd1f9e25711f3769dcd74
+  data.tar.gz: c43066c046874fa618e06b8fd62ada97ee665e795ea9a87a62fb89642796577f
 SHA512:
-  metadata.gz: 4212768404a5a67011682cce9aadac40453dadfc34d63cf69c07fd888789a817793c1c9e0a2b16c582f6a7015f7cd58046e3a5583d992b4072912c452bd5a4e0
-  data.tar.gz: feb6aa83d2fca789fa7044dea3579f80d2c9b8e16b989fd4c3369764c048eea1d7427b36fdb622eeadc657e45aaf6e6931e065582805101735134259aa04db59
+  metadata.gz: 2dfda2e9c51df6408b037dee8a07e17f6a31e51607e35932fb69a81d8a2efa7c986a847de281e06927d512d0d5322ae5e7b4de8e59f429901918ccbb36b7612c
+  data.tar.gz: cff48e717964db88996408c9a347f9f795dc29a3d2ed6a2b26969801f81380f35780be1a1d7e0136f8d67ab0c59071639fc15a555e87ed1e7a2df427636e9697

data/README.adoc

@@ -692,3 +692,73 @@ The color is red and the shape is square.
 ----
 
 --
+
+
+=== Content contains json or yaml filepaths
+
+When the content of the loaded files contains filepaths of json files or
+yaml files, you can load extra data by these filepaths by `load_file` liquid
+filter.
+
+EXAMPLE:
+--
+Given:
+
+strings1.json
+[source,json]
+----
+{
+  "foo": "bar",
+  "paths": ["a.yaml", "b.yaml"]
+}
+----
+
+Where:
+
+* `paths` is an array of filepaths relative to the Metanorma document
+
+a.yaml
+[source,yaml]
+----
+---
+shape: circle
+color: red
+----
+
+b.yaml
+[source,yaml]
+----
+---
+shape: square
+color: blue
+corners: 4
+----
+
+And the block:
+[source,asciidoc]
+------
+[data2text,my_context=strings1.json]
+----
+I'm heading to the {{my_context.foo}}.
+
+{% for path in my_context.paths %}
+{% assign foo = path | load_file %}
+This is {{ foo[shape] }} with color {{ foo[color] }}.
+{% endfor %}
+----
+------
+
+Where:
+
+* load_file is a liquid filter that loads the file content
+
+Will render as:
+[source,asciidoc]
+----
+I'm heading to the bar.
+
+This is circle with color red.
+This is square with color blue.
+----
+
+--

data/lib/liquid/custom_filters/loadfile.rb

@@ -0,0 +1,12 @@
+require "metanorma/plugin/datastruct/content"
+
+module Liquid
+  module CustomFilters
+    include ::Metanorma::Plugin::Datastruct::Content
+
+    def loadfile(path, parent_folder)
+      resolved_file_path = File.expand_path(path, parent_folder)
+      load_content_from_file(resolved_file_path)
+    end
+  end
+end

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

@@ -4,20 +4,13 @@ require "liquid"
 require "asciidoctor"
 require "asciidoctor/reader"
 require "liquid/custom_blocks/key_iterator"
-require "liquid/custom_blocks/with_yaml_nested_context"
-require "liquid/custom_blocks/with_json_nested_context"
 require "liquid/custom_filters/values"
 require "liquid/custom_filters/replace_regex"
+require "liquid/custom_filters/loadfile"
 require "metanorma/plugin/datastruct/source_extractor"
 
 Liquid::Environment.default
   .register_tag("keyiterator", Liquid::CustomBlocks::KeyIterator)
-Liquid::Environment.default
-  .register_tag("with_yaml_nested_context",
-                Liquid::CustomBlocks::WithYamlNestedContext)
-Liquid::Environment.default
-  .register_tag("with_json_nested_context",
-                Liquid::CustomBlocks::WithJsonNestedContext)
 Liquid::Environment.default.register_filter(Liquid::CustomFilters)
 
 module Asciidoctor
@@ -36,6 +29,7 @@ module Metanorma
         Asciidoctor::Extensions::Preprocessor
         BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/.freeze
         BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/.freeze
+        LOAD_FILE_REGEXP = /{% assign (.*) = (.*) \| load_file %}/.freeze
 
         def process(document, reader)
           r = ::Asciidoctor::PreprocessorNoIfdefsReader
@@ -93,23 +87,16 @@ module Metanorma
 
         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
-            if nested_match = block_line
-                .match(/^\[#{config[:block_name]},(.+?),(.+?)\]/)
-              current_block
-                .push(*nested_context_tag(document,
-                                          nested_match[1],
-                                          nested_match[2]).split("\n"))
-              next nested_marks.push(input_lines.next)
-            end
+            if block_line.match?(LOAD_FILE_REGEXP)
+              load_file_match = block_line.match(LOAD_FILE_REGEXP)
 
-            if nested_marks.include?(block_line)
-              current_block.push(
-                "{% endwith_#{data_file_type}_nested_context %}",
-              )
-              next nested_marks.delete(block_line)
+              # Add parent folder as argument to loadfile filter
+              block_line = "{% assign #{load_file_match[1]} = "\
+                           "#{load_file_match[2]} | loadfile: " \
+                           "\"#{document.attributes['docdir']}\" %}"
             end
+
             current_block.push(block_line)
           end
           current_block
@@ -119,16 +106,6 @@ module Metanorma
           @config[:block_name].split("2").first
         end
 
-        def nested_context_tag(document, file_path, context_name)
-          absolute_file_path = relative_file_path(document, file_path)
-          <<~TEMPLATE
-            {% capture nested_file_path %}
-            #{absolute_file_path}
-            {% endcapture %}
-            {% with_#{data_file_type}_nested_context nested_file_path, #{context_name}  %}
-          TEMPLATE
-        end
-
         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)

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

@@ -10,9 +10,7 @@ module Metanorma
         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)
-
+        def yaml_content_from_file(resolved_file_path) # rubocop:disable Metrics/MethodLength
           unless File.exist?(resolved_file_path)
             ::Metanorma::Util.log(
               "YAML file referenced in [yaml2text] block not found: " \
@@ -23,7 +21,7 @@ module Metanorma
 
           YAML.safe_load(
             File.read(resolved_file_path, encoding: "UTF-8"),
-            permitted_classes: [Date, Time],
+            permitted_classes: [Date, Time, Symbol],
             permitted_symbols: [],
             aliases: true,
           )
@@ -32,15 +30,14 @@ module Metanorma
         def yaml_content_from_anchor(document, anchor)
           YAML.safe_load(
             document.attributes["source_blocks"][anchor],
-            permitted_classes: [Date, Time],
+            permitted_classes: [Date, Time, Symbol],
             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"))
+        def json_content_from_file(resolved_file_path)
+          JSON.parse(File.read(resolved_file_path, encoding: "UTF-8"))
         end
 
         def json_content_from_anchor(document, anchor)
@@ -48,21 +45,31 @@ module Metanorma
         end
 
         def content_from_file(document, file_path)
-          if json_file?(file_path)
-            json_content_from_file(document, file_path)
+          resolved_file_path = relative_file_path(document, file_path)
+          load_content_from_file(resolved_file_path)
+        end
+
+        def load_content_from_file(resolved_file_path)
+          if json_file?(resolved_file_path)
+            json_content_from_file(resolved_file_path)
           else
-            yaml_content_from_file(document, file_path)
+            yaml_content_from_file(resolved_file_path)
           end
         end
 
         def content_from_anchor(document, anchor)
-          if json_content?(document.attributes["source_blocks"][anchor])
+          source_block = document.attributes["source_blocks"][anchor]
+          if json_content?(source_block)
             json_content_from_anchor(document, anchor)
           else
             yaml_content_from_anchor(document, anchor)
           end
         end
 
+        def json_or_yaml_filepath?(file_path)
+          file_path.end_with?(".json", ".yaml", ".yml")
+        end
+
         def json_file?(file_path)
           file_path.end_with?(".json")
         end

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-datastruct
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Ribose Inc.
@@ -255,8 +255,7 @@ files:
 - bin/console
 - bin/setup
 - lib/liquid/custom_blocks/key_iterator.rb
-- lib/liquid/custom_blocks/with_json_nested_context.rb
-- lib/liquid/custom_blocks/with_yaml_nested_context.rb
+- lib/liquid/custom_filters/loadfile.rb
 - lib/liquid/custom_filters/replace_regex.rb
 - lib/liquid/custom_filters/values.rb
 - lib/metanorma-plugin-datastruct.rb

data/lib/liquid/custom_blocks/with_json_nested_context.rb

@@ -1,18 +0,0 @@
-module Liquid
-  module CustomBlocks
-    class WithJsonNestedContext < Block
-      def initialize(tag_name, markup, tokens)
-        super
-        @context_file_variable, @context_name = markup.split(",").map(&:strip)
-      end
-
-      def render(context)
-        context_file = context[@context_file_variable].to_s.strip
-        context[@context_name] = JSON.parse(
-          File.read(context_file, encoding: "utf-8"),
-        )
-        super
-      end
-    end
-  end
-end

data/lib/liquid/custom_blocks/with_yaml_nested_context.rb

@@ -1,21 +0,0 @@
-module Liquid
-  module CustomBlocks
-    class WithYamlNestedContext < Block
-      def initialize(tag_name, markup, tokens)
-        super
-        @context_file_variable, @context_name = markup.split(",").map(&:strip)
-      end
-
-      def render(context)
-        context_file = context[@context_file_variable].to_s.strip
-        context[@context_name] = YAML.safe_load(
-          File.read(context_file, encoding: "utf-8"),
-          permitted_classes: [Date, Time],
-          permitted_symbols: [],
-          aliases: true,
-        )
-        super
-      end
-    end
-  end
-end