lm_docstache 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 233db6459ecd3c23c9d566659730ce1e4f2fcfb11b0ad4054dd83631375587ec
-  data.tar.gz: 344689f276e851c835b550f6197cc11dc2c698842b57efc29fc981fbb0026238
+  metadata.gz: ce8fea2c12829636bd22622e1c022cf2ead4ec09997b7e13322f2b94b4261654
+  data.tar.gz: a25d02153cb1a53bf74111dc59710d83a133a821c4632607c60e06531b28b4ad
 SHA512:
-  metadata.gz: 342e46c6da0b34131af9cabd468fcae78e1dd272a8e08f4b395abfa2343f51b592d88ada3885c0c7db13d1ef89b66df30f49ff7237c1fba6f61356d5130e3e52
-  data.tar.gz: 03f3a44bf4a93b5d066cb141fabb9a2d6317940f9705213183ece98cdc2861bb41e7a0d12f399b80d4f6217f92be72bf96ca62a91ddbc790d9ccb57f4bf8d25c
+  metadata.gz: 99bcdac9eea8b1d62e0733b692c600be5e8dcb88710f58d22299b6daa7eabab5f5b01eeb83e61668709655869f6580e918ef38d11bb5ae781db4462b38abba65
+  data.tar.gz: ea96603b65d984edfeeb9aa9f9b760c9665af2c5df163e4c3dae076b24ebc10fccb8e1bdee1cc6e01761496a4b89b7454e80965d6a24e96eb67b53b17e46be84

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.0.4
+* Allow replacement `data` argument to be an `Array`. This feature allow to replace blocks
+in a sequentially order following the sequence of matching blocks order.
+
 ## 3.0.3
 
 ### Bugfix

data/lib/lm_docstache/parser.rb

@@ -18,7 +18,22 @@ module LMDocstache
     VARIABLE_MATCHER = /{{([^#\^\/].*?)}}/
 
     attr_reader :document, :data, :blocks, :special_variable_replacements, :hide_custom_tags
+    attr_reader :data_sequential_replacement
 
+    # Constructor +data+ argument is a +Hash+ where the key is
+    # expected to be a +String+ representing the replacement block value. +Hash+
+    # key must not contain the `{{}}` part, but only the pattern characters.
+    # As for the values of the +Hash+, we have options:
+    #
+    # * +String+  will be the value that will replace matching string.
+    # * +Array<String>+ will be an ordered sequence of values that will replace the matched string following
+    # document matching order.
+    #
+    # Example:
+    # { 'full_name' => 'John Doe', 'text|req|Client' => ['John', 'Matt', 'Paul'] }
+    #
+    # Constructor +options+ argument is a +Hash+ where keys can be:
+    #
     # The +special_variable_replacements+ option is a +Hash+ where the key is
     # expected to be either a +Regexp+ or a +String+ representing the pattern
     # of more specific type of variables that deserves a special treatment. The
@@ -47,7 +62,8 @@ module LMDocstache
     #   will be the value that will replace the matched string
     def initialize(document, data, options = {})
       @document = document
-      @data = data.transform_keys(&:to_s)
+      @data = data.transform_keys(&:to_s).select {|e, v| !v.is_a?(Array) }
+      @data_sequential_replacement = data.transform_keys(&:to_s).select {|e, v| v.is_a?(Array) }
       @special_variable_replacements = add_blocks_to_regexp(options.fetch(:special_variable_replacements, {}))
       @hide_custom_tags = add_blocks_to_regexp(options.fetch(:hide_custom_tags, {}))
     end
@@ -65,6 +81,7 @@ module LMDocstache
       hide_custom_tags!
       find_blocks
       replace_conditional_blocks_in_document!
+      replace_data_sequentially_in_document!
       replace_variables_in_document!
     end
 
@@ -140,6 +157,32 @@ module LMDocstache
       end
     end
 
+    def replace_data_sequentially_in_document!
+      data_sequential_replacement.each do |tag_key, values|
+
+        tag = Regexp.escape("{{#{tag_key}}}")
+        pattern_found = 0
+
+        document.css('w|t').each do |text_node|
+          text = text_node.text
+
+          if text.match(tag)
+
+            text.gsub!(/#{tag}/) do |_match|
+              value = values[pattern_found]
+              # if there is no more available value replace the content with empty string
+              return '' unless value
+
+              pattern_found +=1
+              value
+            end
+
+            text_node.content = text
+          end
+        end
+      end
+    end
+
     def has_skippable_variable?(text)
       return true if hide_custom_tags.find { |(pattern, value)| text =~ pattern }
       !!special_variable_replacements.find do |(pattern, value)|

data/lib/lm_docstache/version.rb

@@ -1,3 +1,3 @@
 module LMDocstache
-  VERSION = "3.0.3"
+  VERSION = "3.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lm_docstache
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Roey Chasman
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri