roo 2.0.1 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db86b4586034783940303cfd17a7ee5c60277a51
-  data.tar.gz: 2cf9222f2f2759f164164f745c72abe6b901df98
+  metadata.gz: 711650fb2132509af1a6df5cd4b5a3d83eaac68f
+  data.tar.gz: ca23282af485cfa63d4b4a761d4081841edd385c
 SHA512:
-  metadata.gz: 442e05a8bffdc839c45a8684e8882f4327098387617b76027b6b5c0543c2a7b4be284c511c35f8333c9bc1147e31350d1f6f67174fc62e5b7fc45520ab0ad307
-  data.tar.gz: 4ba67602e5772cae52f41ea0357ddd6835d25c35be57797307a6194a46ad977d7922b884b4fa826c91efd8533c6f3e56995e8cb0a13146a32e4a3ee7d5e42ae9
+  metadata.gz: 7166103bc551a008905e6052369ed5cf714bd949d83021e3596cef8ae083fccead0faac1b28591bf28b09f977202955c4f2e92fda45a5961475eff4ea3caa93e
+  data.tar.gz: dc030d1d1530114289e8a420283fdf3131759ee107dfaa17bcc35c098e5d0e8b74fe984dc655b72a2701b211e3af3442f3cd79f0ad07e9cf1e7587496cfc7a16

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/.github/ISSUE_TEMPLATE

@@ -0,0 +1,10 @@
+Thanks for filing an issue. Following these instructions will help us solve your problem sooner.
+
+1. Describe the issue.
+2. Create a gist for this issue (Sample gist: https://gist.github.com/stevendaniels/98a05849036e99bb8b3c)? 
+
+Here are some instructions for creating such a gist. 
+
+1. Create a gist (https://gist.github.com) with code that creates the error.
+2. Clone the gist repo locally, add a stripped down version of the offending spreadsheet to the gist repo, and push the gist's changes master.
+3. Paste the gist url here.

data/.gitignore

@@ -5,3 +5,7 @@
 .project
 *.lock
 .idea
+.buildpath
+*~
+.bundle/
+lbin/

data/.travis.yml

@@ -1,13 +1,17 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1
-  - 2.2.0
+  - 2.2.4
+  - 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
+      gemfile: Gemfile_ruby2
+    - rvm: 2.1.8
+      gemfile: Gemfile_ruby2
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-19mode
+    - rvm: jruby-9.1.6.0
 bundler_args: --without local_development

data/CHANGELOG.md

@@ -1,3 +1,118 @@
+## Unreleased
+
+## [2.7.1] 2017-01-03
+### Fixed
+- Fixed regression where a CSV's encoding was being ignored [372](https://github.com/roo-rb/roo/pull/372)
+
+## [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)
+- Fixed loading to support files on ftp [355](https://github.com/roo-rb/roo/pull/355)
+- Fixed Ruby 2.4.0 deprecation warnings [356](https://github.com/roo-rb/roo/pull/356)
+- properly return date as string [359](https://github.com/roo-rb/roo/pull/359)
+
+### Added
+- Cell values can be set in a CSV [350](https://github.com/roo-rb/roo/pull/350/)
+- Raise an error Roo::Excelx::Extractor document is missing [358](https://github.com/roo-rb/roo/pull/358/)
+
+## [2.5.1] 2016-08-26
+### Fixed
+- Fixed NameError. [337](https://github.com/roo-rb/roo/pull/337)
+
+## [2.5.0] 2016-08-21
+### Fixed
+- Remove temporary directories via finalizers on garbage collection. This cleans them up in all known cases, rather than just when the #close method is called. The #close method can be used to cleanup early. [329](https://github.com/roo-rb/roo/pull/329)
+- Fixed README.md typo [318](https://github.com/roo-rb/roo/pull/318)
+- Parse sheets in ODS files once to improve performance [320](https://github.com/roo-rb/roo/pull/320)
+- Fix some Cell conversion issues [324](https://github.com/roo-rb/roo/pull/324) and [331](https://github.com/roo-rb/roo/pull/331)
+- Improved memory performance [332](https://github.com/roo-rb/roo/pull/332)
+- Added `no_hyperlinks` option to improve streamig performance [319](https://github.com/roo-rb/roo/pull/319) and [333](https://github.com/roo-rb/roo/pull/333)
+
+### Deprecations
+- Roo::Base::TEMP_PREFIX should be accessed via Roo::TEMP_PREFIX
+- The private Roo::Base#make_tempdir is now available at the class level in
+  classes that use temporary directories, added via Roo::Tempdir
+=======
+### Added
+- Discard hyperlinks lookups to allow streaming parsing without loading whole files
+
+## [2.4.0] 2016-05-14
+### Fixed  
+- Fixed opening spreadsheets with charts [315](https://github.com/roo-rb/roo/pull/315)
+- Fixed memory issues for Roo::Utils.number_to_letter [308](https://github.com/roo-rb/roo/pull/308)
+- Fixed Roo::Excelx::Cell::Number to recognize floating point numbers [306](https://github.com/roo-rb/roo/pull/306)
+- Fixed version number in Readme.md [304](https://github.com/roo-rb/roo/pull/304)
+
+### Added
+- Added initial support for HTML formatting [278](https://github.com/roo-rb/roo/pull/278)
+
+## [2.3.2] 2016-02-18
+### Fixed
+- Handle url with long query params (ex. S3 secure url) [302](https://github.com/roo-rb/roo/pull/302)
+- Allow streaming for Roo::CSV [297](https://github.com/roo-rb/roo/pull/297)
+- Export Fixnums to Added csv [295](https://github.com/roo-rb/roo/pull/295)
+- Removed various Ruby warnings [289](https://github.com/roo-rb/roo/pull/289)
+- Fix incorrect example result in Readme.md [293](https://github.com/roo-rb/roo/pull/293)
+
+## [2.3.1] - 2016-01-08
+### Fixed
+- Properly parse scientific-notation number like 1E-3 [#288](https://github.com/roo-rb/roo/pull/288)
+- Include all tests in default rake run [#283](https://github.com/roo-rb/roo/pull/283)
+- Fix zero-padded numbers for Excelx [#282](https://github.com/roo-rb/roo/pull/282)
+
+### Changed
+- Moved `ERROR_VALUES` from Excelx::Cell::Number ~> Excelx. [#280](https://github.com/roo-rb/roo/pull/280)
+
+## [2.3.0] - 2015-12-10
+### Changed
+- Excelx::Cell::Number will return a String instead of an Integer or Float if the cell has an error like #DIV/0, etc. [#273](https://github.com/roo-rb/roo/pull/273)
+
+### Fixed
+- Excelx::Cell::Number now handles cell errors. [#273](https://github.com/roo-rb/roo/pull/273)
+
+## [2.2.0] - 2015-10-31
+### Added
+- Added support for returning Integers values to Roo::OpenOffice [#258](https://github.com/roo-rb/roo/pull/258)
+- A missing Header Raises `Roo::HeaderRowNotFoundError`  [#247](https://github.com/roo-rb/roo/pull/247)
+- Roo::Excelx::Shared class to pass shared data to Roo::Excelx sheets [#220](https://github.com/roo-rb/roo/pull/220)
+- Proper Type support to Roo::Excelx [#240](https://github.com/roo-rb/roo/pull/240)
+- Added Roo::HeaderRowNotFoundError [#247](https://github.com/roo-rb/roo/pull/247)
+
+### Changed
+- Made spelling/grammar corrections in the README[260](https://github.com/roo-rb/roo/pull/260)
+- Moved Roo::Excelx::Format module [#259](https://github.com/roo-rb/roo/pull/259)
+- Updated README with details about `Roo::Excelx#each_with_streaming` method [#250](https://github.com/roo-rb/roo/pull/250)
+
+### Fixed
+- Fixed Base64 not found issue in Open Office [#267](https://github.com/roo-rb/roo/pull/267)
+- Fixed Regexp to allow method access to cells with multiple digits [#255](https://github.com/roo-rb/roo/pull/255), [#268](https://github.com/roo-rb/roo/pull/268)
+
+## [2.1.1] - 2015-08-02
+### Fixed invalid new lines with _x000D_ character[#231](https://github.com/roo-rb/roo/pull/231)
+### Fixed missing URI issue. [#245](https://github.com/roo-rb/roo/pull/245)
+
+## [2.1.0] - 2015-07-18
+### Added
+- Added support for Excel 2007 `xlsm` files. [#232](https://github.com/roo-rb/roo/pull/232)
+- Roo::Excelx returns an enumerator when calling each_row_streaming without a block. [#224](https://github.com/roo-rb/roo/pull/224)
+- Returns an enumerator when calling `each` without a block. [#219](https://github.com/roo-rb/roo/pull/219)
+
+### Fixed
+- Removed tabs and windows CRLF. [#235](https://github.com/roo-rb/roo/pull/235), [#234](https://github.com/roo-rb/roo/pull/234)
+- Fixed Regexp to only check for valid URI's when opening a spreadsheet. [#229](https://github.com/roo-rb/roo/pull/228)
+- Open streams in Roo:Excelx correctly. [#222](https://github.com/roo-rb/roo/pull/222)
+
 ## [2.0.1] - 2015-06-01
 ### Added
 - Return an enumerator when calling '#each' without a block [#219](https://github.com/roo-rb/roo/pull/219)
@@ -464,7 +579,7 @@
 
 ## [0.2.4] - 2007-06-16
 ### Fixed
-- ID 11605	Two cols with same value: crash roo (openoffice version only)
+- ID 11605  Two cols with same value: crash roo (openoffice version only)
 
 ## [0.2.3] - 2007-06-02
 ### Changed / Added

data/Gemfile

@@ -4,12 +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
@@ -17,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

@@ -0,0 +1,30 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'nokogiri', "< 1.7.0"
+
+group :test do
+  # additional testing libs
+  gem 'shoulda'
+  gem 'rspec', '>= 3.0.0'
+  gem 'simplecov', '>= 0.9.0', require: false
+  gem 'coveralls', require: false
+  gem "activesupport", "~> 4.2.0"
+  gem "tins", '~> 1.6.0'
+  gem "term-ansicolor", "~> 1.3.2"
+  gem "minitest-reporters"
+end
+
+group :local_development do
+  gem "listen", "~> 3.0.6"
+  gem 'terminal-notifier-guard', require: false if RUBY_PLATFORM.downcase.include?('darwin')
+  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/Guardfile

@@ -3,7 +3,7 @@
 
 guard :minitest, test_folders: ['test'] do
   watch(%r{^test/(.*)\/?test_(.*)\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1].to_s.sub('roo/', '')}test_#{m[2]}.rb" }
   watch(%r{^test/test_helper\.rb$})      { 'test' }
 end
 
@@ -21,4 +21,3 @@ guard :rspec, cmd: 'bundle exec rspec' do
   watch('spec/spec_helper.rb')  { "spec" }
   watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
 end
-

data/README.md

@@ -3,16 +3,13 @@
 [![Build Status](https://img.shields.io/travis/roo-rb/roo.svg?style=flat-square)](https://travis-ci.org/roo-rb/roo) [![Code Climate](https://img.shields.io/codeclimate/github/roo-rb/roo.svg?style=flat-square)](https://codeclimate.com/github/roo-rb/roo) [![Coverage Status](https://img.shields.io/coveralls/roo-rb/roo.svg?style=flat-square)](https://coveralls.io/r/roo-rb/roo) [![Gem Version](https://img.shields.io/gem/v/roo.svg?style=flat-square)](https://rubygems.org/gems/roo)
 
 Roo implements read access for all common spreadsheet types. It can handle:
-
-* Excelx
-* OpenOffice / LibreOffice
+* Excel 2007 - 2013 formats (xlsx, xlsm)
+* LibreOffice / OpenOffice.org formats (ods)
 * CSV
+* Excel 97, Excel 2002 XML, and Excel 2003 XML formats when using the [roo-xls](https://github.com/roo-rb/roo-xls) gem (xls, xml)
+* Google spreadsheets with read/write access when using [roo-google](https://github.com/roo-rb/roo-google)
 
-## Additional Libraries
-
-In addition, the [roo-xls](https://github.com/roo-rb/roo-xls) and [roo-google](https://github.com/roo-rb/roo-google) gems exist to extend Roo to support reading classic Excel formats (i.e. `.xls` and ``Excel2003XML``) and read/write access for Google spreadsheets.
-
-# #Installation
+## Installation
 
 Install as a gem
 
@@ -21,7 +18,7 @@ Install as a gem
 Or add it to your Gemfile
 
 ```ruby
-gem 'roo', '~> 2.0.0'
+gem "roo", "~> 2.7.0"
 ```
 ## Usage
 
@@ -53,7 +50,7 @@ ods.sheet(0).row(1)
 
 # Set the last sheet as the default sheet.
 ods.default_sheet = ods.sheets.last
-ods.default_sheet = s.sheets[3]
+ods.default_sheet = ods.sheets[2]
 ods.default_sheet = 'Sheet 3'
 
 # Iterate through each sheet
@@ -102,7 +99,7 @@ s.cell(1,'A',s.sheets[1])
 ```
 
 #### Querying a spreadsheet
-Use ``each`` with a ``block`` to iterate over each row.
+Use ``each`` to iterate over each row.
 
 If each is given a hash with the names of some columns, then each will generate a hash with the columns supplied for each row.
 
@@ -116,8 +113,8 @@ end
 Use ``sheet.parse`` to return an array of rows. Column names can be a ``String`` or a ``Regexp``.
 
 ```ruby
-sheet.parse(:id => /UPC|SKU/,:qty => /ATS*\sATP\s*QTY\z/)
-# => [{:upc => 727880013358, :qty => 12}, ...]
+sheet.parse(id: /UPC|SKU/, qty: /ATS*\sATP\s*QTY\z/)
+# => [{:id => 727880013358, :qty => 12}, ...]
 ```
 
 Use the ``:header_search`` option to locate the header row and assign the header names.
@@ -129,7 +126,7 @@ sheet.parse(header_search: [/UPC*SKU/,/ATS*\sATP\s*QTY\z/])
 Use the ``:clean`` option to strip out control characters and surrounding white space.
 
 ```ruby
-sheet.parse(:clean => true)
+sheet.parse(clean: true)
 ```
 
 ### Exporting spreadsheets
@@ -143,7 +140,7 @@ sheet.to_xml
 sheet.to_yaml
 ```
 
-### Excel (xlsx) Support
+### Excel (xlsx and xlsm) Support
 
 Stream rows from an Excelx spreadsheet.
 
@@ -154,6 +151,26 @@ xlsx.each_row_streaming do |row|
 end
 ```
 
+By default blank cells will be excluded from the array. To keep them, use the option pad_cells = true. (They will be set to nil in the array)
+```ruby
+xlsx.each_row_streaming(pad_cells: true) do |row|
+  puts row.inspect # Array of Excelx::Cell objects
+end
+```
+
+To stream only some of the rows, you can use the ```max_rows``` and ```offset```options.
+```ruby
+xlsx.each_row_streaming(offset: 1) do |row| # Will exclude first (inevitably header) row
+  puts row.inspect # Array of Excelx::Cell objects
+end
+```
+
+```ruby
+xlsx.each_row_streaming(max_rows: 3) do |row| # Will yield 4 rows (it's automatically incremented by 1) after the supplied offset.
+  puts row.inspect # Array of Excelx::Cell objects
+end
+```
+
 Iterate over each row
 
 ```ruby
@@ -172,6 +189,9 @@ xlsx.cell(3, 'C')
 # => 600000383.0
 
 xlsx.excelx_value(row,col)
+# => '600000383'
+
+xlsx.formatted_value(row,col)
 # => '0600000383'
 ```
 
@@ -185,11 +205,11 @@ xlsx.formula('A', 2)
 
 ### OpenOffice / LibreOffice Support
 
-Roo::OpenOffice supports for encrypted OpenOffice spreadsheets.
+Roo::OpenOffice has support for encrypted OpenOffice spreadsheets.
 
 ```ruby
 # Load an encrypted OpenOffice Spreadsheet
-ods = Roo::OpenOffice.new("myspreadsheet.ods", :password => "password")
+ods = Roo::OpenOffice.new("myspreadsheet.ods", password: "password")
 ```
 
 ``Roo::OpenOffice`` can access celltype, comments, font information, formulas and labels.
@@ -213,7 +233,7 @@ ods.formula('A', 2)
 s = Roo::CSV.new("mycsv.csv")
 ```
 
-Because Roo uses the [standard CSV library](), and you can use options available to that library to parse csv files. You can pass options using the ``csv_options`` key.
+Because Roo uses the [standard CSV library](), you can use options available to that library to parse csv files. You can pass options using the ``csv_options`` key.
 
 For instance, you can load tab-delimited files (``.tsv``), and you can use a particular encoding when opening the file.
 
@@ -236,10 +256,24 @@ Roo's public methods have stayed relatively consistent between 1.13.x and 2.0.0,
 ## Contributing
 ### Features
 1. Fork it ( https://github.com/[my-github-username]/roo/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'My new feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+2. Install it (`bundle install --with local_development`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'My new feature'`)
+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.
+
+You can run the tests/examples with Rspec like reporters by running
+`USE_REPORTERS=true bundle exec rake`
+
+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
 

data/Rakefile

@@ -7,7 +7,7 @@ require 'coveralls/rake/task'
 # Test unit
 Rake::TestTask.new do |t|
   t.libs << 'test'
-  t.test_files = FileList['test/test*.rb']
+  t.test_files = FileList['test/**/test*.rb']
   t.verbose = true
 end