orm_adapter_rails4_fix 0.4.1

data/lib/orm_adapter/adapters/data_mapper.rb

@@ -0,0 +1,57 @@
+require 'dm-core'
+
+module DataMapper
+  module Model
+    include OrmAdapter::ToAdapter
+  end
+
+  module Resource
+    class OrmAdapter < ::OrmAdapter::Base
+      # get a list of column names for a given class
+      def column_names
+        klass.properties.map(&:name)
+      end
+
+      # @see OrmAdapter::Base#get!
+      def get!(id)
+        klass.get!(id)
+      end
+
+      # @see OrmAdapter::Base#get
+      def get(id)
+        klass.get(id)
+      end
+
+      # @see OrmAdapter::Base#find_first
+      def find_first(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, 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!
+      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
+    end
+  end
+end

data/lib/orm_adapter/adapters/mongo_mapper.rb

@@ -0,0 +1,65 @@
+require 'mongo_mapper'
+
+module MongoMapper
+  module Document
+    module ClassMethods
+      include OrmAdapter::ToAdapter
+    end
+
+    class OrmAdapter < ::OrmAdapter::Base
+      # get a list of column names for a given class
+      def column_names
+        klass.column_names
+      end
+
+      # @see OrmAdapter::Base#get!
+      def get!(id)
+        klass.find!(wrap_key(id))
+      end
+
+      # @see OrmAdapter::Base#get
+      def get(id)
+        klass.first({ :id => wrap_key(id) })
+      end
+
+      # @see OrmAdapter::Base#find_first
+      def find_first(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, 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
+
+      # @see OrmAdapter::Base#create!
+      def create!(attributes = {})
+        klass.create!(attributes)
+      end
+
+      # @see OrmAdapter::Base#destroy
+      def destroy(object)
+        object.destroy if valid_object?(object)
+      end
+
+    protected
+
+      # converts and documents to ids
+      def conditions_to_fields(conditions)
+        conditions.inject({}) do |fields, (key, value)|
+          if value.is_a?(MongoMapper::Document) && klass.key?("#{key}_id")
+            fields.merge("#{key}_id" => value.id)
+          else
+            fields.merge(key => value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orm_adapter/adapters/mongoid.rb

@@ -0,0 +1,63 @@
+require 'mongoid'
+
+module Mongoid
+  module Document
+    module ClassMethods
+      include OrmAdapter::ToAdapter
+    end
+
+    class OrmAdapter < ::OrmAdapter::Base
+      # get a list of column names for a given class
+      def column_names
+        klass.fields.keys
+      end
+
+      # @see OrmAdapter::Base#get!
+      def get!(id)
+        klass.find(wrap_key(id))
+      end
+
+      # @see OrmAdapter::Base#get
+      def get(id)
+        klass.where(:_id => wrap_key(id)).first
+      end
+
+      # @see OrmAdapter::Base#find_first
+      def find_first(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, limit, offset = extract_conditions!(options)
+        klass.where(conditions_to_fields(conditions)).order_by(order).limit(limit).offset(offset)
+      end
+
+      # @see OrmAdapter::Base#create!
+      def create!(attributes = {})
+        klass.create!(attributes)
+      end
+
+      # @see OrmAdapter::Base#destroy
+      def destroy(object)
+        object.destroy if valid_object?(object)
+      end
+
+    protected
+
+      # converts and documents to ids
+      def conditions_to_fields(conditions)
+        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
+        end
+      end
+    end
+  end
+end

data/lib/orm_adapter/base.rb

@@ -0,0 +1,127 @@
+module OrmAdapter
+  class Base
+    attr_reader :klass
+
+    # Your ORM adapter needs to inherit from this Base class and its adapter
+    # will be registered. To create an adapter you should create an inner
+    # constant "OrmAdapter" e.g. ActiveRecord::Base::OrmAdapter
+    #
+    # @see orm_adapters/active_record
+    # @see orm_adapters/datamapper
+    # @see orm_adapters/mongoid
+    def self.inherited(adapter)
+      OrmAdapter.adapters << adapter
+      super
+    end
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    # Get a list of column/property/field names
+    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.:
+    #
+    #   User.to_adapter.get!(@user.to_key) == @user
+    #
+    def get!(id)
+      raise NotSupportedError
+    end
+
+    # Get an instance by id of the model. Returns nil if a model is not found.
+    # This should comply with ActiveModel#to_key API, i.e.:
+    #
+    #   User.to_adapter.get(@user.to_key) == @user
+    #
+    def get(id)
+      raise NotSupportedError
+    end
+
+    # 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
+    #
+    #   User.to_adapter.find_first :conditions => {:name => "Fred", :age => 23}
+    #   User.to_adapter.find_first :order => [:age, :desc]
+    #   User.to_adapter.find_first :order => :name, :conditions => {:age => 18}
+    #
+    # When specifying :order, it may be
+    # * a single arg e.g. <tt>:order => :name</tt>
+    # * 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 = {})
+      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 = {})
+      raise NotSupportedError
+    end
+
+    # Create a model using attributes
+    def create!(attributes = {})
+      raise NotSupportedError
+    end
+
+    # Destroy an instance by passing in the instance itself.
+    def destroy(object)
+      raise NotSupportedError
+    end
+
+    protected
+
+    def valid_object?(object)
+      object.class == klass
+    end
+
+    def wrap_key(key)
+      key.is_a?(Array) ? key.first : key
+    end
+
+    # 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, limit, offset]
+    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
+
+  class NotSupportedError < NotImplementedError
+    def to_s
+      "method not supported by this orm adapter"
+    end
+  end
+end

data/lib/orm_adapter/to_adapter.rb

@@ -0,0 +1,8 @@
+module OrmAdapter
+  # Extend into a class that has an OrmAdapter
+  module ToAdapter
+    def to_adapter
+      @_to_adapter ||= self::OrmAdapter.new(self)
+    end
+  end
+end

data/lib/orm_adapter/version.rb

@@ -0,0 +1,3 @@
+module OrmAdapter
+  VERSION = "0.4.1"
+end

data/orm_adapter.gemspec

@@ -0,0 +1,35 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "orm_adapter/version"
+
+Gem::Specification.new do |s|
+  s.name = "orm_adapter_rails4_fix"
+  s.version = OrmAdapter::VERSION.dup
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Ian White", "Jose Valim"]
+  s.description = "Provides a single point of entry for using basic features of ruby ORMs"
+  s.summary = "orm_adapter provides a single point of entry for using basic features of popular ruby ORMs.  Its target audience is gem authors who want to support many ruby ORMs."
+  s.email = "ian.w.white@gmail.com"
+  s.homepage = "http://github.com/ianwhite/orm_adapter"
+
+  s.rubyforge_project = "orm_adapter"
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "git", ">= 1.2.5"
+  s.add_development_dependency "yard", ">= 0.6.0"
+  s.add_development_dependency "rake", ">= 0.8.7"
+  s.add_development_dependency "activerecord", ">= 3.0.0"
+  s.add_development_dependency "mongoid", ">= 2.0.0.beta.20"
+  s.add_development_dependency "mongo_mapper", ">= 0.9.0"
+  s.add_development_dependency "bson_ext", ">= 1.3.0"
+  s.add_development_dependency "rspec", ">= 2.4.0"
+  s.add_development_dependency "sqlite3", ">= 1.3.2"
+  s.add_development_dependency "datamapper", ">= 1.0"
+  s.add_development_dependency "dm-sqlite-adapter", ">= 1.0"
+  s.add_development_dependency "dm-active_model", ">= 1.0"
+end
+

data/spec/orm_adapter/adapters/active_record_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'orm_adapter/example_app_shared'
+
+if !defined?(ActiveRecord::Base)
+  puts "** require 'active_record' to run the specs in #{__FILE__}"
+else  
+  ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")
+
+  ActiveRecord::Migration.suppress_messages do
+    ActiveRecord::Schema.define(:version => 0) do
+      create_table(:users, :force => true) {|t| t.string :name; t.integer :rating; }
+      create_table(:notes, :force => true) {|t| t.belongs_to :owner, :polymorphic => true }
+    end
+  end
+  
+  module ArOrmSpec
+    class User < ActiveRecord::Base
+      has_many :notes, :as => :owner
+    end
+
+    class AbstractNoteClass < ActiveRecord::Base
+      self.abstract_class = true
+    end
+
+    class Note < AbstractNoteClass
+      belongs_to :owner, :polymorphic => true
+    end
+  
+    # here be the specs!
+    describe '[ActiveRecord orm adapter]' do
+      before do
+        User.delete_all
+        Note.delete_all
+      end
+    
+      it_should_behave_like "example app with orm_adapter" do
+        let(:user_class) { User }
+        let(:note_class) { Note }
+      end
+      
+      describe "#conditions_to_fields" do
+        describe "with non-standard association keys" do
+          class PerverseNote < Note
+            belongs_to :user, :foreign_key => 'owner_id'
+            belongs_to :pwner, :polymorphic => true, :foreign_key => 'owner_id', :foreign_type => 'owner_type'
+          end
+          
+          let(:user) { User.create! }
+          let(:adapter) { PerverseNote.to_adapter }
+          
+          it "should convert polymorphic object in conditions to the appropriate fields" do
+            adapter.send(:conditions_to_fields, :pwner => user).should == {'owner_id' => user.id, 'owner_type' => user.class.name}
+          end
+          
+          it "should convert belongs_to object in conditions to the appropriate fields" do
+            adapter.send(:conditions_to_fields, :user => user).should == {'owner_id' => user.id}
+          end
+        end
+      end
+    end
+  end
+end

data/spec/orm_adapter/adapters/data_mapper_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'orm_adapter/example_app_shared'
+
+if !defined?(DataMapper)
+  puts "** require 'dm-core' to run the specs in #{__FILE__}"
+else  
+  
+  DataMapper.setup(:default, 'sqlite::memory:')
+  
+  module DmOrmSpec
+    class User
+      include DataMapper::Resource
+      property :id,   Serial
+      property :name, String
+      property :rating, Integer
+      has n, :notes, :child_key => [:owner_id]
+    end
+
+    class Note
+      include DataMapper::Resource
+      property :id,   Serial
+      property :body, String
+      belongs_to :owner, 'User'
+    end
+    
+    require  'dm-migrations'
+    DataMapper.finalize
+    DataMapper.auto_migrate!
+  
+    # here be the specs!
+    describe DataMapper::Resource::OrmAdapter do
+      before do
+        User.destroy
+        Note.destroy
+      end
+
+      it_should_behave_like "example app with orm_adapter" do
+        let(:user_class) { User }
+        let(:note_class) { Note }
+        
+        def reload_model(model)
+          model.class.get(model.id)
+        end
+      end
+    end
+  end
+end