caracal 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 182b527fbc16b0c6a5ae6c5cc2b77c307dc65f7c
-  data.tar.gz: ac8bd74712cfc75f7c9ac786d33de2b6be4ed3ac
+  metadata.gz: 8aeb4bbbf23d57b58d105f3cb14e93721476dccb
+  data.tar.gz: 24a30fd6c194b1ce00d29277a62937c956307494
 SHA512:
-  metadata.gz: a1e01da077541a289ff4b30e7dc0d6793f7cb7def0ddd8cca6b0480cdc80941fd52c04155d0f41d8572778d6425d09e765574b64f632d59212c7c36a7cac9411
-  data.tar.gz: 187ed9bfa2d8d5f182e7b4223506d69901756d8458c49868306d2033aee7c29ff49a6c4035ca12290ffd2ea965e767e3dc10e47a80d26c2441fec8aa49b04839
+  metadata.gz: 22d42de924ae632ff309b1c74254331d34ab37502a8115960964277657c5b655342439bac025f7ac3b9465126ee3ac1214bc2d8ba6b81f06576eed6d7ffd7feb
+  data.tar.gz: 75e87e2efd8f69ed0803316c5f84fb56812fb768457b6ac4a6d91ce0a16ea6e673f84ba42836314ae8fe3c4253e9998050d51a1bb022a934f9fa0fc03475d53e

data/README.md

@@ -256,13 +256,16 @@ docx.name    # => 'example_document.docx'
 ### Page Size
 
 Page dimensions can be set using the `page_size` method.  The method accepts two parameters for controlling the width and height of the document.
+It also accepts a third parameter for setting the page orientation.  If you want landscape orientation, you need to change both the page
+dimensions and the orientation explicitly.
 
 *Page size defaults to United States standard A4, portrait dimensions (8.5in x 11in).*
 
 ```ruby
 docx.page_size do
-  width   12240     # sets the page width. units in twips.
-  height  15840     # sets the page height. units in twips.
+  width       12240       # sets the page width. units in twips.
+  height      15840       # sets the page height. units in twips.
+  orientation :landscape  # sets the printer orientation. accepts :portrait and :landscape.
 end
 ```
 

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

@@ -4,67 +4,76 @@ require 'caracal/core/models/base_model'
 module Caracal
   module Core
     module Models
-      
+
       # This class handles block options passed to the page size
       # method.
       #
       class PageSizeModel < BaseModel
-        
+
         #-------------------------------------------------------------
         # Configuration
         #-------------------------------------------------------------
-        
+
         # constants
-        const_set(:DEFAULT_PAGE_WIDTH,  12240)  # 8.5in  in twips
-        const_set(:DEFAULT_PAGE_HEIGHT, 15840)  # 11.0in in twips
-        
+        const_set(:DEFAULT_PAGE_WIDTH,        12240)  # 8.5in  in twips
+        const_set(:DEFAULT_PAGE_HEIGHT,       15840)  # 11.0in in twips
+        const_set(:DEFAULT_PAGE_ORIENTATION,  'portrait')
+
         # accessors
         attr_reader :page_width
         attr_reader :page_height
-        
+        attr_reader :page_orientation
+
         # initialization
         def initialize(options={}, &block)
-          @page_width  = DEFAULT_PAGE_WIDTH
-          @page_height = DEFAULT_PAGE_HEIGHT
-          
+          @page_width       = DEFAULT_PAGE_WIDTH
+          @page_height      = DEFAULT_PAGE_HEIGHT
+          @page_orientation = DEFAULT_PAGE_ORIENTATION
+
           super options, &block
         end
-        
-        
+
+
         #-------------------------------------------------------------
         # Public Methods
         #-------------------------------------------------------------
-    
+
         #=============== SETTERS ==============================
-        
+
         def height(value)
           @page_height = value.to_i
         end
-        
+
+        def orientation(value)
+          allowed = ['landscape','portrait']
+          given   = value.to_s.downcase
+          @page_orientation = allowed.include?(given) ? given : 'portrait'
+        end
+
         def width(value)
           @page_width = value.to_i
         end
-        
-        
+
+
         #=============== VALIDATION ==============================
-        
+
         def valid?
           dims = [page_width, page_height]
           dims.all? { |d| d > 0 }
         end
-        
-        
+
+
         #-------------------------------------------------------------
         # Private Instance Methods
         #-------------------------------------------------------------
         private
-        
+
         def option_keys
-          [:width, :height]
+          [:width, :height, :orientation]
         end
-        
+
       end
-      
+
     end
   end
-end
+end

data/lib/caracal/core/page_settings.rb

@@ -5,32 +5,33 @@ 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 size and margins.
     #
     module PageSettings
       def self.included(base)
         base.class_eval do
-          
+
           #-------------------------------------------------------------
           # Configuration
           #-------------------------------------------------------------
-    
+
           # accessors
           attr_reader :page_width
+          attr_reader :page_orientation
           attr_reader :page_height
           attr_reader :page_margin_top
           attr_reader :page_margin_bottom
           attr_reader :page_margin_left
           attr_reader :page_margin_right
-          
-          
+
+
           #-------------------------------------------------------------
           # Public Methods
           #-------------------------------------------------------------
-    
-          # This method controls the physical margins of the printed page. Defaults 
+
+          # This method controls the physical margins of the printed page. Defaults
           # to 1in on each side.
           #
           def page_margins(options={}, &block)
@@ -49,24 +50,25 @@ module Caracal
               raise Caracal::Errors::InvalidModelError, 'page_margins method requires non-zero :top, :bottom, :left, and :right options.'
             end
           end
-          
-          # This method controls the physical width and height of the printed page. Defaults 
+
+          # This method controls the physical width and height of the printed page. Defaults
           # to US standard A4 portrait size.
           #
           def page_size(options={}, &block)
             model = Caracal::Core::Models::PageSizeModel.new(options, &block)
-            
+
             if model.valid?
-              @page_width  = model.page_width
-              @page_height = model.page_height
+              @page_width       = model.page_width
+              @page_height      = model.page_height
+              @page_orientation = model.page_orientation
             else
               raise Caracal::Errors::InvalidModelError, 'page_size method requires non-zero :width and :height options.'
             end
           end
-          
+
         end
       end
     end
-    
+
   end
-end
+end

data/lib/caracal/renderers/document_renderer.rb

@@ -357,8 +357,9 @@ module Caracal
 
       def page_size_options
         {
-          'w:w' => document.page_width,
-          'w:h' => document.page_height
+          'w:w'       => document.page_width,
+          'w:h'       => document.page_height,
+          'w:orient'  => document.page_orientation 
         }
       end
 

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '1.0.6'
+  VERSION = '1.0.7'
 end

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

@@ -1,59 +1,69 @@
 require 'spec_helper'
 
 describe Caracal::Core::Models::PageSizeModel do
-  subject do 
+  subject do
     described_class.new do
       width  15840
       height 12240
     end
   end
-  
+
   #-------------------------------------------------------------
   # Configuration
   #-------------------------------------------------------------
 
   describe 'configuration tests' do
-    
+
     # constants
     describe 'constants' do
       it { expect(described_class::DEFAULT_PAGE_WIDTH).to eq 12240 }
       it { expect(described_class::DEFAULT_PAGE_HEIGHT).to eq 15840 }
+      it { expect(described_class::DEFAULT_PAGE_ORIENTATION).to eq 'portrait' }
     end
-    
+
     # accessors
     describe 'accessors' do
       it { expect(subject.page_width).to eq 15840 }
       it { expect(subject.page_height).to eq 12240 }
     end
-    
+
   end
-  
-  
+
+
   #-------------------------------------------------------------
   # Public Methods
   #-------------------------------------------------------------
-  
+
   describe 'public method tests' do
-    
+
     #=============== SETTERS ==========================
-    
-    # .width
-    describe '.width' do
-      before { subject.width(10000) }
-      
-      it { expect(subject.page_width).to eq 10000 }
-    end
-    
+
     # .height
     describe '.height' do
       before { subject.height(10000) }
-      
+
       it { expect(subject.page_height).to eq 10000 }
     end
-    
-    
+
+    # .orientation
+    describe '.orientation' do
+      before { subject.orientation('landscape') }
+
+      it { expect(subject.page_orientation).to eq 'landscape' }
+    end
+
+    # .width
+    describe '.width' do
+      before { subject.width(10000) }
+
+      it { expect(subject.page_width).to eq 10000 }
+    end
+
+
+
+
     #=============== VALIDATION ===========================
-    
+
     describe '.valid?' do
       describe 'when all sizes gt 0' do
         it { expect(subject.valid?).to eq true }
@@ -63,29 +73,29 @@ describe Caracal::Core::Models::PageSizeModel do
           before do
             allow(subject).to receive("page_#{ d }").and_return(0)
           end
-        
+
           it { expect(subject.valid?).to eq false }
         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) { [:width, :height].sort }
-      
+      let(:expected) { [:width, :height, :orientation].sort }
+
       it { expect(actual).to eq expected }
     end
-    
+
   end
-  
-end
+
+end

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

@@ -2,18 +2,19 @@ require 'spec_helper'
 
 describe Caracal::Core::PageSettings do
   subject { Caracal::Document.new }
-  
-    
+
+
   #-------------------------------------------------------------
   # Configuration
   #-------------------------------------------------------------
 
   describe 'configuration tests' do
-    
+
     # readers
     describe 'page size readers' do
       it { expect(subject.page_width).to eq 12240 }
       it { expect(subject.page_height).to eq 15840 }
+      it { expect(subject.page_orientation).to eq 'portrait' }
     end
     describe 'page margin readers' do
       it { expect(subject.page_margin_top).to    eq 1440 }
@@ -21,67 +22,74 @@ describe Caracal::Core::PageSettings do
       it { expect(subject.page_margin_left).to   eq 1440 }
       it { expect(subject.page_margin_right).to  eq 1440 }
     end
-    
+
   end
-  
-  
+
+
   #-------------------------------------------------------------
   # Public Methods
   #-------------------------------------------------------------
 
   describe 'public methods tests' do
-    
+
     # .page_size
     describe '.page_size' do
       describe 'when options given' do
-        before { subject.page_size width: 10000, height: 12000 }
-        
+        before { subject.page_size width: 10000, height: 12000, orientation: :landscape }
+
         it { expect(subject.page_width).to eq 10000 }
         it { expect(subject.page_height).to eq 12000 }
+        it { expect(subject.page_orientation).to eq 'landscape' }
       end
       describe 'when block given' do
         before do
           subject.page_size do
-            width  10000
-            height 12000
+            width       10000
+            height      12000
+            orientation :landscape
           end
         end
-        
+
         it { expect(subject.page_width).to eq 10000 }
         it { expect(subject.page_height).to eq 12000 }
+        it { expect(subject.page_orientation).to eq 'landscape' }
       end
       describe 'when fancy block given' do
         subject do
           Caracal::Document.new do |docx|
             w = 10000
             h = 12000
+            o = :landscape
             docx.page_size do
-              width  w
-              height h
+              width       w
+              height      h
+              orientation o
             end
           end
         end
-        
+
         it { expect(subject.page_width).to eq 10000 }
         it { expect(subject.page_height).to eq 12000 }
+        it { expect(subject.page_orientation).to eq 'landscape' }
       end
       describe 'when both given' do
         before do
-          subject.page_size width: 10000 do
+          subject.page_size width: 10000, orientation: :landscape do
             height 12000
           end
         end
-        
+
         it { expect(subject.page_width).to eq 10000 }
         it { expect(subject.page_height).to eq 12000 }
+        it { expect(subject.page_orientation).to eq 'landscape' }
       end
     end
-    
+
     # .page_margins
     describe '.page_margins' do
       describe 'when options given' do
         before { subject.page_margins top: 1441, bottom: 1442, left: 1443, right: 1444 }
-        
+
         it { expect(subject.page_margin_top).to    eq 1441 }
         it { expect(subject.page_margin_bottom).to eq 1442 }
         it { expect(subject.page_margin_left).to   eq 1443 }
@@ -96,7 +104,7 @@ describe Caracal::Core::PageSettings do
             right  1444
           end
         end
-        
+
         it { expect(subject.page_margin_top).to    eq 1441 }
         it { expect(subject.page_margin_bottom).to eq 1442 }
         it { expect(subject.page_margin_left).to   eq 1443 }
@@ -117,7 +125,7 @@ describe Caracal::Core::PageSettings do
             end
           end
         end
-        
+
         it { expect(subject.page_margin_top).to    eq 1441 }
         it { expect(subject.page_margin_bottom).to eq 1442 }
         it { expect(subject.page_margin_left).to   eq 1443 }
@@ -130,14 +138,14 @@ describe Caracal::Core::PageSettings do
             right  1444
           end
         end
-        
+
         it { expect(subject.page_margin_top).to    eq 1441 }
         it { expect(subject.page_margin_bottom).to eq 1442 }
         it { expect(subject.page_margin_left).to   eq 1443 }
         it { expect(subject.page_margin_right).to  eq 1444 }
       end
     end
-    
+
   end
-  
-end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caracal
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Trade Infomatics
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2016-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri