caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/workbook/workbook_view.rb

@@ -1,80 +1,75 @@
-# <xsd:complexType name="CT_BookView">
-#     <xsd:sequence>
-#       <xsd:element name="extLst" type="CT_ExtensionList" minOccurs="0" maxOccurs="1"/>
-#     </xsd:sequence>
-#     <xsd:attribute name="visibility" type="ST_Visibility" use="optional" default="visible"/>
-#     <xsd:attribute name="minimized" type="xsd:boolean" use="optional" default="false"/>
-#     <xsd:attribute name="showHorizontalScroll" type="xsd:boolean" use="optional" default="true"/>
-#     <xsd:attribute name="showVerticalScroll" type="xsd:boolean" use="optional" default="true"/>
-#     <xsd:attribute name="showSheetTabs" type="xsd:boolean" use="optional" default="true"/>
-#     <xsd:attribute name="xWindow" type="xsd:int" use="optional"/>
-#     <xsd:attribute name="yWindow" type="xsd:int" use="optional"/>
-#     <xsd:attribute name="windowWidth" type="xsd:unsignedInt" use="optional"/>
-#     <xsd:attribute name="windowHeight" type="xsd:unsignedInt" use="optional"/>
-#     <xsd:attribute name="tabRatio" type="xsd:unsignedInt" use="optional" default="600"/>
-#     <xsd:attribute name="firstSheet" type="xsd:unsignedInt" use="optional" default="0"/>
-#     <xsd:attribute name="activeTab" type="xsd:unsignedInt" use="optional" default="0"/>
-#     <xsd:attribute name="autoFilterDateGrouping" type="xsd:boolean" use="optional"
-#     default="true"/>
-# </xsd:complexType>
-
-module Axlsx
-
-  # A BookView defines the display properties for a workbook.
-  # Units for window widths and other dimensions are expressed in twips.
-  # Twip measurements are portable between different display resolutions.
-  # The formula is (screen pixels) * (20 * 72) / (logical device dpi),
-  # where the logical device dpi can be different for x and y coordinates.
-  class WorkbookView
-
-    include Axlsx::SerializedAttributes
-    include Axlsx::OptionsParser
-    include Axlsx::Accessors
-
-
-    # Creates a new BookView object
-    # @param [Hash] options  A hash of key/value pairs that will be mapped to this instances attributes.
-    # @option [Symbol] visibility Specifies visible state of the workbook window. The default value for this attribute is :visible.
-    # @option [Boolean] minimized Specifies a boolean value that indicates whether the workbook window is minimized.
-    # @option [Boolean] show_horizontal_scroll Specifies a boolean value that indicates whether to display the horizontal scroll bar in the user interface.
-    # @option [Boolean] show_vertical_scroll Specifies a boolean value that indicates whether to display the vertical scroll bar.
-    # @option [Boolean] show_sheet_tabs Specifies a boolean value that indicates whether to display the sheet tabs in the user interface.
-    # @option [Integer] tab_ratio Specifies ratio between the workbook tabs bar and the horizontal scroll bar.
-    # @option [Integer] first_sheet Specifies the index to the first sheet in this book view.
-    # @option [Integer] active_tab Specifies an unsignedInt that contains the index to the active sheet in this book view.
-    # @option [Integer] x_window Specifies the X coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
-    # @option [Integer] y_window Specifies the Y coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
-    # @option [Integer] window_width Specifies the width of the workbook window. The unit of measurement for this value is twips.
-    # @option [Integer] window_height Specifies the height of the workbook window. The unit of measurement for this value is twips.
-    # @option [Boolean] auto_filter_date_grouping Specifies a boolean value that indicates whether to group dates when presenting the user with filtering options in the user interface.
-    def initialize(options={})
-      parse_options options
-      yield self if block_given?
-    end
-
-
-    unsigned_int_attr_accessor :x_window, :y_window, :window_width, :window_height,
-                               :tab_ratio, :first_sheet, :active_tab
-
-    validated_attr_accessor  [:visibility], :validate_view_visibility
-
-    serializable_attributes :visibility, :minimized,
-                            :show_horizontal_scroll, :show_vertical_scroll,
-                            :show_sheet_tabs, :tab_ratio, :first_sheet, :active_tab,
-                            :x_window, :y_window, :window_width, :window_height,
-                            :auto_filter_date_grouping
-
-    boolean_attr_accessor :minimized, :show_horizontal_scroll, :show_vertical_scroll,
-                          :show_sheet_tabs, :auto_filter_date_grouping
-
-
-    # Serialize the WorkbookView
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-       str << '<workbookView '
-       serialized_attributes str
-       str << '></workbookView>'
-    end
-  end
-end
+# <xsd:complexType name="CT_BookView">
+#     <xsd:sequence>
+#       <xsd:element name="extLst" type="CT_ExtensionList" minOccurs="0" maxOccurs="1"/>
+#     </xsd:sequence>
+#     <xsd:attribute name="visibility" type="ST_Visibility" use="optional" default="visible"/>
+#     <xsd:attribute name="minimized" type="xsd:boolean" use="optional" default="false"/>
+#     <xsd:attribute name="showHorizontalScroll" type="xsd:boolean" use="optional" default="true"/>
+#     <xsd:attribute name="showVerticalScroll" type="xsd:boolean" use="optional" default="true"/>
+#     <xsd:attribute name="showSheetTabs" type="xsd:boolean" use="optional" default="true"/>
+#     <xsd:attribute name="xWindow" type="xsd:int" use="optional"/>
+#     <xsd:attribute name="yWindow" type="xsd:int" use="optional"/>
+#     <xsd:attribute name="windowWidth" type="xsd:unsignedInt" use="optional"/>
+#     <xsd:attribute name="windowHeight" type="xsd:unsignedInt" use="optional"/>
+#     <xsd:attribute name="tabRatio" type="xsd:unsignedInt" use="optional" default="600"/>
+#     <xsd:attribute name="firstSheet" type="xsd:unsignedInt" use="optional" default="0"/>
+#     <xsd:attribute name="activeTab" type="xsd:unsignedInt" use="optional" default="0"/>
+#     <xsd:attribute name="autoFilterDateGrouping" type="xsd:boolean" use="optional"
+#     default="true"/>
+# </xsd:complexType>
+
+module Axlsx
+  # A BookView defines the display properties for a workbook.
+  # Units for window widths and other dimensions are expressed in twips.
+  # Twip measurements are portable between different display resolutions.
+  # The formula is (screen pixels) * (20 * 72) / (logical device dpi),
+  # where the logical device dpi can be different for x and y coordinates.
+  class WorkbookView
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+
+    # Creates a new BookView object
+    # @param [Hash] options  A hash of key/value pairs that will be mapped to this instances attributes.
+    # @option [Symbol] visibility Specifies visible state of the workbook window. The default value for this attribute is :visible.
+    # @option [Boolean] minimized Specifies a boolean value that indicates whether the workbook window is minimized.
+    # @option [Boolean] show_horizontal_scroll Specifies a boolean value that indicates whether to display the horizontal scroll bar in the user interface.
+    # @option [Boolean] show_vertical_scroll Specifies a boolean value that indicates whether to display the vertical scroll bar.
+    # @option [Boolean] show_sheet_tabs Specifies a boolean value that indicates whether to display the sheet tabs in the user interface.
+    # @option [Integer] tab_ratio Specifies ratio between the workbook tabs bar and the horizontal scroll bar.
+    # @option [Integer] first_sheet Specifies the index to the first sheet in this book view.
+    # @option [Integer] active_tab Specifies an unsignedInt that contains the index to the active sheet in this book view.
+    # @option [Integer] x_window Specifies the X coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
+    # @option [Integer] y_window Specifies the Y coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
+    # @option [Integer] window_width Specifies the width of the workbook window. The unit of measurement for this value is twips.
+    # @option [Integer] window_height Specifies the height of the workbook window. The unit of measurement for this value is twips.
+    # @option [Boolean] auto_filter_date_grouping Specifies a boolean value that indicates whether to group dates when presenting the user with filtering options in the user interface.
+    def initialize(options = {})
+      parse_options options
+      yield self if block_given?
+    end
+
+    unsigned_int_attr_accessor :x_window, :y_window, :window_width, :window_height,
+                               :tab_ratio, :first_sheet, :active_tab
+
+    validated_attr_accessor [:visibility], :validate_view_visibility
+
+    serializable_attributes :visibility, :minimized,
+                            :show_horizontal_scroll, :show_vertical_scroll,
+                            :show_sheet_tabs, :tab_ratio, :first_sheet, :active_tab,
+                            :x_window, :y_window, :window_width, :window_height,
+                            :auto_filter_date_grouping
+
+    boolean_attr_accessor :minimized, :show_horizontal_scroll, :show_vertical_scroll,
+                          :show_sheet_tabs, :auto_filter_date_grouping
+
+    # Serialize the WorkbookView
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<workbookView '
+      serialized_attributes str
+      str << '></workbookView>'
+    end
+  end
+end

data/lib/axlsx/workbook/workbook_views.rb

@@ -1,22 +1,20 @@
-module Axlsx
-  # a simple types list of BookView objects
-  class WorkbookViews < SimpleTypedList
-
-    # creates the book views object
-    def initialize
-      super WorkbookView
-    end
-
-    # Serialize to xml
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      return if empty?
-      str << "<bookViews>"
-      each { |view| view.to_xml_string(str) }
-      str << '</bookViews>'
-    end
-  end
-end
-
-
+module Axlsx
+  # a simple types list of BookView objects
+  class WorkbookViews < SimpleTypedList
+    # creates the book views object
+    def initialize
+      super WorkbookView
+    end
+
+    # Serialize to xml
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      return if empty?
+
+      str << "<bookViews>"
+      each { |view| view.to_xml_string(str) }
+      str << '</bookViews>'
+    end
+  end
+end

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

@@ -1,77 +1,78 @@
-
-require 'axlsx/workbook/worksheet/auto_filter/filter_column.rb'
-require 'axlsx/workbook/worksheet/auto_filter/filters.rb'
-
-module Axlsx
-
-  #This class represents an auto filter range in a worksheet
-  class AutoFilter
-
-    # creates a new Autofilter object
-    # @param [Worksheet] worksheet
-    def initialize(worksheet)
-      raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
-      @worksheet = worksheet
-    end
-
-    attr_reader :worksheet
-
-    # The range the autofilter should be applied to.
-    # This should be a string like 'A1:B8'
-    # @return [String]
-    attr_accessor :range
-
-    # the formula for the defined name required for this auto filter
-    # This prepends the worksheet name to the absolute cell reference
-    # e.g. A1:B2 -> 'Sheet1'!$A$1:$B$2
-    # @return [String]
-    def defined_name
-      return unless range
-      Axlsx.cell_range(range.split(':').collect { |name| worksheet.name_to_cell(name)})
-    end
-
-    # A collection of filterColumns for this auto_filter
-    # @return [SimpleTypedList]
-    def columns
-      @columns ||= SimpleTypedList.new FilterColumn
-    end
-
-    # Adds a filter column. This is the recommended way to create and manage filter columns for your autofilter.
-    # In addition to the require id and type parameters, options will be passed to the filter column during instantiation.
-    # @param [String] col_id Zero-based index indicating the AutoFilter column to which this filter information applies.
-    # @param [Symbol] filter_type A symbol representing one of the supported filter types.
-    # @param [Hash] options a hash of options to pass into the generated filter
-    # @return [FilterColumn]
-    def add_column(col_id, filter_type, options = {})
-      columns << FilterColumn.new(col_id, filter_type, options)
-      columns.last
-    end
-
-    # actually performs the filtering of rows who's cells do not
-    # match the filter.
-    def apply
-      first_cell, last_cell = range.split(':')
-      start_point = Axlsx::name_to_indices(first_cell)
-      end_point = Axlsx::name_to_indices(last_cell)
-      # The +1 is so we skip the header row with the filter drop downs
-      rows = worksheet.rows[(start_point.last+1)..end_point.last] || []
-
-      column_offset = start_point.first
-      columns.each do |column|
-        rows.each do |row|
-          next if row.hidden
-          column.apply(row, column_offset)
-        end
-      end
-    end
-    # serialize the object
-    # @return [String]
-    def to_xml_string(str='')
-      return unless range
-      str << "<autoFilter ref='#{range}'>"
-      columns.each { |filter_column| filter_column.to_xml_string(str) }
-      str << "</autoFilter>"
-    end
-
-  end
-end
+require 'axlsx/workbook/worksheet/auto_filter/filter_column.rb'
+require 'axlsx/workbook/worksheet/auto_filter/filters.rb'
+
+module Axlsx
+  # This class represents an auto filter range in a worksheet
+  class AutoFilter
+    # creates a new Autofilter object
+    # @param [Worksheet] worksheet
+    def initialize(worksheet)
+      raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
+
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # The range the autofilter should be applied to.
+    # This should be a string like 'A1:B8'
+    # @return [String]
+    attr_accessor :range
+
+    # the formula for the defined name required for this auto filter
+    # This prepends the worksheet name to the absolute cell reference
+    # e.g. A1:B2 -> 'Sheet1'!$A$1:$B$2
+    # @return [String]
+    def defined_name
+      return unless range
+
+      Axlsx.cell_range(range.split(':').collect { |name| worksheet.name_to_cell(name) })
+    end
+
+    # A collection of filterColumns for this auto_filter
+    # @return [SimpleTypedList]
+    def columns
+      @columns ||= SimpleTypedList.new FilterColumn
+    end
+
+    # Adds a filter column. This is the recommended way to create and manage filter columns for your autofilter.
+    # In addition to the require id and type parameters, options will be passed to the filter column during instantiation.
+    # @param [String] col_id Zero-based index indicating the AutoFilter column to which this filter information applies.
+    # @param [Symbol] filter_type A symbol representing one of the supported filter types.
+    # @param [Hash] options a hash of options to pass into the generated filter
+    # @return [FilterColumn]
+    def add_column(col_id, filter_type, options = {})
+      columns << FilterColumn.new(col_id, filter_type, options)
+      columns.last
+    end
+
+    # actually performs the filtering of rows who's cells do not
+    # match the filter.
+    def apply
+      first_cell, last_cell = range.split(':')
+      start_point = Axlsx::name_to_indices(first_cell)
+      end_point = Axlsx::name_to_indices(last_cell)
+      # The +1 is so we skip the header row with the filter drop downs
+      rows = worksheet.rows[(start_point.last + 1)..end_point.last] || []
+
+      column_offset = start_point.first
+      columns.each do |column|
+        rows.each do |row|
+          next if row.hidden
+
+          column.apply(row, column_offset)
+        end
+      end
+    end
+
+    # serialize the object
+    # @return [String]
+    def to_xml_string(str = '')
+      return unless range
+
+      str << "<autoFilter ref='#{range}'>"
+      columns.each { |filter_column| filter_column.to_xml_string(str) }
+      str << "</autoFilter>"
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/auto_filter/filter_column.rb

@@ -1,94 +1,94 @@
-module Axlsx
-  # The filterColumn collection identifies a particular column in the AutoFilter
-  # range and specifies filter information that has been applied to this column.
-  # If a column in the AutoFilter range has no criteria specified,
-  # then there is no corresponding filterColumn collection expressed for that column.
-  class FilterColumn
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-    # Creates a new FilterColumn object
-    # @note This class yeilds its filter object as that is where the vast majority of processing will be done
-    # @param [Integer|Cell] col_id The zero based index for the column to which this filter will be applied
-    # @param [Symbol] filter_type The symbolized class name of the filter to apply to this column.
-    # @param [Hash] options options for this object and the filter
-    # @option [Boolean] hidden_button @see hidden_button
-    # @option [Boolean] show_button @see show_button
-    def initialize(col_id, filter_type, options = {})
-      RestrictionValidator.validate 'FilterColumn.filter', FILTERS, filter_type
-      #Axlsx::validate_unsigned_int(col_id)
-      self.col_id = col_id
-      parse_options options
-      @filter = Axlsx.const_get(Axlsx.camel(filter_type)).new(options)
-      yield @filter if block_given?
-    end
-
-    serializable_attributes :col_id, :hidden_button, :show_button
-
-    # Allowed filters
-    FILTERS =  [:filters] #, :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
-
-    # Zero-based index indicating the AutoFilter column to which this filter information applies.
-    # @return [Integer]
-    attr_reader :col_id
-
-    # The actual filter being dealt with here
-    # This could be any one of the allowed filter types
-    attr_reader :filter
-
-    # Flag indicating whether the filter button is visible.
-    # When the cell containing the filter button is merged with another cell,
-    # the filter button can be hidden, and not drawn.
-    # @return [Boolean]
-    def show_button
-      @show_button ||= true
-    end
-
-    # Flag indicating whether the AutoFilter button for this column is hidden.
-    # @return [Boolean]
-    def hidden_button
-      @hidden_button ||= false
-    end
-
-    # Sets the col_id attribute for this filter column.
-    # @param [Integer | Cell] column_index The zero based index of the column to which this filter applies. 
-    #                         When you specify a cell, the column index will be read off the cell
-    # @return [Integer]
-    def col_id=(column_index)
-      column_index = column_index.col if column_index.is_a?(Cell)
-      Axlsx.validate_unsigned_int column_index
-      @col_id = column_index
-    end
-
-    # Apply the filters for this column
-    # @param [Array] row A row from a worksheet that needs to be
-    # filtered.
-    def apply(row, offset)
-      row.hidden = @filter.apply(row.cells[offset+col_id.to_i])
-    end
-    # @param [Boolean] hidden Flag indicating whether the AutoFilter button for this column is hidden.
-    # @return [Boolean]
-    def hidden_button=(hidden)
-      Axlsx.validate_boolean hidden
-      @hidden_button = hidden
-    end
-
-    # Flag indicating whether the AutoFilter button is show. This is
-    # undocumented in the spec, but exists in the schema file as an
-    # optional attribute.
-    # @param [Boolean] show Show or hide the button
-    # @return [Boolean]
-    def show_button=(show)
-      Axlsx.validate_boolean show
-      @show_botton = show
-    end
-
-    # Serialize the object to xml
-    def to_xml_string(str='')
-      str << "<filterColumn #{serialized_attributes}>"
-      @filter.to_xml_string(str)
-      str << "</filterColumn>"
-    end
-  end
-end
+module Axlsx
+  # The filterColumn collection identifies a particular column in the AutoFilter
+  # range and specifies filter information that has been applied to this column.
+  # If a column in the AutoFilter range has no criteria specified,
+  # then there is no corresponding filterColumn collection expressed for that column.
+  class FilterColumn
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new FilterColumn object
+    # @note This class yeilds its filter object as that is where the vast majority of processing will be done
+    # @param [Integer|Cell] col_id The zero based index for the column to which this filter will be applied
+    # @param [Symbol] filter_type The symbolized class name of the filter to apply to this column.
+    # @param [Hash] options options for this object and the filter
+    # @option [Boolean] hidden_button @see hidden_button
+    # @option [Boolean] show_button @see show_button
+    def initialize(col_id, filter_type, options = {})
+      RestrictionValidator.validate 'FilterColumn.filter', FILTERS, filter_type
+      # Axlsx::validate_unsigned_int(col_id)
+      self.col_id = col_id
+      parse_options options
+      @filter = Axlsx.const_get(Axlsx.camel(filter_type)).new(options)
+      yield @filter if block_given?
+    end
+
+    serializable_attributes :col_id, :hidden_button, :show_button
+
+    # Allowed filters
+    FILTERS = [:filters] # , :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
+
+    # Zero-based index indicating the AutoFilter column to which this filter information applies.
+    # @return [Integer]
+    attr_reader :col_id
+
+    # The actual filter being dealt with here
+    # This could be any one of the allowed filter types
+    attr_reader :filter
+
+    # Flag indicating whether the filter button is visible.
+    # When the cell containing the filter button is merged with another cell,
+    # the filter button can be hidden, and not drawn.
+    # @return [Boolean]
+    def show_button
+      @show_button ||= true
+    end
+
+    # Flag indicating whether the AutoFilter button for this column is hidden.
+    # @return [Boolean]
+    def hidden_button
+      @hidden_button ||= false
+    end
+
+    # Sets the col_id attribute for this filter column.
+    # @param [Integer | Cell] column_index The zero based index of the column to which this filter applies.
+    #                         When you specify a cell, the column index will be read off the cell
+    # @return [Integer]
+    def col_id=(column_index)
+      column_index = column_index.col if column_index.is_a?(Cell)
+      Axlsx.validate_unsigned_int column_index
+      @col_id = column_index
+    end
+
+    # Apply the filters for this column
+    # @param [Array] row A row from a worksheet that needs to be
+    # filtered.
+    def apply(row, offset)
+      row.hidden = @filter.apply(row.cells[offset + col_id.to_i])
+    end
+
+    # @param [Boolean] hidden Flag indicating whether the AutoFilter button for this column is hidden.
+    # @return [Boolean]
+    def hidden_button=(hidden)
+      Axlsx.validate_boolean hidden
+      @hidden_button = hidden
+    end
+
+    # Flag indicating whether the AutoFilter button is show. This is
+    # undocumented in the spec, but exists in the schema file as an
+    # optional attribute.
+    # @param [Boolean] show Show or hide the button
+    # @return [Boolean]
+    def show_button=(show)
+      Axlsx.validate_boolean show
+      @show_botton = show
+    end
+
+    # Serialize the object to xml
+    def to_xml_string(str = '')
+      str << "<filterColumn #{serialized_attributes}>"
+      @filter.to_xml_string(str)
+      str << "</filterColumn>"
+    end
+  end
+end