rubyXL-ptr 3.3.27

data/lib/rubyXL/objects/border.rb

@@ -0,0 +1,74 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
+
+module RubyXL
+
+  class BorderEdge < OOXMLObject
+    define_attribute(:style, RubyXL::ST_BorderStyle, :default => 'none')
+    define_child_node(RubyXL::Color)
+
+    def set_rgb_color(font_color)
+      self.color = RubyXL::Color.new(:rgb => font_color.to_s)
+    end
+
+    def get_rgb_color
+      color && color.rgb
+    end
+  end
+
+  # http://www.datypic.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'
+
+    def get_edge_style(direction)
+      edge = self.send(direction)
+      edge && edge.style
+    end
+
+    def set_edge_style(direction, style)
+      edge = self.send(direction)
+      if edge
+        edge.style = style
+      else
+        self.send("#{direction}=", RubyXL::BorderEdge.new(:style => style))
+      end
+    end
+
+    def get_edge_color(direction)
+      edge = self.send(direction)
+      edge && edge.get_rgb_color
+    end
+
+    def set_edge_color(direction, color)
+      edge = self.send(direction)
+      if edge
+        edge.set_rgb_color(color)
+      else
+        self.send("#{direction}=", RubyXL::BorderEdge.new)
+        self.send(direction).set_rgb_color(color)
+      end
+    end
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_borders-1.html
+  class Borders < OOXMLContainerObject
+    define_child_node(RubyXL::Border, :collection => :with_count)
+    define_element_name 'borders'
+
+    def self.default
+      self.new(:_ => [ RubyXL::Border.new ])
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/calculation_chain.rb

@@ -0,0 +1,31 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/extensions'
+
+module RubyXL
+  # http://www.datypic.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.datypic.com/sc/ooxml/e-ssml_calcChain.html
+  class CalculationChain < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.calcChain+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/calcChain'
+
+    define_child_node(RubyXL::CalculationChainCell, :collection => true, :accessor => :cells)
+    define_child_node(RubyXL::ExtensionStorageArea)
+
+    define_element_name 'calcChain'
+    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main' => nil)
+
+    def xlsx_path
+      ROOT.join('xl', 'calcChain.xml')
+    end
+  end
+end

data/lib/rubyXL/objects/cell_style.rb

@@ -0,0 +1,65 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
+
+module RubyXL
+
+  # http://www.datypic.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.datypic.com/sc/ooxml/e-ssml_alignment-1.html
+  class Alignment < OOXMLObject
+    define_attribute(:horizontal,      RubyXL::ST_HorizontalAlignment)
+    define_attribute(:vertical,        RubyXL::ST_VerticalAlignment)
+    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.datypic.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.datypic.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'
+  end
+
+  # http://www.datypic.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/chartsheet.rb

@@ -0,0 +1,92 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
+require 'rubyXL/objects/extensions'
+require 'rubyXL/objects/relationships'
+require 'rubyXL/objects/sheet_common'
+
+module RubyXL
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheetProtection-4.html
+  class ChartsheetProtection < OOXMLObject
+    define_attribute(:password, RubyXL::ST_UnsignedShortHex)
+    define_attribute(:content,  :bool, :default => false)
+    define_attribute(:objects,  :bool, :default => false)
+    define_element_name 'sheetProtection'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheetPr-4.html
+  class ChartsheetProperties < OOXMLObject
+    define_attribute(:published,                         :bool, :default => true)
+    define_attribute(:codeName,                          :string)
+    define_child_node(RubyXL::Color, :node_name => :tabColor)
+    define_element_name 'sheetPr'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_pageSetup-5.html
+  class ChartsheetPageSetup < OOXMLObject
+    define_attribute(:paperSize,          :int,    :default => 1)
+    define_attribute(:firstPageNumber,    :int,    :default => 1)
+    define_attribute(:orientation,        RubyXL::ST_Orientation, :default => 'default')
+    define_attribute(:usePrinterDefaults, :bool,   :default => true)
+    define_attribute(:blackAndWhite,      :bool,   :default => false)
+    define_attribute(:draft,              :bool,   :default => false)
+    define_attribute(:useFirstPageNumber, :bool,   :default => false)
+    define_attribute(:horizontalDpi,      :int,    :default => 600)
+    define_attribute(:verticalDpi,        :int,    :default => 600)
+    define_attribute(:copies,             :int,    :default => 1)
+    define_attribute(:'r:id',             :string)
+    define_element_name 'pageSetup'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheetView-2.html
+  class ChartsheetView < OOXMLObject
+    define_attribute(:tabSelected,    :bool,  :default => false)
+    define_attribute(:zoomScale,      :int,   :default => 100)
+    define_attribute(:workbookViewId, :int,   :required => true, :default => 0 )
+    define_attribute(:zoomToFit,      :bool,  :default => false)
+    define_child_node(RubyXL::ExtensionStorageArea)
+    define_element_name 'sheetView'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheetViews-4.html
+  class ChartsheetViews < OOXMLObject
+    define_child_node(RubyXL::ChartsheetView, :collection => true)
+    define_child_node(RubyXL::ExtensionStorageArea)
+    define_element_name 'sheetViews'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_chartsheet.html
+  class Chartsheet < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.chartsheet+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/chartsheet'
+
+    include RubyXL::RelationshipSupport
+    define_relationship(RubyXL::DrawingFile)
+
+    attr_accessor :state, :rels
+    attr_accessor :workbook, :sheet_name, :sheet_id
+
+    define_child_node(RubyXL::ChartsheetProperties)
+    define_child_node(RubyXL::ChartsheetViews)
+    define_child_node(RubyXL::ChartsheetProtection)
+    define_child_node(RubyXL::CustomSheetViews)
+    define_child_node(RubyXL::PageMargins)
+    define_child_node(RubyXL::ChartsheetPageSetup)
+    define_child_node(RubyXL::HeaderFooterSettings)
+    define_child_node(RubyXL::RID, :node_name => :drawing)
+    define_child_node(RubyXL::RID, :node_name => :legacyDrawing)
+    define_child_node(RubyXL::RID, :node_name => :legacyDrawingHF)
+    define_child_node(RubyXL::RID, :node_name => :picture)
+    define_child_node(RubyXL::WebPublishingItems)
+    define_child_node(RubyXL::ExtensionStorageArea)
+    define_element_name 'chartsheet'
+    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main' => nil,
+                   'http://schemas.openxmlformats.org/officeDocument/2006/relationships' => 'r')
+
+    def xlsx_path
+      ROOT.join('xl', 'chartsheets', "sheet#{file_index}.xml")
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/color.rb

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

data/lib/rubyXL/objects/column_range.rb

@@ -0,0 +1,92 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_col-1.html
+  class ColumnRange < OOXMLObject
+    define_attribute(:min,          :uint, :required => true)
+    define_attribute(:max,          :uint, :required => true)
+    define_attribute(:width,        :double)
+    define_attribute(:style,        :uint, :default => 0, :accessor => :style_index)
+    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
+
+    DEFAULT_WIDTH = 9
+  end
+
+  class ColumnRanges < OOXMLContainerObject
+    define_child_node(RubyXL::ColumnRange, :collection => true)
+
+    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.locate_range(col_index)
+
+      if old_range.nil? then
+        new_range = RubyXL::ColumnRange.new
+      else
+        if old_range.min == col_num && old_range.max == col_num then
+          return old_range # Single column range, OK to change in place
+        elsif old_range.min == col_num then
+          new_range = old_range.dup
+          old_range.min += 1
+        elsif old_range.max == col_num then
+          new_range = old_range.dup
+          old_range.max -= 1
+        else
+          range_before = old_range.dup
+          range_before.max = col_index # col_num - 1
+          self << range_before
+
+          old_range.min = col_num + 1
+
+          new_range = RubyXL::ColumnRange.new
+        end
+      end
+
+      new_range.min = new_range.max = col_num
+      self << new_range
+      return new_range
+    end
+
+    def locate_range(col_index)
+      self.find { |range| range.include?(col_index) }
+    end
+
+    def insert_column(col_index)
+      self.each { |range| range.insert_column(col_index) }
+    end
+
+    def before_write_xml
+      self.sort_by!{ |r| r.min }
+      !(self.empty?)
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/comments.rb

@@ -0,0 +1,47 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/extensions'
+
+module RubyXL
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_comment-1.html
+  class Comment < OOXMLObject
+    define_child_node(RubyXL::RichText, :node_name => 'text')
+    define_child_node(RubyXL::AlternateContent)
+    define_attribute(:ref,      :ref, :required => true)
+    define_attribute(:authorId, :int, :required => true)
+    define_attribute(:guid,     :string)
+    define_element_name 'comment'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_authors-1.html
+  class CommentList < OOXMLContainerObject
+    define_child_node(RubyXL::Comment, :collection => [0..-1])
+    define_element_name 'commentList'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_authors-1.html
+  class Authors < OOXMLContainerObject
+    define_child_node(RubyXL::StringNode, :node_name => :author, :collection => [0..-1])
+    define_element_name 'authors'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_comments.html
+  class CommentsFile < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments'
+
+    define_child_node(RubyXL::Authors)
+    define_child_node(RubyXL::CommentList)
+    define_child_node(RubyXL::ExtensionStorageArea)
+    define_element_name 'comments'
+    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main' => nil)
+
+    attr_accessor :workbook
+
+    def xlsx_path
+      ROOT.join('xl', "comments#{file_index}.xml")
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/container_nodes.rb

@@ -0,0 +1,135 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
+
+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, :double, :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(:_, :double, :accessor => :value)
+  end
+
+  class StringNodeW3C < OOXMLObject
+    define_attribute(:_, :string, :accessor => :value)
+    define_attribute('xsi:type', :string, :required => true, :default => 'dcterms:W3CDTF')
+
+    def to_time
+      value && (value.strip.empty? ? nil : DateTime.parse(value).to_time)
+    end
+
+    def self.default(v)
+      v && self.new(:value => v.to_datetime.iso8601)
+    end
+
+  end
+
+  # http://www.datypic.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.datypic.com/sc/ooxml/e-docPropsVTypes_vector.html
+  class Vector < OOXMLObject
+    define_attribute(:baseType, RubyXL::ST_VectorBaseType, :required => true)
+    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