docx_template 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25e7e959da3023c6e56466f20de720fd04b7c3a7
-  data.tar.gz: 33b39c4f911c116c28a8fb7be8b6689ca43edb9e
+  metadata.gz: 8de0ab802b5846e6c2c6ef7d65a254b6515803cc
+  data.tar.gz: 4240ab789b88a6fc281e4217b897c7effed15a2e
 SHA512:
-  metadata.gz: c7badb132b8de0afd35cf2c03d9a0665303598e226ce50ef64d7c8efa116b46935c539a09c7835a80a4e98970d67130fd5f6d84fd447aca928b06cf5e85441a7
-  data.tar.gz: ee443021f0c0c7d2bf1d69d186798cc8c57207a4125b60aa1ac85a398bb1d776e81aada7496d73f217a4e473c36fd8b0523d9fd44c2c8ea35e0e7c7706604c8f
+  metadata.gz: 825187871496b970ea789fda0a11416b13b6f66e08269dfe3b1cc930689b3f9bee3cfd48474e8d11a1550f490b8c06501885627cc0b143242bb90f4f81397229
+  data.tar.gz: cd89852f2474baa12dedacaf31e74e4d8c9465915693cb2519cdf1d464005460e262c434594fcb1399c6a6adbbe6b3cdfaf9f42d4659be755c0bd9463f623489

data/LICENSE

@@ -1,3 +1,24 @@
 == docx_template
 
-Put appropriate LICENSE for your project here.
+Copyright (c) 2014 Maniankara
+
+Maniankara Inc. License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,9 +1,30 @@
-docx_template
+docx_template - Templating library for docx files
 =============
 
 Docx templating library which could replace docx contents such as text, images etc. in one go.
 
+### Installation
+docx_template can be used from the command line or as part of a Ruby web framework. To install the gem using terminal, run the following command:
+```
+gem install docx_template
+```
+To use it in Rails, add this line to your Gemfile:
+```
+gem 'docx_template'
+```
+
 #### Sample usage
+```
+require 'docx_template'
+template = DocxTemplate::Docx.new "/opt/docx_template.docx"
+template.replace_text("##SINGLE_REPLACE_TEXT##", "ACTUAL TEXT HERE")
+template.replace_text("##MULTI_REPLACE_TEXT##", "ACTUAL TEXT HERE", true)
+template.replace_image("image1.jpeg", "/opt/image5.jpg")
+template.replace_header("##HEADER_REPLACE_TEXT##", "ACTUAL TEXT HERE", true)
+template.save('/opt/final.docx')
+```
+###### Line by line explanation is given here:
+
 ```
 template = DocxTemplate::Docx.new "/opt/docx_template.docx"
 ```
@@ -21,6 +42,28 @@ template.replace_image("image1.jpeg", "/opt/image5.jpg")
 ```
 The first param defines the name of the image to be replaced. Can be checked by opening the template as archive
 ```
+template.replace_header("##HEADER_REPLACE_TEXT##", "ACTUAL TEXT HERE", true)
+```
+This does the same as before but in document headers
+```
 template.save('/opt/final.docx')
 ```
-The actual process begins and ends here
+The actual file processing begins and ends here
+
+### Contributing
+Contributions are welcomed. You can fork a repository, add your code changes to the forked branch, ensure all existing unit tests pass, create new unit tests cover your new changes and finally create a pull request.
+
+#### Testing
+Once this is complete, you should be able to run the test suite:
+```
+rspec
+```
+### Release test setup
+The following test setup was used when released:
+* ruby2.1.2
+* rails4
+* Ubuntu14.1 Linux
+* Microsoft word 2007+
+
+### License
+docx_template has been published under https://github.com/maniankara/docx_template/blob/master/LICENSE under Maniankara Inc.

data/docx_template.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docx_template/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docx_template"
+  spec.version       = "0.2"
+  spec.authors       = ["Maniankara"]
+  spec.email         = ["Maniankara@gmail.com"]
+  spec.summary       = %q{Docx templating library which could replace docx contents such as text, images etc. in one go.}
+  spec.description   = %q{
+    template = DocxTemplate::Docx.new "/opt/docx_template.docx"
+    template.replace_text("##SINGLE_REPLACE_TEXT##", "ACTUAL TEXT HERE")
+    template.replace_text("##MULTI_REPLACE_TEXT##", "ACTUAL TEXT HERE", true)
+    template.replace_image("image1.jpeg", "/opt/image5.jpg")
+    template.save('/opt/final.docx')
+  }
+  spec.homepage      = "https://www.facebook.com/maniankara"
+  spec.license       = "Maniankara Inc."
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/docx_template/docx.rb

@@ -3,11 +3,17 @@ require 'zip'
 module DocxTemplate
 
   class DocxTemplate::Docx
-    attr_reader :dest_path, :file_path, :text_replacer_list, :image_replacer_list
+    attr_reader :dest_path, 
+      :file_path,
+      :text_replacer_list,
+      :image_replacer_list,
+      :header_replacer_list
+    
     def initialize(file_path)
       @file_path = file_path
       @text_replacer_list = []
       @image_replacer_list = []
+      @header_replacer_list = []
     end
 
     def replace_text(src_text, dest_text, multiple_occurances=false)
@@ -20,6 +26,10 @@ module DocxTemplate
       @image_replacer_list << replacer
     end
 
+    def replace_header(src_text, dest_text, multiple_occurances=false)
+      @header_replacer_list << EntityReplacer.new(src_text, dest_text, multiple_occurances)
+    end
+
     def save(dest_path=Dir.mktmpdir)
       @dest_path = dest_path
       buffer = nil
@@ -29,15 +39,17 @@ module DocxTemplate
           prepare_rest_of_archive(zip_file, out, exclusion_files_list)
           # text part
           unless @text_replacer_list.empty?
-            out.put_next_entry(DOCUMENT_FILE_PATH)
-            replacer = @text_replacer_list.first
-            out.write zip_file.read(DOCUMENT_FILE_PATH).gsub(replacer.src_entity,replacer.dest_entity)
+            replace_content(out, DOCUMENT_FILE_PATH, zip_file, @text_replacer_list)
           end
           # image part
           @image_replacer_list.each do |replacer|
             out.put_next_entry("#{IMAGES_DIR_PATH}/#{replacer.src_entity}")
             out.write File.read(replacer.dest_entity)
           end
+          # header part
+          unless @header_replacer_list.empty?
+            replace_content(out, HEADER_FILE_PATH, zip_file, @header_replacer_list)
+          end
         end
       end
 
@@ -48,7 +60,7 @@ module DocxTemplate
 
     DOCUMENT_FILE_PATH = "word/document.xml"
     IMAGES_DIR_PATH = "word/media"
-    RELS_FILE_PATH = "word"
+    HEADER_FILE_PATH = "word/header1.xml"
 
     def prepare_rest_of_archive(zip_file, out, exclude_list)
       zip_file.entries.each do |e|
@@ -70,6 +82,14 @@ module DocxTemplate
       e_list
     end
 
+    def replace_content(out, dest_file, zip_file, list)
+      out.put_next_entry(dest_file)
+      string_buffer = zip_file.read(dest_file)
+      list.each do |replacer|
+        string_buffer.gsub!(replacer.src_entity,replacer.dest_entity)
+      end
+      out.write string_buffer
+    end
 
     class EntityReplacer
       attr_reader :src_entity, :dest_entity, :occurances

data/lib/docx_template/version.rb

@@ -1,3 +1,3 @@
 module DocxTemplate
-  VERISON = "0.1"
+  VERISON = "0.2"
 end

data/spec/docx_spec.rb

@@ -26,4 +26,11 @@ RSpec.describe DocxTemplate::Docx do
     template.save("/tmp/a.docx")
     expect(@docx_verifier.verify_image_exists?("/tmp/a.docx", "image1.jpeg", "spec/unit/images/image5.jpg")).to be(true)
   end
+
+  it "Replaces text in header" do
+    template = DocxTemplate::Docx.new "spec/unit/templates/docx_template.docx"
+    template.replace_header("##HEADER_REPLACE_TEXT##", "here")
+    template.save("/tmp/a.docx")
+    expect(@docx_verifier.verify_text_exists?("/tmp/a.docx", "##HEADER_REPLACE_TEXT##")).to be(false)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docx_template
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Maniankara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-20 00:00:00.000000000 Z
+date: 2014-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,7 @@ files:
 - README
 - README.md
 - Rakefile
+- docx_template.gemspec
 - lib/docx_template.rb
 - lib/docx_template/docx.rb
 - lib/docx_template/version.rb