orm_adapter 0.1.0 → 0.2.0

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.3
+  - 1.9.3
+before_install: "cp Gemfile.lock.development Gemfile.lock"

data/Gemfile.lock.development

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

data/History.txt

@@ -1,3 +1,8 @@
+== 0.2.0
+ 
+  * Normalise :id in find conditions [Tim Galeckas, Ian White]
+  * Allow find_first and find_all to take no arguments [Tim Galeckas, Ian White]
+  
 == 0.1.0
 
   * Add #destroy(object) to the API [Fred Wu]

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Ian White and José Valim
+Copyright (c) 2010-2012 Ian White and José Valim
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,4 +1,4 @@
-= ORM Adapter
+= ORM Adapter {<img src="https://secure.travis-ci.org/ianwhite/orm_adapter.png?branch=master" alt="Build Status" />}[http://travis-ci.org/ianwhite/orm_adapter]
 
 Provides a single point of entry for popular ruby ORMs.  Its target audience is gem authors who want to support more than one ORM.
 
@@ -14,9 +14,14 @@ Provides a single point of entry for popular ruby ORMs.  Its target audience is
   user_model = User.to_adapter
   user_model.get!(1)                      # find a record by id
   user_model.find_first(:name => 'fred')  # find first fred
+  user_model.find_first(:level => 'awesome', :id => 23)
+                                          # find user 23, only if it's level is awesome
+  user_model.find_all                     # find all users
   user_model.find_all(:name => 'fred')    # find all freds
   user_model.find_all(:order => :name)    # find all freds, ordered by name
   user_model.create!(:name => 'fred')     # create a fred 
+  user_model.destroy(object)              # destroy the user object
+  
 
 @see OrmAdapter::Base for more details of the supported API
   
@@ -56,6 +61,7 @@ orm_adapter is an extraction from {pickle}[http://github.com/ianwhite/pickle] by
 
 {Fred Wu}[http://github.com/fredwu] contributes the #destroy methods.
 
+{Tim Galeckas}[http://github.com/timgaleckas]
 
 == Development
 
@@ -70,4 +76,4 @@ To run the specs, you can start from the last known good set of gem dependencies
 
 == Copyright
 
-Copyright (c) 2010-2011 Ian White and José Valim. See LICENSE for details.
+Copyright (c) 2010-2012 Ian White and José Valim. See LICENSE for details.

data/lib/orm_adapter/adapters/active_record.rb

@@ -34,19 +34,19 @@ module OrmAdapter
     end
 
     # @see OrmAdapter::Base#find_first
-    def find_first(options)
+    def find_first(options = {})
       conditions, order = extract_conditions_and_order!(options)
       klass.where(conditions_to_fields(conditions)).order(*order_clause(order)).first
     end
 
     # @see OrmAdapter::Base#find_all
-    def find_all(options)
+    def find_all(options = {})
       conditions, order = extract_conditions_and_order!(options)
       klass.where(conditions_to_fields(conditions)).order(*order_clause(order)).all
     end
 
     # @see OrmAdapter::Base#create!
-    def create!(attributes)
+    def create!(attributes = {})
       klass.create!(attributes)
     end
 
@@ -87,4 +87,4 @@ end
 ActiveSupport.on_load(:active_record) do
   extend ::OrmAdapter::ToAdapter
   self::OrmAdapter = ::OrmAdapter::ActiveRecord
-end
+end

data/lib/orm_adapter/adapters/data_mapper.rb

@@ -4,7 +4,7 @@ module DataMapper
   module Model
     include OrmAdapter::ToAdapter
   end
-  
+
   module Resource
     class OrmAdapter < ::OrmAdapter::Base
 
@@ -34,29 +34,29 @@ module DataMapper
       end
 
       # @see OrmAdapter::Base#find_first
-      def find_first(options)
+      def find_first(options = {})
         conditions, order = extract_conditions_and_order!(options)
         klass.first :conditions => conditions, :order => order_clause(order)
       end
 
       # @see OrmAdapter::Base#find_all
-      def find_all(options)
+      def find_all(options = {})
         conditions, order = extract_conditions_and_order!(options)
         klass.all :conditions => conditions, :order => order_clause(order)
       end
-    
+
       # @see OrmAdapter::Base#create!
-      def create!(attributes)
+      def create!(attributes = {})
         klass.create(attributes)
       end
-      
+
       # @see OrmAdapter::Base#destroy
       def destroy(object)
         object.destroy if valid_object?(object)
       end
 
     protected
-      
+
       def order_clause(order)
         order.map {|pair| pair.first.send(pair.last)}
       end

data/lib/orm_adapter/adapters/mongo_mapper.rb

@@ -5,7 +5,7 @@ module MongoMapper
     module ClassMethods
       include OrmAdapter::ToAdapter
     end
-    
+
     class OrmAdapter < ::OrmAdapter::Base
       # Do not consider these to be part of the class list
       def self.except_classes
@@ -33,21 +33,21 @@ module MongoMapper
       end
 
       # @see OrmAdapter::Base#find_first
-      def find_first(conditions)
+      def find_first(conditions = {})
         conditions, order = extract_conditions_and_order!(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)
+      def find_all(conditions = {})
         conditions, order = extract_conditions_and_order!(conditions)
         conditions = conditions.merge(:sort => order) unless order.nil?
         klass.all(conditions_to_fields(conditions))
       end
 
       # @see OrmAdapter::Base#create!
-      def create!(attributes)
+      def create!(attributes = {})
         klass.create!(attributes)
       end
 
@@ -70,4 +70,4 @@ module MongoMapper
       end
     end
   end
-end
+end

data/lib/orm_adapter/adapters/mongoid.rb

@@ -5,7 +5,7 @@ module Mongoid
     module ClassMethods
       include OrmAdapter::ToAdapter
     end
-    
+
     class OrmAdapter < ::OrmAdapter::Base
       # Do not consider these to be part of the class list
       def self.except_classes
@@ -33,22 +33,22 @@ module Mongoid
       end
 
       # @see OrmAdapter::Base#find_first
-      def find_first(options)
+      def find_first(options = {})
         conditions, order = extract_conditions_and_order!(options)
         klass.limit(1).where(conditions_to_fields(conditions)).order_by(order).first
       end
 
       # @see OrmAdapter::Base#find_all
-      def find_all(options)
+      def find_all(options = {})
         conditions, order = extract_conditions_and_order!(options)
         klass.where(conditions_to_fields(conditions)).order_by(order)
       end
 
       # @see OrmAdapter::Base#create!
-      def create!(attributes)
+      def create!(attributes = {})
         klass.create!(attributes)
       end
-  
+
       # @see OrmAdapter::Base#destroy
       def destroy(object)
         object.destroy if valid_object?(object)
@@ -61,6 +61,8 @@ module Mongoid
         conditions.inject({}) do |fields, (key, value)|
           if value.is_a?(Mongoid::Document) && klass.fields.keys.include?("#{key}_id")
             fields.merge("#{key}_id" => value.id)
+          elsif key.to_s == 'id'
+            fields.merge('_id' => value)
           else
             fields.merge(key => value)
           end

data/lib/orm_adapter/base.rb

@@ -27,7 +27,7 @@ module OrmAdapter
     def column_names
       raise NotSupportedError
     end
-    
+
     # Get an instance by id of the model. Raises an error if a model is not found.
     # This should comply with ActiveModel#to_key API, i.e.:
     #
@@ -49,7 +49,7 @@ module OrmAdapter
     # Find the first instance, optionally matching conditions, and specifying order
     #
     # You can call with just conditions, providing a hash
-    #   
+    #
     #   User.to_adapter.find_first :name => "Fred", :age => 23
     #
     # Or you can specify :order, and :conditions as keys
@@ -63,18 +63,18 @@ module OrmAdapter
     # * a single pair with :asc, or :desc as last, e.g. <tt>:order => [:name, :desc]</tt>
     # * an array of single args or pairs (with :asc or :desc as last), e.g. <tt>:order => [[:name, :asc], [:age, :desc]]</tt>
     #
-    def find_first(options)
+    def find_first(options = {})
       raise NotSupportedError
     end
 
     # Find all models, optionally matching conditions, and specifying order
     # @see OrmAdapter::Base#find_first for how to specify order and conditions
-    def find_all(options)
+    def find_all(options = {})
       raise NotSupportedError
     end
 
     # Create a model using attributes
-    def create!(attributes)
+    def create!(attributes = {})
       raise NotSupportedError
     end
 
@@ -92,29 +92,29 @@ module OrmAdapter
     def wrap_key(key)
       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))
       conditions = options.delete(:conditions) || options
       [conditions, order]
     end
-    
+
     # given an order argument, returns an array of pairs, with each pair containing the attribute, and :asc or :desc
     def normalize_order(order)
       order = Array(order)
-      
+
       if order.length == 2 && !order[0].is_a?(Array) && [:asc, :desc].include?(order[1])
         order = [order]
       else
         order = order.map {|pair| pair.is_a?(Array) ? pair : [pair, :asc] }
       end
-      
+
       order.each do |pair|
         pair.length == 2 or raise ArgumentError, "each order clause must be a pair (unknown clause #{pair.inspect})"
         [:asc, :desc].include?(pair[1]) or raise ArgumentError, "order must be specified with :asc or :desc (unknown key #{pair[1].inspect})"
       end
-      
+
       order
     end
   end
@@ -124,4 +124,4 @@ module OrmAdapter
       "method not supported by this orm adapter"
     end
   end
-end
+end

data/lib/orm_adapter/version.rb

@@ -1,3 +1,3 @@
 module OrmAdapter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/orm_adapter/example_app_shared.rb

@@ -19,18 +19,18 @@
 #   end
 #
 shared_examples_for "example app with orm_adapter" do
-  
+
   def create_model(klass, attrs = {})
     klass.create!(attrs)
   end
-  
+
   def reload_model(model)
     model.class.find(model.id)
   end
-      
+
   describe "an ORM class" do
     subject { note_class }
-  
+
     it "#to_adapter should return an adapter instance" do
       subject.to_adapter.should be_a(OrmAdapter::Base)
     end
@@ -43,11 +43,11 @@ shared_examples_for "example app with orm_adapter" do
       subject.to_adapter.object_id.should == subject.to_adapter.object_id
     end
   end
-  
+
   describe "adapter instance" do
     let(:note_adapter) { note_class.to_adapter }
     let(:user_adapter) { user_class.to_adapter }
-    
+
     describe "#get!(id)" do
       it "should return the instance with id if it exists" do
         user = create_model(user_class)
@@ -90,14 +90,26 @@ 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 'allows no conditions' do
+          user = create_model(user_class)
+          user_adapter.find_first.should == user
+        end
+
         it "when conditions contain associated object, should return first model if it exists" do
           user = create_model(user_class)
           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")
+          user_adapter.find_first(:id => user.id, :name => "Fred").should == user
+          user_adapter.find_first(:id => user.id, :name => "Not Fred").should be_nil
+        end
       end
-    
+
       describe "(:order => <order array>)" do
         it "should return first model in specified order" do
           user1 = create_model(user_class, :name => "Fred", :rating => 1)
@@ -105,7 +117,7 @@ shared_examples_for "example app with orm_adapter" do
           user_adapter.find_first(:order => [:name, [:rating, :desc]]).should == user2
         end
       end
-          
+
       describe "(:conditions => <conditions hash>, :order => <order array>)" do
         it "should return first model matching conditions, in specified order" do
           user1 = create_model(user_class, :name => "Fred", :rating => 1)
@@ -124,10 +136,24 @@ shared_examples_for "example app with orm_adapter" do
           user_adapter.find_all(:name => "Fred").should == [user1, user2]
         end
 
+        it "should return all models if no conditions passed" do
+          user1 = create_model(user_class, :name => "Fred")
+          user2 = create_model(user_class, :name => "Fred")
+          user3 = create_model(user_class, :name => "Betty")
+          user_adapter.find_all.should == [user1, user2, user3]
+        end
+
         it "should return empty array if no conditions match" do
           user_adapter.find_all(:name => "Fred").should == []
         end
-      
+        
+        it 'allows no conditions' do
+          user1 = create_model(user_class)
+          user2 = create_model(user_class)
+          user_adapter.find_all.to_set.should == [user1, user2].to_set
+        end
+        
+
         it "when conditions contain associated object, should return first model if it exists" do
           user1, user2 = create_model(user_class), create_model(user_class)
           note1 = create_model(note_class, :owner => user1)
@@ -144,7 +170,7 @@ shared_examples_for "example app with orm_adapter" do
           user_adapter.find_all(:order => [:name, [:rating, :desc]]).should == [user3, user2, user1]
         end
       end
-      
+
       describe "(:conditions => <conditions hash>, :order => <order array>)" do
         it "should return only models matching conditions, in specified order" do
           user1 = create_model(user_class, :name => "Fred", :rating => 1)
@@ -154,7 +180,7 @@ shared_examples_for "example app with orm_adapter" do
         end
       end
     end
-    
+
     describe "#create!(attributes)" do
       it "should create a model with the passed attributes" do
         user = user_adapter.create!(:name => "Fred")
@@ -164,13 +190,13 @@ shared_examples_for "example app with orm_adapter" do
       it "should raise error when create fails" do
         lambda { user_adapter.create!(:user => create_model(note_class)) }.should raise_error
       end
-      
+
       it "when attributes contain an associated object, should create a model with the attributes" do
         user = create_model(user_class)
         note = note_adapter.create!(:owner => user)
         reload_model(note).owner.should == user
       end
-      
+
       it "when attributes contain an has_many assoc, should create a model with the attributes" do
         notes = [create_model(note_class), create_model(note_class)]
         user = user_adapter.create!(:notes => notes)
@@ -196,4 +222,4 @@ shared_examples_for "example app with orm_adapter" do
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orm_adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
+date: 2012-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70097699980460 !ruby/object:Gem::Requirement
+  requirement: &70150855160900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70097699980460
+  version_requirements: *70150855160900
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &70097699979600 !ruby/object:Gem::Requirement
+  requirement: &70150855160240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.2.5
   type: :development
   prerelease: false
-  version_requirements: *70097699979600
+  version_requirements: *70150855160240
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70097699979000 !ruby/object:Gem::Requirement
+  requirement: &70150855159520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70097699979000
+  version_requirements: *70150855159520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70097699978040 !ruby/object:Gem::Requirement
+  requirement: &70150855158180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70097699978040
+  version_requirements: *70150855158180
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70097699977120 !ruby/object:Gem::Requirement
+  requirement: &70150855157580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *70097699977120
+  version_requirements: *70150855157580
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70097699976120 !ruby/object:Gem::Requirement
+  requirement: &70150855156740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 2.0.0.beta.20
   type: :development
   prerelease: false
-  version_requirements: *70097699976120
+  version_requirements: *70150855156740
 - !ruby/object:Gem::Dependency
   name: mongo_mapper
-  requirement: &70097699975540 !ruby/object:Gem::Requirement
+  requirement: &70150855141820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70097699975540
+  version_requirements: *70150855141820
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70097699960720 !ruby/object:Gem::Requirement
+  requirement: &70150855139580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70097699960720
+  version_requirements: *70150855139580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70097699957980 !ruby/object:Gem::Requirement
+  requirement: &70150855138220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *70097699957980
+  version_requirements: *70150855138220
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70097699956440 !ruby/object:Gem::Requirement
+  requirement: &70150855137100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70097699956440
+  version_requirements: *70150855137100
 - !ruby/object:Gem::Dependency
   name: datamapper
-  requirement: &70097699955740 !ruby/object:Gem::Requirement
+  requirement: &70150855136280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,10 +132,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70097699955740
+  version_requirements: *70150855136280
 - !ruby/object:Gem::Dependency
   name: dm-sqlite-adapter
-  requirement: &70097699954920 !ruby/object:Gem::Requirement
+  requirement: &70150855135540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -143,10 +143,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70097699954920
+  version_requirements: *70150855135540
 - !ruby/object:Gem::Dependency
   name: dm-active_model
-  requirement: &70097699953980 !ruby/object:Gem::Requirement
+  requirement: &70150855134420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -154,7 +154,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70097699953980
+  version_requirements: *70150855134420
 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: 1483369582695834263
+      hash: -1006971164339010428
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: