rubyXL 3.1.0 → 3.1.2

data/Gemfile

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 
 # Dependencies required to run this gem.
 gem "nokogiri", ">= 1.4.4"
-gem "rubyzip", ">= 1.0.0" , :require => 'zip'
+gem "rubyzip", ">= 1.1.6" , :require => 'zip'
 
 # Development dependencies.
 group :development do

data/README.rdoc

@@ -114,9 +114,9 @@ Please note: these methods are being phased out in favor of the OOXML object mod
 ==== Changing Borders
   # Possible weights: hairline, thin, medium, thick
   # Possible "directions": top, bottom, left, right, diagonal
-  worksheet.sheet_data[0][0].change_border_top('thin') # Sets A1 to have a top, thin border
-  worksheet.change_row_border_left(0, 'hairline')      # Sets first row to have a left, hairline border
-  worksheet.change_column_border_diagonal(0, 'medium') # Sets first column to have diagonal, medium border
+  worksheet.sheet_data[0][0].change_border(:top, 'thin')  # Sets A1 to have a top, thin border
+  worksheet.change_row_border(0, :left, 'hairline')       # Sets first row to have a left, hairline border
+  worksheet.change_column_border(0, :diagonal, 'medium')  # Sets first column to have diagonal, medium border
 
 ==== Changing Alignment
 ===== Horizontal

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.1.2

data/lib/rubyXL.rb

@@ -1,21 +1,5 @@
-require 'rubyXL/objects/relationships'
-require 'rubyXL/workbook'
-require 'rubyXL/worksheet'
-require 'rubyXL/cell'
-require 'rubyXL/objects/reference'
-require 'rubyXL/objects/column_range'
-require 'rubyXL/objects/stylesheet'
-require 'rubyXL/objects/shared_strings'
-require 'rubyXL/objects/worksheet'
-require 'rubyXL/objects/chartsheet'
-require 'rubyXL/objects/calculation_chain'
-require 'rubyXL/objects/content_types'
-require 'rubyXL/objects/theme'
-require 'rubyXL/objects/comments'
 require 'rubyXL/objects/root'
-require 'rubyXL/objects/workbook'
-require 'rubyXL/objects/document_properties'
-require 'rubyXL/objects/storage'
+require 'rubyXL/objects/reference'
 require 'rubyXL/parser'
 
 module RubyXL

data/lib/rubyXL/cell.rb

@@ -19,10 +19,10 @@ module RubyXL
     end
 
     # changes fill color of cell
-    def change_fill(rgb='ffffff')
+    def change_fill(rgb = 'ffffff')
       validate_worksheet
       Color.validate_color(rgb)
-      self.style_index = workbook.modify_fill(self.style_index,rgb)
+      self.style_index = workbook.modify_fill(self.style_index, rgb)
     end
 
     # Changes font name of cell
@@ -120,22 +120,27 @@ module RubyXL
     end
 
     def change_border_top(weight = 'thin')
+      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
       change_border(:top, weight)
     end
 
     def change_border_left(weight = 'thin')
+      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
       change_border(:left, weight)
     end
 
     def change_border_right(weight = 'thin')
+      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
       change_border(:right, weight)
     end
 
     def change_border_bottom(weight = 'thin')
+      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
       change_border(:bottom, weight)
     end
 
     def change_border_diagonal(weight = 'thin')
+      warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_border` instead."
       change_border(:diagonal, weight)
     end
 
@@ -256,6 +261,20 @@ module RubyXL
       return str
     end
 
+    # Performs correct modification based on what type of change_type is specified
+    def font_switch(change_type, arg)
+      case change_type
+        when Worksheet::NAME          then change_font_name(arg)
+        when Worksheet::SIZE          then change_font_size(arg)
+        when Worksheet::COLOR         then change_font_color(arg)
+        when Worksheet::ITALICS       then change_font_italics(arg)
+        when Worksheet::BOLD          then change_font_bold(arg)
+        when Worksheet::UNDERLINE     then change_font_underline(arg)
+        when Worksheet::STRIKETHROUGH then change_font_strikethrough(arg)
+        else raise 'Invalid change_type'
+      end
+    end
+
     private
 
     def get_border(direction)
@@ -278,7 +297,7 @@ module RubyXL
 
     def validate_worksheet()
       return if @worksheet && @worksheet[row] && @worksheet[row][column] == self
-      raise "This cell #{self} is not in worksheet #{worksheet}"
+      raise "Cell #{self} is not in worksheet #{worksheet}"
     end
 
     def get_cell_xf

data/lib/rubyXL/objects/content_types.rb

@@ -15,6 +15,8 @@ module RubyXL
   end
 
   class ContentTypes < OOXMLTopLevelObject
+    SAVE_ORDER = 999  # Must be saved last, so it has time to accumulate overrides from all others.
+
     attr_accessor :owner
 
     define_child_node(RubyXL::ContentTypeDefault,  :collection => true, :accessor => :defaults)
@@ -31,9 +33,6 @@ module RubyXL
       self.class.xlsx_path
     end
 
-    def self.save_order
-      999  # Must be saved last, so it has time to accumulate overrides from all others.
-    end
 
     def add_override(obj)
       return unless obj.class.const_defined?(:CONTENT_TYPE)

data/lib/rubyXL/objects/document_properties.rb

@@ -1,5 +1,6 @@
 require 'rubyXL/objects/ooxml_object'
 require 'rubyXL/objects/container_nodes'
+require 'time'
 
 module RubyXL
 

data/lib/rubyXL/objects/ooxml_object.rb

@@ -394,16 +394,14 @@ module RubyXL
   # Extension class providing functionality for top-level OOXML objects that are represented by
   # their own <tt>.xml</tt> files in <tt>.xslx</tt> zip container.
   class OOXMLTopLevelObject < OOXMLObject
+    SAVE_ORDER = 500
+
     # Prototype method. For top-level OOXML object, returns the path at which the current object's XML file
     # is located within the <tt>.xslx</tt> zip container.
     def xlsx_path
       raise 'Subclass responsebility'
     end
 
-    def self.save_order
-      500
-    end
-
     # Sets the list of namespaces on this object to be added when writing out XML. Valid only on top-level objects.
     # === Parameters
     # * +namespace_hash+ - Hash of namespaces in the form of <tt>"prefix" => "url"</tt>
@@ -449,32 +447,6 @@ module RubyXL
       @workbook.root.rels_hash[self.class].index{ |f| f.equal?(self) }.to_i + 1
     end
 
-    def self.define_relationship(klass, accessor = nil)
-      relationships = obtain_class_variable(:@@ooxml_relationships)
-      relationships[klass] = accessor
-    end 
-
-    def attach_relationship(rid, rf)
-      relationships = obtain_class_variable(:@@ooxml_relationships)
-      klass = rf.class
-      if relationships.has_key?(klass) then
-        accessor = relationships[klass]
-        case accessor
-        when NilClass then
-          # Relationship is known, but we don't have a special accessor for it, store as generic
-          store_relationship(rf)
-        when false then
-          # Do nothing, the code will perform attaching on its own
-        else
-          container = self.send(accessor)
-          if container.is_a?(Array) then container << rf
-          else self.send("#{accessor}=", rf)
-          end
-        end
-      else store_relationship(rf, :unknown)
-      end
-    end 
-
   end
 
 end

data/lib/rubyXL/objects/relationships.rb

@@ -15,6 +15,8 @@ module RubyXL
   end
 
   class OOXMLRelationshipsFile < OOXMLTopLevelObject
+    SAVE_ORDER = 0
+
     define_child_node(RubyXL::Relationship, :collection => true, :accessor => :relationships)
     define_element_name 'Relationships'
     set_namespaces('http://schemas.openxmlformats.org/package/2006/relationships' => '')
@@ -38,10 +40,6 @@ module RubyXL
     end
     protected :add_relationship
 
-    def self.save_order
-      0
-    end
-
     def find_by_rid(r_id)
       relationships.find { |r| r.id == r_id }
     end
@@ -176,7 +174,20 @@ module RubyXL
 
   module RelationshipSupport
 
+    module ClassMehods
+      def define_relationship(klass, accessor = nil)
+        class_variable_get(:@@ooxml_relationships)[klass] = accessor
+        attr_accessor(accessor) if accessor
+      end
+    end
+
+    def self.included(klass)
+      klass.class_variable_set(:@@ooxml_relationships, {})
+      klass.extend RelationshipSupport::ClassMehods
+    end
+
     attr_accessor :generic_storage, :relationship_container
+
     def related_objects # Override this method
       []
     end
@@ -196,12 +207,6 @@ module RubyXL
       res
     end
 
-    def store_relationship(related_file, unknown = false)
-      self.generic_storage ||= []
-      puts "WARNING: #{self.class} is not aware what to do with #{related_file.class}" if unknown
-      self.generic_storage << related_file
-    end
-
     def load_relationships(dir_path, base_file_name = '')
       self.relationship_container = self.class.const_get(:REL_CLASS).load_relationship_file(dir_path, base_file_name)
       return if relationship_container.nil?
@@ -211,6 +216,33 @@ module RubyXL
       }
     end
 
+    def attach_relationship(rid, rf)
+      relationships = self.class.class_variable_get(:@@ooxml_relationships)
+      klass = rf.class
+      if relationships.has_key?(klass) then
+        accessor = relationships[klass]
+        case accessor
+        when NilClass then
+          # Relationship is known, but we don't have a special accessor for it, store as generic
+          store_relationship(rf)
+        when false then
+          # Do nothing, the code will perform attaching on its own
+        else
+          container = self.send(accessor)
+          if container.is_a?(Array) then container << rf
+          else self.send("#{accessor}=", rf)
+          end
+        end
+      else store_relationship(rf, :unknown)
+      end
+    end 
+
+    def store_relationship(related_file, unknown = false)
+      self.generic_storage ||= []
+      puts "WARNING: #{self.class} is not aware what to do with #{related_file.class}" if unknown
+      self.generic_storage << related_file
+    end
+
   end
 
 end

data/lib/rubyXL/objects/root.rb

@@ -1,5 +1,8 @@
 require 'zip'
 require 'rubyXL/objects/relationships'
+require 'rubyXL/objects/document_properties'
+require 'rubyXL/objects/content_types'
+require 'rubyXL/objects/workbook'
 
 module RubyXL
 
@@ -14,27 +17,16 @@ module RubyXL
 
     include RubyXL::RelationshipSupport
 
+    define_relationship(RubyXL::ThumbnailFile,          :thumbnail)
+    define_relationship(RubyXL::CorePropertiesFile,     :core_properties)
+    define_relationship(RubyXL::DocumentPropertiesFile, :document_properties)
+    define_relationship(RubyXL::CustomPropertiesFile,   :custom_properties)
+    define_relationship(RubyXL::Workbook,               :workbook)
+
     def related_objects
       [ content_types, thumbnail, core_properties, document_properties, custom_properties, workbook ]
     end
 
-#    define_relationship(RubyXL::ThumbnailFile,          :thumbnail)
-#    define_relationship(RubyXL::CorePropertiesFile,     :core_properties)
-#    define_relationship(RubyXL::DocumentPropertiesFile, :document_properties)
-#    define_relationship(RubyXL::CustomPropertiesFile,   :custom_properties)
-#    define_relationship(RubyXL::Workbook,               :workbook)
-
-    def attach_relationship(rid, rf)
-      case rf
-      when RubyXL::ThumbnailFile          then self.thumbnail = rf
-      when RubyXL::CorePropertiesFile     then self.core_properties = rf
-      when RubyXL::DocumentPropertiesFile then self.document_properties = rf
-      when RubyXL::CustomPropertiesFile   then self.custom_properties = rf
-      when RubyXL::Workbook               then self.workbook = rf
-      else store_relationship(rf, :unknown)
-      end
-    end
-
     def self.default
       obj = self.new
       obj.document_properties    = RubyXL::DocumentPropertiesFile.new
@@ -56,7 +48,7 @@ module RubyXL
           self.rels_hash[obj.class] << obj
         }
 
-        self.rels_hash.keys.sort_by{ |c| c.save_order }.each { |klass|
+        self.rels_hash.keys.sort_by{ |c| c::SAVE_ORDER }.each { |klass|
           puts "<-- DEBUG: saving related #{klass} files" if @@debug
           self.rels_hash[klass].each { |obj|
             obj.workbook = workbook if obj.respond_to?(:workbook=)

data/lib/rubyXL/objects/sheet_data.rb

@@ -2,6 +2,7 @@ require 'rubyXL/objects/ooxml_object'
 require 'rubyXL/objects/simple_types'
 require 'rubyXL/objects/text'
 require 'rubyXL/objects/formula'
+require 'rubyXL/cell'
 
 module RubyXL
 

data/lib/rubyXL/objects/storage.rb

@@ -1,6 +1,7 @@
 module RubyXL
 
   class GenericStorageObject
+    SAVE_ORDER = 0
 
     attr_accessor :xlsx_path, :data, :workbook, :generic_storage
 
@@ -11,10 +12,6 @@ module RubyXL
       @generic_storage = []
     end
 
-    def self.save_order
-      0
-    end
-
     def self.parse_file(dirpath, file_path = nil)
       file_path ||= self.xlsx_path
       obj = self.new

data/lib/rubyXL/objects/text.rb

@@ -1,6 +1,7 @@
 require 'rubyXL/objects/ooxml_object'
 require 'rubyXL/objects/simple_types'
 require 'rubyXL/objects/container_nodes'
+require 'rubyXL/objects/color'
 
 module RubyXL
 

data/lib/rubyXL/objects/workbook.rb

@@ -1,6 +1,14 @@
 require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/shared_strings'
+require 'rubyXL/objects/stylesheet'
+require 'rubyXL/objects/theme'
+require 'rubyXL/objects/calculation_chain'
+require 'rubyXL/objects/worksheet'
+require 'rubyXL/objects/chartsheet'
+require 'rubyXL/objects/relationships'
 require 'rubyXL/objects/simple_types'
 require 'rubyXL/objects/extensions'
+require 'rubyXL/workbook'
 
 module RubyXL
 

data/lib/rubyXL/objects/worksheet.rb

@@ -6,9 +6,11 @@ require 'rubyXL/objects/sheet_common'
 require 'rubyXL/objects/text'
 require 'rubyXL/objects/formula'
 require 'rubyXL/objects/sheet_data'
+require 'rubyXL/objects/column_range'
 require 'rubyXL/objects/filters'
 require 'rubyXL/objects/data_validation'
 require 'rubyXL/objects/comments'
+require 'rubyXL/worksheet'
 
 module RubyXL
 

data/lib/rubyXL/worksheet.rb

@@ -159,54 +159,63 @@ module LegacyWorksheet
     change_row_font(row, Worksheet::STRIKETHROUGH, struckthrough, font)
   end
 
-  def change_row_height(row = 0, height=10)
+  def change_row_height(row = 0, height = 10)
     validate_workbook
     ensure_cell_exists(row)
 
-    if height.to_i.to_s == height.to_s
-      height = Integer(height)
-    elsif height.to_f.to_s == height.to_s
-      height = Float(height)
-    else
-      raise 'You must enter a number for the height'
-    end
-
-    sheet_data.rows[row].ht = height
-    sheet_data.rows[row].custom_height = true
+    c = sheet_data.rows[row]
+    c.ht = height
+    c.custom_height = true
   end
 
-  def change_row_horizontal_alignment(row = 0,alignment='center')
+  def change_row_horizontal_alignment(row = 0, alignment = 'center')
     validate_workbook
     validate_nonnegative(row)
-    change_row_alignment(row,alignment,true)
+    change_row_alignment(row, alignment, true)
   end
 
-  def change_row_vertical_alignment(row = 0,alignment='center')
+  def change_row_vertical_alignment(row = 0, alignment = 'center')
     validate_workbook
     validate_nonnegative(row)
-    change_row_alignment(row,alignment,false)
+    change_row_alignment(row, alignment, false)
   end
 
   def change_row_border_top(row = 0, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
     change_row_border(row, :top, weight)
   end
 
   def change_row_border_left(row = 0, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
     change_row_border(row, :left, weight)
   end
 
   def change_row_border_right(row = 0, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
     change_row_border(row, :right, weight)
   end
 
   def change_row_border_bottom(row = 0, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
     change_row_border(row, :bottom, weight)
   end
 
   def change_row_border_diagonal(row = 0, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_row_border` instead."
     change_row_border(row, :diagonal, weight)
   end
 
+  def change_row_border(row, direction, weight)
+    validate_workbook
+    ensure_cell_exists(row)
+
+    sheet_data.rows[row].style_index = @workbook.modify_border(get_row_style(row), direction, weight)
+
+    sheet_data[row].cells.each { |c|
+      c.change_border(direction, weight) unless c.nil?
+    }
+  end
+
   # Changes font name of column
   def change_column_font_name(column_index = 0, font_name = 'Verdana')
     xf = get_col_xf(column_index)
@@ -298,25 +307,42 @@ module LegacyWorksheet
   end
 
   def change_column_border_top(column_index, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
     change_column_border(column_index, :top, weight)
   end
 
   def change_column_border_left(column_index, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
     change_column_border(column_index, :left, weight)
   end
 
   def change_column_border_right(column_index, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
     change_column_border(column_index, :right, weight)
   end
 
   def change_column_border_bottom(column_index, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
     change_column_border(column_index, :bottom, weight)
   end
 
   def change_column_border_diagonal(column_index, weight = 'thin')
+    warn "[DEPRECATION] `#{__method__}` is deprecated.  Please use `change_column_border` instead."
     change_column_border(column_index, :diagonal, weight)
   end
 
+  def change_column_border(column_index, direction, weight)
+    validate_workbook
+    ensure_cell_exists(0, column_index)
+
+    cols.get_range(column_index).style_index = @workbook.modify_border(get_col_style(column_index), direction, weight)
+
+    sheet_data.rows.each { |row|
+      c = row.cells[column_index]
+      c.change_border(direction, weight) unless c.nil?
+    }
+  end
+
   # merges cells within a rectangular range
   def merge_cells(row1 = 0, col1 = 0, row2 = 0, col2 = 0)
     validate_workbook
@@ -741,14 +767,14 @@ module LegacyWorksheet
   # Helper method to update the row styles array
   # change_type - NAME or SIZE or COLOR etc
   # main method to change font, called from each separate font mutator method
-  def change_row_font(row, change_type, arg, font)
+  def change_row_font(row_index, change_type, arg, font)
     validate_workbook
-    ensure_cell_exists(row)
-
-    xf = workbook.register_new_font(font, get_row_xf(row))
-    sheet_data.rows[row].style_index = workbook.register_new_xf(xf, get_row_style(row))
+    ensure_cell_exists(row_index)
 
-    sheet_data[row].cells.each { |c| font_switch(c, change_type, arg) unless c.nil? }
+    xf = workbook.register_new_font(font, get_row_xf(row_index))
+    row = sheet_data[row_index]
+    row.style_index = workbook.register_new_xf(xf, get_row_style(row_index))
+    row.cells.each { |c| c.font_switch(change_type, arg) unless c.nil? }
   end
 
   # Helper method to update the fonts and cell styles array
@@ -758,56 +784,14 @@ module LegacyWorksheet
     ensure_cell_exists(0, column_index)
 
     xf = workbook.register_new_font(font, xf)
-
     cols.get_range(column_index).style_index = workbook.register_new_xf(xf, get_col_style(column_index))
 
     sheet_data.rows.each { |row|
-      c = row[column_index]
-      font_switch(c, change_type, arg) unless c.nil?
+      c = row && row[column_index]
+      c.font_switch(change_type, arg) unless c.nil?
     }
   end
 
-  #performs correct modification based on what type of change_type is specified
-  def font_switch(c,change_type,arg)
-    case change_type
-      when Worksheet::NAME
-        unless arg.is_a?String
-          raise 'Not a String'
-        end
-        c.change_font_name(arg)
-      when Worksheet::SIZE
-        unless arg.is_a?(Integer) || arg.is_a?(Float)
-          raise 'Not a Number'
-        end
-          c.change_font_size(arg)
-      when Worksheet::COLOR
-        Color.validate_color(arg)
-        c.change_font_color(arg)
-      when Worksheet::ITALICS
-        unless arg == !!arg
-          raise 'Not a boolean'
-        end
-        c.change_font_italics(arg)
-      when Worksheet::BOLD
-        unless arg == !!arg
-          raise 'Not a boolean'
-        end
-        c.change_font_bold(arg)
-      when Worksheet::UNDERLINE
-        unless arg == !!arg
-          raise 'Not a boolean'
-        end
-        c.change_font_underline(arg)
-      when Worksheet::STRIKETHROUGH
-        unless arg == !!arg
-          raise 'Not a boolean'
-        end
-        c.change_font_strikethrough(arg)
-      else
-        raise 'Invalid change_type'
-    end
-  end
-
   # Ensures that 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)
@@ -891,29 +875,6 @@ module LegacyWorksheet
     }
   end
 
-  def change_row_border(row, direction, weight)
-    validate_workbook
-    ensure_cell_exists(row)
-
-    sheet_data.rows[row].style_index = @workbook.modify_border(get_row_style(row), direction, weight)
-
-    sheet_data[row].cells.each { |c|
-      c.change_border(direction, weight) unless c.nil?
-    }
-  end
-
-  def change_column_border(column_index, direction, weight)
-    validate_workbook
-    ensure_cell_exists(0, column_index)
-
-    cols.get_range(column_index).style_index = @workbook.modify_border(get_col_style(column_index), direction, weight)
-
-    sheet_data.rows.each { |row|
-      c = row.cells[column_index]
-      c.change_border(direction, weight) unless c.nil?
-    }
-  end
-
   def validate_nonnegative(row_or_col)
     raise 'Row and Column arguments must be nonnegative' if row_or_col < 0
   end