rubyXL 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a54bc20d6cdffb9452628d880575ec195885077
-  data.tar.gz: 0c2421c0e01f4c35c4e9aa93ff9c11268e8da399
+  metadata.gz: f5869b42fa836e952c86aaa4fa4f1d1be66667f6
+  data.tar.gz: 99cf17b380cdbeacb9fd6a8ac264db207cc0d933
 SHA512:
-  metadata.gz: 579c2a42754270f6c796647e1d46bd282a9806ca21056ae194929dab205aaf6571505289038e67e4d3befed6492d8514f170fb5cff941e1a2b9dbe5a4d38b58f
-  data.tar.gz: 28261b6ba4913eec6b9bba20c8a21875d35489581791845ce70869f3e9346395f9badadec97e037e29c97880d912febf9d90d7ce88b78412a8b9f0b9cdd04219
+  metadata.gz: 94490818c326db04f0df5623d722a5605e885de1ca23b659f16130063074416ca702b70730b53a27072084c52262dc572ec0569c8bdaf155c20b77e664afdc66
+  data.tar.gz: 28bc3a7c8c56eafec7d78e896f220e597a1014b9cbe6ada9e5cf7e25d0e3a08b887cafba2d2df4e5d346fd77c2259bfd52bfcde78b0a91f2cfdb8f823a2db2cf

data/VERSION

@@ -1 +1 @@
-3.0.2
+3.1.0

data/lib/rubyXL/cell.rb

@@ -286,7 +286,7 @@ module RubyXL
     end
 
     def get_cell_font
-      workbook.fonts[workbook.cell_xfs[self.style_index].font_id]
+      workbook.fonts[get_cell_xf.font_id]
     end
 
     def get_cell_border

data/lib/rubyXL/objects/border.rb

@@ -25,7 +25,6 @@ module RubyXL
     define_child_node(RubyXL::BorderEdge, :node_name => :vertical)
     define_child_node(RubyXL::BorderEdge, :node_name => :horizontal)
     define_element_name 'border'
-    set_countable
 
     def get_edge_style(direction)
       edge = self.send(direction)

data/lib/rubyXL/objects/cell_style.rb

@@ -53,7 +53,6 @@ module RubyXL
     define_child_node(RubyXL::Alignment)
     define_child_node(RubyXL::Protection)
     define_element_name 'xf'
-    set_countable
 
     def ==(other)
       (self.num_fmt_id == other.num_fmt_id) &&

data/lib/rubyXL/objects/chartsheet.rb

@@ -59,8 +59,10 @@ module RubyXL
   class Chartsheet < OOXMLTopLevelObject
     CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.chartsheet+xml'
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/chartsheet'
+    REL_CLASS    = RubyXL::SheetRelationshipsFile
 
     include RubyXL::RelationshipSupport
+    define_relationship(RubyXL::DrawingFile)
 
     attr_accessor :state, :rels
     attr_accessor :workbook, :sheet_name, :sheet_id
@@ -86,17 +88,6 @@ module RubyXL
       File.join('xl', 'chartsheets', "sheet#{file_index}.xml")
     end
 
-    def relationship_file_class
-      RubyXL::SheetRelationshipsFile
-    end
-
-    def attach_relationship(rid, rf)
-      case rf
-      when RubyXL::DrawingFile then store_relationship(rf) # TODO
-      else store_relationship(rf, :unknown)
-      end
-    end
-
   end
 
 end

data/lib/rubyXL/objects/fill.rb

@@ -35,7 +35,6 @@ module RubyXL
     define_child_node(RubyXL::PatternFill)
     define_child_node(RubyXL::GradientFill)
     define_element_name 'fill'
-    set_countable
   end
 
   # http://www.schemacentral.com/sc/ooxml/e-ssml_fills-1.html

data/lib/rubyXL/objects/font.rb

@@ -25,7 +25,6 @@ module RubyXL
     define_child_node(RubyXL::StringValue,  :node_name => :vertAlign)
     define_child_node(RubyXL::StringValue,  :node_name => :scheme)
     define_element_name 'font'
-    set_countable # TODO: phase put, eventually.
 
     def ==(other)
      (!(self.i && self.i.val) == !(other.i && other.i.val)) &&

data/lib/rubyXL/objects/ooxml_object.rb

@@ -105,12 +105,6 @@ module RubyXL
       self.class_variable_set(:@@ooxml_tag_name, element_name)
     end
 
-    # #TODO# This method will eventually be obsoleted.
-    def set_countable
-      self.class_variable_set(:@@ooxml_countable, true)
-      self.send(:attr_accessor, :count)
-    end
-
     def parse(node, known_namespaces = nil)
       node = Nokogiri::XML.parse(node) if node.is_a?(IO) || node.is_a?(String) || node.is_a?(Zip::InputStream)
 
@@ -436,23 +430,51 @@ module RubyXL
       when Zip::File then
         file_path = file_path.relative_path_from(::Pathname.new("/")) if file_path.absolute? # Zip doesn't like absolute paths.
         entry = dirpath.find_entry(file_path)
-        entry && (entry.get_input_stream { |f| parse(f) })
+        # Accomodate for Nokogiri Java implementation which is incapable of reading from a stream
+        entry && (entry.get_input_stream { |f| parse(defined?(JRUBY_VERSION) ? f.read : f) })
       end
     end
 
     # Saves the contents of the object as XML to respective location in <tt>.xslx</tt> zip container.
     # === Parameters
     # * +zipfile+ - ::Zip::File to which the resulting XNMML should be added.
-    def add_to_zip(zipfile)
+    def add_to_zip(zip_stream)
       xml_string = write_xml
       return if xml_string.empty?
-      zipfile.get_output_stream(self.xlsx_path) { |f| f << xml_string }
+      zip_stream.put_next_entry(self.xlsx_path)
+      zip_stream.write(xml_string)
     end
 
     def file_index
       @workbook.root.rels_hash[self.class].index{ |f| f.equal?(self) }.to_i + 1
     end
 
+    def self.define_relationship(klass, accessor = nil)
+      relationships = obtain_class_variable(:@@ooxml_relationships)
+      relationships[klass] = accessor
+    end 
+
+    def attach_relationship(rid, rf)
+      relationships = obtain_class_variable(:@@ooxml_relationships)
+      klass = rf.class
+      if relationships.has_key?(klass) then
+        accessor = relationships[klass]
+        case accessor
+        when NilClass then
+          # Relationship is known, but we don't have a special accessor for it, store as generic
+          store_relationship(rf)
+        when false then
+          # Do nothing, the code will perform attaching on its own
+        else
+          container = self.send(accessor)
+          if container.is_a?(Array) then container << rf
+          else self.send("#{accessor}=", rf)
+          end
+        end
+      else store_relationship(rf, :unknown)
+      end
+    end 
+
   end
 
 end

data/lib/rubyXL/objects/relationships.rb

@@ -203,7 +203,7 @@ module RubyXL
     end
 
     def load_relationships(dir_path, base_file_name = '')
-      self.relationship_container = relationship_file_class.load_relationship_file(dir_path, base_file_name)
+      self.relationship_container = self.class.const_get(:REL_CLASS).load_relationship_file(dir_path, base_file_name)
       return if relationship_container.nil?
 
       relationship_container.load_related_files(dir_path, base_file_name).each_pair { |rid, related_file|

data/lib/rubyXL/objects/root.rb

@@ -4,19 +4,25 @@ require 'rubyXL/objects/relationships'
 module RubyXL
 
   class WorkbookRoot
+    @@debug = nil
+
     attr_accessor :filepath
     attr_accessor :thumbnail, :core_properties, :document_properties, :custom_properties, :workbook
     attr_accessor :content_types, :rels_hash
 
+    REL_CLASS    = RubyXL::RootRelationships
+
     include RubyXL::RelationshipSupport
 
     def related_objects
-      [ content_types, thumbnail, core_properties, document_properties, workbook ]
+      [ content_types, thumbnail, core_properties, document_properties, custom_properties, workbook ]
     end
 
-    def relationship_file_class
-      RubyXL::RootRelationships
-    end
+#    define_relationship(RubyXL::ThumbnailFile,          :thumbnail)
+#    define_relationship(RubyXL::CorePropertiesFile,     :core_properties)
+#    define_relationship(RubyXL::DocumentPropertiesFile, :document_properties)
+#    define_relationship(RubyXL::CustomPropertiesFile,   :custom_properties)
+#    define_relationship(RubyXL::Workbook,               :workbook)
 
     def attach_relationship(rid, rf)
       case rf
@@ -38,18 +44,45 @@ module RubyXL
       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
+    def stream
+      stream = Zip::OutputStream.write_buffer { |zipstream|
+        self.rels_hash = {}
+        self.relationship_container.owner = self
+        self.content_types.overrides = []
+        self.content_types.owner = self
+        collect_related_objects.compact.each { |obj|
+          puts "<-- DEBUG: adding relationship to #{obj.class}" if @@debug
+          self.rels_hash[obj.class] ||= []
+          self.rels_hash[obj.class] << obj
+        }
+
+        self.rels_hash.keys.sort_by{ |c| c.save_order }.each { |klass|
+          puts "<-- DEBUG: saving related #{klass} files" if @@debug
+          self.rels_hash[klass].each { |obj|
+            obj.workbook = workbook if obj.respond_to?(:workbook=)
+            puts "<-- DEBUG:   > #{obj.xlsx_path}" if @@debug
+            self.content_types.add_override(obj)
+            obj.add_to_zip(zipstream)
+          }
+        }
       }
+      stream.rewind
+      stream
+    end
+
+    def self.parse_file(xl_file_path, opts)
+      begin
+        ::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
+        }
+      rescue ::Zip::Error => e
+        raise e, "XLSX file format error: #{e}", e.backtrace
+      end
     end
 
   end

data/lib/rubyXL/objects/sheet_common.rb

@@ -1,4 +1,5 @@
 require 'rubyXL/objects/ooxml_object'
+require 'rubyXL/objects/storage'
 
 module RubyXL
 

data/lib/rubyXL/objects/storage.rb

@@ -34,13 +34,12 @@ module RubyXL
       obj
     end
 
-    def add_to_zip(zipfile)
+    def add_to_zip(zip_stream)
       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 }
+      zip_stream.put_next_entry(path)
+      zip_stream.write(@data)
     end
   end
 
@@ -51,13 +50,10 @@ module RubyXL
   class DrawingFile < GenericStorageObject
     CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawing+xml'
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing'
+    REL_CLASS    = RubyXL::DrawingRelationshipsFile
 
     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
@@ -71,18 +67,15 @@ module RubyXL
   class ChartFile < GenericStorageObject
     CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawingml.chart+xml'
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart'
+    REL_CLASS    = RubyXL::ChartRelationshipsFile
 
     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
+      when RubyXL::ChartColorsFile     then store_relationship(rf) # TODO
+      when RubyXL::ChartStyleFile      then store_relationship(rf) # TODO
+      when RubyXL::ChartUserShapesFile then store_relationship(rf) # TODO
       else store_relationship(rf, :unknown)
       end
     end

data/lib/rubyXL/objects/workbook.rb

@@ -289,9 +289,27 @@ module RubyXL
   class Workbook < OOXMLTopLevelObject
     CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml'
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'
+    REL_CLASS    = RubyXL::WorkbookRelationships
 
     include RubyXL::RelationshipSupport
 
+    def related_objects
+      [ calculation_chain, stylesheet, theme, shared_strings_container ] + @worksheets
+    end
+
+    define_relationship(RubyXL::SharedStringsTable, :shared_strings_container)
+    define_relationship(RubyXL::Stylesheet,         :stylesheet)
+    define_relationship(RubyXL::Theme,              :theme)
+    define_relationship(RubyXL::CalculationChain,   :calculation_chain)
+    define_relationship(RubyXL::Stylesheet,         :stylesheet)
+    define_relationship(RubyXL::Worksheet,          false)
+    define_relationship(RubyXL::Chartsheet,         false)
+    define_relationship(RubyXL::ExternalLinksFile)
+    define_relationship(RubyXL::PivotCacheDefinitionFile)
+    define_relationship(RubyXL::CustomXMLFile)
+    define_relationship(RubyXL::MacrosFile)
+    define_relationship(RubyXL::SlicerCacheFile)
+
     define_child_node(RubyXL::FileVersion)
     define_child_node(RubyXL::FileSharing)
     define_child_node(RubyXL::WorkbookProperties, :accessor => :workbook_properties)
@@ -320,7 +338,7 @@ module RubyXL
                    'http://schemas.microsoft.com/office/spreadsheetml/2010/11/main' => 'x15')
 
     attr_accessor :root
-    attr_accessor :calculation_chain, :theme, :stylesheet, :shared_strings_container
+    attr_accessor :calculation_chain, :theme, :stylesheet, :shared_strings_container, :worksheets
 
     def before_write_xml
       self.sheets = RubyXL::Sheets.new
@@ -334,30 +352,6 @@ module RubyXL
       true
     end
 
-    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
     end

data/lib/rubyXL/objects/worksheet.rb

@@ -8,6 +8,7 @@ require 'rubyXL/objects/formula'
 require 'rubyXL/objects/sheet_data'
 require 'rubyXL/objects/filters'
 require 'rubyXL/objects/data_validation'
+require 'rubyXL/objects/comments'
 
 module RubyXL
 
@@ -606,6 +607,26 @@ module RubyXL
 
   # http://www.schemacentral.com/sc/ooxml/e-ssml_worksheet.html
   class Worksheet < OOXMLTopLevelObject
+    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml'
+    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet'
+    REL_CLASS    = RubyXL::SheetRelationshipsFile
+
+    include RubyXL::RelationshipSupport
+
+    def related_objects
+      comments + printer_settings
+    end
+
+    define_relationship(RubyXL::PrinterSettingsFile,  :printer_settings)
+    define_relationship(RubyXL::CommentsFile,         :comments)
+    define_relationship(RubyXL::VMLDrawingFile)
+    define_relationship(RubyXL::DrawingFile)
+    define_relationship(RubyXL::BinaryImageFile)
+    define_relationship(RubyXL::PivotTableFile)
+    define_relationship(RubyXL::TableFile)
+    define_relationship(RubyXL::ControlPropertiesFile)
+    define_relationship(RubyXL::SlicerFile)
+
     define_child_node(RubyXL::WorksheetProperties)
     define_child_node(RubyXL::WorksheetDimensions)
     define_child_node(RubyXL::WorksheetViews)
@@ -654,9 +675,6 @@ module RubyXL
 
     attr_accessor :workbook, :state, :sheet_name, :sheet_id, :rels, :comments, :printer_settings
 
-    CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml'
-    REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet'
-
     def before_write_xml # This method may need to be moved higher in the hierarchy
       first_nonempty_row = nil
       last_nonempty_row = 0
@@ -702,31 +720,6 @@ module RubyXL
       true
     end
 
-    include RubyXL::RelationshipSupport
-
-    def related_objects
-      comments + printer_settings
-    end
-
-    def relationship_file_class
-      RubyXL::SheetRelationshipsFile
-    end
-
-    def attach_relationship(rid, rf)
-      case rf
-      when RubyXL::PrinterSettingsFile   then printer_settings << rf
-      when RubyXL::CommentsFile          then comments << rf
-      when RubyXL::VMLDrawingFile        then store_relationship(rf) # TODO
-      when RubyXL::DrawingFile           then store_relationship(rf) # TODO
-      when RubyXL::BinaryImageFile       then store_relationship(rf) # TODO
-      when RubyXL::PivotTableFile        then store_relationship(rf) # TODO
-      when RubyXL::TableFile             then store_relationship(rf) # TODO
-      when RubyXL::ControlPropertiesFile then store_relationship(rf) # TODO
-      when RubyXL::SlicerFile            then store_relationship(rf) # TODO
-      else store_relationship(rf, :unknown)
-      end
-    end
-
     def xlsx_path
       File.join('xl', 'worksheets', "sheet#{file_index}.xml")
     end