docx-builder 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 193655c8d43727fc462cdafe92e546f2c3e2ae974e57ed7d5b846499bf03e4bb
-  data.tar.gz: b8981a3a583f8bcfb81258d8cd233c4cc30a685682fd2a4d729cdb027e97c63e
+  metadata.gz: 208b51187c9e384db0e9d585552b8696e0a868709d2ee7348ae57e3d96566e1e
+  data.tar.gz: 54cdcbe11f62f7dcb3ab6fdcd4575f8d2ca09f876da8c0a8e7c8a57209313b42
 SHA512:
-  metadata.gz: b9eda257bc7525ba96125c994b7b52ea63ba48469d56d2deef80fd46405274b5ebd48cbe47431ab5c0bdac131aee31d18e3027b200eac0ddad8a1978a34cebce
-  data.tar.gz: 8920365c82374b20cc2f411a49964731d53edb0042783713103a666c72324d5cf58ff9b4bb42bcf5d107f53e1ca10ed48c69f1f3c887a779da0820a31233cf13
+  metadata.gz: 43f1e1c08dd0f604ba920ad88c139e4797e4b8a6ed7b9d2edf2f5d363c92b19bb9e1b889e32f3a6f4b4deb9c5920e8d197a2815320b167b6049ec8a0636506ae
+  data.tar.gz: 3b71f7b11e68f1c8e19616265401c4f03d392fbd503ab34aef98f8d237ff5a08545108593c4f53daf3e4d1e5e195905326bd9e005b91ec422eea87b2e014f24f

data/.gitignore

@@ -13,3 +13,6 @@
 
 # Generated gem
 docx-builder-*.gem
+
+# Ignore files created by Word
+~$*.docx

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docx-builder (0.2.0)
+    docx-builder (0.2.3)
 
 GEM
   remote: https://rubygems.org/

data/lib/docx/builder/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Docx
+    module Builder
+        class Configuration
+            attr_accessor :null_placeholder
+            attr_accessor :logger
+
+            def initialize
+                @null_placeholder = ''
+                @logger = Docx::Logger.new(STDOUT)
+            end
+        end
+    end
+end

data/lib/docx/builder/decoder.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Docx
-  module Builder
-    module Decoder
-      def self.to_xml(path)
-          Zip::File.open(path) do |file|
-            @zipfile = file
-          end
-          @zipfile
-      end
-    end
-  end
+	module Builder
+		module Decoder
+			def self.to_xml(path)
+				Zip::File.open(path) do |file|
+					@zipfile = file
+				end
+				@zipfile
+			end
+		end
+	end
 end

data/lib/docx/builder/encoder.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 module Docx
-  module Builder
-    module Encoder
-      def self.build_new_document_xml(original_document, new_document_sections)
-          output = Zip::OutputStream.write_buffer(StringIO.new) do |out|
-              original_document.each do |entry|
-                  entry_name = entry.name
-                  out.put_next_entry(entry_name)
-                  out.write(new_document_sections[entry_name] || entry.get_input_stream.read)
-              end
-          end
-          output.string
-      end
-    end
-  end
+	module Builder
+		module Encoder
+			def self.build_new_document_xml(original_document, new_document_sections)
+				output = Zip::OutputStream.write_buffer(StringIO.new) do |out|
+					original_document.each do |entry|
+						entry_name = entry.name
+						out.put_next_entry(entry_name)
+						out.write(new_document_sections[entry_name] || entry.get_input_stream.read)
+					end
+				end
+				output.string
+			end
+		end
+	end
 end

data/lib/docx/builder/template.rb

@@ -1,50 +1,54 @@
 module Docx
     module Builder
-        class Template
-            def initialize(path)
-              @document = Docx::Builder::Decoder.to_xml(path)
-              @sections = ["word/document.xml"]
-              @document.each do |file|
-                if file.name.include? "word/header"
-                  @sections.push(file.name)
-                end
-              end
-            end
-      
-            def render(data)
-              @sections.map do |section|
-                cleaned_document = clean(@document.read(section))
-                erb_template = build_erb_template(cleaned_document)
-                processed_document = render_erb_template(erb_template, data)
-                [section, processed_document] 
-              end.to_h
-            end
-      
-            def clean(document)
-              document.force_encoding(Encoding::UTF_8) if document.respond_to?(:force_encoding)
-              Docx::Builder::XmlProcessor.clean_variables(document)
-            end
-      
-            def build_erb_template(document)
-              ret = document.gsub(/\{\{%/, '<%=').gsub(/%\}\}/, '%>')
-              ret = ret.gsub(/\{\{/, '<%').gsub(/\}\}/, '%>')
-              ret
-            end
-      
-            def render_erb_template(document, data)
-              erb_template = ERB.new(document)
-              ret = erb_template.result_with_hash(data)
-              ret
-            end
-      
-            # creates xml template keys in input docx (template file)
-            def save(path, new_document)
-              File.open(path, 'wb') do |f|
-                new_document_xml_string = Docx::Builder::Encoder.build_new_document_xml(@document, new_document)
-                f.write(new_document_xml_string)
-              end
-              @document.close
-            end
-          end
+		class Template
+			def initialize(path)
+				@document = Docx::Builder::Decoder.to_xml(path)
+				@sections = ["word/document.xml"]
+				@document.each do |file|
+					if file.name.include? "word/header"
+						@sections.push(file.name)
+					end
+				end
+			end
+		
+			def render(data)
+				@sections.map do |section|
+					Docx::Builder.logger.debug("Cleaning template variables for section #{section}")
+					cleaned_document = clean(@document.read(section))
+					Docx::Builder.logger.debug("Replacing template tags ('{{%' -> '<%') for section #{section}")
+					erb_template = build_erb_template(cleaned_document)
+					Docx::Builder.logger.debug("Rendering template for section #{section} with data")
+					processed_document = render_erb_template(erb_template, data)
+					[section, processed_document]
+				end.to_h
+			end
+		
+			def clean(document)
+				document.force_encoding(Encoding::UTF_8) if document.respond_to?(:force_encoding)
+				Docx::Builder::XmlProcessor.clean_variables(document)
+			end
+		
+			def build_erb_template(document)
+				ret = document.gsub(/\{\{%/, '<%=').gsub(/%\}\}/, '%>')
+				ret = ret.gsub(/\{\{/, '<%').gsub(/\}\}/, '%>')
+				ret
+			end
+		
+			def render_erb_template(document, data)
+				erb_template = ERB.new(document)
+				ret = erb_template.result_with_hash(data)
+				ret
+			end
+		
+			# creates xml template keys in input docx (template file)
+			def save(path, new_document)
+				Docx::Builder.logger.info("Saving output file into path #{path.to_s}")
+				File.open(path, 'wb') do |f|
+					new_document_xml_string = Docx::Builder::Encoder.build_new_document_xml(@document, new_document)
+					f.write(new_document_xml_string)
+				end
+				@document.close
+			end
+		end
     end
-end
+end

data/lib/docx/builder/version.rb

@@ -2,6 +2,6 @@
 
 module Docx
   module Builder
-    VERSION = "0.2.0"
+    VERSION = "0.2.3"
   end
 end

data/lib/docx/builder/xml_processor.rb

@@ -1,19 +1,18 @@
 module Docx
     module Builder
         class XmlProcessor
-            BROKEN_VARIABLE_PATTERN = "<w:t>([^\#^<^>]*?)#([^\#^<^>]*?)<\/w:t>"
-        
             def self.clean_variables(document)
                 document.gsub(/\{\{.*?\}\}/m) do |match|
                     ret = match.include?('>') ? join_variable_tags(match) : match
                     ret = clean_spaces_inside_variables(ret)
+                    ret = insert_null_placeholder(ret)
                     ret
                 end
             end
         
             def self.join_variable_tags(match)
-                before = match.gsub(/\<(.*)/m, '')
-                inside = match.scan(/<w:t.*?>([^>]*?)<.w:t>/m).join(' ').gsub(/\s*\.\s*/, '.')
+                before = match.gsub(/<(.*)/m, '')
+                inside = match.scan(/<w:t.*?>([^>]*?)<.w:t>/m).join
                 after = match.gsub(/.*>([^>]+)$/m, "\\1")
                 [before, inside, after].join(' ')
             end
@@ -24,9 +23,16 @@ module Docx
                 cleaner_methods.each do |clean_method|
                     ret = Docx::Builder::Cleaners.send(clean_method, ret)
                 end
-                puts "Returning cleaned variable: #{ret}"
+                Docx::Builder.logger.debug("Returning cleaned variable: #{ret}")
                 ret
             end
+
+            def self.insert_null_placeholder(expression)
+                placeholder = Docx::Builder.configuration.null_placeholder
+                expression.gsub(/\{\{%\s(.+)\s%\}\}/) do |m|
+                    "{{% (#{$1} || '#{placeholder}') %}}"
+                end
+            end
         end
         
         # {{% devedor[:pessoa_fisica][:cedula_identidade] %}}, 

data/lib/docx/builder.rb

@@ -4,9 +4,29 @@ require 'rubygems'
 require 'zip'
 require 'nokogiri'
 
+require_relative "logger"
 require_relative "builder/version"
 require_relative "builder/decoder"
 require_relative "builder/encoder"
 require_relative 'builder/cleaners'
 require_relative "builder/xml_processor"
-require_relative "builder/template"
+require_relative "builder/template"
+require_relative "builder/configuration"
+
+module Docx
+    module Builder
+        class << self
+            def configuration
+                @configuration ||= Configuration.new
+            end
+
+            def logger
+                configuration.logger
+            end
+
+            def configure
+                yield(configuration)
+            end
+        end
+    end
+end

data/lib/docx/logger.rb

@@ -0,0 +1,19 @@
+require 'logger'
+
+module Docx
+    class Logger < ::Logger
+        def initialize(*args, **kwargs)
+            super
+            @formatter = SimpleFormatter.new
+            @level = ENV['LOG_LEVEL'].to_i if ENV.keys.include?('LOG_LEVEL')
+        end
+
+        # Simple formatter which only displays the message
+        class SimpleFormatter < ::Logger::Formatter
+            # This method is invoked when a log event occurs
+            def call(severity, timestamp, progname, msg)
+                "#{String === msg ? msg : msg.inspect}\n"
+            end
+        end
+    end
+end

data/publish.sh

@@ -1,4 +1 @@
-gem bump
-gem build
-gem push $(ls docx-builder-*.gem)
-rm  docx-builder-*.gem
+bundle exec rake release

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docx-builder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Tecnologia Cashme
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies: []
 description: Builds a new docx file using ERB template
 email:
@@ -32,11 +32,13 @@ files:
 - docx-builder.gemspec
 - lib/docx/builder.rb
 - lib/docx/builder/cleaners.rb
+- lib/docx/builder/configuration.rb
 - lib/docx/builder/decoder.rb
 - lib/docx/builder/encoder.rb
 - lib/docx/builder/template.rb
 - lib/docx/builder/version.rb
 - lib/docx/builder/xml_processor.rb
+- lib/docx/logger.rb
 - publish.sh
 - tmp/.gitkeep
 homepage: https://github.com/cash-me/docx-builder