rubyXL 3.3.21 → 3.4.17

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'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/queryTable'
+
+    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/relationships.rb

@@ -4,7 +4,7 @@ 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
@@ -82,7 +82,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
 
@@ -204,7 +207,9 @@ 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
 

data/lib/rubyXL/objects/shared_strings.rb

@@ -4,7 +4,7 @@ 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'

data/lib/rubyXL/objects/sheet_common.rb

@@ -3,7 +3,7 @@ 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)
@@ -16,13 +16,13 @@ module RubyXL
     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 +33,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)

data/lib/rubyXL/objects/sheet_data.rb

@@ -3,11 +3,21 @@ require 'rubyXL/objects/simple_types'
 require 'rubyXL/objects/text'
 require 'rubyXL/objects/formula'
 require 'rubyXL/cell'
-require 'rubyXL/convenience_methods'
 
 module RubyXL
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_v-1.html
+  # 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.datypic.com/sc/ooxml/e-ssml_v-1.html
   class CellValue < OOXMLObject
     define_attribute(:_, :string, :accessor => :value)
     define_attribute(:'xml:space', %w{ preserve })
@@ -19,8 +29,10 @@ 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' )
@@ -32,6 +44,8 @@ module RubyXL
     define_child_node(RubyXL::RichText)    # is
     define_element_name 'c'
 
+    attr_accessor :worksheet
+
     def index_in_collection
       r.col_range.begin
     end
@@ -61,12 +75,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,10 +110,12 @@ 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 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 $1 != '' then r.to_f
           else r.to_i
           end
@@ -92,18 +126,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 +155,10 @@ module RubyXL
 
     attr_accessor :worksheet
 
+    def before_write_xml
+      !(cells.nil? || cells.empty?)
+    end
+
     def index_in_collection
       r - 1
     end
@@ -167,7 +204,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'

data/lib/rubyXL/objects/simple_types.rb

@@ -226,4 +226,22 @@ module RubyXL
   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

data/lib/rubyXL/objects/storage.rb

@@ -28,6 +28,11 @@ module RubyXL
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/printerSettings'
   end
 
+  class CustomPropertyFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.customProperty'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/customProperty'
+  end
+
   class DrawingFile < GenericStorageObject
     CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawing+xml'
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing'
@@ -92,6 +97,7 @@ module RubyXL
   end
 
   class ControlPropertiesFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.ms-excel.controlproperties+xml'
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/ctrlProp'
   end
 
@@ -157,8 +163,26 @@ module RubyXL
   end
 
   class OLEObjectFile < GenericStorageObject
-    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/oleObject'
     CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.oleObject'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/oleObject'
+  end
+
+  class ActiveX < GenericStorageObject
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/control'
+
+    include RubyXL::RelationshipSupport
+
+    def attach_relationship(rid, rf)
+      case rf
+      when RubyXL::ChartFile       then store_relationship(rf) # TODO
+      else store_relationship(rf, :unknown)
+      end
+    end
+
+  end
+
+  class ActiveXBinary < GenericStorageObject
+    REL_TYPE     = 'http://schemas.microsoft.com/office/2006/relationships/activeXControlBinary'
   end
 
 end

data/lib/rubyXL/objects/stylesheet.rb

@@ -7,7 +7,7 @@ require 'rubyXL/objects/extensions'
 
 module RubyXL
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_numFmt-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_numFmt-1.html
   class NumberFormat < OOXMLObject
     define_attribute(:numFmtId,   :int,    :required => true)
     define_attribute(:formatCode, :string, :required => true)
@@ -20,7 +20,7 @@ module RubyXL
 
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_numFmts-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_numFmts-1.html
   class NumberFormats < OOXMLContainerObject
     define_child_node(RubyXL::NumberFormat, :collection => :with_count)
     define_element_name 'numFmts'
@@ -66,7 +66,7 @@ module RubyXL
 
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_cellStyleXfs-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_cellStyleXfs-1.html
   class CellStyleXFs < OOXMLContainerObject
     define_child_node(RubyXL::XF, :collection => :with_count)
     define_element_name 'cellStyleXfs'
@@ -76,7 +76,7 @@ module RubyXL
     end
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_cellXfs-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_cellXfs-1.html
   class CellXFs < OOXMLContainerObject
     define_child_node(RubyXL::XF, :collection => :with_count)
     define_element_name 'cellXfs'
@@ -90,7 +90,7 @@ module RubyXL
     end
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_cellStyles-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_cellStyles-1.html
   class CellStyles < OOXMLContainerObject
     define_child_node(RubyXL::CellStyle, :collection => :with_count)
     define_element_name 'cellStyles'
@@ -100,7 +100,7 @@ module RubyXL
     end
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_dxf-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_dxf-1.html
   class DXF < OOXMLObject
     define_child_node(RubyXL::Font)
     define_child_node(RubyXL::NumberFormat)
@@ -112,13 +112,13 @@ module RubyXL
     define_element_name 'dxf'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_dxfs-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_dxfs-1.html
   class DXFs < OOXMLContainerObject
     define_child_node(RubyXL::DXF, :collection => :with_count)
     define_element_name 'dxfs'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_tableStyle-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_tableStyle-1.html
   class TableStyle < OOXMLObject
     define_attribute(:name,  :string, :required => true)
     define_attribute(:pivot, :bool,   :default => true)
@@ -127,7 +127,7 @@ module RubyXL
     define_element_name 'tableStyle'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_tableStyles-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_tableStyles-1.html
   class TableStyles < OOXMLContainerObject
     define_attribute(:defaultTableStyle, :string)
     define_attribute(:defaultPivotStyle, :string)
@@ -135,31 +135,31 @@ module RubyXL
     define_element_name 'tableStyles'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_colors-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_colors-1.html
   class ColorSet < OOXMLObject
     define_child_node(RubyXL::Color, :collection => true)
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_colors-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_colors-1.html
   class IndexedColors < OOXMLContainerObject
     define_child_node(RubyXL::Color, :collection => true, :node_name => :rgbColor)
     define_element_name 'indexedColors'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_mruColors-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_mruColors-1.html
   class MRUColors < OOXMLContainerObject
     define_child_node(RubyXL::Color, :collection => true)
     define_element_name 'mruColors'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_colors-1.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_colors-1.html
   class Colors < OOXMLObject
     define_child_node(RubyXL::IndexedColors)
     define_child_node(RubyXL::MRUColors)
     define_element_name 'colors'
   end
 
-  # http://www.schemacentral.com/sc/ooxml/e-ssml_styleSheet.html
+  # http://www.datypic.com/sc/ooxml/e-ssml_styleSheet.html
   class Stylesheet < OOXMLTopLevelObject
     CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml'
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles'