rubyXL-ptr 3.3.27

data/lib/rubyXL/objects/content_types.rb

@@ -0,0 +1,77 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+
+  class ContentTypeDefault < OOXMLObject
+    define_attribute(:Extension,   :string)
+    define_attribute(:ContentType, :string)
+    define_element_name 'Default'
+  end
+
+  class ContentTypeOverride < OOXMLObject
+    define_attribute(:PartName,   :string)
+    define_attribute(:ContentType, :string)
+    define_element_name 'Override'
+  end
+
+  class ContentTypes < OOXMLTopLevelObject
+    SAVE_ORDER = 999  # Must be saved last, so it has time to accumulate overrides from all others.
+    XLSX_PATH = ROOT.join('[Content_Types].xml')
+
+    define_child_node(RubyXL::ContentTypeDefault,  :collection => true, :accessor => :defaults)
+    define_child_node(RubyXL::ContentTypeOverride, :collection => true, :accessor => :overrides)
+
+    set_namespaces('http://schemas.openxmlformats.org/package/2006/content-types' => nil)
+    define_element_name 'Types'
+
+    def xlsx_path
+      XLSX_PATH
+    end
+
+    def before_write_xml
+      content_types_by_ext = {}
+
+      # Collect all extensions and corresponding content types
+      root.rels_hash.each_pair { |klass, objects|
+        objects.each { |obj|
+          next unless klass.const_defined?(:CONTENT_TYPE)
+          ext = obj.xlsx_path.extname[1..-1]
+          next if ext.nil?
+          content_types_by_ext[ext] ||= []
+          content_types_by_ext[ext] << klass::CONTENT_TYPE
+        }
+      }
+
+      self.defaults = [ RubyXL::ContentTypeDefault.new(:extension => 'xml', :content_type => 'application/xml') ]
+
+      # Determine which content types are used most often, and add them to the list of defaults
+      content_types_by_ext.each_pair { |ext, content_types_arr|
+        next if ext.nil? || defaults.any? { |d| d.extension == ext }
+        most_frequent_ct = content_types_arr.group_by { |ct| ct }.values.max_by(&:size).first
+        defaults << RubyXL::ContentTypeDefault.new(:extension => ext, :content_type => most_frequent_ct )
+      }
+
+      self.overrides = []
+
+      # Add overrides for the files with known extensions but different content types.
+      root.rels_hash.each_pair { |klass, objects|
+        objects.each { |obj|
+          obj_content_type = case
+                             when obj.respond_to?(:content_type) then obj.content_type
+                             when defined?(klass::CONTENT_TYPE)  then klass::CONTENT_TYPE
+                             else next
+                             end
+
+          ext = obj.xlsx_path.extname[1..-1]
+          next if defaults.any? { |d| (d.extension == ext) && (d.content_type == obj_content_type) }
+          overrides << RubyXL::ContentTypeOverride.new(:part_name => obj.xlsx_path,
+                                                       :content_type => obj_content_type)
+        }
+      }
+
+      true
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/data_validation.rb

@@ -0,0 +1,37 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
+require 'rubyXL/objects/formula'
+
+module RubyXL
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_dataValidation-1.html
+  class DataValidation < OOXMLObject
+    define_attribute(:type,             RubyXL::ST_DataValidationType,       :default => 'none')
+    define_attribute(:errorStyle,       RubyXL::ST_DataValidationErrorStyle, :default => 'stop')
+    define_attribute(:imeMode,          RubyXL::ST_DataValidationImeMode,    :default => 'noControl')
+    define_attribute(:operator,         RubyXL::ST_DataValidationOperator,   :default => 'between')
+    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.datypic.com/sc/ooxml/e-ssml_dataValidations-1.html
+  class DataValidations < OOXMLContainerObject
+    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

data/lib/rubyXL/objects/document_properties.rb

@@ -0,0 +1,159 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/container_nodes'
+require 'time'
+
+module RubyXL
+
+  # http://www.datypic.com/sc/ooxml/e-extended-properties_Properties.html
+  class DocumentPropertiesFile < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.extended-properties+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties'
+
+    attr_accessor :workbook
+
+    define_child_node(RubyXL::StringNode,  :node_name => :Template)
+    define_child_node(RubyXL::StringNode,  :node_name => :Manager)
+    define_child_node(RubyXL::StringNode,  :node_name => :Company)
+    define_child_node(RubyXL::IntegerNode, :node_name => :Pages)
+    define_child_node(RubyXL::IntegerNode, :node_name => :Words)
+    define_child_node(RubyXL::IntegerNode, :node_name => :Characters)
+    define_child_node(RubyXL::StringNode,  :node_name => :PresentationFormat)
+    define_child_node(RubyXL::IntegerNode, :node_name => :Lines)
+    define_child_node(RubyXL::IntegerNode, :node_name => :Paragraphs)
+    define_child_node(RubyXL::IntegerNode, :node_name => :Slides)
+    define_child_node(RubyXL::IntegerNode, :node_name => :Notes)
+    define_child_node(RubyXL::IntegerNode, :node_name => :TotalTime)
+    define_child_node(RubyXL::IntegerNode, :node_name => :HiddenSlides)
+    define_child_node(RubyXL::IntegerNode, :node_name => :MMClips)
+    define_child_node(RubyXL::BooleanNode, :node_name => :ScaleCrop)
+    define_child_node(RubyXL::VectorValue, :node_name => :HeadingPairs)
+    define_child_node(RubyXL::VectorValue, :node_name => :TitlesOfParts)
+    define_child_node(RubyXL::BooleanNode, :node_name => :LinksUpToDate)
+    define_child_node(RubyXL::IntegerNode, :node_name => :CharactersWithSpaces)
+    define_child_node(RubyXL::BooleanNode, :node_name => :SharedDoc)
+    define_child_node(RubyXL::StringNode,  :node_name => :HyperlinkBase)
+    define_child_node(RubyXL::VectorValue, :node_name => :HLinks)
+    define_child_node(RubyXL::BooleanNode, :node_name => :HyperlinksChanged)
+    define_child_node(RubyXL::StringNode,  :node_name => :DigSig)
+    define_child_node(RubyXL::StringNode,  :node_name => :Application)
+    define_child_node(RubyXL::StringNode,  :node_name => :AppVersion)
+    define_child_node(RubyXL::IntegerNode, :node_name => :DocSecurity)
+    set_namespaces('http://schemas.openxmlformats.org/officeDocument/2006/extended-properties' => nil,
+                   'http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes' => 'vt')
+    define_element_name 'Properties'
+
+    def add_parts_count(name, count)
+      return unless count > 0
+      heading_pairs.vt_vector.vt_variant << RubyXL::Variant.new(:vt_lpstr => RubyXL::StringNode.new(:value => name))
+      heading_pairs.vt_vector.vt_variant << RubyXL::Variant.new(:vt_i4 => RubyXL::IntegerNode.new(:value => count))
+    end
+    private :add_parts_count
+
+    def add_part_title(name)
+      titles_of_parts.vt_vector.vt_lpstr << RubyXL::StringNode.new(:value => name)
+    end
+    private :add_part_title
+
+    def before_write_xml
+      workbook = root.workbook
+
+      self.heading_pairs   = RubyXL::VectorValue.new(:vt_vector => RubyXL::Vector.new(:base_type => 'variant'))
+      self.titles_of_parts = RubyXL::VectorValue.new(:vt_vector => RubyXL::Vector.new(:base_type => 'lpstr'))
+
+      worksheets = chartsheets = 0
+
+      workbook.worksheets.each { |sheet|
+        add_part_title(sheet.sheet_name)
+
+        case sheet
+        when RubyXL::Worksheet  then worksheets += 1
+        when RubyXL::Chartsheet then chartsheets += 1
+        end
+      }
+      add_parts_count('Worksheets', worksheets) if worksheets > 0
+      add_parts_count('Charts', chartsheets) if chartsheets > 0
+
+      if workbook.defined_names then
+        add_parts_count('Named Ranges', workbook.defined_names.size)
+        workbook.defined_names.each { |defined_name| add_part_title(defined_name.name) }
+      end
+
+      true
+    end
+
+    def xlsx_path
+      ROOT.join('docProps', 'app.xml')
+    end
+
+  end
+
+
+  class CorePropertiesFile < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-package.core-properties+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties'
+
+    attr_accessor :workbook
+
+    define_child_node(RubyXL::StringNode,    :node_name => 'dc:creator')
+    define_child_node(RubyXL::StringNode,    :node_name => 'dc:description')
+    define_child_node(RubyXL::StringNode,    :node_name => 'dc:identifier')
+    define_child_node(RubyXL::StringNode,    :node_name => 'dc:language')
+    define_child_node(RubyXL::StringNode,    :node_name => 'dc:subject')
+    define_child_node(RubyXL::StringNode,    :node_name => 'dc:title')
+    define_child_node(RubyXL::StringNodeW3C, :node_name => 'dcterms:created')
+    define_child_node(RubyXL::StringNodeW3C, :node_name => 'dcterms:modified')
+    define_child_node(RubyXL::StringNode,    :node_name => 'cp:lastModifiedBy')
+    define_child_node(RubyXL::StringNode,    :node_name => 'cp:lastPrinted')
+    define_child_node(RubyXL::StringNode,    :node_name => 'cp:category')
+    define_child_node(RubyXL::StringNode,    :node_name => 'cp:contentStatus')
+    define_child_node(RubyXL::StringNode,    :node_name => 'cp:contentType')
+    define_child_node(RubyXL::StringNode,    :node_name => 'cp:keywords')
+    define_child_node(RubyXL::StringNode,    :node_name => 'cp:revision')
+    define_child_node(RubyXL::StringNode,    :node_name => 'cp:version')
+
+    set_namespaces('http://schemas.openxmlformats.org/package/2006/metadata/core-properties' => 'cp',
+                   'http://purl.org/dc/elements/1.1/' => 'dc',
+                   'http://purl.org/dc/terms/' => 'dcterms',
+                   'http://purl.org/dc/dcmitype/' => 'dcmitype',
+                   'http://www.w3.org/2001/XMLSchema-instance' => 'xsi')
+    define_element_name 'cp:coreProperties'
+
+    def xlsx_path
+      ROOT.join('docProps', 'core.xml')
+    end
+
+    def creator
+      dc_creator && dc_creator.value
+    end
+
+    def creator=(v)
+      self.dc_creator = v && RubyXL::StringNodeW3C.new(:value => v)
+    end
+
+    def modifier
+      cp_last_modified_by && cp_last_modified_by.value
+    end
+
+    def modifier=(v)
+      self.cp_last_modified_by = v && RubyXL::StringNodeW3C.new(:value => v)
+    end
+
+    def created_at
+      dcterms_created && dcterms_created.to_time
+    end
+
+    def created_at=(v)
+      self.dcterms_created = RubyXL::StringNodeW3C.default(v)
+    end
+
+    def modified_at
+      dcterms_modified && dcterms_modified.to_time
+    end
+
+    def modified_at=(v)
+      self.dcterms_modified = RubyXL::StringNodeW3C.default(v)
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/extensions.rb

@@ -0,0 +1,40 @@
+require 'rubyXL/objects/ooxml_object'
+
+module RubyXL
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_ext-1.html
+  class RawOOXML < OOXMLObject
+    attr_accessor :raw_xml
+
+    def self.parse(node, ignore)
+      obj = new
+      obj.raw_xml = node.to_xml
+      obj
+    end
+
+    def write_xml(xml, node_name_override = nil)
+      self.raw_xml
+    end
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_ext-1.html
+  class Extension < RawOOXML
+    define_attribute(:uri, :string)
+    define_element_name 'ext'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_extLst-1.html
+  class ExtensionStorageArea < OOXMLObject
+    define_child_node(RubyXL::Extension, :collection => true)
+    define_element_name 'extLst'
+  end
+
+  class AlternateContent < RawOOXML
+    define_element_name 'mc:AlternateContent'
+  end
+  
+  class RevisionPtr < RawOOXML
+    define_element_name 'xr:revisionPtr'
+  end
+
+end

data/lib/rubyXL/objects/external_links.rb

@@ -0,0 +1,85 @@
+module RubyXL
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheetName-1.html
+  class SheetName < OOXMLObject
+    define_attribute(:val, :string)
+    define_element_name 'sheetName'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheetNames-1.html
+  class SheetNames < OOXMLContainerObject
+    define_child_node(RubyXL::SheetName, :collection => true)
+    define_element_name 'sheetNames'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_definedName-1.html
+  class DefinedNameExt < OOXMLObject
+    define_attribute(:name,     :string, :required => true)
+    define_attribute(:refersTo, :string)
+    define_attribute(:sheetId,      :uint)
+    define_element_name 'definedName'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_definedNames-1.html
+  class DefinedNamesExt < OOXMLContainerObject
+    define_child_node(RubyXL::DefinedNameExt, :collection => true)
+    define_element_name 'definedNames'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_cell-1.html
+  class CellExt < OOXMLObject
+    define_child_node(RubyXL::StringNode, :node_name => :v)
+    define_attribute(:r,  :sqref)
+    define_attribute(:t,  :string, :default => 'n')
+    define_attribute(:vm, :uint,   :default => 0)
+    define_element_name 'cell'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_row-2.html
+  class RowExt < OOXMLObject
+    define_child_node(RubyXL::CellExt, :collection => true)
+    define_attribute(:r, :uint, :required => true)
+    define_element_name 'row'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheetData-3.html
+  class SheetDataExt < OOXMLObject
+    define_child_node(RubyXL::RowExt, :collection => true)
+    define_attribute(:sheetId,      :uint, :required => true)
+    define_attribute(:refreshError, :bool)
+    define_element_name 'sheetData'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_sheetDataSet-1.html
+  class SheetDataSet < OOXMLContainerObject
+    define_child_node(RubyXL::SheetDataExt, :collection => true)
+    define_element_name 'sheetDataSet'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_externalBook-1.html
+  class ExternalBook < OOXMLObject
+    define_child_node(RubyXL::SheetNames)
+    define_child_node(RubyXL::DefinedNamesExt)
+    define_child_node(RubyXL::SheetDataSet)
+    define_attribute(:'r:id', :string, :required => true)
+    define_element_name 'externalBook'
+  end
+
+  class ExternalLinksFile < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.externalLink+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/externalLink'
+
+    include RubyXL::RelationshipSupport
+    define_child_node(RubyXL::ExternalBook)
+
+    define_element_name 'externalLink'
+    set_namespaces('http://schemas.openxmlformats.org/spreadsheetml/2006/main' => nil,
+                   'http://schemas.openxmlformats.org/markup-compatibility/2006' => 'mc',
+                   'http://schemas.openxmlformats.org/officeDocument/2006/relationships' => 'r')
+
+    def xlsx_path
+      ROOT.join('xl', 'externalLinks', "externalLink#{file_index}.xml")
+    end
+  end
+
+end

data/lib/rubyXL/objects/fill.rb

@@ -0,0 +1,55 @@
+require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/simple_types'
+
+module RubyXL
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_stop-1.html
+  class Stop < OOXMLObject
+    define_attribute(:position, :double, :required => true)
+    define_child_node(RubyXL::Color)
+    define_element_name 'stop'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_patternFill-1.html
+  class PatternFill < OOXMLObject
+    define_attribute(:patternType, RubyXL::ST_PatternType)
+    define_child_node(RubyXL::Color, :node_name => :fgColor )
+    define_child_node(RubyXL::Color, :node_name => :bgColor )
+    define_element_name 'patternFill'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_gradientFill-1.html
+  class GradientFill < OOXMLObject
+    define_attribute(:type,   RubyXL::ST_GradientType, :default => 'linear')
+    define_attribute(:degree, :double, :default => 0)
+    define_attribute(:left,   :double, :default => 0)
+    define_attribute(:right,  :double, :default => 0)
+    define_attribute(:top,    :double, :default => 0)
+    define_attribute(:bottom, :double, :default => 0)
+    define_child_node(RubyXL::Stop, :collection => true)
+    define_element_name 'gradientFill'
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_fill-1.html
+  class Fill < OOXMLObject
+    define_child_node(RubyXL::PatternFill)
+    define_child_node(RubyXL::GradientFill)
+    define_element_name 'fill'
+
+    def self.default(pattern_type)
+      self.new(:pattern_fill => RubyXL::PatternFill.new(:pattern_type => pattern_type))
+    end
+
+  end
+
+  # http://www.datypic.com/sc/ooxml/e-ssml_fills-1.html
+  class Fills < OOXMLContainerObject
+    define_child_node(RubyXL::Fill, :collection => :with_count)
+    define_element_name 'fills'
+
+    def self.default
+      self.new(:_ => [ RubyXL::Fill.default('none'), RubyXL::Fill.default('gray125') ])
+    end
+  end
+
+end