postgresql_cursor 0.4.2 → 0.4.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7761053fbe88cc359b47415f7e79b620defe326
+  data.tar.gz: 8398abd146476cc6ddfa637e3d5215fcc446be38
+SHA512:
+  metadata.gz: 18ebbe7bfa3fdee1435909725be137bf7b895f55f3ad87620a5486697fa67f06afab79d117945643ecbe2e4b1f7e6d6c6e30364358763429beb2c720cfe1d9fe
+  data.tar.gz: 482aeffdbe884a29ca1e05b8a860e897845c9cc86d134c4512475c2039c5f448c2585298c444f89a0afd4f4b781bd4b3221c2deccb321eba6b68f1d178abe49e

data/README.rdoc

@@ -1,8 +1,12 @@
 = PostgreSQLCursor for handling large Result Sets
 
+{<img src="https://badge.fury.io/rb/postgresql_cursor.svg" alt="Gem Version" />}[http://badge.fury.io/rb/postgresql_cursor]
+
 PostgreSQLCursor extends ActiveRecord to allow for efficient processing of queries
 returning a large number of rows.
 
+Note: Rails/ActiveRecord 4.x support has been reworked in the v0.5 Branch. For AR < 4.x, use the gem 0.4.x series.
+
 == Why use this?
 
 ActiveRecord is designed and optimized for web performance. In a web transaction, only a "page" of
@@ -11,10 +15,10 @@ around 20 rows is returned to the user. When you do this
   Model.find(:all, :conditions=>["id>0"]
 
 The database returns all matching result set rows to ActiveRecord, which instantiates each row with
-the data returned. This function returns an array of all these rows to the caller. 
+the data returned. This function returns an array of all these rows to the caller.
 
 Asyncronous, Background, or Offline processing may require processing a large amount of data.
-When there is a very large number of rows, this requires a lot more memory to hold the data. Ruby 
+When there is a very large number of rows, this requires a lot more memory to hold the data. Ruby
 does not return that memory after processing the array, and the causes your process to "bloat". If you
 don't have enough memory, it will cause an exception.
 
@@ -44,7 +48,7 @@ to declare a cursor to run a given query returning "chunks" of rows to the appli
 retaining the position of the full result set in the database. This overcomes all the disadvantages
 of using find_each and find_in_batches.
 
-Also, with PostgreSQL, you have on option to have raw hashes of the row returned instead of the 
+Also, with PostgreSQL, you have on option to have raw hashes of the row returned instead of the
 instantiated models. An informal benchmark showed that returning instances is a factor of 4 times
 slower than returning hashes. If you are can work with the data in this form, you will find better
 performance.
@@ -54,7 +58,7 @@ With PostgreSQL, you can work with cursors as follows:
   Model.where("id>0").each_row { |hash| Model.process(hash) }
 
   Model.where("id>0").each_instance { |model| model.process! }
-  Model.where("id>0").each_instance(buffer_size:100000) { |model| model.process! }
+  Model.where("id>0").each_instance(block_size:100000) { |model| model.process! }
 
   Model.each_row_by_sql("select * from models") { |hash| Model.process(hash) }
 
@@ -62,7 +66,7 @@ With PostgreSQL, you can work with cursors as follows:
 
 All these methods take an options hash to control things more:
 
-  buffer_size:n     The number of rows to fetch from the database each time (default 1000)
+  block_size:n      The number of rows to fetch from the database each time (default 1000)
   while:value       Continue looping as long as the block returns this value
   until:value       Continue looping until the block returns this value
   connection:conn   Use this connection instead of the current model connection
@@ -79,7 +83,7 @@ Thank you to:
 * Julian Mehnle, julian@mehnle.net (Suggestions)
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.4.3

data/lib/postgresql_cursor.rb

@@ -65,8 +65,9 @@ class PostgreSQLCursor
           break if has_do_while && rc != @options[:while]
         end
       rescue Exception => e
-        close
         raise e
+      ensure
+        close
       end
     end
     @count
@@ -89,7 +90,7 @@ class PostgreSQLCursor
   end
 
   # Private: Fetches the next block of rows into @block
-  def fetch_block(block_size=nil)
+  def  fetch_block(block_size=nil)
     block_size ||= @block_size ||= @options.fetch(:block_size) { 1000 }
     @result = @connection.execute("fetch #{block_size} from cursor_#{@cursor}")
     @block = @result.collect {|row| row } # Make our own
@@ -116,7 +117,6 @@ end
 
 # Defines extension to ActiveRecord to use this library
 class ActiveRecord::Base
-  
   # Public: Returns each row as a hash to the given block
   #
   # sql         - Full SQL statement, variables interpolated
@@ -128,6 +128,7 @@ class ActiveRecord::Base
   #
   # Returns the number of rows yielded to the block
   def self.each_row_by_sql(sql, options={}, &block)
+    options = {:connection => self.connection}.merge(options)
     PostgreSQLCursor.new(sql, options).each(&block)
   end
 
@@ -138,6 +139,7 @@ class ActiveRecord::Base
   #
   # Returns the number of rows yielded to the block
   def self.each_instance_by_sql(sql, options={}, &block)
+    options = {:connection => self.connection}.merge(options)
     PostgreSQLCursor.new(sql, options).each do |row|
       model = instantiate(row)
       yield model
@@ -159,7 +161,8 @@ class ActiveRecord::Relation
   #
   # Returns the number of rows yielded to the block
   def each_row(options={}, &block)
-    PostgreSQLCursor.new(to_sql).each(&block)
+    options = {:connection => self.connection}.merge(options)
+    PostgreSQLCursor.new(to_sql, options).each(&block)
   end
 
   # Public: Like each_row, but returns an instantiated model object to the block
@@ -168,9 +171,10 @@ class ActiveRecord::Relation
   #
   # Returns the number of rows yielded to the block
   def each_instance(options={}, &block)
+    options = {:connection => self.connection}.merge(options)
     PostgreSQLCursor.new(to_sql, options).each do |row|
       model = instantiate(row)
-      yield model
+      block.call model
     end
   end
 end

data/postgresql_cursor.gemspec

@@ -2,14 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: postgresql_cursor 0.4.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "postgresql_cursor"
-  s.version = "0.4.2"
+  s.version = "0.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Allen Fair"]
-  s.date = "2013-02-20"
+  s.date = "2014-06-06"
   s.description = "PostgreSQL Cursor is an extension to the ActiveRecord PostgreSQLAdapter for very large result sets. It provides a cursor open/fetch/close interface to access data without loading all rows into memory, and instead loads the result rows in \"chunks\" (default of 10_000 rows), buffers them, and returns the rows one at a time."
   s.email = "allen.fair@gmail.com"
   s.extra_rdoc_files = [
@@ -28,12 +30,11 @@ Gem::Specification.new do |s|
     "test/test_postgresql_cursor.rb"
   ]
   s.homepage = "http://github.com/afair/postgresql_cursor"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "2.2.1"
   s.summary = "ActiveRecord PostgreSQL Adapter extension for using a cursor to return a large result set"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activerecord>, [">= 0"])

data/test/helper.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'test/unit'
+require 'minitest'
 require 'active_record'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -21,5 +21,5 @@ end
 
 Model.generate(1000) if Model.count == 0
 
-class Test::Unit::TestCase
+class MiniTest::Unit::TestCase
 end

data/test/test_postgresql_cursor.rb

@@ -1,6 +1,8 @@
 require 'helper'
+# database: allen_test
+# create table records ( id serial);
 
-class TestPostgresqlCursor < Test::Unit::TestCase
+class TestPostgresqlCursor < Minitest::Test
 
   def test_each
     c = PostgreSQLCursor.new("select * from records order by 1")

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: postgresql_cursor
 version: !ruby/object:Gem::Version
-  version: 0.4.2
-  prerelease: 
+  version: 0.4.3
 platform: ruby
 authors:
 - Allen Fair
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: PostgreSQL Cursor is an extension to the ActiveRecord PostgreSQLAdapter
@@ -38,7 +35,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files:
-- .document
+- ".document"
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -49,27 +46,26 @@ files:
 - test/test_postgresql_cursor.rb
 homepage: http://github.com/afair/postgresql_cursor
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ActiveRecord PostgreSQL Adapter extension for using a cursor to return a
   large result set
 test_files: []