orm_adapter 0.3.0 → 0.4.0

data/Gemfile.lock.development

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    orm_adapter (0.3.0)
+    orm_adapter (0.4.0)
 
 GEM
   remote: http://rubygems.org/

data/History.txt

@@ -1,3 +1,7 @@
+== 0.4.0
+
+  * Adds :limit, and :offset options to #find_all [Fred Wu]
+
 == 0.3.0
 
   * Removes OrmAdapter::Base.model_classes and friends.  This is a BC breaking change if you use .model_classes [Ian White]

data/README.rdoc

@@ -51,7 +51,7 @@ orm_adapter is an extraction from {pickle}[http://github.com/ianwhite/pickle] by
 
 {Luke Cunningham}[http://github.com/icaruswings] contributes the Mongo Mapper adapter.
 
-{Fred Wu}[http://github.com/fredwu] contributes the #destroy methods.
+{Fred Wu}[http://github.com/fredwu] contributes the #destroy methods, and :limit, :offset options for #find_all
 
 {Tim Galeckas}[http://github.com/timgaleckas]
 

data/lib/orm_adapter/adapters/active_record.rb

@@ -19,14 +19,14 @@ module OrmAdapter
 
     # @see OrmAdapter::Base#find_first
     def find_first(options = {})
-      conditions, order = extract_conditions_and_order!(options)
+      conditions, order = extract_conditions!(options)
       klass.where(conditions_to_fields(conditions)).order(*order_clause(order)).first
     end
 
     # @see OrmAdapter::Base#find_all
     def find_all(options = {})
-      conditions, order = extract_conditions_and_order!(options)
-      klass.where(conditions_to_fields(conditions)).order(*order_clause(order)).all
+      conditions, order, limit, offset = extract_conditions!(options)
+      klass.where(conditions_to_fields(conditions)).order(*order_clause(order)).limit(limit).offset(offset).all
     end
 
     # @see OrmAdapter::Base#create!

data/lib/orm_adapter/adapters/data_mapper.rb

@@ -24,14 +24,17 @@ module DataMapper
 
       # @see OrmAdapter::Base#find_first
       def find_first(options = {})
-        conditions, order = extract_conditions_and_order!(options)
+        conditions, order = extract_conditions!(options)
         klass.first :conditions => conditions, :order => order_clause(order)
       end
 
       # @see OrmAdapter::Base#find_all
       def find_all(options = {})
-        conditions, order = extract_conditions_and_order!(options)
-        klass.all :conditions => conditions, :order => order_clause(order)
+        conditions, order, limit, offset = extract_conditions!(options)
+        opts = { :conditions => conditions, :order => order_clause(order) }
+        opts = opts.merge({ :limit => limit }) unless limit.nil?
+        opts = opts.merge({ :offset => offset }) unless offset.nil?
+        klass.all opts
       end
 
       # @see OrmAdapter::Base#create!

data/lib/orm_adapter/adapters/mongo_mapper.rb

@@ -24,15 +24,17 @@ module MongoMapper
 
       # @see OrmAdapter::Base#find_first
       def find_first(conditions = {})
-        conditions, order = extract_conditions_and_order!(conditions)
+        conditions, order = extract_conditions!(conditions)
         conditions = conditions.merge(:sort => order) unless order.nil?
         klass.first(conditions_to_fields(conditions))
       end
 
       # @see OrmAdapter::Base#find_all
       def find_all(conditions = {})
-        conditions, order = extract_conditions_and_order!(conditions)
+        conditions, order, limit, offset = extract_conditions!(conditions)
         conditions = conditions.merge(:sort => order) unless order.nil?
+        conditions = conditions.merge(:limit => limit) unless limit.nil?
+        conditions = conditions.merge(:offset => offset) unless limit.nil? || offset.nil?
         klass.all(conditions_to_fields(conditions))
       end
 

data/lib/orm_adapter/adapters/mongoid.rb

@@ -24,14 +24,14 @@ module Mongoid
 
       # @see OrmAdapter::Base#find_first
       def find_first(options = {})
-        conditions, order = extract_conditions_and_order!(options)
+        conditions, order = extract_conditions!(options)
         klass.limit(1).where(conditions_to_fields(conditions)).order_by(order).first
       end
 
       # @see OrmAdapter::Base#find_all
       def find_all(options = {})
-        conditions, order = extract_conditions_and_order!(options)
-        klass.where(conditions_to_fields(conditions)).order_by(order)
+        conditions, order, limit, offset = extract_conditions!(options)
+        klass.where(conditions_to_fields(conditions)).order_by(order).limit(limit).offset(offset)
       end
 
       # @see OrmAdapter::Base#create!

data/lib/orm_adapter/base.rb

@@ -88,11 +88,16 @@ module OrmAdapter
       key.is_a?(Array) ? key.first : key
     end
 
-    # given an options hash, with optional :conditions and :order keys, returns conditions and normalized order
-    def extract_conditions_and_order!(options = {})
-      order = normalize_order(options.delete(:order))
+    # given an options hash,
+    # with optional :conditions, :order, :limit and :offset keys,
+    # returns conditions, normalized order, limit and offset
+    def extract_conditions!(options = {})
+      order      = normalize_order(options.delete(:order))
+      limit      = options.delete(:limit)
+      offset     = options.delete(:offset)
       conditions = options.delete(:conditions) || options
-      [conditions, order]
+
+      [conditions, order, limit, offset]
     end
 
     # given an order argument, returns an array of pairs, with each pair containing the attribute, and :asc or :desc

data/lib/orm_adapter/version.rb

@@ -1,3 +1,3 @@
 module OrmAdapter
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/orm_adapter/base_spec.rb

@@ -2,27 +2,45 @@ require 'spec_helper'
 
 describe OrmAdapter::Base do
   subject { OrmAdapter::Base.new(Object) }
-  
-  describe "#extract_conditions_and_order!" do
+
+  describe "#extract_conditions!" do
     let(:conditions) { {:foo => 'bar'} }
     let(:order) { [[:foo, :asc]] }
-    
-    it "(<conditions>) should return [<conditions>, []]" do
-      subject.send(:extract_conditions_and_order!, conditions).should == [conditions, []]
+    let(:limit) { 1 }
+    let(:offset) { 2 }
+
+    it "(<conditions>)" do
+      subject.send(:extract_conditions!, conditions).should == [conditions, [], nil, nil]
+    end
+
+    it "(:conditions => <conditions>)" do
+      subject.send(:extract_conditions!, :conditions => conditions).should == [conditions, [], nil, nil]
+    end
+
+    it "(:order => <order>)" do
+      subject.send(:extract_conditions!, :order => order).should == [{}, order, nil, nil]
     end
-    
-    it "(:conditions => <conditions>) should return [<conditions>, []]" do
-      subject.send(:extract_conditions_and_order!, :conditions => conditions).should == [conditions, []]
+
+    it "(:limit => <limit>)" do
+      subject.send(:extract_conditions!, :limit => limit).should == [{}, [], limit, nil]
     end
 
-    it "(:order => <order>) should return [{}, <order>]" do
-      subject.send(:extract_conditions_and_order!, :order => order).should == [{}, order]
+    it "(:offset => <offset>)" do
+      subject.send(:extract_conditions!, :offset => offset).should == [{}, [], nil, offset]
     end
-    
-    it "(:conditions => <conditions>, :order => <order>) should return [<conditions>, <order>]" do
-      subject.send(:extract_conditions_and_order!, :conditions => conditions, :order => order).should == [conditions, order]
+
+    it "(:conditions => <conditions>, :order => <order>)" do
+      subject.send(:extract_conditions!, :conditions => conditions, :order => order).should == [conditions, order, nil, nil]
+    end
+
+    it "(:conditions => <conditions>, :limit => <limit>)" do
+      subject.send(:extract_conditions!, :conditions => conditions, :limit => limit).should == [conditions, [], limit, nil]
     end
-    
+
+    it "(:conditions => <conditions>, :offset => <offset>)" do
+      subject.send(:extract_conditions!, :conditions => conditions, :offset => offset).should == [conditions, [], nil, offset]
+    end
+
     describe "#valid_object?" do
       it "determines whether an object is valid for the current model class" do
         subject.send(:valid_object?, Object.new).should be_true
@@ -34,27 +52,27 @@ describe OrmAdapter::Base do
       specify "(nil) returns []" do
         subject.send(:normalize_order, nil).should == []
       end
-      
+
       specify ":foo returns [[:foo, :asc]]" do
         subject.send(:normalize_order, :foo).should == [[:foo, :asc]]
       end
-      
+
       specify "[:foo] returns [[:foo, :asc]]" do
         subject.send(:normalize_order, [:foo]).should == [[:foo, :asc]]
       end
-      
+
       specify "[:foo, :desc] returns [[:foo, :desc]]" do
         subject.send(:normalize_order, [:foo, :desc]).should == [[:foo, :desc]]
       end
-      
+
       specify "[:foo, [:bar, :asc], [:baz, :desc], :bing] returns [[:foo, :asc], [:bar, :asc], [:baz, :desc], [:bing, :asc]]" do
         subject.send(:normalize_order, [:foo, [:bar, :asc], [:baz, :desc], :bing]).should == [[:foo, :asc], [:bar, :asc], [:baz, :desc], [:bing, :asc]]
       end
-      
+
       specify "[[:foo, :wtf]] raises ArgumentError" do
         lambda { subject.send(:normalize_order, [[:foo, :wtf]]) }.should raise_error(ArgumentError)
       end
-      
+
       specify "[[:foo, :asc, :desc]] raises ArgumentError" do
         lambda { subject.send(:normalize_order, [[:foo, :asc, :desc]]) }.should raise_error(ArgumentError)
       end

data/spec/orm_adapter/example_app_shared.rb

@@ -90,7 +90,7 @@ shared_examples_for "example app with orm_adapter" do
         it "should return nil if no conditions match" do
           user_adapter.find_first(:name => "Betty").should == nil
         end
-        
+
         it 'should return the first model if no conditions passed' do
           user = create_model(user_class)
           create_model(user_class)
@@ -102,7 +102,7 @@ shared_examples_for "example app with orm_adapter" do
           note = create_model(note_class, :owner => user)
           note_adapter.find_first(:owner => user).should == note
         end
-        
+
         it "understands :id as a primary key condition (allowing scoped finding)" do
           create_model(user_class, :name => "Fred")
           user = create_model(user_class, :name => "Fred")
@@ -173,6 +173,27 @@ shared_examples_for "example app with orm_adapter" do
           user_adapter.find_all(:conditions => {:name => "Fred"}, :order => [:rating, :desc]).should == [user2, user1]
         end
       end
+
+      describe "(:limit => <number of items>)" do
+        it "should return a limited set of matching models" do
+          user1 = create_model(user_class, :name => "Fred", :rating => 1)
+          user2 = create_model(user_class, :name => "Fred", :rating => 2)
+          user3 = create_model(user_class, :name => "Betty", :rating => 1)
+          user_adapter.find_all(:limit => 1).should == [user1]
+          user_adapter.find_all(:limit => 2).should == [user1, user2]
+        end
+      end
+
+      describe "(:offset => <offset number>) with limit (as DataMapper doesn't allow offset on its own)" do
+        it "should return an offset set of matching models" do
+          user1 = create_model(user_class, :name => "Fred", :rating => 1)
+          user2 = create_model(user_class, :name => "Fred", :rating => 2)
+          user3 = create_model(user_class, :name => "Betty", :rating => 1)
+          user_adapter.find_all(:limit => 3, :offset => 0).should == [user1, user2, user3]
+          user_adapter.find_all(:limit => 3, :offset => 1).should == [user2, user3]
+          user_adapter.find_all(:limit => 1, :offset => 1).should == [user2]
+        end
+      end
     end
 
     describe "#create!(attributes)" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orm_adapter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000 Z
+date: 2012-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70282396920860 !ruby/object:Gem::Requirement
+  requirement: &70358654083860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70282396920860
+  version_requirements: *70358654083860
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &70282396919960 !ruby/object:Gem::Requirement
+  requirement: &70358654083320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.2.5
   type: :development
   prerelease: false
-  version_requirements: *70282396919960
+  version_requirements: *70358654083320
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70282396919320 !ruby/object:Gem::Requirement
+  requirement: &70358654082820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70282396919320
+  version_requirements: *70358654082820
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70282396918380 !ruby/object:Gem::Requirement
+  requirement: &70358654082040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70282396918380
+  version_requirements: *70358654082040
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70282396917120 !ruby/object:Gem::Requirement
+  requirement: &70358654080600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *70282396917120
+  version_requirements: *70358654080600
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70282396916500 !ruby/object:Gem::Requirement
+  requirement: &70358654079240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 2.0.0.beta.20
   type: :development
   prerelease: false
-  version_requirements: *70282396916500
+  version_requirements: *70358654079240
 - !ruby/object:Gem::Dependency
   name: mongo_mapper
-  requirement: &70282396915800 !ruby/object:Gem::Requirement
+  requirement: &70358654078040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70282396915800
+  version_requirements: *70358654078040
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70282396900760 !ruby/object:Gem::Requirement
+  requirement: &70358654077240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70282396900760
+  version_requirements: *70358654077240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70282396898120 !ruby/object:Gem::Requirement
+  requirement: &70358654076340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *70282396898120
+  version_requirements: *70358654076340
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70282396896760 !ruby/object:Gem::Requirement
+  requirement: &70358654056980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70282396896760
+  version_requirements: *70358654056980
 - !ruby/object:Gem::Dependency
   name: datamapper
-  requirement: &70282396896060 !ruby/object:Gem::Requirement
+  requirement: &70358654056260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,10 +132,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70282396896060
+  version_requirements: *70358654056260
 - !ruby/object:Gem::Dependency
   name: dm-sqlite-adapter
-  requirement: &70282396895200 !ruby/object:Gem::Requirement
+  requirement: &70358654055740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -143,10 +143,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70282396895200
+  version_requirements: *70358654055740
 - !ruby/object:Gem::Dependency
   name: dm-active_model
-  requirement: &70282396894300 !ruby/object:Gem::Requirement
+  requirement: &70358654055220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -154,7 +154,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70282396894300
+  version_requirements: *70358654055220
 description: Provides a single point of entry for using basic features of ruby ORMs
 email: ian.w.white@gmail.com
 executables: []
@@ -201,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3963130271152065035
+      hash: 3652466131119741366
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: