pluck_each 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a53f3851ce03e4a77c7900b6d2f7577e62803a12
+  data.tar.gz: 35a28d803fcf5f219d3927f80140804b86e56b34
+SHA512:
+  metadata.gz: 5dc272f28fd7ae2019dce19e1c01ca473e9fa3c17044ed9a9c893a92fbf112052129f865819603d9f8ecf7c72518c194724dba64867790a1ce61b527c82e6653
+  data.tar.gz: 1fb026a0c2c70bc0e38e05e9e3ea9f3539c81436d8474ae2ffb931824012ee61095c34f841337acd9e1d41f270a9df4d67a485b1443013fbd3d412b780249498

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/test.db
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.ruby-*
+mkmf.log

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_each.gemspec
+gemspec
+
+platforms :ruby do
+  gem "sqlite3"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brandon Dewitt
+
+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,47 @@
+# PluckEach
+
+ActiveRecord comes with find_each and find_in_batches to batch process records from a database.
+ActiveRecord also has the method `pluck` which allows the selection of a single field without pulling the entire record into memory.
+
+This gem combines these ideas and provides `pluck_each` and `pluck_in_batches` to allow batch processing of plucked fields from the db.
+
+```ruby
+  #
+  # User.create(:first_name => "name1")
+  # User.create(:first_name => "name2")
+  # User.create(:first_name => "name3")
+  # User.create(:first_name => "name4")
+  # User.create(:first_name => "name5")
+  #
+
+User.all.pluck(:first_name) # => ["name1", "name2", "name3", "name4", "name5"]
+
+# If the table is large you would want to "page" over these values
+User.all.pluck_each(:first_name, :batch_size => 2) do |first_name| # default batch_size is 1000
+  # do something with first_name
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pluck_each'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pluck_each
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pluck_each/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "spec"
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = true
+end
+
+task :spec => :test
+task :default => :spec

data/lib/pluck_each.rb

@@ -0,0 +1,45 @@
+require "pluck_each/version"
+require "active_record"
+require "active_support/core_ext/array/extract_options"
+
+module PluckEach
+end
+
+module ActiveRecord
+  module Batches
+
+    def pluck_each(*args)
+      pluck_in_batches(*args) do |values|
+        values.each { |value| yield value }
+      end
+    end
+
+    def pluck_in_batches(*args)
+      options = args.extract_options!
+      relation = self
+      batch_size = options[:batch_size] || 1000
+      offset = 0
+
+      relation = relation.reorder(pluck_batch_order).offset(offset).limit(batch_size)
+      records = relation.pluck(*args)
+
+      while records.any?
+        records_size = records.size
+        offset += records_size
+        break if records_size <= 0
+
+        yield records
+
+        break if records_size < batch_size
+        records = relation.offset(offset).limit(batch_size).pluck(*args)
+      end
+    end
+
+    private
+
+    def pluck_batch_order
+      "#{quoted_table_name}.#{quoted_primary_key} ASC"
+    end
+
+  end
+end

data/lib/pluck_each/version.rb

@@ -0,0 +1,3 @@
+module PluckEach
+  VERSION = "0.0.1"
+end

data/pluck_each.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pluck_each/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pluck_each"
+  spec.version       = PluckEach::VERSION
+  spec.authors       = ["Brandon Dewitt"]
+  spec.email         = ["brandonsdewitt@gmail.com"]
+  spec.summary       = %q{ pluck_each and plucK_in_batches ... should behave like find_each and find_in_batches }
+  spec.description   = %q{ pluck_each and plucK_in_batches ... should behave like find_each and find_in_batches }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "activerecord", "> 3.2.0"
+  spec.add_dependency "activesupport", "> 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/pluck_each_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'pry'
+
+describe PluckEach do
+  File.delete(File.expand_path(File.dirname(__FILE__) + "/test.db")) rescue nil
+
+  ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database => "spec/test.db"
+  )
+  load_schema
+
+  describe 'API' do
+    it 'adds pluck_each to Arel relation nodes' do
+      User.all.must_respond_to :pluck_each
+    end
+
+    it 'adds pluck_in_batches to Arel relation nodes' do
+      User.all.must_respond_to :pluck_in_batches
+    end
+  end
+
+  describe 'pluck_each' do
+    before do
+      User.delete_all
+      User.create(:first_name => '1', :last_name => '1')
+      User.create(:first_name => '2', :last_name => '2')
+      User.create(:first_name => '3', :last_name => '3')
+      User.create(:first_name => '4', :last_name => '4')
+      User.create(:first_name => '5', :last_name => '5')
+    end
+
+    it 'plucks only the fields requested' do
+      values = []
+      User.all.pluck_each(:first_name) do |first_name|
+        values << first_name
+      end
+
+      values.sort!
+      values.must_equal ['1', '2', '3', '4', '5']
+    end
+
+    it 'allows batch_size in options to determine batch size' do
+      count = 0 
+      values = []
+      User.all.pluck_each(:first_name, :batch_size => 1) do |first_name|
+        values << first_name
+        count += 1
+      end
+
+      count.must_equal(5)
+      values.sort!
+      values.must_equal ['1', '2', '3', '4', '5']
+    end
+  end
+
+  describe 'pluck_in_batches' do
+    before do
+      User.delete_all
+      User.create(:first_name => '1', :last_name => '1')
+      User.create(:first_name => '2', :last_name => '2')
+      User.create(:first_name => '3', :last_name => '3')
+      User.create(:first_name => '4', :last_name => '4')
+      User.create(:first_name => '5', :last_name => '5')
+    end
+
+    it 'allows batch_size in options to determine batch size' do
+      batch_sizes = []
+      User.all.pluck_in_batches(:first_name, :batch_size => 2) do |first_names|
+        batch_sizes << first_names.size
+      end
+
+      batch_sizes.sort!
+      batch_sizes.must_equal [1, 2, 2]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :development, :test)
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/api'
+
+class User < ActiveRecord::Base
+  has_many :products
+end
+
+class Product < ActiveRecord::Base
+  belongs_to :user
+end
+
+ActiveRecord::Schema.verbose = false
+
+def configure_database(config)
+  @database_config = config
+end
+
+def load_schema
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :users do |t|
+      t.string :first_name
+      t.string :last_name
+    end
+
+    create_table :products do |t|
+      t.string :name
+      t.integer :value
+      t.boolean :available, :default => true
+      t.belongs_to :user
+    end
+  end
+end
+
+def recreate_database(database)
+  ActiveRecord::Base.establish_connection(@database_config)
+  ActiveRecord::Base.connection.drop_database(database) rescue nil
+  ActiveRecord::Base.connection.create_database(database)
+  ActiveRecord::Base.establish_connection(@database_config.merge(:database => database))
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: pluck_each
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Dewitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-05 00:00:00.000000000 Z
+dependencies:
+- !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.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: mocha
+  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: pry
+  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: 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'
+description: " pluck_each and plucK_in_batches ... should behave like find_each and
+  find_in_batches "
+email:
+- brandonsdewitt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pluck_each.rb
+- lib/pluck_each/version.rb
+- pluck_each.gemspec
+- spec/pluck_each_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: pluck_each and plucK_in_batches ... should behave like find_each and find_in_batches
+test_files:
+- spec/pluck_each_spec.rb
+- spec/spec_helper.rb