rubyXL 3.3.22 → 3.4.25

data/lib/rubyXL/objects/query_table.rb

@@ -0,0 +1,104 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
+require 'rubyXL/objects/extensions'
+require 'rubyXL/objects/relationships'
+require 'rubyXL/objects/sheet_common'
+
+# Query Tables
+# https://msdn.microsoft.com/en-us/library/hh643563(v=office.12).aspx
+
+module RubyXL
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTableField-1.html
+  class QueryTableField < OOXMLObject
+    define_attribute(:id,            :uint, :required => true)
+    define_attribute(:name,          RubyXL::ST_Xstring)
+    define_attribute(:dataBound,     :bool, :default => true)
+    define_attribute(:rowNumbers,    :bool, :default => false)
+    define_attribute(:fillFormulas,  :bool, :default => false)
+    define_attribute(:clipped,       :bool, :default => false)
+    define_attribute(:tableColumnId, :uint, :default => 0)
+
+    define_child_node(RubyXL::ExtensionStorageArea)
+
+    define_element_name 'queryTableField'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTableFields-1.html
+  class QueryTableFields < OOXMLObject
+    define_child_node(RubyXL::QueryTableField, :collection => :with_count, :accessor => :fields, :node_name => :queryTableField)
+    define_element_name 'queryTableFields'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_deletedField-1.html
+  class QueryTableDeletedField < OOXMLObject
+    define_attribute(:name, RubyXL::ST_Xstring, :required => true)
+
+    define_element_name 'deletedField'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTableDeletedFields-1.html
+  class QueryTableDeletedFields < OOXMLObject
+    define_child_node(RubyXL::QueryTableDeletedField, :collection => :with_count, :accessor => :deleted_fields, :node_name => :deletedField)
+    define_element_name 'queryTableDeletedFields'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTableRefresh-1.html
+  class QueryTableRefresh < OOXMLObject
+    define_attribute(:preserveSortFilterLayout, :bool, :default => true)
+    define_attribute(:fieldIdWrapped,           :bool, :default => false)
+    define_attribute(:headersInLastRefresh,     :bool, :default => true)
+    define_attribute(:minimumVersion,           :uint, :default => 0)
+    define_attribute(:nextId,                   :uint, :default => 1)
+    define_attribute(:unboundColumnsLeft,       :uint, :default => 0)
+    define_attribute(:unboundColumnsRight,      :uint, :default => 0)
+
+    define_child_node(RubyXL::QueryTableFields) # [1..1]
+    define_child_node(RubyXL::QueryTableDeletedFields)
+    define_child_node(RubyXL::SortState)
+    define_child_node(RubyXL::ExtensionStorageArea)
+
+    define_element_name 'queryTableRefresh'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_queryTable.html
+  class QueryTable < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.queryTable+xml'.freeze
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/queryTable'.freeze
+
+    include RubyXL::RelationshipSupport
+
+    define_attribute(:name,                    RubyXL::ST_Xstring, :required => true)
+    define_attribute(:headers,                 :bool, :default => true)
+    define_attribute(:rowNumbers,              :bool, :default => false)
+    define_attribute(:disableRefresh,          :bool, :default => false)
+    define_attribute(:backgroundRefresh,       :bool, :default => true)
+    define_attribute(:firstBackgroundRefresh,  :bool, :default => false)
+    define_attribute(:refreshOnLoad,           :bool, :default => false)
+    define_attribute(:growShrinkType,          RubyXL::ST_GrowShrinkType, :default => 'insertDelete')
+    define_attribute(:fillFormulas,            :bool, :default => false)
+    define_attribute(:removeDataOnSave,        :bool, :default => false)
+    define_attribute(:disableEdit,             :bool, :default => false)
+    define_attribute(:preserveFormatting,      :bool, :default => true)
+    define_attribute(:adjustColumnWidth,       :bool, :default => true)
+    define_attribute(:intermediate,            :bool, :default => false)
+    define_attribute(:connectionId,            :uint, :required => true)
+    define_attribute(:autoFormatId,            :uint)
+    define_attribute(:applyNumberFormats,      :bool)
+    define_attribute(:applyBorderFormats,      :bool)
+    define_attribute(:applyFontFormats,        :bool)
+    define_attribute(:applyPatternFormats,     :bool)
+    define_attribute(:applyAlignmentFormats,   :bool)
+    define_attribute(:applyWidthHeightFormats, :bool)
+
+    define_child_node(RubyXL::QueryTableRefresh)
+    define_child_node(RubyXL::ExtensionStorageArea)
+
+    define_element_name 'queryTable'
+    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main'           => nil,
+                   'http://schemas.openxmlformats.org/officeDocument/2006/relationships' => 'r')
+
+    def xlsx_path
+      ROOT.join('xl', 'queryTables', "queryTable#{file_index}.xml")
+    end
+  end
+end

data/lib/rubyXL/objects/reference.rb

@@ -29,6 +29,10 @@ module RubyXL
       (@row_range.begin == @row_range.end) && (@col_range.begin == @col_range.end)
     end
 
+    def valid?
+      !(row_range.begin.negative? || col_range.begin.negative?)
+    end
+
     def first_row
       @row_range.begin
     end
@@ -71,7 +75,7 @@ module RubyXL
     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)
+    # <0> A...Z, AA...AZ, BA... ...ZZ, AAA... ...AZZ, BAA... ...XFD <16383>
     def self.ind2ref(row = 0, col = 0)
       str = ''
 
@@ -88,16 +92,11 @@ module RubyXL
     # Converts Excel-style cell reference to +row+ and +col+ zero-based indices.
     def self.ref2ind(str)
       return [ -1, -1 ] unless str =~ /\A([A-Z]+)(\d+)\Z/
-
-      col = 0
-      $1.each_byte { |chr| col = col * 26 + (chr - 64) }
-      [ $2.to_i - 1, col - 1 ]
+      [ Regexp.last_match(2).to_i - 1, Regexp.last_match(1).each_byte.inject(0) { |col, chr| col * 26 + (chr - 64) } - 1 ]
     end
-
   end
 
   class Sqref < Array
-
     def initialize(str)
       str.split.each { |ref_str| self << RubyXL::Reference.new(ref_str) }
     end
@@ -105,6 +104,5 @@ module RubyXL
     def to_s
       self.collect{ |ref| ref.to_s }.join(' ')
     end
-
   end
 end

data/lib/rubyXL/objects/relationships.rb

@@ -2,9 +2,8 @@ require 'pathname'
 require 'rubyXL/objects/ooxml_object'
 
 module RubyXL
-
   class RID < OOXMLObject
-    define_attribute(:'r:id',            :string, :required => true)
+    define_relationship(:required => true)
   end
 
   class Relationship < OOXMLObject
@@ -16,7 +15,7 @@ module RubyXL
   end
 
   class OOXMLRelationshipsFile < OOXMLTopLevelObject
-    CONTENT_TYPE = 'application/vnd.openxmlformats-package.relationships+xml'
+    CONTENT_TYPE = 'application/vnd.openxmlformats-package.relationships+xml'.freeze
     SAVE_ORDER = 100
 
     define_child_node(RubyXL::Relationship, :collection => true, :accessor => :relationships)
@@ -28,8 +27,8 @@ module RubyXL
     @@debug_indent = ($DEBUG ? 0 : nil)
 
     def new_relationship(target, type)
-      RubyXL::Relationship.new(:id => "rId#{relationships.size + 1}",
-                               :type => type,
+      RubyXL::Relationship.new(:id     => "rId#{relationships.size + 1}",
+                               :type   => type,
                                :target => target)
     end
     protected :new_relationship
@@ -37,8 +36,8 @@ module RubyXL
     def add_relationship(obj)
       return if obj.nil? || !defined?(obj.class::REL_TYPE) || (obj.respond_to?(:empty?) && obj.empty?)
 
-      relationships << RubyXL::Relationship.new(:id => "rId#{relationships.size + 1}",
-                                                :type => obj.class::REL_TYPE,
+      relationships << RubyXL::Relationship.new(:id     => "rId#{relationships.size + 1}",
+                                                :type   => obj.class::REL_TYPE,
                                                 :target => obj.xlsx_path.relative_path_from(owner.xlsx_path.dirname))
     end
     protected :add_relationship
@@ -82,7 +81,10 @@ module RubyXL
         klass = RubyXL::OOXMLRelationshipsFile.get_class_by_rel_type(rel.type)
 
         if klass.nil? then
-          puts "*** WARNING: storage class not found for #{rel.target} (#{rel.type})"
+          if !RubyXL.class_variable_get(:@@suppress_warnings) then
+            puts "*** WARNING: storage class not found for #{rel.target} (#{rel.type})"
+          end
+
           klass = GenericStorageObject
         end
 
@@ -128,12 +130,10 @@ module RubyXL
       basename = base_file_path.root? ? '' : base_file_path.basename
       base_file_path.dirname.join('_rels', "#{basename}.rels").cleanpath
     end
-
   end
 
   # +RelationshipSupport+ module enables automatic loading and saving of _rels for the respective file
   module RelationshipSupport
-
     module ClassMehods
       def define_relationship(klass, accessor = nil)
         class_variable_get(:@@ooxml_relationships)[klass] = accessor
@@ -204,10 +204,10 @@ module RubyXL
 
     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
+      if unknown && !RubyXL.class_variable_get(:@@suppress_warnings) then
+        puts "WARNING: #{self.class} is not aware how to process #{related_file.class}"
+      end
       self.generic_storage << related_file
     end
-
   end
-
 end

data/lib/rubyXL/objects/root.rb

@@ -5,7 +5,6 @@ require 'rubyXL/objects/content_types'
 require 'rubyXL/objects/workbook'
 
 module RubyXL
-
   class WorkbookRoot
     @@debug = $DEBUG
 
@@ -82,5 +81,4 @@ module RubyXL
       root
     end
   end
-
 end

data/lib/rubyXL/objects/shared_strings.rb

@@ -3,15 +3,14 @@ require 'rubyXL/objects/text'
 require 'rubyXL/objects/extensions'
 
 module RubyXL
-
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_sst.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_sst.html
   class SharedStringsTable < OOXMLTopLevelObject
-    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml'
-    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings'
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml'.freeze
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings'.freeze
 
     # 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_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'
@@ -64,7 +63,5 @@ module RubyXL
     def xlsx_path
       ROOT.join('xl', 'sharedStrings.xml')
     end
-
   end
-
 end

data/lib/rubyXL/objects/sheet_common.rb

@@ -2,8 +2,7 @@ require 'rubyXL/objects/ooxml_object'
 require 'rubyXL/objects/storage'
 
 module RubyXL
-
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_webPublishItem-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_webPublishItem-1.html
   class WebPublishingItem < OOXMLObject
     define_attribute(:id,              :int,    :required => true)
     define_attribute(:divId,           :int,    :required => true)
@@ -12,17 +11,17 @@ module RubyXL
     define_attribute(:sourceObject,    :string)
     define_attribute(:destinationFile, :string, :required => true)
     define_attribute(:title,           :string)
-    define_attribute(:autoRepublish,   :bool,   :default => false)
+    define_attribute(:autoRepublish,   :bool, :default => false)
     define_element_name 'webPublishItem'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_webPublishItems-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_webPublishItems-1.html
   class WebPublishingItems < OOXMLContainerObject
     define_child_node(RubyXL::WebPublishingItem, :collection => :with_count)
     define_element_name 'webPublishItems'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_pageMargins-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_pageMargins-1.html
   class PageMargins < OOXMLObject
     define_attribute(:left,   :double, :required => true)
     define_attribute(:right,  :double, :required => true)
@@ -33,7 +32,7 @@ module RubyXL
     define_element_name 'pageMargins'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_headerFooter-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_headerFooter-1.html
   class HeaderFooterSettings < OOXMLObject
     define_attribute(:differentOddEven, :bool, :default => false)
     define_attribute(:differentFirst,   :bool, :default => false)
@@ -47,5 +46,4 @@ module RubyXL
     define_child_node(RubyXL::StringNode, :node_name => :firstFooter)
     define_element_name 'headerFooter'
   end
-
 end

data/lib/rubyXL/objects/sheet_data.rb

@@ -3,11 +3,20 @@ require 'rubyXL/objects/simple_types'
 require 'rubyXL/objects/text'
 require 'rubyXL/objects/formula'
 require 'rubyXL/cell'
-require 'rubyXL/convenience_methods'
 
 module RubyXL
+  # http://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.cellvalues(v=office.14).aspx
+  module DataType
+    SHARED_STRING = 's'
+    RAW_STRING    = 'str'
+    INLINE_STRING = 'inlineStr'
+    ERROR         = 'e'
+    BOOLEAN       = 'b'
+    NUMBER        = 'n'
+    DATE          = 'd' # Only available in Office2010.
+  end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_v-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_v-1.html
   class CellValue < OOXMLObject
     define_attribute(:_, :string, :accessor => :value)
     define_attribute(:'xml:space', %w{ preserve })
@@ -19,19 +28,23 @@ module RubyXL
     end
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_c-2.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_c-2.html
   class Cell < OOXMLObject
+    NUMBER_REGEXP = /\A-?\d+((?:\.\d+)?(?:e[+-]?\d+)?)?\Z/i
+
     define_attribute(:r,   :ref)
     define_attribute(:s,   :int,  :default => 0, :accessor => :style_index)
-    define_attribute(:t,   RubyXL::ST_CellType,  :accessor => :datatype, :default => 'n' )
+    define_attribute(:t,   RubyXL::ST_CellType,  :accessor => :datatype, :default => 'n')
     define_attribute(:cm,  :int,  :default => 0)
     define_attribute(:vm,  :int,  :default => 0)
     define_attribute(:ph,  :bool, :default => false)
     define_child_node(RubyXL::Formula,   :accessor => :formula)
     define_child_node(RubyXL::CellValue, :accessor => :value_container)
-    define_child_node(RubyXL::RichText)    # is
+    define_child_node(RubyXL::RichText) # is
     define_element_name 'c'
 
+    attr_accessor :worksheet
+
     def index_in_collection
       r.col_range.begin
     end
@@ -61,12 +74,30 @@ module RubyXL
       value_container.value = v
     end
 
+    def get_cell_xf
+      workbook.stylesheet.cell_xfs[self.style_index || 0]
+    end
+
+    def get_cell_font
+      workbook.stylesheet.fonts[get_cell_xf.font_id]
+    end
+
+    def get_cell_border
+      workbook.stylesheet.borders[get_cell_xf.border_id]
+    end
+
     def number_format
       workbook.stylesheet.get_number_format_by_id(get_cell_xf.num_fmt_id)
     end
 
     def is_date?
-      return false unless raw_value =~ /\A\d+(?:\.\d+)?\Z/ # Only fully numeric values can be dates
+      return false unless # Only fully numeric values can be dates
+        case raw_value
+        when Numeric then true
+        when String  then raw_value =~ NUMBER_REGEXP
+        else false
+        end
+
       num_fmt = self.number_format
       num_fmt && num_fmt.is_date_format?
     end
@@ -78,11 +109,13 @@ module RubyXL
 
       case datatype
       when RubyXL::DataType::SHARED_STRING then workbook.shared_strings_container[r.to_i].to_s
+      when RubyXL::DataType::INLINE_STRING then is.to_s
       when RubyXL::DataType::RAW_STRING    then raw_value
       else
-        if is_date? then workbook.num_to_date(r.to_f)
-        elsif r.is_a?(String) && (r =~ /\A-?\d+((?:\.\d+)?(?:e[+-]?\d+)?)?\Z/i) then # Numeric
-          if $1 != '' then r.to_f
+        if is then is.to_s
+        elsif is_date? then workbook.num_to_date(r.to_f)
+        elsif r.is_a?(String) && (r =~ NUMBER_REGEXP) then # Numeric
+          if Regexp.last_match(1) != '' then r.to_f
           else r.to_i
           end
         else r
@@ -92,18 +125,17 @@ module RubyXL
 
     def inspect
       str = "#<#{self.class}(#{row},#{column}): #{raw_value.inspect}"
-      str += " =#{self.formula.expression}" if self.formula
-      str += ", datatype=#{self.datatype.inspect}, style_index=#{self.style_index.inspect}>"
+      str << " =#{self.formula.expression}" if self.formula
+      str << ", datatype=#{self.datatype.inspect}, style_index=#{self.style_index.inspect}>"
       return str
     end
 
     include LegacyCell
-    include CellConvenienceMethods
   end
 
 #TODO#<row r="1" spans="1:1" x14ac:dyDescent="0.25">
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_row-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_row-1.html
   class Row < OOXMLObject
     define_attribute(:r,            :int)
     define_attribute(:spans,        :string)
@@ -122,6 +154,10 @@ module RubyXL
 
     attr_accessor :worksheet
 
+    def before_write_xml
+      !(cells.nil? || cells.empty?)
+    end
+
     def index_in_collection
       r - 1
     end
@@ -167,7 +203,7 @@ module RubyXL
     DEFAULT_HEIGHT = 13
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_sheetData-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheetData-1.html
   class SheetData < OOXMLObject
     define_child_node(RubyXL::Row, :collection => true, :accessor => :rows)
     define_element_name 'sheetData'
@@ -179,7 +215,5 @@ module RubyXL
     def size
       rows.size
     end
-
   end
-
 end

data/lib/rubyXL/objects/simple_types.rb

@@ -140,7 +140,7 @@ module RubyXL
   ST_TextHorzOverflowType = %w{ overflow clip }
   ST_TextVerticalType     = %w{ horz vert vert270 wordArtVert eaVert mongolianVert wordArtVertRtl }
   ST_TextWrappingType     = %w{ none square }
-  ST_TextAnchoringType	  = %w{ t ctr b just dist }
+  ST_TextAnchoringType = %w{ t ctr b just dist }
   ST_TextShapeType        = %w{ textNoShape textPlain textStop textTriangle textTriangleInverted textChevron
                                 textChevronInverted textRingInside textRingOutside textArchUp textArchDown
                                 textCircle textButton textArchUpPour textArchDownPour textCirclePour textButtonPour
@@ -223,7 +223,27 @@ module RubyXL
 
   ST_TextUnderlineType    = %w{ none words sng dbl heavy dotted dottedHeavy dash dashHeavy dashLong dashLongHeavy
                                 dotDash dotDashHeavy dotDotDash dotDotDashHeavy wavy wavyHeavy wavyDbl }
+  ST_UnderlineValues      = %w{ single double singleAccounting doubleAccounting none }
+
   ST_TextStrikeType       = %w{ noStrike sngStrike dblStrike }
   ST_TextCapsType         = %w{ none small all }
 
+  # TODO: http://www.datypic.com/sc/ooxml/t-ssml_ST_UnsignedIntHex.html
+  ST_UnsignedIntHex       = :string # length = 4
+  # TODO: http://www.datypic.com/sc/ooxml/t-ssml_ST_UnsignedShortHex.html
+  ST_UnsignedShortHex     = :string # length = 2
+
+  ST_Xstring = :string
+
+  # Query Tables
+  ST_GrowShrinkType = %w{ insertDelete insertClear overwriteClear }
+
+  # Connections
+  ST_CredMethod             = %w{ integrated none stored prompt }
+  ST_ParameterType          = %w{ prompt value cell }
+  ST_FileType               = %w{ mac win dos }
+  ST_Qualifier              = %w{ doubleQuote singleQuote none }
+  ST_ExternalConnectionType = %w{ general text MDY DMY YMD MYD DYM YDM skip EMD }
+
+  ST_HtmlFmt = %w{ none rtf all }
 end