roo-google 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bca53fffea8b64bf864b796d233da2c2c260130b
+  data.tar.gz: 66bd40f914969abf1a445fa49f28909a044df058
+SHA512:
+  metadata.gz: dc20c65584614eb7615be9e2904fa7c5b16935f21cdc8d7f8c479e3f6c0bfb80004e85123d0e7fd3db40e0894622f742adf959f69af25c40f46ade90bb15535f
+  data.tar.gz: 9f997dde0080302a1b846add27a1d183b45dba007ea5f9203de04bebf59aa72564be5839addb593841f9b8661a7a34b635a99c342f31044fffd981e012ffc5b4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'spec/**/*'
+Metrics/LineLength:
+  Max: 99
+Style/FileName:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 15

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter 'spec'
+  add_filter 'test'
+end

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+bundler_args: --without local_development

data/Gemfile

@@ -0,0 +1,32 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in roo-xls.gemspec
+gemspec
+
+if ENV['TRAVIS']
+  gem 'roo', '>= 2.0.0beta1', github: 'roo-rb/roo'
+else
+  gem 'roo', '>= 2.0.0beta1', path: ::File.expand_path('../../roo', __FILE__)
+end
+
+group :test do
+  # additional testing libs
+  gem 'webmock'
+  gem 'shoulda'
+  gem 'rspec', '>= 3.0.0'
+  gem 'vcr'
+  gem 'simplecov', '>= 0.9.0', :require => false
+  gem 'coveralls', :require => false
+end
+
+group :local_development do
+  gem 'terminal-notifier-guard', require: false if RUBY_PLATFORM.downcase.include?('darwin')
+  gem 'guard-rspec', '>= 4.3.1' ,require: false
+  gem 'guard-bundler', require: false
+  gem 'guard-preek', require: false
+  gem 'guard-rubocop', require: false
+  gem 'guard-reek', github: 'pericles/guard-reek', require: false
+  gem 'pry'
+  gem 'appraisal'
+  gem 'transpec'
+end

data/Guardfile

@@ -0,0 +1,20 @@
+guard 'rspec', cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('roo-google.gemspec')
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :preek, run_all_dir: 'lib' do
+	watch(/^lib\/(.*).rb/)
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2008-2014 Thomas Preymesser, Ben Woosley
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Roo::Google [![BuildStatus](https://travis-ci.org/roo-rb/roo-google.svg)](https://travis-ci.org/roo-rb/roo-google)[![Code Climate](https://codeclimate.com/github/roo-rb/roo-google/badges/gpa.svg)](https://codeclimate.com/github/roo-rb/roo-google)[![Coverage Status](https://coveralls.io/repos/roo-rb/roo-google/badge.png)](https://coveralls.io/r/roo-rb/roo-google)
+
+### Google Spreadsheet
+
+Using Roo to access Google spreadsheets requires you install the 'google-drive-ruby' gem separately.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'roo-google'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install roo-google
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/roo-rb/roo-google/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+
+# require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+
+# Test unit
+# Rake::TestTask.new do |t|
+#  t.libs << 'test'
+#  t.test_files = FileList['test/test*.rb']
+#  t.verbose = true
+# end
+
+# RSpec
+RSpec::Core::RakeTask.new(:spec)
+
+# Coveralls
+Coveralls::RakeTask.new
+
+default_task = [:spec]
+default_task << 'coveralls:push' if ENV['TRAVIS']
+
+task default: default_task

data/defaults.reek

@@ -0,0 +1,11 @@
+---
+NestedIterators:
+  max_allowed_nesting: 2
+UtilityFunction:
+  enabled: false
+IrresponsibleModule:
+  enabled: false
+DuplicateMethodCall:
+  max_calls: 5
+FeatureEnvy:
+  enabled: false

data/lib/roo-google.rb

@@ -0,0 +1,6 @@
+require 'roo'
+require 'roo/google'
+
+module Roo
+  CLASS_FOR_EXTENSION.merge! google: ::Roo::Google
+end

data/lib/roo/google.rb

@@ -0,0 +1,244 @@
+require 'roo/base'
+require 'google_drive'
+
+class Roo::Google < Roo::Base
+  attr_accessor :date_format, :datetime_format, :time_format
+  # returns an array of sheet names in the spreadsheet
+  attr_reader :sheets
+  DATE_FORMAT     = '%d/%m/%Y'.freeze
+  DATETIME_FORMAT = '%d/%m/%Y %H:%M:%S'.freeze
+  TIME_FORMAT     = '%H:%M:%S'.freeze
+
+  # Creates a new Google Drive object.
+  def initialize(spreadsheet_key, options = {})
+    @filename     = spreadsheet_key
+    @access_token = options[:access_token] || ENV['GOOGLE_TOKEN']
+    super
+    @cell      = Hash.new { |h, k| h[k] = Hash.new }
+    @cell_type = Hash.new { |h, k| h[k] = Hash.new }
+    @formula   = {}
+    %w(date time datetime).each do |key|
+      __send__("#{key}_format=", self.class.const_get("#{key.upcase}_FORMAT"))
+    end
+  end
+
+  def worksheets
+    @worksheets ||= session.spreadsheet_by_key(@filename).worksheets
+  end
+
+  def sheets
+    @sheets ||= worksheets.map(&:title)
+  end
+
+  %w(date time datetime).each do |key|
+    class_eval <<-EOS, __FILE__, __LINE__ + 1
+      def #{key}?(string)
+        ::DateTime.strptime(string, @#{key}_format || #{key.upcase}_FORMAT)
+        true
+      rescue
+        false
+      end
+    EOS
+  end
+
+  def numeric?(string)
+    string =~ /\A[0-9]+[\.]*[0-9]*\z/
+  end
+
+  def timestring_to_seconds(value)
+    hms = value.split(':')
+    hms[0].to_i * 3600 + hms[1].to_i * 60 + hms[2].to_i
+  end
+
+  # Returns the content of a spreadsheet-cell.
+  # (1,1) is the upper left corner.
+  # (1,1), (1,'A'), ('A',1), ('a',1) all refers to the
+  # cell at the first line and first row.
+  def cell(row, col, sheet = default_sheet)
+    validate_sheet!(sheet) # TODO: 2007-12-16
+    read_cells(sheet)
+    row, col = normalize(row, col)
+    value    = @cell[sheet]["#{row},#{col}"]
+    type     = celltype(row, col, sheet)
+    return value unless [:date, :datetime].include?(type)
+    klass, format = if type == :date
+                      [::Date, @date_format]
+                    else
+                      [::DateTime, @datetime_format]
+                    end
+    begin
+      return klass.strptime(value, format)
+    rescue ArgumentError
+      raise "Invalid #{klass} #{sheet}[#{row},#{col}] #{value} using format '#{format}'"
+    end
+  end
+
+  # returns the type of a cell:
+  # * :float
+  # * :string
+  # * :date
+  # * :percentage
+  # * :formula
+  # * :time
+  # * :datetime
+  def celltype(row, col, sheet = default_sheet)
+    read_cells(sheet)
+    row, col = normalize(row, col)
+    if @formula.size > 0 && @formula[sheet]["#{row},#{col}"]
+      :formula
+    else
+      @cell_type[sheet]["#{row},#{col}"]
+    end
+  end
+
+  # Returns the formula at (row,col).
+  # Returns nil if there is no formula.
+  # The method #formula? checks if there is a formula.
+  def formula(row, col, sheet = default_sheet)
+    read_cells(sheet)
+    row, col = normalize(row, col)
+    @formula[sheet]["#{row},#{col}"] && @formula[sheet]["#{row},#{col}"]
+  end
+
+  alias_method :formula?, :formula
+
+  # true, if the cell is empty
+  def empty?(row, col, sheet = default_sheet)
+    value = cell(row, col, sheet)
+    return true unless value
+    return false if value.class == Date # a date is never empty
+    return false if value.class == Float
+    return false if celltype(row, col, sheet) == :time
+    value.empty?
+  end
+
+  # sets the cell to the content of 'value'
+  # a formula can be set in the form of '=SUM(...)'
+  def set(row, col, value, sheet = default_sheet)
+    validate_sheet!(sheet)
+
+    sheet_no = sheets.index(sheet) + 1
+    row, col = normalize(row, col)
+    add_to_cell_roo(row, col, value, sheet_no)
+    # re-read the portion of the document that has changed
+    if @cells_read[sheet]
+      value, value_type = determine_datatype(value.to_s)
+
+      _set_value(row, col, value, sheet)
+      set_type(row, col, value_type, sheet)
+    end
+  end
+
+  %w(first_row last_row first_column last_column).each do |key|
+    class_eval <<-EOS, __FILE__, __LINE__ + 1
+      def #{key}(sheet = default_sheet)
+        unless @#{key}[sheet]
+          set_first_last_row_column(sheet)
+        end
+        @#{key}[sheet]
+      end
+    EOS
+  end
+
+  private
+
+  def set_first_last_row_column(sheet)
+    sheet_no                                                                       = sheets.index(sheet) + 1
+    @first_row[sheet], @last_row[sheet], @first_column[sheet], @last_column[sheet] =
+      rows_and_cols_min_max(sheet_no)
+  end
+
+  def _set_value(row, col, value, sheet = default_sheet)
+    @cell[sheet]["#{row},#{col}"] = value
+  end
+
+  def set_type(row, col, type, sheet = default_sheet)
+    @cell_type[sheet]["#{row},#{col}"] = type
+  end
+
+  # read all cells in a sheet.
+  def read_cells(sheet = default_sheet)
+    validate_sheet!(sheet)
+    return if @cells_read[sheet]
+
+    ws = worksheets[sheets.index(sheet)]
+    for row in 1..ws.num_rows
+      for col in 1..ws.num_cols
+        read_cell_row(sheet, ws, row, col)
+      end
+    end
+    @cells_read[sheet] = true
+  end
+
+  def read_cell_row(sheet, ws, row, col)
+    key                    = "#{row},#{col}"
+    string_value           = ws.input_value(row, col) # item['inputvalue'] ||  item['inputValue']
+    numeric_value          = ws[row, col] # item['numericvalue']  ||  item['numericValue']
+    (value, value_type)    = determine_datatype(string_value, numeric_value)
+    @cell[sheet][key]      = value unless value == '' || value.nil?
+    @cell_type[sheet][key] = value_type
+    @formula[sheet]        = {} unless @formula[sheet]
+    @formula[sheet][key]   = string_value if value_type == :formula
+  end
+
+  def determine_datatype(val, numval = nil)
+    if val.nil? || val[0, 1] == '='
+      ty  = :formula
+      val = numeric?(numval) ? numval.to_f : numval
+    else
+      case
+      when datetime?(val)
+        ty = :datetime
+      when date?(val)
+        ty = :date
+      when numeric?(val)
+        ty  = :float
+        val = val.to_f
+      when time?(val)
+        ty  = :time
+        val = timestring_to_seconds(val)
+      else
+        ty = :string
+      end
+    end
+    [val, ty]
+  end
+
+  def add_to_cell_roo(row, col, value, sheet_no = 1)
+    sheet_no -= 1
+    worksheets[sheet_no][row, col] = value
+    worksheets[sheet_no].save
+  end
+
+  def entry_roo(value, row, col)
+    [value, row, col]
+  end
+
+  def rows_and_cols_min_max(sheet_no)
+    ws   = worksheets[sheet_no - 1]
+    rows = []
+    cols = []
+    for row in 1..ws.num_rows
+      for col in 1..ws.num_cols
+        if ws[row, col] && !ws[row, col].empty?
+          rows << row
+          cols << col
+        end
+      end
+    end
+    [rows.min, rows.max, cols.min, cols.max]
+  end
+
+  def reinitialize
+    @session = nil
+    initialize(@filename, access_token: @access_token)
+  end
+
+  def session
+    @session ||= if @access_token
+                   ::GoogleDrive.login_with_oauth(@access_token)
+                 else
+                   warn 'set access token'
+                 end
+  end
+end