roo 1.11.2 → 1.12.0

data/lib/roo/google.rb

@@ -1,59 +1,32 @@
 begin
-  require "google_spreadsheet"
+  require "google_drive"
 rescue LoadError => e
-  raise e, "Using Roo::Google requires the google-spreadsheet-ruby gem"
+  raise e, "Using Roo::Google requires the google_drive gem"
 end
 
-class GoogleHTTPError < RuntimeError; end
-class GoogleReadError < RuntimeError; end
-class GoogleWriteError < RuntimeError; end
-
-class Roo::Google < Roo::GenericSpreadsheet
+class Roo::Google < Roo::Base
   attr_accessor :date_format, :datetime_format
 
-  # Creates a new Google spreadsheet object.
-  def initialize(spreadsheetkey,user=nil,password=nil)
-    @filename = spreadsheetkey
-    @spreadsheetkey = spreadsheetkey
-    @user = user
-    @password = password
-    unless user
-      user = ENV['GOOGLE_MAIL']
-    end
-    unless password
-      password = ENV['GOOGLE_PASSWORD']
-    end
-    unless user and user.size > 0
-	    warn "user not set"
-    end
-    unless password and password.size > 0
-	    warn "password not set"
-    end
+  # Creates a new Google Drive object.
+  def initialize(spreadsheet_key, options = {})
+    @filename = spreadsheet_key
+    @user = options[:user] || ENV['GOOGLE_MAIL']
+    @password = options[:password] || ENV['GOOGLE_PASSWORD']
+    @access_token = options[:access_token] || ENV['GOOGLE_TOKEN']
+
+    @worksheets = session.spreadsheet_by_key(@filename).worksheets
+    @sheets = @worksheets.map {|sheet| sheet.title }
+    super
     @cell = Hash.new {|h,k| h[k]=Hash.new}
     @cell_type = Hash.new {|h,k| h[k]=Hash.new}
     @formula = Hash.new
-    @first_row = Hash.new
-    @last_row = Hash.new
-    @first_column = Hash.new
-    @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'
-    session = GoogleSpreadsheet.login(user, password)
-    @sheetlist = []
-    session.spreadsheet_by_key(@spreadsheetkey).worksheets.each { |sheet|
-      @sheetlist << sheet.title
-    }
-    @default_sheet = self.sheets.first
-    @worksheets = session.spreadsheet_by_key(@spreadsheetkey).worksheets
   end
 
   # returns an array of sheet names in the spreadsheet
-  def sheets
-    @sheetlist
-  end
+  attr_reader :sheets
 
   def date?(string)
     Date.strptime(string, @date_format)
@@ -93,7 +66,7 @@ class Roo::Google < Roo::GenericSpreadsheet
   def cell(row, col, sheet=nil)
     sheet ||= @default_sheet
     validate_sheet!(sheet) #TODO: 2007-12-16
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     row,col = normalize(row,col)
     value = @cell[sheet]["#{row},#{col}"]
     if celltype(row,col,sheet) == :date
@@ -122,10 +95,10 @@ class Roo::Google < Roo::GenericSpreadsheet
   # * :datetime
   def celltype(row, col, sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     row,col = normalize(row,col)
     if @formula.size > 0 && @formula[sheet]["#{row},#{col}"]
-      return :formula
+      :formula
     else
       @cell_type[sheet]["#{row},#{col}"]
     end
@@ -136,22 +109,11 @@ class Roo::Google < Roo::GenericSpreadsheet
   # The method #formula? checks if there is a formula.
   def formula(row,col,sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
-    row,col = normalize(row,col)
-    if @formula[sheet]["#{row},#{col}"] == nil
-      return nil
-    else
-      return @formula[sheet]["#{row},#{col}"]
-    end
-  end
-
-  # true, if there is a formula
-  def formula?(row,col,sheet=nil)
-    sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     row,col = normalize(row,col)
-    formula(row,col) != nil
+    @formula[sheet]["#{row},#{col}"] && @formula[sheet]["#{row},#{col}"]
   end
+  alias_method :formula?, :formula
 
   # true, if the cell is empty
   def empty?(row, col, sheet=nil)
@@ -247,6 +209,8 @@ class Roo::Google < Roo::GenericSpreadsheet
   def read_cells(sheet=nil)
     sheet ||= @default_sheet
     validate_sheet!(sheet)
+    return if @cells_read[sheet]
+
     sheet_no = sheets.index(sheet)
     ws = @worksheets[sheet_no]
     for row in 1..ws.num_rows
@@ -312,4 +276,17 @@ class Roo::Google < Roo::GenericSpreadsheet
     return rows.min, rows.max, cols.min, cols.max
   end
 
-end # class
+  def reinitialize
+    initialize(@filename, user: @user, password: @password, access_token: @access_token)
+  end
+
+  def session
+    @session ||= if @user && @password
+                   GoogleDrive.login(@user, @password)
+                 elsif @access_token
+                   GoogleDrive.login_with_oauth(@access_token)
+                 else
+                   warn 'set user and password or access token'
+                 end
+  end
+end

data/lib/roo/openoffice.rb

@@ -1,10 +1,8 @@
-require 'fileutils'
 require 'date'
 require 'nokogiri'
 require 'cgi'
-require 'pp' #TODO
-class Roo::Openoffice < Roo::GenericSpreadsheet
 
+class Roo::OpenOffice < Roo::Base
   class << self
     def extract_content(tmpdir, filename)
       Zip::ZipFile.open(filename) do |zip|
@@ -32,34 +30,35 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
 
   # initialization and opening of a spreadsheet file
   # values for packed: :zip
-  def initialize(filename, packed=nil, file_warning=:error, tmpdir_root=nil)
-    file_type_check(filename,'.ods','an Roo::Openoffice', file_warning, packed)
+  def initialize(filename, options={}, deprecated_file_warning=:error, deprecated_tmpdir_root=nil)
+    if Hash === options
+      packed = options[:packed]
+      file_warning = options[:file_warning] || :error
+      tmpdir_root = options[:tmpdir_root]
+    else
+      warn 'Supplying `packed`, `file_warning`, or `tmpdir_root` as separate arguments to `Roo::OpenOffice.new` is deprected. Use an options hash instead.'
+      packed = options
+      file_warning = deprecated_file_warning
+      tmpdir_root = deprecated_tmpdir_root
+    end
+
+    file_type_check(filename,'.ods','an Roo::OpenOffice', file_warning, packed)
     make_tmpdir(tmpdir_root) do |tmpdir|
-      filename = open_from_uri(filename, tmpdir) if uri?(filename)
+      filename = download_uri(filename, tmpdir) if uri?(filename)
       filename = unzip(filename, tmpdir) if packed == :zip
-      @cells_read = Hash.new
       #TODO: @cells_read[:default] = false
       @filename = filename
       unless File.file?(@filename)
         raise IOError, "file #{@filename} does not exist"
       end
       self.class.extract_content(tmpdir, @filename)
-      @doc = File.open(File.join(tmpdir, "roo_content.xml")) do |file|
-        Nokogiri::XML(file)
-      end
+      @doc = load_xml(File.join(tmpdir, "roo_content.xml"))
     end
-    @default_sheet = self.sheets.first
-    @cell = Hash.new
-    @cell_type = Hash.new
+    super(filename, options)
     @formula = Hash.new
-    @first_row = Hash.new
-    @last_row = Hash.new
-    @first_column = Hash.new
-    @last_column = Hash.new
     @style = Hash.new
     @style_defaults = Hash.new { |h,k| h[k] = [] }
     @style_definitions = Hash.new
-    @header_line = 1
     @comment = Hash.new
     @comments_read = Hash.new
   end
@@ -82,7 +81,7 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   # cell at the first line and first row.
   def cell(row, col, sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     row,col = normalize(row,col)
     if celltype(row,col,sheet) == :date
       yyyy,mm,dd = @cell[sheet][[row,col]].to_s.split('-')
@@ -96,36 +95,17 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   # The method #formula? checks if there is a formula.
   def formula(row,col,sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
-    row,col = normalize(row,col)
-    if @formula[sheet][[row,col]] == nil
-      return nil
-    else
-      # return @formula[sheet][[row,col]]["oooc:".length..-1]
-      # TODO:
-      #str = @formula[sheet][[row,col]]
-      #if str.include? ':'
-	      #return str[str.index(':')+1..-1]
-      #else
-	      #return str
-      #end
-      @formula[sheet][[row,col]]
-    end
-  end
-
-  # true, if there is a formula
-  def formula?(row,col,sheet=nil)
-    sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     row,col = normalize(row,col)
-    formula(row,col) != nil
+    @formula[sheet][[row,col]]
   end
+  alias_method :formula?, :formula
 
   # returns each formula in the selected sheet as an array of elements
   # [row, col, formula]
   def formulas(sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     if @formula[sheet]
       @formula[sheet].each.collect do |elem|
         [elem[0][0], elem[0][1], elem[1]]
@@ -154,7 +134,7 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   # Given a cell, return the cell's style
   def font(row, col, sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     row,col = normalize(row,col)
     style_name = @style[sheet][[row,col]] || @style_defaults[sheet][col - 1] || 'Default'
     @style_definitions[style_name]
@@ -170,7 +150,7 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   # * :datetime
   def celltype(row,col,sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     row,col = normalize(row,col)
     if @formula[sheet][[row,col]]
       return :formula
@@ -180,14 +160,12 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   end
 
   def sheets
-    return_sheets = []
-    @doc.xpath("//*[local-name()='table']").each do |sheet|
-      return_sheets << sheet.attributes["name"].value
+    @doc.xpath("//*[local-name()='table']").map do |sheet|
+      sheet.attributes["name"].value
     end
-    return_sheets
   end
 
-  # version of the Roo::Openoffice document
+  # version of the Roo::OpenOffice document
   # at 2007 this is always "1.0"
   def officeversion
     oo_version
@@ -198,7 +176,7 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   # mainly for debugging purposes
   def to_s(sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     @cell[sheet].inspect
   end
 
@@ -211,7 +189,7 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
     end
     if @label.has_key? labelname
       return @label[labelname][1].to_i,
-        Roo::GenericSpreadsheet.letter_to_number(@label[labelname][2]),
+        Roo::Base.letter_to_number(@label[labelname][2]),
         @label[labelname][0]
     else
       return nil,nil,nil
@@ -225,7 +203,7 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
     @label.map do |label|
       [ label[0], # name
         [ label[1][1].to_i, # row
-          Roo::GenericSpreadsheet.letter_to_number(label[1][2]), # column
+          Roo::Base.letter_to_number(label[1][2]), # column
           label[1][0], # sheet
         ] ]
     end
@@ -235,7 +213,7 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   # nil if there is no comment
   def comment(row,col,sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     row,col = normalize(row,col)
     return nil unless @comment[sheet]
     @comment[sheet][[row,col]]
@@ -244,7 +222,7 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   # true, if there is a comment
   def comment?(row,col,sheet=nil)
     sheet ||= @default_sheet
-    read_cells(sheet) unless @cells_read[sheet]
+    read_cells(sheet)
     row,col = normalize(row,col)
     comment(row,col) != nil
   end
@@ -277,7 +255,7 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   def set_cell_values(sheet,x,y,i,v,value_type,formula,table_cell,str_v,style_name)
     key = [y,x+i]
     @cell_type[sheet] = {} unless @cell_type[sheet]
-    @cell_type[sheet][key] = Roo::Openoffice.oo_type_2_roo_type(value_type)
+    @cell_type[sheet][key] = Roo::OpenOffice.oo_type_2_roo_type(value_type)
     @formula[sheet] = {} unless @formula[sheet]
     if formula
       ['of:', 'oooc:'].each do |prefix|
@@ -323,8 +301,9 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   def read_cells(sheet=nil)
     sheet ||= @default_sheet
     validate_sheet!(sheet)
-    sheet_found = false
+    return if @cells_read[sheet]
 
+    sheet_found = false
     @doc.xpath("//*[local-name()='table']").each do |ws|
       if sheet == attr(ws,'name')
         sheet_found = true
@@ -436,8 +415,8 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
     @comments_read[sheet] = true
   end
 
-  # Only calls read_cells because Roo::GenericSpreadsheet calls read_comments
-  # whereas the reading of comments is done in read_cells for Roo::Openoffice-objects
+  # Only calls read_cells because Roo::Base calls read_comments
+  # whereas the reading of comments is done in read_cells for Roo::OpenOffice-objects
   def read_comments(sheet=nil)
     read_cells(sheet)
   end
@@ -456,12 +435,12 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
   end
 
   def read_styles(style_elements)
-    @style_definitions['Default'] = Roo::Openoffice::Font.new
+    @style_definitions['Default'] = Roo::OpenOffice::Font.new
     style_elements.each do |style|
       next unless style.name == 'style'
       style_name = attr(style,'name')
       style.each do |properties|
-        font = Roo::Openoffice::Font.new
+        font = Roo::OpenOffice::Font.new
         font.bold = attr(properties,'font-weight')
         font.italic = attr(properties,'font-style')
         font.underline = attr(properties,'text-underline-style')
@@ -505,16 +484,13 @@ class Roo::Openoffice < Roo::GenericSpreadsheet
     result
   end
 
-
-  private
   def attr(node, attr_name)
     if node.attributes[attr_name]
       node.attributes[attr_name].value
     end
   end
-
 end # class
 
-# Libreoffice is just an alias for Roo::Openoffice class
-class Roo::Libreoffice < Roo::Openoffice
+# LibreOffice is just an alias for Roo::OpenOffice class
+class Roo::LibreOffice < Roo::OpenOffice
 end

data/lib/roo/roo_rails_helper.rb

@@ -1,3 +1,4 @@
+warn "Roo's roo_rails_helper, aka the spreadsheet view method is currently deprecated with no replacement. If you find it helpful, tell http://github.com/Empact or extract it yourself."
 def spreadsheet(spreadsheet, sheets, options={})
   @rspreadsheet = spreadsheet
   coordinates = true # default
@@ -43,7 +44,7 @@ def spreadsheet(spreadsheet, sheets, options={})
           next
         end
         o << "    <td>"
-        o << "      <b>#{Roo::GenericSpreadsheet.number_to_letter(c)}</b>"
+        o << "      <b>#{Roo::Base.number_to_letter(c)}</b>"
         o << "    </td>"
       }
       o << "</tr>"

data/lib/roo/spreadsheet.rb

@@ -1,21 +1,30 @@
 module Roo
   class Spreadsheet
     class << self
-      def open(file)
+      def open(file, options = {})
         file = File === file ? file.path : file
-        case File.extname(file).downcase
+
+        extension =
+          if options[:extension]
+            options[:file_warning] = :ignore
+            ".#{options[:extension]}"
+          else
+            File.extname(file)
+          end
+
+        case extension.downcase
         when '.xls'
-          Roo::Excel.new(file)
+          Roo::Excel.new(file, options)
         when '.xlsx'
-          Roo::Excelx.new(file)
+          Roo::Excelx.new(file, options)
         when '.ods'
-          Roo::Openoffice.new(file)
+          Roo::OpenOffice.new(file, options)
         when '.xml'
-          Roo::Excel2003XML.new(file)
+          Roo::Excel2003XML.new(file, options)
         when ''
-          Roo::Google.new(file)
+          Roo::Google.new(file, options)
         when '.csv'
-          Roo::Csv.new(file)
+          Roo::CSV.new(file, options)
         else
           raise ArgumentError, "Don't know how to open file #{file}"
         end