metanorma-plugin-datastruct 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe622d105e9790da8f5d61265addc954c5718827464c6b7069bfcf4f28b854e2
-  data.tar.gz: aa6fd9ec16c14b9d558631ce6dd3f87a4a5547d7cd917a8651489018ca7b9bdc
+  metadata.gz: fc634fc7a6b9a9f552e22cc95a4ca8175398003670fb00a8e6570f12adf735ac
+  data.tar.gz: 5a39bb7f4053fcfba93e50a0f78eca3d127c0a088f48c1f8db4c4606fc8fc3af
 SHA512:
-  metadata.gz: 57afedfbda26e055e3b09cc7ea5fd84978c95862039ce7894438ad6acead8dff3551fc9c7980fa006ad98eadfc6d3ed5d1c76dbe465c89df487aaa69be44c642
-  data.tar.gz: 23171c33074450db80cd6c6ab310cfdab19153428bf147beb9a7478edc3d7a61c55a89e29274debece82663ffc9d98d9d886a3193cce259b37e78a1bc40fe046
+  metadata.gz: e09440e5e49f8293720973e657b93dd46bf51c0a5952364aa45b8638dc7605ce27ec146bc0057fa677f4e6ae4b26f08576b3c729956473ffbf099e882bf2a4c9
+  data.tar.gz: a7da83aabbfaa3907355af04304551eb7eb829d304ddca8ef0e06072801f082e842565c79b2fce6ddd483503cac17fcacfc88dfb454699f376662b9db97ebd84

data/.gitignore

@@ -9,4 +9,8 @@
 
 # rspec failure tracking
 .rspec_status
-Gemfile.lock
+Gemfile.lock
+
+.byebug_history
+*.err
+.rubocop*

data/Gemfile

@@ -1,5 +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-datastruct.gemspec
 gemspec
-gem "debug"
+
+eval_gemfile("Gemfile.devel") rescue nil

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

@@ -8,6 +8,7 @@ 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 "metanorma/plugin/datastruct/source_extractor"
 
 Liquid::Template.register_tag("keyiterator", Liquid::CustomBlocks::KeyIterator)
 Liquid::Template
@@ -18,6 +19,14 @@ Liquid::Template
                 Liquid::CustomBlocks::WithJsonNestedContext)
 Liquid::Template.register_filter(Liquid::CustomFilters)
 
+module Asciidoctor
+  class PreprocessorNoIfdefsReader < PreprocessorReader
+    def preprocess_conditional_directive(_keyword, _target, _delimiter, _text)
+      false # decline to resolve idefs
+    end
+  end
+end
+
 module Metanorma
   module Plugin
     module Datastruct
@@ -28,8 +37,15 @@ module Metanorma
         BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/.freeze
 
         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
+          Metanorma::Plugin::Datastruct::SourceExtractor.extract(
+            document,
+            input_lines,
+          )
+          Asciidoctor::PreprocessorNoIfdefsReader
+            .new(document, processed_lines(document, input_lines.to_enum))
         end
 
         protected
@@ -38,6 +54,10 @@ module Metanorma
           raise ArgumentError, "Implement `content_from_file` in your class"
         end
 
+        def content_from_anchor(_document, _file_path)
+          raise ArgumentError, "Implement `content_from_anchor` in your class"
+        end
+
         private
 
         def processed_lines(document, input_lines)
@@ -50,7 +70,7 @@ module Metanorma
 
         def relative_file_path(document, file_path)
           docfile_directory = File.dirname(
-            document.attributes["docfile"] || "."
+            document.attributes["docfile"] || ".",
           )
           document
             .path_resolver
@@ -109,7 +129,13 @@ module Metanorma
         def parse_template(document, current_block, block_match)
           transformed_liquid_lines = current_block
             .map(&method(:transform_line_liquid))
-          context_items = content_from_file(document, block_match[1])
+
+          context_items = if block_match[1].start_with?("#")
+                            content_from_anchor(document, block_match[1][1..-1])
+                          else
+                            content_from_file(document, block_match[1])
+                          end
+
           parse_context_block(document: document,
                               context_lines: transformed_liquid_lines,
                               context_items: context_items,
@@ -133,7 +159,7 @@ module Metanorma
             .gsub(/(?<!{){(?!%)([^{}]+)(?<!%)}(?!})/, '{{\1}}')
             .gsub(/[a-z\.]+\#/, "index")
             .gsub(/{{(.+)\s+\+\s+(\d+)\s*?}}/, '{{ \1 | plus: \2 }}')
-            .gsub(/{{(.+)\s+\-\s+(\d+)\s*?}}/, '{{ \1 | minus: \2 }}')
+            .gsub(/{{(.+)\s+-\s+(\d+)\s*?}}/, '{{ \1 | minus: \2 }}')
             .gsub(/{{(.+)\.values(.*?)}}/,
                   '{% assign custom_value = \1 | values %}{{custom_value\2}}')
         end
@@ -146,7 +172,7 @@ module Metanorma
             template_string: context_lines.join("\n"),
             context_items: context_items,
             context_name: context_name,
-            document: document
+            document: document,
           )
           notify_render_errors(document, errors)
           render_result.split("\n")
@@ -156,7 +182,8 @@ module Metanorma
                                  context_name:, 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, ""))
+          liquid_template.registers[:file_system] =
+            ::Liquid::LocalFileSystem.new(relative_file_path(document, ""))
           rendered_string = liquid_template
             .render(context_name => context_items,
                     strict_variables: true,

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

@@ -41,6 +41,10 @@ module Metanorma
           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

@@ -0,0 +1,100 @@
+module Metanorma
+  module Plugin
+    module Datastruct
+      class SourceExtractor
+        # 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
+          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 relative_file_path(document, file_path)
+          docfile_directory = File.dirname(
+            document.attributes["docfile"] || ".",
+          )
+          document
+            .path_resolver
+            .system_path(file_path, docfile_directory)
+        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/datastruct/version.rb

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

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

@@ -43,7 +43,16 @@ module Metanorma
             File.read(relative_file_path(document, file_path), encoding: "UTF-8"),
             permitted_classes: [Date, Time],
             permitted_symbols: [],
-            aliases: true
+            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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-datastruct
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-09 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -234,6 +234,7 @@ files:
 - lib/metanorma-plugin-datastruct.rb
 - lib/metanorma/plugin/datastruct/base_structured_text_preprocessor.rb
 - lib/metanorma/plugin/datastruct/json2_text_preprocessor.rb
+- lib/metanorma/plugin/datastruct/source_extractor.rb
 - lib/metanorma/plugin/datastruct/version.rb
 - lib/metanorma/plugin/datastruct/yaml2_text_preprocessor.rb
 - metanorma-plugin-datastruct.gemspec