spreadsheet_stream_reader 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08ec0153a1bb700d633a0849ffa0cd1d01a9e3a5
-  data.tar.gz: f2ac037707850c9d7c77c9898c641e3cab4c98aa
+  metadata.gz: 4645b2f23a11e836905f2d3d93aa797081a10498
+  data.tar.gz: 0408bb2f3731df578dead03a427d3ad8b54e04da
 SHA512:
-  metadata.gz: 04bee6a44ca78c9b22d3ac0bf112ff990e5a94207e3e1cb79afebe0057d49ded25f5efc8425ddaefed937ca6d8af30b53820e532ebeb25217f44da47c5b8db84
-  data.tar.gz: 359308722a9ad5b05dff8412301fb3df9e4eae91a514dc48cb8289e7219c81998d6c6f8c379f3a485540dd56179df1e7bab331ea029a3d315bf1c0bfa116d252
+  metadata.gz: 070deb75a3c3986701de43609dd34aecad083eecb37d0c94910c28f2791778f74a16a7c88ce7a1f7c3a93defa7e4ac7ede320410ae87b2b0caf7dad1d0468e30
+  data.tar.gz: cd699ac31811b634d1aa8eb1afca045262473b806d281961b378c1dc18c792bb2058d1a45e43c9b5d89c7834e6aa49def74927a5ad1991a8abc960f51c9f9635

data/README.md

@@ -1,8 +1,8 @@
 # SpreadsheetStreamReader
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/spreadsheet_stream_reader`. To experiment with that code, run `bin/console` for an interactive prompt.
+Memory efficient spreadsheet reader. It reads file in streaming fashion. Currently supports Excel legacy file (.xls) format. Work in progress for other file formats.
 
-TODO: Delete this and the text above, and describe your gem
+You can configure the batch size. It will read and streams the batch size rows at a time.
 
 ## Installation
 
@@ -22,7 +22,50 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Opening a spreadsheet
+
+```ruby
+require 'spreadsheet_stream_reader'
+
+records_per_batch = 100 #By default its 1000. You will get this much records at a time.
+
+document = SpreadsheetStreamReader::Reader.new('/path/to/workbook.xls', records_per_batch)
+```
+
+#### Working with sheets
+
+```ruby
+# Returns an array of names of sheets present in the workbook
+document.sheet_names
+# => ["K-Sheet-1", "K-Sheet-22"]
+
+
+## Access the sheet
+# By name
+sheet1 = document.get_sheet('K-Sheet-1')
+# By index
+sheet2 = document.get_sheet(1)
+
+# => Returns the SpreadsheetStreamReader::Sheet object
+```
+
+#### Iterate through single sheet
+
+```ruby
+sheet1.stream_rows_in_batch do |row|
+  puts row #Work with the row data
+end
+```
+
+#### Iterate through workbook (all sheets in workbook)
+
+```ruby
+document.each_sheet do |sheet|
+  sheet.stream_rows_in_batch do |row|
+    puts row #Work with the row data
+  end
+end
+```
 
 ## Development
 
@@ -32,7 +75,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/spreadsheet_stream_reader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ketandoshi/spreadsheet-stream-reader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +83,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the SpreadsheetStreamReader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/spreadsheet_stream_reader/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SpreadsheetStreamReader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ketandoshi/spreadsheet-stream-reader/blob/master/CODE_OF_CONDUCT.md).

data/lib/spreadsheet_stream_reader/version.rb

@@ -1,3 +1,3 @@
 module SpreadsheetStreamReader
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spreadsheet_stream_reader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ketan Doshi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler