roo 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8604a4f1951ab6dfcd733de054d7bfb5a82a5fe0
-  data.tar.gz: 9d9a0f430db3eaf985772a6a934374d2a04ab822
+  metadata.gz: 416c34282c125b08fbf46e19c398f6a1c07d269a
+  data.tar.gz: 56a97234a7ddef8c1cd8aa0aa308949bc9f00d52
 SHA512:
-  metadata.gz: cd5bb56cbd0744febca931b1032b14910f512e5f4d5513ec81cbd6de011a75f557fd8855fe53311ab83e77f67f8564c1c8b2774ee16d89b44687906b1ca77332
-  data.tar.gz: b3cef390c20fc5e5bf70d1896222352c04d8f4eac4af5e4a64e850fbb2abfbbf0e2ad5a92aa45568c229562fd5e6e8a82c6f28d8bb089722e7b5d0afd5bfda75
+  metadata.gz: 8d318576088c9fd269ffc3702c38aa00f9bca4bddf97f1125d0d289c9674b0bae4136dbf43b70f635bba8f597d14bd22894b739e5306ec0690aa244638a374dd
+  data.tar.gz: a578beb4286e83f6a308aac442bc39bc829badc7ff35d9b0b6914550ccf587106cfbcc9974c51c957d8c16cf08dacabdf7383be1170f91ed207834035a302d8a

data/.codeclimate.yml

@@ -0,0 +1,17 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/
+- test/

data/.travis.yml

@@ -4,8 +4,7 @@ rvm:
   - 2.3.1
   - 2.4.0
   - ruby-head
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-2
+  - jruby-9.1.6.0
 matrix:
   include:
     - rvm: 2.0.0
@@ -14,6 +13,5 @@ matrix:
       gemfile: Gemfile_ruby2
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-19mode
-    - rvm: rbx-2
+    - rvm: jruby-9.1.6.0
 bundler_args: --without local_development

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## Unreleased
 
+## [2.7.0] 2016-12-31
+### Fixed
+- Added rack server for testing Roo's download capabilities [365](https://github.com/roo-rb/roo/pull/365)
+- Refactored tests into different formats [365](https://github.com/roo-rb/roo/pull/365)
+- Fixed OpenOffice for JRuby [362](https://github.com/roo-rb/roo/pull/362)
+- Added '0.000000' => '%.6f' number format [354](https://github.com/roo-rb/roo/pull/354)
+- Add additional formula cell types for to_csv [367][https://github.com/roo-rb/roo/pull/367]
+
+### Added
+- Extracted formatters from Roo::Base#to_* methods [364](https://github.com/roo-rb/roo/pull/364)
+
 ## [2.6.0] 2016-12-28
 ### Fixed
 - Fixed error if sheet name starts with a slash [348](https://github.com/roo-rb/roo/pull/348)

data/Gemfile

@@ -4,13 +4,12 @@ gemspec
 
 group :test do
   # additional testing libs
-  gem 'webmock'
   gem 'shoulda'
   gem 'activesupport', '< 5.1'
   gem 'rspec', '>= 3.0.0'
-  gem 'vcr'
   gem 'simplecov', '>= 0.9.0', require: false
   gem 'coveralls', require: false
+  gem "minitest-reporters"
 end
 
 group :local_development do
@@ -18,8 +17,7 @@ group :local_development do
   gem 'guard-rspec', '>= 4.3.1', require: false
   gem 'guard-minitest', 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 "rb-readline"
   gem 'pry'
 end

data/Gemfile_ruby2

@@ -6,14 +6,14 @@ gem 'nokogiri', "< 1.7.0"
 
 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
-  # gem "pry"
   gem "activesupport", "~> 4.2.0"
+  gem "tins", '~> 1.6.0'
+  gem "term-ansicolor", "~> 1.3.2"
+  gem "minitest-reporters"
 end
 
 group :local_development do
@@ -25,5 +25,6 @@ group :local_development do
   gem 'guard-preek', require: false
   gem 'guard-rubocop', require: false
   gem 'guard-reek', github: 'pericles/guard-reek', require: false
+  gem 'rb-readline'
   gem 'pry'
 end

data/README.md

@@ -262,6 +262,16 @@ Roo's public methods have stayed relatively consistent between 1.13.x and 2.0.0,
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
 
+### Testing
+Roo uses Minitest and RSpec. The best of both worlds! Run `bundle exec rake` to
+run the tests/examples.
+
+Roo also has a few tests that take a long time (5+ seconds). To run these, use
+`LONG_RUN=true bundle exec rake`
+
+When testing using Ruby 2.0 or 2.1, use this command:
+`BUNDLE_GEMFILE=Gemfile_ruby2 bundle exec rake`
+
 ### Issues
 
 If you find an issue, please create a gist and refer to it in an issue ([sample gist](https://gist.github.com/stevendaniels/98a05849036e99bb8b3c)). Here are some instructions for creating such a gist.

data/lib/roo/base.rb

@@ -4,10 +4,20 @@ require 'tmpdir'
 require 'stringio'
 require 'nokogiri'
 require 'roo/utils'
+require "roo/formatters/base"
+require "roo/formatters/csv"
+require "roo/formatters/matrix"
+require "roo/formatters/xml"
+require "roo/formatters/yaml"
 
 # Base class for all other types of spreadsheets
 class Roo::Base
   include Enumerable
+  include Roo::Formatters::Base
+  include Roo::Formatters::CSV
+  include Roo::Formatters::Matrix
+  include Roo::Formatters::XML
+  include Roo::Formatters::YAML
 
   MAX_ROW_COL = 999_999.freeze
   MIN_ROW_COL = 0.freeze
@@ -22,6 +32,10 @@ class Roo::Base
     Roo::TEMP_PREFIX
   end
 
+  def self.finalize(object_id)
+    proc { finalize_tempdirs(object_id) }
+  end
+
   def initialize(filename, options = {}, _file_warning = :error, _tmpdir = nil)
     @filename = filename
     @options = options
@@ -105,73 +119,6 @@ class Roo::Base
     EOS
   end
 
-  # returns a rectangular area (default: all cells) as yaml-output
-  # you can add additional attributes with the prefix parameter like:
-  # oo.to_yaml({"file"=>"flightdata_2007-06-26", "sheet" => "1"})
-  def to_yaml(prefix = {}, from_row = nil, from_column = nil, to_row = nil, to_column = nil, sheet = default_sheet)
-    return '' unless first_row # empty result if there is no first_row in a sheet
-
-    from_row ||= first_row(sheet)
-    to_row ||= last_row(sheet)
-    from_column ||= first_column(sheet)
-    to_column ||= last_column(sheet)
-
-    result = "--- \n"
-    from_row.upto(to_row) do |row|
-      from_column.upto(to_column) do |col|
-        next if empty?(row, col, sheet)
-
-        result << "cell_#{row}_#{col}: \n"
-        prefix.each do|k, v|
-          result << "  #{k}: #{v} \n"
-        end
-        result << "  row: #{row} \n"
-        result << "  col: #{col} \n"
-        result << "  celltype: #{celltype(row, col, sheet)} \n"
-        value = cell(row, col, sheet)
-        if celltype(row, col, sheet) == :time
-          value = integer_to_timestring(value)
-        end
-        result << "  value: #{value} \n"
-      end
-    end
-
-    result
-  end
-
-  # write the current spreadsheet to stdout or into a file
-  def to_csv(filename = nil, separator = ',', sheet = default_sheet)
-    if filename
-      File.open(filename, 'w') do |file|
-        write_csv_content(file, sheet, separator)
-      end
-      true
-    else
-      sio = ::StringIO.new
-      write_csv_content(sio, sheet, separator)
-      sio.rewind
-      sio.read
-    end
-  end
-
-  # returns a matrix object from the whole sheet or a rectangular area of a sheet
-  def to_matrix(from_row = nil, from_column = nil, to_row = nil, to_column = nil, sheet = default_sheet)
-    require 'matrix'
-
-    return Matrix.empty unless first_row
-
-    from_row ||= first_row(sheet)
-    to_row ||= last_row(sheet)
-    from_column ||= first_column(sheet)
-    to_column ||= last_column(sheet)
-
-    Matrix.rows(from_row.upto(to_row).map do |row|
-      from_column.upto(to_column).map do |col|
-        cell(row, col, sheet)
-      end
-    end)
-  end
-
   def inspect
     "<##{self.class}:#{object_id.to_s(8)} #{instance_variables.join(' ')}>"
   end
@@ -274,32 +221,6 @@ class Roo::Base
     end
   end
 
-  # returns an XML representation of all sheets of a spreadsheet file
-  def to_xml
-    Nokogiri::XML::Builder.new do |xml|
-      xml.spreadsheet do
-        sheets.each do |sheet|
-          self.default_sheet = sheet
-          xml.sheet(name: sheet) do |x|
-            if first_row && last_row && first_column && last_column
-              # sonst gibt es Fehler bei leeren Blaettern
-              first_row.upto(last_row) do |row|
-                first_column.upto(last_column) do |col|
-                  next if empty?(row, col)
-
-                  x.cell(cell(row, col),
-                           row: row,
-                           column: col,
-                           type: celltype(row, col))
-                end
-              end
-            end
-          end
-        end
-      end
-    end.to_xml
-  end
-
   # when a method like spreadsheet.a42 is called
   # convert it to a call of spreadsheet.cell('a',42)
   def method_missing(m, *args)
@@ -675,76 +596,4 @@ class Roo::Base
       ret
     end
   end
-
-  # Write all cells to the csv file. File can be a filename or nil. If the this
-  # parameter is nil the output goes to STDOUT
-  def write_csv_content(file = nil, sheet = nil, separator = ',')
-    file ||= STDOUT
-    return unless first_row(sheet) # The sheet is empty
-
-    1.upto(last_row(sheet)) do |row|
-      1.upto(last_column(sheet)) do |col|
-        file.print(separator) if col > 1
-        file.print cell_to_csv(row, col, sheet)
-      end
-      file.print("\n")
-    end
-  end
-
-  # The content of a cell in the csv output
-  def cell_to_csv(row, col, sheet)
-    return '' if empty?(row, col, sheet)
-
-    onecell = cell(row, col, sheet)
-
-    case celltype(row, col, sheet)
-    when :string
-      %("#{onecell.gsub('"', '""')}") unless onecell.empty?
-    when :boolean
-      # TODO: this only works for excelx
-      onecell = self.sheet_for(sheet).cells[[row, col]].formatted_value
-      %("#{onecell.gsub('"', '""').downcase}")
-    when :float, :percentage
-      if onecell == onecell.to_i
-        onecell.to_i.to_s
-      else
-        onecell.to_s
-      end
-    when :formula
-      case onecell
-      when String
-        %("#{onecell.gsub('"', '""')}") unless onecell.empty?
-      when Integer
-        onecell.to_s
-      when Float
-        if onecell == onecell.to_i
-          onecell.to_i.to_s
-        else
-          onecell.to_s
-        end
-      when DateTime
-        onecell.to_s
-      else
-        fail "unhandled onecell-class #{onecell.class}"
-      end
-    when :date, :datetime
-      onecell.to_s
-    when :time
-      integer_to_timestring(onecell)
-    when :link
-      %("#{onecell.url.gsub('"', '""')}")
-    else
-      fail "unhandled celltype #{celltype(row, col, sheet)}"
-    end || ''
-  end
-
-  # converts an integer value to a time string like '02:05:06'
-  def integer_to_timestring(content)
-    h = (content / 3600.0).floor
-    content -= h * 3600
-    m = (content / 60.0).floor
-    content -= m * 60
-    s = content
-    sprintf('%02d:%02d:%02d', h, m, s)
-  end
 end

data/lib/roo/csv.rb

@@ -1,5 +1,5 @@
-require 'csv'
-require 'time'
+require "csv"
+require "time"
 
 # The CSV class can read csv files (must be separated with commas) which then
 # can be handled like spreadsheets. This means you can access cells like A5
@@ -9,124 +9,119 @@ require 'time'
 #
 # You can pass options to the underlying CSV parse operation, via the
 # :csv_options option.
-#
-
-class Roo::CSV < Roo::Base
+module Roo
+  class CSV < Roo::Base
+    attr_reader :filename
+
+    # Returns an array with the names of the sheets. In CSV class there is only
+    # one dummy sheet, because a csv file cannot have more than one sheet.
+    def sheets
+      ["default"]
+    end
 
-  attr_reader :filename
+    def cell(row, col, sheet = nil)
+      sheet ||= default_sheet
+      read_cells(sheet)
+      @cell[normalize(row, col)]
+    end
 
-  # Returns an array with the names of the sheets. In CSV class there is only
-  # one dummy sheet, because a csv file cannot have more than one sheet.
-  def sheets
-    ['default']
-  end
+    def celltype(row, col, sheet = nil)
+      sheet ||= default_sheet
+      read_cells(sheet)
+      @cell_type[normalize(row, col)]
+    end
 
-  def cell(row, col, sheet=nil)
-    sheet ||= default_sheet
-    read_cells(sheet)
-    @cell[normalize(row,col)]
-  end
+    def cell_postprocessing(_row, _col, value)
+      value
+    end
 
-  def celltype(row, col, sheet=nil)
-    sheet ||= default_sheet
-    read_cells(sheet)
-    @cell_type[normalize(row,col)]
-  end
+    def csv_options
+      @options[:csv_options] || {}
+    end
 
-  def cell_postprocessing(row,col,value)
-    value
-  end
+    def set_value(row, col, value, _sheet)
+      @cell[[row, col]] = value
+    end
 
-  def csv_options
-    @options[:csv_options] || {}
-  end
+    def set_type(row, col, type, _sheet)
+      @cell_type[[row, col]] = type
+    end
 
-  def set_value(row, col, value, _sheet)
-    @cell[[row, col]] = value
-  end
+    private
 
-  def set_type(row, col, type, _sheet)
-    @cell_type[[row, col]] = type
-  end
+    TYPE_MAP = {
+      String => :string,
+      Float => :float,
+      Date => :date,
+      DateTime => :datetime,
+    }
 
-  private
+    def celltype_class(value)
+      TYPE_MAP[value.class]
+    end
 
-  TYPE_MAP = {
-    String => :string,
-    Float => :float,
-    Date => :date,
-    DateTime => :datetime,
-  }
+    def read_cells(sheet = default_sheet)
+      sheet ||= default_sheet
+      return if @cells_read[sheet]
+      set_row_count(sheet)
+      set_column_count(sheet)
+      row_num = 1
+
+      each_row csv_options do |row|
+        row.each_with_index do |elem, col_num|
+          coordinate = [row_num, col_num + 1]
+          @cell[coordinate] = elem
+          @cell_type[coordinate] = celltype_class(elem)
+        end
+        row_num += 1
+      end
 
-  def celltype_class(value)
-    TYPE_MAP[value.class]
-  end
+      @cells_read[sheet] = true
+    end
 
-  def each_row(options, &block)
-    if uri?(filename)
-      ::Dir.mktmpdir(Roo::TEMP_PREFIX, ENV['ROO_TMP']) do |tmpdir|
-        tmp_filename = download_uri(filename, tmpdir)
-        CSV.foreach(tmp_filename, options, &block)
+    def each_row(options, &block)
+      if uri?(filename)
+        each_row_using_temp_dir(filename)
+      elsif is_stream?(filename_or_stream)
+        ::CSV.new(filename_or_stream, options).each(&block)
+      else
+        ::CSV.foreach(filename, options, &block)
       end
-    elsif is_stream?(filename_or_stream)
-      CSV.new(filename_or_stream, options).each(&block)
-    else
-      CSV.foreach(filename, options, &block)
     end
-  end
 
-  def read_cells(sheet = default_sheet)
-    sheet ||= default_sheet
-    return if @cells_read[sheet]
-    @first_row[sheet] = 1
-    @last_row[sheet] = 0
-    @first_column[sheet] = 1
-    @last_column[sheet] = 1
-    rownum = 1
-    each_row csv_options do |row|
-      row.each_with_index do |elem,i|
-        @cell[[rownum,i+1]] = cell_postprocessing rownum,i+1, elem
-        @cell_type[[rownum,i+1]] = celltype_class @cell[[rownum,i+1]]
-        if i+1 > @last_column[sheet]
-          @last_column[sheet] += 1
-        end
+    def each_row_using_tempdir
+      ::Dir.mktmpdir(Roo::TEMP_PREFIX, ENV["ROO_TMP"]) do |tmpdir|
+        tmp_filename = download_uri(filename, tmpdir)
+        ::CSV.foreach(tmp_filename, options, &block)
       end
-      rownum += 1
-      @last_row[sheet] += 1
-    end
-    @cells_read[sheet] = true
-    #-- adjust @first_row if neccessary
-    while !row(@first_row[sheet]).any? and @first_row[sheet] < @last_row[sheet]
-      @first_row[sheet] += 1
-    end
-    #-- adjust @last_row if neccessary
-    while !row(@last_row[sheet]).any? and @last_row[sheet] and
-        @last_row[sheet] > @first_row[sheet]
-      @last_row[sheet] -= 1
     end
-    #-- adjust @first_column if neccessary
-    while !column(@first_column[sheet]).any? and
-          @first_column[sheet] and
-          @first_column[sheet] < @last_column[sheet]
-      @first_column[sheet] += 1
+
+    def set_row_count(sheet)
+      @first_row[sheet] = 1
+      @last_row[sheet] = ::CSV.readlines(@filename).size
+      @last_row[sheet] = @first_row[sheet] if @last_row[sheet].zero?
+
+      nil
     end
-    #-- adjust @last_column if neccessary
-    while !column(@last_column[sheet]).any? and
-          @last_column[sheet] and
-          @last_column[sheet] > @first_column[sheet]
-      @last_column[sheet] -= 1
+
+    def set_column_count(sheet)
+      @first_column[sheet] = 1
+      @last_column[sheet] = (::CSV.readlines(@filename).first || []).size
+      @last_column[sheet] = @first_column[sheet] if @last_column[sheet].zero?
+
+      nil
     end
-  end
 
-  def clean_sheet(sheet)
-    read_cells(sheet)
+    def clean_sheet(sheet)
+      read_cells(sheet)
+
+      @cell.each_pair do |coord, value|
+        @cell[coord] = sanitize_value(value) if value.is_a?(::String)
+      end
 
-    @cell.each_pair do |coord, value|
-      @cell[coord] = sanitize_value(value) if value.is_a?(::String)
+      @cleaned[sheet] = true
     end
 
-    @cleaned[sheet] = true
+    alias_method :filename_or_stream, :filename
   end
-
-  alias_method :filename_or_stream, :filename
 end