rubyXL 1.2.10 → 2.1.1

data/lib/rubyXL/cell.rb

@@ -1,209 +1,115 @@
 module RubyXL
-  class Cell < PrivateClass
-
-    attr_accessor :row, :column, :datatype, :style_index, :formula, :worksheet
-    attr_reader :workbook,:formula_attributes
-
-    def initialize(worksheet,row,column,value=nil,formula=nil,datatype='s',style_index=0, fmla_attr={})
-      @worksheet = worksheet
-
-      @workbook = worksheet.workbook
-      @row = row
-      @column = column
-      @datatype = datatype
-      @value = value
-      @formula=formula
-      @style_index = style_index
-      @formula_attributes = fmla_attr
-    end
-
-    def value(args = {})
-      raw_values = args.delete(:raw) || false
-      return @value if raw_values
-      
-      if is_date?
-        return @workbook.num_to_date(@value)
-      else
-        return @value
-      end
+  module LegacyCell
+    SHARED_STRING = 's'
+    RAW_STRING = 'str'
+    ERROR = 'e'
+
+    attr_accessor :formula, :worksheet
+
+    def workbook
+      @worksheet.workbook
     end
 
     def is_date?
-      if !@value.is_a?(String)
-        if @workbook.num_fmts_by_id
-          num_fmt_id = xf_id()[:numFmtId]
-          tmp_num_fmt = @workbook.num_fmts_by_id[num_fmt_id]
-          num_fmt = (tmp_num_fmt &&tmp_num_fmt[:attributes] && tmp_num_fmt[:attributes][:formatCode]) ? tmp_num_fmt[:attributes][:formatCode] : nil
-          if num_fmt && workbook.date_num_fmt?(num_fmt)
-            return true
-          end
-        end
-      end
-      return false
-    end
-
-    def is_date_format?(num_fmt)
-      skip_chars = ['$', '-', '+', '/', '(', ')', ':', ' ']
-      num_chars = ['0', '#', '?']
-      non_date_formats = ['0.00E+00', '##0.0E+0', 'General', 'GENERAL', 'general', '@']
-      date_chars = ['y','m','d','h','s']
-
-      state = 0
-      s = ''
-      num_fmt.split(//).each do |c|
-        if state == 0
-          if c == '"'
-            state = 1
-          elsif ['\\', '_', '*'].include?(c)
-            state = 2
-          elsif skip_chars.include?(c)
-            next
-          else
-            s << c
-          end
-        elsif state == 1
-          if c == '"'
-            state = 0
-          end
-        elsif state == 2
-          state = 0
-        end
-      end
-      s.gsub!(/\[[^\]]*\]/, '')
-      if non_date_formats.include?(s)
-        return false
-      end
-      separator = ';'
-      got_sep = 0
-      date_count = 0
-      num_count = 0
-      s.split(//).each do |c|
-        if date_chars.include?(c)
-          date_count += 1
-        elsif num_chars.include?(c)
-          num_count += 1
-        elsif c == separator
-          got_sep = 1
-        end
-      end
-      if date_count > 0 && num_count == 0
-        return true
-      elsif num_count > 0 && date_count == 0
-        return false
-      elsif date_count
-        # ambiguous result
-      elsif got_sep == 0
-        # constant result
-      end
-      return date_count > num_count
+      return false unless raw_value =~ /^\d+$/ # Only fully numeric values can be dates
+      num_fmt = get_number_format
+      num_fmt && num_fmt.is_date_format?
     end
 
     # changes fill color of cell
     def change_fill(rgb='ffffff')
       validate_worksheet
       Color.validate_color(rgb)
-      @style_index = modify_fill(@workbook, @style_index,rgb)
+      self.style_index = workbook.modify_fill(self.style_index,rgb)
     end
 
     # Changes font name of cell
-    def change_font_name(font_name='Verdana')
+    def change_font_name(new_font_name = 'Verdana')
       validate_worksheet
-      # Get copy of font object with modified name
-      font = deep_copy(workbook.fonts[font_id().to_s][:font])
-      font[:name][:attributes][:val] = font_name.to_s
-      # Update font and xf array
-      change_font(font)
+
+      font = get_cell_font.dup
+      font.set_name(new_font_name)
+      update_font_references(font)
     end
 
     # Changes font size of cell
     def change_font_size(font_size=10)
       validate_worksheet
-      if font_size.is_a?(Integer) || font_size.is_a?(Float)
-        # Get copy of font object with modified size
-        font = deep_copy(workbook.fonts[font_id().to_s][:font])
-        font[:sz][:attributes][:val] = font_size
-        # Update font and xf array
-        change_font(font)
-      else
-        raise 'Argument must be a number'
-      end
+      raise 'Argument must be a number' unless font_size.is_a?(Integer) || font_size.is_a?(Float)
+
+      font = get_cell_font.dup
+      font.set_size(font_size)
+      update_font_references(font)
     end
 
     # Changes font color of cell
     def change_font_color(font_color='000000')
       validate_worksheet
-      #if arg is a color name, convert to integer
       Color.validate_color(font_color)
-      # Get copy of font object with modified color
-      font = deep_copy(workbook.fonts[font_id().to_s][:font])
-      font = modify_font_color(font, font_color.to_s)
-      # Update font and xf array
-      change_font(font)
+
+      font = get_cell_font.dup
+      font.set_rgb_color(font_color)
+      update_font_references(font)
     end
 
     # Changes font italics settings of cell
     def change_font_italics(italicized=false)
       validate_worksheet
-      # Get copy of font object with modified italics settings
-      font = deep_copy(workbook.fonts[font_id().to_s][:font])
-      font = modify_font_italics(font, italicized)
-      # Update font and xf array
-      change_font(font)
+
+      font = get_cell_font.dup
+      font.set_italic(italicized)
+      update_font_references(font)
     end
 
     # Changes font bold settings of cell
     def change_font_bold(bolded=false)
       validate_worksheet
-      # Get copy of font object with modified bold settings
-      font = deep_copy(workbook.fonts[font_id().to_s][:font])
-      font = modify_font_bold(font, bolded)
-      # Update font and xf array
-      change_font(font)
+
+      font = get_cell_font.dup
+      font.set_bold(bolded)
+      update_font_references(font)
     end
 
     # Changes font underline settings of cell
     def change_font_underline(underlined=false)
       validate_worksheet
-      # Get copy of font object with modified underline settings
-      font = deep_copy(workbook.fonts[font_id().to_s][:font])
-      font = modify_font_underline(font, underlined)
-      # Update font and xf array
-      change_font(font)
+
+      font = get_cell_font.dup
+      font.set_underline(underlined)
+      update_font_references(font)
     end
 
-    # Changes font strikethrough settings of cell
     def change_font_strikethrough(struckthrough=false)
       validate_worksheet
-      # Get copy of font object with modified strikethrough settings
-      font = deep_copy(workbook.fonts[font_id().to_s][:font])
-      font = modify_font_strikethrough(font, struckthrough)
-      # Update font and xf array
-      change_font(font)
+
+      font = get_cell_font.dup
+      font.set_strikethrough(struckthrough)
+      update_font_references(font)
     end
 
     # Helper method to update the font array and xf array
-    def change_font(font)
-      # Modify font array and retrieve new font id
-      font_id = modify_font(@workbook, font, font_id())
-      # Get copy of xf object with modified font id
-      xf = deep_copy(xf_id())
-      xf[:fontId] = Integer(font_id.to_i)
-      # Modify xf array and retrieve new xf id
-      @style_index = modify_xf(@workbook, xf)
+    def update_font_references(modified_font)
+      xf = workbook.register_new_font(modified_font, get_cell_xf)
+      self.style_index = workbook.register_new_xf(xf, self.style_index)
     end
+    private :update_font_references
 
     # changes horizontal alignment of cell
     def change_horizontal_alignment(alignment='center')
       validate_worksheet
-      validate_horizontal_alignment(alignment)
-      @style_index = modify_alignment(@workbook,@style_index,true,alignment)
+      self.style_index = workbook.modify_alignment(self.style_index, true, alignment)
     end
 
     # changes vertical alignment of cell
     def change_vertical_alignment(alignment='center')
       validate_worksheet
-      validate_vertical_alignment(alignment)
-      @style_index = modify_alignment(@workbook,@style_index,false,alignment)
+      self.style_index = workbook.modify_alignment(self.style_index, false, alignment)
+    end
+
+    # changes wrap of cell
+    def change_text_wrap(wrap=false)
+      validate_worksheet
+      self.style_index = workbook.modify_text_wrap(self.style_index, wrap)
     end
 
     # changes top border of cell
@@ -234,106 +140,82 @@ module RubyXL
     # changes contents of cell, with formula option
     def change_contents(data, formula=nil)
       validate_worksheet
-      @datatype='str'
-      if data.is_a?(Date) || data.is_a?(DateTime)
-        data = @workbook.date_to_num(data)
-      end
-      if (data.is_a?Integer) || (data.is_a?Float)
-        @datatype = ''
+      self.datatype = RAW_STRING
+
+      case data
+      when Date           then data = workbook.date_to_num(data)
+      when Integer, Float then self.datatype = ''
       end
-      @value=data
-      @formula=formula
+
+      self.raw_value = data
+      @formula = formula
     end
 
     # returns if font is italicized
     def is_italicized()
       validate_worksheet
-      if @workbook.fonts[font_id()][:font][:i].nil?
-        false
-      else
-        true
-      end
+      get_cell_font.is_italic
     end
 
     # returns if font is bolded
     def is_bolded()
       validate_worksheet
-      if @workbook.fonts[font_id()][:font][:b].nil?
-        false
-      else
-        true
-      end
+      get_cell_font.is_bold
     end
 
-    # returns if font is underlined
     def is_underlined()
       validate_worksheet
-      xf = @workbook.get_style_attributes(@workbook.get_style(@style_index))
-      if @workbook.fonts[font_id()][:font][:u].nil?
-        false
-      else
-        true
-      end
+      get_cell_font.is_underlined
     end
 
-    # returns if font has a strike through it
     def is_struckthrough()
       validate_worksheet
-      xf = @workbook.get_style_attributes(@workbook.get_style(@style_index))
-      if @workbook.fonts[font_id()][:font][:strike].nil?
-        false
-      else
-        true
-      end
+      get_cell_font.is_strikethrough
     end
 
-    # returns cell's font name
     def font_name()
       validate_worksheet
-      @workbook.fonts[font_id()][:font][:name][:attributes][:val]
+      get_cell_font.get_name
     end
 
-    # returns cell's font size
     def font_size()
       validate_worksheet
-      return @workbook.fonts[font_id()][:font][:sz][:attributes][:val]
+      get_cell_font.get_size
     end
 
-    # returns cell's font color
     def font_color()
       validate_worksheet
-      if @workbook.fonts[font_id()][:font][:color].nil?
-        '000000' #black
-      else
-        @workbook.fonts[font_id()][:font][:color][:attributes][:rgb]
-      end
+      get_cell_font.get_rgb_color || '000000'
     end
 
     # returns cell's fill color
     def fill_color()
       validate_worksheet
-      xf = @workbook.get_style_attributes(@workbook.get_style(@style_index))
-      return @workbook.get_fill_color(xf)
+      return workbook.get_fill_color(get_cell_xf)
     end
 
     # returns cell's horizontal alignment
     def horizontal_alignment()
       validate_worksheet
-      xf_obj = @workbook.get_style(@style_index)
-      if xf_obj[:alignment].nil? || xf_obj[:alignment][:attributes].nil?
-        return nil
-      end
-      xf_obj[:alignment][:attributes][:horizontal].to_s
+      xf_obj = get_cell_xf
+      return nil if xf_obj.alignment.nil?
+      xf_obj.alignment.horizontal
     end
 
     # returns cell's vertical alignment
     def vertical_alignment()
       validate_worksheet
-      xf_obj = @workbook.get_style(@style_index)
-      if xf_obj[:alignment].nil? || xf_obj[:alignment][:attributes].nil?
-        return nil
-      end
-      xf_obj[:alignment][:attributes][:vertical].to_s
+      xf_obj = get_cell_xf
+      return nil if xf_obj.alignment.nil?
+      xf_obj.alignment.vertical
+    end
+
+    # returns cell's wrap
+    def text_wrap()
+      validate_worksheet
+      xf_obj = get_cell_xf
+      return nil if xf_obj.alignment.nil?
+      xf_obj.alignment.wrap_text
     end
 
     # returns cell's top border
@@ -361,46 +243,10 @@ module RubyXL
       return get_border(:diagonal)
     end
 
-    # returns Excel-style cell string from matrix indices
-    def Cell.convert_to_cell(row=0,col=0)
-      row_string = (row + 1).to_s #+1 for 0 indexing
-      col_string = ''
-
-      if row < 0 || col < 0
-        raise 'Invalid input: cannot convert negative numbers'
-      end
-
-      unless col == 0
-        col_length = 1+Integer(Math.log(col) / Math.log(26)) #opposite of 26**
-      else
-        col_length = 1
-      end
-
-      1.upto(col_length) do |i|
-
-        #for the last digit, 0 should mean A. easy way to do this.
-        if i == col_length
-          col+=1
-        end
-
-        if col >= 26**(col_length-i)
-          int_val = col / 26**(col_length-i) #+1 for 0 indexing
-          int_val += 64 #converts 1 to A, etc.
-
-          col_string += int_val.chr
-
-          #intval multiplier decrements by placeholder, essentially
-          #a B subtracts more than an A this way.
-          col -= (int_val-64)*26**(col_length-i)
-        end
-      end
-      col_string+row_string
-    end
-
     def inspect
-      str = "(#{@row},#{@column}): #{@value}" 
+      str = "#<#{self.class}(#{row},#{column}): #{raw_value.inspect}" 
       str += " =#{@formula}" if @formula
-      str += ", datatype = #{@datatype}, style_index = #{@style_index}"
+      str += ", datatype = #{self.datatype}, style_index = #{self.style_index}>"
       return str
     end
 
@@ -408,54 +254,48 @@ module RubyXL
 
     def change_border(direction, weight)
       validate_worksheet
-      validate_border(weight)
-      @style_index = modify_border(@workbook,@style_index)
-      if @workbook.borders[border_id()][:border][direction][:attributes].nil?
-        @workbook.borders[border_id()][:border][direction][:attributes] = { :style => nil }
-      end
-      @workbook.borders[border_id()][:border][direction][:attributes][:style] = weight.to_s
+      self.style_index = workbook.modify_border(self.style_index, direction, weight)
     end
 
     def get_border(direction)
       validate_worksheet
-
-      if @workbook.borders[border_id()][:border][direction][:attributes].nil?
-        return nil
-      end
-      return @workbook.borders[border_id()][:border][direction][:attributes][:style]
+      get_cell_border.get_edge_style(direction)
     end
 
     def validate_workbook()
-      unless @workbook.nil? || @workbook.worksheets.nil?
-        @workbook.worksheets.each do |sheet|
-          unless sheet.nil? || sheet.sheet_data.nil? || sheet.sheet_data[@row].nil?
-            if sheet.sheet_data[@row][@column] == self
+      unless workbook.nil? || workbook.worksheets.nil?
+        workbook.worksheets.each do |sheet|
+          unless sheet.nil? || sheet.sheet_data.nil? || sheet.sheet_data[row].nil?
+            if sheet.sheet_data[row][column] == self
               return
             end
           end
         end
       end
-      raise "This cell #{self} is not in workbook #{@workbook}"
+      raise "This cell #{self} is not in workbook #{workbook}"
     end
 
     def validate_worksheet()
-      if !@worksheet.nil? && @worksheet[@row][@column] == self
-        return
-      else
-        raise "This cell #{self} is not in worksheet #{worksheet}"
-      end
+      return if @worksheet && @worksheet[row][column] == self
+      raise "This cell #{self} is not in worksheet #{worksheet}"
     end
 
-    def xf_id()
-      @workbook.get_style_attributes(@workbook.get_style(@style_index.to_s))
+    def get_cell_xf
+      workbook.cell_xfs[self.style_index]
     end
 
-    def border_id()
-      xf_id()[:borderId].to_s
+    def get_cell_font
+      workbook.fonts[workbook.cell_xfs[self.style_index].font_id]
     end
 
-    def font_id()
-      xf_id()[:fontId].to_s
+    def get_cell_border
+      workbook.borders[get_cell_xf.border_id]
     end
+
+    def get_number_format
+      workbook.stylesheet.get_number_format_by_id(get_cell_xf.num_fmt_id)
+    end
+
   end
 end
+