docx_replace 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG

@@ -0,0 +1,3 @@
+## v1.0.0
+
+* Initial Release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docx_replace.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Albrecht
+
+MIT 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

@@ -0,0 +1,61 @@
+# Docx Replace
+
+This gem allows you to generate .docx files in your rails or ruby app by
+embedding variables inside of a .docx template. This is purposefully
+meant to be simple and feature-light.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docx_replace'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docx_replace
+
+## Usage
+
+Inside of a rails controller, your code might look something like this:
+
+```ruby
+def user_report
+  @user = User.find(params[:user_id])
+
+  respond_to do |format|
+    format.docx do
+      # Initialize DocxReplace with your template
+      doc = DocxReplace::Doc.new("#{Rails.root}/lib/docx_templates/my_template.docx", "#{Rails.root}/tmp")
+
+      # Replace some variables. $var$ convention is used here, but not required.
+      doc.replace("$first_name$", @user.first_name)
+      doc.replace("$last_name$", @user.last_name)
+      doc.replace("$user_bio$", @user.bio)
+      
+      # Write the document back to a temporary file
+      tmp_file = TempFile.new('word_tempate', "#{Rails.root}/tmp")
+      doc.commit(tmp_file)
+
+      # Respond to the request by sending the temp file
+      send_file tmp_file.path, filename: "user_#{@user.id}_report.docx", disposition: 'attachment'
+    end
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+Much of this code is based on an older gem called [docxedit](https://github.com/oliamb/docxedit). This has a few more features, but is very sensitive to the formatting of the .docx template.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/docx_replace.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docx_replace/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "docx_replace"
+  gem.version       = DocxReplace::VERSION
+  gem.authors       = ["Adam Albrecht"]
+  gem.email         = ["adam.albrecht@gmail.com"]
+  gem.description   = %q{Find and replace variables inside a Micorsoft Word (.docx) template}
+  gem.summary       = %q{Find and replace variables inside a Micorsoft Word (.docx) template}
+  gem.homepage      = "https://github.com/adamalbrecht/docx_replace"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_runtime_dependency "rubyzip"
+end

data/lib/docx_replace.rb

@@ -0,0 +1,60 @@
+require "docx_replace/version"
+require 'zip/zip'
+require 'tempfile'
+
+module DocxReplace
+  class Doc
+    def initialize(path, temp_dir=nil)
+      @zip_file = Zip::ZipFile.new(path)
+      @temp_dir = temp_dir
+      read_docx_file
+    end
+
+    def replace(pattern, replacement, multiple_occurrences=false)
+      if multiple_occurrences
+        @document_content.gsub!(pattern, replacement)
+      else
+        @document_content.sub!(pattern, replacement)
+      end
+    end
+
+    def commit(new_path=nil)
+      write_back_to_file(new_path)
+    end
+
+    private
+    DOCUMENT_FILE_PATH = 'word/document.xml'
+
+    def read_docx_file
+      @document_content = @zip_file.read(DOCUMENT_FILE_PATH)
+    end
+
+    def write_back_to_file(new_path=nil)
+      if @temp_dir.nil?
+        temp_file = Tempfile.new('docxedit-')
+      else
+        temp_file = Tempfile.new('docxedit-', @temp_dir)
+      end
+      Zip::ZipOutputStream.open(temp_file.path) do |zos|
+        @zip_file.entries.each do |e|
+          unless e.name == DOCUMENT_FILE_PATH
+            zos.put_next_entry(e.name)
+            zos.print e.get_input_stream.read
+          end
+        end
+
+        zos.put_next_entry(DOCUMENT_FILE_PATH)
+        zos.print @document_content
+      end
+
+      if new_path.nil?
+        path = @zip_file.name
+        FileUtils.rm(path)
+      else
+        path = new_path
+      end
+      FileUtils.mv(temp_file.path, path)
+      @zip_file = Zip::ZipFile.new(path)
+    end
+  end
+end

data/lib/docx_replace/version.rb

@@ -0,0 +1,3 @@
+module DocxReplace
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: docx_replace
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Albrecht
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Find and replace variables inside a Micorsoft Word (.docx) template
+email:
+- adam.albrecht@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docx_replace.gemspec
+- lib/docx_replace.rb
+- lib/docx_replace/version.rb
+homepage: https://github.com/adamalbrecht/docx_replace
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Find and replace variables inside a Micorsoft Word (.docx) template
+test_files: []