docx_template 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25e7e959da3023c6e56466f20de720fd04b7c3a7
+  data.tar.gz: 33b39c4f911c116c28a8fb7be8b6689ca43edb9e
+SHA512:
+  metadata.gz: c7badb132b8de0afd35cf2c03d9a0665303598e226ce50ef64d7c8efa116b46935c539a09c7835a80a4e98970d67130fd5f6d84fd447aca928b06cf5e85441a7
+  data.tar.gz: ee443021f0c0c7d2bf1d69d186798cc8c57207a4125b60aa1ac85a398bb1d776e81aada7496d73f217a4e473c36fd8b0523d9fd44c2c8ea35e0e7c7706604c8f

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+#Unit testing
+gem 'rspec'
+
+#ruby official zip
+gem 'rubyzip'

data/LICENSE

@@ -0,0 +1,3 @@
+== docx_template
+
+Put appropriate LICENSE for your project here.

data/README

@@ -0,0 +1,3 @@
+== docx_template
+
+You should document your project here.

data/README.md

@@ -0,0 +1,26 @@
+docx_template
+=============
+
+Docx templating library which could replace docx contents such as text, images etc. in one go.
+
+#### Sample usage
+```
+template = DocxTemplate::Docx.new "/opt/docx_template.docx"
+```
+The template document contains notations and other things which will be replaced
+```
+template.replace_text("##SINGLE_REPLACE_TEXT##", "ACTUAL TEXT HERE")
+```
+The replace text can be anything inside the document
+```
+template.replace_text("##MULTI_REPLACE_TEXT##", "ACTUAL TEXT HERE", true)
+```
+The given text can also be replaced across the whole document
+```
+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.save('/opt/final.docx')
+```
+The actual process begins and ends here

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+#Rake::TestTask.new do |t|
+#  t.libs << "lib/docx_template"
+#  t.libs << "test"
+#  t.test_files = FileList["test/**/*_test.rb"]
+#  t.verbose = true
+#end

data/lib/docx_template/docx.rb

@@ -0,0 +1,90 @@
+require 'zip'
+
+module DocxTemplate
+
+  class DocxTemplate::Docx
+    attr_reader :dest_path, :file_path, :text_replacer_list, :image_replacer_list
+    def initialize(file_path)
+      @file_path = file_path
+      @text_replacer_list = []
+      @image_replacer_list = []
+    end
+
+    def replace_text(src_text, dest_text, multiple_occurances=false)
+      @text_replacer_list << EntityReplacer.new(src_text, dest_text, multiple_occurances)
+    end
+
+    def replace_image(src_image_file_name, dest_image_file)
+      replacer = EntityReplacer.new(src_image_file_name, dest_image_file, false)
+      replacer.type = "IMAGE"
+      @image_replacer_list << replacer
+    end
+
+    def save(dest_path=Dir.mktmpdir)
+      @dest_path = dest_path
+      buffer = nil
+      Zip::File.open(@file_path) do |zip_file|
+        buffer = Zip::OutputStream.write_buffer do |out|
+          exclusion_files_list = derive_exclusion_file_list
+          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)
+          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
+        end
+      end
+
+      File.open(dest_path, "w") {|f| f.write(buffer.string) }
+    end
+
+    private
+
+    DOCUMENT_FILE_PATH = "word/document.xml"
+    IMAGES_DIR_PATH = "word/media"
+    RELS_FILE_PATH = "word"
+
+    def prepare_rest_of_archive(zip_file, out, exclude_list)
+      zip_file.entries.each do |e|
+        unless exclude_list.include?(e.name)
+          out.put_next_entry(e.name)
+          out.write e.get_input_stream.read
+         end
+      end
+    end
+
+    def derive_exclusion_file_list
+      e_list = []
+      unless @text_replacer_list.empty?
+        e_list << DOCUMENT_FILE_PATH
+      end
+      @image_replacer_list.each do |replacer|
+        e_list << "#{IMAGES_DIR_PATH}/#{replacer.src_entity}"
+      end
+      e_list
+    end
+
+
+    class EntityReplacer
+      attr_reader :src_entity, :dest_entity, :occurances
+      attr_writer :type
+      def initialize(src, dest, occurances)
+        @src_entity = src
+        @dest_entity = dest
+        @occurances = occurances
+      end
+
+      def type
+        @type || "FILE"
+      end
+    end
+
+  end
+
+end

data/lib/docx_template/version.rb

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

data/lib/docx_template.rb

@@ -0,0 +1,6 @@
+require 'docx_template/version'
+require 'docx_template/docx'
+
+module DocxTemplate
+  
+end

data/spec/docx_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe DocxTemplate::Docx do
+
+  before(:all) do
+    @docx_verifier = SpecHelper::DocxVerifier.new
+  end
+  
+  it "Replaces text once" do
+    template = DocxTemplate::Docx.new "spec/unit/templates/docx_template.docx"
+    template.replace_text("##SINGLE_REPLACE_TEXT##", "here")
+    template.save("/tmp/a.docx")
+    expect(@docx_verifier.verify_text_exists?("/tmp/a.docx", "##SINGLE_REPLACE_TEXT##")).to be(false)
+  end
+
+  it "Replaces text multiple occurances" do
+    template = DocxTemplate::Docx.new "spec/unit/templates/docx_template.docx"
+    template.replace_text("##MULTIPLE_REPLACE_TEXT##", "here")
+    template.save("/tmp/a.docx")
+    expect(@docx_verifier.verify_text_exists?("/tmp/a.docx", "##MULTIPLE_REPLACE_TEXT##")).to be(false)
+  end
+
+  it "Replaces an image" do
+    template = DocxTemplate::Docx.new "spec/unit/templates/docx_template.docx"
+    template.replace_image("image1.jpeg", "spec/unit/images/image5.jpg")
+    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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'docx_template/docx'
+
+module SpecHelper
+
+  class DocxVerifier
+
+    def verify_text_exists?(docx_file_path, search_text)
+      Zip::File.open(docx_file_path) do |zip_file|
+        zip_file.entries.each do |entry|
+          next if entry.name != DOCUMENT_FILE_PATH
+          file_contents = entry.get_input_stream.read
+          return true if file_contents.include?(search_text)
+        end
+      end
+      return false
+    end
+
+    # verifies if the sizes of file are same
+    def verify_image_exists?(docx_file_path, src_image, expected_image)
+      Zip::File.open(docx_file_path) do |zip_file|
+        zip_file.entries.each do |entry|
+          next if entry.name != "#{IMAGE_DIR_PATH}/#{src_image}"
+          archive_file_contents = entry.get_input_stream.read
+          return archive_file_contents.size == File.size(expected_image)
+        end
+      end
+      return false
+    end
+
+    private
+
+    DOCUMENT_FILE_PATH = 'word/document.xml'
+    IMAGE_DIR_PATH = 'word/media'
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: docx_template
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Maniankara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    template = DocxTemplate::Docx.new \"/opt/docx_template.docx\"\n
+  \   template.replace_text(\"##SINGLE_REPLACE_TEXT##\", \"ACTUAL TEXT HERE\")\n    template.replace_text(\"##MULTI_REPLACE_TEXT##\",
+  \"ACTUAL TEXT HERE\", true)\n    template.replace_image(\"image1.jpeg\", \"/opt/image5.jpg\")\n
+  \   template.save('/opt/final.docx')\n  "
+email:
+- Maniankara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README
+- README.md
+- Rakefile
+- lib/docx_template.rb
+- lib/docx_template/docx.rb
+- lib/docx_template/version.rb
+- spec/docx_spec.rb
+- spec/spec_helper.rb
+- spec/unit/images/image5.jpg
+- spec/unit/templates/docx_template.docx
+homepage: https://www.facebook.com/maniankara
+licenses:
+- Maniankara Inc.
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Docx templating library which could replace docx contents such as text, images
+  etc. in one go.
+test_files:
+- spec/docx_spec.rb
+- spec/spec_helper.rb
+- spec/unit/images/image5.jpg
+- spec/unit/templates/docx_template.docx