caracal 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e775f349922d6591347d38de57b4211581c75d1b1b1fe08f67d887d68833a6b
-  data.tar.gz: 635e787f52491c8f06ff3dcb32cd0d573a4abc7b44aa693dc8421a74108942e0
+  metadata.gz: 52dc6e582d7e47010ca9fc90d1e02f20944d55faa485548c881bec1091c45e96
+  data.tar.gz: b6f22eebb075a7852b0ea30ea595ca6ca89f7b98e40564ff3ab2b68c9f004039
 SHA512:
-  metadata.gz: 20b0fd3d486e99180c7a871610ba7d619d75cefc2116cb54e3920ed8bf2c036a6d93789df6570dde608cc68ece8693e272da093ad5ac26dad8962804c35f2171
-  data.tar.gz: d69653b8075ec87ab191cf07d4bc1090fb0822b3ae05a1f24d9edfd8ac3476efa2291c46a21c8194dca4d99505fee569cf1ddaf85a4f03dce7ae1de3857cc486
+  metadata.gz: 9651b63df3aa217d25c8ed1f9c3676a57071f3c4e7532053c76f0d07ead18e399c0dcc79c40427959bd275966c60e8be5b72ac0620f0bfd8853aff0ff1a1ddc4
+  data.tar.gz: 9b9bd2396372f9fe4334eccbeddee4bff14aa7f3b14acc595fe6dbdeba858f37017c3b64d38b28b9efd60f26b11351590122bff05d73f7fb3cffefa36c9dee3a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+#### v1.3.0
+
+* Enhancements
+  * Added proper text highlighting. Colors are limited so we left :bgcolor option. (@rmarone)
+  * Added bookmarks and internal links. (@rmarone)
+
 #### v1.2.0
 
 * Enhancements

data/README.md

@@ -405,15 +405,16 @@ docx.p 'Sample text.'
 docx.p 'Sample text.', style: 'custom_style'
 
 docx.p 'Sample text.' do
-  style          'custom_style'    # sets the paragraph style. generally used at the exclusion of other attributes.
-  align          :left             # sets the alignment. accepts :left, :center, :right, and :both.
-  color          '333333'          # sets the font color.
-  size           32                # sets the font size. units in 1/2 points.
-  bold           true              # sets whether or not to render the text with a bold weight.
-  italic         false             # sets whether or not render the text in italic style.
-  underline      false             # sets whether or not to underline the text.
-  bgcolor        'cccccc'          # sets the background color.
-  vertical_align 'superscript'     # sets the vertical alignment.
+  style           'custom_style'    # sets the paragraph style. generally used at the exclusion of other attributes.
+  align           :left             # sets the alignment. accepts :left, :center, :right, and :both.
+  color           '333333'          # sets the font color.
+  size            32                # sets the font size. units in 1/2 points.
+  bold            true              # sets whether or not to render the text with a bold weight.
+  italic          false             # sets whether or not render the text in italic style.
+  underline       false             # sets whether or not to underline the text.
+  bgcolor         'cccccc'          # sets the background color.
+  highlight_color 'yellow'          # sets the highlight color. only accepts OOXML enumerations. see http://www.datypic.com/sc/ooxml/t-w_ST_HighlightColor.html.
+  vertical_align  'superscript'     # sets the vertical alignment.
 end
 ```
 
@@ -436,23 +437,50 @@ end
 
 Links can be added inside paragraphs using the `link` method.  The method accepts several optional parameters for controlling the style and behavior of the rule.
 
-*At present, all links are assumed to be external.*
-
 ```ruby
 p do
   link 'Example Text', 'https://wwww.example.com' do
-    font       'Courier New'  # sets the font name to use. defaults to nil.
-    color       '0000ff'      # sets the color of the text. defaults to 1155cc.
-    size        24            # sets the font size. units in half-points. defaults to nil.
-    bold        false         # sets whether or not the text will be bold. defaults to false.
-    italic      false         # sets whether or not the text will be italic. defaults to false.
-    underline   true          # sets whether or not the text will be underlined. defaults to true.
-    bgcolor     'cccccc'      # sets the background color.
+    internal        false             # sets whether or not the link references an external url. defaults to false.
+    font            'Courier New'     # sets the font name to use. defaults to nil.
+    color           '0000ff'          # sets the color of the text. defaults to 1155cc.
+    size            24                # sets the font size. units in half-points. defaults to nil.
+    bold            false             # sets whether or not the text will be bold. defaults to false.
+    italic          false             # sets whether or not the text will be italic. defaults to false.
+    underline       true              # sets whether or not the text will be underlined. defaults to true.
+    bgcolor         'cccccc'          # sets the background color.
+    highlight_color 'yellow'          # sets the highlight color. only accepts OOXML enumerations. see http://www.datypic.com/sc/ooxml/t-w_ST_HighlightColor.html.
   end
 end
 ```
 
 
+### Bookmarks
+
+Bookmarks can be added directly to the document or inside paragraph blocks using the `bookmark_start` and `bookmark_end`
+methods. Bookmarks can be inserted at the document-level to describe section headings, etc. or inside
+of a paragraph block for fine-grained linking.
+
+```ruby
+# document-level bookmark
+dox.bookmark_start id: 's1', name: 'section1'
+docx.h2 'Section Heading'
+docx.bookmark_end id: 's1'
+docx.p  'Section content.'
+
+# pargraph-level bookmark
+docx.h2 'Section Heading'
+docx.p do
+  text 'Pretend this paragraph has a lot of text and we want to bookmark '
+  bookmark_start id: 'p1', name: 'phrase1'
+  text 'a single phrase'
+  bookmark_end id: 'p1'
+  text ' inside the larger block.'
+end
+```
+
+Bookmarks work in conjunction with internal links.  Please see above.
+
+
 ### Headings
 
 Headings can be added using the `h1`, `h2`, `h3`, `h4`, `h5`, and `h6` methods.  Headings are simply paragraph commands with a specific style set, so anything you can do with a paragraph is available to a heading.
@@ -643,9 +671,9 @@ It is possible to merge cells vertically and horizontally using the `rowspan` an
 
 ```ruby
 docx.table [['11', '1213', '14'], ['21', '22', '23', '24']] do
-  cell_style rows[0][0], rowspan: 2 
-  cell_style rows[0][1], colspan: 2 
-  cell_style rows[0][2], rowspan: 2 
+  cell_style rows[0][0], rowspan: 2
+  cell_style rows[0][1], colspan: 2
+  cell_style rows[0][2], rowspan: 2
 end
 ```
 
@@ -659,10 +687,10 @@ If your table contains more complex data (multiple paragraphs, images, lists, et
 c1 = Caracal::Core::Models::TableCellModel.new do
   background 'cccccc'    # sets the background color. defaults to 'ffffff'.
   margins do
-    top                  # sets the top margin. defaults to 0. units in twips.
-    bottom               # sets the bottom margin. defaults to 0. units in twips.
-    left                 # sets the left margin. defaults to 0. units in twips.
-    right                # sets the right margin. defaults to 0. units in twips.
+    top                  # sets the top margin. defaults to 100. units in twips.
+    bottom               # sets the bottom margin. defaults to 100. units in twips.
+    left                 # sets the left margin. defaults to 100. units in twips.
+    right                # sets the right margin. defaults to 100. units in twips.
   end
 
   p 'This is a sentence above an image.'

data/lib/caracal/core/bookmarks.rb

@@ -0,0 +1,52 @@
+require 'caracal/core/models/bookmark_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to adding
+    # bookmarks to the document.
+    #
+    module Bookmarks
+      def self.included(base)
+        base.class_eval do
+
+          #------------------------------------------------
+          # Public Methods
+          #------------------------------------------------
+
+          #========== BOOKMARKS ===========================
+
+          def bookmark_start(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+            options.merge!({ start: true})
+
+            model = Caracal::Core::Models::BookmarkModel.new(options, &block)
+            if model.valid?
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'Bookmark starting tags require an id and a name.'
+            end
+            model
+          end
+
+          def bookmark_end(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+            options.merge!({ start: false})
+
+            model = Caracal::Core::Models::BookmarkModel.new(options, &block)
+            if model.valid?
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'Bookmark ending tags require an id.'
+            end
+            model
+          end
+          
+        end
+      end
+    end
+
+  end
+end

data/lib/caracal/core/models/bookmark_model.rb

@@ -0,0 +1,86 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class encapsulates the logic needed to store and manipulate
+      # bookmarks.
+      #
+      class BookmarkModel < BaseModel
+
+        #--------------------------------------------------
+        # Configuration
+        #--------------------------------------------------
+
+        # accessors
+        attr_reader :bookmark_start
+        attr_reader :bookmark_id
+        attr_reader :bookmark_name
+
+
+        #--------------------------------------------------
+        # Public Methods
+        #--------------------------------------------------
+
+        #========== GETTERS ===============================
+
+        # .run_attributes
+        def run_attributes
+          {
+            start:          bookmark_start,
+            id:             bookmark_id,
+            name:           bookmark_name
+          }
+        end
+
+
+        #========== SETTERS ===============================
+
+        # booleans
+        [:start].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@bookmark_#{ m }", !!value)
+          end
+        end
+
+        # strings
+        [:id, :name].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@bookmark_#{ m }", value.to_s)
+          end
+        end
+
+
+        #========== STATE HELPERS =========================
+
+        def start?
+          !!bookmark_start
+        end
+
+
+        #========== VALIDATION ============================
+
+        def valid?
+          a  = [:id]
+          a << :name  if start?
+
+          a.map { |m| send("bookmark_#{ m }") }.compact.size == a.size
+        end
+
+
+        #--------------------------------------------------
+        # Private Methods
+        #--------------------------------------------------
+        private
+
+        def option_keys
+          [:id, :name, :start]
+        end
+
+      end
+
+    end
+  end
+end

data/lib/caracal/core/models/link_model.rb

@@ -10,9 +10,9 @@ module Caracal
       #
       class LinkModel < TextModel
 
-        #-------------------------------------------------------------
+        #--------------------------------------------------
         # Configuration
-        #-------------------------------------------------------------
+        #--------------------------------------------------
 
         # constants
         const_set(:DEFAULT_LINK_COLOR,      '1155cc')
@@ -21,14 +21,17 @@ module Caracal
         # readers (create aliases for superclass methods to conform
         # to expected naming convention.)
         attr_reader  :link_href
-        alias_method :link_content,   :text_content
-        alias_method :link_font,      :text_font
-        alias_method :link_color,     :text_color
-        alias_method :link_size,      :text_size
-        alias_method :link_bold,      :text_bold
-        alias_method :link_italic,    :text_italic
-        alias_method :link_underline, :text_underline
-        alias_method :link_bgcolor,   :text_bgcolor
+        attr_reader  :link_internal
+        alias_method :link_content,         :text_content
+        alias_method :link_font,            :text_font
+        alias_method :link_color,           :text_color
+        alias_method :link_size,            :text_size
+        alias_method :link_bold,            :text_bold
+        alias_method :link_italic,          :text_italic
+        alias_method :link_underline,       :text_underline
+        alias_method :link_bgcolor,         :text_bgcolor
+        alias_method :link_highlight_color, :text_highlight_color
+        alias_method :link_vertical_align,  :text_vertical_align
 
         # initialization
         def initialize(options={}, &block)
@@ -39,11 +42,18 @@ module Caracal
         end
 
 
-        #-------------------------------------------------------------
+        #--------------------------------------------------
         # Public Instance Methods
-        #-------------------------------------------------------------
+        #--------------------------------------------------
 
-        #=============== SETTERS ==============================
+        #========== SETTERS ===============================
+
+        # booleans
+        [:internal].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@link_#{ m }", !!value)
+          end
+        end
 
         # strings
         [:href].each do |m|
@@ -53,7 +63,14 @@ module Caracal
         end
 
 
-        #=============== VALIDATION ===========================
+        #========== STATE HELPERS =========================
+
+        def external?
+          !link_internal
+        end
+
+
+        #========== VALIDATION ============================
 
         def valid?
           a = [:content, :href]
@@ -61,13 +78,13 @@ module Caracal
         end
 
 
-        #-------------------------------------------------------------
+        #--------------------------------------------------
         # Private Instance Methods
-        #-------------------------------------------------------------
+        #--------------------------------------------------
         private
 
         def option_keys
-          (super + [:href]).flatten
+          (super + [:internal, :href]).flatten
         end
 
       end

data/lib/caracal/core/models/paragraph_model.rb

@@ -1,4 +1,5 @@
 require 'caracal/core/models/base_model'
+require 'caracal/core/models/bookmark_model'
 require 'caracal/core/models/link_model'
 require 'caracal/core/models/text_model'
 require 'caracal/errors'
@@ -13,9 +14,9 @@ module Caracal
       #
       class ParagraphModel < BaseModel
 
-        #-------------------------------------------------------------
+        #--------------------------------------------------
         # Configuration
-        #-------------------------------------------------------------
+        #--------------------------------------------------
 
         # readers
         attr_reader :paragraph_style
@@ -35,11 +36,11 @@ module Caracal
         end
 
 
-        #-------------------------------------------------------------
+        #--------------------------------------------------
         # Public Instance Methods
-        #-------------------------------------------------------------
+        #--------------------------------------------------
 
-        #=============== GETTERS ==============================
+        #========== GETTERS ===============================
 
         # .runs
         def runs
@@ -59,7 +60,7 @@ module Caracal
         end
 
 
-        #=============== SETTERS ==============================
+        #========== SETTERS ===============================
 
         # booleans
         [:bold, :italic, :underline].each do |m|
@@ -90,7 +91,33 @@ module Caracal
         end
 
 
-        #=============== SUB-METHODS ===========================
+        #========== SUB-METHODS ===========================
+
+        # .bookmarks
+        def bookmark_start(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ start: true})
+
+          model = Caracal::Core::Models::BookmarkModel.new(options, &block)
+          if model.valid?
+            runs << model
+          else
+            raise Caracal::Errors::InvalidModelError, 'Bookmark starting tags require an id and a name.'
+          end
+          model
+        end
+        def bookmark_end(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ start: false})
+
+          model = Caracal::Core::Models::BookmarkModel.new(options, &block)
+          if model.valid?
+            runs << model
+          else
+            raise Caracal::Errors::InvalidModelError, 'Bookmark ending tags require an id.'
+          end
+          model
+        end
 
         # .br
         def br
@@ -136,16 +163,16 @@ module Caracal
         end
 
 
-        #=============== VALIDATION ===========================
+        #========== VALIDATION ============================
 
         def valid?
           runs.size > 0
         end
 
 
-        #-------------------------------------------------------------
+        #--------------------------------------------------
         # Private Instance Methods
-        #-------------------------------------------------------------
+        #--------------------------------------------------
         private
 
         def option_keys

data/lib/caracal/core/models/text_model.rb

@@ -24,6 +24,7 @@ module Caracal
         attr_reader :text_italic
         attr_reader :text_underline
         attr_reader :text_bgcolor
+        attr_reader :text_highlight_color
         attr_reader :text_vertical_align
 
 
@@ -37,15 +38,16 @@ module Caracal
         # .run_attributes
         def run_attributes
           {
-            style:          text_style,
-            font:           text_font,
-            color:          text_color,
-            size:           text_size,
-            bold:           text_bold,
-            italic:         text_italic,
-            underline:      text_underline,
-            bgcolor:        text_bgcolor,
-            vertical_align: text_vertical_align
+            style:            text_style,
+            font:             text_font,
+            color:            text_color,
+            size:             text_size,
+            bold:             text_bold,
+            italic:           text_italic,
+            underline:        text_underline,
+            bgcolor:          text_bgcolor,
+            highlight_color:  text_highlight_color,
+            vertical_align:   text_vertical_align
           }
         end
 
@@ -67,7 +69,7 @@ module Caracal
         end
 
         # strings
-        [:bgcolor, :color, :content, :font, :style].each do |m|
+        [:bgcolor, :color, :content, :font, :highlight_color, :style].each do |m|
           define_method "#{ m }" do |value|
             instance_variable_set("@text_#{ m }", value.to_s)
           end
@@ -95,7 +97,7 @@ module Caracal
         private
 
         def option_keys
-          [:content, :style, :font, :color, :size, :bold, :italic, :underline, :bgcolor, :vertical_align]
+          [:content, :style, :font, :color, :size, :bold, :italic, :underline, :bgcolor, :highlight_color, :vertical_align]
         end
 
         def method_missing(method, *args, &block)

data/lib/caracal/document.rb

@@ -1,6 +1,7 @@
 require 'open-uri'
 require 'zip'
 
+require 'caracal/core/bookmarks'
 require 'caracal/core/custom_properties'
 require 'caracal/core/file_name'
 require 'caracal/core/fonts'
@@ -53,6 +54,7 @@ module Caracal
     include Caracal::Core::Styles
     include Caracal::Core::ListStyles
 
+    include Caracal::Core::Bookmarks
     include Caracal::Core::IFrames
     include Caracal::Core::Images
     include Caracal::Core::Lists

data/lib/caracal/renderers/core_renderer.rb

@@ -41,4 +41,4 @@ module Caracal
    
     end
   end
-end
+end

data/lib/caracal/renderers/document_renderer.rb

@@ -82,6 +82,7 @@ module Caracal
                 xml['w'].i(         { 'w:val'  => (attrs[:italic] ? '1' : '0') })             unless attrs[:italic].nil?
                 xml['w'].u(         { 'w:val'  => (attrs[:underline] ? 'single' : 'none') })  unless attrs[:underline].nil?
                 xml['w'].shd(       { 'w:fill' => attrs[:bgcolor], 'w:val' => 'clear' })      unless attrs[:bgcolor].nil?
+                xml['w'].highlight( { 'w:val' => attrs[:highlight_color] })                   unless attrs[:highlight_color].nil?
                 xml['w'].vertAlign( { 'w:val' => attrs[:vertical_align] })                    unless attrs[:vertical_align].nil?
                 unless attrs[:font].nil?
                   f = attrs[:font]
@@ -97,6 +98,14 @@ module Caracal
 
       #============= MODEL RENDERERS ===========================
 
+      def render_bookmark(xml, model)
+        if model.start?
+          xml['w'].bookmarkStart({ 'w:id' => model.bookmark_id, 'w:name' => model.bookmark_name })
+        else
+          xml['w'].bookmarkEnd({ 'w:id' => model.bookmark_id })
+        end
+      end
+
       def render_iframe(xml, model)
         ::Zip::File.open(model.file) do |zip|
           a_href     = 'http://schemas.openxmlformats.org/drawingml/2006/main'
@@ -195,9 +204,14 @@ module Caracal
       end
 
       def render_link(xml, model)
-        rel = document.relationship({ target: model.link_href, type: :link })
+        if model.external?
+          rel = document.relationship({ target: model.link_href, type: :link })
+          hyperlink_options = { 'r:id' => rel.formatted_id }
+        else
+          hyperlink_options = { 'w:anchor' => model.link_href }
+        end
 
-        xml['w'].hyperlink({ 'r:id' => rel.formatted_id }) do
+        xml['w'].hyperlink(hyperlink_options) do
           xml['w'].r run_options do
             render_run_attributes(xml, model, false)
             xml['w'].t({ 'xml:space' => 'preserve' }, model.link_content)

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/lib/caracal/core/bookmarks_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Caracal::Core::Bookmarks do
+  subject { Caracal::Document.new }
+
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    # .bookmark_start
+    describe '.bookmark_start' do
+      let!(:size) { subject.contents.size }
+
+      before { subject.send('bookmark_start', id: '123', name: 'abc') }
+
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::BookmarkModel) }
+    end
+
+    # .bookmark_end
+    describe '.bookmark_end' do
+      let!(:size) { subject.contents.size }
+
+      before { subject.send('bookmark_end', id: '123') }
+
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::BookmarkModel) }
+    end
+
+  end
+
+end

data/spec/lib/caracal/core/models/bookmark_model_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Caracal::Core::Models::BookmarkModel do
+  subject do
+    described_class.new do
+      id      '0'
+      name    'myAnchor'
+      start   false
+    end
+  end
+
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+
+  describe 'configuration tests' do
+
+    # accessors
+    describe 'accessors' do
+      it { expect(subject.bookmark_id).to eq    '0' }
+      it { expect(subject.bookmark_name).to eq  'myAnchor' }
+      it { expect(subject.bookmark_start).to eq false }
+    end
+
+  end
+
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    #=============== GETTERS ==========================
+
+    # .run_attributes
+    describe '.run_attributes' do
+      let(:expected) { { id: '0', name: 'myAnchor', start: false} }
+
+      it { expect(subject.run_attributes).to eq expected }
+    end
+
+
+    #=============== SETTERS ==========================
+
+    # booleans
+    describe '.start' do
+      before { subject.start(true) }
+
+      it { expect(subject.bookmark_start).to eq true }
+    end
+
+    # strings
+    describe '.id' do
+      before { subject.id('dddddd') }
+
+      it { expect(subject.bookmark_id).to eq 'dddddd' }
+    end
+    describe '.name' do
+      before { subject.name('999999') }
+
+      it { expect(subject.bookmark_name).to eq '999999' }
+    end
+
+
+    #=============== STATE HELPERS ========================
+
+    describe '.start?' do
+      describe 'when start is true' do
+        before { subject.start(true) }
+
+        it { expect(subject.start?).to eq true }
+      end
+      describe 'when start is false' do
+        before { subject.start(false) }
+
+        it { expect(subject.start?).to eq false }
+      end
+    end
+
+
+    #=============== VALIDATION ===========================
+
+    describe '.valid?' do
+      describe 'when required attributes provided' do
+        it { expect(subject.valid?).to eq true }
+      end
+      describe 'when start is true' do
+        before { subject.start(true) }
+
+        [:id, :name].each do |prop|
+          describe "when #{ prop } is empty" do
+            before do
+              allow(subject).to receive("bookmark_#{ prop }").and_return(nil)
+            end
+
+            it { expect(subject.valid?).to eq false }
+          end
+        end
+      end
+      describe 'when start is false' do
+        before { subject.start(false) }
+
+        [:id].each do |prop|
+          describe "when #{ prop } is empty" do
+            before do
+              allow(subject).to receive("bookmark_#{ prop }").and_return(nil)
+            end
+
+            it { expect(subject.valid?).to eq false }
+          end
+        end
+      end
+    end
+
+  end
+
+
+  #-------------------------------------------------------------
+  # Private Methods
+  #-------------------------------------------------------------
+
+  describe 'private method tests' do
+
+    # .option_keys
+    describe '.option_keys' do
+      let(:actual)   { subject.send(:option_keys).sort }
+      let(:expected) { [:id, :name, :start].sort }
+
+      it { expect(actual).to eq expected }
+    end
+
+  end
+
+end

data/spec/lib/caracal/core/models/link_model_spec.rb

@@ -3,16 +3,18 @@ require 'spec_helper'
 describe Caracal::Core::Models::LinkModel do
   subject do
     described_class.new do
-      content         'Link Text'
-      href            'http://www.google.com'
-      font            'Courier New'
-      color           '666666'
-      size            20
-      bold            false
-      italic          false
-      underline       true
-      bgcolor         'cccccc'
-      vertical_align  :top
+      content           'Link Text'
+      href              'http://www.google.com'
+      internal          false
+      font              'Courier New'
+      color             '666666'
+      size              20
+      bold              false
+      italic            false
+      underline         true
+      bgcolor           'cccccc'
+      highlight_color   'yellow'
+      vertical_align    :top
     end
   end
 
@@ -32,6 +34,7 @@ describe Caracal::Core::Models::LinkModel do
     describe 'accessors' do
       it { expect(subject.link_content).to eq 'Link Text' }
       it { expect(subject.link_href).to eq 'http://www.google.com' }
+      it { expect(subject.link_internal).to eq false }
       it { expect(subject.link_font).to eq 'Courier New' }
       it { expect(subject.link_color).to eq '666666' }
       it { expect(subject.link_size).to eq 20 }
@@ -39,6 +42,8 @@ describe Caracal::Core::Models::LinkModel do
       it { expect(subject.link_italic).to eq false }
       it { expect(subject.link_underline).to eq true }
       it { expect(subject.link_bgcolor).to eq 'cccccc' }
+      it { expect(subject.link_highlight_color).to eq 'yellow' }
+      it { expect(subject.link_vertical_align).to eq :top }
     end
 
   end
@@ -54,7 +59,7 @@ describe Caracal::Core::Models::LinkModel do
 
     # .run_attributes
     describe '.run_attributes' do
-      let(:expected) { { style: nil, font: 'Courier New', color: '666666', size: 20, bold: false, italic: false, underline: true, bgcolor: 'cccccc', vertical_align: :top } }
+      let(:expected) { { style: nil, font: 'Courier New', color: '666666', size: 20, bold: false, italic: false, underline: true, bgcolor: 'cccccc', highlight_color: 'yellow', vertical_align: :top } }
 
       it { expect(subject.run_attributes).to eq expected }
     end
@@ -68,6 +73,11 @@ describe Caracal::Core::Models::LinkModel do
 
       it { expect(subject.link_bold).to eq true }
     end
+    describe '.internal' do
+      before { subject.internal(true) }
+
+      it { expect(subject.link_internal).to eq true }
+    end
     describe '.italic' do
       before { subject.italic(true) }
 
@@ -102,15 +112,31 @@ describe Caracal::Core::Models::LinkModel do
 
       it { expect(subject.link_content).to eq 'Something Else' }
     end
+    describe '.font' do
+      before { subject.font('Palantino') }
+
+      it { expect(subject.link_font).to eq 'Palantino' }
+    end
     describe '.href' do
       before { subject.href('http://www.google.com') }
 
       it { expect(subject.link_href).to eq 'http://www.google.com' }
     end
-    describe '.font' do
-      before { subject.font('Palantino') }
 
-      it { expect(subject.link_font).to eq 'Palantino' }
+
+    #=============== STATE HELPERS ========================
+
+    describe '.external?' do
+      describe 'when internal is true' do
+        before { subject.internal(true) }
+
+        it { expect(subject.external?).to eq false }
+      end
+      describe 'when internal is false' do
+        before { subject.internal(false) }
+
+        it { expect(subject.external?).to eq true }
+      end
     end
 
 
@@ -143,7 +169,7 @@ describe Caracal::Core::Models::LinkModel do
     # .option_keys
     describe '.option_keys' do
       let(:actual)   { subject.send(:option_keys).sort }
-      let(:expected) { [:content, :href, :style, :font, :color, :size, :bold, :italic, :underline, :bgcolor, :vertical_align].sort }
+      let(:expected) { [:content, :href, :internal, :style, :font, :color, :size, :bold, :highlight_color, :italic, :underline, :bgcolor, :vertical_align].sort }
 
       it { expect(actual).to eq expected }
     end

data/spec/lib/caracal/core/models/paragraph_model_spec.rb

@@ -137,6 +137,23 @@ describe Caracal::Core::Models::ParagraphModel do
       it { expect(subject.runs.size).to eq length + 1 }
     end
 
+    # .bookmark
+    describe '.bookmark_start' do
+      let!(:length) { subject.runs.length }
+
+      before { subject.bookmark_start(id:'1', name:'abc')}
+
+      it { expect(subject.runs.size).to eq length + 1 }
+    end
+
+    describe '.bookmark_end' do
+      let!(:length) { subject.runs.length }
+
+      before { subject.bookmark_end {id:'1'}}
+
+      it { expect(subject.runs.size).to eq length + 1 }
+    end
+
 
     #=============== VALIDATION ===========================
 

data/spec/lib/caracal/core/models/table_cell_model_spec.rb

@@ -220,7 +220,7 @@ describe Caracal::Core::Models::TableCellModel do
     # .option_keys
     describe '.option_keys' do
       let(:actual)     { subject.send(:option_keys).sort }
-      let(:expected)   { [:background, :width, :vertical_align, :margins].sort }
+      let(:expected)   { [:background, :colspan, :rowspan, :width, :vertical_align, :margins].sort }
       
       it { expect(actual).to eq expected }
     end

data/spec/lib/caracal/core/models/text_model_spec.rb

@@ -12,6 +12,7 @@ describe Caracal::Core::Models::TextModel do
       underline       true
       bgcolor         'cccccc'
       vertical_align  :subscript
+      highlight_color 'yellow'
     end
   end
 
@@ -31,6 +32,7 @@ describe Caracal::Core::Models::TextModel do
       it { expect(subject.text_italic).to eq false }
       it { expect(subject.text_underline).to eq true }
       it { expect(subject.text_bgcolor).to eq 'cccccc' }
+      it { expect(subject.text_highlight_color).to eq 'yellow' }
       it { expect(subject.text_vertical_align).to eq :subscript }
     end
 
@@ -47,7 +49,7 @@ describe Caracal::Core::Models::TextModel do
 
     # .run_attributes
     describe '.run_attributes' do
-      let(:expected) { { style: nil, font: 'Courier New', color: '666666', size: 20, bold: false, italic: false, underline: true, bgcolor: 'cccccc', vertical_align: :subscript } }
+      let(:expected) { { style: nil, font: 'Courier New', color: '666666', size: 20, bold: false, italic: false, underline: true, bgcolor: 'cccccc', highlight_color: 'yellow', vertical_align: :subscript } }
 
       it { expect(subject.run_attributes).to eq expected }
     end
@@ -81,9 +83,9 @@ describe Caracal::Core::Models::TextModel do
 
     # strings
     describe '.bgcolor' do
-      before { subject.color('dddddd') }
+      before { subject.bgcolor('dddddd') }
 
-      it { expect(subject.text_color).to eq 'dddddd' }
+      it { expect(subject.text_bgcolor).to eq 'dddddd' }
     end
     describe '.color' do
       before { subject.color('999999') }
@@ -100,6 +102,11 @@ describe Caracal::Core::Models::TextModel do
 
       it { expect(subject.text_font).to eq 'Palantino' }
     end
+    describe '.hightlight_color' do
+      before { subject.highlight_color('green') }
+
+      it { expect(subject.text_highlight_color).to eq 'green' }
+    end
 
     #symbols
     describe '.vertical_align' do
@@ -137,7 +144,7 @@ describe Caracal::Core::Models::TextModel do
     # .option_keys
     describe '.option_keys' do
       let(:actual)   { subject.send(:option_keys).sort }
-      let(:expected) { [:bgcolor, :bold, :color, :content, :font, :italic, :size, :style, :underline, :vertical_align].sort }
+      let(:expected) { [:bgcolor, :bold, :color, :content, :font, :highlight_color, :italic, :size, :style, :underline, :vertical_align].sort }
 
       it { expect(actual).to eq expected }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caracal
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Trade Infomatics
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -112,6 +112,7 @@ files:
 - Rakefile
 - caracal.gemspec
 - lib/caracal.rb
+- lib/caracal/core/bookmarks.rb
 - lib/caracal/core/custom_properties.rb
 - lib/caracal/core/file_name.rb
 - lib/caracal/core/fonts.rb
@@ -121,6 +122,7 @@ files:
 - lib/caracal/core/list_styles.rb
 - lib/caracal/core/lists.rb
 - lib/caracal/core/models/base_model.rb
+- lib/caracal/core/models/bookmark_model.rb
 - lib/caracal/core/models/border_model.rb
 - lib/caracal/core/models/custom_property_model.rb
 - lib/caracal/core/models/font_model.rb
@@ -170,6 +172,7 @@ files:
 - lib/caracal/utilities.rb
 - lib/caracal/version.rb
 - lib/tilt/caracal.rb
+- spec/lib/caracal/core/bookmarks_spec.rb
 - spec/lib/caracal/core/file_name_spec.rb
 - spec/lib/caracal/core/fonts_spec.rb
 - spec/lib/caracal/core/iframes_spec.rb
@@ -178,6 +181,7 @@ files:
 - spec/lib/caracal/core/list_styles_spec.rb
 - spec/lib/caracal/core/lists_spec.rb
 - spec/lib/caracal/core/models/base_model_spec.rb
+- spec/lib/caracal/core/models/bookmark_model_spec.rb
 - spec/lib/caracal/core/models/border_model_spec.rb
 - spec/lib/caracal/core/models/font_model_spec.rb
 - spec/lib/caracal/core/models/iframe_model_spec.rb
@@ -236,6 +240,7 @@ signing_key:
 specification_version: 4
 summary: Fast, professional Microsoft Word (docx) writer for Ruby.
 test_files:
+- spec/lib/caracal/core/bookmarks_spec.rb
 - spec/lib/caracal/core/file_name_spec.rb
 - spec/lib/caracal/core/fonts_spec.rb
 - spec/lib/caracal/core/iframes_spec.rb
@@ -244,6 +249,7 @@ test_files:
 - spec/lib/caracal/core/list_styles_spec.rb
 - spec/lib/caracal/core/lists_spec.rb
 - spec/lib/caracal/core/models/base_model_spec.rb
+- spec/lib/caracal/core/models/bookmark_model_spec.rb
 - spec/lib/caracal/core/models/border_model_spec.rb
 - spec/lib/caracal/core/models/font_model_spec.rb
 - spec/lib/caracal/core/models/iframe_model_spec.rb