rubyXL 2.5.7 → 3.0.0

data/lib/rubyXL/objects/worksheet.rb

@@ -306,7 +306,7 @@ module RubyXL
 
   # http://www.schemacentral.com/sc/ooxml/e-ssml_hyperlinks-1.html
   class Hyperlinks < OOXMLContainerObject
-    define_child_node(RubyXL::Hyperlink, :colection => true)
+    define_child_node(RubyXL::Hyperlink, :collection => true)
     define_element_name 'hyperlinks'
   end
 
@@ -324,7 +324,7 @@ module RubyXL
 
   # http://www.schemacentral.com/sc/ooxml/e-ssml_oleObjects-1.html
   class OLEObjects < OOXMLContainerObject
-    define_child_node(RubyXL::OLEObject, :colection => true)
+    define_child_node(RubyXL::OLEObject, :collection => true)
     define_element_name 'oleObjects'
   end                              
 
@@ -652,7 +652,10 @@ module RubyXL
                    'http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac' => 'x14ac',
                    'urn:schemas-microsoft-com:mac:vml' => 'mv')
 
-    attr_accessor :workbook, :state, :sheet_name, :sheet_id
+    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
@@ -699,24 +702,45 @@ module RubyXL
       true
     end
 
-    def sheet_index
-      @workbook.worksheets.select{ |sheet| sheet.is_a?(self.class) }.index{ |sheet| sheet.equal?(self) }
+    include RubyXL::RelationshipSupport
+
+    def related_objects
+      comments + printer_settings
     end
 
-    def xlsx_path
-      File.join('xl', 'worksheets', "sheet#{sheet_index + 1}.xml")
+    def relationship_file_class
+      RubyXL::SheetRelationshipsFile
     end
 
-    def self.content_type
-      'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml'
+    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 rel_type
-      'worksheet'
+    def xlsx_path
+      File.join('xl', 'worksheets', "sheet#{file_index}.xml")
+    end
+    def self.parse(param)
+      sheet_obj = super
+      sheet_obj.sheet_data.rows.each { |r|
+        next if r.nil?
+        r.worksheet = sheet_obj
+        r.cells.each { |c| c.worksheet = sheet_obj unless c.nil? }
+      }
+      sheet_obj
     end
 
     include LegacyWorksheet
-
   end
 
 end

data/lib/rubyXL/parser.rb

@@ -1,7 +1,6 @@
 require 'nokogiri'
 require 'tmpdir'
 require 'zip'
-require 'rubyXL/generic_storage'
 
 module RubyXL
 
@@ -10,117 +9,44 @@ module RubyXL
       self.new(opts).parse(file_path)
     end
 
-    # +keep_tempfiles_on_error+ prevents temp files to be erased if exception was thrown during parsing.
     # +:data_only+ allows only the sheet data to be parsed, so as to speed up parsing.
     # However, using this option will result in date-formatted cells being interpreted as numbers.
     def initialize(opts = {})
-      @data_only = opts.is_a?(TrueClass) || opts[:data_only]
-      @skip_filename_check = opts[:skip_filename_check]
-      @delete_tempfiles_on_error = !opts[:keep_tempfiles_on_error]
-    end
-
-    def data_only
-      @data_only = true
-      self
+      @opts = opts
     end
 
     def parse(xl_file_path)
-      raise 'Not .xlsx or .xlsm excel file' unless @skip_filename_check ||
-                                              %w{.xlsx .xlsm}.include?(File.extname(xl_file_path))
-
-      dir_path = File.join(File.dirname(xl_file_path), Dir::Tmpname.make_tmpname(['rubyXL', '.tmp'], nil))
-      parse_success = false
-
-      begin
-        ::Zip::File.open(xl_file_path) { |zip_file|
-          zip_file.each { |f|
-            fpath = File.join(dir_path, f.name)
-            FileUtils.mkdir_p(File.dirname(fpath))
-            zip_file.extract(f, fpath) unless File.exist?(fpath)
-          }
-        }
-
-        wb = RubyXL::Workbook.parse_file(dir_path)
-        wb.filepath = xl_file_path
-
-        wb.content_types = RubyXL::ContentTypes.parse_file(dir_path)
-        wb.relationship_container = RubyXL::WorkbookRelationships.parse_file(dir_path)
-        wb.root_relationship_container = RubyXL::RootRelationships.parse_file(dir_path)
-        wb.shared_strings_container = RubyXL::SharedStringsTable.parse_file(dir_path)
-
-        # We must always load the stylesheet because it tells us which values are actually dates/times.
-        wb.stylesheet = RubyXL::Stylesheet.parse_file(dir_path)
+      root = RubyXL::WorkbookRoot.parse_file(xl_file_path, @opts)
 
-        unless @data_only
-          wb.media.load_dir(dir_path)
-          wb.external_links.load_dir(dir_path)
-          wb.external_links_rels.load_dir(dir_path)
-          wb.drawings.load_dir(dir_path)
-          wb.drawings_rels.load_dir(dir_path)
-          wb.charts.load_dir(dir_path)
-          wb.chart_rels.load_dir(dir_path)
-          wb.printer_settings.load_dir(dir_path)
-          wb.worksheet_rels.load_dir(dir_path)
-          wb.chartsheet_rels.load_dir(dir_path)
-          wb.macros.load_file(dir_path, 'vbaProject.bin')
-          wb.thumbnail.load_file(dir_path, 'thumbnail.jpeg')
+      wb = root.workbook
 
-          wb.theme = RubyXL::Theme.parse_file(dir_path)
-          wb.core_properties = RubyXL::CoreProperties.parse_file(dir_path)
-          wb.document_properties = RubyXL::DocumentProperties.parse_file(dir_path)
-          wb.calculation_chain = RubyXL::CalculationChain.parse_file(dir_path)
-        end
+      if wb.stylesheet then
+        #fills out count information for each font, fill, and border
+        wb.cell_xfs.each { |style|
 
-        if wb.stylesheet then
-          #fills out count information for each font, fill, and border
-          wb.cell_xfs.each { |style|
+          id = style.font_id
+          wb.fonts[id].count += 1 #unless id.nil?
 
-            id = style.font_id
-            wb.fonts[id].count += 1 #unless id.nil?
+          id = style.fill_id
+          wb.fills[id].count += 1 #unless id.nil?
 
-            id = style.fill_id
-            wb.fills[id].count += 1 #unless id.nil?
-
-            id = style.border_id
-            wb.borders[id].count += 1 #unless id.nil?
-          }
-        end
-
-        wb.sheets.each_with_index { |sheet, i|
-          sheet_rel = wb.relationship_container.find_by_rid(sheet.r_id)
-
-          sheet_path = sheet_rel.target
-          sheet_path = File.join('xl', sheet_path) if sheet_path[0] != '/'
-
-          # Making sure that the file will be automatically closed immediately after it has been read
-          File.open(File.join(dir_path, sheet_path)) { |sheet_file|
-            case File::basename(sheet_rel.type)
-            when 'worksheet' then
-              sheet_obj = RubyXL::Worksheet.parse(sheet_file)
-              sheet_obj.sheet_data.rows.each { |r|
-                next if r.nil?
-                r.worksheet = sheet
-                r.cells.each { |c| c.worksheet = sheet_obj unless c.nil? }
-              }
-            when 'chartsheet' then
-              sheet_obj = RubyXL::Chartsheet.parse(sheet_file)
-            end
+          id = style.border_id
+          wb.borders[id].count += 1 #unless id.nil?
+        }
+      end
 
-            sheet_obj.workbook = wb
-            sheet_obj.sheet_name = sheet.name
-            sheet_obj.sheet_id = sheet.sheet_id
-            sheet_obj.state = sheet.state
+      wb.sheets.each_with_index { |sheet, i|
+        sheet_obj = wb.relationship_container.related_files[sheet.r_id]
 
-            wb.worksheets[i] = sheet_obj
-          }
-        }
+        wb.worksheets[i] = sheet_obj # Must be done first so the sheet becomes aware of its number
+        sheet_obj.workbook = wb
 
-        parse_success = true
-      ensure
-        FileUtils.remove_entry_secure(dir_path) if parse_success || @delete_tempfiles_on_error
-      end
+        sheet_obj.sheet_name = sheet.name
+        sheet_obj.sheet_id = sheet.sheet_id
+        sheet_obj.state = sheet.state
+      }
 
-      return wb
+      wb
     end
 
   end

data/lib/rubyXL/workbook.rb

@@ -5,17 +5,14 @@ require 'zip'
 module RubyXL
   module LegacyWorkbook
     include Enumerable
-    attr_accessor :worksheets, :filepath, :theme,
-      :media, :external_links, :external_links_rels, :drawings, :drawings_rels, :charts, :chart_rels,
-      :worksheet_rels, :chartsheet_rels, :printer_settings, :macros, :thumbnail
-
-    attr_accessor :stylesheet, :shared_strings_container, :document_properties, :calculation_chain,
-                  :relationship_container, :root_relationship_container, :core_properties, :content_types
+    attr_accessor :worksheets
 
     SHEET_NAME_TEMPLATE = 'Sheet%d'
     APPLICATION = 'Microsoft Macintosh Excel'
     APPVERSION  = '12.0000'
 
+    @@debug = nil
+
     def initialize(worksheets=[], filepath=nil, creator=nil, modifier=nil, created_at=nil,
                    company='', application=APPLICATION,
                    appversion=APPVERSION, date1904=0)
@@ -26,32 +23,18 @@ module RubyXL
       @worksheets = worksheets
       add_worksheet if @worksheets.empty?
 
-      @filepath            = filepath
       @creator             = creator
       @modifier            = modifier
       self.date1904        = date1904 > 0
-      @media               = RubyXL::GenericStorage.new(File.join('xl', 'media')).binary
-      @external_links      = RubyXL::GenericStorage.new(File.join('xl', 'externalLinks'))
-      @external_links_rels = RubyXL::GenericStorage.new(File.join('xl', 'externalLinks', '_rels'))
-      @drawings            = RubyXL::GenericStorage.new(File.join('xl', 'drawings'))
-      @drawings_rels       = RubyXL::GenericStorage.new(File.join('xl', 'drawings', '_rels'))
-      @charts              = RubyXL::GenericStorage.new(File.join('xl', 'charts'))
-      @chart_rels          = RubyXL::GenericStorage.new(File.join('xl', 'charts', '_rels'))
-      @worksheet_rels      = RubyXL::GenericStorage.new(File.join('xl', 'worksheets', '_rels'))
-      @chartsheet_rels     = RubyXL::GenericStorage.new(File.join('xl', 'chartsheets', '_rels'))
-      @printer_settings    = RubyXL::GenericStorage.new(File.join('xl', 'printerSettings')).binary
-      @macros              = RubyXL::GenericStorage.new('xl').binary
-      @thumbnail           = RubyXL::GenericStorage.new('docProps').binary
 
       @theme                    = RubyXL::Theme.defaults
       @shared_strings_container = RubyXL::SharedStringsTable.new
       @stylesheet               = RubyXL::Stylesheet.default
-      @document_properties      = RubyXL::DocumentProperties.new
-      @core_properties          = RubyXL::CoreProperties.new
-      @content_types            = RubyXL::ContentTypes.new
       @relationship_container   = RubyXL::WorkbookRelationships.new
-      @root_relationship_container  = RubyXL::RootRelationships.new
-      @calculation_chain        = nil
+      @root                     = RubyXL::WorkbookRoot.default
+      @root.workbook            = self
+      @root.filepath            = filepath
+      @comments                 = []
 
       self.company         = company
       self.application     = application
@@ -95,7 +78,9 @@ module RubyXL
     end
 
     #filepath of xlsx file (including file itself)
-    def write(filepath = @filepath)
+    def write(filepath)
+      filepath ||= root.filepath
+
       extension = File.extname(filepath)
       unless %w{.xlsx .xlsm}.include?(extension)
         raise "Only xlsx and xlsm files are supported. Unsupported extension: #{extension}"
@@ -107,24 +92,27 @@ module RubyXL
       zippath  = File.join(temppath, 'file.zip')
 
       ::Zip::File.open(zippath, ::Zip::File::CREATE) { |zipfile|
-        theme && theme.add_to_zip(zipfile)
-        calculation_chain && calculation_chain.add_to_zip(zipfile)
-        shared_strings_container && shared_strings_container.add_to_zip(zipfile)
-        document_properties.add_to_zip(zipfile) if document_properties
-        core_properties.add_to_zip(zipfile) if core_properties
-        content_types.workbook = self
-        content_types.add_to_zip(zipfile)
-        relationship_container.workbook = root_relationship_container.workbook = self
-        relationship_container.add_to_zip(zipfile)
-        stylesheet.add_to_zip(zipfile) if stylesheet
-        root_relationship_container.add_to_zip(zipfile)
-        self.add_to_zip(zipfile)
+        root.rels_hash = {}
+        root.relationship_container.owner = root
+        root.content_types.overrides = []
+        root.content_types.owner = root
+        root.collect_related_objects.compact.each { |obj|
+          puts "<-- DEBUG: adding relationship to #{obj.class}" if @@debug
+          root.rels_hash[obj.class] ||= []
+          root.rels_hash[obj.class] << obj
+        }
 
-        [ @media, @external_links, @external_links_rels,
-          @drawings, @drawings_rels, @charts, @chart_rels,
-          @printer_settings, @worksheet_rels, @chartsheet_rels, @macros, @thumbnail ].each { |s| s.add_to_zip(zipfile) }
+        root.rels_hash.keys.sort_by{ |c| c.save_order }.each { |klass|
+          puts "<-- DEBUG: saving related #{klass} files" if @@debug
+          root.rels_hash[klass].each { |obj|
+            obj.workbook = self if obj.respond_to?(:workbook=)
+            puts "<-- DEBUG:   > #{obj.xlsx_path}" if @@debug
+            root.content_types.add_override(obj)
+            obj.add_to_zip(zipfile)
+          }
+        }
 
-        @worksheets.each { |sheet| sheet.add_to_zip(zipfile) }
+        self.add_to_zip(zipfile)
       }
 
       FileUtils.mv(zippath, filepath)

data/lib/rubyXL/worksheet.rb

@@ -9,6 +9,9 @@ module LegacyWorksheet
     self.sheet_id   = params[:sheet_id]
     self.sheet_data = RubyXL::SheetData.new
     self.cols = RubyXL::ColumnRanges.new
+    @comments = [] # Do not optimize! These are arrays, so they will share the pointer!
+    @printer_settings = []
+    @generic_storage = []
   end
 
   # allows for easier access to sheet_data

data/rdoc/README_rdoc.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>README - rubyXL 2.5.7</title>
+<title>README - rubyXL 3.0.0</title>
 
 <link href="./fonts.css" rel="stylesheet">
 <link href="./rdoc.css" rel="stylesheet">

data/rdoc/RubyXL.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>module RubyXL - rubyXL 2.5.7</title>
+<title>module RubyXL - rubyXL 3.0.0</title>
 
 <link href="./fonts.css" rel="stylesheet">
 <link href="./rdoc.css" rel="stylesheet">

data/rdoc/RubyXL/AExtension.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AExtension - rubyXL 2.5.7</title>
+<title>class RubyXL::AExtension - rubyXL 3.0.0</title>
 
 <link href="../fonts.css" rel="stylesheet">
 <link href="../rdoc.css" rel="stylesheet">

data/rdoc/RubyXL/AExtensionStorageArea.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AExtensionStorageArea - rubyXL 2.5.7</title>
+<title>class RubyXL::AExtensionStorageArea - rubyXL 3.0.0</title>
 
 <link href="../fonts.css" rel="stylesheet">
 <link href="../rdoc.css" rel="stylesheet">

data/rdoc/RubyXL/AdjustHandleList.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AdjustHandleList - rubyXL 2.5.7</title>
+<title>class RubyXL::AdjustHandleList - rubyXL 3.0.0</title>
 
 <link href="../fonts.css" rel="stylesheet">
 <link href="../rdoc.css" rel="stylesheet">

data/rdoc/RubyXL/Alignment.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::Alignment - rubyXL 2.5.7</title>
+<title>class RubyXL::Alignment - rubyXL 3.0.0</title>
 
 <link href="../fonts.css" rel="stylesheet">
 <link href="../rdoc.css" rel="stylesheet">

data/rdoc/RubyXL/AlternateContent.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AlternateContent - rubyXL 2.5.7</title>
+<title>class RubyXL::AlternateContent - rubyXL 3.0.0</title>
 
 <link href="../fonts.css" rel="stylesheet">
 <link href="../rdoc.css" rel="stylesheet">

data/rdoc/RubyXL/Authors.html

@@ -0,0 +1,105 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class RubyXL::Authors - rubyXL 3.0.0</title>
+
+<link href="../fonts.css" rel="stylesheet">
+<link href="../rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/navigation.js"></script>
+<script src="../js/search_index.js"></script>
+<script src="../js/search.js"></script>
+<script src="../js/searcher.js"></script>
+<script src="../js/darkfish.js"></script>
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  
+  <p class="link">OOXMLContainerObject
+  
+</div>
+
+    
+    
+    
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-RubyXL::Authors">
+  <h1 id="class-RubyXL::Authors" class="class">
+    class RubyXL::Authors
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+