axlsx 1.1.4 → 1.3.1

data/lib/axlsx/workbook/worksheet/data_validation.rb

@@ -0,0 +1,245 @@
+# encoding: UTF-8
+module Axlsx
+  # Data validation allows the validation of cell data
+  #
+  # @note The recommended way to manage data validations is via Worksheet#add_data_validation
+  # @see Worksheet#add_data_validation
+  class DataValidation
+    
+    # instance values that must be serialized as their own elements - e.g. not attributes.
+    CHILD_ELEMENTS = [:formula1, :formula2]
+    
+    # Formula1
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :formula1
+    
+    # Formula2
+    # Available for type whole, decimal, date, time, textLength
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :formula2
+    
+    # Allow Blank
+    # A boolean value indicating whether the data validation allows the use of empty or blank
+    # entries. 1 means empty entries are OK and do not violate the validation constraints.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [Boolean]
+    # default true
+    attr_reader :allowBlank
+    
+    # Error Message
+    # Message text of error alert.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :error
+    
+    # Error Style (ST_DataValidationErrorStyle)
+    # The style of error alert used for this data validation.
+    # Options are:
+    #  * information: This data validation error style uses an information icon in the error alert.
+    #  * stop: This data validation error style uses a stop icon in the error alert.
+    #  * warning: This data validation error style uses a warning icon in the error alert.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [Symbol]
+    # default :stop
+    attr_reader :errorStyle
+    
+    # Error Title
+    # Title bar text of error alert.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :errorTitle
+    
+    # Operator (ST_DataValidationOperator)
+    # The relational operator used with this data validation.
+    # Options are:
+    #  * between: Data validation which checks if a value is between two other values.
+    #  * equal: Data validation which checks if a value is equal to a specified value.
+    #  * greater_than: Data validation which checks if a value is greater than a specified value.
+    #  * greater_than_or_equal: Data validation which checks if a value is greater than or equal to a specified value.
+    #  * less_than: Data validation which checks if a value is less than a specified value.
+    #  * less_than_or_equal: Data validation which checks if a value is less than or equal to a specified value.
+    #  * not_between: Data validation which checks if a value is not between two other values.
+    #  * not_equal: Data validation which checks if a value is not equal to a specified value.
+    # Available for type whole, decimal, date, time, textLength
+    # @see type
+    # @return [Symbol]
+    # default nil
+    attr_reader :operator
+    
+    # Input prompt
+    # Message text of input prompt.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :prompt
+    
+    # Prompt title
+    # Title bar text of input prompt.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :promptTitle
+    
+    # Show drop down
+    # A boolean value indicating whether to display a dropdown combo box for a list type data
+    # validation. Be careful: false shows the dropdown list!
+    # Available for type list
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :showDropDown
+    
+    # Show error message
+    # A boolean value indicating whether to display the error alert message when an invalid
+    # value has been entered, according to the criteria specified.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :showErrorMessage
+    
+    # Show input message
+    # A boolean value indicating whether to display the input prompt message.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :showInputMessage
+    
+    # Range over which data validation is applied, in "A1:B2" format
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :sqref
+    
+    # The type (ST_DataValidationType) of data validation.
+    # Options are:
+    #  * custom: Data validation which uses a custom formula to check the cell value.
+    #  * date: Data validation which checks for date values satisfying the given condition.
+    #  * decimal: Data validation which checks for decimal values satisfying the given condition.
+    #  * list: Data validation which checks for a value matching one of list of values.
+    #  * none: No data validation.
+    #  * textLength: Data validation which checks for text values, whose length satisfies the given condition.
+    #  * time: Data validation which checks for time values satisfying the given condition.
+    #  * whole: Data validation which checks for whole number values satisfying the given condition.
+    # @return [Symbol]
+    # default none
+    attr_reader :type
+    
+    # Creates a new {DataValidation} object
+    # @option options [String] formula1
+    # @option options [String] formula2
+    # @option options [Boolean] allowBlank - A boolean value indicating whether the data validation allows the use of empty or blank entries.
+    # @option options [String] error - Message text of error alert.
+    # @option options [Symbol] errorStyle - The style of error alert used for this data validation.
+    # @option options [String] errorTitle - itle bar text of error alert.
+    # @option options [Symbol] operator - The relational operator used with this data validation.
+    # @option options [String] prompt - Message text of input prompt.
+    # @option options [String] promptTitle - Title bar text of input prompt.
+    # @option options [Boolean] showDropDown - A boolean value indicating whether to display a dropdown combo box for a list type data validation
+    # @option options [Boolean] showErrorMessage - A boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified.
+    # @option options [Boolean] showInputMessage - A boolean value indicating whether to display the input prompt message.
+    # @option options [String] sqref - Range over which data validation is applied, in "A1:B2" format.
+    # @option options [Symbol] type - The type of data validation.
+    def initialize(options={})
+      # defaults
+      @formula1 = @formula2 = @error = @errorTitle = @operator = @prompt = @promptTitle = @sqref = nil
+      @allowBlank = @showErrorMessage = true
+      @showDropDown = @showInputMessage = false
+      @type = :none
+      @errorStyle = :stop
+      
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+    
+    # @see formula1
+    def formula1=(v); Axlsx::validate_string(v); @formula1 = v end
+    
+    # @see formula2
+    def formula2=(v); Axlsx::validate_string(v); @formula2 = v end 
+    
+    # @see allowBlank
+    def allowBlank=(v); Axlsx::validate_boolean(v); @allowBlank = v end
+    
+    # @see error
+    def error=(v); Axlsx::validate_string(v); @error = v end
+    
+    # @see errorStyle
+    def errorStyle=(v); Axlsx::validate_data_validation_error_style(v); @errorStyle = v end
+    
+    # @see errorTitle
+    def errorTitle=(v); Axlsx::validate_string(v); @errorTitle = v end
+    
+    # @see operator
+    def operator=(v); Axlsx::validate_data_validation_operator(v); @operator = v end
+    
+    # @see prompt
+    def prompt=(v); Axlsx::validate_string(v); @prompt = v end
+    
+    # @see promptTitle
+    def promptTitle=(v); Axlsx::validate_string(v); @promptTitle = v end
+    
+    # @see showDropDown
+    def showDropDown=(v); Axlsx::validate_boolean(v); @showDropDown = v end
+    
+    # @see showErrorMessage
+    def showErrorMessage=(v); Axlsx::validate_boolean(v); @showErrorMessage = v end
+    
+    # @see showInputMessage
+    def showInputMessage=(v); Axlsx::validate_boolean(v); @showInputMessage = v end
+        
+    # @see sqref
+    def sqref=(v); Axlsx::validate_string(v); @sqref = v end
+    
+    # @see type
+    def type=(v); Axlsx::validate_data_validation_type(v); @type = v end
+    
+    # Serializes the data validation
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      valid_attributes = get_valid_attributes
+      
+      str << '<dataValidation '
+      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' if (valid_attributes.include?(key.to_sym) and not CHILD_ELEMENTS.include?(key.to_sym)) }.join(' ')
+      str << '>'
+      str << '<formula1>' << self.formula1 << '</formula1>' if @formula1 and valid_attributes.include?(:formula1)
+      str << '<formula2>' << self.formula2 << '</formula2>' if @formula2 and valid_attributes.include?(:formula2)
+      str << '</dataValidation>'
+    end
+    
+  private
+    def get_valid_attributes
+      attributes = [:allowBlank, :error, :errorStyle, :errorTitle, :prompt, :promptTitle, :showErrorMessage, :showInputMessage, :sqref, :type ]
+      
+      if [:whole, :decimal, :data, :time, :textLength].include?(@type)
+        attributes << [:operator, :formula1]
+        attributes << [:formula2] if [:between, :notBetween].include?(@operator)
+      elsif @type == :list
+        attributes << [:showDropDown, :formula1]
+      elsif @type == :custom
+        attributes << [:formula1]
+      else
+        attributes = []
+      end
+      
+      attributes.flatten!
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/data_validations.rb

@@ -0,0 +1,28 @@
+module Axlsx
+
+  # A simple, self serializing class for storing conditional formattings
+  class DataValidations < SimpleTypedList
+
+    # creates a new Tables object
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      super DataValidation
+      @worksheet = worksheet
+    end
+
+    # The worksheet that owns this collection of tables
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # serialize the conditional formattings
+    def to_xml_string(str = "")
+      return if empty?
+      str << "<dataValidations count='#{size}'>"
+      each { |item| item.to_xml_string(str) }
+      str << '</dataValidations>'
+    end
+  end
+
+end
+
+

data/lib/axlsx/workbook/worksheet/date_time_converter.rb

@@ -10,7 +10,7 @@ module Axlsx
     # @return [Numeric]
     def self.date_to_serial(date)
       epoch = Axlsx::Workbook::date1904 ? Date.new(1904) : Date.new(1899, 12, 30)
-      (date-epoch).to_f
+      (date - epoch).to_f
     end
 
     # The time_to_serial methond converts a Time object its excel serialized form.

data/lib/axlsx/workbook/worksheet/dimension.rb

@@ -0,0 +1,65 @@
+module Axlsx
+
+  # This class manages the dimensions for a worksheet.
+  # While this node is optional in the specification some readers like 
+  # LibraOffice require this node to render the sheet
+  class Dimension
+
+    # the default value for the first cell in the dimension
+    # @return [String]
+    def self.default_first
+      @@default_first ||= 'A1'
+    end
+
+    # the default value for the last cell in the dimension
+    # @return [String]
+    def self.default_last
+      @@default_last ||= 'AA200'
+    end
+
+
+    # Creates a new dimension object
+    # @param[Worksheet] worksheet - the worksheet this dimension applies
+    # to.
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # the full refernece for this dimension
+    # @return [String]
+    def sqref
+      "#{first_cell_reference}:#{last_cell_reference}"
+    end 
+
+    # serialize the object
+    # @return [String]
+    def to_xml_string(str = '')
+      return if worksheet.rows.empty?
+      str << "<dimension ref=\"%s\"></dimension>" % sqref
+    end
+
+    # The first cell in the dimension
+    # @return [String]
+    def first_cell_reference
+      dimension_reference(worksheet.rows.first.cells.first, Dimension.default_first)
+    end
+
+    # the last cell in the dimension
+    # @return [String]
+    def last_cell_reference
+      dimension_reference(worksheet.rows.last.cells.last, Dimension.default_last)
+    end
+
+    private
+
+    # Returns the reference of a cell or the default specified
+    # @return [String]
+    def dimension_reference(cell, default)
+      return default unless cell.respond_to?(:r)
+      cell.r
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/merged_cells.rb

@@ -0,0 +1,35 @@
+module Axlsx
+
+  # A simple list of merged cells
+  class MergedCells < SimpleTypedList
+
+    # creates a new MergedCells object
+    # @param [Worksheet] worksheet
+    def initialize(worksheet)
+      raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
+      super String
+    end
+
+    # adds cells to the merged cells collection
+    # @param [Array||String] cells The cells to add to the merged cells
+    # collection. This can be an array of actual cells or a string style
+    # range like 'A1:C1'
+    def add(cells)
+      @list << if cells.is_a?(String)
+                 cells
+               elsif cells.is_a?(Array)
+                 Axlsx::cell_range(cells, false)
+               end
+    end
+
+    # serialize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      return if @list.empty?
+      str << "<mergeCells count='#{size}'>"
+      each { |merged_cell| str << "<mergeCell ref='#{merged_cell}'></mergeCell>" }
+      str << '</mergeCells>'
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/page_set_up_pr.rb

@@ -0,0 +1,47 @@
+module Axlsx
+
+  # Page setup properties of the worksheet
+  # This class name is not a typo, its spec.
+  class PageSetUpPr
+
+    # creates a new page setup properties object
+    # @param [Hash] options
+    # @option [Boolean] auto_page_breaks Flag indicating whether the sheet displays Automatic Page Breaks.
+    # @option [Boolean] fit_to_page Flag indicating whether the Fit to Page print option is enabled.
+    def initialize(options = {})
+      options.each do |key, value|
+        self.send("#{key}=",value) if self.respond_to?("#{key}=")
+      end
+    end
+
+    attr_reader :auto_page_breaks
+    attr_reader :fit_to_page
+
+    # Flag indicating whether the Fit to Page print option is enabled.
+    # @param [Boolean] value
+    # @return [Boolean]
+    def fit_to_page=(value)
+      Axlsx.validate_boolean value
+      @fit_to_page = value
+    end
+
+    # Flag indicating whether the sheet displays Automatic Page Breaks.
+    # @param [Boolean] value
+    # @return [Boolean]
+    def auto_page_breaks=(value)
+      Axlsx.validate_boolean value
+      @auto_page_breaks = value
+    end
+
+    # serialize to xml
+    def to_xml_string(str='')
+      str << '<pageSetUpPr ' << serialized_attributes << '/>'
+    end
+
+    private
+
+    def serialized_attributes
+      instance_values.map { |key, value| "#{Axlsx.camel(key, false)}='#{value}'" }.join(' ')
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/page_setup.rb

@@ -0,0 +1,241 @@
+module Axlsx
+  # Page setup settings for printing a worksheet. All settings are optional.
+  #
+  # @note The recommended way to manage print options is via Worksheet#page_setup
+  # @see Worksheet#print_options
+  # @see Worksheet#initialize
+  class PageSetup
+
+    # TODO: Attributes defined by Open XML spec that are not implemented yet:
+    # 
+    # * blackAndWhite
+    # * cellComments
+    # * copies
+    # * draft
+    # * errors
+    # * firstPageNumber
+    # * horizontalDpi
+    # * pageOrder
+    # * paperSize
+    # * useFirstPageNumber
+    # * usePrinterDefaults
+    # * verticalDpi
+
+    # Number of vertical pages to fit on.
+    # @note PageSetup#fit_to is the recomended way to manage page fitting as only specifying one of fit_to_width/fit_to_height will result in the counterpart
+    # being set to 1.
+    # @return [Integer]
+    attr_reader :fit_to_height
+
+    # Number of horizontal pages to fit on.
+    # @note PageSetup#fit_to is the recomended way to manage page fitting as only specifying one of width/height will result in the counterpart
+    # being set to 1. 
+    # @return [Integer]
+    attr_reader :fit_to_width
+
+    # Orientation of the page (:default, :landscape, :portrait)
+    # @return [Symbol]
+    attr_reader :orientation 
+
+    # Height of paper (string containing a number followed by a unit identifier: "297mm", "11in")
+    # @return [String]
+    attr_reader :paper_height
+
+    # Width of paper (string containing a number followed by a unit identifier: "210mm", "8.5in")
+    # @return [String]
+    attr_reader :paper_width
+
+    # Print scaling (percent value, given as integer ranging from 10 to 400)
+    # @return [Integer]
+    attr_reader :scale
+
+    # The paper size to use in printing
+    #1 = Letter paper (8.5 in. by 11 in.)
+    #2 = Letter small paper (8.5 in. by 11 in.)
+    #3 = Tabloid paper (11 in. by 17 in.)
+    #4 = Ledger paper (17 in. by 11 in.)
+    #5 = Legal paper (8.5 in. by 14 in.)
+    #6 = Statement paper (5.5 in. by 8.5 in.)
+    #7 = Executive paper (7.25 in. by 10.5 in.)
+    #8 = A3 paper (297 mm by 420 mm)
+    #9 = A4 paper (210 mm by 297 mm)
+    #10 = A4 small paper (210 mm by 297 mm) 
+    #11 = A5 paper (148 mm by 210 mm)
+    #12 = B4 paper (250 mm by 353 mm)
+    #13 = B5 paper (176 mm by 250 mm)
+    #14 = Folio paper (8.5 in. by 13 in.)
+    #15 = Quarto paper (215 mm by 275 mm) 
+    #16 = Standard paper (10 in. by 14 in.)
+    #17 = Standard paper (11 in. by 17 in.)
+    #18 = Note paper (8.5 in. by 11 in.)
+    #19 = #9 envelope (3.875 in. by 8.875 in.) 
+    #20 = #10 envelope (4.125 in. by 9.5 in.) 
+    #21 = #11 envelope (4.5 in. by 10.375 in.) 
+    #22 = #12 envelope (4.75 in. by 11 in.)
+    #23 = #14 envelope (5 in. by 11.5 in.) 24 = C paper (17 in. by 22 in.)
+    #25 = D paper (22 in. by 34 in.)
+    #26 = E paper (34 in. by 44 in.)
+    #27 = DL envelope (110 mm by 220 mm)
+    #28 = C5 envelope (162 mm by 229 mm)
+    #29 = C3 envelope (324 mm by 458 mm)
+    #30 = C4 envelope (229 mm by 324 mm)
+    #31 = C6 envelope (114 mm by 162 mm)
+    #32 = C65 envelope (114 mm by 229 mm)
+    #33 = B4 envelope (250 mm by 353 mm)
+    #34 = B5 envelope (176 mm by 250 mm)
+    #35 = B6 envelope (176 mm by 125 mm)
+    #36 = Italy envelope (110 mm by 230 mm)
+    #37 = Monarch envelope (3.875 in. by 7.5 in.). 38 = 6 3/4 envelope (3.625 in. by 6.5 in.)
+    #39 = US standard fanfold (14.875 in. by 11 in.)
+    #40 = German standard fanfold (8.5 in. by 12 in.)
+    #41 = German legal fanfold (8.5 in. by 13 in.)
+    #42 = ISO B4 (250 mm by 353 mm)
+    #43 = Japanese double postcard (200 mm by 148 mm) 
+    #44 = Standard paper (9 in. by 11 in.)
+    #45 = Standard paper (10 in. by 11 in.)
+    #46 = Standard paper (15 in. by 11 in.)
+    #47 = Invite envelope (220 mm by 220 mm)
+    #50 = Letter extra paper (9.275 in. by 12 in.)
+    #51 = Legal extra paper (9.275 in. by 15 in.)
+    #52 = Tabloid extra paper (11.69 in. by 18 in.)
+    #53 = A4 extra paper (236 mm by 322 mm)
+    #54 = Letter transverse paper (8.275 in. by 11 in.)
+    #55 = A4 transverse paper (210 mm by 297 mm)
+    #56 = Letter extra transverse paper (9.275 in. by 12 in.) 
+    #57 = SuperA/SuperA/A4 paper (227 mm by 356 mm) 
+    #58 = SuperB/SuperB/A3 paper (305 mm by 487 mm) 
+    #59 = Letter plus paper (8.5 in. by 12.69 in.)
+    #60 = A4 plus paper (210 mm by 330 mm)
+    #61 = A5 transverse paper (148 mm by 210 mm)
+    #62 = JIS B5 transverse paper (182 mm by 257 mm)
+    #63 = A3 extra paper (322 mm by 445 mm)
+    #64 = A5 extra paper (174 mm by 235 mm)
+    #65 = ISO B5 extra paper (201 mm by 276 mm)
+    #66 = A2 paper (420 mm by 594 mm)
+    #67 = A3 transverse paper (297 mm by 420 mm)
+    #68 = A3 extra transverse paper (322 mm by 445 mm) 
+    #69 = Japanese Double Postcard (200 mm x 148 mm) 
+    #70 = A6 (105 mm x 148 mm
+    #71 = Japanese Envelope Kaku #2
+    #72 = Japanese Envelope Kaku #3
+    #73 = Japanese Envelope Chou #3
+    #74 = Japanese Envelope Chou #4
+    #75 = Letter Rotated (11in x 8 1/2 11 in)
+    #76 = A3 Rotated (420 mm x 297 mm)
+    #77 = A4 Rotated (297 mm x 210 mm)
+    #78 = A5 Rotated (210 mm x 148 mm)
+    #79 = B4 (JIS) Rotated (364 mm x 257 mm)
+    #80 = B5 (JIS) Rotated (257 mm x 182 mm)
+    #81 = Japanese Postcard Rotated (148 mm x 100 mm)
+    #82 = Double Japanese Postcard Rotated (148 mm x 200 mm) 
+    #83 = A6 Rotated (148 mm x 105 mm)
+    #84 = Japanese Envelope Kaku #2 Rotated
+    #85 = Japanese Envelope Kaku #3 Rotated
+    #86 = Japanese Envelope Chou #3 Rotated
+    #87 = Japanese Envelope Chou #4 Rotated
+    #88 = B6 (JIS) (128 mm x 182 mm)
+    #89 = B6 (JIS) Rotated (182 mm x 128 mm)
+    #90 = (12 in x 11 in)
+    #91 = Japanese Envelope You #4
+    #92 = Japanese Envelope You #4 Rotated
+    #93 = PRC 16K (146 mm x 215 mm)
+    #94 = PRC 32K (97 mm x 151 mm)
+    #95 = PRC 32K(Big) (97 mm x 151 mm)
+    #96 = PRC Envelope #1 (102 mm x 165 mm)
+    #97 = PRC Envelope #2 (102 mm x 176 mm)
+    #98 = PRC Envelope #3 (125 mm x 176 mm)
+    #99 = PRC Envelope #4 (110 mm x 208 mm)
+    #100 = PRC Envelope #5 (110 mm x 220 mm)
+    #101 = PRC Envelope #6 (120 mm x 230 mm)
+    #102 = PRC Envelope #7 (160 mm x 230 mm)
+    #103 = PRC Envelope #8 (120 mm x 309 mm)
+    #104 = PRC Envelope #9 (229 mm x 324 mm)
+    #105 = PRC Envelope #10 (324 mm x 458 mm)
+    #106 = PRC 16K Rotated
+    #107 = PRC 32K Rotated
+    #108 = PRC 32K(Big) Rotated
+    #109 = PRC Envelope #1 Rotated (165 mm x 102 mm)
+    #110 = PRC Envelope #2 Rotated (176 mm x 102 mm)
+    #111 = PRC Envelope #3 Rotated (176 mm x 125 mm)
+    #112 = PRC Envelope #4 Rotated (208 mm x 110 mm)
+    #113 = PRC Envelope #5 Rotated (220 mm x 110 mm)
+    #114 = PRC Envelope #6 Rotated (230 mm x 120 mm)
+    #115 = PRC Envelope #7 Rotated (230 mm x 160 mm)
+    #116 = PRC Envelope #8 Rotated (309 mm x 120 mm)
+    #117 = PRC Envelope #9 Rotated (324 mm x 229 mm)
+    #118 = PRC Envelope #10 Rotated (458 mm x 324 mm)
+    # @return [Integer]
+    attr_reader :paper_size
+
+
+    # Sets the paper size for printing.
+    # @see PageSetup#paper_size
+    # @return integer
+    def paper_size=(size)
+      RestrictionValidator.validate 'paper_size', (1..118), size
+      @paper_size = size
+    end
+
+    # Creates a new PageSetup object
+    # @option options [Integer] fit_to_height Number of vertical pages to fit on
+    # @option options [Integer] fit_to_width Number of horizontal pages to fit on
+    # @option options [Symbol] orientation Orientation of the page (:default, :landscape, :portrait)
+    # @option options [String] paper_height Height of paper (number followed by unit identifier: "297mm", "11in")
+    # @option options [String] paper_width Width of paper (number followed by unit identifier: "210mm", "8.5in")
+    # @option options [Integer] scale Print scaling (percent value, integer ranging from 10 to 400)
+    # @option options [Integer] paper_size - the size of paper to use
+    def initialize(options = {})
+      set(options)
+    end
+
+    # Set some or all page settings at once.
+    # @param [Hash] options The page settings to set (possible keys are :fit_to_height, :fit_to_width, :orientation, :paper_height, :paper_width, and :scale).
+    def set(options)
+      options.each do |k, v|
+        send("#{k}=", v) if respond_to? "#{k}="
+      end
+    end
+
+    # @see fit_to_height
+    def fit_to_height=(v); Axlsx::validate_unsigned_int(v); @fit_to_height = v; end
+    # @see fit_to_width
+    def fit_to_width=(v); Axlsx::validate_unsigned_int(v); @fit_to_width = v; end
+    # @see orientation
+    def orientation=(v); Axlsx::validate_page_orientation(v); @orientation = v; end
+    # @see paper_height
+    def paper_height=(v); Axlsx::validate_number_with_unit(v); @paper_height = v; end
+    # @see paper_width
+    def paper_width=(v); Axlsx::validate_number_with_unit(v); @paper_width = v; end
+    # @see scale
+    def scale=(v); Axlsx::validate_scale_10_400(v); @scale = v; end
+
+    # convenience method to achieve sanity when setting fit_to_width and fit_to_height 
+    # as they both default to 1 if only their counterpart is specified.
+    # @note This method will overwrite any value you explicitly set via the fit_to_height or fit_to_width methods.
+    # @option options [Integer] width The number of pages to fit this worksheet on horizontally. Default 9999
+    # @option options [Integer] height The number of pages to fit this worksheet on vertically. Default 9999
+    def fit_to(options={})
+      self.fit_to_width = options[:width] || 9999
+      self.fit_to_height = options[:height] || 9999
+      [@fit_to_width, @fit_to_height]
+    end
+
+
+    # helper method for worksheet to determine if the page setup is configured for fit to page printing
+    # We treat any page set up that has a value set for fit_to_width or fit_to_height value as fit_to_page. 
+    # @return [Boolean]
+    def fit_to_page?
+      # is there some better what to express this?
+      (fit_to_width != nil || fit_to_height != nil)
+    end
+
+    # Serializes the page settings element.
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<pageSetup '
+      str << instance_values.reject{ |k, v| k == 'worksheet' }.map{ |k,v| k.gsub(/_(.)/){ $1.upcase } << %{="#{v}"} }.join(' ')
+      str << '/>'
+    end
+  end
+end