docx-builder 0.2.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 208b51187c9e384db0e9d585552b8696e0a868709d2ee7348ae57e3d96566e1e
-  data.tar.gz: 54cdcbe11f62f7dcb3ab6fdcd4575f8d2ca09f876da8c0a8e7c8a57209313b42
+  metadata.gz: 04a3f8e6aceab4a926778161073b38cbed31c533e52ac924e83bf70fddc2a61c
+  data.tar.gz: 7746ba4203d23e18182a803082927bb50ec14d9dfed43b52c5bee557c86ba94b
 SHA512:
-  metadata.gz: 43f1e1c08dd0f604ba920ad88c139e4797e4b8a6ed7b9d2edf2f5d363c92b19bb9e1b889e32f3a6f4b4deb9c5920e8d197a2815320b167b6049ec8a0636506ae
-  data.tar.gz: 3b71f7b11e68f1c8e19616265401c4f03d392fbd503ab34aef98f8d237ff5a08545108593c4f53daf3e4d1e5e195905326bd9e005b91ec422eea87b2e014f24f
+  metadata.gz: 03e659b8e2c8f9ce9d8468f7752d2aa29bc0e55c63687ee97fa16fd1e5e029107773bf6ccbc4d5d4837de69b92a7e34b886f5fbfa8efb3587811e293cb6527f3
+  data.tar.gz: 144b48158964a4410792d43bf69386de53f291b329f34b66bca1fed8e909182dfd4284f162986601e6771ef0ba979d13c35b262a77fb99ba2cef863f39f7c718

data/.github/workflows/cd.yaml

@@ -0,0 +1,27 @@
+name: CD - Publish
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+
+  publish:
+    name: Publish gem
+    runs-on: ubuntu-18.04
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+
+    - name: Release gem
+      uses: discourse/publish-rubygems-action@v2
+      env:
+        RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        GIT_EMAIL: automated_release@cashme.com.br
+        GIT_NAME: Automated Release

data/.github/workflows/ci.yaml

@@ -6,69 +6,46 @@ on:
 
 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
+  lint:
+    name: Linters verification
+    runs-on: ubuntu-18.04
 
-  #     - name: Ruby gem cache
-  #       uses: actions/cache@v1
-  #       with:
-  #         path: vendor/bundle
-  #         key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-  #         restore-keys: |
-  #           ${{ runner.os }}-gems-
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
 
-  #     - name: Linters
-  #       uses: ./.github/deployment/actions/linters/rails
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+          bundler-cache: true # Run "bundle install", and cache the result automatically.
 
-  # test:
-  #   name: Run tests
-  #   needs: lint
-  #   runs-on: ubuntu-18.04
+      - name: Run security checks
+        run: bundle exec bundler-audit --update
 
-  #   services:
-  #     postgres:
-  #       image: postgres:11.6
-  #       ports: ["5432:5432"]
-  #       options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      - name: Run rubocop
+        run: bundle exec rubocop
 
-  #   steps:
-  #     - uses: actions/checkout@v2
+  test:
+    name: Run tests
+    needs: lint
+    runs-on: ubuntu-18.04
 
-  #     - name: Checkout deployment repo
-  #       uses: actions/checkout@v2
-  #       with:
-  #         repository: cash-me/deployment
-  #         ssh-key: ${{ secrets.DEPLOYMENT_KEY }}
-  #         path: '.github/deployment'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
 
-  #     - uses: ruby/setup-ruby@v1
-  #       with:
-  #         ruby-version: 2.7.2
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+          bundler-cache: true
 
-  #     - name: Tests
-  #       uses: ./.github/deployment/actions/tests/rails
-  #       with:
-  #         cc_reporter_id: ${{ secrets.CC_TEST_REPORTER_ID }}
+      - name: Run tests
+        run: bundle exec rake
 
   ci-workflow:
-    # needs: test
+    needs: test
     runs-on: ubuntu-18.04
     steps:
-      - run: exit 0
+      - run: exit 0

data/.gitignore

@@ -15,4 +15,4 @@
 docx-builder-*.gem
 
 # Ignore files created by Word
-~$*.docx
+~$*.docx

data/.rubocop.yml

@@ -1,10 +1,18 @@
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 160
+
+Metrics/BlockLength:
+  CountAsOne: ['array', 'hash']
+  CountComments: false
+  Max: 50
+
 Style/StringLiterals:
   Enabled: true
-  EnforcedStyle: double_quotes
+  EnforcedStyle: single_quotes
 
 Style/StringLiteralsInInterpolation:
   Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
+  EnforcedStyle: single_quotes

data/Gemfile

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in docx-builder.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
+gem 'nokogiri', '~> 1.13.2'
+gem 'rake', '~> 13.0'
 gem 'rubyzip', require: 'zip'
-gem "rubocop", "~> 0.80"
-gem "nokogiri", "~> 1.11.1"
 
 group :test do
-    gem "byebug"
+  gem 'bundler-audit'
+  gem 'byebug'
+
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 0.80'
 end
 
 group :development do
-    gem "bump"
+  gem 'bump'
 end

data/Gemfile.lock

@@ -1,40 +1,43 @@
 PATH
   remote: .
   specs:
-    docx-builder (0.2.3)
+    docx-builder (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     bump (0.10.0)
+    bundler-audit (0.9.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
     byebug (11.1.3)
-    diff-lcs (1.4.4)
-    mini_portile2 (2.5.0)
-    nokogiri (1.11.3)
-      mini_portile2 (~> 2.5.0)
+    diff-lcs (1.5.0)
+    mini_portile2 (2.8.0)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    racc (1.5.2)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
     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)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rubocop (0.93.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -44,20 +47,22 @@ GEM
       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)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    rubyzip (2.3.0)
-    unicode-display_width (1.7.0)
+    rubyzip (2.3.2)
+    thor (1.2.1)
+    unicode-display_width (1.8.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bump
+  bundler-audit
   byebug
   docx-builder!
-  nokogiri (~> 1.11.1)
+  nokogiri (~> 1.13.2)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.80)

data/README.md

@@ -1,8 +1,36 @@
 # Docx::Builder
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/docx/builder`. To experiment with that code, run `bin/console` for an interactive prompt.
+Gem used to create docx files based on a template.
+Our idea is quite similar to an erb file (in fact, we use an erb file behind :P)
+The only difference is:
+* When we want to write conditions and loops, we write the code between "{{" and "}}"
+* When we want to print a variable, we write it between "{{%" and "%}}"
 
-TODO: Delete this and the text above, and describe your gem
+For example, in our template file example.docx we could have:
+
+```
+{{ items.each do |item| }}
+Insert here some text: {{% item.property %}}
+{{ end }}
+```
+
+## Helpers
+
+### Table
+
+In order to render a table on docx template, we wrote:
+
+```
+{{t config t}}
+```
+
+where "config" is a hash that contains two properties:
+
+* columns: an array of hashes. Each element represents a column and may have the following information:
+    * name (required): attribute name;
+    * width (required): specifies the value of the preferred width of the column (according to the officeopenxml documentation, it's in twentieths of a point or 1/1440 of an inch)
+    * description (optional): attribute description used on table's header; if not specified, its name will be used as a description
+* rows: an array of hashes. Each element represents a row and all of its properties must appear in the columns' array. 
 
 ## Installation
 
@@ -22,18 +50,45 @@ Or install it yourself as:
 
 ## Usage
 
+```ruby
+    builder = Docx::Builder::Template.new('/path/to/input.docx')
+    new_xml = builder.render(variables_hash)
+    builder.save('/path/to/output.docx', new_xml)
+    # or memory_stream = builder.save_as_buffer(new_xml)
 ```
-    template_file = File.open('spec/files/example.docx', 'r')
-    builder = Docx::Builder::Template.new(template_file)
-    new_xml = builder.render({ numero_contrato: 101 })
-    builder.save('tmp/output.docx', new_xml)
-```
-
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+An exemple of table configuration should be:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+    users_table = {
+        columns: [
+            {
+                name: :name,
+                description: 'Name',
+                width: 1150
+            },
+            {
+                name: :email,
+                description: 'Mail address',
+                width: 1150
+            }
+        ],
+        rows: [
+            {
+                name: 'João',
+                email: 'joao@example.com' 
+            },
+            {
+                name: 'José',
+                email: 'jose@example.com' 
+            },
+            {
+                name: 'Felipe',
+                email: 'felipe@example.com' 
+            }
+        ]
+    }
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+task default: 'spec'

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "docx/builder"
+require 'bundler/setup'
+require 'docx/builder'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require "docx/builder"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/docx-builder.gemspec

@@ -1,33 +1,33 @@
 # frozen_string_literal: true
 
-require_relative "lib/docx/builder/version"
+require_relative 'lib/docx/builder/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "docx-builder"
+  spec.name          = 'docx-builder'
   spec.version       = Docx::Builder::VERSION
-  spec.authors       = ["Tecnologia Cashme"]
-  spec.email         = ["tecnologia@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"
-  spec.homepage      = "https://github.com/cash-me/docx-builder"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Builds a new docx file using ERB template'
+  spec.description   = 'Builds a new docx file using ERB template'
+  spec.homepage      = 'https://github.com/cash-me/docx-builder'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   # spec.metadata["allowed_push_host"] = "Set to 'http://mygemserver.com'"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/cash-me/docx-builder"
-  spec.metadata["changelog_uri"] = "https://github.com/cash-me/docx-builder/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/cash-me/docx-builder'
+  spec.metadata['changelog_uri'] = 'https://github.com/cash-me/docx-builder/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"

data/lib/docx/builder/cleaners.rb

@@ -1,41 +1,44 @@
+# frozen_string_literal: true
+
 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
+  module Builder
+    # Methods used for cleaning variables inside template
+    module Cleaners
+      def self.starting_tags_without_spaces_cleaner(str)
+        str&.gsub(/\{\s*\{\s*%/, '{{%')
+      end
+
+      def self.ending_tags_without_spaces_cleaner(str)
+        str&.gsub(/%\s*\}\s*\}/, '%}}')
+      end
+
+      def self.single_quote_cleaner(str)
+        str&.gsub(/‘/, '\'')&.gsub(/’/, '\'')
+      end
+
+      def self.var_without_duplicated_spaces_cleaner(str)
+        str&.gsub(/\s+/, ' ')
+      end
+
+      def self.var_without_spaces_inside_brackets_cleaner(str)
+        str&.gsub(/\[(.*?)\]/) { |match| match.gsub(/\s/, '') }
+      end
+
+      def self.no_spaces_around_undeline_cleaner(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 #{Regexp.last_match(1)}\? }}"
+        else
+          str
         end
+      end
     end
+  end
 end

data/lib/docx/builder/configuration.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
 module Docx
-    module Builder
-        class Configuration
-            attr_accessor :null_placeholder
-            attr_accessor :logger
+  module Builder
+    # Configuration for docx-builder gem
+    #
+    # There are two available settings:
+    # * null_placeholder: string placeholder to be put when the variable is null
+    # * logger: the logger object itself
+    class Configuration
+      attr_accessor :null_placeholder, :logger
 
-            def initialize
-                @null_placeholder = ''
-                @logger = Docx::Logger.new(STDOUT)
-            end
-        end
+      def initialize
+        @null_placeholder = ''
+        @logger = Docx::Logger.new($stdout)
+      end
     end
-end
+  end
+end

data/lib/docx/builder/decoder.rb

@@ -1,14 +1,15 @@
 # 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
+    # Unzips a docx file into a series of XML files
+    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
+    # Rebuild the docx file using the new xml strings for header and document
+    module Encoder
+      def self.build_docx_buffer(original_document, new_document_sections)
+        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
+      end
+    end
+  end
 end

data/lib/docx/builder/template.rb

@@ -1,54 +1,79 @@
+# frozen_string_literal: true
+
 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|
-					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
+  module Builder
+    # Represents a docx erb template
+    class Template
+      attr_reader :document, :sections
+
+      def initialize(path)
+        @document = Docx::Builder::Decoder.to_xml(path)
+        @sections = ['word/document.xml']
+        @document.each do |file|
+          @sections.push(file.name) if file.name.include? 'word/header'
+        end
+      end
+
+      # Renders the hash data in the template xml
+      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
+
+      # Cleans the xml nodes in the middle of the variables
+      def clean(document)
+        document.force_encoding(Encoding::UTF_8) if document.respond_to?(:force_encoding)
+        Docx::Builder::XmlProcessor.clean_variables(document)
+      end
+
+      # Replaces the docx-builder's tags for those ones currently used in erb files
+      def build_erb_template(document)
+        ret = document.gsub(/\{\{%/, '<%=').gsub(/%\}\}/, '%>')
+        ret = ret.gsub(/\{\{t\s(.*)\st\}\}/) { |_| build_dynamic_table(Regexp.last_match(1)) }
+        ret.gsub(/\{\{/, '<%').gsub(/\}\}/, '%>')
+      end
+
+      def render_erb_template(document, data)
+        erb_template = ERB.new(document)
+        erb_template.result_with_hash(data)
+      end
+
+      # Saves the rendered template in a file
+      def save(path, new_document)
+        Docx::Builder.logger.info("Saving output file into path #{path}")
+        File.open(path, 'wb') do |f|
+          buffer = Docx::Builder::Encoder.build_docx_buffer(@document, new_document)
+          f.write(buffer.string)
+        end
+        @document.close
+      end
+
+      # Saves the rendered template in a memory stream (StringIO)
+      def save_as_buffer(new_document)
+        Docx::Builder.logger.info('Saving output file as buffer')
+        buffer = Docx::Builder::Encoder.build_docx_buffer(@document, new_document)
+        @document.close
+        buffer
+      end
+
+      private
+
+      def build_dynamic_table(variable)
+        template = read_xml_template(:table)
+        template.gsub('data', variable)
+      end
+
+      def read_xml_template(filename)
+        path = File.join(File.dirname(__FILE__), "../../../templates/#{filename}.xml.erb")
+        File.readlines(path).map(&:strip).join('')
+      end
     end
+  end
 end

data/lib/docx/builder/version.rb

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

data/lib/docx/builder/xml_processor.rb

@@ -1,40 +1,42 @@
+# frozen_string_literal: true
+
 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
-                Docx::Builder.logger.debug("Returning cleaned variable: #{ret}")
-                ret
-            end
+  module Builder
+    # Class responsible for dealing with xml nodes in-between the variables
+    class XmlProcessor
+      def self.clean_variables(document)
+        document.gsub(/\{\{.*?\}\}/m) do |match|
+          ret = match.include?('>') ? join_variable_tags(match) : match
+          Docx::Builder.logger.debug("Before cleaning: #{ret}")
+          ret = clean_spaces_inside_variables(ret)
+          ret = insert_null_placeholder(ret)
+          Docx::Builder.logger.debug("After cleaning: #{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
+        ret
+      end
 
-            def self.insert_null_placeholder(expression)
-                placeholder = Docx::Builder.configuration.null_placeholder
-                expression.gsub(/\{\{%\s(.+)\s%\}\}/) do |m|
-                    "{{% (#{$1} || '#{placeholder}') %}}"
-                end
-            end
+      def self.insert_null_placeholder(expression)
+        placeholder = Docx::Builder.configuration.null_placeholder
+        expression.gsub(/\{\{%\s(.+)\s%\}\}/) do |_m|
+          "{{% (#{Regexp.last_match(1)} || '#{placeholder}') %}}"
         end
-        
-        # {{% devedor[:pessoa_fisica][:cedula_identidade] %}}, 
+      end
     end
+  end
 end

data/lib/docx/builder.rb

@@ -4,29 +4,40 @@ require 'rubygems'
 require 'zip'
 require 'nokogiri'
 
-require_relative "logger"
-require_relative "builder/version"
-require_relative "builder/decoder"
-require_relative "builder/encoder"
+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/configuration"
+require_relative 'builder/xml_processor'
+require_relative 'builder/template'
+require_relative 'builder/configuration'
 
 module Docx
-    module Builder
-        class << self
-            def configuration
-                @configuration ||= Configuration.new
-            end
+  # Main module of the gem
+  #
+  # @example configuring string placeholder
+  #   Docx::Builder.configure do |config|
+  #     config.null_placeholder = 'XXXX'
+  #   end
+  #
+  # @example configuring log level
+  #   Docx::Builder.configure do |config|
+  #     config.logger.level = 1 #info
+  #   end
+  module Builder
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
 
-            def logger
-                configuration.logger
-            end
+      def logger
+        configuration.logger
+      end
 
-            def configure
-                yield(configuration)
-            end
-        end
+      def configure
+        yield(configuration)
+      end
     end
-end
+  end
+end

data/lib/docx/logger.rb

@@ -1,19 +1,25 @@
+# frozen_string_literal: true
+
 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 logger for the gem
+  #
+  # Available levels (from 0 to 5):
+  # DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
+  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
+    # 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)
+        "#{msg.is_a?(String) ? msg : msg.inspect}\n"
+      end
     end
-end
+  end
+end

data/templates/table.xml.erb

@@ -0,0 +1,102 @@
+<w:tbl>
+  <w:tblPr>
+    <w:tblW w:w="10006" w:type="dxa"/>
+    <w:tblInd w:w="-626" w:type="dxa"/>
+    <w:tblCellMar>
+      <w:left w:w="70" w:type="dxa"/>
+      <w:right w:w="70" w:type="dxa"/>
+    </w:tblCellMar>
+    <w:tblLook w:val="04A0" w:firstRow="1" w:lastRow="0" w:firstColumn="1" w:lastColumn="0" w:noHBand="0" w:noVBand="1"/>
+  </w:tblPr>
+  <w:tblGrid>
+    <% data[:columns].each do |column| %>
+      <w:gridCol w:w="<%= column[:width] %>"/>
+    <% end %>
+  </w:tblGrid>
+  <w:tr w:rsidR="00080F99" w:rsidRPr="00E71341" w:rsidTr="00E653AF">
+    <w:trPr>
+      <w:trHeight w:val="315"/>
+    </w:trPr>
+    <% data[:columns].each do |column| %>
+      <w:tc>
+        <w:tcPr>
+          <w:tcW w:w="<%= column[:width] %>" w:type="dxa"/>
+          <w:tcBorders>
+            <w:top w:val="single" w:sz="4" w:space="0" w:color="000000"/>
+            <w:left w:val="single" w:sz="4" w:space="0" w:color="000000"/>
+            <w:bottom w:val="single" w:sz="8" w:space="0" w:color="000000"/>
+            <w:right w:val="single" w:sz="4" w:space="0" w:color="000000"/>
+          </w:tcBorders>
+          <w:shd w:val="clear" w:color="000000" w:fill="FFFFFF"/>
+          <w:noWrap/>
+          <w:vAlign w:val="center"/>
+          <w:hideMark/>
+        </w:tcPr>
+        <w:p w:rsidR="00080F99" w:rsidRPr="00E71341" w:rsidRDefault="00080F99" w:rsidP="00E653AF">
+          <w:pPr>
+            <w:jc w:val="center"/>
+            <w:rPr>
+              <w:rFonts w:ascii="Arial" w:hAnsi="Arial" w:cs="Arial"/>
+              <w:b/>
+              <w:bCs/>
+              <w:color w:val="000000"/>
+              <w:lang w:val="pt-BR" w:eastAsia="pt-BR"/>
+            </w:rPr>
+          </w:pPr>
+          <w:r w:rsidRPr="00E71341">
+            <w:rPr>
+              <w:rFonts w:ascii="Arial" w:hAnsi="Arial" w:cs="Arial"/>
+              <w:b/>
+              <w:bCs/>
+              <w:color w:val="000000"/>
+              <w:lang w:val="pt-BR" w:eastAsia="pt-BR"/>
+            </w:rPr>
+            <w:t><%= column[:description] %></w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+    <% end %>
+  </w:tr>
+  <% data[:rows].each do |row| %>
+    <w:tr w:rsidR="00080F99" w:rsidRPr="00E71341" w:rsidTr="00E653AF">
+      <w:trPr>
+        <w:trHeight w:val="315"/>
+      </w:trPr>
+      <% data[:columns].each do |column| %>
+        <w:tc>
+          <w:tcPr>
+            <w:tcW w:w="<%= column[:width] %>" w:type="dxa"/>
+            <w:tcBorders>
+              <w:top w:val="single" w:sz="4" w:space="0" w:color="000000"/>
+              <w:left w:val="single" w:sz="4" w:space="0" w:color="000000"/>
+              <w:bottom w:val="single" w:sz="4" w:space="0" w:color="000000"/>
+              <w:right w:val="single" w:sz="4" w:space="0" w:color="000000"/>
+            </w:tcBorders>
+            <w:shd w:val="clear" w:color="000000" w:fill="FFFFFF"/>
+            <w:noWrap/>
+            <w:vAlign w:val="center"/>
+            <w:hideMark/>
+          </w:tcPr>
+          <w:p w:rsidR="00080F99" w:rsidRPr="00E71341" w:rsidRDefault="005549E3" w:rsidP="00E653AF">
+            <w:pPr>
+              <w:jc w:val="center"/>
+              <w:rPr>
+                <w:rFonts w:ascii="Arial" w:hAnsi="Arial" w:cs="Arial"/>
+                <w:color w:val="000000"/>
+                <w:lang w:val="pt-BR" w:eastAsia="pt-BR"/>
+              </w:rPr>
+            </w:pPr>
+            <w:r>
+              <w:rPr>
+                <w:rFonts w:ascii="Arial" w:hAnsi="Arial" w:cs="Arial"/>
+                <w:color w:val="000000"/>
+                <w:lang w:val="pt-BR" w:eastAsia="pt-BR"/>
+              </w:rPr>
+              <w:t><%= row[column[:name]] %></w:t>
+            </w:r>
+          </w:p>
+        </w:tc>
+      <% end %>
+    </w:tr>
+  <% end %>
+</w:tbl>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docx-builder
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Tecnologia Cashme
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies: []
 description: Builds a new docx file using ERB template
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/cd.yaml"
 - ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
@@ -39,7 +40,7 @@ files:
 - lib/docx/builder/version.rb
 - lib/docx/builder/xml_processor.rb
 - lib/docx/logger.rb
-- publish.sh
+- templates/table.xml.erb
 - tmp/.gitkeep
 homepage: https://github.com/cash-me/docx-builder
 licenses:
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Builds a new docx file using ERB template

data/publish.sh

@@ -1 +0,0 @@
-bundle exec rake release