rods 0.1.1 → 0.5.0

data/README

@@ -14,6 +14,9 @@
  Licensed under the same terms as Ruby. No warranty is provided.
 
  = Changelog
+ * 0.5.0
+   * new performance-boosters for reading lots of rows (cf. chapter and second example-script below)
+     * getNextRow, getPreviousRow, getNextCell, getPreviousCell
  * 0.1.1 
    * Bug-Fix: readCellFromRow() did not return value in some cases
  * 0.1.0 
@@ -42,6 +45,8 @@
    * Ruby 1.9.1 and 1.8.7
  
  = Howto
+ Please consider the hints in the next chapter to boost performance when walking
+ your way through many rows. But first the basics:
 
    $ sudo gem install rods (root-privileges necessary)
  
@@ -266,11 +271,58 @@
      puts("Read #{text1} of #{type1} and #{text2} of #{type2}
    }
 
+ in spite of the fact that
+   getRow 
+ even creates a row if it does not yet exist (returns the specified row in any case !), while
+   readCell
+ merely looks up exisiting rows and cells (returns nil,nil otherwise).
+
  This difference hardly matters while dealing with small documents, but degrades performance significantly when you 
  move up or down a sheet with a lot of rows and process several cells on the same row !
 
- On the ATOM-Nettop I developed the gem the script above took 2-3 seconds and on my Core-i7-Notebook it was finished so quickly
- that I supposed it had halted on an immediate error, so: don't be concerned, just be smart and try :-)
+ Provided you just want to read exisiting cells and not write to at the user leven seemingly empty ones, but de facto
+ non-existent cells according to Open Document format, an absolute speed-booster compared to the above is the following
+
+   # coding: UTF-8
+   #
+   # Author: Dr. Heinz Breinlinger
+   #
+   require 'rubygems'
+   require 'rods'
+
+   mySheet=Rods.new("Konten.ods")
+   sum=0.0
+   i=0
+   row=mySheet.getRow(1)
+   #---------------------------------------------------------------------------------
+   # The routines
+   # - getNextRow(row)
+   # - getPreviousRow(row)
+   # - getNextCell(cell)
+   # - getPreviousCell(cell)
+   # allow the XML-Parser to just continue from the "adjacent" node) and 
+   # return the previsous/next element without having to start from the top-node 
+   # of the document over and over again !
+   #---------------------------------------------------------------------------------
+   while(row=mySheet.getNextRow(row))  
+     i+=1
+     puts("#{i}")
+     confirmed,type=mySheet.readCellFromRow(row,1)
+     next if (! confirmed || confirmed.empty?())
+     account,type=mySheet.readCellFromRow(row,9)
+     next if (! account || account.empty?())
+     transfer,type=mySheet.readCellFromRow(row,7)
+     next if (! transfer || transfer.empty?())
+     if(confirmed.match(/x/i) && account.match(/Hauskonto/))
+       puts("#{i}: --> #{transfer} €")
+       sum+=transfer.to_f
+     end
+   end
+   puts("------------")
+   puts("Sum: #{sum}")
+
+ On the ATOM-Nettop I developed the gem, even the script above took just 2-3 seconds and on my Core-i7-Notebook it was finished so quickly
+ that I supposed it had halted on an immediate error, so: don't be concerned and just experiment :-).
  
  = Standards
  * Open Document Format for Office Applications (Open Document) v1.1 based on OpenOffice.org (OOo)

data/Rakefile

@@ -2,8 +2,8 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('rods', '0.1.1') do |p|
-  p.description    = "OpenOffice.org oocalc: Automated batch-processing of spreadsheets (*.ods) conforming to Open Document Format v1.1. used by e.g. OpenOffice.org and LibreOffice. Please see screenshot and Rdoc-Documentation at http://ruby.homelinux.com/ruby/rods/. You can contact me at rodsdotrubyatonlinedotde."
+Echoe.new('rods', '0.5.0') do |p|
+  p.description    = "OpenOffice.org oocalc: Fast automated batch-processing of spreadsheets (*.ods) conforming to Open Document Format v1.1. used by e.g. OpenOffice.org and LibreOffice. Please see screenshot and Rdoc-Documentation at http://ruby.homelinux.com/ruby/rods/. You can contact me at rodsdotrubyatonlinedotde."
   p.summary        = "Automation of OpenOffice/LibreOffice by batch-processing of spreadsheets conforming to Open Document v1.1"
   p.url            = "http://ruby.homelinux.com/ruby/rods/"
   p.author         = "Dr. Heinz Breinlinger"

data/lib/rods.rb

@@ -2457,6 +2457,38 @@ class Rods
     puts("  color")
   end
   ##########################################################################
+  # Fast Routine to get the previous row, because XML-Parser does not have
+  # to start from top-node of document to find row ! 
+  # Returns previous row as a REXML::Element or nil if no element exists.
+  #------------------------------------------------------------------------
+  def getPreviousRow(row)
+    return row.previous_sibling
+  end
+  ##########################################################################
+  # Fast Routine to get the next cell, because XML-Parser does not have
+  # to start from top-node of row to find cell ! 
+  # Returns next cell as a REXML::Element or nil if no element exists
+  #------------------------------------------------------------------------
+  def getNextCell(cell)
+    return cell.next_sibling
+  end
+  ##########################################################################
+  # Fast Routine to get the previous cell, because XML-Parser does not have
+  # to start from top-node of row to find cell ! 
+  # Returns previous cell as a REXML::Element or nil if no element exists
+  #------------------------------------------------------------------------
+  def getPreviousCell(cell)
+    return cell.previous_sibling
+  end
+  ##########################################################################
+  # Fast Routine to get the next row, because XML-Parser does not have
+  # to start from top-node of document to find row ! 
+  # Returns next row as a REXML::Element or nil if no element exists
+  #------------------------------------------------------------------------
+  def getNextRow(row)
+    return row.next_sibling
+  end
+  ##########################################################################
   # Oeffnet zip-Datei und erzeugt diese, wenn nicht existent
   #-------------------------------------------------------------------------
   def open(file)
@@ -2475,7 +2507,8 @@ class Rods
   public :setDateFormat, :writeGetCell, :writeCell, :writeGetCellFromRow, :writeCellFromRow, 
          :getCellFromRow, :getCell, :getRow, :renameTable, :setCurrentTable, 
          :insertTable, :deleteTable, :readCellFromRow, :readCell, :setAttributes, :writeStyleAbbr, 
-         :setStyle, :printOfficeStyles, :printAutoStyles,
+         :setStyle, :printOfficeStyles, :printAutoStyles, :getNextRow, :getPreviousRow, 
+	 :getNextCell, :getPreviousCell,
          :writeComment, :save, :saveAs, :initialize, :writeText
 
   private :tell, :die, :createCell, :createRow, :getChildByIndex, :createElement, :setRepetition, :initHousekeeping, 

data/rods.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rods}
-  s.version = "0.1.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dr. Heinz Breinlinger"]
   s.date = %q{2011-01-07}
-  s.description = %q{OpenOffice.org oocalc: Automated batch-processing of spreadsheets (*.ods) conforming to Open Document Format v1.1. used by e.g. OpenOffice.org and LibreOffice. Please see screenshot and Rdoc-Documentation at http://ruby.homelinux.com/ruby/rods/. You can contact me at rodsdotrubyatonlinedotde.}
+  s.description = %q{OpenOffice.org oocalc: Fast automated batch-processing of spreadsheets (*.ods) conforming to Open Document Format v1.1. used by e.g. OpenOffice.org and LibreOffice. Please see screenshot and Rdoc-Documentation at http://ruby.homelinux.com/ruby/rods/. You can contact me at rodsdotrubyatonlinedotde.}
   s.email = %q{rods.ruby@online.de}
   s.extra_rdoc_files = ["README", "lib/example.rb", "lib/rods.rb"]
   s.files = ["Manifest", "README", "Rakefile", "lib/example.rb", "lib/rods.rb", "rods.gemspec"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rods
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Dr. Heinz Breinlinger
@@ -19,7 +19,7 @@ date: 2011-01-07 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: "OpenOffice.org oocalc: Automated batch-processing of spreadsheets (*.ods) conforming to Open Document Format v1.1. used by e.g. OpenOffice.org and LibreOffice. Please see screenshot and Rdoc-Documentation at http://ruby.homelinux.com/ruby/rods/. You can contact me at rodsdotrubyatonlinedotde."
+description: "OpenOffice.org oocalc: Fast automated batch-processing of spreadsheets (*.ods) conforming to Open Document Format v1.1. used by e.g. OpenOffice.org and LibreOffice. Please see screenshot and Rdoc-Documentation at http://ruby.homelinux.com/ruby/rods/. You can contact me at rodsdotrubyatonlinedotde."
 email: rods.ruby@online.de
 executables: []