docxedit 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Olivier Amblet <olivier@amblet.net>
+
+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

@@ -0,0 +1,31 @@
+Ruby Docx Edit
+==============
+
+A very minimal Ruby library that let you edit .docx file in some simple way
+
+* make string replacement in .docx document
+* insert new paragraphe using XML before or after a block of text
+
+This is not meant to be fully functional or even completed in the future, take this code if you want at your own risk.
+
+
+
+ require 'docxedit'
+ doc = DocxEdit::Docx.new('mydocfile.docx')
+ doc.contains? /A simple string/ #return true if regexp is match in one of the document xml node
+ doc.replace(/str_to_find/, "replacement") #replace the matched string with "replacement" string
+ block = doc.find_block_with_content("[[EXACT block content]]") #return a ContentBlock object
+
+ # insert a new block of text before block
+ doc.insert(:before, block, ContentBlock.new("<w:p><w:r>A new block for this file.</w:r></w:p>", "A new block for this file."))
+
+VERSIONS
+========
+0.0.1 First release
+
+ROADMAP
+=======
+No more development planned for now
+
+
+homepage: https://github.com/oliamb/docxedit

data/lib/docxedit.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+require "bundler/setup"
+Bundler.require(:default)
+
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+require_relative "docxedit/docx"

data/lib/docxedit/content_block.rb

@@ -0,0 +1,21 @@
+module DocxEdit
+  class ContentBlock
+    
+    attr_accessor :content
+    
+    def initialize(xml, content)
+      @xml = xml
+      @content_key = content
+      @content = content
+    end
+    
+    def xml
+      unless(@content_key == @content)
+        @node = REXML::XPath.first(@xml, "//*[text()='#{@content_key}']]")
+        @node.text = @content
+        @content_key = @content
+      end
+      return @xml
+    end
+  end
+end

data/lib/docxedit/docx.rb

@@ -0,0 +1,70 @@
+require 'zip/zip'
+require "rexml/document"
+require_relative 'content_block'
+
+module DocxEdit
+  class Docx    
+    attr_reader :zip_file, :xml_document
+    
+    def initialize(path)
+      @zip_file = Zip::ZipFile.new(path)
+      @xml_document = REXML::Document.new(read_content)
+    end
+    
+    def contains?(text)
+      REXML::XPath.each @xml_document, XPATH_ALL_TEXT_NODE do |n|
+        return true if n.text =~ text
+      end
+      return false
+    end
+    
+    # Persist changes in the Zip file
+    def commit
+      write_content
+    end
+    
+    def replace(reg_to_match, replacement)
+      REXML::XPath.each @xml_document, XPATH_ALL_TEXT_NODE do |n|
+        n.text = n.text.gsub(reg_to_match, replacement)
+      end
+    end
+    
+    def find_block_with_content(exact_content_string)
+      node = REXML::XPath.first(@xml_document, "//w:p[descendant-or-self::*[text()='#{exact_content_string}']]")
+      return ContentBlock.new(node, exact_content_string)
+    end
+    
+    # insert the xml of a content block :before or :after the anchor_block
+    def insert_block(position, anchor_block, new_block)
+      case position
+      when :before
+        anchor_block.xml.previous_sibling = new_block.xml
+      when :after
+        anchor_block.xml.next_sibling = new_block.xml
+      else
+        raise "position argument must be one of :before, :after"
+      end
+    end
+    
+    def remove_block(block)
+      block.xml.remove
+    end
+    
+  private
+    DOCUMENT_FILE_PATH = 'word/document.xml'
+    XPATH_ALL_TEXT_NODE = "//*[text()]"
+  
+    def read_content()
+      return text = @zip_file.read(DOCUMENT_FILE_PATH)
+    end
+    
+    def write_content()
+      @zip_file.get_output_stream(DOCUMENT_FILE_PATH) do |input|
+        output = ""
+        @xml_document.write(output, 0)
+        input.write output
+      end
+      @zip_file.commit
+    end
+  end
+end

data/lib/docxedit/version.rb

@@ -0,0 +1,3 @@
+module DocxEdit
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: docxedit
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Olivier Amblet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: minimal .docx file editor.
+email: olivier@amblet.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/docxedit/content_block.rb
+- lib/docxedit/docx.rb
+- lib/docxedit/version.rb
+- lib/docxedit.rb
+- LICENSE
+- README
+has_rdoc: true
+homepage: http://livingweb.ch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: docxedit
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Minimal Word Open Document format editor.
+test_files: []
+