rubyXL 2.5.7 → 3.0.0

data/lib/rubyXL/objects/root.rb

@@ -0,0 +1,57 @@
+require 'zip'
+require 'rubyXL/objects/relationships'
+
+module RubyXL
+
+  class WorkbookRoot
+    attr_accessor :filepath
+    attr_accessor :thumbnail, :core_properties, :document_properties, :custom_properties, :workbook
+    attr_accessor :content_types, :rels_hash
+
+    include RubyXL::RelationshipSupport
+
+    def related_objects
+      [ content_types, thumbnail, core_properties, document_properties, workbook ]
+    end
+
+    def relationship_file_class
+      RubyXL::RootRelationships
+    end
+
+    def attach_relationship(rid, rf)
+      case rf
+      when RubyXL::ThumbnailFile          then self.thumbnail = rf
+      when RubyXL::CorePropertiesFile     then self.core_properties = rf
+      when RubyXL::DocumentPropertiesFile then self.document_properties = rf
+      when RubyXL::CustomPropertiesFile   then self.custom_properties = rf
+      when RubyXL::Workbook               then self.workbook = rf
+      else store_relationship(rf, :unknown)
+      end
+    end
+
+    def self.default
+      obj = self.new
+      obj.document_properties    = RubyXL::DocumentPropertiesFile.new
+      obj.core_properties        = RubyXL::CorePropertiesFile.new
+      obj.relationship_container = RubyXL::RootRelationships.new
+      obj.content_types          = RubyXL::ContentTypes.new
+      obj
+    end
+
+    def self.parse_file(xl_file_path, opts)
+      raise 'Not .xlsx or .xlsm excel file' unless opts[:skip_filename_check] || 
+                                              %w{.xlsx .xlsm}.include?(File.extname(xl_file_path))
+
+      ::Zip::File.open(xl_file_path) { |zip_file|
+        root = self.new
+        root.filepath = xl_file_path
+        root.content_types = RubyXL::ContentTypes.parse_file(zip_file)
+        root.load_relationships(zip_file)
+        root.workbook.root = root
+        root
+      }
+    end
+
+  end
+
+end

data/lib/rubyXL/objects/shared_strings.rb

@@ -6,6 +6,9 @@ module RubyXL
 
   # http://www.schemacentral.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'
+
     # 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)
@@ -48,14 +51,10 @@ module RubyXL
       index 
     end
 
-    def self.xlsx_path
+    def xlsx_path
       File.join('xl', 'sharedStrings.xml')
     end
 
-    def self.content_type
-      'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml'
-    end
-
   end
 
 end

data/lib/rubyXL/objects/sheet_data.rb

@@ -8,7 +8,13 @@ module RubyXL
   # http://www.schemacentral.com/sc/ooxml/e-ssml_v-1.html
   class CellValue < OOXMLObject
     define_attribute(:_, :string, :accessor => :value)
+    define_attribute(:'xml:space', :string)
     define_element_name 'v'
+
+    def before_write_xml
+      self.xml_space = (value.is_a?(String) && ((value =~ /\A\s/) || (value =~ /\s\Z/) || value.include?("\n"))) ? 'preserve' : nil
+      true
+    end
   end
 
   # http://www.schemacentral.com/sc/ooxml/e-ssml_c-2.html
@@ -58,7 +64,7 @@ module RubyXL
     end
 
     def is_date?
-      return false unless raw_value =~ /^\d+(?:\.\d+)?$/ # Only fully numeric values can be dates
+      return false unless raw_value =~ /\A\d+(?:\.\d+)?\Z/ # Only fully numeric values can be dates
       num_fmt = self.number_format
       num_fmt && num_fmt.is_date_format?
     end
@@ -72,7 +78,7 @@ module RubyXL
         workbook.shared_strings_container[raw_value.to_i].to_s
       else 
         if is_date? then workbook.num_to_date(raw_value.to_f)
-        elsif raw_value.is_a?(String) && (raw_value =~ /^-?\d+(\.\d+(?:e[+-]\d+)?)?$/i) # Numeric
+        elsif raw_value.is_a?(String) && (raw_value =~ /\A-?\d+(\.\d+(?:e[+-]\d+)?)?\Z/i) # Numeric
           if $1 then raw_value.to_f
           else raw_value.to_i
           end

data/lib/rubyXL/objects/storage.rb

@@ -0,0 +1,169 @@
+module RubyXL
+
+  class GenericStorageObject
+
+    attr_accessor :xlsx_path, :data, :workbook, :generic_storage
+
+    def initialize
+      @workbook = nil
+      @xlsx_path = nil
+      @data = nil
+      @generic_storage = []
+    end
+
+    def self.save_order
+      0
+    end
+
+    def self.parse_file(dirpath, file_path = nil)
+      file_path ||= self.xlsx_path
+      obj = self.new
+
+      case dirpath
+      when String then
+        full_path = File.join(dirpath, file_path)
+        return nil unless File.exist?(full_path)
+        obj.data = File.open(full_path, 'r') { |f| f.read }
+      when Zip::File then
+        entry = dirpath.find_entry(file_path)
+        return nil if entry.nil?
+        obj.data = entry.get_input_stream { |f| f.read }
+      end
+
+      obj.xlsx_path = file_path
+      obj
+    end
+
+    def add_to_zip(zipfile)
+      return if @data.nil?
+
+      path = self.xlsx_path
+      path = path.relative_path_from(Pathname.new("/")) if path.absolute? # Zip doesn't like absolute paths.
+
+      zipfile.get_output_stream(path) { |f| f << @data }
+    end
+  end
+
+  class PrinterSettingsFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/printerSettings'
+  end
+
+  class DrawingFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawing+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing'
+
+    include RubyXL::RelationshipSupport
+
+    def relationship_file_class
+      RubyXL::DrawingRelationshipsFile
+    end
+
+    def attach_relationship(rid, rf)
+      case rf
+      when RubyXL::ChartFile       then store_relationship(rf) # TODO
+      when RubyXL::BinaryImageFile then store_relationship(rf) # TODO
+      else store_relationship(rf, :unknown)
+      end
+    end
+
+  end
+
+  class ChartFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawingml.chart+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart'
+
+    include RubyXL::RelationshipSupport
+
+    def relationship_file_class
+      RubyXL::ChartRelationshipsFile
+    end
+
+    def attach_relationship(rid, rf)
+      case rf
+      when RubyXL::ChartColorsFile     then self.generic_storage << rf # TODO
+      when RubyXL::ChartStyleFile      then self.generic_storage << rf # TODO
+      when RubyXL::ChartUserShapesFile then self.generic_storage << rf # TODO
+      else store_relationship(rf, :unknown)
+      end
+    end
+
+  end
+
+  class VMLDrawingFile < GenericStorageObject
+#    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawingml.chart+xml'
+    REL_TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/vmlDrawing'
+
+  end
+
+  class ChartColorsFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.ms-office.chartcolorstyle+xml'
+    REL_TYPE     = 'http://schemas.microsoft.com/office/2011/relationships/chartColorStyle'
+  end
+
+  class ChartStyleFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.ms-office.chartstyle+xml'
+    REL_TYPE     = 'http://schemas.microsoft.com/office/2011/relationships/chartStyle'
+  end
+
+  class TableFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/table'
+  end
+
+  class ControlPropertiesFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/ctrlProp'
+  end
+
+  class PivotTableFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotTable'
+  end
+
+  class PivotCacheDefinitionFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotCacheDefinition'
+  end
+
+  class BinaryImageFile < GenericStorageObject
+#    CONTENT_TYPE = 'image/jpeg'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/image'
+  end
+
+  class HyperlinkRelFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink'
+  end
+
+  class ThumbnailFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail'
+  end
+
+  class ChartUserShapesFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawingml.chartshapes+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/chartUserShapes'
+  end
+
+  class CustomPropertiesFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.custom-properties+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties'
+  end
+
+  class MacrosFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.ms-office.vbaProject'
+    REL_TYPE     = 'http://schemas.microsoft.com/office/2006/relationships/vbaProject'
+  end
+
+  class ExternalLinksFile < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.externalLink+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/externalLink'
+  end
+
+  class CustomXMLFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXml'
+  end
+
+  class SlicerFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.microsoft.com/office/2007/relationships/slicer'
+  end
+
+  class SlicerCacheFile < GenericStorageObject
+    REL_TYPE     = 'http://schemas.microsoft.com/office/2007/relationships/slicerCache'
+  end
+
+end

data/lib/rubyXL/objects/stylesheet.rb

@@ -160,6 +160,9 @@ module RubyXL
 
   # http://www.schemacentral.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'
+
     define_child_node(RubyXL::NumberFormats, :accessor => :number_formats)
     define_child_node(RubyXL::Fonts)
     define_child_node(RubyXL::Fills)
@@ -183,14 +186,10 @@ module RubyXL
       @format_hash = nil
     end
 
-    def self.xlsx_path
+    def xlsx_path
       File.join('xl', 'styles.xml')
     end
 
-    def self.content_type
-      'application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml'
-    end
-
     def self.default
       self.new(:fonts          => RubyXL::Fonts.defaults,
                :fills          => RubyXL::Fills.defaults,

data/lib/rubyXL/objects/text.rb

@@ -11,7 +11,7 @@ module RubyXL
     define_element_name 't'
 
     def before_write_xml
-      self.xml_space = (value && ((value =~ /^\s/) || (value =~ /\s$/)) || value.include?("\n")) ? 'preserve' : nil
+      self.xml_space = (value.is_a?(String) && ((value =~ /\A\s/) || (value =~ /\s\Z/) || value.include?("\n"))) ? 'preserve' : nil
       true
     end
 
@@ -72,8 +72,8 @@ module RubyXL
   class RichText < OOXMLObject
     define_child_node(RubyXL::Text)
     define_child_node(RubyXL::RichTextRun, :collection => true)
-    define_child_node(RubyXL::PhoneticRun)
-    define_child_node(RubyXL::PhoneticProperties) # phoneticPr
+    define_child_node(RubyXL::PhoneticRun, :collection => true)
+    define_child_node(RubyXL::PhoneticProperties)
     define_element_name 'is'
 
     def to_s

data/lib/rubyXL/objects/theme.rb

@@ -1377,6 +1377,9 @@ module RubyXL
 
   # http://www.schemacentral.com/sc/ooxml/e-a_theme.html
   class Theme < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.theme+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme'
+
     define_attribute(:name, :string, :default => '')
     define_child_node(RubyXL::ThemeElements)
     define_child_node(RubyXL::CT_ObjectStyleDefaults)
@@ -1388,15 +1391,10 @@ module RubyXL
 
     set_namespaces('http://schemas.openxmlformats.org/drawingml/2006/main' => 'a')
 
-    def self.xlsx_path
+    def xlsx_path
       File.join('xl', 'theme', 'theme1.xml')
     end
 
-    def self.content_type
-      'application/vnd.openxmlformats-officedocument.theme+xml'
-    end
-
-
     def self.defaults
       default_theme = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <a:theme xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main" name="Office Theme">

data/lib/rubyXL/objects/workbook.rb

@@ -287,6 +287,11 @@ module RubyXL
 
   # http://www.schemacentral.com/sc/ooxml/e-ssml_workbook.html
   class Workbook < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'
+
+    include RubyXL::RelationshipSupport
+
     define_child_node(RubyXL::FileVersion)
     define_child_node(RubyXL::FileSharing)
     define_child_node(RubyXL::WorkbookProperties, :accessor => :workbook_properties)
@@ -314,11 +319,14 @@ module RubyXL
                    'http://schemas.openxmlformats.org/markup-compatibility/2006' => 'mc',
                    'http://schemas.microsoft.com/office/spreadsheetml/2010/11/main' => 'x15')
 
+    attr_accessor :root
+    attr_accessor :calculation_chain, :theme, :stylesheet, :shared_strings_container
+
     def before_write_xml
       self.sheets = RubyXL::Sheets.new
 
       worksheets.each_with_index { |sheet, i|
-        rel = relationship_container.find_by_target(sheet.xlsx_path.gsub(/^xl\//, ''))
+        rel = relationship_container.find_by_target(sheet.xlsx_path.gsub(/\Axl\//, ''))
         sheets << RubyXL::Sheet.new(:name => sheet.sheet_name[0..30], # Max sheet name length is 31 char
                                     :sheet_id => sheet.sheet_id || (i + 1),
                                     :state => sheet.state, :r_id => rel.id)
@@ -326,7 +334,29 @@ module RubyXL
       true
     end
 
-    include LegacyWorkbook
+    def related_objects
+      [ calculation_chain, stylesheet, theme, shared_strings_container ] + @worksheets
+    end
+
+    def relationship_file_class
+      RubyXL::WorkbookRelationships
+    end
+
+    def attach_relationship(rid, rf)
+      case rf
+      when RubyXL::SharedStringsTable       then self.shared_strings_container = rf
+      when RubyXL::Stylesheet               then self.stylesheet = rf
+      when RubyXL::Theme                    then self.theme = rf
+      when RubyXL::CalculationChain         then self.calculation_chain = rf
+      when RubyXL::ExternalLinksFile        then store_relationship(rf) # TODO
+      when RubyXL::PivotCacheDefinitionFile then store_relationship(rf) # TODO
+      when RubyXL::CustomXMLFile            then store_relationship(rf) # TODO
+      when RubyXL::MacrosFile               then store_relationship(rf) # TODO
+      when RubyXL::SlicerCacheFile          then store_relationship(rf) # TODO
+      when RubyXL::Worksheet, RubyXL::Chartsheet then nil # These will be handled in the next loop
+      else store_relationship(rf, :unknown)
+      end
+    end
 
     def date1904
       workbook_properties && workbook_properties.date1904
@@ -342,67 +372,65 @@ module RubyXL
     end
 
     def company=(v)
-      self.document_properties.company ||= StringNode.new
-      self.document_properties.company.value = v
+      root.document_properties.company ||= StringNode.new
+      root.document_properties.company.value = v
     end
 
     def application
-      self.document_properties.application && self.document_properties.application.value
+      root.document_properties.application && self.document_properties.application.value
     end
 
     def application=(v)
-      self.document_properties.application ||= StringNode.new
-      self.document_properties.application.value = v
+      root.document_properties.application ||= StringNode.new
+      root.document_properties.application.value = v
     end
 
     def appversion
-      self.document_properties.app_version && self.document_properties.app_version.value
+      root.document_properties.app_version && root.document_properties.app_version.value
     end
 
     def appversion=(v)
-      self.document_properties.app_version ||= StringNode.new
-      self.document_properties.app_version.value = v
+      root.document_properties.app_version ||= StringNode.new
+      root.document_properties.app_version.value = v
     end
 
     def creator
-      self.core_properties.creator
+      root.core_properties.creator
     end
 
     def creator=(v)
-      self.core_properties.creator = v
+      root.core_properties.creator = v
     end
 
     def modifier
-      self.core_properties.modifier
+      root.core_properties.modifier
     end
 
     def modifier=(v)
-      self.core_properties.modifier = v
+      root.core_properties.modifier = v
     end
 
     def created_at
-      self.core_properties.created_at
+      root.core_properties.created_at
     end
 
     def created_at=(v)
-      self.core_properties.created_at = v
+      root.core_properties.created_at = v
     end
 
     def modified_at
-      self.core_properties.modified_at
+      root.core_properties.modified_at
     end
 
     def modified_at=(v)
-      self.core_properties.modified_at = v
+      root.core_properties.modified_at = v
     end
 
-    def self.xlsx_path
+    def xlsx_path
       File.join('xl', 'workbook.xml')
     end
 
-    def self.content_type
-      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml'
-    end
+    include LegacyWorkbook
 
   end