orm_adapter 0.2.0 → 0.3.0

data/Gemfile.lock.development

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

data/History.txt

@@ -1,3 +1,8 @@
+== 0.3.0
+
+  * Removes OrmAdapter::Base.model_classes and friends.  This is a BC breaking change if you use .model_classes [Ian White]
+  * Add note about the scope of ORM Adapter re: model instance methods
+
 == 0.2.0
  
   * Normalise :id in find conditions [Tim Galeckas, Ian White]

data/README.rdoc

@@ -2,7 +2,6 @@
 
 Provides a single point of entry for popular ruby ORMs.  Its target audience is gem authors who want to support more than one ORM.
 
-
 == Example of use
 
   require 'orm_adapter'
@@ -36,20 +35,13 @@ To write an adapter look at <tt>lib/orm_adapter/adapters/active_record.rb</tt> f
 
 == Goals
 
-ORM Adapter goal is to support a minimum API used by most of the plugins that needs agnosticism beyond Active Model.
+ORM Adapter's goal is to support a minimum API used by most of the plugins that needs agnosticism beyond Active Model.  
 
 ORM Adapter will support only basic methods, as +get+, +find_first+, <tt>create!</tt> and so forth. It is not ORM Adapter's goal to support different query constructions, handle table joins, etc.
 
-If you need complex queries, we recommend you to subclass ORM Adapters in your plugin and extend it expressing these query conditions as part of your domain logic.
-
-
-== Projects using orm_adapter
-
-* {devise}[http://github.com/plataformatec/devise]
-* {pickle}[http://github.com/ianwhite/pickle]
-
-Get in touch if you want your project added to this list
+ORM adapter provides a consistent API for these basic class or 'factory' methods. It does not attempt to unify the behaviour of model instances returned by these methods.  This means that unifying the behaviour of methods such as `model.save`, and `model.valid?` is beyond the scope of orm_adapter.
 
+If you need complex queries, we recommend you to subclass ORM Adapters in your plugin and extend it expressing these query conditions as part of your domain logic.
 
 == History
 

data/lib/orm_adapter.rb

@@ -7,11 +7,6 @@ module OrmAdapter
   def self.adapters
     @@adapters ||= []
   end
-
-  # All model classes from all registered adapters
-  def self.model_classes
-    self.adapters.map { |a| a.model_classes }.flatten
-  end
 end
 
 require 'orm_adapter/adapters/active_record' if defined?(ActiveRecord::Base)

data/lib/orm_adapter/adapters/active_record.rb

@@ -2,22 +2,6 @@ require 'active_record'
 
 module OrmAdapter
   class ActiveRecord < Base
-    # Do not consider these to be part of the class list
-    def self.except_classes
-      @@except_classes ||= [
-        "ActiveRecord::SessionStore::Session"
-      ]
-    end
-
-    # Gets a list of the available models for this adapter
-    def self.model_classes
-      klasses = ::ActiveRecord::Base.__send__(:descendants)
-
-      klasses.select do |klass|
-        !klass.abstract_class? && !except_classes.include?(klass.name)
-      end
-    end
-
     # Return list of column/property names
     def column_names
       klass.column_names

data/lib/orm_adapter/adapters/data_mapper.rb

@@ -7,17 +7,6 @@ module DataMapper
 
   module Resource
     class OrmAdapter < ::OrmAdapter::Base
-
-      # Do not consider these to be part of the class list
-      def self.except_classes
-        @@except_classes ||= []
-      end
-
-      # Gets a list of the available models for this adapter
-      def self.model_classes
-        ::DataMapper::Model.descendants.to_a.select{|k| !except_classes.include?(k.name)}
-      end
-
       # get a list of column names for a given class
       def column_names
         klass.properties.map(&:name)

data/lib/orm_adapter/adapters/mongo_mapper.rb

@@ -7,16 +7,6 @@ module MongoMapper
     end
 
     class OrmAdapter < ::OrmAdapter::Base
-      # Do not consider these to be part of the class list
-      def self.except_classes
-        @@except_classes ||= []
-      end
-
-      # Gets a list of the available models for this adapter
-      def self.model_classes
-        ObjectSpace.each_object(Class).to_a.select {|klass| klass.ancestors.include? MongoMapper::Document}
-      end
-
       # get a list of column names for a given class
       def column_names
         klass.column_names

data/lib/orm_adapter/adapters/mongoid.rb

@@ -7,16 +7,6 @@ module Mongoid
     end
 
     class OrmAdapter < ::OrmAdapter::Base
-      # Do not consider these to be part of the class list
-      def self.except_classes
-        @@except_classes ||= []
-      end
-
-      # Gets a list of the available models for this adapter
-      def self.model_classes
-        ObjectSpace.each_object(Class).to_a.select {|klass| klass.ancestors.include? Mongoid::Document}
-      end
-
       # get a list of column names for a given class
       def column_names
         klass.fields.keys

data/lib/orm_adapter/base.rb

@@ -14,11 +14,6 @@ module OrmAdapter
       super
     end
 
-    # Gets a list of the available models for this adapter
-    def self.model_classes
-      raise NotImplementedError, "return a list of available models for this adapter"
-    end
-
     def initialize(klass)
       @klass = klass
     end

data/lib/orm_adapter/version.rb

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

data/spec/orm_adapter/adapters/active_record_spec.rb

@@ -32,18 +32,6 @@ else
         User.delete_all
         Note.delete_all
       end
-
-      describe "the OrmAdapter class" do
-        subject { ActiveRecord::Base::OrmAdapter }
-
-        specify "#except_classes should return the names of active record session store classes" do
-          subject.except_classes.should == ["ActiveRecord::SessionStore::Session"]
-        end
-
-        specify "#model_classes should return all of the non abstract model classes (that are not in except_classes)" do
-          subject.model_classes.should include(User, Note)
-        end
-      end
     
       it_should_behave_like "example app with orm_adapter" do
         let(:user_class) { User }

data/spec/orm_adapter/adapters/data_mapper_spec.rb

@@ -33,14 +33,6 @@ else
         User.destroy
         Note.destroy
       end
-      
-      describe "the OrmAdapter class" do
-        subject { DataMapper::Resource::OrmAdapter }
-
-        specify "#model_classes should return all of the non abstract model classes (that are not in except_classes)" do
-          subject.model_classes.should == [User, Note]
-        end
-      end
 
       it_should_behave_like "example app with orm_adapter" do
         let(:user_class) { User }

data/spec/orm_adapter/adapters/mongo_mapper_spec.rb

@@ -31,14 +31,6 @@ else
           coll.remove
         end
       end
-      
-      describe "the OrmAdapter class" do
-        subject { MongoMapper::Document::OrmAdapter }
-
-        specify "#model_classes should return all document classes" do
-          (subject.model_classes & [User, Note]).to_set.should == [User, Note].to_set
-        end
-      end
     
       it_should_behave_like "example app with orm_adapter" do
         let(:user_class) { User }

data/spec/orm_adapter/adapters/mongoid_spec.rb

@@ -29,14 +29,6 @@ else
         User.delete_all
         Note.delete_all
       end
-      
-      describe "the OrmAdapter class" do
-        subject { Mongoid::Document::OrmAdapter }
-
-        specify "#model_classes should return all document classes" do
-          (subject.model_classes & [User, Note]).to_set.should == [User, Note].to_set
-        end
-      end
     
       it_should_behave_like "example app with orm_adapter" do
         let(:user_class) { User }

data/spec/orm_adapter/example_app_shared.rb

@@ -91,8 +91,9 @@ shared_examples_for "example app with orm_adapter" do
           user_adapter.find_first(:name => "Betty").should == nil
         end
         
-        it 'allows no conditions' do
+        it 'should return the first model if no conditions passed' do
           user = create_model(user_class)
+          create_model(user_class)
           user_adapter.find_first.should == user
         end
 
@@ -146,13 +147,6 @@ shared_examples_for "example app with orm_adapter" do
         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)

data/spec/orm_adapter_spec.rb

@@ -8,14 +8,6 @@ describe OrmAdapter do
     
     its(:adapters) { should include(adapter) }
     
-    describe "and the adapter has a model class" do
-      let(:model) { Class.new }
-      
-      before { adapter.stub!(:model_classes).and_return([model]) }
-      
-      its(:model_classes) { should include(model) }
-    end
-    
     after { OrmAdapter.adapters.delete(adapter) }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orm_adapter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70150855160900 !ruby/object:Gem::Requirement
+  requirement: &70282396920860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70150855160900
+  version_requirements: *70282396920860
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &70150855160240 !ruby/object:Gem::Requirement
+  requirement: &70282396919960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.2.5
   type: :development
   prerelease: false
-  version_requirements: *70150855160240
+  version_requirements: *70282396919960
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70150855159520 !ruby/object:Gem::Requirement
+  requirement: &70282396919320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70150855159520
+  version_requirements: *70282396919320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70150855158180 !ruby/object:Gem::Requirement
+  requirement: &70282396918380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70150855158180
+  version_requirements: *70282396918380
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70150855157580 !ruby/object:Gem::Requirement
+  requirement: &70282396917120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *70150855157580
+  version_requirements: *70282396917120
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70150855156740 !ruby/object:Gem::Requirement
+  requirement: &70282396916500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 2.0.0.beta.20
   type: :development
   prerelease: false
-  version_requirements: *70150855156740
+  version_requirements: *70282396916500
 - !ruby/object:Gem::Dependency
   name: mongo_mapper
-  requirement: &70150855141820 !ruby/object:Gem::Requirement
+  requirement: &70282396915800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70150855141820
+  version_requirements: *70282396915800
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70150855139580 !ruby/object:Gem::Requirement
+  requirement: &70282396900760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70150855139580
+  version_requirements: *70282396900760
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70150855138220 !ruby/object:Gem::Requirement
+  requirement: &70282396898120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *70150855138220
+  version_requirements: *70282396898120
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70150855137100 !ruby/object:Gem::Requirement
+  requirement: &70282396896760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70150855137100
+  version_requirements: *70282396896760
 - !ruby/object:Gem::Dependency
   name: datamapper
-  requirement: &70150855136280 !ruby/object:Gem::Requirement
+  requirement: &70282396896060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,10 +132,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70150855136280
+  version_requirements: *70282396896060
 - !ruby/object:Gem::Dependency
   name: dm-sqlite-adapter
-  requirement: &70150855135540 !ruby/object:Gem::Requirement
+  requirement: &70282396895200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -143,10 +143,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70150855135540
+  version_requirements: *70282396895200
 - !ruby/object:Gem::Dependency
   name: dm-active_model
-  requirement: &70150855134420 !ruby/object:Gem::Requirement
+  requirement: &70282396894300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -154,7 +154,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70150855134420
+  version_requirements: *70282396894300
 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: -1006971164339010428
+      hash: 3963130271152065035
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: