rods 0.6.2 → 0.7.0

data/README

@@ -14,17 +14,23 @@
  Licensed under the same terms as Ruby. No warranty is provided.
 
  = Changelog
+ * 0.7.0 
+   * added new function
+     * getCellsAndIndicesFor(expression)
+     This function returns all cells and their indices for which 
+     the external representation matches the given expression.
+   cf. Example 0.7.0 below
  * 0.6.2
    * added style-attributes
      * text-underline-style
      * text-underline-width
      * text-underline-color
-   cf. Example 0.6.2
+   cf. Example 0.6.2 below
  * 0.6.1
    * added new functions
      * insertTableBefore()
      * insertTableAfter()
-   cf. Example 0.6.1
+   cf. Example 0.6.1 below
  * 0.6.0
    * changed interface from
      * getNextRow, getPreviousRow, getNextCell, getPreviousCell to
@@ -316,13 +322,60 @@
                                 "style:text-underline-width" => "auto"})
    cell=mySheet.writeGetCell(4,4,"string","Underline_Default_with_Black")
    #----------------------------------------------------------------------
-   # if not specified otherwise, widt and color are set to default
+   # if not specified otherwise, width and color are set to default
    # - black
    # - solid
    #----------------------------------------------------------------------
    mySheet.setAttributes(cell,{ "style:text-underline-style" => "solid" })
    mySheet.saveAs("Test3.ods")
    puts("done")
+
+ = Example 0.7.0
+
+   #!/usr/bin/ruby
+   # coding: UTF-8
+   #
+   # Author: Dr. Heinz Breinlinger
+   #
+   require 'rubygems'
+   require 'rods'
+
+   mySheet=Rods.new("Konten.ods")
+   # Finds all cells with content 'content' and returns them along with the
+   # indices of row and column as an array of hashes.
+   # [{ :cell => cell,
+   #    :row  => rowIndex,
+   #    :col  => colIndex},
+   #  { :cell => cell,
+   #    :row  => rowIndex,
+   #    :col  => colIndex}]
+   #  
+   # Regular expressions for 'content' are alllowd but must be enclosed in 
+   # single (not double) quotes !
+   #
+   # In case of no matches at all, an empty array is returned.
+   # 
+   # Keep in mind that the content of a cell with a formula is not the formula, but the
+   # current value of the computed result.
+   #
+   # Also consider that you have to search for the external (i.e. visible)
+   # represenation of a cell's content, not it's internal computational value.
+   # For instance, when looking for a currency value of 1525 (that is shown as
+   # '1.525 $'), you'll have to code
+   #
+   #   result=mySheet.getCellsAndIndicesFor('1[.,]525')
+   #
+   # The following finds all occurences of a comma- or dot-separated number,
+   # consisting of 1 digit before and 2 digits behind the decimal-separator.
+   #-------------------------------------------------------------------------
+   result=mySheet.getCellsAndIndicesFor('\d{1}[.,]\\d{2}')
+   result.each{ |cellHash|
+     puts("----------------------------------------------")
+     puts("Node: #{cellHash[:cell]}") # Be aware: Prints out whole node ! ;-)
+     puts("Row: #{cellHash[:row]}")
+     puts("Column: #{cellHash[:col]}")
+   }
+   puts("done")
  
  = Caveat
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('rods', '0.6.2') do |p|
+Echoe.new('rods', '0.7.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 (and drop me a line, if you like it ;-)"
   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/"

data/lib/rods.rb

@@ -2580,7 +2580,136 @@ class Rods
     return row.next_sibling
   end
   ##########################################################################
-  # Oeffnet zip-Datei und erzeugt diese, wenn nicht existent
+  # Finds all cells with content 'content' and returns them along with the
+  # indices of row and column as an array of hashes.
+  # [{ :cell => cell,
+  #    :row  => rowIndex,
+  #    :col  => colIndex},
+  #  { :cell => cell,
+  #    :row  => rowIndex,
+  #    :col  => colIndex}]
+  #  
+  # Regular expressions for 'content' are alllowd but must be enclosed in 
+  # single (not double) quotes !
+  #
+  # In case of no matches at all, an empty array is returned.
+  # 
+  # The following finds all occurences of a comma- or dot-separated number,
+  # consisting of 1 digit before and 2 digits behind the decimal-separator.
+  #
+  # myArray=mySheet.getCellsAndIndicesFor('\d{1}[.,]\d{2}')
+  #
+  # Keep in mind that the content of a call with a formula is not the formula, but the
+  # current value of the computed result.
+  #
+  # Also consider that you have to search for the external (i.e. visible)
+  # represenation of a cell's content, not it's internal computational value.
+  # For instance, when looking for a currency value of 1525 (that is shown as
+  # '1.525 €', you'll have to code
+  #
+  # result=mySheet.getCellsAndIndicesFor('1[.,]525')
+  # result.each{ |cellHash|
+  #   puts("Found #{cellHash[:cell] on #{cellHash[:row] - #{cellHash[:col]")
+  # }
+  #-------------------------------------------------------------------------
+  def getCellsAndIndicesFor(content)
+    die("getCellsAndIndicesFor: 'content' is not of typ String") unless (content.class.to_s == "String")
+    result=Array.new()
+    i=0
+    tell("getCellsAndIndicesFor: Searching for cells with content '#{content}'")
+    #----------------------------------------------------------------
+    # Alle Text-Nodes suchen
+    #----------------------------------------------------------------
+    @spreadSheet.elements.each("//table:table-cell/text:p"){ |textNode|
+      text=textNode.text
+      #---------------------------------------------------------
+      # Zelle gefunden ?
+      #
+      # 'content' darf regulaerer Ausdruck sein, muss dann jedoch
+      # in einfachen Hochkommata uebergeben werden
+      #---------------------------------------------------------
+      if(text && (text.match(/#{content}/)))
+        result[i]=Hash.new() 
+        tell("getCellsAndIndicesFor: '#{content}' matched '#{text}'")
+        #-----------------------------------------------------
+        # Zelle und Zellenindex ermitteln
+        #-----------------------------------------------------
+        cell=textNode.elements["ancestor::table:table-cell"]
+        unless (cell)
+          die("getCellsAndIndicesFor: internal error: Could not extract parent-cell of textNode with #{content}") 
+        end
+        colIndex=getIndexOfElement(cell)
+        #-----------------------------------------------------
+        # Zeile und Zeilenindex ermitteln
+        #-----------------------------------------------------
+        row=textNode.elements["ancestor::table:table-row"]
+        unless (row)
+          die("getCellsAndIndicesFor: internal error: Could not extract parent-row of textNode with #{content}") 
+        end
+        rowIndex=getIndexOfElement(row)
+        result[i][:cell]=cell
+        result[i][:row]=rowIndex
+        result[i][:col]=colIndex
+        tell("getCellsAndIndicesFor: Indices #{rowIndex} #{colIndex}")
+        i+=1
+      end
+    }
+    return result
+  end
+  ##########################################################################
+  # internal: Calculates index (in the sense of spreadsheet, NOT XML) of
+  # given element (row or cell as REXML::Element) within the corresponding parent-element
+  # (table or row)
+  #
+  # index=mySheet.getIndexOfElement(row) # -> Line-number within table
+  #-------------------------------------------------------------------------
+  def getIndexOfElement(node)
+    die("getIndexOfElements: passed node '#{node}' is not a REXML::Element") unless (node.class.to_s == "REXML::Element")
+    index=0
+    #--------------------------------------------------------------
+    # Typabhaengige Vorbelegungen
+    #--------------------------------------------------------------
+    if(node.elements["self::table:table-cell"])
+      kindOfSelf="table:table-cell"
+      kindOfParent="table:table-row"
+      kindOfRepetition="table:number-columns-repeated"
+    elsif(node.elements["self::table:table-row"])
+      kindOfSelf="table:table-row"
+      kindOfParent="table:table"
+      kindOfRepetition="table:number-rows-repeated"
+    else
+      die("getIndexOfElement: internal error: passed element '#{node}' is neither cell nor row")
+    end
+    #--------------------------------------------------------------
+    # Zugehoeriges Vater-Element ermitteln 
+    #--------------------------------------------------------------
+    parent=node.elements["ancestor::"+kindOfParent]
+    unless (parent)
+      die("getIndexOfElement: internal error: Could not extract parent of #{node}") 
+    end
+    #--------------------------------------------------------------
+    # Index des Kind-Elements innerhalb Vater-Element ermitteln
+    #--------------------------------------------------------------
+    parent.elements.each(kindOfSelf){ |child|
+      index+=1
+      #-----------------------------------------------
+      # Bei Treffer -> Ruecksprung mit aktuellem Index
+      #-----------------------------------------------
+      if(child == node)
+        return index
+      #-----------------------------------------------
+      # Wiederholungen zaehlen
+      # Cave: Aktuelles Element selbst zaehlt ebenfalls als Wiederholung
+      # => um 1 dekrementieren
+      #-----------------------------------------------
+      elsif(repetition=child.attributes[kindOfRepetition])
+        index+=repetition.to_i-1
+      end
+    }
+    die("getIndexOfElement: internal error: Could not calculate index of element #{node}")
+  end
+  ##########################################################################
+  # internal: Opens zip-file
   #-------------------------------------------------------------------------
   def open(file)
     die("open: file #{file} does not have valid ending '*.ods'") unless (file.match(/\.ods$/))
@@ -2600,11 +2729,11 @@ class Rods
          :insertTable, :deleteTable, :readCellFromRow, :readCell, :setAttributes, :writeStyleAbbr, 
          :setStyle, :printOfficeStyles, :printAutoStyles, :getNextExistentRow, :getPreviousExistentRow, 
 	 :getNextExistentCell, :getPreviousExistentCell, :insertTableAfter, :insertTableBefore,
-         :writeComment, :save, :saveAs, :initialize, :writeText
+         :writeComment, :save, :saveAs, :initialize, :writeText, :getCellsAndIndicesFor
 
   private :tell, :die, :createCell, :createRow, :getChildByIndex, :createElement, :setRepetition, :initHousekeeping, 
           :getTableWidth, :padTable, :padRow, :time2TimeVal, :percent2PercentVal, :date2DateVal, 
-          :finalize, :init, :normalizeText, :getColor, :normStyleHash, :getStyle, 
+          :finalize, :init, :normalizeText, :getColor, :normStyleHash, :getStyle, :getIndexOfElement,
           :getAppropriateStyle, :checkStyleAttributes, :insertStyleAttributes, :cloneNode, 
           :writeStyle, :writeStyleXml, :style2Hash, :writeDefaultStyles, :writeXml, 
           :internalizeFormula, :getColorPalette, :open, :printStyles, :insertTableBeforeAfter

data/rods.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rods}
-  s.version = "0.6.2"
+  s.version = "0.7.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-10}
+  s.date = %q{2011-01-11}
   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 (and drop me a line, if you like it ;-)}
   s.email = %q{rods.ruby@online.de}
   s.extra_rdoc_files = ["README", "lib/example.rb", "lib/rods.rb"]

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 2
-  version: 0.6.2
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Dr. Heinz Breinlinger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-10 00:00:00 +01:00
+date: 2011-01-11 00:00:00 +01:00
 default_executable: 
 dependencies: []