rubyXL 3.3.11 → 3.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f0204a1f12f767f68d274090700221023e5f04c
-  data.tar.gz: 0043ffb504367b35b4f5b6f9f4c2f12f7fe2ab0d
+  metadata.gz: 6e1c2446da3e82b6cb501d89c16c00779775dad4
+  data.tar.gz: 3be7993c63cab52678c22d6e9b8fadcd84d5429b
 SHA512:
-  metadata.gz: 14ee274b6fd27f0a7dc5f3b2980cbb4d4082796786e09c4540485bede4f7dab4f44ef65aab8a1ed2f7c6b2915c62c603cd749d2b38c31edafbb00f6313e31e80
-  data.tar.gz: 6afbe933dcb4d9197d57857628fc8afeb42d6fe642ab30ca4c98e53ac23e48c20d9bf50ed6f4a572d20849ba6cbab9e390b7041704470b89d9ffe8a4571f39f2
+  metadata.gz: 497e6a697688a07626a3a8677d39277f5fc77823d57c67fdd34561d81228898c88cfe0f0e94b22d0c498a8f79fe87263f442d9de4c5b75c9a7cf0aea9b623285
+  data.tar.gz: 2c679571955146a204105913426632c1e27ad79938eb3122111eb0cbdadf71b5569b0627996b88db5b75fc19fede41bbf01d310117dfb5af9dd486c2872eaa86

data/README.rdoc

@@ -194,12 +194,14 @@ WARNING: Use of this method WILL break formulas referencing cells which have bee
 
 == I/O
 
-=== Writing
+By default, the gem operates with files on the local filesystem:
+
+  workbook = RubyXL::Parser.parse("path/to/Excel/file.xlsx")
   workbook.write("path/to/desired/Excel/file.xlsx")
 
-=== Streaming
-The gem can provide +StringIO+ object containing the resulting +xlsx+ file, eliminating the need to save it to disk first. This capability comes in handy for web servers.
+It can also operate on +StringIO+ objects, thus eliminating the need to save the +xlsx+ file to disk. This capability comes in handy for web servers.
 
+  workbook = RubyXL::Parser.parse_buffer(buffer)
   workbook.stream
 
 == Miscellaneous

data/VERSION

@@ -1 +1 @@
-3.3.11
+3.3.12

data/lib/rubyXL.rb

@@ -3,6 +3,7 @@ require 'rubyXL/parser'
 
 module RubyXL
 
+  # Convert any path passed to absolute path (within the XLSX file).
   def self.from_root(path)
     return path unless path.absolute?
     path.relative_path_from(OOXMLTopLevelObject::ROOT)

data/lib/rubyXL/objects/ooxml_object.rb

@@ -421,10 +421,10 @@ module RubyXL
       self.class_variable_set(:@@ooxml_namespaces, namespace_hash)
     end
 
-    # Generates the top-level OOXML object by parsing its XML file from the temporary
-    # directory containing the unzipped contents of <tt>.xslx</tt>
+    # Generates the top-level OOXML object by parsing its XML file from the contents of the <tt>.xslx</tt> container.
     # === Parameters
-    # * +dirpath+ - path to the directory with the unzipped <tt>.xslx</tt> contents.
+    # * +zip_file+ - <tt>.xslx</tt> file as <tt>Zip::File</tt> object
+    # * +file_path+ - path to the subject file inside the <tt>.xslx</tt> zip archive
     def self.parse_file(zip_file, file_path)
       entry = zip_file.find_entry(RubyXL::from_root(file_path))
       # Accomodate for Nokogiri Java implementation which is incapable of reading from a stream

data/lib/rubyXL/objects/root.rb

@@ -9,7 +9,7 @@ module RubyXL
   class WorkbookRoot
     @@debug = nil
 
-    attr_accessor :filepath, :content_types, :rels_hash
+    attr_accessor :source_file_path, :content_types, :rels_hash
 
     include RubyXL::RelationshipSupport
 
@@ -32,6 +32,7 @@ module RubyXL
       obj
     end
 
+    # Write <tt>.xlsx</tt> to a stream (useful for sending over HTTP)
     def stream
       stream = Zip::OutputStream.write_buffer { |zipstream|
         self.rels_hash = {}
@@ -59,35 +60,27 @@ module RubyXL
       OOXMLTopLevelObject::ROOT
     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, ContentTypes::XLSX_PATH)
-          root.load_relationships(zip_file, OOXMLTopLevelObject::ROOT)
+    def self.parse_zip_file(zip_file)
+      root = self.new
+      root.content_types = RubyXL::ContentTypes.parse_file(zip_file, ContentTypes::XLSX_PATH)
+      root.load_relationships(zip_file, OOXMLTopLevelObject::ROOT)
 
-          wb = root.workbook
-          wb.root = root
+      wb = root.workbook
+      wb.root = root
 
-          wb.sheets.each_with_index { |sheet, i|
-            sheet_obj = wb.relationship_container.related_files[sheet.r_id]
+      wb.sheets.each_with_index { |sheet, i|
+        sheet_obj = wb.relationship_container.related_files[sheet.r_id]
 
-            wb.worksheets[i] = sheet_obj # Must be done first so the sheet becomes aware of its number
-            sheet_obj.workbook = wb
+        wb.worksheets[i] = sheet_obj # Must be done first so the sheet becomes aware of its number
+        sheet_obj.workbook = wb
 
-            sheet_obj.sheet_name = sheet.name
-            sheet_obj.sheet_id = sheet.sheet_id
-            sheet_obj.state = sheet.state
-          }
+        sheet_obj.sheet_name = sheet.name
+        sheet_obj.sheet_id = sheet.sheet_id
+        sheet_obj.state = sheet.state
+      }
 
-          root
-        }
-      rescue ::Zip::Error => e
-        raise e, "XLSX file format error: #{e}", e.backtrace
-      end
+      root
     end
-
   end
 
 end

data/lib/rubyXL/objects/workbook.rb

@@ -356,14 +356,19 @@ module RubyXL
     attr_accessor :worksheets
 
     def before_write_xml
+      max_sheet = worksheets.max_by(&:sheet_id)
+      max_sheet_id = max_sheet && max_sheet.sheet_id || 0
+
       self.sheets = RubyXL::Sheets.new
 
-      worksheets.each_with_index { |sheet, i|
+      worksheets.each { |sheet, i|
         rel = relationship_container.find_by_target(sheet.xlsx_path)
-        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)
+        sheets << RubyXL::Sheet.new(:name     => sheet.sheet_name[0..30], # Max sheet name length is 31 char
+                                    :sheet_id => sheet.sheet_id || (max_sheet_id += 1),
+                                    :state    => sheet.state,
+                                    :r_id     => rel.id)
       }
+
       true
     end
 
@@ -377,17 +382,17 @@ module RubyXL
     end
 
     # Save the resulting XLSX file to the specified location
-    def save(filepath = nil)
-      filepath ||= root.filepath
+    def save(dst_file_path = nil)
+      dst_file_path ||= root.source_file_path
 
-      extension = File.extname(filepath)
+      extension = File.extname(dst_file_path)
       unless %w{.xlsx .xlsm}.include?(extension.downcase)
         raise "Unsupported extension: #{extension} (only .xlsx and .xlsm files are supported)."
       end
 
-      File.open(filepath, "wb") { |output_file| FileUtils.copy_stream(root.stream, output_file) }
+      File.open(dst_file_path, "wb") { |output_file| FileUtils.copy_stream(root.stream, output_file) }
 
-      return filepath
+      return dst_file_path
     end
     alias_method :write, :save
 
@@ -421,7 +426,7 @@ module RubyXL
 
     @@debug = nil
 
-    def initialize(worksheets = [], filepath = nil, creator = nil, modifier = nil, created_at = nil,
+    def initialize(worksheets = [], src_file_path = nil, creator = nil, modifier = nil, created_at = nil,
                    company = '', application = APPLICATION, appversion = APPVERSION, date1904 = 0)
       super()
 
@@ -436,7 +441,7 @@ module RubyXL
       @relationship_container   = RubyXL::OOXMLRelationshipsFile.new
       @root                     = RubyXL::WorkbookRoot.default
       @root.workbook            = self
-      @root.filepath            = filepath
+      @root.source_file_path    = src_file_path
 
       creation_time = DateTime.parse(created_at) rescue DateTime.now
       self.created_at  = creation_time

data/lib/rubyXL/parser.rb

@@ -1,8 +1,29 @@
 module RubyXL
   class Parser
-    def self.parse(xl_file_path)
-      root = RubyXL::WorkbookRoot.parse_file(xl_file_path)
-      root.workbook
+
+    # Parse <tt>.xslx</tt> file by reading it from local disk.
+    def self.parse(src_file_path)
+      begin
+        ::Zip::File.open(src_file_path) { |zip_file|
+          root = RubyXL::WorkbookRoot.parse_zip_file(zip_file)
+          root.source_file_path = src_file_path
+          root.workbook
+        }
+      rescue ::Zip::Error => e
+        raise e, "XLSX file format error: #{e}", e.backtrace
+      end
     end
+
+    # Parse <tt>.xslx</tt> file contained in a stream (useful for receiving over HTTP).
+    def self.parse_buffer(buffer)
+      root = nil # Zip::File.open_buffer somehow fails to return the value from the block :(
+      begin
+        ::Zip::File.open_buffer(buffer) { |zip_file| root = RubyXL::WorkbookRoot.parse_zip_file(zip_file)  } 
+        root.workbook
+      rescue ::Zip::Error => e
+        raise e, "XLSX file format error: #{e}", e.backtrace
+      end
+    end
+
   end
 end

data/rdoc/README_rdoc.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>README - rubyXL 3.3.11</title>
+<title>README - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "./";
@@ -91,8 +91,6 @@
     <li><a href="#label-Delete+Cell">Delete Cell</a>
     <li><a href="#label-Modifying+Cell+Format">Modifying Cell Format</a>
     <li><a href="#label-I-2FO">I/O</a>
-    <li><a href="#label-Writing">Writing</a>
-    <li><a href="#label-Streaming">Streaming</a>
     <li><a href="#label-Miscellaneous">Miscellaneous</a>
     <li><a href="#label-For+more+information">For more information</a>
     <li><a href="#label-Contributing+to+rubyXL">Contributing to rubyXL</a>
@@ -408,18 +406,18 @@ have been moved, as the formulas do not adapt to the shifted cells</p>
 
 <h2 id="label-I-2FO">I/O<span><a href="#label-I-2FO">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
-<h3 id="label-Writing">Writing<span><a href="#label-Writing">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<p>By default, the gem operates with files on the local filesystem:</p>
 
-<pre class="ruby"><span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">write</span>(<span class="ruby-string">&quot;path/to/desired/Excel/file.xlsx&quot;</span>)
+<pre class="ruby"><span class="ruby-identifier">workbook</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Parser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">&quot;path/to/Excel/file.xlsx&quot;</span>)
+<span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">write</span>(<span class="ruby-string">&quot;path/to/desired/Excel/file.xlsx&quot;</span>)
 </pre>
 
-<h3 id="label-Streaming">Streaming<span><a href="#label-Streaming">&para;</a> <a href="#top">&uarr;</a></span></h3>
-
-<p>The gem can provide <code>StringIO</code> object containing the resulting
-<code>xlsx</code> file, eliminating the need to save it to disk first. This
-capability comes in handy for web servers.</p>
+<p>It can also operate on <code>StringIO</code> objects, thus eliminating the
+need to save the <code>xlsx</code> file to disk. This capability comes in
+handy for web servers.</p>
 
-<pre class="ruby"><span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">stream</span>
+<pre class="ruby"><span class="ruby-identifier">workbook</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Parser</span>.<span class="ruby-identifier">parse_buffer</span>(<span class="ruby-identifier">buffer</span>)
+<span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">stream</span>
 </pre>
 
 <h2 id="label-Miscellaneous">Miscellaneous<span><a href="#label-Miscellaneous">&para;</a> <a href="#top">&uarr;</a></span></h2>

data/rdoc/RubyXL.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>module RubyXL - rubyXL 3.3.11</title>
+<title>module RubyXL - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "./";
@@ -556,13 +556,13 @@
 
         <div class="method-description">
           
-          
+          <p>Convert any path passed to absolute path (within the XLSX file).</p>
           
           
 
           
           <div class="method-source-code" id="from_root-source">
-            <pre><span class="ruby-comment"># File lib/rubyXL.rb, line 6</span>
+            <pre><span class="ruby-comment"># File lib/rubyXL.rb, line 7</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">from_root</span>(<span class="ruby-identifier">path</span>)
   <span class="ruby-keyword">return</span> <span class="ruby-identifier">path</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">absolute?</span>
   <span class="ruby-identifier">path</span>.<span class="ruby-identifier">relative_path_from</span>(<span class="ruby-constant">OOXMLTopLevelObject</span><span class="ruby-operator">::</span><span class="ruby-constant">ROOT</span>)

data/rdoc/RubyXL/AExtension.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AExtension - rubyXL 3.3.11</title>
+<title>class RubyXL::AExtension - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/AExtensionStorageArea.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AExtensionStorageArea - rubyXL 3.3.11</title>
+<title>class RubyXL::AExtensionStorageArea - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/AdjustHandleList.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AdjustHandleList - rubyXL 3.3.11</title>
+<title>class RubyXL::AdjustHandleList - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/Alignment.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::Alignment - rubyXL 3.3.11</title>
+<title>class RubyXL::Alignment - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/AlternateContent.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AlternateContent - rubyXL 3.3.11</title>
+<title>class RubyXL::AlternateContent - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/Authors.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::Authors - rubyXL 3.3.11</title>
+<title>class RubyXL::Authors - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/AutoFilter.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AutoFilter - rubyXL 3.3.11</title>
+<title>class RubyXL::AutoFilter - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/AutoFilterColumn.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::AutoFilterColumn - rubyXL 3.3.11</title>
+<title>class RubyXL::AutoFilterColumn - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/BinaryImageFile.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::BinaryImageFile - rubyXL 3.3.11</title>
+<title>class RubyXL::BinaryImageFile - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/BodyProperties.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::BodyProperties - rubyXL 3.3.11</title>
+<title>class RubyXL::BodyProperties - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/BooleanNode.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::BooleanNode - rubyXL 3.3.11</title>
+<title>class RubyXL::BooleanNode - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/BooleanValue.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::BooleanValue - rubyXL 3.3.11</title>
+<title>class RubyXL::BooleanValue - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/Border.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::Border - rubyXL 3.3.11</title>
+<title>class RubyXL::Border - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/BorderEdge.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::BorderEdge - rubyXL 3.3.11</title>
+<title>class RubyXL::BorderEdge - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/Borders.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::Borders - rubyXL 3.3.11</title>
+<title>class RubyXL::Borders - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";

data/rdoc/RubyXL/Break.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>class RubyXL::Break - rubyXL 3.3.11</title>
+<title>class RubyXL::Break - rubyXL 3.3.12</title>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";