axlsx 1.2.0 → 2.0.0

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

@@ -7,8 +7,24 @@ module Axlsx
   # @see ConditionalFormattingRule#initialize
   class IconSet
 
-    # instance values that must be serialized as their own elements - e.g. not attributes.
-    CHILD_ELEMENTS = [:value_objects]
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new icon set object
+    # @option options [String] iconSet
+    # @option options [Boolean] reverse
+    # @option options [Boolean] percent
+    # @option options [Boolean] showValue
+    def initialize(options = {})
+      @percent = @showValue = true
+      @reverse = false
+      @iconSet = "3TrafficLights1"
+      initialize_value_objects
+      parse_options options
+      yield self if block_given?
+    end
+
+    serializable_attributes :iconSet, :percent, :reverse, :showValue
 
     # The icon set to display.
     # Allowed values are: 3Arrows, 3ArrowsGray, 3Flags, 3TrafficLights1, 3TrafficLights2, 3Signs, 3Symbols, 3Symbols2, 4Arrows, 4ArrowsGray, 4RedToBlack, 4Rating, 4TrafficLights, 5Arrows, 5ArrowsGray, 5Rating, 5Quarters
@@ -31,23 +47,7 @@ module Axlsx
     # @return [Boolean]
     attr_reader :showValue
 
-    # Creates a new icon set object
-    # @option options [String] iconSet
-    # @option options [Boolean] reverse
-    # @option options [Boolean] percent
-    # @option options [Boolean] showValue
-    def initialize(options = {})
-      @percent = @showValue = true
-      @reverse = false
-      @iconSet = "3TrafficLights1"
-      initialize_value_objects
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      yield self if block_given?
-    end
-
-    # @see iconSet
+      # @see iconSet
     def iconSet=(v); Axlsx::validate_icon_set(v); @iconSet = v end
 
     # @see showValue
@@ -64,7 +64,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str="")
       str << '<iconSet '
-      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' unless CHILD_ELEMENTS.include?(key.to_sym) }.join(' ')
+      serialized_attributes str
       str << '>'
       @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
       str << '</iconSet>'

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

@@ -10,6 +10,26 @@ module Axlsx
   # @see Worksheet#initialize
   class PageMargins
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new PageMargins object
+    # @option options [Numeric] left The left margin in inches
+    # @option options [Numeric] right The right margin in inches
+    # @option options [Numeric] bottom The bottom margin in inches
+    # @option options [Numeric] top The top margin in inches
+    # @option options [Numeric] header The header margin in inches
+    # @option options [Numeric] footer The footer margin in inches
+    def initialize(options={})
+      # Default values taken from MS Excel for Mac 2011
+      @left = @right = DEFAULT_LEFT_RIGHT
+      @top = @bottom = DEFAULT_TOP_BOTTOM
+      @header = @footer = DEFAULT_HEADER_FOOTER
+      parse_options options
+    end
+
+    serializable_attributes :left, :right, :bottom, :top, :header, :footer
+
     # Default left and right margin (in inches)
     DEFAULT_LEFT_RIGHT = 0.75
 
@@ -43,24 +63,6 @@ module Axlsx
     # @return [Float]
     attr_reader :footer
 
-    # Creates a new PageMargins object
-    # @option options [Numeric] left The left margin in inches
-    # @option options [Numeric] right The right margin in inches
-    # @option options [Numeric] bottom The bottom margin in inches
-    # @option options [Numeric] top The top margin in inches
-    # @option options [Numeric] header The header margin in inches
-    # @option options [Numeric] footer The footer margin in inches
-    def initialize(options={})
-      # Default values taken from MS Excel for Mac 2011
-      @left = @right = DEFAULT_LEFT_RIGHT
-      @top = @bottom = DEFAULT_TOP_BOTTOM
-      @header = @footer = DEFAULT_HEADER_FOOTER
-
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
     # Set some or all margins at once.
     # @param [Hash] margins the margins to set (possible keys are :left, :right, :top, :bottom, :header and :footer).
     def set(margins)
@@ -90,7 +92,7 @@ module Axlsx
     # @see #custom_margins_specified?
     def to_xml_string(str = '')
       str << '<pageMargins '
-      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '/>'
     end
   end

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

@@ -0,0 +1,44 @@
+module Axlsx
+
+  # Page setup properties of the worksheet
+  # This class name is not a typo, its spec.
+  class PageSetUpPr
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # 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 = {})
+      parse_options options
+    end
+
+    serializable_attributes :auto_page_breaks, :fit_to_page
+
+    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
+  end
+end

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

@@ -6,8 +6,24 @@ module Axlsx
   # @see Worksheet#initialize
   class PageSetup
 
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # 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 = {})
+       parse_options options
+    end
+
+    serializable_attributes :fit_to_height, :fit_to_width, :orientation, :paper_height, :paper_width, :scale, :paper_size
+
     # TODO: Attributes defined by Open XML spec that are not implemented yet:
-    # 
     # * blackAndWhite
     # * cellComments
     # * copies
@@ -16,15 +32,14 @@ module Axlsx
     # * 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]
+    # @return [Integer]
     attr_reader :fit_to_height
 
     # Number of horizontal pages to fit on.
@@ -36,7 +51,7 @@ module Axlsx
     # 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
@@ -44,28 +59,142 @@ module Axlsx
     # 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
 
-    # 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)
-    def initialize(options = {})
-      set(options)
+    # 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
 
-    # Set some or all page settings at once.
+     # 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
+      parse_options options
     end
 
     # @see fit_to_height
@@ -80,7 +209,7 @@ module Axlsx
     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.
@@ -97,8 +226,8 @@ module Axlsx
     # 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)
+      # is there some better what to express this?
+      (fit_to_width != nil || fit_to_height != nil)
     end
 
     # Serializes the page settings element.
@@ -106,7 +235,7 @@ module Axlsx
     # @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(' ')
+      serialized_attributes str
       str << '/>'
     end
   end

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

@@ -1,11 +1,27 @@
-# encoding: UTF-8
 module Axlsx
   # Pane options for a worksheet.
   #
   # @note The recommended way to manage the pane options is via SheetView#pane
   # @see SheetView#pane
   class Pane
-    
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    # Creates a new {Pane} object
+    # @option options [Symbol] active_pane Active Pane
+    # @option options [Symbol] state Split State
+    # @option options [Cell, String] top_left_cell Top Left Visible Cell
+    # @option options [Integer] x_split Horizontal Split Position
+    # @option options [Integer] y_split Vertical Split Position
+    def initialize(options={})
+      #defaults
+      @active_pane = @state = @top_left_cell = nil
+      @x_split = @y_split = 0
+      parse_options options
+    end
+
+    serializable_attributes :active_pane, :state, :top_left_cell, :x_split, :y_split
+
     # Active Pane
     # The pane that is active.
     # Options are 
@@ -32,8 +48,8 @@ module Axlsx
     # @return [Symbol]
     # default nil
     attr_reader :active_pane
-    
-    
+
+
     # Split State
     # Indicates whether the pane has horizontal / vertical 
     # splits, and whether those splits are frozen.
@@ -51,8 +67,7 @@ module Axlsx
     # @return [Symbol]
     # default nil
     attr_reader :state
-    
-    
+
     # Top Left Visible Cell
     # Location of the top left visible cell in the bottom 
     # right pane (when in Left-To-Right mode).
@@ -60,8 +75,7 @@ module Axlsx
     # @return [String]
     # default nil
     attr_reader :top_left_cell
-    
-    
+
     # Horizontal Split Position
     # Horizontal position of the split, in 1/20th of a point; 0 (zero)
     # if none. If the pane is frozen, this value indicates the number 
@@ -70,8 +84,7 @@ module Axlsx
     # @return [Integer]
     # default 0
     attr_reader :x_split
-    
-    
+
     # Vertical Split Position
     # Vertical position of the split, in 1/20th of a point; 0 (zero) 
     # if none. If the pane is frozen, this value indicates the number
@@ -80,65 +93,49 @@ module Axlsx
     # @return [Integer]
     # default 0
     attr_reader :y_split
-    
-    
-    # Creates a new {Pane} object
-    # @option options [Symbol] active_pane Active Pane
-    # @option options [Symbol] state Split State
-    # @option options [Cell, String] top_left_cell Top Left Visible Cell
-    # @option options [Integer] x_split Horizontal Split Position
-    # @option options [Integer] y_split Vertical Split Position
-    def initialize(options={})
-      #defaults
-      @active_pane = @state = @top_left_cell = nil
-      @x_split = @y_split = 0
-      
-      # write options to instance variables
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-    
-    
+
     # @see active_pane
-    def active_pane=(v); Axlsx::validate_pane_type(v); @active_pane = v end
-    
-    
+    def active_pane=(v)
+      Axlsx::validate_pane_type(v)
+      @active_pane = Axlsx::camel(v.to_s, false)
+    end
+
     # @see state
-    def state=(v); Axlsx::validate_split_state_type(v); @state = v end
-    
-    
+    def state=(v)
+      Axlsx::validate_split_state_type(v)
+      @state = Axlsx::camel(v.to_s, false)
+    end
+
     # @see top_left_cell
     def top_left_cell=(v)
       cell = (v.class == Axlsx::Cell ? v.r_abs : v)
-      Axlsx::validate_string(cell)  
-      @top_left_cell = cell 
+      Axlsx::validate_string(cell)
+      @top_left_cell = cell
     end
-    
-    
+
     # @see x_split
     def x_split=(v); Axlsx::validate_unsigned_int(v); @x_split = v end
-    
-    
+
     # @see y_split
     def y_split=(v); Axlsx::validate_unsigned_int(v); @y_split = v end
-    
-    
+
     # Serializes the data validation
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      if @state == :frozen && @top_left_cell.nil?
+      finalize
+      str << '<pane '
+      serialized_attributes str
+      str << '/>'
+    end
+    private
+
+    def finalize
+      if @state == 'frozen' && @top_left_cell.nil?
         row = @y_split || 0
         column = @x_split || 0
-        
         @top_left_cell = "#{('A'..'ZZ').to_a[column]}#{row+1}"
       end
-      
-      str << '<pane '
-      str << instance_values.map { |key, value| '' << key.gsub(/_(.)/){ $1.upcase } << 
-        %{="#{[:active_pane, :state].include?(key.to_sym) ? value.to_s.gsub(/_(.)/){ $1.upcase } : value}"} unless value.nil? }.join(' ')
-      str << '/>'
     end
   end
 end