dm-chunked_query 0.2.1 → 0.3.0

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.3.0 / 2011-05-16
+
+* Added {DataMapper::ChunkedQuery::Mixin#each_slice} which calls
+  {DataMapper::ChunkedQuery::Mixin#each_chunk}.
+* Added {DataMapper::ChunkedQuery::Mixin#batch}.
+
 ### 0.2.1 / 2011-05-02
 
 * Fixed a typo in {DataMapper::ChunkedQuery::Mixin#each_chunk}.

data/README.md

@@ -22,7 +22,7 @@ Enumerate over all chunks, 20 resources per-chunk:
 
     require 'dm-chunked_query'
 
-    MyModel.each_chunk(20).each do |chunk|
+    MyModel.each_chunk(20) do |chunk|
       chunk.each do |resource|
         # ...
       end
@@ -32,6 +32,12 @@ Get the 5th chunk, containing 10 resources:
 
     MyModel.all(:foo => 'bar').chunks(10)[5]
 
+Process records in batches:
+
+    MyModel.batch(100) do |resource|
+      # ...
+    end
+
 ## Requirements
 
 * [dm-core](http://github.com/datamapper/dm-core#readme) ~> 1.0

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: dm-chunked_query
-version: 0.2.1
+version: 0.3.0
 summary: Allows performing chunked queries with DataMapper.
 description:
   Allows performing chunked queries on DataMapper Models or Collections.

data/lib/dm-chunked_query/mixin.rb

@@ -45,6 +45,39 @@ module DataMapper
       def each_chunk(per_chunk,&block)
         chunks(per_chunk).each(&block)
       end
+
+      #
+      # @see each_chunk
+      #
+      # @since 0.3.0
+      #
+      def each_slice(per_chunk,&block)
+        each_chunk(per_chunk,&block)
+      end
+
+      #
+      # Reads in records in batches and processes them.
+      #
+      # @param [Integer] per_batch
+      #   The number of resources per-batch.
+      #
+      # @yield [resource]
+      #   The given block will be passed each resource from each batch
+      #   of resources.
+      #
+      # @yieldparam [DataMapper::Resource] resource
+      #   A resource from the batch.
+      #
+      # @return [Chunks]
+      #   The abstract collection of chunks from the query.
+      #
+      # @see #each_chunk
+      #
+      # @since 0.3.0
+      #
+      def batch(per_batch,&block)
+        each_chunk(per_batch) { |chunk| chunk.each(&block) }
+      end
     end
   end
 end

data/spec/chunked_query_spec.rb

@@ -1,11 +1,29 @@
 require 'spec_helper'
 
 describe DataMapper::ChunkedQuery do
+  subject { TestModel }
+
   it "should allow chunked queries directly from Models" do
-    TestModel.chunks(1).length.should == 100
+    subject.chunks(1).length.should == 100
   end
 
   it "should allow chunked queries from other queries" do
-    TestModel.all(:number.lte => 50).chunks(1).length.should == 50
+    subject.all(:number.lte => 50).chunks(1).length.should == 50
+  end
+
+  it "should allow iterating over every resource" do
+    count = 0
+
+    subject.each_chunk(2) { |chunk| count += chunk.length }
+
+    count.should == 100
+  end
+
+  it "should allow processing records in batch" do
+    count = 0
+
+    subject.batch(2) { |resource| count += 1 }
+
+    count.should == 100
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: dm-chunked_query
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Postmodern
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 Z
+date: 2011-05-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: dm-core
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dm-chunked_query
-rubygems_version: 1.7.2
+rubygems_version: 1.8.1
 signing_key: 
 specification_version: 3
 summary: Allows performing chunked queries with DataMapper.