rubyXL 3.3.29 → 3.4.33

data/lib/rubyXL/objects/worksheet.rb

@@ -10,11 +10,11 @@ require 'rubyXL/objects/column_range'
 require 'rubyXL/objects/filters'
 require 'rubyXL/objects/data_validation'
 require 'rubyXL/objects/comments'
+require 'rubyXL/objects/connection'
+require 'rubyXL/objects/query_table'
 require 'rubyXL/worksheet'
-require 'rubyXL/convenience_methods'
 
 module RubyXL
-
   # Eventually, the entire code for Worksheet will be moved here. One small step at a time!
 
   # http://www.datypic.com/sc/ooxml/e-ssml_outlinePr-1.html
@@ -57,7 +57,7 @@ module RubyXL
   end
 
   class WorksheetFormatProperties < OOXMLObject
-    define_attribute(:baseColWidth,     :int,    :default => 8)
+    define_attribute(:baseColWidth,     :int, :default => 8)
     define_attribute(:defaultColWidth,  :double)
     define_attribute(:defaultRowHeight, :double, :required => true)
     define_attribute(:customHeight,     :bool,   :default => false)
@@ -82,12 +82,12 @@ module RubyXL
     define_attribute(:blackAndWhite,      :bool,   :default => false)
     define_attribute(:draft,              :bool,   :default => false)
     define_attribute(:cellComments,       RubyXL::ST_CellComments, :default => 'none')
-    define_attribute(:useFirstPageNumber, :bool,   :default => false)
+    define_attribute(:useFirstPageNumber, :bool, :default => false)
     define_attribute(:errors,             RubyXL::ST_PrintError, :default => 'displayed')
     define_attribute(:horizontalDpi,      :int,    :default => 600)
     define_attribute(:verticalDpi,        :int,    :default => 600)
     define_attribute(:copies,             :int,    :default => 1)
-    define_attribute(:'r:id',             :string)
+    define_relationship
     define_element_name 'pageSetup'
   end
 
@@ -165,7 +165,7 @@ module RubyXL
   class ConditionalFormatValue < OOXMLObject
     define_attribute(:type, RubyXL::ST_CfvoType, :required => true)
     define_attribute(:val,  :string)
-    define_attribute(:gte,  :bool,   :default => true)
+    define_attribute(:gte,  :bool, :default => true)
     define_child_node(RubyXL::ExtensionStorageArea)
     define_element_name 'cfvo'
   end
@@ -173,7 +173,7 @@ module RubyXL
   # http://www.datypic.com/sc/ooxml/e-ssml_colorScale-1.html
   class ColorScale < OOXMLObject
     define_child_node(RubyXL::ConditionalFormatValue, :collection => true, :accessor => :cfvo)
-    define_child_node(RubyXL::Color)
+    define_child_node(RubyXL::Color, :collection => true)
     define_element_name 'colorScale'
   end
 
@@ -183,7 +183,7 @@ module RubyXL
     define_attribute(:maxLength, :int,  :default => 90)
     define_attribute(:showValue, :bool, :default => true)
     define_child_node(RubyXL::ConditionalFormatValue, :collection => true, :accessor => :cfvo)
-    define_child_node(RubyXL::Color)
+    define_child_node(RubyXL::Color, :collection => true)
     define_element_name 'dataBar'
   end
 
@@ -211,7 +211,7 @@ module RubyXL
     define_attribute(:timePeriod,   RubyXL::ST_TimePeriod)
     define_attribute(:rank,         :int)
     define_attribute(:stdDev,       :int)
-    define_attribute(:equalAverage, :bool,   :default  => false)
+    define_attribute(:equalAverage, :bool, :default => false)
     define_child_node(RubyXL::Formula, :collection => true, :node_name => :formula, :accessor => :formulas)
     define_child_node(RubyXL::ColorScale)
     define_child_node(RubyXL::DataBar)
@@ -300,8 +300,8 @@ module RubyXL
 
   # http://www.datypic.com/sc/ooxml/e-ssml_hyperlink-1.html
   class Hyperlink < OOXMLObject
-    define_attribute(:ref,      :ref,    :required => true)
-    define_attribute(:'r:id',   :string)
+    define_attribute(:ref, :ref, :required => true)
+    define_relationship
     define_attribute(:location, :string)
     define_attribute(:tooltip,  :string)
     define_attribute(:display,  :string)
@@ -322,7 +322,7 @@ module RubyXL
     define_attribute(:oleUpdate, RubyXL::ST_OleUpdate)
     define_attribute(:autoLoad,  :bool, :default => false)
     define_attribute(:shapeId,   :int,  :required => true)
-    define_attribute(:'r:id',    :string)
+    define_relationship
     define_element_name 'oleObject'
   end
 
@@ -338,7 +338,7 @@ module RubyXL
     define_attribute(:ref,    :ref)
     define_attribute(:name,   :string)
     define_attribute(:sheet,  :string)
-    define_attribute(:'r:id', :string)
+    define_relationship
     define_element_name 'dataRef'
   end
 
@@ -362,7 +362,7 @@ module RubyXL
   class Pane < OOXMLObject
     define_attribute(:xSplit,      :double)
     define_attribute(:ySplit,      :double)
-    define_attribute(:topLeftCell, :string)
+    define_attribute(:topLeftCell, :ref)
     define_attribute(:activePane,  RubyXL::ST_Pane,      :default => 'topLeft')
     define_attribute(:state,       RubyXL::ST_PaneState, :default => 'split')
     define_element_name 'pane'
@@ -407,9 +407,9 @@ module RubyXL
     define_attribute(:hiddenRows,     :bool,   :default => false)
     define_attribute(:hiddenColumns,  :bool,   :default => false)
     define_attribute(:state,          RubyXL::ST_Visibility, :default => 'visible')
-    define_attribute(:filterUnique,   :bool,   :default => false)
+    define_attribute(:filterUnique,   :bool, :default => false)
     define_attribute(:view,           RubyXL::ST_SheetViewType, :default => 'normal')
-    define_attribute(:showRuler,      :bool,   :default => true)
+    define_attribute(:showRuler,      :bool, :default => true)
     define_attribute(:topLeftCell,    :ref)
     define_child_node(RubyXL::Pane)
     define_child_node(RubyXL::Selection)
@@ -432,9 +432,9 @@ module RubyXL
 
   # http://www.datypic.com/sc/ooxml/e-ssml_control-1.html
   class EmbeddedControl < OOXMLObject
-    define_attribute(:shapeId, :int,    :required => true)
-    define_attribute(:'r:id',  :string, :required => true)
-    define_attribute(:name,    :string)
+    define_attribute(:shapeId, :int, :required => true)
+    define_relationship(:required => true)
+    define_attribute(:name, :string)
     define_element_name 'control'
   end
 
@@ -488,8 +488,8 @@ module RubyXL
 
   # http://www.datypic.com/sc/ooxml/e-ssml_customPr-1.html
   class CustomProperty < OOXMLObject
-    define_attribute(:name,   :string, :required => true)
-    define_attribute(:'r:id', :string, :required => true)
+    define_attribute(:name, :string, :required => true)
+    define_relationship(:required => true)
     define_element_name 'customPr'
   end
 
@@ -545,7 +545,7 @@ module RubyXL
     define_attribute(:cacheIndex,    :bool, :default => false)
     define_attribute(:outline,       :bool, :default => true)
     define_attribute(:offset,        :ref)
-    define_attribute(:collapsedLevelsAreSubtotals, :bool,   :default => false)
+    define_attribute(:collapsedLevelsAreSubtotals, :bool, :default => false)
     define_attribute(:axis,          RubyXL::ST_Axis)
     define_attribute(:fieldPosition, :int,  :default => 0)
     define_child_node(RubyXL::PivotReferences)
@@ -571,7 +571,7 @@ module RubyXL
     define_attribute(:previousRow, :uint, :default => 0)
     define_attribute(:previousCol, :uint, :default => 0)
     define_attribute(:click,       :uint, :default => 0)
-    define_attribute(:'r:id',      :string)
+    define_relationship
     define_child_node(RubyXL::PivotArea)
     define_element_name 'pivotSelection'
   end
@@ -596,10 +596,10 @@ module RubyXL
     define_attribute(:zoomScaleNormal,          :uint, :default => 0)
     define_attribute(:zoomScaleSheetLayoutView, :uint, :default => 0)
     define_attribute(:zoomScalePageLayoutView,  :uint, :default => 0)
-    define_attribute(:workbookViewId,           :uint, :required => true, :default => 0 )
+    define_attribute(:workbookViewId,           :uint, :required => true, :default => 0)
     define_child_node(RubyXL::Pane)
     define_child_node(RubyXL::Selection, :collection => true, :accessor => :selections)
-    define_child_node(RubyXL::PivotTableSelection, :collection => true, :accessor => :pivot_table_selections )
+    define_child_node(RubyXL::PivotTableSelection, :collection => true, :accessor => :pivot_table_selections)
     define_child_node(RubyXL::ExtensionStorageArea)
     define_element_name 'sheetView'
   end
@@ -613,8 +613,8 @@ module RubyXL
 
   # http://www.datypic.com/sc/ooxml/e-ssml_worksheet.html
   class Worksheet < OOXMLTopLevelObject
-    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml'
-    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet'
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml'.freeze
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet'.freeze
 
     include RubyXL::RelationshipSupport
 
@@ -630,9 +630,11 @@ module RubyXL
     define_relationship(RubyXL::PivotTableFile)
     define_relationship(RubyXL::TableFile)
     define_relationship(RubyXL::ControlPropertiesFile)
+    define_relationship(RubyXL::CustomPropertyFile)
     define_relationship(RubyXL::SlicerFile)
     define_relationship(RubyXL::OLEObjectFile)
     define_relationship(RubyXL::ActiveX)
+    define_relationship(RubyXL::QueryTable)
 
     define_child_node(RubyXL::WorksheetProperties)
     define_child_node(RubyXL::WorksheetDimensions)
@@ -648,7 +650,7 @@ module RubyXL
     define_child_node(RubyXL::SortState)
     define_child_node(RubyXL::DataConsolidate)
     define_child_node(RubyXL::CustomSheetViews)
-    define_child_node(RubyXL::MergedCells,           :accessor => :merged_cells)
+    define_child_node(RubyXL::MergedCells, :accessor => :merged_cells)
     define_child_node(RubyXL::PhoneticProperties)
     define_child_node(RubyXL::ConditionalFormatting, :collection => [0..-1])
     define_child_node(RubyXL::DataValidations)
@@ -674,11 +676,11 @@ module RubyXL
     define_child_node(RubyXL::ExtensionStorageArea)
     define_child_node(RubyXL::AlternateContent)
     define_element_name 'worksheet'
-    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main' => nil,
+    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main'           => nil,
                    'http://schemas.openxmlformats.org/officeDocument/2006/relationships' => 'r',
-                   'http://schemas.openxmlformats.org/markup-compatibility/2006' => 'mc',
-                   'http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac' => 'x14ac',
-                   'urn:schemas-microsoft-com:mac:vml' => 'mv')
+                   'http://schemas.openxmlformats.org/markup-compatibility/2006'         => 'mc',
+                   'http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac'         => 'x14ac',
+                   'urn:schemas-microsoft-com:mac:vml'                                   => 'mv')
 
     attr_accessor :workbook, :state, :sheet_name, :sheet_id, :rels
 
@@ -741,8 +743,20 @@ module RubyXL
       sheet_obj
     end
 
+    def get_col_xf(column_index)
+      workbook.stylesheet.cell_xfs[get_col_style(column_index)]
+    end
+
+    def get_row_xf(row)
+      workbook.stylesheet.cell_xfs[get_row_style(row)]
+    end
+
+    def cell_at(ref)
+      reference = RubyXL::Reference.new(ref)
+      raise "Invalid reference: #{ref}" unless reference.valid? && reference.single_cell?
+      sheet_data&.rows&.[](reference.first_row)&.cells&.[](reference.first_col)
+    end
+
     include LegacyWorksheet
-    include WorksheetConvenienceMethods
   end
-
 end

data/lib/rubyXL/parser.rb

@@ -1,6 +1,5 @@
 module RubyXL
   class Parser
-
     # Parse <tt>.xslx</tt> file by reading it from local disk.
     def self.parse(src_file_path)
       begin
@@ -18,12 +17,11 @@ module RubyXL
     def self.parse_buffer(buffer)
       root = nil # Zip::File.open_buffer somehow fails to return the value from the block :(
       begin
-        ::Zip::File.open_buffer(buffer) { |zip_file| root = RubyXL::WorkbookRoot.parse_zip_file(zip_file)  } 
+        ::Zip::File.open_buffer(buffer) { |zip_file| root = RubyXL::WorkbookRoot.parse_zip_file(zip_file) }
         root.workbook
       rescue ::Zip::Error => e
         raise e, "XLSX file format error: #{e}", e.backtrace
       end
     end
-
   end
 end

data/lib/rubyXL/worksheet.rb

@@ -1,105 +1,105 @@
 module RubyXL
-module LegacyWorksheet
-  include Enumerable
-
-  def initialize(params = {})
-    super
-    self.workbook   = params[:workbook]
-    self.sheet_name = params[:sheet_name]
-    self.sheet_id   = params[:sheet_id]
-    self.sheet_data = RubyXL::SheetData.new
-    self.cols = RubyXL::ColumnRanges.new
-    @comments = [] # Do not optimize! These are arrays, so they will share the pointer!
-    @printer_settings = []
-    @generic_storage = []
-  end
+  module LegacyWorksheet
+    TEXT_LENGTH_LIMIT_IN_CELL = 32767 # 2 ** 15 - 1
+
+    include Enumerable
+
+    def initialize(params = {})
+      super
+      self.workbook   = params[:workbook]
+      self.sheet_name = params[:sheet_name]
+      self.sheet_id   = params[:sheet_id]
+      self.sheet_data = RubyXL::SheetData.new
+      self.cols = RubyXL::ColumnRanges.new
+      @comments = [] # Do not optimize! These are arrays, so they will share the pointer!
+      @printer_settings = []
+      @generic_storage = []
+    end
 
-  # allows for easier access to sheet_data
-  def [](row = 0)
-    sheet_data[row]
-  end
+    # allows for easier access to sheet_data
+    def [](row = 0)
+      sheet_data[row]
+    end
 
-  def each
-    sheet_data.rows.each { |row| yield(row) }
-  end
+    def each
+      sheet_data.rows.each { |row| yield(row) }
+    end
 
-  def add_row(row_index = 0, params = {})
-    new_row = RubyXL::Row.new(params)
-    new_row.worksheet = self
-    sheet_data.rows[row_index] = new_row
-  end
+    def add_row(row_index = 0, params = {})
+      new_row = RubyXL::Row.new(params)
+      new_row.worksheet = self
+      sheet_data.rows[row_index] = new_row
+    end
+
+    def add_cell(row_index = 0, column_index = 0, data = '', formula = nil, overwrite = true)
+      validate_workbook
+      validate_nonnegative(row_index)
+      validate_nonnegative(column_index)
+      row = sheet_data.rows[row_index] || add_row(row_index)
 
-  def add_cell(row_index = 0, column_index = 0, data = '', formula = nil, overwrite = true)
-    validate_workbook
-    validate_nonnegative(row_index)
-    validate_nonnegative(column_index)
-    row = sheet_data.rows[row_index] || add_row(row_index)
-
-    c = row.cells[column_index]
-
-    if overwrite || c.nil?
-      c = RubyXL::Cell.new
-      c.worksheet = self
-      c.row = row_index
-      c.column = column_index
-
-      if formula then
-        c.formula = RubyXL::Formula.new(:expression => formula)
-        c.raw_value = data
-      else
-        case data
-        when Numeric          then c.raw_value = data
-        when String           then
+      c = row.cells[column_index]
+
+      if overwrite || c.nil?
+        c = RubyXL::Cell.new
+        c.worksheet = self
+        c.row = row_index
+        c.column = column_index
+
+        if formula then
+          c.formula = RubyXL::Formula.new(:expression => formula)
           c.raw_value = data
-          c.datatype = RubyXL::DataType::RAW_STRING
-        when RubyXL::RichText then
-          c.is = data
-          c.datatype = RubyXL::DataType::INLINE_STRING
-        when NilClass         then nil
+        else
+          case data
+          when Numeric          then c.raw_value = data
+          when String           then
+            if data.length > TEXT_LENGTH_LIMIT_IN_CELL
+              raise ArgumentError, "The maximum length of cell contents (text) is #{TEXT_LENGTH_LIMIT_IN_CELL} characters"
+            end
+            c.raw_value = data
+            c.datatype = RubyXL::DataType::RAW_STRING
+          when RubyXL::RichText then
+            if data.to_s.length > TEXT_LENGTH_LIMIT_IN_CELL
+              raise ArgumentError, "The maximum length of cell contents (text) is #{TEXT_LENGTH_LIMIT_IN_CELL} characters"
+            end
+            c.is = data
+            c.datatype = RubyXL::DataType::INLINE_STRING
+          when Time, Date, DateTime then
+            c.raw_value = workbook.date_to_num(data)
+          when NilClass then nil
+          end
         end
+
+        range = cols&.locate_range(column_index)
+        c.style_index = row.style_index || range&.style_index || 0
+        row.cells[column_index] = c
       end
 
-      range = cols && cols.locate_range(column_index)
-      c.style_index = row.style_index || (range && range.style_index) || 0
-      row.cells[column_index] = c
+      c
     end
 
-    c
-  end
+    private
 
-  private
+    # validates Workbook, ensures that this worksheet is in @workbook
+    def validate_workbook
+      unless @workbook.nil? || @workbook.worksheets.nil?
+        return if @workbook.worksheets.any? { |sheet| sheet.equal?(self) }
+      end
 
-  #validates Workbook, ensures that this worksheet is in @workbook
-  def validate_workbook()
-    unless @workbook.nil? || @workbook.worksheets.nil?
-      return if @workbook.worksheets.any? { |sheet| sheet.equal?(self) }
+      raise "This worksheet #{self} is not in workbook #{@workbook}"
     end
 
-    raise "This worksheet #{self} is not in workbook #{@workbook}"
-  end
-
-  # Ensures that storage space for a cell with +row_index+ and +column_index+
-  # exists in +sheet_data+ arrays, growing them up if necessary.
-  def ensure_cell_exists(row_index, column_index = 0)
-    validate_nonnegative(row_index)
-    validate_nonnegative(column_index)
-
-    sheet_data.rows[row_index] || add_row(row_index)
-  end
-
-  def get_col_xf(column_index)
-    @workbook.cell_xfs[get_col_style(column_index)]
-  end
+    # Ensures that storage space for a cell with +row_index+ and +column_index+
+    # exists in +sheet_data+ arrays, growing them up if necessary.
+    def ensure_cell_exists(row_index, column_index = 0)
+      validate_nonnegative(row_index)
+      validate_nonnegative(column_index)
 
-  def get_row_xf(row)
-    validate_nonnegative(row)
-    @workbook.cell_xfs[get_row_style(row)]
-  end
+      sheet_data.rows[row_index] || add_row(row_index)
+    end
 
-  def validate_nonnegative(row_or_col)
-    raise 'Row and Column arguments must be nonnegative' if row_or_col < 0
+    def validate_nonnegative(row_or_col)
+      raise 'Row and Column arguments must be nonnegative' if row_or_col < 0
+    end
+    private :validate_nonnegative
   end
-  private :validate_nonnegative
-
-end #end class
 end

data/lib/rubyXL.rb

@@ -2,11 +2,11 @@ require 'rubyXL/objects/root'
 require 'rubyXL/parser'
 
 module RubyXL
+  @@suppress_warnings = false
 
   # Convert any path passed to absolute path (within the XLSX file).
   def self.from_root(path)
     return path unless path.absolute?
     path.relative_path_from(OOXMLTopLevelObject::ROOT)
   end
-
 end