axlsx 1.2.0 → 2.0.0

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

@@ -5,10 +5,54 @@ module Axlsx
   # @note The recommended way to manage the sheet view is via Worksheet#sheet_view
   # @see Worksheet#sheet_view
   class SheetView
-    
+   
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+    include Axlsx::SerializedAttributes
+
+    # Creates a new {SheetView} object
+    # @option options [Integer] color_id Color Id
+    # @option options [Boolean] default_grid_color Default Grid Color
+    # @option options [Boolean] right_to_left Right To Left
+    # @option options [Boolean] show_formulas Show Formulas
+    # @option options [Boolean] show_grid_lines Show Grid Lines
+    # @option options [Boolean] show_outline_symbols Show Outline Symbols
+    # @option options [Boolean] show_row_col_headers Show Headers
+    # @option options [Boolean] show_ruler Show Ruler
+    # @option options [Boolean] show_white_space Show White Space
+    # @option options [Boolean] show_zeros Show Zero Values
+    # @option options [Boolean] tab_selected Sheet Tab Selected
+    # @option options [String, Cell] top_left_cell Top Left Visible Cell
+    # @option options [Symbol] view View Type
+    # @option options [Boolean] window_protection Window Protection
+    # @option options [Integer] workbook_view_id Workbook View Index
+    # @option options [Integer] zoom_scale
+    # @option options [Integer] zoom_scale_normal Zoom Scale Normal View
+    # @option options [Integer] zoom_scale_page_layout_view Zoom Scale Page Layout View
+    # @option options [Integer] zoom_scale_sheet_layout_view Zoom Scale Page Break Preview
+    def initialize(options={})
+      #defaults
+      @color_id = @top_left_cell = @pane = nil
+      @right_to_left = @show_formulas = @show_outline_symbols = @show_white_space = @tab_selected = @window_protection = false
+      @default_grid_color = @show_grid_lines = @show_row_col_headers = @show_ruler = @show_zeros = true
+      @zoom_scale = 100
+      @zoom_scale_normal = @zoom_scale_page_layout_view = @zoom_scale_sheet_layout_view = @workbook_view_id = 0
+      @selections = {}
+      parse_options options
+    end
+
+    boolean_attr_accessor :default_grid_color, :right_to_left, :show_formulas, :show_grid_lines,
+      :show_row_col_headers, :show_ruler, :show_white_space, :show_zeros, :tab_selected, :window_protection, :show_outline_symbols
+
+    serializable_attributes :default_grid_color, :right_to_left, :show_formulas, :show_grid_lines,
+      :show_row_col_headers, :show_ruler, :show_white_space, :show_zeros, :tab_selected, :window_protection, :show_outline_symbols,
+      :zoom_scale_sheet_layout_view, :zoom_scale_page_layout_view, :zoom_scale_normal, :workbook_view_id,
+      :view, :top_left_cell, :color_id, :zoom_scale
+
+
     # instance values that must be serialized as their own elements - e.g. not attributes.
     CHILD_ELEMENTS = [ :pane, :selections ]
-    
+
     # The pane object for the sheet view
     # @return [Pane]
     # @see [Pane]
@@ -17,7 +61,7 @@ module Axlsx
       yield @pane if block_given?
       @pane
     end
-    
+
     # A hash of selection objects keyed by pane type associated with this sheet view.
     # @return [Hash]
     attr_reader :selections
@@ -32,116 +76,7 @@ module Axlsx
     # @return [Integer]
     # default nil
     attr_reader :color_id
-    
-    
-    # Default Grid Color
-    # Flag indicating that the consuming application 
-    # should use the default grid lines color
-    # (system dependent). Overrides any color 
-    # specified in colorId.
-    # @see type
-    # @return [Boolean]
-    # default true
-    attr_reader :default_grid_color
-    
-    
-    # Right To Left
-    # Flag indicating whether the sheet is in 
-    # 'right to left' display mode. When in this 
-    # mode, Column A is on the far right, Column B ;
-    # is one column left of Column A, and so on. Also,
-    # information in cells is displayed in the Right 
-    # to Left format.
-    # @see type
-    # @return [Boolean]
-    # default false
-    attr_reader :right_to_left
-    
-    
-    # Show Formulas
-    # Flag indicating whether this sheet should 
-    # display formulas.
-    # @see type
-    # @return [Boolean]
-    # default false
-    attr_reader :show_formulas
-    
-    
-    # Show Grid Lines
-    # Flag indicating whether this sheet 
-    # should display gridlines.
-    # @see type
-    # @return [Boolean]
-    # default true
-    attr_reader :show_grid_lines
-    
-    
-    # Show Outline Symbols
-    # Flag indicating whether the sheet has outline 
-    # symbols visible. This flag shall always override 
-    # SheetPr element's outlinePr child element 
-    # whose attribute is named showOutlineSymbols 
-    # when there is a conflict.
-    # @see type
-    # @return [Boolean]
-    # default false
-    attr_reader :show_outline_symbols
-    
-    
-    # Show Headers
-    # Flag indicating whether the sheet should 
-    # display row and column headings.
-    # @see type
-    # @return [Boolean]
-    # default true
-    attr_reader :show_row_col_headers
-    
-    
-    # Show Ruler
-    # Show the ruler in Page Layout View.
-    # @see type
-    # @return [Boolean]
-    # default true
-    attr_reader :show_ruler
-    
-    
-    # Show White Space
-    # Flag indicating whether page layout 
-    # view shall display margins. False means 
-    # do not display left, right, top (header), 
-    # and bottom (footer) margins (even when 
-    # there is data in the header or footer).
-    # @see type
-    # @return [Boolean]
-    # default false
-    attr_reader :show_white_space
-    
-    
-    # Show Zero Values
-    # Flag indicating whether the window should 
-    # show 0 (zero) in cells containing zero value.
-    # When false, cells with zero value appear 
-    # blank instead of showing the number zero.
-    # @see type
-    # @return [Boolean]
-    # default true
-    attr_reader :show_zeros
-    
-    
-    # Sheet Tab Selected
-    # Flag indicating whether this sheet is selected. 
-    # When only 1 sheet is selected and active, this 
-    # value should be in synch with the activeTab value. 
-    # In case of a conflict, the Start Part setting 
-    # wins and sets the active sheet tab. Multiple 
-    # sheets can be selected, but only one sheet shall 
-    # be active at one time.
-    # @see type
-    # @return [Boolean]
-    # default false
-    attr_reader :tab_selected
-    
-    
+
     # Top Left Visible Cell
     # Location of the top left visible cell Location 
     # of the top left visible cell in the bottom right
@@ -162,19 +97,7 @@ module Axlsx
     # @return [Symbol]
     # default :normal
     attr_reader :view
-    
-    
-    # Window Protection
-    # Flag indicating whether the panes in the window 
-    # are locked due to workbook protection.
-    # This is an option when the workbook structure is 
-    # protected.
-    # @see type
-    # @return [Boolean] 
-    # default true
-    attr_reader :window_protection
-    
-    
+
     # Workbook View Index
     # Zero-based index of this workbook view, pointing 
     # to a workbookView element in the bookViews collection.
@@ -182,8 +105,7 @@ module Axlsx
     # @return [Integer] 
     # default 0
     attr_reader :workbook_view_id
-    
-    
+
     # Zoom Scale
     # Window zoom magnification for current view 
     # representing percent values. This attribute
@@ -195,8 +117,8 @@ module Axlsx
     # @return [Integer] 
     # default 100
     attr_reader :zoom_scale
-    
-    
+
+
     # Zoom Scale Normal View
     # Zoom magnification to use when in normal view, 
     # representing percent values. This attribute is 
@@ -208,8 +130,8 @@ module Axlsx
     # @return [Integer] 
     # default 0
     attr_reader :zoom_scale_normal
-    
-    
+
+
     # Zoom Scale Page Layout View
     # Zoom magnification to use when in page layout 
     # view, representing percent values. This attribute 
@@ -221,8 +143,8 @@ module Axlsx
     # @return [Integer] 
     # default 0
     attr_reader :zoom_scale_page_layout_view
-    
-    
+
+
     # Zoom Scale Page Break Preview
     # Zoom magnification to use when in page break 
     # preview, representing percent values. This 
@@ -235,43 +157,7 @@ module Axlsx
     # @return [Integer] 
     # default 0
     attr_reader :zoom_scale_sheet_layout_view
-    
-    
-    # Creates a new {SheetView} object
-    # @option options [Integer] color_id Color Id
-    # @option options [Boolean] default_grid_color Default Grid Color
-    # @option options [Boolean] right_to_left Right To Left
-    # @option options [Boolean] show_formulas Show Formulas
-    # @option options [Boolean] show_grid_lines Show Grid Lines
-    # @option options [Boolean] show_outline_symbols Show Outline Symbols
-    # @option options [Boolean] show_row_col_headers Show Headers
-    # @option options [Boolean] show_ruler Show Ruler
-    # @option options [Boolean] show_white_space Show White Space
-    # @option options [Boolean] show_zeros Show Zero Values
-    # @option options [Boolean] tab_selected Sheet Tab Selected
-    # @option options [String, Cell] top_left_cell Top Left Visible Cell
-    # @option options [Symbol] view View Type
-    # @option options [Boolean] window_protection Window Protection
-    # @option options [Integer] workbook_view_id Workbook View Index
-    # @option options [Integer] zoom_scale_normal Zoom Scale Normal View
-    # @option options [Integer] zoom_scale_page_layout_view Zoom Scale Page Layout View
-    # @option options [Integer] zoom_scale_sheet_layout_view Zoom Scale Page Break Preview
-    def initialize(options={})
-      #defaults
-      @color_id = @top_left_cell = @pane = nil
-      @right_to_left = @show_formulas = @show_outline_symbols = @show_white_space = @tab_selected = @window_protection = false
-      @default_grid_color = @show_grid_lines = @show_row_col_headers = @show_ruler = @show_zeros = true
-      @zoom_scale = 100
-      @zoom_scale_normal = @zoom_scale_page_layout_view = @zoom_scale_sheet_layout_view = @workbook_view_id = 0
-      @selections = {}
-      
-      # write options to instance variables
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-    
-    
+
     # Adds a new selection
     # param [Symbol] pane
     # param [Hash] options
@@ -279,94 +165,42 @@ module Axlsx
     def add_selection(pane, options = {})
       @selections[pane] = Selection.new(options.merge(:pane => pane))
     end
-    
+
     # @see color_id
     def color_id=(v); Axlsx::validate_unsigned_int(v); @color_id = v end
-    
-    
-    # @see default_grid_color
-    def default_grid_color=(v); Axlsx::validate_boolean(v); @default_grid_color = v end
-    
-    
-    # @see right_to_left
-    def right_to_left=(v); Axlsx::validate_boolean(v); @right_to_left = v end
-    
-    
-    # @see show_formulas
-    def show_formulas=(v); Axlsx::validate_boolean(v); @show_formulas = v end
-    
-    
-    # @see show_grid_lines
-    def show_grid_lines=(v); Axlsx::validate_boolean(v); @show_grid_lines = v end
-    
-    
-    # @see show_outline_symbols
-    def show_outline_symbols=(v); Axlsx::validate_boolean(v); @show_outline_symbols = v end
-    
-    
-    # @see show_row_col_headers
-    def show_row_col_headers=(v); Axlsx::validate_boolean(v); @show_row_col_headers = v end
-    
-    
-    # @see show_ruler
-    def show_ruler=(v); Axlsx::validate_boolean(v); @show_ruler = v end
-    
-    
-    # @see show_white_space
-    def show_white_space=(v); Axlsx::validate_boolean(v); @show_white_space = v end
-    
-    
-    # @see show_zeros
-    def show_zeros=(v); Axlsx::validate_boolean(v); @show_zeros = v end
-    
-    
-    # @see tab_selected
-    def tab_selected=(v); Axlsx::validate_boolean(v); @tab_selected = v 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 
+      @top_left_cell = cell
     end
-    
-    
+
     # @see view
     def view=(v); Axlsx::validate_sheet_view_type(v); @view = v end
-    
-    
-    # @see window_protection
-    def window_protection=(v); Axlsx::validate_boolean(v); @window_protection = v end
-    
-    
+
     # @see workbook_view_id
     def workbook_view_id=(v); Axlsx::validate_unsigned_int(v); @workbook_view_id = v end
-    
-    
+
     # @see zoom_scale
     def zoom_scale=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale = v end
-    
-    
+
     # @see zoom_scale_normal
     def zoom_scale_normal=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale_normal = v end
-    
-    
+
     # @see zoom_scale_page_layout_view
     def zoom_scale_page_layout_view=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale_page_layout_view = v end
-    
-    
+
     # @see zoom_scale_sheet_layout_view
     def zoom_scale_sheet_layout_view=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale_sheet_layout_view = v end
-    
-    
+
     # Serializes the data validation
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<sheetViews>'
       str << '<sheetView '
-      str << instance_values.map { |key, value| (Axlsx::camel(key.to_s, false) << '="' << value.to_s << '"') unless CHILD_ELEMENTS.include?(key.to_sym) || value == nil }.join(' ')
+      serialized_attributes str
       str << '>'
       @pane.to_xml_string(str) if @pane
       @selections.each do |key, selection|

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

@@ -5,18 +5,7 @@ module Axlsx
   # @see README for examples
   class Table
 
-
-    # The reference to the table data
-    # @return [String]
-    attr_reader :ref
-
-    # The name of the table.
-    # @return [String]
-    attr_reader :name
-
-    # The style for the table.
-    # @return [TableStyle]
-    attr_reader :style
+    include Axlsx::OptionsParser
 
     # Creates a new Table object
     # @param [String] ref The reference to the table data like 'A1:G24'.
@@ -28,13 +17,24 @@ module Axlsx
       @sheet = sheet
       @style = nil
       @sheet.workbook.tables << self
+      @table_style_info = TableStyleInfo.new(options[:style_info]) if options[:style_info]
       @name = "Table#{index+1}"
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
       yield self if block_given?
     end
 
+    # The reference to the table data
+    # @return [String]
+    attr_reader :ref
+
+    # The name of the table.
+    # @return [String]
+    attr_reader :name
+
+    # The style for the table.
+    # @return [TableStyle]
+    attr_reader :style
+
     # The index of this chart in the workbooks charts collection
     # @return [Integer]
     def index
@@ -47,10 +47,11 @@ module Axlsx
       "#{TABLE_PN % (index+1)}"
     end
 
-    # The relation reference id for this table
+    # The relationship id for this table.
+    # @see Relationship#Id
     # @return [String]
     def rId
-      "rId#{index+1}"
+      @sheet.relationships.for(self).Id
     end
 
     # The name of the Table.
@@ -63,6 +64,12 @@ module Axlsx
       end
     end
 
+    # TableStyleInfo for the table. 
+    # initialization can be fed via the :style_info option
+    def table_style_info
+      @table_style_info ||= TableStyleInfo.new
+    end
+
     # Serializes the object
     # @param [String] str
     # @return [String]
@@ -76,8 +83,7 @@ module Axlsx
         str << '<tableColumn id ="' << (index+1).to_s << '" name="' << cell.value << '"/>'
       end
       str << '</tableColumns>'
-      #TODO implement tableStyleInfo
-      str << '<tableStyleInfo showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0" name="TableStyleMedium9" />'
+      table_style_info.to_xml_string(str)
       str << '</table>'
     end
 

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

@@ -0,0 +1,51 @@
+module Axlsx
+
+  # The table style info class manages style attributes for defined tables in
+  # a worksheet
+  class TableStyleInfo
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
+    # creates a new TableStyleInfo instance
+    # @param [Hash] options
+    # @option [Boolean] show_first_column indicates if the first column should
+    #                   be shown
+    # @option [Boolean] show_last_column indicates if the last column should
+    #                   be shown
+    # @option [Boolean] show_column_stripes indicates if column stripes should
+    #                   be shown
+    # @option [Boolean] show_row_stripes indicates if row stripes should be shown
+    # @option [String] name The name of the style to apply to your table. 
+    #                  Only predefined styles are currently supported.
+    #                  @see Annex G. (normative) Predefined SpreadsheetML Style Definitions in part 1 of the specification.
+    def initialize(options = {})
+      initialize_defaults
+      @name = 'TableStyleMedium9'
+      parse_options options
+    end
+
+    # boolean attributes for this object
+    boolean_attr_accessor :show_first_column, :show_last_column, :show_row_stripes, :show_column_stripes
+    serializable_attributes :show_first_column, :show_last_column, :show_row_stripes, :show_column_stripes,
+      :name
+
+    # Initialize all the values to false as Excel requires them to
+    # explicitly be disabled or all will show.
+    def initialize_defaults
+      %w(show_first_column show_last_column show_row_stripes show_column_stripes).each do |attr|
+        self.send("#{attr}=", 0)
+      end
+    end
+
+    # The name of the table style.
+    attr_accessor :name
+
+    # seralizes this object to an xml string
+    # @param [String] str the string to contact this objects serialization to.
+    def to_xml_string(str = '')
+      str << '<tableStyleInfo '
+      serialized_attributes str
+      str << '/>'
+    end
+  end
+end

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

@@ -17,7 +17,7 @@ module Axlsx
     # returns the relationships required by this collection
     def relationships
       return [] if empty?
-      map{ |table| Relationship.new(TABLE_R, "../#{table.pn}") }
+      map{ |table| Relationship.new(table, TABLE_R, "../#{table.pn}") }
     end
 
     def to_xml_string(str = "")