docx-builder 0.1.11 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5847fb8238c628a1907025033216d203c41d4dcb6798a8d3d4d9538d05af4a2e
-  data.tar.gz: 7ce08edfa70098ce12c5c436d6fed7a73a7de59539f35ea6dd61734e3d452d33
+  metadata.gz: 4a834e7eb99b4459de40d6942008c8487626ff25ccf75d19a2c4d5af4978402b
+  data.tar.gz: 1fa0be4e4a3c0d9c7e15804d90b1dbcedc9ca3b42f059593daeef50f08ca5b47
 SHA512:
-  metadata.gz: e4f6190d0f1bb16a313740edbc5dca7feab7ec812b8748905a7329bd67dc3bc1be48166e62d95629e0a69654d058e57830767b8e7be395dc1a373e47612baf15
-  data.tar.gz: 27993bea930a31617d205684c66bca679da3e2b1d02e5be983a14facac29609a60b83858666283d0e00dcefb26d126612f146a71fdeb68766dd169c3d5de9acf
+  metadata.gz: b80c298d29268dc7b5aae2ddc90533be3668fc8fa34c2f0da64451c47a58a44e9eee63b269092cb4af1e86b7ecdcba0ee63d23498f7c24935fcfc524019c5abd
+  data.tar.gz: 8f85311bcfd8a02207a2f673d0b81be605b49ede108508b9a3da514ce3a725c0085f9dbbbefdcf567a8abb46ee614e974e5d5ac0eda7f4456315684c0c60edd9

data/.github/workflows/ci.yaml

@@ -0,0 +1,74 @@
+name: CI - Checks
+on:
+  push:
+    branches-ignore:
+      - master
+
+jobs:
+
+  # lint:
+  #   name: Linters verification
+  #   runs-on: ubuntu-18.04
+
+  #   steps:
+
+  #     - name: Checkout code
+  #       uses: actions/checkout@v2
+
+  #     - name: Checkout deployment repo
+  #       uses: actions/checkout@v2
+  #       with:
+  #         repository: cash-me/deployment
+  #         ssh-key: ${{ secrets.DEPLOYMENT_KEY }}
+  #         path: '.github/deployment'
+
+  #     - uses: ruby/setup-ruby@v1
+  #       with:
+  #         ruby-version: 2.7.2
+
+  #     - name: Ruby gem cache
+  #       uses: actions/cache@v1
+  #       with:
+  #         path: vendor/bundle
+  #         key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+  #         restore-keys: |
+  #           ${{ runner.os }}-gems-
+
+  #     - name: Linters
+  #       uses: ./.github/deployment/actions/linters/rails
+
+  # test:
+  #   name: Run tests
+  #   needs: lint
+  #   runs-on: ubuntu-18.04
+
+  #   services:
+  #     postgres:
+  #       image: postgres:11.6
+  #       ports: ["5432:5432"]
+  #       options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+  #   steps:
+  #     - uses: actions/checkout@v2
+
+  #     - name: Checkout deployment repo
+  #       uses: actions/checkout@v2
+  #       with:
+  #         repository: cash-me/deployment
+  #         ssh-key: ${{ secrets.DEPLOYMENT_KEY }}
+  #         path: '.github/deployment'
+
+  #     - uses: ruby/setup-ruby@v1
+  #       with:
+  #         ruby-version: 2.7.2
+
+  #     - name: Tests
+  #       uses: ./.github/deployment/actions/tests/rails
+  #       with:
+  #         cc_reporter_id: ${{ secrets.CC_TEST_REPORTER_ID }}
+
+  ci-workflow:
+    # needs: test
+    runs-on: ubuntu-18.04
+    steps:
+      - run: exit 0

data/.gitignore

@@ -5,8 +5,14 @@
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
+/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

@@ -7,10 +7,14 @@ gemspec
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
-gem "zip", "~> 2.0.2"
+gem 'rubyzip', require: 'zip'
 gem "rubocop", "~> 0.80"
 gem "nokogiri", "~> 1.11.1"
 
 group :test do
     gem "byebug"
-end
+end
+
+group :development do
+    gem "bump"
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    docx-builder (0.2.1)
+
+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)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    rubyzip (2.3.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bump
+  byebug
+  docx-builder!
+  nokogiri (~> 1.11.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+  rubyzip
+
+BUNDLED WITH
+   2.1.4

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/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.11"
+    VERSION = "0.2.1"
   end
 end

data/lib/docx/builder/xml_processor.rb

@@ -0,0 +1,32 @@
+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
+                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
+        end
+        
+        # {{% devedor[:pessoa_fisica][:cedula_identidade] %}}, 
+    end
+end

data/lib/docx/builder.rb

@@ -1,59 +1,12 @@
 # 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
-      SECTIONS = %w( word/header1.xml word/document.xml )
-      
-      def initialize(path)
-        @document = Docx::Decoder.to_xml(path)
-      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
-
-      # 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)
-        end
-        @document.close
-      end
-    end
-  end
-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"

metadata

@@ -1,28 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: docx-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.1
 platform: ruby
 authors:
-- Paulo Soares
+- Tecnologia Cashme
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-23 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: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -30,12 +31,14 @@ files:
 - bin/setup
 - docx-builder.gemspec
 - lib/docx/builder.rb
+- lib/docx/builder/cleaners.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
 licenses:
 - MIT
@@ -58,7 +61,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/.github/workflows/main.yml

@@ -1,18 +0,0 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7.2
-    - name: Run the default task
-      run: |
-        gem install bundler -v 2.2.2
-        bundle install
-        bundle exec rake

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,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'zip'
-
-module Docx
-  module Decoder
-    def self.to_xml(path)
-        Zip::File.open(path)
-    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] %}},