caracal 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b18e4eda1bbb02a4efb9191d1c65d99701e54800
-  data.tar.gz: 5720059a89acdabe4f278fff2abb6c08c40ffb99
+  metadata.gz: 0d2efc2b19a3ae0483703f88497fb42bbf876f9e
+  data.tar.gz: 2dcd3fb0074ddc334878eb00339dc27ad7ec30aa
 SHA512:
-  metadata.gz: 707f70ec9a572317a0bef6d04cb44c7247b9e7d7b1d5baa7d8176eb4297eedfb5a405d8aeeebf7af29827b98955e5582fadb77bdafadce38fa399c15b65d5888
-  data.tar.gz: ef395004b3eef312499f6ea2db4465ec50409f0a75580289d41cd10a98ccec0d0e6942bd651b4059387560dcbf4254488e0dadcdf4338836a2cf204c301e3adc
+  metadata.gz: 5539dbe580138147f1c3c036d2147790085178a4fd2b60dfb54e0b545fab050f52a1c10bf5ff591354c6d14712ce8ff9f8f5a31254adee2a60abf4b781be59c5
+  data.tar.gz: 39f1c998d281aaa798f52310c4346721e1e39e81d1c4821ad99c6d7026603a27a0c3bba8d9804a45f6977404907de3badd9b1d57c674781e458ca659405411b2

data/README.md

@@ -301,12 +301,13 @@ docx.page     # starts a new page.
 
 ### Page Numbers
 
-Page numbers can be added to the footer via the `page_numbers` method.  The method accepts an optional parameter for controlling the alignment of the text.
+Page numbers can be added to the footer via the `page_numbers` method.  The method accepts optional parameters for controlling the label and alignment of the text.
 
 *Page numbers are turned off by default.*
 
 ```ruby
 docx.page_numbers true do
+  label 'Page'     # sets the text that will go to the left of the page number. Defaults to nil.
   align :right     # sets the alignment. accepts :left, :center, and :right.
 end
 ```

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

@@ -4,66 +4,72 @@ require 'caracal/core/models/base_model'
 module Caracal
   module Core
     module Models
-      
+
       # This class handles block options passed to the page_numbers
       # method.
       #
       class PageNumberModel < BaseModel
-        
+
         #-------------------------------------------------------------
         # Configuration
         #-------------------------------------------------------------
-        
+
         # constants
-        const_set(:DEFAULT_PAGE_NUMBER_SHOW,  false)
         const_set(:DEFAULT_PAGE_NUMBER_ALIGN, :center)
-        
+        const_set(:DEFAULT_PAGE_NUMBER_SHOW,  false)
+
         # accessors
         attr_reader :page_number_align
+        attr_reader :page_number_label
         attr_reader :page_number_show
-        
+
         # initialization
         def initialize(options={}, &block)
-          @page_number_show  = DEFAULT_PAGE_NUMBER_SHOW
           @page_number_align = DEFAULT_PAGE_NUMBER_ALIGN
-          
+          @page_number_label = nil
+          @page_number_show  = DEFAULT_PAGE_NUMBER_SHOW
+
           super options, &block
         end
-        
-        
+
+
         #-------------------------------------------------------------
         # Public Methods
         #-------------------------------------------------------------
-    
+
         #=============== SETTERS ==============================
-        
+
         def align(value)
           @page_number_align = value.to_s.to_sym
         end
-        
+
+        def label(value)
+          @page_number_label = value.to_s.strip   # renderer will enforce trailing space
+        end
+
         def show(value)
           @page_number_show = !!value
         end
-        
-        
+
+
         #=============== VALIDATION ===========================
-        
+
         def valid?
           (!page_number_show || [:left, :center, :right].include?(page_number_align))
         end
-        
-        
+
+
         #-------------------------------------------------------------
         # Private Instance Methods
         #-------------------------------------------------------------
         private
-        
+
         def option_keys
-          [:align, :show]
+          [:align, :label, :show]
         end
-        
+
       end
-      
+
     end
   end
-end
+end

data/lib/caracal/core/page_numbers.rb

@@ -4,49 +4,51 @@ require 'caracal/errors'
 
 module Caracal
   module Core
-    
-    # This module encapsulates all the functionality related to setting the 
+
+    # This module encapsulates all the functionality related to setting the
     # document's page number behavior.
     #
     module PageNumbers
       def self.included(base)
         base.class_eval do
-          
+
           #-------------------------------------------------------------
           # Configuration
           #-------------------------------------------------------------
-    
+
           # constants
           const_set(:DEFAULT_PAGE_NUMBER_ALIGN,  :center)
-          
+
           # accessors
-          attr_reader :page_number_show
           attr_reader :page_number_align
-          
-          
+          attr_reader :page_number_label
+          attr_reader :page_number_show
+
+
           #-------------------------------------------------------------
           # Public Methods
           #-------------------------------------------------------------
-    
+
           # This method controls whether and how page numbers are displayed
           # on the document.
           #
           def page_numbers(*args, &block)
             options = Caracal::Utilities.extract_options!(args)
             options.merge!({ show: !!args.first }) unless args.first.nil?  # careful: falsey value
-            
+
             model = Caracal::Core::Models::PageNumberModel.new(options, &block)
             if model.valid?
-              @page_number_show  = model.page_number_show
               @page_number_align = model.page_number_align
+              @page_number_label = model.page_number_label
+              @page_number_show  = model.page_number_show
             else
               raise Caracal::Errors::InvalidModelError, 'page_numbers :align parameter must be :left, :center, or :right'
             end
           end
-          
+
         end
       end
     end
-    
+
   end
-end
+end

data/lib/caracal/renderers/footer_renderer.rb

@@ -6,12 +6,12 @@ require 'caracal/renderers/xml_renderer'
 module Caracal
   module Renderers
     class FooterRenderer < XmlRenderer
-      
+
       #-------------------------------------------------------------
       # Public Methods
       #-------------------------------------------------------------
-      
-      # This method produces the xml required for the `word/settings.xml` 
+
+      # This method produces the xml required for the `word/settings.xml`
       # sub-document.
       #
       def to_xml
@@ -22,6 +22,16 @@ module Caracal
                 xml.send 'w:contextualSpacing', { 'w:val' => '0' }
                 xml.send 'w:jc', { 'w:val' => "#{ document.page_number_align }" }
               end
+              if document.page_number_label.present?
+                xml.send 'w:r', run_options do
+                  xml.send 'w:rPr' do
+                    xml.send 'w:rStyle', { 'w:val' => 'PageNumber' }
+                  end
+                  xml.send 'w:t', { 'xml:space' => 'preserve' } do
+                    xml.text "#{ document.page_number_label } "
+                  end
+                end
+              end
               xml.send 'w:fldSimple', { 'w:dirty' => '0', 'w:instr' => 'PAGE', 'w:fldLock' => '0' } do
                 xml.send 'w:r', run_options do
                   xml.send 'w:rPr'
@@ -37,13 +47,13 @@ module Caracal
         end
         builder.to_xml(save_options)
       end
-      
-      
+
+
       #-------------------------------------------------------------
       # Private Methods
-      #------------------------------------------------------------- 
+      #-------------------------------------------------------------
       private
-      
+
       def root_options
         {
           'xmlns:mc'  => 'http://schemas.openxmlformats.org/markup-compatibility/2006',
@@ -63,7 +73,7 @@ module Caracal
           'xmlns:dgm' => 'http://schemas.openxmlformats.org/drawingml/2006/diagram'
         }
       end
-   
+
     end
   end
-end
+end

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '1.0.8'
+  VERSION = '1.0.9'
 end

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

@@ -1,64 +1,73 @@
 require 'spec_helper'
 
 describe Caracal::Core::Models::PageNumberModel do
-  subject do 
+  subject do
     described_class.new do
       show  true
       align :right
+      label 'Page'
     end
   end
-  
+
   #-------------------------------------------------------------
   # Configuration
   #-------------------------------------------------------------
 
   describe 'configuration tests' do
-    
+
     # constants
     describe 'constants' do
       it { expect(described_class::DEFAULT_PAGE_NUMBER_ALIGN).to eq :center }
     end
-    
+
     # accessors
     describe 'accessors' do
       it { expect(subject.page_number_align).to eq :right }
+      it { expect(subject.page_number_label).to eq 'Page' }
       it { expect(subject.page_number_show).to eq true }
     end
-    
+
   end
-  
-  
+
+
   #-------------------------------------------------------------
   # Public Methods
   #-------------------------------------------------------------
-  
+
   describe 'public method tests' do
-    
+
     #=============== SETTERS ==============================
-    
+
     # .align
     describe '.align' do
       before { subject.align(:left) }
-      
+
       it { expect(subject.page_number_align).to eq :left }
     end
-    
+
+    # .label
+    describe '.label' do
+      before { subject.label('Page') }
+
+      it { expect(subject.page_number_label).to eq 'Page' }
+    end
+
     # .show
     describe '.show' do
       before { subject.show(true) }
-      
+
       it { expect(subject.page_number_show).to eq true }
     end
-    
-    
+
+
     #=============== VALIDATIONS ==========================
-    
+
     describe '.valid?' do
       describe 'when show is false' do
         before do
           allow(subject).to receive(:page_number_show).and_return(false)
         end
-        
+
         it { expect(subject.valid?).to eq true }
       end
       describe 'when show is true and align is valid' do
@@ -66,7 +75,7 @@ describe Caracal::Core::Models::PageNumberModel do
           allow(subject).to receive(:page_number_show).and_return(true)
           allow(subject).to receive(:page_number_align).and_return(:left)
         end
-        
+
         it { expect(subject.valid?).to eq true }
       end
       describe 'when show is true and align is invalid' do
@@ -74,28 +83,28 @@ describe Caracal::Core::Models::PageNumberModel do
           allow(subject).to receive(:page_number_show).and_return(true)
           allow(subject).to receive(:page_number_align).and_return(:dummy)
         end
-        
+
         it { expect(subject.valid?).to eq false }
       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) { [:align, :show].sort }
-      
+      let(:expected) { [:align, :label, :show].sort }
+
       it { expect(actual).to eq expected }
     end
-    
+
   end
-  
-end
+
+end

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

@@ -2,79 +2,88 @@ require 'spec_helper'
 
 describe Caracal::Core::PageSettings do
   subject { Caracal::Document.new }
-  
-    
+
+
   #-------------------------------------------------------------
   # Configuration
   #-------------------------------------------------------------
 
   describe 'configuration tests' do
-    
+
     # constants
     describe 'page number constants' do
       it { expect(subject.class::DEFAULT_PAGE_NUMBER_ALIGN).to  eq :center }
     end
-      
+
     # readers
     describe 'page number readers' do
-      it { expect(subject.page_number_show).to eq false }
       it { expect(subject.page_number_align).to eq :center }
+      it { expect(subject.page_number_label).to eq nil }
+      it { expect(subject.page_number_show).to eq false }
     end
-    
+
   end
-  
-  
+
+
   #-------------------------------------------------------------
   # Public Methods
   #-------------------------------------------------------------
 
   describe 'public methods tests' do
-    
+
     # .page_numbers
     describe '.page_numbers' do
       describe 'when nothing given' do
         before { subject.page_numbers }
-        
-        it { expect(subject.page_number_show).to eq false }
+
         it { expect(subject.page_number_align).to eq :center }
+        it { expect(subject.page_number_label).to eq nil }
+        it { expect(subject.page_number_show).to eq false }
       end
       describe 'when explicitly turned off' do
         before { subject.page_numbers false }
-        
-        it { expect(subject.page_number_show).to eq false }
+
         it { expect(subject.page_number_align).to eq :center }
+        it { expect(subject.page_number_label).to eq nil }
+        it { expect(subject.page_number_show).to eq false }
       end
       describe 'when options given' do
-        before { subject.page_numbers true, align: :left }
-        
-        it { expect(subject.page_number_show).to eq true }
+        before { subject.page_numbers true, label: 'Custom Text', align: :left }
+
         it { expect(subject.page_number_align).to eq :left }
+        it { expect(subject.page_number_label).to eq 'Custom Text' }
+        it { expect(subject.page_number_show).to eq true }
       end
       describe 'when block given' do
         before do
           subject.page_numbers true do
             align :left
+            label 'More Text'
           end
         end
-        
-        it { expect(subject.page_number_show).to eq true }
+
         it { expect(subject.page_number_align).to eq :left }
+        it { expect(subject.page_number_label).to eq 'More Text' }
+        it { expect(subject.page_number_show).to eq true }
       end
       describe 'when fancy block given' do
         subject do
           Caracal::Document.new do |docx|
+            t = 'This is text'
             a = :left
             docx.page_numbers true do
+              label t
               align a
             end
           end
         end
-        
-        it { expect(subject.page_number_show).to eq true }
+
         it { expect(subject.page_number_align).to eq :left }
+        it { expect(subject.page_number_label).to eq 'This is text' }
+        it { expect(subject.page_number_show).to eq true }
       end
     end
-    
+
   end
-  
-end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caracal
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Trade Infomatics
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Fast, professional MSWord writer for Ruby.
@@ -260,4 +260,3 @@ test_files:
 - spec/lib/caracal/core/text_spec.rb
 - spec/lib/caracal/errors_spec.rb
 - spec/spec_helper.rb
-has_rdoc: