doct 0.1.3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "nokogiri"
+gem "rubyzip"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Anton Argirov
+
+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.rdoc

@@ -0,0 +1,19 @@
+= doct
+
+Description goes here.
+
+== Contributing to doct
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Anton Argirov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "doct"
+  gem.homepage = "http://redmine.academ.org"
+  gem.license = "MIT"
+  gem.summary = 'Simple Office Document Templating'
+  gem.description = %Q(Provides an ability to pre-populate an office document through a simple templating mechanism that can easily be managed by an end user.)
+  gem.email = "anton.argirov@gmail.com"
+  gem.authors = ["Anton Argirov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "render_parent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/lib/doct.rb

@@ -0,0 +1 @@
+require 'doct/template'

data/lib/doct/formats/base.rb

@@ -0,0 +1,13 @@
+module Doct::Formats
+  class Base
+    def initialize(path)
+      @template_path = path
+    end
+    def render(params)
+      raise NotImplementedError
+    end
+    def placeholders
+      raise NotImplementedError
+    end
+  end
+end

data/lib/doct/formats/docx.rb

@@ -0,0 +1,45 @@
+require 'doct/formats/open_format'
+
+module Doct::Formats
+  class Docx < OpenFormat
+
+    def content_entry?(entry)
+      return true if entry == 'word/document.xml'
+      entry =~ /word\/(header|footer)\d*.xml/
+    end
+
+    def entry_render(entry, content, params)
+      xml = Nokogiri::XML(content)
+      orig_xml = xml.dup
+      current_xml = xml
+      sectpr_node = xml.xpath("w:document/w:body/w:sectPr").first
+      if entry == 'word/document.xml'
+        for page in params
+          nodes = current_xml.xpath("w:document/w:body/*[name()!='w:sectPr']")
+          nodes.xpath("//w:sdt//w:t").each do |node|
+            node.content = page[node.content.to_sym].to_s
+          end
+          sectpr_node.before(nodes)
+          if page != params.last
+            sectpr_node.before("<w:p><w:r><w:br w:type='page'/></w:r></w:p>")
+          end
+          current_xml = orig_xml.dup
+        end
+      elsif not params.empty?
+        xml.xpath("//w:sdt//w:t").each do |node|
+          node.content = params.first[node.content.to_sym]
+        end
+      end
+      xml.to_s
+    end
+
+    def entry_placeholders(entry, content)
+      xml = Nokogiri::XML(content)
+      xml.xpath("//w:sdt//w:t").collect {|node| node.content.to_s}
+    end
+
+    private
+
+    Doct::Template::register_format(self, 'docx')
+  end
+end

data/lib/doct/formats/odt.rb

@@ -0,0 +1,43 @@
+require 'doct/formats/open_format'
+
+module Doct::Formats
+  class Odt < OpenFormat
+    def content_entries
+      %w(content.xml styles.xml)
+    end
+
+    def entry_render(entry, content, params)
+      xml = Nokogiri::XML(content)
+      orig_xml = xml.dup
+      current_xml = xml
+      text_node = xml.xpath("//office:text").first
+      if entry == 'content.xml'
+        for page in params
+          nodes = current_xml.xpath("//office:text/*")
+          nodes.xpath("//text:database-display").each do |node|
+            param_name = node.attributes["column-name"].to_s
+            node.replace page[param_name.to_sym].to_s
+          end
+          text_node.add_child(nodes)
+          if page != params.last
+            text_node.add_child("<text:soft-page-break>")
+          end
+          current_xml = orig_xml.dup
+        end
+      elsif not params.empty?
+        xml.xpath("//text:database-display").each do |node|
+          param_name = node.attributes["column-name"].to_s
+          node.replace params.first[param_name.to_sym].to_s
+        end
+      end
+      xml.to_s
+    end
+
+    def entry_placeholders(entry, content)
+      xml = Nokogiri::XML(content)
+      xml.xpath("//text:database-display").collect { |node| node.attributes["column-name"].to_s }
+    end
+
+    Doct::Template::register_format(self, 'odt')
+  end
+end

data/lib/doct/formats/open_format.rb

@@ -0,0 +1,58 @@
+require 'doct/formats/base'
+require 'zip/zip'
+require 'nokogiri'
+require 'fileutils'
+
+module Doct::Formats
+  class OpenFormat < Base
+
+    def render(params)
+      Zip::ZipOutputStream.write_buffer do |output|
+        each_entry do |entry, file|
+          file = entry_render(entry, file, params) if _content_entry?(entry)
+          output.put_next_entry entry
+          output.write file
+        end
+      end.string
+    end
+
+    def placeholders
+      placeholders = []
+      each_entry do |entry, file|
+        placeholders += entry_placeholders(entry, file) if _content_entry?(entry)
+      end
+      placeholders
+    end
+
+    def content_entries
+      nil
+    end
+
+    def content_entry?(entry)
+      false
+    end
+
+    private
+
+    def _content_entry?(entry)
+      content_entries && content_entries.include?(entry) || content_entry?(entry)
+    end
+
+    def each_entry
+      Zip::ZipInputStream.open(@template_path) do |input|
+        while (entry = input.get_next_entry) do
+          yield entry.name, input.read
+        end
+      end
+    end
+
+    def entry_placeholders(entry, xml)
+      []
+    end
+
+    def entry_render(entry, xml, template)
+      xml
+    end
+  end
+end
+

data/lib/doct/template.rb

@@ -0,0 +1,26 @@
+module Doct
+  class Template < Array
+    attr_reader :format
+    FORMATS = {}
+
+    def self.register_format(format, *extensions)
+      extensions.each {|ext| FORMATS[ext] = format}
+    end
+    def initialize(filename, format = nil)
+      format ||= File.extname(filename)[1..-1].to_s.downcase
+      raise "Unrecognized format '#{format}'" unless FORMATS[format]
+      @format = FORMATS[format].new(filename)
+    end
+    def placeholders
+      @format.placeholders.map(&:to_sym)
+    end
+    def save_as filename
+      open(filename, "wb") { |io| io << render }
+    end
+    def render
+      @format.render self
+    end
+  end
+end
+
+Dir["#{File.dirname(__FILE__)}/formats/*.rb"].each {|file| require file}

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: doct
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+  prerelease: 
+platform: ruby
+authors:
+- Anton Argirov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: Provides an ability to pre-populate an office document through a simple
+  templating mechanism that can easily be managed by an end user.
+email: anton.argirov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/output.docx
+- examples/output.odt
+- examples/template.docx
+- examples/template.odt
+- lib/doct.rb
+- lib/doct/formats/base.rb
+- lib/doct/formats/docx.rb
+- lib/doct/formats/odt.rb
+- lib/doct/formats/open_format.rb
+- lib/doct/template.rb
+homepage: http://redmine.academ.org
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 616003599
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple Office Document Templating
+test_files: []