openxml_docx_templater 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfe1d4c33886dbb55766f0f298cbb0ee3343c719
-  data.tar.gz: 1e07055b775a6be7ad235a23e8456213f862edd9
+  metadata.gz: 6acf4751ef96a4c85d4e5a17d23fe65263ea368a
+  data.tar.gz: 664cff7779ba79761ff6e3e9c2c1de51cfd5057c
 SHA512:
-  metadata.gz: a15bdf27ab3324eb543dc3e2cff30879a2a4021f0bc86c3a62c60ef9c5ee38457e55cf2781f344a0c3a1df63fe56e50f3dbc3b9b51383aa8497fd9cdc889025e
-  data.tar.gz: b89f52d940165e8597958fd81d332d42bcf013482d2fc7167ebc24d598948b7e13c39e2154f9c545d31b1e2115d131f3a4146d7f5c24e005d6465838f15bd03e
+  metadata.gz: e639d4980436809ba24516da4a442e0b090318643b22ca12c3da4f60c886f4fd3b3d6e91941d586f265dc39e1813954337c8da2fcff7bf471fb8a1ebaa0269d8
+  data.tar.gz: 22fa05283f6009d2817a32629097f60c43f1d1c19cd916ab7ce4c60066650b1650965d5aba2ea8f42f6891d5311847da33df4a869bbf65f7a999645ea98aae58

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+AsciiComments:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/PredicateName:
+  NameWhitelist:
+    - is_a?
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Layout/AlignParameters:
+  Enabled: false
+
+LineLength:
+  Max: 120
+
+Lint/UnifiedInteger:
+  Description: 'Use Integer instead of Fixnum or Bignum'
+  Enabled: false

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/circle.yml

@@ -0,0 +1,7 @@
+machine:
+  ruby:
+    version: 2.4.1
+
+test:
+  override:
+    - bundle exec rspec

data/examples/example.rb

@@ -1,4 +1,4 @@
-$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'openxml_docx_templater'
 

data/lib/openxml_docx_templater.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "openxml_docx_templater/version"
 require "openxml_docx_templater/debug"
 require "openxml_docx_templater/node_type"

data/lib/openxml_docx_templater/debug.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OpenxmlDocxTemplater
   module Debug
     def debug?

data/lib/openxml_docx_templater/docx_eruby.rb

@@ -1,45 +1,46 @@
+# frozen_string_literal: true
+
 module OpenxmlDocxTemplater
   class DocxEruby
     include Debug
 
     EMBEDDED_PATTERN = /\{%([=%]+)?(.*?)-?%\}/m
 
-    def initialize template
+    def initialize(template)
       @src = convert template
-      if debug?
-        File.open(debug_file_path, 'w') do |f|
-          f << @src
-        end
+      return unless debug?
+      File.open(debug_file_path, 'w') do |f|
+        f << @src
       end
     end
 
-    def evaluate context
+    def evaluate(context)
       eval(@src, context)
     end
 
     private
 
-    def convert template
+    def convert(template)
       src = "_buf = '';"
       buffer = []
 
-      template.each_node do |node, type|
+      template.each_node do |node, _type|
         buffer << process_instruction(node)
         buffer.flatten!
       end
 
-      buffer.each { |line| src << line.to_buf }
-      src << "\n_buf.to_s\n"
+      buffer.each { |line| src += line.to_buf }
+      src += "\n_buf.to_s\n"
     end
 
-    def process_instruction text
+    def process_instruction(text)
       pos = 0
       src = []
 
       text.scan(EMBEDDED_PATTERN) do |indicator, code|
         m = Regexp.last_match
         middle = text[pos...m.begin(0)]
-        pos  = m.end(0)
+        pos = m.end(0)
         src << Line.text(middle) unless middle.empty?
 
         if !indicator            # <% %>
@@ -51,9 +52,9 @@ module OpenxmlDocxTemplater
         end
       end
 
-      rest = pos == 0 ? text : text[pos..-1]
+      rest = pos.zero? ? text : text[pos..-1]
 
-      src << Line.text(rest) unless rest.nil? or rest.empty?
+      src << Line.text(rest) unless rest.nil? || rest.empty?
       src
     end
   end

data/lib/openxml_docx_templater/escape_xml.rb

@@ -1,26 +1,25 @@
-class String
+# frozen_string_literal: true
 
+class String
   CODE_LINE_PATTERN = /{(.*?)%(.+?)%(.*?)}/
   TAG_PATTERN = /<(.+?)>[\n]?/m
 
   def escape_xml
-    mgsub!([[/&/, '&amp;'], [/</, '&lt;'], [/>/, '&gt;']])
+    mgsub(/&/ => '&amp;', /</ => '&lt;', />/ => '&gt;')
   end
 
   def convert_newlines
-    gsub!("\n", '<w:br/>')
-    self
+    gsub("\n", '<w:br/>')
   end
 
   def refact
-    gsub(CODE_LINE_PATTERN) { |result| result.gsub(TAG_PATTERN, "") }
+    gsub(CODE_LINE_PATTERN) { |result| result.gsub(TAG_PATTERN, '') }
   end
 
-  def mgsub!(key_value_pairs=[].freeze)
-    regexp_fragments = key_value_pairs.collect { |k, v| k }
-    gsub!(Regexp.union(*regexp_fragments)) do |match|
-      key_value_pairs.detect { |k, v| k =~ match }[1]
+  def mgsub(key_value_pairs = {})
+    regexp_fragments = key_value_pairs.keys
+    gsub(Regexp.union(*regexp_fragments)) do |match|
+      key_value_pairs.detect { |k, _v| k =~ match }[1]
     end
-    self
   end
 end

data/lib/openxml_docx_templater/generator.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module OpenxmlDocxTemplater
   module Generator
-    def render_msword template_path, output_path = output_name(template_path)
+    def render_msword(template_path, output_path = output_name(template_path))
       template = Template.new template_path, output_path
       template.process binding
     end
 
     private
 
-    def output_name input
+    def output_name(input)
       if input =~ /(.+)\.docx\Z/
-        "#{$1}_output.docx"
+        "#{Regexp.last_match(1)}_output.docx"
       else
         "#{input}_output.docx"
       end

data/lib/openxml_docx_templater/line.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module OpenxmlDocxTemplater
   class Line
     attr_reader :text
 
-    def initialize text
+    def initialize(text)
       @text = text
     end
 
@@ -10,59 +12,52 @@ module OpenxmlDocxTemplater
       @text
     end
 
-    def self.text txt
+    def self.text(txt)
       TextLine.new txt
     end
 
-    def self.code txt
+    def self.code(txt)
       CodeLine.new txt
     end
 
-    def self.string txt
-      StringLine.new txt
+    def self.string(txt)
+      StringLine.new(txt)
     end
 
-    def self.literal txt
+    def self.literal(txt)
       LiteralLine.new txt
     end
-
   end
 
   class TextLine < Line
     def to_buf
-      " _buf << '" << escape_text(@text) << "';"
+      " _buf << '#{escape_text(@text)}';"
     end
 
-    def escape_text text
+    def escape_text(text)
       text.gsub(/['\\]/, '\\\\\&')
     end
   end
 
   class CodeLine < Line
     def to_buf
-      escape_code(@text) << ';'
+      "#{escape_code(@text)};"
     end
 
-    def escape_code code
-      code.mgsub! [[/&apos;/, "'"], [/&gt;/, '>'], [/&lt/, '<'], [/&quot;/, '"'], [/&amp;/, '&']]
+    def escape_code(code)
+      code.mgsub(/&apos;/ => "'", /&gt;/ => '>', /&lt/ => '<', /&quot;/ => '"', /&amp;/ => '&')
     end
   end
 
   class StringLine < CodeLine
     def to_buf
-      " _buf << (" << escape_code(@text) << ").to_s.escape_xml.convert_newlines;"
-    end
-
-    def convert_newlines text
-      text.gsub("First line", '<w:br/>')
+      " _buf << (#{escape_code(@text)}).to_s.escape_xml.convert_newlines;"
     end
   end
 
   class LiteralLine < CodeLine
     def to_buf
-      " _buf << (" << escape_code(@text) << ").to_s;"
+      " _buf << (#{escape_code(@text)}).to_s;"
     end
   end
-
 end
-

data/lib/openxml_docx_templater/node_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OpenxmlDocxTemplater
   class NodeType
     TAG = 1

data/lib/openxml_docx_templater/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zip'
 require 'fileutils'
 
@@ -10,16 +12,16 @@ module OpenxmlDocxTemplater
       @template = output
     end
 
-    def process context
+    def process(context)
       tmpfiles = []
       Zip::File.open(@template) do |zipfile|
         zipfile.entries.select { |entry| entry.name[/\.xml$/] }.each do |xml_file|
-          content = zipfile.read(xml_file).refact.force_encoding("utf-8")
+          content = zipfile.read(xml_file).refact.force_encoding('utf-8')
 
           docxeruby = DocxEruby.new(XmlReader.new(content))
           out = docxeruby.evaluate(context)
 
-          tmpfiles << (file = Tempfile.new("openxml_template"))
+          tmpfiles << (file = Tempfile.new('openxml_template'))
           file << out
           file.close
 

data/lib/openxml_docx_templater/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OpenxmlDocxTemplater
-  VERSION = "0.1.3"
+  VERSION = '0.2.0'
 end

data/lib/openxml_docx_templater/xml_reader.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module OpenxmlDocxTemplater
   class XmlReader
-
-    def initialize src
+    def initialize(src)
       @src = src
     end
 
@@ -20,12 +21,9 @@ module OpenxmlDocxTemplater
       end
     end
 
-    def node_type text
-      if text =~ /\s*\{%[^=#].+?%\}\s*/
-        NodeType::CONTROL
-      else
-        NodeType::TEMPLATE
-      end
+    def node_type(text)
+      return NodeType::CONTROL if text.match?(/\s*\{%[^=#].+?%\}\s*/)
+      NodeType::TEMPLATE
     end
   end
 end

data/openxml_docx_templater.gemspec

@@ -1,27 +1,30 @@
+# frozen_string_literal: true
+
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'openxml_docx_templater/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "openxml_docx_templater"
+  spec.name          = 'openxml_docx_templater'
   spec.version       = OpenxmlDocxTemplater::VERSION
-  spec.authors       = ["Andrew Ageev"]
-  spec.email         = ["ageev86@gmail.com"]
+  spec.authors       = ['Andrew Ageev']
+  spec.email         = ['ageev86@gmail.com']
 
-  spec.summary       = %q{Simple creation .docx files by templates}
-  spec.description   = %q{Simple creation .docx files by templates}
-  spec.homepage      = "https://github.com/AgeevAndrew/openxml_docx_templater"
-  spec.license       = "MIT"
+  spec.summary       = 'Simple creation .docx files by templates'
+  spec.description   = 'Simple creation .docx files by templates'
+  spec.homepage      = 'https://github.com/AgeevAndrew/openxml_docx_templater'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 12.1'
   spec.add_dependency 'rubyzip'
 
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: openxml_docx_templater
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Ageev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -75,13 +75,14 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
 - examples/example.rb
 - examples/example_template.docx
 - examples/example_template_output.docx
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Simple creation .docx files by templates

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.10.6