activerecord-stream 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf405467f9cb3c18ceaba65b4023e89d60ccea1f
+  data.tar.gz: 51130ccf858bbda74eeb6545ca5803e13e163f9d
+SHA512:
+  metadata.gz: c3d9edf0589f1a9948d483d57e6152ba4d5924a50c0e7b625c7c2b3488d9ec3fa35331c5ec37bc669c280460747fc41137fb0385d2c46fd76bd8b45dbb059cf1
+  data.tar.gz: 1c769ccf0a5abdb0e451957dd951fd5b3fc3450f7f0458f8d946f1888e329d5f11de2050a000e8655b11ba44e8a56159ea3552ad6827e71d99cd77224dc09cf9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-stream.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Scott Fleckenstein
+
+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,48 @@
+# Activerecord::Stream
+
+Enables lazy-ish, Enumerator based traversal of data within ActiveRecord.
+
+NOTE: yes, this uses an inefficient paging mechanism (offset/limit) that will get progressively
+slower with each batch load.  A future goal is to provide a pluggable paging mechanism to compensate,
+allowing the integrating developer to choose a more efficient method when the schema and query allows.
+
+Offset/limit is the very flexible method for streaming but is susceptible to [Schlemiel the Painter's algorithm](http://en.wikipedia.org/wiki/Joel_Spolsky#Schlemiel_the_Painter.27s_algorithm).  As you get deaper into the stream, performance per batch will decrease.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-stream'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-stream
+
+## Usage
+
+```ruby
+
+# get an enumerator
+users = User.order("id desc").stream
+
+
+users.next # => #<User:...>
+# The preceding call loads a batch of records
+# User Load (330.4ms)  SELECT "users".* FROM "users" ORDER BY id desc LIMIT 500 OFFSET 0
+user.next # =>  #<User:...>
+# No DB load happens until we exhaust the batch loaded in the previous call
+
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord-stream.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/stream/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-stream"
+  spec.version       = ActiveRecord::Stream::VERSION
+  spec.authors       = ["Scott Fleckenstein"]
+  spec.email         = ["nullstyle@gmail.com"]
+  spec.description   = %q{lazy-ish, Enumerator based traversal of data within ActiveRecord}
+  spec.summary       = %q{lazy-ish, Enumerator based traversal of data within ActiveRecord}
+  spec.homepage      = "https://github.com/nullstyle/activerecord-stream"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+
+  spec.add_dependency "activerecord", ">= 3.2.0"
+  spec.add_dependency "activesupport", ">= 3.2.0"
+end

data/lib/activerecord/stream.rb

@@ -0,0 +1,39 @@
+require "activerecord/stream/version"
+require 'core_ext/enumerator/take'
+require 'core_ext/enumerator/drop'
+require 'core_ext/enumerator/filter'
+
+module ActiveRecord
+  module Stream
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def stream(options={})
+        offset = options[:start] || 0
+        batch_size = options[:batch_size] || 500
+        scope = respond_to?(:scoped) ? scoped : all
+
+        Enumerator.new do |yielder|
+          loop do
+            current_batch = load_batch(scope, batch_size, offset)
+            current_batch.each{|r| yielder << r}
+
+            break if current_batch.length < batch_size
+            offset += batch_size
+          end
+        end
+      end
+
+      private
+      def load_batch(scope, limit, offset)
+        scope.limit(limit).offset(offset).to_a
+      end
+
+    end
+
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::Stream)
+ActiveRecord::Relation.send(:include, ActiveRecord::Stream)

data/lib/activerecord/stream/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Stream
+    VERSION = "0.0.1"
+  end
+end

data/lib/core_ext/enumerator/drop.rb

@@ -0,0 +1,9 @@
+module Enumerator::Drop
+  def drop(count)
+    count.times{ self.next }
+  rescue StopIteration
+    ; # noop
+  end
+end
+
+Enumerator.send(:include, Enumerator::Drop)

data/lib/core_ext/enumerator/filter.rb

@@ -0,0 +1,27 @@
+module Enumerator::Filter
+  def select(&block)
+    filter(true, &block)
+  end
+
+  def reject(&block)
+    filter(false, &block)
+  end
+
+  private
+  def filter(filter_val, &block)
+    Enumerator.new do |yielder|
+
+      begin
+        loop do
+          val = self.next
+          should_yield = block.call(val) == filter_val
+          yielder << val if should_yield
+        end
+      rescue StopIteration
+      end
+    end
+  end
+
+end
+
+Enumerator.send(:include, Enumerator::Filter)

data/lib/core_ext/enumerator/take.rb

@@ -0,0 +1,13 @@
+module Enumerator::Take
+  def take(count)
+    result = []
+    count.times do
+      result << self.next
+    end
+    result
+  rescue StopIteration
+    result
+  end
+end
+
+Enumerator.send(:include, Enumerator::Take)

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-stream
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Scott Fleckenstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: lazy-ish, Enumerator based traversal of data within ActiveRecord
+email:
+- nullstyle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-stream.gemspec
+- lib/activerecord/stream.rb
+- lib/activerecord/stream/version.rb
+- lib/core_ext/enumerator/drop.rb
+- lib/core_ext/enumerator/filter.rb
+- lib/core_ext/enumerator/take.rb
+homepage: https://github.com/nullstyle/activerecord-stream
+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.2.2
+signing_key: 
+specification_version: 4
+summary: lazy-ish, Enumerator based traversal of data within ActiveRecord
+test_files: []