spreadsheet_stream_reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08ec0153a1bb700d633a0849ffa0cd1d01a9e3a5
+  data.tar.gz: f2ac037707850c9d7c77c9898c641e3cab4c98aa
+SHA512:
+  metadata.gz: 04bee6a44ca78c9b22d3ac0bf112ff990e5a94207e3e1cb79afebe0057d49ded25f5efc8425ddaefed937ca6d8af30b53820e532ebeb25217f44da47c5b8db84
+  data.tar.gz: 359308722a9ad5b05dff8412301fb3df9e4eae91a514dc48cb8289e7219c81998d6c6f8c379f3a485540dd56179df1e7bab331ea029a3d315bf1c0bfa116d252

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ketan@fab.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in spreadsheet_stream_reader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ketan Doshi
+
+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,43 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spreadsheet_stream_reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spreadsheet_stream_reader
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spreadsheet_stream_reader"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/spreadsheet_stream_reader.rb

@@ -0,0 +1,51 @@
+require 'spreadsheet_stream_reader/version'
+require 'spreadsheet_stream_reader/book_reader'
+require 'spreadsheet_stream_reader/sheet'
+
+module SpreadsheetStreamReader
+  class InvalidParameterError < StandardError; end
+
+  class Reader
+    attr_accessor :file_path, :batch_size, :data
+
+    VALID_FILE_EXTS = %w(.xls)
+
+    def initialize(file_path, batch_size = 1000)
+      raise InvalidParameterError,
+            "File extension should be one of the: #{VALID_FILE_EXTS}" unless VALID_FILE_EXTS.include?(File.extname(file_path.to_s))
+
+      self.file_path = file_path.to_s
+      self.batch_size = batch_size
+      self.data = Array.new
+    end
+
+    def sheet_names
+      sheets.collect{|s| s.name}
+    end
+
+    def get_sheet(idx_or_name)
+      Sheet.new(book_reader.get_work_sheet(idx_or_name), @batch_size)
+    end
+
+    def each_sheet
+      sheet_names.each do |name|
+        yield get_sheet(name)
+      end
+    end
+
+    private
+
+    def book
+      @book ||= book_reader.open_book
+    end
+
+    def sheets
+      @work_sheets ||= book_reader.get_work_sheets
+    end
+
+    def book_reader
+      @book_reader ||= BookReader.new(@file_path)
+    end
+  end
+
+end

data/lib/spreadsheet_stream_reader/book_reader.rb

@@ -0,0 +1,31 @@
+require 'spreadsheet'
+
+module SpreadsheetStreamReader
+
+  class BookReader
+    attr_accessor :file_path, :file_ext
+
+    def initialize(file_path)
+      self.file_path = file_path.to_s
+      self.file_ext = File.extname(file_path.to_s).downcase
+    end
+
+    def open_book
+      @open_book ||= case @file_ext
+        when '.xls'
+          Spreadsheet.open(@file_path)
+        else
+          nil
+      end
+    end
+
+    def get_work_sheets
+      open_book.worksheets
+    end
+
+    def get_work_sheet(idx_or_name)
+      open_book.worksheet(idx_or_name)
+    end
+  end
+
+end

data/lib/spreadsheet_stream_reader/sheet.rb

@@ -0,0 +1,73 @@
+module SpreadsheetStreamReader
+
+  class Sheet
+    attr_accessor :batch_size, :offset, :counter, :data, :w_sheet
+
+    def initialize(_sheet, batch_size = 1000)
+      self.batch_size = batch_size
+      self.offset = 1
+      self.counter = 0
+      self.data = Array.new
+      self.w_sheet = _sheet
+    end
+
+    def stream_rows_in_batch
+      if block_given?
+        while offset < max_record
+          get_content_in_chunks
+
+          @data.each do |row|
+            yield row
+          end
+
+          increment_offset
+        end
+      else
+        get_content_in_chunks
+        increment_offset
+        @data
+      end
+    end
+
+    def get_content_in_chunks
+      clear_data
+
+      sheet.each @offset do |row|
+        increment_counter
+        @data << row[0..(row.size - 1)]
+        break if reached_batch_size? || reached_end_of_file?
+      end
+    end
+
+    private
+
+    def sheet
+      @w_sheet
+    end
+
+    def max_record
+      @max_record ||= sheet.last_row_index
+    end
+
+    def increment_counter
+      @counter += 1
+    end
+
+    def increment_offset
+      @offset += @batch_size
+    end
+
+    def reached_batch_size?
+      (counter % @batch_size).zero?
+    end
+
+    def reached_end_of_file?
+      counter == max_record
+    end
+
+    def clear_data
+      @data.clear
+    end
+  end
+
+end

data/lib/spreadsheet_stream_reader/version.rb

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

data/spreadsheet_stream_reader.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spreadsheet_stream_reader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'spreadsheet_stream_reader'
+  spec.version       = SpreadsheetStreamReader::VERSION
+  spec.authors       = ['Ketan Doshi']
+  spec.email         = ['ketandoshi81@gmail.com']
+
+  spec.summary       = %q{Memory efficient spreadsheet reader.}
+  spec.description   = %q{Memory efficient spreadsheet reader. It reads file in streaming fashion. Currently supports Excel legacy file (.xls) format. Work in progress for other file formats.}
+  spec.homepage      = 'https://github.com/ketandoshi/spreadsheet-stream-reader'
+  spec.license       = 'MIT'
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'spreadsheet', '~> 1.1', '>= 1.1.5'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: spreadsheet_stream_reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ketan Doshi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+description: Memory efficient spreadsheet reader. It reads file in streaming fashion.
+  Currently supports Excel legacy file (.xls) format. Work in progress for other file
+  formats.
+email:
+- ketandoshi81@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/spreadsheet_stream_reader.rb
+- lib/spreadsheet_stream_reader/book_reader.rb
+- lib/spreadsheet_stream_reader/sheet.rb
+- lib/spreadsheet_stream_reader/version.rb
+- spreadsheet_stream_reader.gemspec
+homepage: https://github.com/ketandoshi/spreadsheet-stream-reader
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Memory efficient spreadsheet reader.
+test_files: []