rubyXL 1.2.10 → 2.1.1

data/lib/rubyXL/objects/reference.rb

@@ -0,0 +1,110 @@
+module RubyXL
+  class Reference
+    ROW_MAX = 1024*1024
+    COL_MAX = 16393
+
+    attr_reader :row_range, :col_range
+
+    # RubyXL::Reference.new(row, col)
+    # RubyXL::Reference.new(row_from, row_to, col_from, col_to)
+    # RubyXL::Reference.new(reference_string)
+    def initialize(*params)
+      row_from = row_to = col_from = col_to = nil
+
+      case params.size
+      when 4 then row_from, row_to, col_from, col_to = params
+      when 2 then row_from, col_from = params
+      when 1 then
+        raise ArgumentError.new("invalid value for #{self.class}: #{params[0].inspect}") unless params[0].is_a?(String)
+        from, to = params[0].split(':')
+        row_from, col_from = self.class.ref2ind(from)
+        row_to, col_to = self.class.ref2ind(to) unless to.nil?
+      end      
+
+      @row_range = Range.new(row_from || 0, row_to || row_from || ROW_MAX)
+      @col_range = Range.new(col_from || 0, col_to || col_from || COL_MAX)
+    end
+
+    def single_cell?
+      (@row_range.begin == @row_range.end) && (@col_range.begin == @col_range.end)
+    end
+
+    def first_row
+      @row_range.begin
+    end
+
+    def last_row
+      @row_range.end
+    end
+
+    def first_col
+      @col_range.begin
+    end
+
+    def last_col
+      @col_range.end
+    end
+
+    def ==(other)
+      !other.nil? && (@row_range == other.row_range) && (@col_range == other.col_range)
+    end
+
+    def cover?(other)
+      !other.nil? && (@row_range.cover?(other.row_range.begin) && @row_range.cover?(other.row_range.end) && 
+                      @col_range.cover?(other.col_range.begin) && @col_range.cover?(other.col_range.end))
+    end
+
+    def to_s
+      if single_cell? then
+        self.class.ind2ref(@row_range.begin, @col_range.begin)
+      else
+        self.class.ind2ref(@row_range.begin, @col_range.begin) + ':' + self.class.ind2ref(@row_range.end, @col_range.end)
+      end
+    end
+
+    def inspect
+      if single_cell? then
+        "#<#{self.class} @row=#{@row_range.begin} @col=#{@col_range.begin}>"
+      else
+        "#<#{self.class} @row_range=#{@row_range} @col_range=#{@col_range}>"
+      end
+    end
+
+    # Converts +row+ and +col+ zero-based indices to Excel-style cell reference
+    # (0) A...Z, AA...AZ, BA... ...ZZ, AAA... ...AZZ, BAA... ...XFD (16383)
+    def self.ind2ref(row = 0, col = 0)
+      str = ''
+
+      loop do
+        x = col % 26
+        str = ('A'.ord + x).chr + str
+        col = (col / 26).floor - 1
+        break if col < 0
+      end
+
+      str += (row + 1).to_s
+    end
+
+    # Converts Excel-style cell reference to +row+ and +col+ zero-based indices.
+    def self.ref2ind(str)
+      return [ -1, -1 ] unless str =~ /^([A-Z]+)(\d+)$/
+
+      col = 0
+      $1.each_byte { |chr| col = col * 26 + (chr - 64) }
+      [ $2.to_i - 1, col - 1 ]
+    end  
+
+  end
+
+  class Sqref < Array
+
+    def initialize(str)
+      str.split.each { |ref_str| self << RubyXL::Reference.new(ref_str) }
+    end
+
+    def to_s
+      self.collect{ |ref| ref.to_s }.join(' ')
+    end
+
+  end
+end

data/lib/rubyXL/objects/relationships.rb

@@ -0,0 +1,59 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+
+  class Relationship < OOXMLObject
+    define_attribute(:Id,     :string)
+    define_attribute(:Type,   :string)
+    define_attribute(:Target, :string)
+    define_element_name 'Relationship'
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_calcChain.html
+  class WorkbookRelationships < OOXMLObject
+    define_child_node(RubyXL::Relationship, :collection => true, :accessor => :relationships)
+    define_element_name 'Relationships'
+    set_namespaces('xmlns' => 'http://schemas.openxmlformats.org/package/2006/relationships')
+
+    attr_accessor :workbook
+
+    def create_relationship(target, type)
+      RubyXL::Relationship.new(:id => "rId#{relationships.size + 1}", 
+                               :type => "http://schemas.openxmlformats.org/officeDocument/2006/relationships/#{type}",
+                               :target => target)
+    end
+
+    def before_write_xml
+      self.relationships = []
+
+      @workbook.worksheets.each_index { |i|
+        relationships << create_relationship("worksheets/sheet#{i + 1}.xml", 'worksheet')
+      }
+
+      @workbook.external_links.each_key { |k| 
+        relationships << create_relationship("externalLinks/#{k}", 'externalLink')
+      }
+
+      relationships << create_relationship('theme/theme1.xml', 'theme')
+      relationships << create_relationship('styles.xml', 'styles')
+
+      if @workbook.shared_strings_container && !@workbook.shared_strings_container.strings.empty? then
+        relationships << create_relationship('sharedStrings.xml', 'sharedStrings') 
+      end
+
+      if @workbook.calculation_chain && !@workbook.calculation_chain.cells.empty? then
+        relationships << create_relationship('calcChain.xml', 'calcChain') 
+      end
+
+      true
+    end
+
+    def find_by_rid(r_id)
+      relationships.find { |r| r.id == r_id }
+    end
+
+    def self.filepath
+      File.join('xl', '_rels', 'workbook.xml.rels')
+    end
+  end
+end

data/lib/rubyXL/objects/shared_strings.rb

@@ -0,0 +1,57 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/text'
+require 'rubyXL/objects/extensions'
+
+module RubyXL
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_sst.html
+  class SharedStringsTable < OOXMLObject
+    # According to http://msdn.microsoft.com/en-us/library/office/gg278314.aspx,
+    # +count+ and +uniqueCount+ may be either both missing, or both present. Need to validate.
+    define_attribute(:uniqueCount,  :int)
+    define_child_node(RubyXL::RichText, :collection => :with_count, :node_name => 'si', :accessor => :strings)
+    define_child_node(RubyXL::ExtensionStorageArea)
+    define_element_name 'sst'
+    set_namespaces('xmlns' => 'http://schemas.openxmlformats.org/spreadsheetml/2006/main')
+
+    def initialize(*params)
+      super
+      # So far, going by the structure that the original creator had in mind. However, 
+      # since the actual implementation is now extracted into a separate class, 
+      # we will be able to transparrently change it later if needs be.
+      @index_by_content = {}
+    end
+
+    def before_write_xml
+      super
+      self.unique_count = self.count
+      self.count > 0
+    end
+
+    def [](index)
+      strings[index]
+    end
+
+    def empty?
+      strings.empty?
+    end
+
+    def add(str, index = nil)
+      index ||= strings.size
+      strings[index] = RubyXL::Text.new(:value => str)
+      @index_by_content[str] = index
+    end
+
+    def get_index(str, add_if_missing = false)
+      index = @index_by_content[str]
+      index = add(str) if index.nil? && add_if_missing
+      index 
+    end
+
+    def self.filepath
+      File.join('xl', 'sharedStrings.xml')
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/sheet_data.rb

@@ -0,0 +1,149 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/text'
+require 'rubyXL/objects/formula'
+
+module RubyXL
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_v-1.html
+  class CellValue < OOXMLObject
+    define_attribute(:_, :string, :accessor => :value)
+    define_element_name 'v'
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_c-2.html
+  class Cell < OOXMLObject
+    define_attribute(:r,   :ref)
+    define_attribute(:s,   :int,    :accessor => :style_index)
+    define_attribute(:t,   :string, :accessor => :datatype, :default => 'n', :values => %w{ b n e s str inlineStr })
+    define_attribute(:cm,  :int)
+    define_attribute(:vm,  :int)
+    define_attribute(:ph,  :bool)
+    define_child_node(RubyXL::Formula,   :accessor => :formula)
+    define_child_node(RubyXL::CellValue, :accessor => :value_container) 
+    define_child_node(RubyXL::RichText)    # is
+    define_element_name 'c'
+
+    def index_in_collection
+      r.col_range.begin
+    end
+
+    def row
+      r && r.first_row
+    end
+
+    def row=(v)
+      self.r = RubyXL::Reference.new(v, column || 0)
+    end
+
+    def column
+      r && r.first_col
+    end
+
+    def column=(v)
+      self.r = RubyXL::Reference.new(row || 0, v)
+    end
+
+    def raw_value
+      value_container && value_container.value
+    end
+
+    def raw_value=(v)
+      self.value_container ||= RubyXL::CellValue.new
+      value_container.value = v
+    end
+
+    def value(args = {})
+      return raw_value if args[:raw]
+      case datatype
+      when RubyXL::Cell::SHARED_STRING then
+        workbook.shared_strings_container[raw_value.to_i]
+      else 
+        if is_date? then workbook.num_to_date(raw_value.to_i)
+        else raw_value
+        end
+      end
+    end
+
+    include LegacyCell
+  end
+
+#TODO#<row r="1" spans="1:1" x14ac:dyDescent="0.25">
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_row-1.html
+  class Row < OOXMLObject
+    define_attribute(:r,            :int)
+    define_attribute(:spans,        :string)
+    define_attribute(:s,            :int)
+    define_attribute(:customFormat, :bool,  :default => false)
+    define_attribute(:ht,           :float)
+    define_attribute(:hidden,       :bool,  :default => false)
+    define_attribute(:customHeight, :bool,  :default => false)
+    define_attribute(:outlineLevel, :int,   :default => 0)
+    define_attribute(:collapsed,    :bool,  :default => false)
+    define_attribute(:thickTop,     :bool,  :default => false)
+    define_attribute(:thickBot,     :bool,  :default => false)
+    define_attribute(:ph,           :bool,  :default => false)
+    define_child_node(RubyXL::Cell, :collection => true, :accessor => :cells)
+    define_element_name 'row'
+
+    attr_accessor :worksheet
+
+    def index_in_collection
+      r - 1
+    end
+
+    def [](ind)
+      cells[ind]
+    end
+
+    def size
+      cells.size
+    end
+
+    def insert_cell_shift_right(c, col_index)
+      cells.insert(col_index, c)
+      col_index.upto(cells.size) { |col|
+        cell = cells[col]
+        next if cell.nil?
+        cell.column = col
+      }
+    end
+
+    def delete_cell_shift_left(col_index)
+      cells.delete_at(col_index)
+      col_index.upto(cells.size) { |col|
+        cell = cells[col]
+        next if cell.nil?
+        cell.column = col
+      }
+    end
+
+    def xf
+      @worksheet.workbook.cell_xfs[self.s || 0]
+    end
+
+    def get_fill_color
+      @worksheet.workbook.get_fill_color(xf)
+    end
+
+    def get_font
+      @worksheet.workbook.fonts[xf.font_id]
+    end
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_sheetData-1.html
+  class SheetData < OOXMLObject
+    define_child_node(RubyXL::Row, :collection => true, :accessor => :rows)
+    define_element_name 'sheetData'
+
+    def [](ind)
+      rows[ind]
+    end
+
+    def size
+      rows.size
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/sheet_view.rb

@@ -0,0 +1,71 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_pane-1.html
+  class Pane < OOXMLObject
+    define_attribute(:xSplit,      :int)
+    define_attribute(:ySplit,      :int)
+    define_attribute(:topLeftCell, :string)
+    define_attribute(:activePane,  :string, :default => 'topLeft',
+                       :values => %w{ bottomRight topRight bottomLeft topLeft })
+    define_attribute(:state,       :string, :default=> 'split',
+                       :values => %w{ split frozen frozenSplit })
+    define_element_name 'pane'
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_selection-1.html
+  class Selection < OOXMLObject
+    define_attribute(:pane,         :string,
+                       :values => %w{ bottomRight topRight bottomLeft topLeft })
+    define_attribute(:activeCell,   :ref)
+    define_attribute(:activeCellId, :int)   # 0-based index of @active_cell in @sqref
+    define_attribute(:sqref,        :sqref) # Array of references to the selected cells.
+    define_element_name 'selection'
+
+    def before_write_xml
+      # Normally, rindex of activeCellId in sqref:
+      # <selection activeCell="E12" activeCellId="9" sqref="A4 B6 C8 D10 E12 A4 B6 C8 D10 E12"/>
+      if @active_cell_id.nil? && !@active_cell.nil? && @sqref.size > 1 then
+        # But, things can be more complex:
+        # <selection activeCell="E8" activeCellId="2" sqref="A4:B4 C6:D6 E8:F8"/>
+        # Not using .reverse.each here to avoid memory reallocation.
+        @sqref.each_with_index { |ref, ind| @active_cell_id = ind if ref.cover?(@active_cell) } 
+      end
+      true
+    end
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_sheetView-1.html
+  class SheetView < OOXMLObject
+    define_attribute(:windowProtection,         :bool,   :default => false)
+    define_attribute(:showFormulas,             :bool,   :default => false)
+    define_attribute(:showGridLines,            :bool,   :default => true)
+    define_attribute(:showRowColHeaders,        :bool,   :default => true)
+    define_attribute(:showZeros,                :bool,   :default => true)
+    define_attribute(:rightToLeft,              :bool,   :default => false)
+    define_attribute(:tabSelected,              :bool,   :default => false)
+    define_attribute(:showRuler,                :bool,   :default => true)
+    define_attribute(:showOutlineSymbols,       :bool,   :default => true)
+    define_attribute(:defaultGridColor,         :bool,   :default => true)
+    define_attribute(:showWhiteSpace,           :bool,   :default => true)
+    define_attribute(:view,                     :string, :default => 'normal',
+                       :values => %w{ normal pageBreakPreview pageLayout })
+    define_attribute(:topLeftCell,              :ref)
+    define_attribute(:colorId,                  :int,    :default => 64)
+    define_attribute(:zoomScale,                :int,    :default => 100)
+    define_attribute(:zoomScaleNormal,          :int,    :default => 0)
+    define_attribute(:zoomScaleSheetLayoutView, :bool,   :default => 0)
+    define_attribute(:zoomScalePageLayoutView,  :bool,   :default => 0)
+    define_attribute(:workbookViewId,           :int,    :required => true, :default => 0 )
+    define_child_node(RubyXL::Pane)
+    define_child_node(RubyXL::Selection, :collection => true, :accessor => :selections )
+    define_element_name 'sheetView'
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_sheetViews-3.html
+  class SheetViews < OOXMLObject
+    define_child_node(RubyXL::SheetView, :collection => true, :accessor => :sheet_views)
+    define_element_name 'sheetViews'
+  end
+
+end