lm_docstache 3.0.5 → 3.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc1a3839b3cfabfd78b144d3f2862aa4a8bf1650bc4037220b2e5af4feaa4a31
-  data.tar.gz: d573c864a49f7e2dcc07122fc242664b597a588253408f065ad94cb0f2823f0a
+  metadata.gz: c0fd5eae0f079701b3e226ae771b1d155adb69e7766dc57e67f54574c3800663
+  data.tar.gz: 2142350801b95b13ce03d2d9d34d7e077e08b257d938b65c833d25f368530a12
 SHA512:
-  metadata.gz: 7b0fb9ff483de6b2e4315206d1961f3ff847612519ed7ff11203f8ca9e7aabd35fc8a5f8730ff552c171082a0d29d2a1a126f86e89a3a117e3a10ab0a5fb5222
-  data.tar.gz: a8c510d591b10ee2d66e6c3ac85995ee9eadb8d91f2178c127e70c12b4184d840cfa725929d4d02b40e62b2e2f9f2c7d629bf65866164833e421a5fdbb5e5c7b
+  metadata.gz: 716af477b2e3c4c9b85a968836c9af7e698a0d047fb31a2801cc139eebee35968e6e47447dfbda154c70263e7b253a3d1f06aedaf6589ef12c51d9258f9ddc61
+  data.tar.gz: a85b2b58ca5590a392ff65373250049987ca14c9894fe0ba18e3731d3cb74a706104046f03f5a9053402490c1d664b012ddb74790c30a8226a722e3bc891f5db

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## 3.0.10
+
+#### Bug fixes
+
+* Only try to access and set text node's "xml:space" attribute if the text node
+  exists (in `LMDocstache::Document#flatten_text_blocks` private method).
+
+## 3.0.9
+
+#### Bug fixes
+
+* Text nodes merged in paragraphs with problems through `fix_errors` private
+  method have now the "xml:space" attribute preserved from now on.
+
+## 3.0.8
+
+#### Bug fixes
+
+* Fix a bug on `usable_tags` method, so it now properly and expectedly
+  includes conditional tag names that have its opening tag markup as the sole
+  content of paragraphs (which represents conditional blocks where both
+  opening and closing tags are in separate parapraghs sorrounding one or more
+  paragraphs as its conditional block content).
+
+## 3.0.7
+
+#### Bug fixes
+
+* Fix a bug on `usable_tag_names` method, so it now properly and expectedly
+  includes conditional tag names as well, as before.
+
+## 3.0.6
+
+#### Bug fixes
+
+* Fix bug on `LMDocstache::Docstache#unusable_tags` method, where `nil` could be
+  passed to `broken_tags.deleted_at` call.
+
 ## 3.0.5
 
 #### Bug fixes and improvements

data/lib/lm_docstache/document.rb

@@ -6,6 +6,8 @@ module LMDocstache
     BLOCK_CHILDREN_ELEMENTS = 'w|r,w|hyperlink,w|ins,w|del'
     RUN_LIKE_ELEMENTS = 'w|r,w|ins'
 
+    attr_reader :document
+
     def initialize(*paths)
       raise ArgumentError if paths.empty?
 
@@ -38,7 +40,7 @@ module LMDocstache
     def tags
       @documents.values.flat_map do |document|
         document_text = document.text
-        extract_tag_names(document_text) + extract_tag_names(document_text, true)
+        extract_tag_names(document_text) + extract_tag_names(document_text, :full_block)
       end
     end
 
@@ -47,7 +49,8 @@ module LMDocstache
         document.css('w|t').reduce(tags) do |document_tags, text_node|
           text = text_node.text
           document_tags.push(*extract_tag_names(text))
-          document_tags.push(*extract_tag_names(text, true))
+          document_tags.push(*extract_tag_names(text, :start_block))
+          document_tags.push(*extract_tag_names(text, :full_block))
         end
       end
     end
@@ -56,24 +59,16 @@ module LMDocstache
       usable_tags.reduce([]) do |memo, tag|
         next memo if !tag.is_a?(Regexp) && tag =~ ROLES_REGEXP
 
-        tag = tag.source if tag.is_a?(Regexp)
+        tag = unescape_escaped_start_block(tag.source) if tag.is_a?(Regexp)
         memo << (tag.scan(GENERAL_TAG_REGEX) && $1)
       end.compact.uniq
     end
 
     def unusable_tags
-      conditional_start_tags = text_nodes_containing_only_starting_conditionals.map(&:text)
-
       usable_tags.reduce(tags) do |broken_tags, usable_tag|
-        broken_tags.delete_at(broken_tags.index(usable_tag)) && broken_tags
-      end.reject do |broken_tag|
-        operator = broken_tag.is_a?(Regexp) ? :=~ : :==
-        start_tags_index = conditional_start_tags.find_index do |start_tag|
-          broken_tag.send(operator, start_tag)
-        end
+        next broken_tags unless index = broken_tags.index(usable_tag)
 
-        conditional_start_tags.delete_at(start_tags_index) if start_tags_index
-        !!start_tags_index
+        broken_tags.delete_at(index) && broken_tags
       end
     end
 
@@ -112,23 +107,26 @@ module LMDocstache
 
     private
 
-    def text_nodes_containing_only_starting_conditionals
-      @documents.values.flat_map do |document|
-        document.css('w|t').select do |paragraph|
-          paragraph.text =~ WHOLE_BLOCK_START_REGEX
+    def unescape_escaped_start_block(regex_source_string)
+      regex_source_string
+        .gsub('\\{', '{')
+        .gsub('\\#', '#')
+        .gsub('\\}', '}')
+        .gsub('\\^', '^')
+        .gsub('\\ ', ' ')
+    end
+
+    def extract_tag_names(text, tag_type = :variable)
+      text, regex, extractor =
+        if tag_type == :variable
+          [text, Parser::VARIABLE_MATCHER, ->(match) { "{{%s}}" % match }]
+        else
+          extractor = ->(match) { /#{Regexp.escape("{{%s%s %s %s}}" % match)}/ }
+          tag_type == :full_block ? [text, Parser::BLOCK_MATCHER, extractor] :
+            [text.strip, WHOLE_BLOCK_START_REGEX, extractor]
         end
-      end
-    end
 
-    def extract_tag_names(text, conditional_tag = false)
-      if conditional_tag
-        text.scan(Parser::BLOCK_MATCHER).map do |match|
-          start_block_tag = "{{#{match[0]}#{match[1]} #{match[2]} #{match[3]}}}"
-          /#{Regexp.escape(start_block_tag)}/
-        end
-      else
-        text.scan(Parser::VARIABLE_MATCHER).map { |match| "{{#{match[0]}}}" }
-      end
+      text.scan(regex).map(&extractor)
     end
 
     def render_documents(data, text = nil, render_options = {})
@@ -180,7 +178,10 @@ module LMDocstache
         next if style_html != previous_style_html
         next if current_text_node.nil? || previous_text_node.nil?
 
+        whitespace_attr = current_text_node['xml:space']
+        previous_text_node['xml:space'] = whitespace_attr if whitespace_attr
         previous_text_node.content = previous_text_node.text + current_text_node.text
+
         node.unlink
       end
     end

data/lib/lm_docstache/version.rb

@@ -1,3 +1,3 @@
 module LMDocstache
-  VERSION = "3.0.5"
+  VERSION = "3.0.10"
 end

data/spec/integration_spec.rb

@@ -62,7 +62,7 @@ describe 'integration test', integration: true do
     it 'fixes nested xml errors breaking tags' do
       expect { document.fix_errors }.to change {
         document.send(:problem_paragraphs).size
-      }.from(7).to(1)
+      }.from(10).to(1)
 
       expect(document.send(:problem_paragraphs).first.text).to eq(
         '{{TAG123-\\-//WITH WE👻IRD CHARS}}'
@@ -70,7 +70,18 @@ describe 'integration test', integration: true do
     end
 
     it 'has the expected amount of usable tags' do
-      expect(document.usable_tags.count).to eq(21)
+      expect { document.fix_errors }.to change {
+        document.usable_tags.count
+      }.from(29).to(37)
+    end
+
+    it 'keeps "xml:space" attribute when fixing errors' do
+      document.fix_errors
+
+      text_node = document.document.css('w|p').last
+        .css('w|t').find { |node| node.text.include?('that occurred on') }
+
+      expect(text_node['xml:space']).to eq('preserve')
     end
 
     it 'has the expected amount of usable roles tags' do
@@ -79,13 +90,14 @@ describe 'integration test', integration: true do
     end
 
     it 'has the expected amount of unique tag names' do
-      expect(document.usable_tag_names.count).to eq(14)
+      expect(document.usable_tag_names.count).to eq(20)
     end
 
     it 'renders file using data' do
       document.render_file(output_file, data)
     end
   end
+
   context "testing hide custom tags" do
     before do
       FileUtils.rm_rf(output_dir) if File.exist?(output_dir)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lm_docstache
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.10
 platform: ruby
 authors:
 - Roey Chasman
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: Merges Hash of Data into Word docx template files using mustache syntax