docx-builder 0.1.13 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 647fc0a676e9e89d5c524065eb3ef33c543eb0d3730e062651178a20369034a4
-  data.tar.gz: bef01a5005273274367163c7cdcd58142bc086c5c7f18506929fe7315297a430
+  metadata.gz: 1a12d4646ce0b78cc0977eb4c1fa6a6d4082911dc1546c567b299a58f9b84e56
+  data.tar.gz: 13197d06bd647197e7fb0857ce7f10c3d4f9c119c3e0a28503d2ad20c73a44fa
 SHA512:
-  metadata.gz: 44b5758d199bc5ec64514a81d8aecd420125c7f846feda1654a546b92768643641f4254fd05eb43085db7c8e593ae8e2361791ab52b5fc792c6f642aeabac840
-  data.tar.gz: 1db1450803e102a75f1c02edc3a3b278fcf4f3faf89ca1b49bdf95e97d04a920ddb2627a51b4c2baa0887ebb8961a5a632963d79c78c1c69eb21e5d802054be9
+  metadata.gz: 36580ca2af1ab880193203d304f8030125a53e6139e66c750d33f6f7846e33ccd0efe581d37eed5948708f8a933beef76d527922d3eadc018501028ca9521c51
+  data.tar.gz: cd3a2fd33771dcfc717f0e2ecf5340125ec80e9be792ed073425c2126c5684c2a66fc7ecbf269b795c5593fa08bab8f256af608861de0d62624b57ca60836bbf

data/.github/workflows/ci.yaml

@@ -22,10 +22,9 @@ jobs:
   #         ssh-key: ${{ secrets.DEPLOYMENT_KEY }}
   #         path: '.github/deployment'
 
-  #     - name: Setup Ruby
-  #       uses: ruby/setup-ruby@v1
+  #     - uses: ruby/setup-ruby@v1
   #       with:
-  #         ruby-version: '2.7.2'
+  #         ruby-version: 2.7.2
 
   #     - name: Ruby gem cache
   #       uses: actions/cache@v1
@@ -59,9 +58,9 @@ jobs:
   #         ssh-key: ${{ secrets.DEPLOYMENT_KEY }}
   #         path: '.github/deployment'
 
-  #     - uses: actions/setup-ruby@v1
+  #     - uses: ruby/setup-ruby@v1
   #       with:
-  #         ruby-version: '2.7.2'
+  #         ruby-version: 2.7.2
 
   #     - name: Tests
   #       uses: ./.github/deployment/actions/tests/rails

data/.gitignore

@@ -6,7 +6,13 @@
 /pkg/
 /spec/reports/
 /tmp/output.docx
+.byebug_history
 
 # rspec failure tracking
 .rspec_status
-docx-builder-0.1.0.gem
+
+# Generated gem
+docx-builder-*.gem
+
+# Ignore files created by Word
+~$*.docx

data/Gemfile

@@ -13,4 +13,8 @@ gem "nokogiri", "~> 1.11.1"
 
 group :test do
     gem "byebug"
-end
+end
+
+group :development do
+    gem "bump"
+end

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    docx-builder (0.2.0)
+    docx-builder (0.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    bump (0.10.0)
     byebug (11.1.3)
     diff-lcs (1.4.4)
     mini_portile2 (2.5.0)
@@ -53,6 +54,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bump
   byebug
   docx-builder!
   nokogiri (~> 1.11.1)

data/docx-builder.gemspec

@@ -5,8 +5,8 @@ require_relative "lib/docx/builder/version"
 Gem::Specification.new do |spec|
   spec.name          = "docx-builder"
   spec.version       = Docx::Builder::VERSION
-  spec.authors       = ["Paulo Soares"]
-  spec.email         = ["paulo.soares@cashme.com.br"]
+  spec.authors       = ["Tecnologia Cashme"]
+  spec.email         = ["tecnologia@cashme.com.br"]
 
   spec.summary       = "Builds a new docx file using ERB template"
   spec.description   = "Builds a new docx file using ERB template"

data/lib/docx/builder/cleaners.rb

@@ -0,0 +1,41 @@
+module Docx
+    module Builder
+        module Cleaners
+            def self.starting_tags_without_spaces_cleaner(str) 
+                str && str.gsub(/\{\s*\{\s*%/, '{{%')
+            end
+        
+            def self.ending_tags_without_spaces_cleaner(str) 
+                str && str.gsub(/%\s*\}\s*\}/, '%}}')
+            end
+        
+            def self.single_quote_cleaner(str)
+                str && str.gsub(/\‘/, '\'').gsub(/\’/, '\'')
+            end
+        
+            def self.var_without_duplicated_spaces_cleaner(str) 
+                str && str.gsub(/\s+/, ' ')
+            end
+        
+            def self.var_without_spaces_inside_brackets_cleaner(str) 
+                str && str.gsub(/\[(.*?)\]/) { |match| match.gsub(/\s/, '')}
+            end
+        
+            def self.no_spaces_around_undeline_cleaner(str) 
+                str && str.gsub(/\s*\_\s*/, "_")
+            end
+        
+            def self.join_dots_and_brackets_cleaner(str)
+                str && str.gsub(/\s*\.\s*/, '.').gsub(/\s*\[\s*/, '[').gsub(/\s*\]/, ']')
+            end
+        
+            def self.question_method_cleaner(str)
+                if str && str =~ /\A\{\{\s+if\s*(.*?)\s*\?\s+\}\}\Z/
+                    "{{ if #{$1}\? }}"
+                else
+                    str
+                end
+            end
+        end
+    end
+end

data/lib/docx/builder/configuration.rb

@@ -0,0 +1,11 @@
+module Docx
+    module Builder
+        class Configuration
+            attr_accessor :null_placeholder
+
+            def initialize
+                @null_placeholder = ''
+            end
+        end
+    end
+end

data/lib/docx/builder/decoder.rb

@@ -0,0 +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
+end

data/lib/docx/builder/encoder.rb

@@ -0,0 +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
+end

data/lib/docx/builder/template.rb

@@ -0,0 +1,50 @@
+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
+    end
+end

data/lib/docx/builder/version.rb

@@ -2,6 +2,6 @@
 
 module Docx
   module Builder
-    VERSION = "0.1.13"
+    VERSION = "0.2.2"
   end
 end

data/lib/docx/builder/xml_processor.rb

@@ -0,0 +1,40 @@
+module Docx
+    module Builder
+        class XmlProcessor
+            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
+                after = match.gsub(/.*>([^>]+)$/m, "\\1")
+                [before, inside, after].join(' ')
+            end
+        
+            def self.clean_spaces_inside_variables(match)
+                ret = match.dup
+                cleaner_methods = Docx::Builder::Cleaners.methods.grep /_cleaner/
+                cleaner_methods.each do |clean_method|
+                    ret = Docx::Builder::Cleaners.send(clean_method, ret)
+                end
+                puts "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] %}}, 
+    end
+end

data/lib/docx/builder.rb

@@ -1,64 +1,27 @@
 # frozen_string_literal: true
 
-require_relative "builder/version"
-require_relative "decoder"
-require_relative "encoder"
-require_relative "xml_processor"
-
 require 'rubygems'
 require 'zip'
 require 'nokogiri'
 
-module Docx
-  module Builder
-    class Error < StandardError; end
-    
-    class Template
-
-      def initialize(path)
-        @document = Docx::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)
-        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
+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/configuration"
 
-      # 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::Encoder.build_new_document_xml(@document, new_document)
-          f.write(new_document_xml_string)
+module Docx
+    module Builder
+        class << self
+            def configuration
+                @configuration ||= Configuration.new
+            end
+
+            def configure
+                yield(configuration)
+            end
         end
-        @document.close
-      end
     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,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: docx-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.2.2
 platform: ruby
 authors:
-- Paulo Soares
+- Tecnologia Cashme
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2022-04-06 00:00:00.000000000 Z
 dependencies: []
 description: Builds a new docx file using ERB template
 email:
-- paulo.soares@cashme.com.br
+- tecnologia@cashme.com.br
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -31,11 +31,13 @@ files:
 - bin/setup
 - 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/cleaners.rb
-- lib/docx/decoder.rb
-- lib/docx/encoder.rb
-- lib/docx/xml_processor.rb
+- lib/docx/builder/xml_processor.rb
 - publish.sh
 - tmp/.gitkeep
 homepage: https://github.com/cash-me/docx-builder
@@ -60,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.9
 signing_key: 
 specification_version: 4
 summary: Builds a new docx file using ERB template

data/lib/docx/cleaners.rb

@@ -1,37 +0,0 @@
-module Cleaners
-    def self.starting_tags_without_spaces_cleaner(str) 
-        str && str.gsub(/\{\s*\{\s*%/, '{{%')
-    end
-
-    def self.ending_tags_without_spaces_cleaner(str) 
-        str && str.gsub(/%\s*\}\s*\}/, '%}}')
-    end
-
-    def self.single_quote_cleaner(str)
-        str && str.gsub(/\‘/, '\'').gsub(/\’/, '\'')
-    end
-
-    def self.var_without_duplicated_spaces_cleaner(str) 
-        str && str.gsub(/\s+/, ' ')
-    end
-
-    def self.var_without_spaces_inside_brackets_cleaner(str) 
-        str && str.gsub(/\[(.*?)\]/) { |match| match.gsub(/\s/, '')}
-    end
-
-    def self.no_spaces_around_undeline_cleaner(str) 
-        str && str.gsub(/\s*\_\s*/, "_")
-    end
-
-    def self.join_dots_and_brackets_cleaner(str)
-        str && str.gsub(/\s*\.\s*/, '.').gsub(/\s*\[\s*/, '[').gsub(/\s*\]/, ']')
-    end
-
-    def self.question_method_cleaner(str)
-        if str && str =~ /\A\{\{\s+if\s*(.*?)\s*\?\s+\}\}\Z/
-            "{{ if #{$1}\? }}"
-        else
-            str
-        end
-    end
-end

data/lib/docx/decoder.rb

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

data/lib/docx/encoder.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'zip'
-
-module Docx
-  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

data/lib/docx/xml_processor.rb

@@ -1,32 +0,0 @@
-require_relative 'cleaners'
-
-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
-        end
-    end
-
-    def self.join_variable_tags(match)
-        before = match.gsub(/\<(.*)/m, '')
-        inside = match.scan(/<w:t.*?>([^>]*?)<.w:t>/m).join(' ').gsub(/\s*\.\s*/, '.')
-        after = match.gsub(/.*>([^>]+)$/m, "\\1")
-        [before, inside, after].join(' ')
-    end
-
-    def self.clean_spaces_inside_variables(match)
-        ret = match.dup
-        cleaner_methods = Cleaners.methods.grep /_cleaner/
-        cleaner_methods.each do |clean_method|
-            ret = Cleaners.send(clean_method, ret)
-        end
-        puts "Returning cleaned variable: #{ret}"
-        ret
-    end
-end
-
-# {{% devedor[:pessoa_fisica][:cedula_identidade] %}},