rubyXL 3.2.3 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c64fdf09ffe2f26c37a1fd3aace4d1ec00cd398
-  data.tar.gz: fe5034b9f96bc0639fe9b7889d6c7f3e4687cfe3
+  metadata.gz: e450c70daabe201ccf2e0f987f4f14c3273bb037
+  data.tar.gz: bd023be77266276fa8b29bda8166ead733ba23aa
 SHA512:
-  metadata.gz: adb96c6cc256aa9a27647d2d0eb13ef4189e558d76d0485e8382424d85b30b70f06a02d138a020bf3c5d0a5231263b5efd98642464c1224f535a156f32bf62e2
-  data.tar.gz: 915bd0716b2cf919c05f99011f1842effcd17e4f57c9974f6cf57bc3766c53600ce9a4e7e267d4c6c9790f8f55ee2086da60d386b3da9423fd543a7de72838cb
+  metadata.gz: ee7372a66f9b8aaa7a3ffd0f3b6104de0d2775360bcc142192036b854cd9ed522bfa70475b70aabce510a6e249221eeebe4db3835fb723b2a6102f733455b068
+  data.tar.gz: 6ac2cb780df29ad9fa26e5e6368062279dfb9f8fb516a0f9a677c5468faa198145f8a6f0a6011178dbc301f7410e929c6754aba09795b3bd4ad58d6e4e77f64f

data/README.rdoc

@@ -2,6 +2,13 @@
 {<img src="https://badge.fury.io/rb/rubyXL.svg" alt="Gem Version" />}[http://badge.fury.io/rb/rubyXL]
 {<img src="https://codeclimate.com/github/weshatheleopard/rubyXL.png" alt="Code Climate" />}[https://codeclimate.com/github/weshatheleopard/rubyXL]
 
+This gem supports operating on +xlsx+ files (Open XML format). While it is capable
+of properly parsing the entire OOXML structure, its current main emphasis is on
+reading files produced by MS Excel, making minor modifications to them and saving
+them to be opened again, while preserving as much of the structure as possible.
+
+Please note that proprietary binary +xls+ format is *not* supported.
+
 == To Install:
   gem install rubyXL
 
@@ -67,7 +74,7 @@ Please note: these methods are being phased out in favor of the OOXML object mod
   worksheet.get_column_font_size(0)
   worksheet.get_column_font_color(0)
   worksheet.is_column_underlined(0)
-  worksheet.get_column_height(0)
+  worksheet.get_column_width(0)
   worksheet.get_column_horizontal_alignment(0)
   worksheet.get_column_vertical_alignment(0)
   worksheet.get_column_border_right(0)

data/VERSION

@@ -1 +1 @@
-3.2.3
+3.2.4

data/lib/rubyXL/{workbook.rb → convenience_methods.rb}

@@ -1,50 +1,6 @@
-require 'tmpdir'
-require 'date'
-
 module RubyXL
-  module LegacyWorkbook
-    include Enumerable
-
+  module WorkbookConvenienceMethods
     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)
-      super()
-
-      # Order of sheets in the +worksheets+ array corresponds to the order of pages in Excel UI.
-      # SheetId's, rId's, etc. are completely unrelated to ordering.
-      @worksheets = worksheets
-      add_worksheet if @worksheets.empty?
-
-      @creator             = creator
-      @modifier            = modifier
-      self.date1904        = date1904 > 0
-
-      @theme                    = RubyXL::Theme.defaults
-      @shared_strings_container = RubyXL::SharedStringsTable.new
-      @stylesheet               = RubyXL::Stylesheet.default
-      @relationship_container   = RubyXL::OOXMLRelationshipsFile.new
-      @root                     = RubyXL::WorkbookRoot.default
-      @root.workbook            = self
-      @root.filepath            = filepath
-      @comments                 = []
-
-      self.company         = company
-      self.application     = application
-      self.appversion      = appversion
-
-      begin
-        @created_at       = DateTime.parse(created_at).strftime('%Y-%m-%dT%TZ')
-      rescue
-        @created_at       = Time.now.strftime('%Y-%m-%dT%TZ')
-      end
-      @modified_at        = @created_at
-    end
 
     # Finds worksheet by its name or numerical index
     def [](ind)
@@ -75,42 +31,88 @@ module RubyXL
       worksheets.each{ |i| yield i }
     end
 
-    # Return the resulting XLSX file in a stream (useful for sending over HTTP)
-    def stream
-      root.stream
+    def date1904
+      workbook_properties && workbook_properties.date1904
     end
 
-    # Save the resulting XLSX file to the specified location
-    def save(filepath = nil)
-      filepath ||= root.filepath
+    def date1904=(v)
+      self.workbook_properties ||= RubyXL::WorkbookProperties.new
+      workbook_properties.date1904 = v
+    end
 
-      extension = File.extname(filepath)
-      unless %w{.xlsx .xlsm}.include?(extension.downcase)
-        raise "Unsupported extension: #{extension} (only .xlsx and .xlsm files are supported)."
-      end
+    def company
+      root.document_properties.company && root.document_properties.company.value
+    end
+
+    def company=(v)
+      root.document_properties.company ||= StringNode.new
+      root.document_properties.company.value = v
+    end
 
-      File.open(filepath, "wb") { |output_file| FileUtils.copy_stream(root.stream, output_file) }
+    def application
+      root.document_properties.application && root.document_properties.application.value
+    end
 
-      return filepath
+    def application=(v)
+      root.document_properties.application ||= StringNode.new
+      root.document_properties.application.value = v
     end
-    alias_method :write, :save
 
-    def base_date
-      if date1904 then
-        DateTime.new(1904, 1, 1)
-      else
-        # Subtracting one day to accomodate for erroneous 1900 leap year compatibility only for 1900 based dates
-        DateTime.new(1899, 12, 31) - 1
-      end
+    def appversion
+      root.document_properties.app_version && root.document_properties.app_version.value
+    end
+
+    def appversion=(v)
+      root.document_properties.app_version ||= StringNode.new
+      root.document_properties.app_version.value = v
+    end
+
+    def creator
+      root.core_properties.creator
     end
-    private :base_date
 
-    def date_to_num(date)
-      date && (date.ajd - base_date().ajd).to_f
+    def creator=(v)
+      root.core_properties.creator = v
     end
 
-    def num_to_date(num)
-      num && (base_date + num)
+    def modifier
+      root.core_properties.modifier
+    end
+
+    def modifier=(v)
+      root.core_properties.modifier = v
+    end
+
+    def created_at
+      root.core_properties.created_at
+    end
+
+    def created_at=(v)
+      root.core_properties.created_at = v
+    end
+
+    def modified_at
+      root.core_properties.modified_at
+    end
+
+    def modified_at=(v)
+      root.core_properties.modified_at = v
+    end
+
+    def cell_xfs # Stylesheet should be pre-filled with defaults on initialize()
+      stylesheet.cell_xfs
+    end
+
+    def fonts # Stylesheet should be pre-filled with defaults on initialize()
+      stylesheet.fonts
+    end
+
+    def fills # Stylesheet should be pre-filled with defaults on initialize()
+      stylesheet.fills
+    end
+
+    def borders # Stylesheet should be pre-filled with defaults on initialize()
+      stylesheet.borders
     end
 
     def get_fill_color(xf)
@@ -183,38 +185,6 @@ module RubyXL
       register_new_xf(new_xf, style_index)
     end
 
-    def cell_xfs # Stylesheet should be pre-filled with defaults on initialize()
-      stylesheet.cell_xfs
-    end
-
-    def fonts # Stylesheet should be pre-filled with defaults on initialize()
-      stylesheet.fonts
-    end
-
-    def fills # Stylesheet should be pre-filled with defaults on initialize()
-      stylesheet.fills
-    end
-
-    def borders # Stylesheet should be pre-filled with defaults on initialize()
-      stylesheet.borders
-    end
-
-    private
-
-=begin
-    #fills shared strings hash, contains each unique string
-    def fill_shared_strings()
-      @worksheets.compact.each { |sheet|
-        sheet.sheet_data.rows.each { |row|
-          row.cells.each { |cell|
-            if cell && cell.value && cell.datatype == RubyXL::DataType::SHARED_STRING then
-              get_index(cell.value.to_s, :add_if_missing)
-            end
-          }
-        }
-      }
-    end
-=end
-
   end
+
 end

data/lib/rubyXL/objects/document_properties.rb

@@ -140,20 +140,20 @@ module RubyXL
 
     def created_at
       val = dcterms_created && dcterms_created.value
-      val && (val.strip.empty? ? nil : Time.parse(val))
+      val && (val.strip.empty? ? nil : DateTime.parse(val).to_time)
     end
 
     def created_at=(v)
-      self.dcterms_created = RubyXL::StringNodeW3C.new(:value => v.iso8601)
+      self.dcterms_created = RubyXL::StringNodeW3C.new(:value => v.to_datetime.iso8601)
     end
 
     def modified_at
       val = dcterms_modified && dcterms_modified.value
-      val && (val.strip.empty? ? nil : Time.parse(val))
+      val && (val.strip.empty? ? nil : DateTime.parse(val).to_time)
     end
 
     def modified_at=(v)
-      self.dcterms_modified = RubyXL::StringNodeW3C.new(:value => v.iso8601)
+      self.dcterms_modified = RubyXL::StringNodeW3C.new(:value => v.to_datetime.iso8601)
     end
 
   end

data/lib/rubyXL/objects/workbook.rb

@@ -1,3 +1,5 @@
+#require 'tmpdir'
+require 'date'
 require 'rubyXL/objects/ooxml_object'
 require 'rubyXL/objects/shared_strings'
 require 'rubyXL/objects/stylesheet'
@@ -8,7 +10,7 @@ require 'rubyXL/objects/chartsheet'
 require 'rubyXL/objects/relationships'
 require 'rubyXL/objects/simple_types'
 require 'rubyXL/objects/extensions'
-require 'rubyXL/workbook'
+require 'rubyXL/convenience_methods'
 
 module RubyXL
 
@@ -357,80 +359,83 @@ module RubyXL
       true
     end
 
-    def date1904
-      workbook_properties && workbook_properties.date1904
-    end
-
-    def date1904=(v)
-      self.workbook_properties ||= RubyXL::WorkbookProperties.new
-      workbook_properties.date1904 = v
-    end
-
-    def company
-      self.document_properties.company && self.document_properties.company.value
-    end
-
-    def company=(v)
-      root.document_properties.company ||= StringNode.new
-      root.document_properties.company.value = v
-    end
-
-    def application
-      root.document_properties.application && self.document_properties.application.value
-    end
-
-    def application=(v)
-      root.document_properties.application ||= StringNode.new
-      root.document_properties.application.value = v
-    end
-
-    def appversion
-      root.document_properties.app_version && root.document_properties.app_version.value
+    def xlsx_path
+      ROOT.join('xl', 'workbook.xml')
     end
 
-    def appversion=(v)
-      root.document_properties.app_version ||= StringNode.new
-      root.document_properties.app_version.value = v
+    # Return the resulting XLSX file in a stream (useful for sending over HTTP)
+    def stream
+      root.stream
     end
 
-    def creator
-      root.core_properties.creator
-    end
+    # Save the resulting XLSX file to the specified location
+    def save(filepath = nil)
+      filepath ||= root.filepath
 
-    def creator=(v)
-      root.core_properties.creator = v
-    end
+      extension = File.extname(filepath)
+      unless %w{.xlsx .xlsm}.include?(extension.downcase)
+        raise "Unsupported extension: #{extension} (only .xlsx and .xlsm files are supported)."
+      end
 
-    def modifier
-      root.core_properties.modifier
-    end
+      File.open(filepath, "wb") { |output_file| FileUtils.copy_stream(root.stream, output_file) }
 
-    def modifier=(v)
-      root.core_properties.modifier = v
+      return filepath
     end
+    alias_method :write, :save
 
-    def created_at
-      root.core_properties.created_at
-    end
+    DATE1904 = DateTime.new(1904, 1, 1)
+    # Subtracting one day to accomodate for erroneous 1900 leap year compatibility only for 1900 based dates
+    DATE1899 = DateTime.new(1899, 12, 31) - 1
 
-    def created_at=(v)
-      root.core_properties.created_at = v
+    def base_date
+      (workbook_properties && workbook_properties.date1904) ? DATE1904 : DATE1899
     end
+    private :base_date
 
-    def modified_at
-      root.core_properties.modified_at
+    def date_to_num(date)
+      date && (date.ajd - base_date().ajd).to_f
     end
 
-    def modified_at=(v)
-      root.core_properties.modified_at = v
+    def num_to_date(num)
+      num && (base_date + num)
     end
 
-    def xlsx_path
-      ROOT.join('xl', 'workbook.xml')
+    include Enumerable
+
+    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)
+      super()
+
+      # Order of sheets in the +worksheets+ array corresponds to the order of pages in Excel UI.
+      # SheetId's, rId's, etc. are completely unrelated to ordering.
+      @worksheets = worksheets
+      add_worksheet if @worksheets.empty?
+
+      @theme                    = RubyXL::Theme.defaults
+      @shared_strings_container = RubyXL::SharedStringsTable.new
+      @stylesheet               = RubyXL::Stylesheet.default
+      @relationship_container   = RubyXL::OOXMLRelationshipsFile.new
+      @root                     = RubyXL::WorkbookRoot.default
+      @root.workbook            = self
+      @root.filepath            = filepath
+
+      creation_time = DateTime.parse(created_at) rescue DateTime.now
+      self.created_at  = creation_time
+      self.modified_at = creation_time
+      self.company     = company
+      self.application = application
+      self.appversion  = appversion
+      self.creator     = creator
+      self.modifier    = modifier
+      self.date1904    = date1904 > 0
     end
 
-    include LegacyWorkbook
-
+    include WorkbookConvenienceMethods
   end
 
 end

data/rdoc/README_rdoc.html

@@ -4,7 +4,7 @@
 <head>
 <meta charset="UTF-8">
 
-<title>README - rubyXL 3.2.3</title>
+<title>README - rubyXL 3.2.4</title>
 
 <link href="./fonts.css" rel="stylesheet">
 <link href="./rdoc.css" rel="stylesheet">
@@ -125,6 +125,15 @@ href="https://codeclimate.com/github/weshatheleopard/rubyXL"><img
 src="https://codeclimate.com/github/weshatheleopard/rubyXL.png" alt="Code
 Climate" /></a></p>
 
+<p>This gem supports operating on <code>xlsx</code> files (Open XML format).
+While it is capable of properly parsing the entire OOXML structure, its
+current main emphasis is on reading files produced by MS Excel, making
+minor modifications to them and saving them to be opened again, while
+preserving as much of the structure as possible.</p>
+
+<p>Please note that proprietary binary <code>xls</code> format is
+<strong>not</strong> supported.</p>
+
 <h2 id="label-To+Install%3A">To Install:<span><a href="#label-To+Install%3A">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
 
 <pre>gem install rubyXL</pre>
@@ -206,7 +215,7 @@ worksheet.get_column_font_name(0)
 worksheet.get_column_font_size(0)
 worksheet.get_column_font_color(0)
 worksheet.is_column_underlined(0)
-worksheet.get_column_height(0)
+worksheet.get_column_width(0)
 worksheet.get_column_horizontal_alignment(0)
 worksheet.get_column_vertical_alignment(0)
 worksheet.get_column_border_right(0)</pre>
@@ -409,7 +418,7 @@ further details.</p>
 
 <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>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.2.
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>