axlsx 2.0.1 → 3.0.0.pre

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

@@ -4,14 +4,10 @@ module Axlsx
   # The Worksheet class represents a worksheet in the workbook.
   class Worksheet
     include Axlsx::OptionsParser
-
+    include Axlsx::SerializedAttributes
     # definition of characters which are less than the maximum width of 0-9 in the default font for use in String#count.
     # This is used for autowidth calculations
-    # @return [String]
-    def self.thin_chars
-      # removed 'e' and 'y' from this list - as a GUESS
-      @thin_chars ||= "^.acfijklrstxzFIJL()-"
-    end
+    THIN_CHARS = '^.acfijklrstxzFIJL()-'.freeze
 
     # Creates a new worksheet.
     # @note the recommended way to manage worksheets is Workbook#add_worksheet
@@ -24,12 +20,15 @@ module Axlsx
     def initialize(wb, options={})
       self.workbook = wb
       @sheet_protection = nil
-
       initialize_page_options(options)
       parse_options options
       @workbook.worksheets << self
+      @sheet_id = index + 1
+      yield self if block_given?
     end
 
+    serializable_attributes :sheet_id, :state
+
     # Initalizes page margin, setup and print options
     # @param [Hash] options Options passed in from the initializer
     def initialize_page_options(options)
@@ -44,7 +43,23 @@ module Axlsx
     # The name of the worksheet
     # @return [String]
     def name
-      @name ||=  "Sheet" + (index+1).to_s
+      @name ||= "Sheet" + (index+1).to_s
+    end
+
+    # Specifies the visible state of this sheet. Allowed states are
+    # :visible, :hidden or :very_hidden. The default value is :visible.
+    #
+    # Worksheets in the :hidden state can be shown using the sheet formatting properties in excel.
+    # :very_hidden sheets should be inaccessible to end users.
+    # @param [Symbol] sheet_state The visible state for this sheet.
+    def state=(sheet_state)
+      RestrictionValidator.validate :worksheet_state, [:visible, :hidden, :very_hidden], sheet_state
+      @state = sheet_state
+    end
+
+    # The visibility of this sheet
+    def state
+      @state ||= :visible
     end
 
     # The sheet calculation properties
@@ -76,7 +91,7 @@ module Axlsx
     # @see [SheetFormatPr]
     def sheet_format_pr
       @sheet_format_pr ||= SheetFormatPr.new
-      yeild @sheet_format_pr if block_given?
+      yield @sheet_format_pr if block_given?
       @sheet_format_pr
     end
 
@@ -129,7 +144,7 @@ module Axlsx
     # @return [SimpleTypedList]
     # @see Worksheet#add_row
     def rows
-      @rows ||=  SimpleTypedList.new Row
+      @rows ||= SimpleTypedList.new Row
     end
 
     # returns the sheet data as columns
@@ -137,12 +152,12 @@ module Axlsx
     # cell at a specific index. The block will be called with the row and column
     # index in the missing cell was found.
     # @example
-    #     cols { |row_index, column_index| p "warn - row #{row_index} is does not have a cell at #{column_index}
+    #     cols { |row_index, column_index| puts "warn - row #{row_index} does not have a cell at #{column_index}" }
     def cols(&block)
       @rows.transpose(&block)
     end
 
-    # An range that excel will apply an auto-filter to "A1:B3"
+    # A range that excel will apply an auto-filter to "A1:B3"
     # This will turn filtering on for the cells in the range.
     # The first row is considered the header, while subsequent rows are considered to be data.
     # @return String
@@ -249,7 +264,7 @@ module Axlsx
       @header_footer
     end
 
-    # convinience method to access all cells in this worksheet
+    # convenience method to access all cells in this worksheet
     # @return [Array] cells
     def cells
       rows.flatten
@@ -290,50 +305,6 @@ module Axlsx
       @sheet_pr ||= SheetPr.new self
     end
 
-    # Indicates if gridlines should be shown in the sheet.
-    # This is true by default.
-    # @return [Boolean]
-    # @deprecated Use SheetView#show_grid_lines= instead.
-    def show_gridlines=(v)
-      warn('axlsx::DEPRECIATED: Worksheet#show_gridlines= has been depreciated. This value can be set over SheetView#show_grid_lines=.')
-      Axlsx::validate_boolean v
-      sheet_view.show_grid_lines = v
-    end
-
-    # @see selected
-    # @return [Boolean]
-    # @deprecated Use SheetView#tab_selected= instead.
-    def selected=(v)
-      warn('axlsx::DEPRECIATED: Worksheet#selected= has been depreciated. This value can be set over SheetView#tab_selected=.')
-      Axlsx::validate_boolean v
-      sheet_view.tab_selected = v
-    end
-
-    # Indicates if the worksheet should show gridlines or not
-    # @return Boolean
-    # @deprecated Use SheetView#show_grid_lines instead.
-    def show_gridlines
-      warn('axlsx::DEPRECIATED: Worksheet#show_gridlines has been depreciated. This value can get over SheetView#show_grid_lines.')
-      sheet_view.show_grid_lines
-    end
-
-    # Indicates if the worksheet is selected in the workbook
-    # It is possible to have more than one worksheet selected, however it might cause issues
-    # in some older versions of excel when using copy and paste.
-    # @return Boolean
-    # @deprecated Use SheetView#tab_selected instead.
-    def selected
-      warn('axlsx::DEPRECIATED: Worksheet#selected has been depreciated. This value can get over SheetView#tab_selected.')
-      sheet_view.tab_selected
-    end
-
-    # (see #fit_to_page)
-    # @return [Boolean]
-    def fit_to_page=(v)
-      warn('axlsx::DEPRECIATED: Worksheet#fit_to_page has been depreciated. This value will automatically be set for you when you use PageSetup#fit_to.')
-      fit_to_page?
-    end
-
     # The name of the worksheet
     # The name of a worksheet must be unique in the workbook, and must not exceed 31 characters
     # @param [String] name
@@ -346,7 +317,7 @@ module Axlsx
     # @param [String] v
     # @see auto_filter
     def auto_filter=(v)
-      DataTypeValidator.validate "Worksheet.auto_filter", String, v
+      DataTypeValidator.validate :worksheet_auto_filter, String, v
       auto_filter.range = v
     end
 
@@ -427,10 +398,10 @@ module Axlsx
     # @option options [Array] widths each member of the widths array will affect how auto_fit behavies.
     # @option options [Float] height the row's height (in points)
     def add_row(values=[], options={})
-      Row.new(self, values, options)
-      update_column_info @rows.last.cells, options.delete(:widths) || []
-      yield @rows.last if block_given?
-      @rows.last
+      row = Row.new(self, values, options)
+      update_column_info row, options.delete(:widths)
+      yield row if block_given?
+      row
     end
 
     alias :<< :add_row
@@ -522,7 +493,7 @@ module Axlsx
     # @example
     #   ws.add_page_break("A4")
     def add_page_break(cell)
-      DataTypeValidator.validate "Worksheet#add_page_break cell", [String, Cell], cell
+      DataTypeValidator.validate :worksheet_page_break, [String, Cell], cell
       column_index, row_index = if cell.is_a?(String)
           Axlsx.name_to_indices(cell)
         else
@@ -535,12 +506,12 @@ module Axlsx
     end
 
     # This is a helper method that Lets you specify a fixed width for multiple columns in a worksheet in one go.
-    # Axlsx is sparse, so if you have not set data for a column, you cannot set the width.
+    # Note that you must call column_widths AFTER adding data, otherwise the width will not be set successfully.
     # Setting a fixed column width to nil will revert the behaviour back to calculating the width for you on the next call to add_row.
     # @example This would set the first and third column widhts but leave the second column in autofit state.
     #      ws.column_widths 7.2, nil, 3
     # @note For updating only a single column it is probably easier to just set the width of the ws.column_info[col_index].width directly
-    # @param [Integer|Float|Fixnum|nil] widths
+    # @param [Integer|Float|nil] widths
     def column_widths(*widths)
       widths.each_with_index do |value, index|
         next if value == nil
@@ -559,7 +530,7 @@ module Axlsx
     # @see README.md for an example
     def col_style(index, style, options={})
       offset = options.delete(:row_offset) || 0
-      cells = @rows[(offset..-1)].map { |row| row.cells[index] }.flatten.compact
+      cells = @rows[(offset..-1)].map { |row| row[index] }.flatten.compact
       cells.each { |cell| cell.style = style }
     end
 
@@ -577,18 +548,27 @@ module Axlsx
       cells.each { |cell| cell.style = style }
     end
 
+    # Returns a sheet node serialization for this sheet in the workbook.
+    def to_sheet_node_xml_string(str='')
+      add_autofilter_defined_name_to_workbook
+      str << '<sheet '
+      serialized_attributes str
+      str << ('name="' << name << '" ')
+      str << ('r:id="' << rId << '"></sheet>')
+    end
+
     # Serializes the worksheet object to an xml string
     # This intentionally does not use nokogiri for performance reasons
     # @return [String]
-    def to_xml_string
+    def to_xml_string str=''
+      add_autofilter_defined_name_to_workbook
       auto_filter.apply if auto_filter.range
-      str = '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
       str << worksheet_node
       serializable_parts.each do |item|
         item.to_xml_string(str) if item
       end
       str << '</worksheet>'
-      Axlsx::sanitize(str)
     end
 
     # The worksheet relationships. This is managed automatically by the worksheet
@@ -606,7 +586,7 @@ module Axlsx
     # Returns the cell or cells defined using excel style A1:B3 references.
     # @param [String|Integer] cell_def the string defining the cell or range of cells, or the rownumber
     # @return [Cell, Array]
-    def [] (cell_def)
+    def [](cell_def)
       return rows[cell_def] if cell_def.is_a?(Integer)
       parts = cell_def.split(':').map{ |part| name_to_cell part }
       if parts.size == 1
@@ -622,7 +602,7 @@ module Axlsx
     def name_to_cell(name)
       col_index, row_index = *Axlsx::name_to_indices(name)
       r = rows[row_index]
-      r.cells[col_index] if r
+      r[col_index] if r
     end
 
     # shortcut method to access styles direclty from the worksheet
@@ -675,7 +655,7 @@ module Axlsx
     end
 
     def validate_sheet_name(name)
-      DataTypeValidator.validate "Worksheet.name", String, name
+      DataTypeValidator.validate :worksheet_name, String, name
       raise ArgumentError, (ERR_SHEET_NAME_TOO_LONG % name) if name.size > 31
       raise ArgumentError, (ERR_SHEET_NAME_CHARACTER_FORBIDDEN % name) if '[]*/\?:'.chars.any? { |char| name.include? char }
       name = Axlsx::coder.encode(name)
@@ -695,8 +675,8 @@ module Axlsx
     def range(*cell_def)
       first, last = cell_def
       cells = []
-      rows[(first.row.index..last.row.index)].each do |r|
-        r.cells[(first.index..last.index)].each do |c|
+      rows[(first.row.row_index..last.row.row_index)].each do |r|
+        r[(first.index..last.index)].each do |c|
           cells << c
         end
       end
@@ -734,7 +714,7 @@ module Axlsx
     # Helper method for parsingout the root node for worksheet
     # @return [String]
     def worksheet_node
-       "<worksheet xmlns=\"%s\" xmlns:r=\"%s\" xml:space=\"#{xml_space}\">" % [XML_NS, XML_NS_R]
+      "<worksheet xmlns=\"#{XML_NS}\" xmlns:r=\"#{XML_NS_R}\" xml:space=\"#{xml_space}\">"
     end
 
     def sheet_data
@@ -753,11 +733,12 @@ module Axlsx
 
     def workbook=(v) DataTypeValidator.validate "Worksheet.workbook", Workbook, v; @workbook = v; end
 
-    def update_column_info(cells, widths=[])
+    def update_column_info(cells, widths=nil)
       cells.each_with_index do |cell, index|
+        width = widths ? widths[index] : nil
         col = find_or_create_column_info(index)
-        next if widths[index] == :ignore
-        col.update_width(cell, widths[index], workbook.use_autowidth)
+        next if width == :ignore
+        col.update_width(cell, width, workbook.use_autowidth)
       end
     end
 
@@ -765,5 +746,10 @@ module Axlsx
       column_info[index] ||= Col.new(index + 1, index + 1)
     end
 
+    def add_autofilter_defined_name_to_workbook
+      return if !auto_filter.range
+      workbook.add_defined_name auto_filter.defined_name, name: '_xlnm._FilterDatabase', local_sheet_id: index, hidden: 1
+    end
+
   end
 end

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

@@ -1,5 +1,5 @@
 module Axlsx
-  
+
   # This is a utility class for serialing the drawing node in a
   # worksheet. Drawing objects have their own serialization that exports
   # a drawing document. This is only for the single node in the
@@ -17,7 +17,7 @@ module Axlsx
     attr_reader :worksheet
 
     attr_reader :drawing
-    
+
     # adds a chart to the drawing object
     # @param [Class] chart_type The type of chart to add
     # @param [Hash] options Options to pass on to the drawing and chart
@@ -26,17 +26,17 @@ module Axlsx
       @drawing ||= Drawing.new worksheet
       drawing.add_chart(chart_type, options)
     end
-    
+
     # adds an image to the drawing object
-    # @param [Hash] options Options to pass on to the drawing and image 
+    # @param [Hash] options Options to pass on to the drawing and image
     # @see Worksheet#add_image
     def add_image(options)
-      @drawing ||= Drawing.new worksheet
+      @drawing ||= Drawing.new(worksheet)
       drawing.add_image(options)
-    end 
-  
+    end
+
     # helper method to tell us if the drawing has something in it or not
-    # @return [Boolean] 
+    # @return [Boolean]
     def has_drawing?
       @drawing.is_a? Drawing
     end
@@ -45,13 +45,13 @@ module Axlsx
     # @return [Relationship]
     def relationship
       return unless has_drawing?
-      Relationship.new(self, DRAWING_R, "../#{drawing.pn}") 
+      Relationship.new(self, DRAWING_R, "../#{drawing.pn}")
     end
 
     # Serialize the drawing for the worksheet
     # @param [String] str
     def to_xml_string(str = '')
-      return unless has_drawing? 
+      return unless has_drawing?
       str << "<drawing r:id='#{relationship.Id}'/>"
     end
   end

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

@@ -15,8 +15,8 @@ module Axlsx
     # @see WorksheetHyperlink#initialize
     # @return [WorksheetHyperlink]
     def add(options)
-      @list << WorksheetHyperlink.new(@worksheet, options)
-      @list.last
+      self << WorksheetHyperlink.new(@worksheet, options)
+      last
     end
 
     # The relationships required by this collection's hyperlinks
@@ -31,7 +31,7 @@ module Axlsx
     def to_xml_string(str='')
       return if empty?
       str << '<hyperlinks>'
-      @list.each { |hyperlink| hyperlink.to_xml_string(str) }
+      each { |hyperlink| hyperlink.to_xml_string(str) }
       str << '</hyperlinks>'
     end
   end

data/lib/axlsx.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 require 'htmlentities'
 require 'axlsx/version.rb'
+require 'mimemagic'
 
 require 'axlsx/util/simple_typed_list.rb'
 require 'axlsx/util/constants.rb'
@@ -10,6 +11,7 @@ require 'axlsx/util/serialized_attributes'
 require 'axlsx/util/options_parser'
 # to be included with parsable intitites.
 #require 'axlsx/util/parser.rb'
+require 'axlsx/util/mime_type_utils'
 
 require 'axlsx/stylesheet/styles.rb'
 
@@ -53,7 +55,7 @@ module Axlsx
     cells = sort_cells(cells)
     reference = "#{cells.first.reference(absolute)}:#{cells.last.reference(absolute)}"
     if absolute
-      escaped_name = cells.first.row.worksheet.name.gsub "'", "''"
+      escaped_name = cells.first.row.worksheet.name.gsub ''', "''"
       "'#{escaped_name}'!#{reference}"
     else
       reference
@@ -65,7 +67,7 @@ module Axlsx
   # @param [Array] cells
   # @return [Array]
   def self.sort_cells(cells)
-    cells.sort { |x, y| [x.index, x.row.index] <=> [y.index, y.row.index] }
+    cells.sort { |x, y| [x.index, x.row.row_index] <=> [y.index, y.row.row_index] }
   end
 
   #global reference html entity encoding
@@ -88,20 +90,21 @@ module Axlsx
   # @note This follows the standard spreadsheet convention of naming columns A to Z, followed by AA to AZ etc.
   # @return [String]
   def self.col_ref(index)
-    chars = []
+    chars = ''
     while index >= 26 do
-      chars << ((index % 26) + 65).chr
-      index = (index / 26).to_i - 1
+      index, char = index.divmod(26)
+      chars.prepend((char + 65).chr)
+      index -= 1
     end
-    chars << (index + 65).chr
-    chars.reverse.join
+    chars.prepend((index + 65).chr)
+    chars
   end
 
   # @return [String] The alpha(column)numeric(row) reference for this sell.
   # @example Relative Cell Reference
   #   ws.rows.first.cells.first.r #=> "A1"
   def self.cell_r(c_index, r_index)
-    Axlsx::col_ref(c_index).to_s << (r_index+1).to_s
+    col_ref(c_index) << (r_index+1).to_s
   end
 
   # Creates an array of individual cell references based on an excel reference range.
@@ -113,7 +116,7 @@ module Axlsx
     end_col,   end_row   = name_to_indices($2)
     (start_row..end_row).to_a.map do |row_num|
       (start_col..end_col).to_a.map do |col_num|
-        "#{col_ref(col_num)}#{row_num+1}"
+        cell_r(col_num, row_num)
       end
     end
   end
@@ -127,14 +130,30 @@ module Axlsx
     s.gsub(/_(.)/){ $1.upcase }
   end
 
-    # returns the provided string with all invalid control charaters
-    # removed.
-    # @param [String] str The sting to process
-    # @return [String]
-    def self.sanitize(str)
-      str.gsub(CONTROL_CHAR_REGEX, '')
+  # returns the provided string with all invalid control charaters
+  # removed.
+  # @param [String] str The string to process
+  # @return [String]
+  def self.sanitize(str)
+    if str.frozen?
+      str.delete(CONTROL_CHARS)
+    else
+      str.delete!(CONTROL_CHARS)
+      str
     end
+  end
 
+  # If value is boolean return 1 or 0
+  # else return the value
+  # @param [Object] value The value to process
+  # @return [Object]
+  def self.booleanize(value)
+    if value == true || value == false
+      value ? 1 : 0
+    else
+      value
+    end
+  end
 
   # Instructs the serializer to not try to escape cell value input.
   # This will give you a huge speed bonus, but if you content has <, > or other xml character data

data/test/drawing/tc_area_chart.rb

@@ -0,0 +1,39 @@
+require 'tc_helper.rb'
+
+class TestAreaChart < Test::Unit::TestCase
+
+  def setup
+    @p = Axlsx::Package.new
+    ws = @p.workbook.add_worksheet
+    @row = ws.add_row ["one", 1, Time.now]
+    @chart = ws.add_chart Axlsx::AreaChart, :title => "fishery"
+  end
+
+  def teardown
+  end
+
+  def test_initialization
+    assert_equal(@chart.grouping, :standard, "grouping defualt incorrect")
+    assert_equal(@chart.series_type, Axlsx::AreaSeries, "series type incorrect")
+    assert(@chart.cat_axis.is_a?(Axlsx::CatAxis), "category axis not created")
+    assert(@chart.val_axis.is_a?(Axlsx::ValAxis), "value access not created")
+  end
+
+  def test_grouping
+    assert_raise(ArgumentError, "require valid grouping") { @chart.grouping = :inverted }
+    assert_nothing_raised("allow valid grouping") { @chart.grouping = :stacked }
+    assert(@chart.grouping == :stacked)
+  end
+
+  def test_to_xml
+    schema = Nokogiri::XML::Schema(File.open(Axlsx::DRAWING_XSD))
+    doc = Nokogiri::XML(@chart.to_xml_string)
+    errors = []
+    schema.validate(doc).each do |error|
+      errors.push error
+      puts error.message
+    end
+    assert(errors.empty?, "error free validation")
+  end
+
+end

data/test/drawing/tc_area_series.rb

@@ -0,0 +1,71 @@
+require 'tc_helper.rb'
+
+class TestAreaSeries < Test::Unit::TestCase
+
+  def setup
+    p = Axlsx::Package.new
+    @ws = p.workbook.add_worksheet :name=>"hmmm"
+    chart = @ws.add_chart Axlsx::AreaChart, :title => "fishery"
+    @series = chart.add_series(
+      :data => [0,1,2],
+      :labels => ["zero", "one", "two"],
+      :title => "bob",
+      :color => "#FF0000",
+      :show_marker => true,
+      :smooth => true
+    )
+  end
+
+  def test_initialize
+    assert_equal(@series.title.text, "bob", "series title has been applied")
+    assert_equal(@series.labels.class, Axlsx::AxDataSource)
+    assert_equal(@series.data.class, Axlsx::NumDataSource)
+  end
+
+  def test_show_marker
+    assert_equal(true, @series.show_marker)
+    @series.show_marker = false
+    assert_equal(false, @series.show_marker)
+  end
+
+  def test_smooth
+    assert_equal(true, @series.smooth)
+    @series.smooth = false
+    assert_equal(false, @series.smooth)
+  end
+
+  def test_marker_symbol
+    assert_equal(:default, @series.marker_symbol)
+    @series.marker_symbol = :circle
+    assert_equal(:circle, @series.marker_symbol)
+  end
+
+  def test_to_xml_string
+    doc = Nokogiri::XML(wrap_with_namespaces(@series))
+    assert(doc.xpath("//srgbClr[@val='#{@series.color}']"))
+    assert_equal(xpath_with_namespaces(doc, "//c:marker").size, 0)
+    assert(doc.xpath("//smooth"))
+
+    @series.marker_symbol = :diamond
+    doc = Nokogiri::XML(wrap_with_namespaces(@series))
+    assert_equal(xpath_with_namespaces(doc, "//c:marker/c:symbol[@val='diamond']").size, 1)
+
+    @series.show_marker = false
+    doc = Nokogiri::XML(wrap_with_namespaces(@series))
+    assert_equal(xpath_with_namespaces(doc, "//c:marker/c:symbol[@val='none']").size, 1)
+  end
+
+  def wrap_with_namespaces(series)
+    '<c:chartSpace xmlns:c="' <<
+      Axlsx::XML_NS_C <<
+      '" xmlns:a="' <<
+      Axlsx::XML_NS_A <<
+      '">' <<
+      series.to_xml_string <<
+      '</c:chartSpace>'
+  end
+
+  def xpath_with_namespaces(doc, xpath)
+    doc.xpath(xpath, "a" => Axlsx::XML_NS_A, "c" => Axlsx::XML_NS_C)
+  end
+end

data/test/drawing/tc_axis.rb

@@ -61,6 +61,33 @@ class TestAxis < Test::Unit::TestCase
     assert_nothing_raised("accepts valid format code") { @axis.format_code = "00.##"  }
   end
 
+  def create_chart_with_formatting(format_string=nil)
+    p = Axlsx::Package.new
+    p.workbook.add_worksheet(:name => "Formatting Test") do |sheet|
+      sheet.add_row(['test', 20])
+      sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,5], :end_at => [10, 20], :title => "Test Formatting") do |chart|
+        chart.add_series :data => sheet["B1:B1"], :labels => sheet["A1:A1"]
+        chart.val_axis.format_code = format_string if format_string
+        doc = Nokogiri::XML(chart.to_xml_string)
+        yield doc
+      end
+    end
+  end
+
+  def test_format_code_resets_source_linked
+    create_chart_with_formatting("#,##0.00") do |doc|
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@formatCode='#,##0.00']").size, 1)
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@sourceLinked='0']").size, 1)
+    end
+  end
+
+  def test_no_format_code_keeps_source_linked
+    create_chart_with_formatting do |doc|
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@formatCode='General']").size, 1)
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@sourceLinked='1']").size, 1)
+    end
+  end
+
   def test_crosses
     assert_raise(ArgumentError, "requires valid crosses") { @axis.crosses = 1 }
     assert_nothing_raised("accepts valid crosses") { @axis.crosses = :min }