Finished bookmark insertions

Author: chrahunt

lib/docx/containers/container.rb

@@ -4,7 +4,6 @@ module Docx
   module Elements
     module Containers
       module Container
-        include Elements::Element
         # Relation methods
         # TODO: Create a properties object, include Element
         def properties

lib/docx/containers/paragraph.rb

@@ -6,8 +6,8 @@ module Elements
     module Containers
       class Paragraph
         include Container
-        attr_accessor :text_runs
-        
+        include Elements::Element
+
         TAG = 'p'
 
         # Child elements: pPr, r, fldSimple, hlink, subDoc
@@ -20,12 +20,14 @@ def initialize(node)
         # Handle direct text insertion into paragraph on some conditions
         def text=(content)
           if text_runs.size == 1
-            @text_runs.first.text = content
+            text_runs.first.text = content
           elsif text_runs.size == 0
             new_r = TextRun.create_within(self)
             new_r.text = content
           else
-            nil
+            text_runs.each {|r| r.node.remove }
+            new_r = TextRun.create_within(self)
+            new_r.text = content
           end
         end
 

lib/docx/containers/text_run.rb

@@ -5,6 +5,8 @@ module Elements
     module Containers
       class TextRun
         include Container
+        include Elements::Element
+
         DEFAULT_FORMATTING = {
           italic:    false,
           bold:      false,
@@ -18,18 +20,23 @@ class TextRun
 
         def initialize(node)
           @node = node
+          @text_nodes = @node.xpath('w:t').map {|t_node| Elements::Text.new(t_node) }
           @properties_tag = 'rPr'
           @text       = parse_text || ''
           @formatting = parse_formatting || DEFAULT_FORMATTING
         end
 
         def text=(content)
-          @node.content = content
-          self
+          if @text_nodes.size == 1
+            @text_nodes.first.content = content
+          elsif @text_nodes.empty?
+            new_t = Elements::Text.create_within(self)
+            new_t.content = content
+          end
         end
 
         def parse_text
-          @node.xpath('w:t').map(&:text).join('')
+          @text_nodes.map(&:content).join('')
         end
 
         def parse_formatting

lib/docx/elements.rb

@@ -1,2 +1,3 @@
 require 'docx/elements/bookmark'
-require 'docx/elements/element'
+require 'docx/elements/element'
+require 'docx/elements/text'

lib/docx/elements/bookmark.rb

@@ -6,10 +6,46 @@ class Bookmark
       include Element
       attr_accessor :name
 
+      TAG = 'bookmarkStart'
+
       def initialize(node)
         @node = node
         @name = @node['w:name']
       end
+
+      def insert_text_before(text)
+        text_run = get_run_after
+        text_run.text = "#{text}#{text_run.text}"
+      end
+
+      def insert_text_after(text)
+        text_run = get_run_before
+        text_run.text = "#{text_run.text}#{text}"
+      end
+
+      def get_run_before
+        # at_xpath returns the first match found and preceding-sibling returns siblings in the 
+        # order they appear in the document not the order as they appear when moving out from
+        # the starting node
+        if (r_nodes = @node.xpath("./preceding-sibling::w:r"))
+          r_node = r_nodes.last
+          Containers::TextRun.new(r_node)
+        else
+          new_r = Containers::TextRun.create_with(self)
+          new_r.insert_before(self)
+          new_r
+        end
+      end
+
+      def get_run_after
+        if (r_node = @node.at_xpath("./following-sibling::w:r"))
+          Containers::TextRun.new(r_node)
+        else
+          new_r = Containers::TextRun.create_with(self)
+          new_r.insert_after(self)
+          new_r
+        end
+      end
     end
   end
 end

lib/docx/elements/element.rb

@@ -3,8 +3,11 @@
 module Docx
   module Elements
     module Element
+      DEFAULT_TAG = ''
+
       def self.included(base)
         base.extend(ClassMethods)
+        base.const_set(:TAG, Element::DEFAULT_TAG) unless base.const_defined?(:TAG)
       end
 
       attr_accessor :node
@@ -24,20 +27,24 @@ def paragraph
       # Insert node as last child
       def append_to(element)
         @node = element.node.add_child(@node)
+        self
       end
 
       # Insert node as first child (after properties)
       def prepend_to(element)
         @node = element.node.properties.add_next_sibling(@node)
+        self
       end
 
       def insert_after(element)
         # Returns newly re-parented node
         @node = element.node.add_next_sibling(@node)
+        self
       end
 
       def insert_before(element)
         @node = element.node.add_previous_sibling(@node)
+        self
       end
 
       # Creation/edit methods
@@ -48,12 +55,13 @@ def copy
       module ClassMethods
         def create_with(element)
           # Need to somehow get the xml document accessible here by default, but this is alright in the interim
-          self.new(Nokogiri::XML::Node.new("w:#{TAG}"), element.node)
+          self.new(Nokogiri::XML::Node.new("w:#{self.const_get(:TAG)}", element.node))
         end
 
         def create_within(element)
           new_element = create_with(element)
           new_element.append_to(element)
+          new_element
         end
       end
     end

lib/docx/elements/text.rb

@@ -0,0 +1,13 @@
+module Docx
+  module Elements
+    class Text
+      include Element
+      delegate :content, :content=, :to => :@node
+      TAG = 't'
+
+      def initialize(node)
+        @node = node
+      end
+    end
+  end
+end

lib/docx/parser.rb

@@ -21,7 +21,12 @@ def paragraphs
     end
 
     def bookmarks
-      @doc.xpath('//w:bookmarkStart').map { |b_node| parse_bookmark_from b_node }
+      bkmrks_hsh = Hash.new
+      bkmrks_ary = @doc.xpath('//w:bookmarkStart').map { |b_node| parse_bookmark_from b_node }
+      # auto-generated by office 2010
+      bkmrks_ary.reject! {|b| b.name == "_GoBack" }
+      bkmrks_ary.each {|b| bkmrks_hsh[b.name] = b }
+      bkmrks_hsh
     end
 
     private

test/docx/test_document.rb

@@ -14,8 +14,8 @@ def test_basic_functionality
   end
 
   def test_bookmarks
-    assert_equal 2, @doc.bookmarks.size
-    assert_equal 'test_bookmark', @doc.bookmarks.first.name
+    assert_equal 1, @doc.bookmarks.size
+    assert @doc.bookmarks['test_bookmark']
   end
 
   def test_each_paragraph

test/docx/test_editing.rb

@@ -1,12 +1,12 @@
 require 'docx'
 require 'test/unit'
 
-class SaveTest < Test::Unit::TestCase
+class EditTest < Test::Unit::TestCase
   def setup
-    @doc = Docx::Document.open('test/fixtures/saving.docx')
+    @doc = Docx::Document.open('test/fixtures/editing.docx')
   end
 
-  def test_copy
+  def test_copy_paragraph
     old_p = @doc.paragraphs.first
     new_p = old_p.copy
     assert_kind_of Docx::Elements::Containers::Paragraph, new_p
@@ -15,11 +15,34 @@ def test_copy
   end
 
   def test_insertion
-    assert_equal 2, @doc.paragraphs.size
+    assert_equal 3, @doc.paragraphs.size
     first_p = @doc.paragraphs.first
     new_p = first_p.copy
     new_p.insert_after first_p
-    assert_equal 3, @doc.paragraphs.size
+    assert_equal 4, @doc.paragraphs.size
+  end
+
+  def test_paragraph_text
+    assert_equal 'test text', @doc.paragraphs.first.text
+    @doc.paragraphs.first.text = 'the real test'
+    assert_equal 'the real test', @doc.paragraphs.first.text
+  end
+
+  def test_inserting_text_before_bookmark
+    assert_equal 'test text', @doc.paragraphs.first.text
+    @doc.bookmarks['beginning_bookmark'].insert_text_before('foo')
+    assert_equal 'footest text', @doc.paragraphs.first.text
+  end
+
+  def test_inserting_text_after_bookmark
+    assert_equal 'test text', @doc.paragraphs.first.text
+    @doc.bookmarks['end_bookmark'].insert_text_after('bar')
+    assert_equal 'test textbar', @doc.paragraphs.first.text
+  end
+
+  # Insert text intelligently around bookmark
+  def test_inserting_text_around_bookmark
+
   end
 
   def test_blank