dm-chunked_query 0.1.2 → 0.2.0

data/ChangeLog.md

@@ -1,3 +1,8 @@
+### 0.2.0 / 2011-04-19
+
+* Added {DataMapper::ChunkedQuery::Chunks#first}.
+* Added {DataMapper::ChunkedQuery::Mixin#each_chunk}.
+
 ### 0.1.2 / 2011-03-03
 
 * Fixed a typo in {DataMapper::ChunkedQuery::Chunks#[]}.

data/gemspec.yml

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

data/lib/dm-chunked_query/chunks.rb

@@ -30,9 +30,8 @@ module DataMapper
       # @param [Range<Integer>, Integer] key
       #   The index or range of indices to access.
       #
-      # @return [DataMapper::Collection, nil]
+      # @return [DataMapper::Collection]
       #   A collection of resources at the given index or indices.
-      #   If the index is out of bounds, `nil` will be returned.
       #
       def [](key)
         case key
@@ -52,14 +51,35 @@ module DataMapper
       # @param [#to_i] index
       #   The index to access.
       #
-      # @return [DataMapper::Collection, nil]
-      #   The chunk of resources at the given index. If the index is out of
-      #   bounds, `nil` will be returned.
+      # @return [DataMapper::Collection]
+      #   The chunk of resources at the given index.
       #
       def at(index)
         chunk_at(index.to_i)
       end
 
+      #
+      # Returns the first chunk(s).
+      #
+      # @param [Integer] n
+      #   The number of sub-chunks to include.
+      #
+      # @return [DataMapper::Collection]
+      #   The first chunk of resources.
+      #
+      # @raise [ArgumentError]
+      #   The number of sub-chunks was negative.
+      #
+      # @since 0.2.0
+      #
+      def first(n=1)
+        if n >= 0
+          chunk_at(0,n)
+        else
+          raise(ArgumentError,"negative array size")
+        end
+      end
+
       #
       # Enumerates over each chunk in the collection of Chunks.
       #
@@ -75,7 +95,7 @@ module DataMapper
       def each
         return enum_for(:each) unless block_given?
 
-        (0...length).each do |index|
+        length.times do |index|
           yield chunk_at(index)
         end
 
@@ -119,9 +139,7 @@ module DataMapper
       #   The collection of resources that makes up the chunk.
       #
       def chunk_at(index,span=1)
-        if (index >= 0 && index < length)
-          @query[(index * @per_chunk), (span * @per_chunk)]
-        end
+        @query[(index * @per_chunk), (span * @per_chunk)]
       end
 
     end

data/lib/dm-chunked_query/mixin.rb

@@ -15,6 +15,34 @@ module DataMapper
       def chunks(per_chunk)
         Chunks.new(self,per_chunk)
       end
+
+      #
+      # @see chunks
+      #
+      def chunks_of(per_chunk)
+        chunks(per_chunk)
+      end
+
+      #
+      # Enumerate over every chunk.
+      #
+      # @param [Integer] per_chunk
+      #   The number of resources per-chunk.
+      #
+      # @yield [chunk]
+      #   A chunk of resources within the query.
+      #
+      # @yieldparam [DataMapper::Collection] chunk
+      #   A collection of resources that makes up the chunk.
+      #
+      # @return [Chunks]
+      #   The abstract collection of chunks from the query.
+      #
+      # @since 0.2.0
+      #
+      def each_chunk(per_chunk,&block)
+        chunks.each(&block)
+      end
     end
   end
 end

data/spec/chunks_spec.rb

@@ -51,6 +51,26 @@ describe DataMapper::ChunkedQuery::Chunks do
     end
   end
 
+  describe "#first" do
+    it "should return the first chunk by default" do
+      resources = subject.first
+      numbers = resources.map { |resource| resource.number }
+
+      numbers.should == (1..10).to_a
+    end
+
+    it "should return multiple chunks when n > 1" do
+      resources = subject.first(2)
+      numbers = resources.map { |resource| resource.number }
+
+      numbers.should == (1..20).to_a
+    end
+
+    it "should return an empty collection when n=0" do
+      subject.first(0).should be_empty
+    end
+  end
+
   it "should allow enumerating through every chunk" do
     resources = []
     subject.each { |chunk| resources += chunk }

metadata

@@ -2,7 +2,7 @@
 name: dm-chunked_query
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Postmodern
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-03 00:00:00 -08:00
-default_executable: 
+date: 2011-04-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: dm-core
@@ -96,7 +95,6 @@ files:
 - spec/chunked_query_spec.rb
 - spec/chunks_spec.rb
 - spec/spec_helper.rb
-has_rdoc: yard
 homepage: http://github.com/postmodern/dm-chunked_query
 licenses: 
 - MIT
@@ -120,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dm-chunked_query
-rubygems_version: 1.5.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Allows performing chunked queries with DataMapper.