axlsx 1.1.4 → 1.3.1

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

@@ -0,0 +1,224 @@
+# encoding: UTF-8
+module Axlsx
+
+  # The SheetProtection object manages worksheet protection options per sheet.
+  class SheetProtection
+
+    # If 1 or true then AutoFilters should not be allowed to operate when the sheet is protected.
+    # If 0 or false then AutoFilters should be allowed to operate when the sheet is protected.
+    # @return [Boolean]
+    # default true 
+    attr_reader :auto_filter
+
+    # If 1 or true then deleting columns should not be allowed when the sheet is protected. 
+    # If 0 or false then deleting columns should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :delete_columns
+
+    # If 1 or true then deleting rows should not be allowed when the sheet is protected.
+    # If 0 or false then deleting rows should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :delete_rows
+
+    # If 1 or true then formatting cells should not be allowed when the sheet is protected.
+    # If 0 or false then formatting cells should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :format_cells
+
+    # If 1 or true then formatting columns should not be allowed when the sheet is protected.
+    # If 0 or false then formatting columns should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :format_columns
+
+    # If 1 or true then formatting rows should not be allowed when the sheet is protected. 
+    # If 0 or false then formatting rows should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :format_rows
+
+    # If 1 or true then inserting columns should not be allowed when the sheet is protected. 
+    # If 0 or false then inserting columns should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :insert_columns
+
+    # If 1 or true then inserting hyperlinks should not be allowed when the sheet is protected. 
+    # If 0 or false then inserting hyperlinks should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :insert_hyperlinks
+
+    # If 1 or true then inserting rows should not be allowed when the sheet is protected. 
+    # If 0 or false then inserting rows should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :insert_rows
+
+    # If 1 or true then editing of objects should not be allowed when the sheet is protected. 
+    # If 0 or false then objects are allowed to be edited when the sheet is protected.
+    # @return [Boolean]
+    # default false
+    attr_reader :objects
+
+    # If 1 or true then PivotTables should not be allowed to operate when the sheet is protected.
+    # If 0 or false then PivotTables should be allowed to operate when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :pivot_tables
+
+    # Specifies the salt which was prepended to the user-supplied password before it was hashed using the hashing algorithm
+    # @return [String]
+    attr_reader :salt_value
+
+    # If 1 or true then Scenarios should not be edited when the sheet is protected.
+    # If 0 or false then Scenarios are allowed to be edited when the sheet is protected.
+    # @return [Boolean]
+    # default false
+    attr_reader :scenarios
+
+    # If 1 or true then selection of locked cells should not be allowed when the sheet is protected.
+    # If 0 or false then selection of locked cells should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default false
+    attr_reader :select_locked_cells
+
+    # If 1 or true then selection of unlocked cells should not be allowed when the sheet is protected.
+    # If 0 or false then selection of unlocked cells should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default false
+    attr_reader :select_unlocked_cells
+
+    # If 1 or true then the sheet is protected. 
+    # If 0 or false then the sheet is not protected. 
+    # @return [Boolean]
+    # default true
+    attr_reader :sheet
+
+    # If 1 or true then sorting should not be allowed when the sheet is protected.
+    # If 0 or false then sorting should be allowed when the sheet is protected.
+    # @return [Boolean]
+    # default true
+    attr_reader :sort
+
+    # Password hash
+    # @return [String]
+    # default nil
+    attr_reader :password
+
+    # Creates a new SheetProtection instance
+    # @option options [Boolean] sheet @see SheetProtection#sheet
+    # @option options [Boolean] objects @see SheetProtection#objects
+    # @option options [Boolean] scenarios @see SheetProtection#scenarios
+    # @option options [Boolean] format_cells @see SheetProtection#objects
+    # @option options [Boolean] format_columns @see SheetProtection#format_columns
+    # @option options [Boolean] format_rows @see SheetProtection#format_rows
+    # @option options [Boolean] insert_columns @see SheetProtection#insert_columns
+    # @option options [Boolean] insert_rows @see SheetProtection#insert_rows
+    # @option options [Boolean] insert_hyperlinks @see SheetProtection#insert_hyperlinks
+    # @option options [Boolean] delete_columns @see SheetProtection#delete_columns
+    # @option options [Boolean] delete_rows @see SheetProtection#delete_rows
+    # @option options [Boolean] select_locked_cells @see SheetProtection#select_locked_cells
+    # @option options [Boolean] sort @see SheetProtection#sort
+    # @option options [Boolean] auto_filter @see SheetProtection#auto_filter
+    # @option options [Boolean] pivot_tables @see SheetProtection#pivot_tables
+    # @option options [Boolean] select_unlocked_cells @see SheetProtection#select_unlocked_cells
+    # @option options [String] password. The password required for unlocking. @see SheetProtection#password=
+    # @option options [Boolean] objects @see SheetProtection#objects
+    def initialize(options={})
+      @objects = @scenarios = @select_locked_cells = @select_unlocked_cells = false
+      @sheet = @format_cells = @format_rows = @format_columns = @insert_columns = @insert_rows = @insert_hyperlinks = @delete_columns = @delete_rows = @sort = @auto_filter = @pivot_tables = true
+      @password = nil
+
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+
+
+     # create validating setters for boolean values
+     # @return [Boolean] 
+     [:sheet, :objects, :scenarios, :select_locked_cells, :sort,
+     :select_unlocked_cells, :format_cells, :format_rows, :format_columns,
+     :insert_columns, :insert_rows, :insert_hyperlinks, :delete_columns,
+     :delete_rows, :auto_filter, :pivot_tables].each do |f_name|
+       define_method "#{f_name.to_s}=".to_sym do |v|
+         Axlsx::validate_boolean(v)
+         instance_variable_set "@#{f_name.to_s}".to_sym, v
+       end
+     end
+
+     # This block is intended to implement the salt_value, hash_value and spin count as per the ECMA-376 standard. 
+     # However, it does not seem to actually work in EXCEL - instead they are using their old retro algorithm shown below 
+     # defined in the transitional portion of the speck. I am leaving this code in in the hope that someday Ill be able to 
+     # figure out why it does not work, and if Excel even supports it.
+#     def propper_password=(v)
+#       @algorithm_name = v == nil ? nil : 'SHA-1'
+#       @salt_value = @spin_count = @hash_value = v if v == nil
+#       return if v == nil
+#       require 'digest/sha1'
+#       @spin_count = 10000
+#       @salt_value = Digest::SHA1.hexdigest(rand(36**8).to_s(36))
+#       @spin_count.times do |count|
+#         @hash_value = Digest::SHA1.hexdigest((@hash_value ||= (@salt_value + v.to_s)) + Array(count).pack('V'))
+#       end
+#     end
+
+
+
+     # encodes password for protection locking
+     def password=(v)
+       return if v == nil
+        @password = create_password_hash(v)
+     end
+
+     # Serialize the object
+     # @param [String] str
+     # @return [String]
+     def to_xml_string(str = '')
+       str << '<sheetProtection '
+       str << instance_values.map{ |k,v| k.gsub(/_(.)/){ $1.upcase } << %{="#{v.to_s}"} }.join(' ')
+       str << '/>'
+     end
+
+  private
+    # Creates a password hash for a given password
+    # @return [String]
+    def create_password_hash(password)
+      encoded_password = encode_password(password)
+
+      password_as_hex = [encoded_password].pack("v")
+      password_as_string = password_as_hex.unpack("H*").first.upcase
+
+      password_as_string[2..3] + password_as_string[0..1]
+    end
+
+
+    # Encodes a given password
+    # Based on the algorithm provided by Daniel Rentz of OpenOffice.
+    # http://www.openoffice.org/sc/excelfileformat.pdf, Revision 1.42, page 115 (21.05.2012)
+    # @return [String]
+    def encode_password(password)
+      i = 0
+      chars = password.split(//)
+      count = chars.size
+
+      chars.collect! do |char|
+        i += 1
+        char     = char.unpack('c')[0] << i #ord << i
+        low_15   = char & 0x7fff
+        high_15  = char & 0x7fff << 15
+        high_15  = high_15 >> 15
+        char     = low_15 | high_15
+      end
+
+      encoded_password  = 0x0000
+      chars.each { |c| encoded_password ^= c }
+      encoded_password ^= count
+      encoded_password ^= 0xCE4B
+    end
+  end
+end

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

@@ -0,0 +1,379 @@
+# encoding: UTF-8
+module Axlsx
+  # View options for a worksheet.
+  #
+  # @note The recommended way to manage the sheet view is via Worksheet#sheet_view
+  # @see Worksheet#sheet_view
+  class SheetView
+    
+    # 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]
+    def pane
+      @pane ||= Pane.new
+      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
+
+    #  
+    # Color Id
+    # Index to the color value for row/column
+    # text headings and gridlines. This is an 
+    # 'index color value' (ICV) rather than 
+    # rgb value.
+    # @see type
+    # @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
+    # pane (when in Left-to-Right mode).
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :top_left_cell
+    
+    
+    # View Type
+    # Indicates the view type.
+    # Options are 
+    #  * normal: Normal view
+    #  * page_break_preview: Page break preview
+    #  * page_layout: Page Layout View
+    # @see type
+    # @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.
+    # @see type
+    # @return [Integer] 
+    # default 0
+    attr_reader :workbook_view_id
+    
+    
+    # Zoom Scale
+    # Window zoom magnification for current view 
+    # representing percent values. This attribute
+    # is restricted to values ranging from 10 to 400. 
+    # Horizontal & Vertical scale together.
+    # Current view can be Normal, Page Layout, or 
+    # Page Break Preview.
+    # @see type
+    # @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 
+    # restricted to values ranging from 10 to 400. 
+    # Horizontal & Vertical scale together.
+    # Applies for worksheets only; zero implies the 
+    # automatic setting.
+    # @see type
+    # @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 
+    # is restricted to values ranging from 10 to 400. 
+    # Horizontal & Vertical scale together.
+    # Applies for worksheets only; zero implies 
+    # the automatic setting.
+    # @see type
+    # @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 
+    # attribute is restricted to values ranging 
+    # from 10 to 400. Horizontal & Vertical scale
+    # together.
+    # Applies for worksheet only; zero implies 
+    # the automatic setting.
+    # @see type
+    # @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
+    # return [Selection]
+    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 
+    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(' ')
+      str << '>'
+      @pane.to_xml_string(str) if @pane
+      @selections.each do |key, selection|
+        selection.to_xml_string(str)
+      end
+      str << '</sheetView>'
+      str << '</sheetViews>'
+    end
+  end
+end

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

@@ -19,8 +19,8 @@ module Axlsx
     attr_reader :style
 
     # Creates a new Table object
-    # @param [String] ref The reference to the table data.
-    # @param [Sheet] ref The sheet containing the table data.
+    # @param [String] ref The reference to the table data like 'A1:G24'.
+    # @param [Worksheet] sheet The sheet containing the table data.
     # @option options [Cell, String] name
     # @option options [TableStyle] style
     def initialize(ref, sheet, options={})
@@ -28,6 +28,7 @@ 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]}="
@@ -62,6 +63,12 @@ module Axlsx
         @name = v
       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
@@ -77,7 +84,7 @@ module Axlsx
       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) # '<tableStyleInfo showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0" name="TableStyleMedium9" />'
       str << '</table>'
     end