caracal 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d6531d588b6cb5bb6a5c48941029510fdfce000
-  data.tar.gz: b7d7136f8e1dc0b126599e6f14b92aae20a925f4
+  metadata.gz: 1f3944130ad07554a021682f7365b9b6db126c8d
+  data.tar.gz: 358849a03c5e6806f77590a4eb3ce86de6c6a68e
 SHA512:
-  metadata.gz: 125ebdcb4425c9283651a28deb626244eca27ac179889e7d5d93aaa55ef998182cb144727552040786cf73cd4b6eae94524f57466a70b7bc022332aa26b9b2e3
-  data.tar.gz: e3b1762168958781a93605fa12591229cfb1c24a0fe300394783da2e83cb4b6347197287a99fbf09d6ed882f8c7fb256f1268a44170d2e789ddb6148ea7520e3
+  metadata.gz: c84b97f6fbbf1038db085d86205e2f50f74eb4c09f3aff1391ed65b8c111c1def9f05fba78027a36a7a626a6ecc2b95543e9737949d3190bd6cfdc1e7940f9d1
+  data.tar.gz: 2643cfcd452911dce56bb8cf96884021cd0d11ea4e041e35cc1af8a5ba45147b444237413d69c501d2d8e1acf8d23e06a579a69806e93eb4a3e24b4b052c3e60

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+#### v1.1.2
+
+* Enhancements
+  * Added font size options for page numbers. (@cfacello)
+
+#### v1.1.1
+
+* Enhancements
+  * Added character styles. (@xerespm)
+
+
 #### v1.1.0
 
 * Enhancements

data/README.md

@@ -300,17 +300,22 @@ docx.page     # starts a new page.
 
 ### Page Numbers
 
-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 can be added to the footer via the `page_numbers` method.  The method accepts optional parameters for controlling the alignment, label and size 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.
+  align        :right  # sets the alignment. accepts :left, :center, and :right.
+  label        'Page'  # sets the text that will go to the left of the page number. Defaults to nil.
+  size:        24      # sets the label and number size simultaneously. units in half points.
+  label_size:  24      # sets the label size only. units in half points.
+  number_size: 20      # sets the number size only. units in half points.
 end
 ```
 
+The `size` option and the `label_size` and `number_size` options are mutually exclusive.
+
 
 ### Fonts
 

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

@@ -21,13 +21,17 @@ module Caracal
         # accessors
         attr_reader :page_number_align
         attr_reader :page_number_label
+        attr_reader :page_number_label_size
+        attr_reader :page_number_number_size
         attr_reader :page_number_show
 
         # initialization
         def initialize(options={}, &block)
-          @page_number_align = DEFAULT_PAGE_NUMBER_ALIGN
-          @page_number_label = nil
-          @page_number_show  = DEFAULT_PAGE_NUMBER_SHOW
+          @page_number_align        = DEFAULT_PAGE_NUMBER_ALIGN
+          @page_number_label        = nil
+          @page_number_label_size   = nil
+          @page_number_number_size  = nil
+          @page_number_show         = DEFAULT_PAGE_NUMBER_SHOW
 
           super options, &block
         end
@@ -47,10 +51,26 @@ module Caracal
           @page_number_label = value.to_s.strip   # renderer will enforce trailing space
         end
 
+        def label_size(value)
+          v = value.to_i
+          @page_number_label_size = (v == 0) ? nil : v
+        end
+
+        def number_size(value)
+          v = value.to_i
+          @page_number_number_size = (v == 0) ? nil : v
+        end
+
         def show(value)
           @page_number_show = !!value
         end
 
+        def size(value)
+          v = value.to_i
+          @page_number_label_size  = (v == 0) ? nil : v
+          @page_number_number_size = (v == 0) ? nil : v
+        end
+
 
         #=============== VALIDATION ===========================
 
@@ -65,7 +85,7 @@ module Caracal
         private
 
         def option_keys
-          [:align, :label, :show]
+          [:align, :label, :label_size, :number_size, :show]
         end
 
       end

data/lib/caracal/core/page_numbers.rb

@@ -22,6 +22,8 @@ module Caracal
           # accessors
           attr_reader :page_number_align
           attr_reader :page_number_label
+          attr_reader :page_number_label_size
+          attr_reader :page_number_number_size
           attr_reader :page_number_show
 
 
@@ -34,13 +36,15 @@ module Caracal
           #
           def page_numbers(*args, &block)
             options = Caracal::Utilities.extract_options!(args)
-            options.merge!({ show: !!args.first }) unless args.first.nil?  # careful: falsey value
+            options.merge!({ show: !!args.first }) unless args.first.nil?  # careful: just `args.first` is falsey
 
             model = Caracal::Core::Models::PageNumberModel.new(options, &block)
             if model.valid?
-              @page_number_align = model.page_number_align
-              @page_number_label = model.page_number_label
-              @page_number_show  = model.page_number_show
+              @page_number_align        = model.page_number_align
+              @page_number_label        = model.page_number_label
+              @page_number_label_size   = model.page_number_label_size
+              @page_number_number_size  = model.page_number_number_size
+              @page_number_show         = model.page_number_show
             else
               raise Caracal::Errors::InvalidModelError, 'page_numbers :align parameter must be :left, :center, or :right'
             end

data/lib/caracal/renderers/footer_renderer.rb

@@ -26,16 +26,27 @@ module Caracal
                 xml['w'].r run_options do
                   xml['w'].rPr do
                     xml['w'].rStyle({ 'w:val' => 'PageNumber' })
+                    unless document.page_number_label_size.nil?
+                      xml['w'].sz({ 'w:val'  => document.page_number_label_size })
+                    end
                   end
                   xml['w'].t({ 'xml:space' => 'preserve' }) do
                     xml.text "#{ document.page_number_label } "
                   end
                 end
               end
-              xml['w'].fldSimple({ 'w:dirty' => '0', 'w:instr' => 'PAGE', 'w:fldLock' => '0' }) do
-                xml['w'].r run_options do
-                  xml['w'].rPr
+              xml['w'].r run_options do
+                xml['w'].rPr do
+                  unless document.page_number_number_size.nil?
+                    xml['w'].sz({ 'w:val'  => document.page_number_number_size })
+                    xml['w'].szCs({ 'w:val' => document.page_number_number_size })
+                  end
+                end
+                xml['w'].fldChar({ 'w:fldCharType' => 'begin' })
+                xml['w'].instrText({ 'xml:space' => 'preserve' }) do
+                  xml.text 'PAGE'
                 end
+                xml['w'].fldChar({ 'w:fldCharType' => 'end' })
               end
               xml['w'].r run_options do
                 xml['w'].rPr do

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

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

@@ -3,9 +3,11 @@ require 'spec_helper'
 describe Caracal::Core::Models::PageNumberModel do
   subject do
     described_class.new do
-      show  true
-      align :right
-      label 'Page'
+      show        true
+      align       :right
+      label       'Page'
+      label_size  24
+      number_size 20
     end
   end
 
@@ -24,6 +26,8 @@ describe Caracal::Core::Models::PageNumberModel do
     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_label_size).to eq 24 }
+      it { expect(subject.page_number_number_size).to eq 20 }
       it { expect(subject.page_number_show).to eq true }
     end
 
@@ -52,6 +56,20 @@ describe Caracal::Core::Models::PageNumberModel do
       it { expect(subject.page_number_label).to eq 'Page' }
     end
 
+    # .label_size
+    describe '.label_size' do
+      before { subject.label_size(28) }
+
+      it { expect(subject.page_number_label_size).to eq 28 }
+    end
+
+    # .number_size
+    describe '.number_size' do
+      before { subject.number_size(28) }
+
+      it { expect(subject.page_number_number_size).to eq 28 }
+    end
+
     # .show
     describe '.show' do
       before { subject.show(true) }
@@ -59,6 +77,14 @@ describe Caracal::Core::Models::PageNumberModel do
       it { expect(subject.page_number_show).to eq true }
     end
 
+    # .size
+    describe '.size' do
+      before { subject.size(32) }
+
+      it { expect(subject.page_number_label_size).to eq 32 }
+      it { expect(subject.page_number_number_size).to eq 32 }
+    end
+
 
     #=============== VALIDATIONS ==========================
 
@@ -100,7 +126,7 @@ describe Caracal::Core::Models::PageNumberModel do
     # .option_keys
     describe '.option_keys' do
       let(:actual)   { subject.send(:option_keys).sort }
-      let(:expected) { [:align, :label, :show].sort }
+      let(:expected) { [:align, :label, :label_size, :number_size, :show].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.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Trade Infomatics