hmcgowan-roo 1.3.1 → 1.3.2

data/README.markdown

@@ -1,9 +1,6 @@
 # README for Roo
 
-This is the semi-official roo repository. I've been unable to contact the maintainer so this
-repository should allow us to continue in the interim. If you'd like to contribute I'm happy 
-to pull your changes in and will be making periodic releases from here until we can get
-the gems on RubyForge. 
+This is now the official roo repository and I'll be making a release on RubyForge in the next few weeks.  
 
 
 ## Installation

data/lib/roo/google.rb

@@ -1,4 +1,6 @@
 require 'gdata/spreadsheet'
+gem 'libxml-ruby', '>= 0.8.3'
+require 'xml'
 
 # overwrite some methods from the gdata-gem:
 module GData
@@ -45,7 +47,7 @@ XML
     def add_to_cell_roo(row,col,value, sheet_no=1)
       save_entry_roo(entry_roo(value,row,col), sheet_no)
     end
-
+   
     #-- new
     def get_one_sheet
       path = "/feeds/cells/#{@spreadsheet_id}/1/private/full"
@@ -70,11 +72,19 @@ XML
       doc = Hpricot(request(path))
       return doc
     end
+
+    def celldoc(sheet_no, cell_name)
+      path = "/feeds/cells/#{@spreadsheet_id}/#{sheet_no}/private/full" + cell_name
+      doc = Hpricot(request(path))
+      return doc
+    end
+
   end # class
 end # module
 
 class Google < GenericSpreadsheet
-
+  attr_accessor :date_format, :datetime_format
+  
   # Creates a new Google spreadsheet object.
   def initialize(spreadsheetkey,user=nil,password=nil)
     @filename = spreadsheetkey
@@ -89,6 +99,7 @@ class Google < GenericSpreadsheet
     end
     @default_sheet = nil
     @cell = Hash.new
+    @cell_name = Hash.new
     @cell_type = Hash.new
     @formula = Hash.new
     @first_row = Hash.new
@@ -97,10 +108,11 @@ class Google < GenericSpreadsheet
     @last_column = Hash.new
     @cells_read = Hash.new
     @header_line = 1
-
+    @date_format = '%d/%m/%Y'
+    @datetime_format = '%d/%m/%Y %H:%M:%S' 
+    @time_format = '%H:%M:%S'
     @gs = GData::Spreadsheet.new(spreadsheetkey)
     @gs.authenticate(user, password)
-
     #-- ----------------------------------------------------------------------
     #-- TODO: Behandlung von Berechtigungen hier noch einbauen ???
     #-- ----------------------------------------------------------------------
@@ -115,29 +127,41 @@ class Google < GenericSpreadsheet
     return @gs.sheetlist
   end
 
-  # is String a date with format DD/MM/YYYY
-  def Google.date?(string)
+  def date?(string)
     return false if string.class == Float
     return true if string.class == Date
-    return string.strip =~ /^([0-9]+)\/([0-9]+)\/([0-9]+)$/
+    begin
+      Date.strptime(string, @date_format)
+      true
+    rescue
+      false
+    end
   end
 
   # is String a time with format HH:MM:SS?
-  def Google.time?(string)
+  def time?(string)
     return false if string.class == Float
     return true if string.class == Date
-    return string.strip =~ /^([0-9]+):([0-9]+):([0-9]+)$/
+    begin
+      DateTime.strptime(string, @time_format)
+      true
+    rescue
+      false
+    end
   end
 
-  # is String a date+time with format DD/MM/YYYY HH:MM:SS
-  def Google.datetime?(string)
+  def datetime?(string)
     return false if string.class == Float
     return true if string.class == Date
-    return string.strip =~ /^([0-9]+)\/([0-9]+)\/([0-9]+)\ ([0-9]+):([0-9]+):([0-9]+)$/
+    begin
+      DateTime.strptime(string, @datetime_format)
+      true
+    rescue
+      false
+    end
   end
 
-
-  def Google.timestring_to_seconds(value)
+  def timestring_to_seconds(value)
     hms = value.split(':')
     hms[0].to_i*3600 + hms[1].to_i*60 + hms[2].to_i
   end
@@ -151,24 +175,21 @@ class Google < GenericSpreadsheet
     check_default_sheet #TODO: 2007-12-16
     read_cells(sheet) unless @cells_read[sheet]
     row,col = normalize(row,col)
+    value = @cell[sheet]["#{row},#{col}"]
     if celltype(row,col,sheet) == :date
-      yyyy,mm,dd = @cell[sheet]["#{row},#{col}"].split('-')
       begin
-        return Date.new(yyyy.to_i,mm.to_i,dd.to_i)
+        return  Date.strptime(value, @date_format)
       rescue ArgumentError
-        raise "Invalid date parameter: #{yyyy}, #{mm}, #{dd}"
+        raise "Invalid Date #{sheet}[#{row},#{col}] #{value} using format '{@date_format}'"
       end
     elsif celltype(row,col,sheet) == :datetime
       begin
-        date_part,time_part = @cell[sheet]["#{row},#{col}"].split(' ')
-        yyyy,mm,dd = date_part.split('-')
-        hh,mi,ss = time_part.split(':')
-        return DateTime.civil(yyyy.to_i,mm.to_i,dd.to_i,hh.to_i,mi.to_i,ss.to_i)
+        return  DateTime.strptime(value, @datetime_format)
       rescue ArgumentError
-        raise "Invalid date parameter: #{yyyy}, #{mm}, #{dd}, #{hh}, #{mi}, #{ss}"
+        raise "Invalid DateTime #{sheet}[#{row},#{col}] #{value} using format '{@datetime_format}'"
       end
     end 
-    return @cell[sheet]["#{row},#{col}"]
+    return value
   end
 
   # returns the type of a cell:
@@ -291,8 +312,13 @@ class Google < GenericSpreadsheet
     end
     row,col = normalize(row,col)
     @gs.add_to_cell_roo(row,col,value,sheet_no)
+    # re-read the portion of the document that has changed
+    if @cells_read[sheet] 
+      cell_name = @cell_name[sheet]["#{row},#{col}"] 
+      read_cells(sheet, cell_name) 
+    end
   end
-
+  
   # returns the first non-empty row in a sheet
   def first_row(sheet=nil)
     sheet = @default_sheet unless sheet
@@ -335,61 +361,67 @@ class Google < GenericSpreadsheet
 
   private
 
-  # read all cells in a sheet
-  def read_cells(sheet=nil)
+  # read all cells in a sheet. if the cell_name is 
+  # specified, only return the XML pertaining to that cell
+  def read_cells(sheet=nil, cell_name=nil)
     sheet = @default_sheet unless sheet
     raise RangeError, "illegal sheet <#{sheet}>" unless sheets.index(sheet)
     sheet_no = sheets.index(sheet)+1
-    doc = @gs.fulldoc(sheet_no)
-    (doc/"gs:cell").each {|item|
-      row = item['row']
-      col = item['col']
-      value = item['inputvalue']
-      numericvalue = item['numericvalue']
-      if value[0,1] == '='
-        formula = value
-      else
-        formula = nil
-      end
-      @cell_type[sheet] = {} unless @cell_type[sheet]
-      if formula
-        ty = :formula
-        if numeric?(numericvalue)
-          value = numericvalue.to_f
-        else
-          value = numericvalue
+    @cell_name[sheet] ||= {}
+    xml = cell_name ? @gs.celldoc(sheet_no, cell_name).to_s : @gs.fulldoc(sheet_no).to_s
+    doc = XML::Parser.string(xml).parse
+    doc.find("//*[local-name()='entry']").each do |entry|
+      key = nil; 
+      cell_name = nil;      
+      entry.each do |element|
+        next unless element.name == 'category'
+        cell_name = nil
+        element.each do |item|
+          case item.name
+          when 'link'
+            cell_name = item['href'][/\/R\d+C\d+/] if item['rel'] == 'self'
+          when 'cell'
+            row = item['row']
+            col = item['col']
+            value =  item['inputvalue'] ||  item['inputValue'] 
+            numericvalue = item['numericvalue']  ||  item['numericValue'] 
+            if value[0,1] == '='
+              formula = value
+            else
+              formula = nil
+            end
+            @cell_type[sheet] ||= {} 
+            if formula
+              ty = :formula
+              if numeric?(numericvalue)
+                value = numericvalue.to_f
+              else
+                value = numericvalue
+              end
+            elsif datetime?(value)
+              ty = :datetime
+            elsif date?(value)
+              ty = :date
+            elsif numeric?(value) # or o.class ???
+              ty = :float
+              value = value.to_f
+            elsif time?(value)
+              ty = :time
+              value = timestring_to_seconds(value)
+            else
+              ty = :string
+            end
+            key = "#{row},#{col}"
+            @cell[sheet] ||= {} 
+            @cell[sheet][key] = value unless value == "" or value == nil
+            @cell_type[sheet][key] = ty # Openoffice.oo_type_2_roo_type(vt)
+          end
+          @formula[sheet] = {} unless @formula[sheet]
+          @formula[sheet][key] = formula  if formula
         end
-      elsif Google.date?(value)
-        ty = :date
-      elsif Google.datetime?(value)
-        ty = :datetime
-      elsif numeric?(value) # or o.class ???
-        ty = :float
-        value = value.to_f
-      elsif Google.time?(value)
-        ty = :time
-        value = Google.timestring_to_seconds(value)
-      else
-        ty = :string
-      end
-      key = "#{row},#{col}"
-      @cell[sheet] = {} unless @cell[sheet]
-      if ty == :date
-        dd,mm,yyyy = value.split('/')
-        @cell[sheet][key] = sprintf("%04d-%02d-%02d",yyyy.to_i,mm.to_i,dd.to_i)
-      elsif ty == :datetime
-        date_part,time_part = value.split(' ')
-        dd,mm,yyyy = date_part.split('/')
-        hh,mi,ss = time_part.split(':')
-        @cell[sheet][key] = sprintf("%04d-%02d-%02d %02d:%02d:%02d",
-          yyyy.to_i,mm.to_i,dd.to_i,hh.to_i,mi.to_i,ss.to_i)
-      else
-        @cell[sheet][key] = value unless value == "" or value == nil
       end
-      @cell_type[sheet][key] = ty # Openoffice.oo_type_2_roo_type(vt)
-      @formula[sheet] = {} unless @formula[sheet]
-      @formula[sheet][key] = formula  if formula
-    }
+      @cell_name[sheet][key] = cell_name if cell_name && key
+    end  
     @cells_read[sheet] = true
   end
 
@@ -397,15 +429,6 @@ class Google < GenericSpreadsheet
     string =~ /^[0-9]+[\.]*[0-9]*$/
   end
 
-  # convert string DD/MM/YYYY into a Date-object
-  #TODO: was ist mit verschiedenen Typen der Datumseingabe bei Google?
-  def Google.to_date(string)
-    if string.strip =~ /^([0-9]+)\/([0-9]+)\/([0-9]+)$/
-      return Date.new($3.to_i,$2.to_i,$1.to_i)
-    else
-      return nil
-    end
-  end
 
 
 end # class

data/lib/roo/roo_rails_helper.rb

@@ -1,4 +1,5 @@
 def spreadsheet(spreadsheet, sheets, options={})
+  @rspreadsheet = spreadsheet
   coordinates = true # default
   o=""
   if options[:coordinates] != nil

data/lib/roo/version.rb

@@ -2,7 +2,7 @@ module Roo #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 3
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/test_roo.rb

@@ -44,17 +44,27 @@ end
 class Test::Unit::TestCase
   def key_of(spreadsheetname)
     begin
+      
       return {
-        'numbers1' => "o10837434939102457526.4784396906364855777",
-        'borders' => "o10837434939102457526.664868920231926255",
-        'simple_spreadsheet' => "ptu6bbahNZpYe-L1vEBmgGA",
+        'formula' => 'rt4Pw1WmjxFtyfrqqy94wPw',
+        "write.me" => 'r6m7HFlUOwst0RTUTuhQ0Ow',
+        'numbers1' => "rYraCzjxTtkxw1NxHJgDU8Q",
+        'borders' => "r_nLYMft6uWg_PT9Rc2urXw",
+        'simple_spreadsheet' => "r3aMMCBCA153TmU_wyIaxfw",
         'testnichtvorhandenBibelbund.ods' => "invalidkeyforanyspreadsheet", # !!! intentionally false key
-        "only_one_sheet" => "o10837434939102457526.762705759906130135",
-        "write.me" => 'ptu6bbahNZpY0N0RrxQbWdw&hl',
-        'formula' => 'o10837434939102457526.3022866619437760118',
-        'time-test' => 'ptu6bbahNZpYBMhk01UfXSg',
-        'datetime' => "ptu6bbahNZpYQEtZwzL_dZQ",
+        "only_one_sheet" => "rqRtkcPJ97nhQ0m9ksDw2rA",
+        'time-test' => 'r2XfDBJMrLPjmuLrPQQrEYw',
+        'datetime' => "r2kQpXWr6xOSUpw9MyXavYg",
       }[spreadsheetname]
+        # 'numbers1' => "o10837434939102457526.4784396906364855777",
+        # 'borders' => "o10837434939102457526.664868920231926255",
+        # 'simple_spreadsheet' => "ptu6bbahNZpYe-L1vEBmgGA",
+        # 'testnichtvorhandenBibelbund.ods' => "invalidkeyforanyspreadsheet", # !!! intentionally false key
+        # "only_one_sheet" => "o10837434939102457526.762705759906130135",
+        # "write.me" => 'ptu6bbahNZpY0N0RrxQbWdw&hl',
+        # 'formula' => 'o10837434939102457526.3022866619437760118',
+        # 'time-test' => 'ptu6bbahNZpYBMhk01UfXSg',
+        # 'datetime' => "ptu6bbahNZpYQEtZwzL_dZQ",
     rescue
       raise "unknown spreadsheetname: #{spreadsheetname}"
     end
@@ -129,18 +139,21 @@ class TestRoo < Test::Unit::TestCase
     assert_equal 42*60, 42.minutes
   end
 
+  # Using Date.strptime so check that it's using the method
+  # with the value set in date_format
   def test_date
-    assert Google.date?("21/11/1962")
-    assert_equal Date.new(1962,11,21), Google.to_date("21/11/1962")
-
-    assert !Google.date?("21")
-    assert_nil Google.to_date("21")
-
-    assert !Google.date?("21/11")
-    assert_nil Google.to_date("21/11")
-
-    assert !Google.date?("Mittwoch/21/1961")
-    assert_nil Google.to_date("Mittwoch/21/1961")
+    if GOOGLE
+      oo = Google.new(key_of("numbers1"))
+      # should default to  DDMMYYYY
+      assert oo.date?("21/11/1962") == true
+      assert oo.date?("11/21/1962") == false
+      oo.date_format = '%m/%d/%Y'
+      assert oo.date?("21/11/1962") == false
+      assert oo.date?("11/21/1962") == true
+      oo.date_format = '%Y-%m-%d'
+      assert oo.date?("1962-11-21") == true
+      assert oo.date?("1962-21-11") == false
+    end
   end
 
   def test_classes
@@ -439,25 +452,19 @@ class TestRoo < Test::Unit::TestCase
       assert_equal 8, oo.cell(2,4)
       assert_equal 9, oo.cell(2,5)
       assert_equal "test", oo.cell(2,6)
-      # assert_equal "string", oo.celltype(2,6)
       assert_equal :string, oo.celltype(2,6)
       assert_equal 11, oo.cell(2,7)
-      # assert_equal "float", oo.celltype(2,7)
       assert_equal :float, oo.celltype(2,7), "Inhalt: --#{oo.cell(2,7)}--"
-
       assert_equal 10, oo.cell(4,1)
       assert_equal 11, oo.cell(4,2)
       assert_equal 12, oo.cell(4,3)
       assert_equal 13, oo.cell(4,4)
       assert_equal 14, oo.cell(4,5)
-
       assert_equal 10, oo.cell(4,'A')
       assert_equal 11, oo.cell(4,'B')
       assert_equal 12, oo.cell(4,'C')
       assert_equal 13, oo.cell(4,'D')
       assert_equal 14, oo.cell(4,'E')
-
-      # assert_equal "date", oo.celltype(5,1)
       assert_equal :date, oo.celltype(5,1)
       assert_equal Date.new(1961,11,21), oo.cell(5,1)
       assert_equal "1961-11-21", oo.cell(5,1).to_s
@@ -1974,7 +1981,7 @@ class TestRoo < Test::Unit::TestCase
     end
   end
 
-  def SKIP_test_excel_zipped
+  def test_excel_zipped
     after Date.new(2009,1,10) do
       if EXCEL
         $log.level = Logger::DEBUG
@@ -2259,12 +2266,12 @@ class TestRoo < Test::Unit::TestCase
         oo.default_sheet = oo.sheets.first
         assert oo.to_csv("/tmp/numbers1.csv")
         assert File.exists?("/tmp/numbers1.csv")
-        assert_equal "", `diff test/numbers1.csv /tmp/numbers1.csv`
+        assert_equal "", `diff #{File.join(TESTDIR,"numbers1.csv")} /tmp/numbers1.csv`
 
         # bug?, 2008-01-15 from Troy Davis
         assert oo.to_csv("/tmp/numbers1.csv",oo.sheets.first)
         assert File.exists?("/tmp/numbers1.csv")
-        assert_equal "", `diff test/numbers1.csv /tmp/numbers1.csv`
+        assert_equal "", `diff #{File.join(TESTDIR,"numbers1.csv")} /tmp/numbers1.csv`
 
       end # Timeout
       #} # nothing_raised
@@ -3222,6 +3229,7 @@ class TestRoo < Test::Unit::TestCase
       oo = Google.new(key_of("simple_spreadsheet"))
       oo.default_sheet = oo.sheets.first
       oo.header_line = 3
+      oo.date_format = '%m/%d/%Y'
       erg = oo.find(:all, :conditions => {'Comment' => 'Task 1'})
       assert_equal Date.new(2007,05,07), erg[1]['Date']
       assert_equal 10.75       , erg[1]['Start time']
@@ -3417,12 +3425,10 @@ class TestRoo < Test::Unit::TestCase
       }
     end
     if GOOGLE
-      after Date.new(2009,1,15) do
-        assert_raise(IOError) {
-          # oo = Google.new(key_of('testnichtvorhanden'+'Bibelbund.ods'))
-          oo = Google.new('testnichtvorhanden')
-        }
-      end
+ #     assert_raise(Net::HTTPServerException) {
+        # oo = Google.new(key_of('testnichtvorhanden'+'Bibelbund.ods'))
+#        oo = Google.new('testnichtvorhanden')
+#      }
     end
   end
   
@@ -3441,11 +3447,12 @@ class TestRoo < Test::Unit::TestCase
   def test_write_google
     # write.me: http://spreadsheets.google.com/ccc?key=ptu6bbahNZpY0N0RrxQbWdw&hl=en_GB
     if GOOGLE
-      oo = Google.new('ptu6bbahNZpY0N0RrxQbWdw')
+      oo = Google.new(key_of('write.me'))
       oo.default_sheet = oo.sheets.first
       oo.set_value(1,1,"hello from the tests")
-      #oo.set_value(1,1,"sin(1)")
       assert_equal "hello from the tests", oo.cell(1,1)
+      oo.set_value(1,1, 1.0)
+      assert_equal 1.0, oo.cell(1,1)
     end
   end
 
@@ -3454,7 +3461,7 @@ class TestRoo < Test::Unit::TestCase
     if GOOGLE
       content1 = 'AAA'
       content2 = 'BBB'
-      oo = Google.new('ptu6bbahNZpY0N0RrxQbWdw')
+      oo = Google.new(key_of('write.me'))
       oo.default_sheet = oo.sheets.first
       oo.set_value(1,1,content1)
       oo.default_sheet = oo.sheets[1]
@@ -3470,7 +3477,7 @@ class TestRoo < Test::Unit::TestCase
     if GOOGLE
       random_row = rand(10)+1
       random_column = rand(10)+1
-      oo = Google.new('ptu6bbahNZpY0N0RrxQbWdw')
+      oo = Google.new(key_of('write.me'))
       oo.default_sheet = oo.sheets.first
       content1 = 'ABC'
       content2 = 'DEF'
@@ -3697,7 +3704,7 @@ Sheet 3:
       oo.default_sheet = oo.sheets.first
       assert oo.to_csv("/tmp/time-test.csv")
       assert File.exists?("/tmp/time-test.csv")
-      assert_equal "", `diff test/time-test.csv /tmp/time-test.csv`
+      assert_equal "", `diff #{File.join(TESTDIR,"time-test.csv")} /tmp/time-test.csv`
     end # GOOGLE
   end
 
@@ -4632,7 +4639,7 @@ This attached file is the newer format of Microsoft Excel (.xlsx).
   end
 
   def do_datetime_tests(oo)
-    val = oo.cell('c',3)
+     val = oo.cell('c',3)
     assert_kind_of DateTime, val
     assert_equal :datetime, oo.celltype('c',3)
     assert_equal DateTime.new(1961,11,21,12,17,18), val

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hmcgowan-roo
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors: 
 - Hugh McGowan
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-21 00:00:00 -07:00
+date: 2009-05-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -129,7 +129,7 @@ files:
 - test/time-test.xlsx
 - README.markdown
 - History.txt
-has_rdoc: true
+has_rdoc: false
 homepage: http://roo.rubyforge.org
 post_install_message: 
 rdoc_options: 
@@ -156,7 +156,7 @@ requirements: []
 rubyforge_project: roo
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: roo
 test_files: []