axlsx 1.2.3 → 1.3.1

data/lib/axlsx.rb

@@ -37,7 +37,12 @@ if !Object.respond_to?(:instance_values)
   end
 end
 
-# xlsx generation with charts, images, automated column width, customizable styles and full schema validation. Axlsx excels at helping you generate beautiful Office Open XML Spreadsheet documents without having to understand the entire ECMA specification. Check out the README for some examples of how easy it is. Best of all, you can validate your xlsx file before serialization so you know for sure that anything generated is going to load on your client's machine.
+# xlsx generation with charts, images, automated column width, customizable styles
+# and full schema validation. Axlsx excels at helping you generate beautiful
+# Office Open XML Spreadsheet documents without having to understand the entire
+# ECMA specification. Check out the README for some examples of how easy it is.
+# Best of all, you can validate your xlsx file before serialization so you know
+# for sure that anything generated is going to load on your client's machine.
 module Axlsx
 
   # determines the cell range for the items provided
@@ -65,6 +70,7 @@ module Axlsx
   # returns the x, y position of a cell
   def self.name_to_indices(name)
     raise ArgumentError, 'invalid cell name' unless name.size > 1
+    # capitalization?!?
     v = name[/[A-Z]+/].reverse.chars.reduce({:base=>1, :i=>0}) do  |val, c|
       val[:i] += ((c.bytes.first - 64) * val[:base]); val[:base] *= 26; val
     end
@@ -95,6 +101,7 @@ module Axlsx
   # @param [String] s The snake case string to camelize
   # @return [String]
   def self.camel(s="", all_caps = true)
+    s = s.to_s
     s = s.capitalize if all_caps
     s.gsub(/_(.)/){ $1.upcase }
   end

data/lib/axlsx/stylesheet/styles.rb

@@ -279,6 +279,10 @@ module Axlsx
     # @return [Font|Integer]
     def parse_font_options(options={})
       return if (options.keys & [:fg_color, :sz, :b, :i, :u, :strike, :outline, :shadow, :charset, :family, :font_name]).empty?
+      fonts.first.instance_values.each do |key, value|
+        # Thanks for that 1.8.7 - cant do a simple merge...
+        options[key.to_sym] = value unless options.keys.include?(key.to_sym)
+      end
       font = Font.new(options)
       font.color = Color.new(:rgb => options[:fg_color]) if options[:fg_color]
       font.name = options[:font_name] if options[:font_name]

data/lib/axlsx/util/constants.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module Axlsx
 
   # XML Encoding
@@ -129,7 +128,7 @@ module Axlsx
 
   # digital signature origin content type
   DIGITAL_SIGNATURE_ORIGIN_CT = "application/vnd.openxmlformats-package.digital-signature-origin"
-  
+
   # digital signature certificate content type
   DIGITAL_SIGNATURE_CERTIFICATE_CT = "application/vnd.openxmlformats-package.digital-signature-certificate"
 
@@ -151,7 +150,7 @@ module Axlsx
   #drawing content type
   DRAWING_CT = "application/vnd.openxmlformats-officedocument.drawing+xml"
 
-  
+
   # xml content type extensions
   XML_EX = "xml"
 
@@ -263,11 +262,14 @@ module Axlsx
   # error message for RegexValidator
   ERR_REGEX = "Invalid Data. %s does not match %s."
 
+  # error message for RangeValidator
+  ERR_RANGE = "Invalid Data. %s must be between %s and %s, (inclusive:%s) you gave: %s"
+
   # error message for sheets that use a name which is longer than 31 bytes
   ERR_SHEET_NAME_TOO_LONG = "Your worksheet name '%s' is too long. Worksheet names must be 31 characters (bytes) or less"
-  
+
   # error message for sheets that use a name which includes a colon
-  
+
   ERR_SHEET_NAME_COLON_FORBIDDEN = "Your worksheet name '%s' contains a colon, which is not allowed by MS Excel and will cause repair warnings. Please change the name of your sheet."
 
   # error message for duplicate sheet names
@@ -284,4 +286,87 @@ module Axlsx
 
   # error message for non 'integerish' value
   ERR_INTEGERISH = "You value must be, or be castable via to_i, an Integer. You provided %s"
+
+  # Regex to match forbidden control characters
+  # The following will be automatically stripped from worksheets.
+  #
+  # x00 Null
+  # x01 Start Of Heading
+  # x02 Start Of Text
+  # x03End Of Text
+  # x04 End Of Transmission
+  # x05 Enquiry
+  # x06 Acknowledge
+  # x07 Bell
+  # x08 Backspace
+  # x0B Line Tabulation
+  # x0C Form Feed
+  # x0E Shift Out
+  # x0F Shift In
+  # x10 Data Link Escape
+  # x11 Device Control One
+  # x12 Device Control Two
+  # x13 Device Control Three
+  # x14 Device Control Four
+  # x15 Negative Acknowledge
+  # x16 Synchronous Idle
+  # x17 End Of Transmission Block
+  # x18 Cancel
+  # x19 End Of Medium
+  # x1A Substitute
+  # x1B Escape
+  # x1C Information Separator Four
+  # x1D Information Separator Three
+  # x1E Information Separator Two
+  # x1F Information Separator One
+  #
+  # The following are not dealt with. 
+  # If you have this in your data, expect excel to blow up!
+  #
+  # x7F	Delete
+  # x80	Control 0080
+  # x81	Control 0081
+  # x82	Break Permitted Here
+  # x83	No Break Here
+  # x84	Control 0084
+  # x85	Next Line (Nel)
+  # x86	Start Of Selected Area
+  # x87	End Of Selected Area
+  # x88	Character Tabulation Set
+  # x89	Character Tabulation With Justification
+  # x8A	Line Tabulation Set
+  # x8B	Partial Line Forward
+  # x8C	Partial Line Backward
+  # x8D	Reverse Line Feed
+  # x8E	Single Shift Two
+  # x8F	Single Shift Three
+  # x90	Device Control String
+  # x91	Private Use One
+  # x92	Private Use Two
+  # x93	Set Transmit State
+  # x94	Cancel Character
+  # x95	Message Waiting
+  # x96	Start Of Guarded Area
+  # x97	End Of Guarded Area
+  # x98	Start Of String
+  # x99	Control 0099
+  # x9A	Single Character Introducer
+  # x9B	Control Sequence Introducer
+  # x9C	String Terminator
+  # x9D	Operating System Command
+  # x9E	Privacy Message
+  # x9F	Application Program Command
+  #
+  # The following are allowed:
+  #
+  # x0A Line Feed (Lf)
+  # x0D Carriage Return (Cr)
+  # x09 Character Tabulation
+  # @see http://www.codetable.net/asciikeycodes
+  pattern = "[\x0-\x08\x0B\x0C\x0E-\x1F]"
+  pattern= pattern.respond_to?(:encode) ? pattern.encode('UTF-8') : pattern
+  
+  # The regular expression used to remove control characters from worksheets
+  CONTROL_CHAR_REGEX = Regexp.new(pattern, 'n')
+
 end

data/lib/axlsx/util/validators.rb

@@ -14,6 +14,24 @@ module Axlsx
     end
   end
 
+  # Validate that the value provided is between a specific range
+  # Note that no data conversions will be done for you!
+  # Comparisons will be made using < and > or <= and <= when the inclusive parameter is true
+  class RangeValidator
+    # @param [String] name The name of what is being validated
+    # @param [Any] min The minimum allowed value
+    # @param [Any] max The maximum allowed value
+    # @param [Any] value The value to be validated
+    # @param [Boolean] inclusive Flag indicating if the comparison should be inclusive.
+    def self.validate(name, min, max, value, inclusive = true)
+      passes = if inclusive
+                 min <= value && value <= max
+               else
+                 min < value && value < max
+               end
+      raise ArgumentError, (ERR_RANGE % [value.inspect, min.to_s, max.to_s, inclusive]) unless passes
+    end
+  end
   # Validates the value against the regular expression provided.
   class RegexValidator
     # @param [String] name The name of what is being validated. This is included in the output when the value is invalid
@@ -73,7 +91,7 @@ module Axlsx
   # @raise [ArgumentError] raised if the value is not a Fixnun, Integer, Float value greater or equal to 0
   # @return [Boolean] true if the data is valid
   def self.validate_unsigned_numeric(v)
-    DataTypeValidator.validate("Invalid column width", [Fixnum, Integer, Float], v, lambda { |arg| arg.respond_to?(:>=) && arg >= 0 })
+    DataTypeValidator.validate("Invalid column width", [Fixnum, Integer, Float], v, lambda { |arg| arg.respond_to?(:>=) && arg.to_i >= 0 })
   end
 
   # Requires that the value is a Fixnum or Integer
@@ -112,7 +130,7 @@ module Axlsx
   def self.validate_scale_10_400(v)
     DataTypeValidator.validate "page_scale", [Fixnum, Integer], v, lambda { |arg| arg >= 10 && arg <= 400 }
   end
-  
+
   # Requires that the value is an integer ranging from 10 to 400 or 0.
   def self.validate_scale_0_10_400(v)
     DataTypeValidator.validate "page_scale", [Fixnum, Integer], v, lambda { |arg| arg == 0 || (arg >= 10 && arg <= 400) }
@@ -129,7 +147,7 @@ module Axlsx
   # @param [Any] v The value validated
   def self.validate_pattern_type(v)
     RestrictionValidator.validate :pattern_type, [:none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, :darkVertical, :darkDown, :darkUp, :darkGrid,
-       :darkTrellis, :lightHorizontal, :lightVertical, :lightDown, :lightUp, :lightGrid, :lightTrellis, :gray125, :gray0625], v
+                                                  :darkTrellis, :lightHorizontal, :lightVertical, :lightDown, :lightUp, :lightGrid, :lightTrellis, :gray125, :gray0625], v
   end
 
   # Requires that the value is one of the ST_TimePeriod types
@@ -226,7 +244,7 @@ module Axlsx
   def self.validate_data_validation_error_style(v)
     RestrictionValidator.validate :validate_data_validation_error_style, [:information, :stop, :warning], v
   end
-  
+
   # Requires that the value is valid data validation operator.
   # valid operators must be one of lessThan, lessThanOrEqual, equal,
   # notEqual, greaterThanOrEqual, greaterThan, between, notBetween
@@ -234,28 +252,28 @@ module Axlsx
   def self.validate_data_validation_operator(v)
     RestrictionValidator.validate :data_validation_operator, [:lessThan, :lessThanOrEqual, :equal, :notEqual, :greaterThanOrEqual, :greaterThan, :between, :notBetween], v
   end
-  
+
   # Requires that the value is valid data validation type.
   # valid types must be one of custom, data, decimal, list, none, textLength, time, whole
   # @param [Any] v The value validated
   def self.validate_data_validation_type(v)
     RestrictionValidator.validate :data_validation_type, [:custom, :data, :decimal, :list, :none, :textLength, :time, :whole], v
   end
-  
+
   # Requires that the value is a valid sheet view type.
   # valid types must be one of normal, page_break_preview, page_layout
   # @param [Any] v The value validated
   def self.validate_sheet_view_type(v)
     RestrictionValidator.validate :sheet_view_type, [:normal, :page_break_preview, :page_layout], v
   end
-  
+
   # Requires that the value is a valid active pane type.
   # valid types must be one of bottom_left, bottom_right, top_left, top_right
   # @param [Any] v The value validated
   def self.validate_pane_type(v)
     RestrictionValidator.validate :active_pane_type, [:bottom_left, :bottom_right, :top_left, :top_right], v
   end
-  
+
   # Requires that the value is a valid split state type.
   # valid types must be one of frozen, frozen_split, split
   # @param [Any] v The value validated

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
-# encoding: UTF-8
 module Axlsx
+
   # The current version
-  VERSION="1.2.3"
+  VERSION = "1.3.1"
 end

data/lib/axlsx/workbook/workbook.rb

@@ -1,11 +1,13 @@
 # -*- coding: utf-8 -*-
 module Axlsx
-require 'axlsx/workbook/worksheet/auto_filter.rb'
+require 'axlsx/workbook/worksheet/sheet_calc_pr.rb'
+require 'axlsx/workbook/worksheet/auto_filter/auto_filter.rb'
 require 'axlsx/workbook/worksheet/date_time_converter.rb'
 require 'axlsx/workbook/worksheet/protected_range.rb'
 require 'axlsx/workbook/worksheet/protected_ranges.rb'
 require 'axlsx/workbook/worksheet/cell.rb'
 require 'axlsx/workbook/worksheet/page_margins.rb'
+require 'axlsx/workbook/worksheet/page_set_up_pr.rb'
 require 'axlsx/workbook/worksheet/page_setup.rb'
 require 'axlsx/workbook/worksheet/print_options.rb'
 require 'axlsx/workbook/worksheet/cfvo.rb'
@@ -33,6 +35,7 @@ require 'axlsx/workbook/worksheet/worksheet.rb'
 require 'axlsx/workbook/shared_strings_table.rb'
 require 'axlsx/workbook/defined_name.rb'
 require 'axlsx/workbook/defined_names.rb'
+require 'axlsx/workbook/worksheet/table_style_info.rb'
 require 'axlsx/workbook/worksheet/table.rb'
 require 'axlsx/workbook/worksheet/tables.rb'
 require 'axlsx/workbook/worksheet/data_validation.rb'

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

@@ -0,0 +1,77 @@
+
+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

@@ -0,0 +1,102 @@
+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
+
+    # Allowed filters
+    FILTERS =  [:filters] #, :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
+
+    # 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
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      @filter = Axlsx.const_get(Axlsx.camel(filter_type)).new(options)
+      yield @filter if block_given?
+    end
+
+    # 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
+
+    private
+
+    def serialized_attributes(str='')
+      instance_values.each do |key, value|
+        if %(show_button hidden_button col_id).include? key.to_s
+        str << "#{Axlsx.camel(key, false)}='#{value}' "
+        end
+      end
+      str
+    end
+  end
+end