rubyXL 1.2.10 → 2.1.1

data/lib/rubyXL/generic_storage.rb

@@ -0,0 +1,40 @@
+module RubyXL
+  class GenericStorage < Hash
+    attr_reader :local_dir_path
+
+    def initialize(local_dir_path)
+      @local_dir_path = local_dir_path
+      @mode = 'r'
+      super
+    end
+
+    def binary
+      @mode = 'rb'
+      self
+    end
+
+    def load_dir(root_dir)
+      dirpath = File.join(root_dir, @local_dir_path)
+      if File.directory?(dirpath) then
+        (Dir.new(dirpath).entries - ['.', '..', '.DS_Store', '_rels']).each { |filename|
+          self[filename] = File.open(File.join(dirpath, filename), @mode).read
+        }
+      end
+
+      self
+    end
+
+    def load_file(root_dir, filename)
+      filepath = File.join(root_dir, @local_dir_path, filename)
+      self[filename] = File.open(filepath, @mode).read if File.readable?(filepath)
+      self
+    end
+
+    def add_to_zip(zipfile)
+      each_pair { |filename, data|
+        zipfile.get_output_stream(File.join(@local_dir_path, filename)) { |f| f << data }
+      }
+    end
+
+  end
+end

data/lib/rubyXL/objects/border.rb

@@ -0,0 +1,66 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+
+  class BorderEdge < OOXMLObject
+    define_attribute(:style,   :string)
+    define_child_node(RubyXL::Color, :default => 'none', :values => 
+                        %w{ none thin medium dashed dotted thick double hair
+                            mediumDashed dashDot mediumDashDot dashDotDot slantDashDot } )
+
+    def ==(other)
+      style == other.style
+    end
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_border-2.html
+  class Border < OOXMLObject
+    define_attribute(:diagonalUp,   :bool)
+    define_attribute(:diagonalDown, :bool)
+    define_attribute(:outline,      :bool, :default => true)
+    define_child_node(RubyXL::BorderEdge, :node_name => :left)
+    define_child_node(RubyXL::BorderEdge, :node_name => :right)
+    define_child_node(RubyXL::BorderEdge, :node_name => :top)
+    define_child_node(RubyXL::BorderEdge, :node_name => :bottom)
+    define_child_node(RubyXL::BorderEdge, :node_name => :diagonal)
+    define_child_node(RubyXL::BorderEdge, :node_name => :vertical)
+    define_child_node(RubyXL::BorderEdge, :node_name => :horizontal)
+    define_element_name 'border'
+    set_countable
+
+    def get_edge_style(direction)
+      edge = self.send(direction)
+      edge && edge.style
+    end
+
+    def set_edge_style(direction, style)
+      self.send("#{direction}=", RubyXL::BorderEdge.new(:style => style))
+    end
+
+    def ==(other)
+      (diagonal_up == other.diagonal_up) &&
+        (diagonal_down == other.diagonal_down) &&
+        (outline == other.outline) &&
+        (left == other.left) &&
+        (right == other.right) &&
+        (top == other.top) &&
+        (bottom == other.bottom) &&
+        (diagonal == other.diagonal) &&
+        (vertical == other.vertical) &&
+        (horizontal == other.horizontal)
+    end
+
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_borders-1.html
+  class BorderContainer < OOXMLObject
+    define_child_node(RubyXL::Border, :collection => :with_count, :accessor => :borders)
+    define_element_name 'borders'
+
+    def self.defaults
+      self.new(:borders => [ RubyXL::Border.new ])
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/calculation_chain.rb

@@ -0,0 +1,28 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/extensions'
+
+module RubyXL
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_c-1.html
+  class CalculationChainCell < OOXMLObject
+    define_attribute(:r, :ref,  :accessor => :ref)
+    define_attribute(:i, :int,  :accessor => :sheet_id,    :default => 0)
+    define_attribute(:s, :bool, :accessor => :child_chain, :default => false)
+    define_attribute(:l, :bool, :accessor => :new_dep_lvl, :default => false)
+    define_attribute(:t, :bool, :accessor => :new_thread,  :default => false)
+    define_attribute(:a, :bool, :accessor => :array,       :default => false)
+    define_element_name 'c'
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_calcChain.html
+  class CalculationChain < OOXMLObject
+    define_child_node(RubyXL::CalculationChainCell, :collection => true, :accessor => :cells)
+    define_child_node(RubyXL::ExtensionStorageArea)
+
+    define_element_name 'calcChain'
+    set_namespaces('xmlns'     => 'http://schemas.openxmlformats.org/spreadsheetml/2006/main')
+
+    def self.filepath
+      File.join('xl', 'calcChain.xml')
+    end
+  end
+end

data/lib/rubyXL/objects/cell_style.rb

@@ -0,0 +1,75 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_cellStyle-1.html
+  class CellStyle < OOXMLObject
+    define_attribute(:name,          :string)
+    define_attribute(:xfId,          :int,  :required => true)
+    define_attribute(:builtinId,     :int)
+    define_attribute(:iLevel,        :int)
+    define_attribute(:hidden,        :bool)
+    define_attribute(:customBuiltin, :bool)
+    define_element_name 'cellStyle'
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_alignment-1.html
+  class Alignment < OOXMLObject
+    define_attribute(:horizontal,      :string,
+                       :values => %w{general left center right fill justify centerContinuous distributed})
+    define_attribute(:vertical,        :string,
+                       :values => %w{top center bottom justify distributed})
+    define_attribute(:textRotation,    :int)
+    define_attribute(:wrapText,        :bool)
+    define_attribute(:indent,          :int)
+    define_attribute(:relativeIndent,  :int)
+    define_attribute(:justifyLastLine, :bool)
+    define_attribute(:shrinkToFit,     :bool)
+    define_attribute(:readingOrder,    :int)
+    define_element_name 'alignment'
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_protection-1.html
+  class Protection < OOXMLObject
+    define_attribute(:locked, :bool)
+    define_attribute(:hidden, :bool)
+    define_element_name 'protection'
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_xf-1.html
+  class XF < OOXMLObject
+    define_attribute(:numFmtId,          :int)
+    define_attribute(:fontId,            :int)
+    define_attribute(:fillId,            :int)
+    define_attribute(:borderId,          :int)
+    define_attribute(:xfId,              :int)
+    define_attribute(:quotePrefix,       :bool, :default => false )
+    define_attribute(:pivotButton,       :bool, :default => false )
+    define_attribute(:applyNumberFormat, :bool)
+    define_attribute(:applyFont,         :bool)
+    define_attribute(:applyFill,         :bool)
+    define_attribute(:applyBorder,       :bool)
+    define_attribute(:applyAlignment,    :bool)
+    define_attribute(:applyProtection,   :bool)
+    define_child_node(RubyXL::Alignment)
+    define_child_node(RubyXL::Protection)
+    define_element_name 'xf'
+    set_countable
+
+    def ==(other)
+      (self.num_fmt_id == other.num_fmt_id) &&
+        (self.font_id == other.font_id) &&
+        (self.fill_id == other.fill_id) &&
+        (self.border_id == other.border_id) &&
+        (self.xf_id == other.xf_id)
+    end
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_numFmt-1.html
+  class NumFmt < OOXMLObject
+    define_attribute(:numFmtId,   :int,    :required => true)
+    define_attribute(:formatCode, :string, :required => true)
+    define_element_name 'numFmt'
+  end
+
+end

data/lib/rubyXL/objects/color.rb

@@ -0,0 +1,25 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_color-4.html
+  class Color < OOXMLObject
+    define_attribute(:auto,    :bool)
+    define_attribute(:indexed, :int)
+    define_attribute(:rgb,     :string)
+    define_attribute(:theme,   :int)
+    define_attribute(:tint,    :float)
+    define_element_name 'color'
+
+    #validates hex color code, no '#' allowed
+    def self.validate_color(color)
+      if color =~ /^([a-f]|[A-F]|[0-9]){6}$/
+        return true
+      else
+        raise 'invalid color'
+      end
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/column_range.rb

@@ -0,0 +1,74 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_col-1.html
+  class ColumnRange < OOXMLObject
+    define_attribute(:min,          :int,     :required => true)
+    define_attribute(:max,          :int,     :required => true)
+    define_attribute(:width,        :float)
+    define_attribute(:style,        :int,     :default => 0)
+    define_attribute(:hidden,       :bool,    :default => false)
+    define_attribute(:bestFit,      :bool,    :default => false)
+    define_attribute(:customWidth,  :bool,    :default => false)
+    define_attribute(:phonetic,     :bool,    :default => false)
+    define_attribute(:outlineLevel, :int,     :default => 0)
+    define_attribute(:collapsed,    :bool,    :default => false)
+    define_element_name 'col'
+
+    def delete_column(col_index)
+      col = col_index + 1
+      self.min -=1 if min >= col
+      self.max -=1 if max >= col
+    end
+
+    def insert_column(col_index)
+      col = col_index + 1
+      self.min +=1 if min >= col
+      self.max +=1 if max >= col - 1
+    end
+
+    def include?(col_index)
+      ((min-1)..(max-1)).include?(col_index)
+    end
+
+  end
+
+  class ColumnRanges < OOXMLObject
+    define_child_node(RubyXL::ColumnRange, :collection => true, :accessor => :column_ranges)
+    define_element_name 'cols'
+
+    # Locate an existing column range, make a new one if not found,
+    # or split existing column range into multiples.
+    def get_range(col_index)
+      col_num = col_index + 1
+
+      old_range = self.find(col_index)
+
+      if old_range.nil? then
+        new_range = RubyXL::ColumnRange.new(:min => col_num, :max => col_num)
+        self.column_ranges << new_range
+        return new_range
+      elsif old_range.min == col_num && 
+              old_range.max == col_num then # Single column range, OK to change in place
+        return old_range
+      else
+        raise "Range splitting not implemented yet"
+      end
+    end
+
+    def find(col_index)
+      column_ranges && column_ranges.find { |range| range.include?(col_index) }
+    end
+
+    def insert_column(col_index)
+      column_ranges && column_ranges.each { |range| range.insert_column(col_index) }
+    end
+
+    def before_write_xml
+      !(column_ranges.nil? || column_ranges.empty?)
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/container_nodes.rb

@@ -0,0 +1,122 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+
+  class BooleanValue < OOXMLObject
+    define_attribute(:val, :bool, :required => true, :default => true)
+  end
+
+  class StringValue < OOXMLObject
+    define_attribute(:val, :string, :required => true)
+  end
+
+  class IntegerValue < OOXMLObject
+    define_attribute(:val, :int, :required => true)
+  end
+
+  class FloatValue < OOXMLObject
+    define_attribute(:val, :float, :required => true)
+  end
+
+  class BooleanNode < OOXMLObject
+    define_attribute(:_, :bool, :accessor => :value)
+  end
+
+  class StringNode < OOXMLObject
+    define_attribute(:_, :string, :accessor => :value)
+  end
+
+  class IntegerNode < OOXMLObject
+    define_attribute(:_, :int, :accessor => :value)
+  end
+
+  class FloatNode < OOXMLObject
+    define_attribute(:_, :float, :accessor => :value)
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-docPropsVTypes_variant.html
+  class Variant < OOXMLObject
+    define_child_node(RubyXL::Variant,      :node_name => 'vt:variant')
+
+#   vector    Vector
+#    array    Array
+#    blob    Binary Blob
+#    oblob    Binary Blob Object
+#    empty    Empty
+#    null    Null
+#    int    Integer
+#    uint    Unsigned Integer
+#    decimal    Decimal
+#    stream    Binary Stream
+#    ostream    Binary Stream Object
+#    storage    Binary Storage
+#    ostorage    Binary Storage Object
+#    vstream    Binary Versioned Stream
+#
+    define_child_node(RubyXL::IntegerNode, :node_name => 'vt:i1')
+    define_child_node(RubyXL::IntegerNode, :node_name => 'vt:i2')
+    define_child_node(RubyXL::IntegerNode, :node_name => 'vt:i4')
+    define_child_node(RubyXL::IntegerNode, :node_name => 'vt:i8')
+    define_child_node(RubyXL::IntegerNode, :node_name => 'vt:ui1')
+    define_child_node(RubyXL::IntegerNode, :node_name => 'vt:ui2')
+    define_child_node(RubyXL::IntegerNode, :node_name => 'vt:ui4')
+    define_child_node(RubyXL::IntegerNode, :node_name => 'vt:ui8')
+    define_child_node(RubyXL::FloatNode,   :node_name => 'vt:r4')
+    define_child_node(RubyXL::FloatNode,   :node_name => 'vt:r8')
+    define_child_node(RubyXL::StringNode,  :node_name => 'vt:lpstr')
+    define_child_node(RubyXL::StringNode,  :node_name => 'vt:lpstrw')
+    define_child_node(RubyXL::StringNode,  :node_name => 'vt:bstr')
+    define_child_node(RubyXL::StringNode,  :node_name => 'vt:date')
+    define_child_node(RubyXL::StringNode,  :node_name => 'vt:filetime')
+    define_child_node(RubyXL::BooleanNode, :node_name => 'vt:bool')
+    define_child_node(RubyXL::StringNode,  :node_name => 'vt:cy')
+    define_child_node(RubyXL::StringNode,  :node_name => 'vt:error')
+    define_child_node(RubyXL::StringNode,  :node_name => 'vt:clsid')
+    define_child_node(RubyXL::StringNode,  :node_name => 'vt:cf')
+    define_element_name 'vt:vector'
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-docPropsVTypes_vector.html
+  class Vector < OOXMLObject
+    define_attribute(:baseType, :string, :required => true, :values => 
+                       %w{ variant i1 i2 i4 i8 ui1 ui2 ui4 ui8 r4 r8
+                           lpstr lpwstr bstr date filetime bool cy error clsid cf })
+    define_attribute(:size,     :int, :required => true)
+    define_child_node(RubyXL::Variant,     :collection => true, :node_name => 'vt:variant')
+    define_child_node(RubyXL::IntegerNode, :collection => true, :node_name => 'vt:i1')
+    define_child_node(RubyXL::IntegerNode, :collection => true, :node_name => 'vt:i2')
+    define_child_node(RubyXL::IntegerNode, :collection => true, :node_name => 'vt:i4')
+    define_child_node(RubyXL::IntegerNode, :collection => true, :node_name => 'vt:i8')
+    define_child_node(RubyXL::IntegerNode, :collection => true, :node_name => 'vt:ui1')
+    define_child_node(RubyXL::IntegerNode, :collection => true, :node_name => 'vt:ui2')
+    define_child_node(RubyXL::IntegerNode, :collection => true, :node_name => 'vt:ui4')
+    define_child_node(RubyXL::IntegerNode, :collection => true, :node_name => 'vt:ui8')
+    define_child_node(RubyXL::FloatNode,   :collection => true, :node_name => 'vt:r4')
+    define_child_node(RubyXL::FloatNode,   :collection => true, :node_name => 'vt:r8')
+    define_child_node(RubyXL::StringNode,  :collection => true, :node_name => 'vt:lpstr')
+    define_child_node(RubyXL::StringNode,  :collection => true, :node_name => 'vt:lpstrw')
+    define_child_node(RubyXL::StringNode,  :collection => true, :node_name => 'vt:bstr')
+    define_child_node(RubyXL::StringNode,  :collection => true, :node_name => 'vt:date')
+    define_child_node(RubyXL::StringNode,  :collection => true, :node_name => 'vt:filetime')
+    define_child_node(RubyXL::BooleanNode, :collection => true, :node_name => 'vt:bool')
+    define_child_node(RubyXL::StringNode,  :collection => true, :node_name => 'vt:cy')
+    define_child_node(RubyXL::StringNode,  :collection => true, :node_name => 'vt:error')
+    define_child_node(RubyXL::StringNode,  :collection => true, :node_name => 'vt:clsid')
+    define_child_node(RubyXL::StringNode,  :collection => true, :node_name => 'vt:cf')
+    define_element_name 'vt:vector'
+
+    def before_write_xml
+      # Fill out the count attribute
+      known_child_nodes = obtain_class_variable(:@@ooxml_child_nodes)
+      self.size = 0
+      known_child_nodes.values.each { |v| self.size += self.send(v[:accessor]).size }
+      true
+    end
+
+  end
+
+  class VectorValue < OOXMLObject
+    define_child_node(RubyXL::Vector)
+  end
+
+end

data/lib/rubyXL/objects/data_validation.rb

@@ -0,0 +1,43 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/formula'
+
+module RubyXL
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_dataValidation-1.html
+  class DataValidation < OOXMLObject
+    define_attribute(:type,             :string, :default => 'none',
+                        :values => %w{ none whole decimal list date time textLength custom })
+    define_attribute(:errorStyle,       :string, :default => 'stop',
+                        :values => %w{ stop warning information })
+    define_attribute(:imeMode,          :string, :default => 'noControl',
+                        :values => %w{ noControl off on disabled hiragana fullKatakana halfKatakana
+                            fullAlpha halfAlpha fullHangul halfHangul })
+    define_attribute(:operator,         :string, :default => 'between',
+                        :values => %w{ between notBetween equal notEqual lessThan lessThanOrEqual
+                            greaterThan greaterThanOrEqual })
+    define_attribute(:allowBlank,       :bool, :default => false)
+    define_attribute(:showDropDown,     :bool, :default => false)
+    define_attribute(:showInputMessage, :bool, :default => false)
+    define_attribute(:showErrorMessage, :bool, :default => false)
+    define_attribute(:errorTitle,       :string)
+    define_attribute(:error,            :string)
+    define_attribute(:promptTitle,      :string)
+    define_attribute(:prompt,           :string)
+    define_attribute(:sqref,            :sqref, :required => true)
+
+    define_child_node(RubyXL::Formula, :node_name => :formula1)
+    define_child_node(RubyXL::Formula, :node_name => :formula2)
+    define_element_name 'dataValidation'
+
+  end
+
+  # http://www.schemacentral.com/sc/ooxml/e-ssml_dataValidations-1.html
+  class DataValidations < OOXMLObject
+    define_attribute(:disablePrompts, :bool, :default => false)
+    define_attribute(:xWindow,        :int)
+    define_attribute(:yWindow,        :int)
+    define_child_node(RubyXL::DataValidation, :collection => :with_count)
+    define_element_name 'dataValidations'
+  end
+
+end