ardm 0.2.7 → 0.3.0

data/Gemfile

@@ -8,13 +8,16 @@ gem 'awesome_print'
 
 group :test do
   gem 'sqlite3'
-  gem 'activerecord', '~> 4.0.0'
   gem 'addressable'
   gem 'database_cleaner'
   gem 'rspec-its'
 end
 
-group :datamapper do
+group :ar do
+  gem 'activerecord', '~> 4.0.0'
+end
+
+group :dm do
   gem 'dm-core', '~> 1.2'
   gem 'dm-sqlite-adapter', '~> 1.2'
   gem 'dm-types', '~> 1.2', git: "git://github.com/engineyard/dm-types.git", branch: "1.2-multijson"

data/README.md

@@ -29,53 +29,58 @@ Lets examine some of the reasons why you might move to ActiveRecord.
 
 ## Installation
 
+Near the top of your config/application.rb, add the following:
+
     require 'ardm'
+    Ardm.orm = ENV['ORM'] || :dm # default
 
-Run your project using the ORM environment variable.
+    Ardm.ar do # only executed if ORM is ActiveRecord
+      Bundler.require(:active_record) # libs related to active record
+      require "active_record/railtie"
+    end
+    Ardm.dm do # only executed if ORM is DataMapper
+      Bundler.require(:data_mapper) # libs related to data mapper
+    end
+    Ardm.setup # this requires the Ardm shim code
 
-    ORM=activerecord bundle exec rake spec
-    ORM=datamapper bundle exec rake spec
+Next you need to change add a base class to EVERY model that previously
+included DataMapper::Resource.
 
-## Incremental migration from DataMapper to ActiveRecord
+This is very tedious but there's no way around it. All ActiveRecord
+models must inherit from ActiveRecord::Base, so Ardm creates an interchangeable
+base class that can be either ActiveRecord or DataMapper.
 
-ActiveRecord requires your models to inherit from ActiveRecord::Base, which makes
-it difficult to approach this migration incrementally. All or nothing is a scary
-way to switch ORMs. To solve this, Ardm supplies Ardm::Record.
+If your model is STI, add it to the base model.
 
-Ardm::Record will be the new base class. You'll need to search and replace
-all models that include DataMapper::Resource, remove it, and add Ardm::Record
-as the base class. If your model is STI, add it to the base model and remove
-DataMapper::Resource from all models.
+I'm sorry, it's the only way.
 
-Example:
+    app/models/my_model.rb
 
-    class MyModel
-      include DataMapper::Resource
-      # ...
+    class MyModel < Ardm::Record # <--- add this
+      include DataMapper::Resource # you can remove this (it should also be shimmed)
     end
 
-    # The model above changes to:
+Run your project using the ORM environment variable.
 
-    class MyModel < Ardm::Record
-      # ...
-    end
+    # Try to get this one working now with the changes above.
+    ORM=dm bundle exec rake spec
 
-With this new base clase you can switch between ActiveRecord and DataMapper
-by flipping a swith in your application. This approach allows you to continue
-developing your application in DataMapper while you work on removing all
-the "datamapper-isms" from your code. This library attempts to take care of
-most DataMapper features, but there are probably tons of small variations
-that are not accounted for.
+    # This will fail horribly
+    ORM=ar bundle exec rake spec
 
-## General Strategy
+With this new base clase and the ORM environment variable, you can switch
+between ActiveRecord and DataMapper by flipping the ORM variable.
 
-This is a complex thing to approach. I'm hoping this project can make this move
-into a repeatable strategy rather than everyone needing to create their own
-unique solution.
+This approach allows you to continue developing your application in
+DataMapper while you work on removing all the "datamapper-isms" from your
+code. This library attempts to take care of most DataMapper features, but
+there are probably tons of small variations that are not accounted for.
+
+## General Strategy
 
-1. Get the application running with Ardm installed. Don't even think about
-   ActiveRecord until you have Ardm working in DataMapper mode and you can
-   deploy your application normally with ardm installed.
+1. Get the application running in DataMapper with Ardm installed. Don't even
+   think about ActiveRecord until you have Ardm working in DataMapper mode and
+   you can deploy your application normally with ardm installed.
 2. Start to remove references to `DataMapper` by using the conversions
    mentioned below. The idea is to remove the `DataMapper` constant completely
    so you can run without `dm-core` when in ActiveRecord mode.
@@ -89,11 +94,15 @@ unique solution.
    DataMapper specific code for ActiveRecord code. You can branch around
    picky code with the `Ardme.activerecord?` and `Ardm.datamapper?` helpers.
 
+This is a complex thing to approach. I hope Ardm will make this change
+into a repeatable strategy rather than everyone needing to create their own
+unique solution.
+
 ## Conversions
 
 Things that access DataMapper directly can be replaced with Ardm invocations:
 
-    DataMapper.finalize    =>  Ardm::Record.finalize (no-op in AR mode)
+    DataMapper.finalize    =>  Ardm::Record.finalize # this is still important for Ardm
     DataMapper.repository  =>  Ardm::Record.repository
     DataMapper.logger      =>  Ardm::Record.logger
 
@@ -110,12 +119,9 @@ adapters for accessing the same data through ActiveRecord.
 If you run into code that is particularly difficult to convert, you can
 duplicate the code and write a different version for each ORM:
 
-    if Ardm.activerecord?
-      Thing.where(Thing.arel_table[:field].matches('something'))
-    else
-      # This is just an example. This should actually work fine in Ardm.
-      Thing.all(:field.like => 'something')
-    end
+    Ardm.ar { Thing.where(Thing.arel_table[:field].matches('something')) }
+    # This is just an example. This should actually work fine in Ardm.
+    Ardm.dm { Thing.all(:field.like => 'something') }
 
 ## Copyright
 

data/lib/ardm/{active_record → ar}/associations.rb

@@ -1,7 +1,7 @@
 
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Associations
       extend ActiveSupport::Concern
 
@@ -66,7 +66,7 @@ module Ardm
           end
         end
 
-        def belongs_to(field, *args)
+        def belongs_to(name, *args)
           options = args.shift || {}
 
           if String === options || Class === options # belongs_to :name, 'Class', options: 'here'
@@ -74,20 +74,38 @@ module Ardm
           end
 
           unless Hash === options
-            raise ArgumentError, "bad belongs_to #{field} options format #{options.inspect}"
+            raise ArgumentError, "bad belongs_to #{name} options format #{options.inspect}"
+          end
+
+          if options.has_key?(:key) || options.has_key?(:unique)
+            raise Ardm::NotImplemented, "belongs to :key and :unique are not implemented."
           end
 
           options.delete(:default)
-          options.delete(:required)
-          opts = Ardm::ActiveRecord::Associations.convert_options(self, options)
-          super field, *opts
-          klass = self
-          Ardm::ActiveRecord::Finalize.on_finalize do
-            assoc = reflect_on_association(field)
-            klass.class_eval do
-              # @todo String is a hack... hoping AR can convert strings to integers during save for integer keys.
-              property assoc.foreign_key, assoc.primary_key_column.sql_type == "Integer" ? Integer : String, key: false
+          required = options.delete(:required)
+          opts = Ardm::Ar::Associations.convert_options(self, options)
+          super name, *opts
+
+          model = self
+          Ardm::Ar::Finalize.on_finalize do
+            return @child_key if defined?(@child_key)
+
+            properties = model.properties
+            assoc = reflect_on_association(name)
+
+            property_name = assoc.foreign_key
+            target_property = assoc.klass.properties.key.first
+
+            properties[property_name] || begin
+              source_key_options = Ardm::Ext::Hash.only(target_property.options, :length, :precision, :scale, :min, :max).update(
+                :index    => name,
+                :required => (required == false ? false : true),
+                :key      => false,
+                :unique   => false
+              )
+              model.property(property_name, target_property.to_child_key, source_key_options)
             end
+
           end
           nil
         end
@@ -107,8 +125,8 @@ module Ardm
             raise ArgumentError, "bad has #{count} options format #{options.inspect}"
           end
 
-          options[:order] = Ardm::ActiveRecord::Query.order(self, options[:order]) if options[:order]
-          opts = Ardm::ActiveRecord::Associations.convert_options(self, options, :through, :order, :source)
+          options[:order] = Ardm::Ar::Query.order(self, options[:order]) if options[:order]
+          opts = Ardm::Ar::Associations.convert_options(self, options, :through, :order, :source)
 
           case count
           when 1      then has_one  name, *opts

data/lib/ardm/ar/base.rb

@@ -0,0 +1,53 @@
+require 'active_support/concern'
+
+require 'ardm/ar/associations'
+require 'ardm/ar/dirty'
+require 'ardm/ar/finalize'
+require 'ardm/ar/hooks'
+require 'ardm/ar/is'
+require 'ardm/ar/inheritance'
+require 'ardm/ar/persistence'
+require 'ardm/ar/property'
+require 'ardm/ar/query'
+require 'ardm/ar/repository'
+require 'ardm/ar/storage_names'
+require 'ardm/ar/validations'
+
+module Ardm
+  module Ar
+    # Include all the Ardm modules.
+    #
+    # You can use this directly if you want your own abstract base class.
+    #
+    #   require 'ardm/active_record/base'
+    #
+    #   class MyRecord < ActiveRecord::Base
+    #     include Ardm::Ar::Base
+    #   end
+    #
+    # Or Ardm::ActiveRecord::Base is built in to Ardm::Record
+    #
+    #   require 'ardm/active_record/record'
+    #
+    #   class MyRecord < Ardm::Record
+    #     # already included
+    #   end
+    #
+    module Base
+      extend ActiveSupport::Concern
+
+      include Ardm::Ar::Associations
+      include Ardm::Ar::Finalize
+      include Ardm::Ar::Hooks
+      include Ardm::Ar::Dirty
+      include Ardm::Ar::Is
+      include Ardm::Ar::Inheritance
+      include Ardm::Ar::Persistence
+      include Ardm::Ar::Property
+      include Ardm::Ar::Query
+      include Ardm::Ar::Repository
+      include Ardm::Ar::StorageNames
+      include Ardm::Ar::Validations
+    end
+  end
+end

data/lib/ardm/ar/data_mapper_constant.rb

@@ -0,0 +1 @@
+::DataMapper = Ardm::Ar::DataMapperConstantProxy

data/lib/ardm/{active_record → ar}/data_mapper_constant_proxy.rb

@@ -1,5 +1,5 @@
 module Ardm
-  module ActiveRecord
+  module Ar
     module DataMapperConstantProxy
 
       class << self

data/lib/ardm/{active_record → ar}/dirty.rb

@@ -1,5 +1,5 @@
 module Ardm
-  module ActiveRecord
+  module Ar
     module Dirty
       def dirty?
         changed?

data/lib/ardm/ar/finalize.rb

@@ -0,0 +1,26 @@
+module Ardm
+  module Ar
+    module Finalize
+      extend ActiveSupport::Concern
+
+      def self.finalizers
+        @finalizers ||= []
+      end
+
+      def self.on_finalize(&block)
+        return unless block_given?
+        finalizers << block
+      end
+
+      def self.finalize
+        Ardm::Ar::Finalize.finalizers.each { |f| f.call }
+      end
+
+      module ClassMethods
+        def finalize
+          Ardm::Ar::Finalize.finalize
+        end
+      end
+    end
+  end
+end

data/lib/ardm/{active_record → ar}/hooks.rb

@@ -1,7 +1,7 @@
 require 'active_support/concern'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Hooks
       extend ActiveSupport::Concern
 

data/lib/ardm/{active_record → ar}/inheritance.rb

@@ -1,7 +1,7 @@
 require 'active_support/concern'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Inheritance
       extend ActiveSupport::Concern
 

data/lib/ardm/{active_record → ar}/is/state_machine.rb

@@ -1,5 +1,5 @@
 module Ardm
-  module ActiveRecord
+  module Ar
     module Is
       module StateMachine
         extend ActiveSupport::Concern

data/lib/ardm/{active_record → ar}/is.rb

@@ -1,8 +1,8 @@
 require 'active_support/concern'
-require 'ardm/active_record/is/state_machine'
+require 'ardm/ar/is/state_machine'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Is
       extend ActiveSupport::Concern
 
@@ -10,7 +10,7 @@ module Ardm
         def is(target, options={}, &block)
           case target
           when :state_machine
-            include Ardm::ActiveRecord::Is::StateMachine
+            include Ardm::Ar::Is::StateMachine
             is_state_machine(options, &block)
           else
             STDERR.puts "TODO: #{self} is #{target.inspect}, #{options.inspect}"

data/lib/ardm/{active_record → ar}/persistence.rb

@@ -1,7 +1,7 @@
 require 'active_support/concern'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Persistence
       extend ActiveSupport::Concern
 

data/lib/ardm/{active_record → ar}/predicate_builder/array_handler.rb

@@ -1,5 +1,5 @@
 module Ardm
-  module ActiveRecord
+  module Ar
     module PredicateBuilder
       class ArrayHandler # :nodoc:
         def call(attribute, value)

data/lib/ardm/{active_record → ar}/predicate_builder/rails3.rb

@@ -1,7 +1,7 @@
 require 'active_support/concern'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module PredicateBuilder
       module Rails3
         extend ActiveSupport::Concern

data/lib/ardm/{active_record → ar}/predicate_builder/rails4.rb

@@ -1,7 +1,7 @@
 require 'active_support/concern'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module PredicateBuilder
       module Rails4
         extend ActiveSupport::Concern

data/lib/ardm/{active_record → ar}/predicate_builder/relation_handler.rb

@@ -1,5 +1,5 @@
 module Ardm
-  module ActiveRecord
+  module Ar
     module PredicateBuilder
       class RelationHandler # :nodoc:
         def call(attribute, value)

data/lib/ardm/ar/predicate_builder.rb

@@ -0,0 +1,19 @@
+require 'active_record/relation/predicate_builder' # force it to load
+
+require 'ardm/ar/predicate_builder/relation_handler'
+require 'ardm/ar/predicate_builder/array_handler'
+
+if ::ActiveRecord::PredicateBuilder.respond_to? :expand
+  require 'ardm/ar/predicate_builder/rails4'
+  ::ActiveRecord::PredicateBuilder.send(:include, Ardm::Ar::PredicateBuilder::Rails4)
+else
+  require 'ardm/ar/predicate_builder/rails3'
+  ::ActiveRecord::PredicateBuilder.send(:include, Ardm::Ar::PredicateBuilder::Rails3)
+end
+
+::ActiveRecord::PredicateBuilder.class_eval do
+  # calls super instead of calling the method on the class
+  class << self
+    remove_method :build_from_hash
+  end
+end

data/lib/ardm/{active_record → ar}/property.rb

@@ -2,13 +2,13 @@ require 'active_support/concern'
 require 'ardm/property/lookup'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Property
       extend ActiveSupport::Concern
 
       included do
         extend Ardm::Property::Lookup
-        extend Ardm::ActiveRecord::Property::ClassMethods
+        extend Ardm::Ar::Property::ClassMethods
 
         instance_variable_set(:@properties, Ardm::PropertySet.new)
         instance_variable_set(:@field_naming_convention, nil)

data/lib/ardm/{active_record → ar}/query.rb

@@ -3,10 +3,10 @@ require 'active_support/concern'
 require 'ardm/query/expression'
 require 'ardm/query/operator'
 require 'ardm/query/ext/symbol'
-require 'ardm/active_record/predicate_builder'
+require 'ardm/ar/predicate_builder'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Query
       extend ActiveSupport::Concern
 

data/lib/ardm/{active_record → ar}/record.rb

@@ -1,11 +1,11 @@
 require 'active_record'
 require 'ardm'
-require 'ardm/active_record/base'
+require 'ardm/ar/base'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     class Record < ::ActiveRecord::Base
-      include Ardm::ActiveRecord::Base
+      include Ardm::Ar::Base
 
       self.abstract_class = true
 
@@ -15,7 +15,7 @@ module Ardm
           attr_accessible prop.name
           attr_accessible prop.field
         rescue => e
-          puts "WARNING: `attr_accessible` not found. Include 'protected_attributes' gem in rails >= 4 (or if you need it).\n#{e}" unless $attr_accessible_warning
+          puts "WARNING: `attr_accessible` not found. Include 'protected_attributes' gem in rails >= 4 (if you need it).\n#{e}" unless $attr_accessible_warning
           $attr_accessible_warning = true
         end
         prop

data/lib/ardm/{active_record → ar}/relation.rb

@@ -1,8 +1,8 @@
 require 'active_support/concern'
-require 'ardm/active_record/collection'
+require 'ardm/ar/collection'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Relation
       extend ActiveSupport::Concern
 

data/lib/ardm/{active_record → ar}/repository.rb

@@ -1,7 +1,7 @@
 require 'active_support/concern'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Repository
       extend ActiveSupport::Concern
 
@@ -18,7 +18,7 @@ module Ardm
           if block_given?
             yield
           else
-            Ardm::ActiveRecord::Repository::Proxy.new self
+            Ardm::Ar::Repository::Proxy.new self
           end
         end
       end

data/lib/ardm/{active_record → ar}/serialization.rb

@@ -1,7 +1,7 @@
 require 'active_support/concern'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module Serialization
       extend ActiveSupport::Concern
 

data/lib/ardm/{active_record → ar}/storage_names.rb

@@ -1,13 +1,13 @@
 require 'active_support/concern'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     module StorageNames
       extend ActiveSupport::Concern
 
       module ClassMethods
         def storage_names
-          Ardm::ActiveRecord::StorageNames::Proxy.new(self)
+          Ardm::Ar::StorageNames::Proxy.new(self)
         end
       end
 

data/lib/ardm/{active_record → ar}/validations.rb

@@ -2,7 +2,7 @@ require 'active_support/concern'
 require 'active_model/validations'
 
 module Ardm
-  module ActiveRecord
+  module Ar
     # Extend ActiveRecord to support DataMapper validations
     module Validations
       extend ActiveSupport::Concern
@@ -34,22 +34,22 @@ module Ardm
       module ClassMethods
 
         def validates_belongs_to(*fields)
-          fields, options = Ardm::ActiveRecord::Validations.extract_options(fields)
+          fields, options = Ardm::Ar::Validations.extract_options(fields)
           validates *fields, presence: options
         end
 
         def validates_presence_of(*fields)
-          fields, options = Ardm::ActiveRecord::Validations.extract_options(fields)
+          fields, options = Ardm::Ar::Validations.extract_options(fields)
           validates *fields, presence: options
         end
 
         def validates_length_of(*fields)
-          fields, options = Ardm::ActiveRecord::Validations.extract_options(fields, :in, :within, :maximum, :minimum, :is)
+          fields, options = Ardm::Ar::Validations.extract_options(fields, :in, :within, :maximum, :minimum, :is)
           validates *fields, length: options
         end
 
         def validates_uniqueness_of(*fields)
-          fields, options = Ardm::ActiveRecord::Validations.extract_options(fields, :scope)
+          fields, options = Ardm::Ar::Validations.extract_options(fields, :scope)
           fields = fields.map do |field|
             if property = properties[field]
               property.field
@@ -71,7 +71,7 @@ module Ardm
         end
 
         def validates_within(*fields)
-          fields, options = Ardm::ActiveRecord::Validations.extract_options(fields, :in)
+          fields, options = Ardm::Ar::Validations.extract_options(fields, :in)
           validates *fields, inclusion: options
         end
 
@@ -81,7 +81,7 @@ module Ardm
         # validates_with_method :attr, method: :method_name
         # validates_with_method :method_name, options: "here"
         def validates_with_method(*fields)
-          fields, options = Ardm::ActiveRecord::Validations.extract_options(fields, :method)
+          fields, options = Ardm::Ar::Validations.extract_options(fields, :method)
 
           # validates_with_method :attr, :method_name
           att, meth = *fields

data/lib/ardm/{active_record.rb → ar.rb}

@@ -26,20 +26,22 @@ require 'ardm/support/descendant_set'
 require 'active_record'
 require 'active_record/relation'
 
-require 'ardm/active_record/record'
-require 'ardm/active_record/relation'
-require 'ardm/active_record/data_mapper_constant_proxy'
+require 'ardm/ar/record'
+require 'ardm/ar/relation'
+require 'ardm/ar/data_mapper_constant_proxy'
+require 'ardm/ar/validations'
 
 module Ardm
-  Record = Ardm::ActiveRecord::Record
+  Record           = Ardm::Ar::Record
+  Validations      = Ardm::Ar::Validations
   SaveFailureError = ::ActiveRecord::RecordNotSaved
-  RecordNotFound = ::ActiveRecord::RecordNotFound
+  RecordNotFound   = ::ActiveRecord::RecordNotFound
 
   def self.define_datamapper_constant!
-    require 'ardm/active_record/data_mapper_constant'
+    require 'ardm/ar/data_mapper_constant'
   end
 end
 
 ::ActiveRecord::Relation.class_eval do
-  include Ardm::ActiveRecord::Relation
+  include Ardm::Ar::Relation
 end

data/lib/ardm/dm/collection.rb

@@ -0,0 +1,27 @@
+module Ardm::Dm
+  module RelationChain
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method :old_delegate_to_relationship, :delegate_to_relationship
+    end
+
+    def delegate_to_relationship(relationship, query = nil)
+      Ardm::Deprecation.warn("Relation chain #{model.name}.#{relationship.name}")
+      old_delegate_to_relationship(relationship, query)
+    end
+
+    def includes(*)
+      self
+    end
+
+    def references(*)
+      self
+    end
+  end
+end
+
+DataMapper::Collection.class_eval do
+  include Ardm::Dm::RelationChain
+end
+

data/lib/ardm/{data_mapper → dm}/record.rb

@@ -1,14 +1,34 @@
 require 'active_support/concern'
 require 'dm-core'
-require 'ardm/data_mapper/collection'
+require 'ardm/dm/collection'
 
 module Ardm
-  module DataMapper
+  module Dm
     class Record
       def self.inherited(base)
-        base.send(:include, ::DataMapper::Resource)
+        @on_inherited.each { |block| base.class_eval(&block) }
       end
 
+      def self.on_inherited(&block)
+        if Ardm::Dm::Record == self
+          @on_inherited ||= []
+          @on_inherited << block
+          @on_inherited
+        else
+          class_eval(&block)
+        end
+      end
+
+      class << self
+        alias __include_after_inherited__ include
+      end
+
+      def self.include(mod)
+        on_inherited { __include_after_inherited__ mod }
+      end
+
+      include ::DataMapper::Resource
+
       def self.finalize
         ::DataMapper.finalize
       end

data/lib/ardm/dm.rb

@@ -0,0 +1,14 @@
+require 'ardm'
+
+require 'dm-core'
+require 'ardm/dm/record'
+require 'ardm/dm/collection'
+
+module Ardm
+  Record           = Ardm::Dm::Record
+  Validations      = ::DataMapper::Validations
+  SaveFailureError = ::DataMapper::SaveFailureError
+  RecordNotFound   = ::DataMapper::ObjectNotFoundError
+  Property         = ::DataMapper::Property
+  Collection       = ::DataMapper::Collection
+end

data/lib/ardm/version.rb

@@ -1,3 +1,3 @@
 module Ardm
-  VERSION = '0.2.7'
+  VERSION = '0.3.0'
 end

data/lib/ardm.rb

@@ -3,65 +3,115 @@ require 'ardm/deprecation'
 module Ardm
   NotImplemented = Class.new(RuntimeError)
 
-  # Check which ORM is loaded in Ardm.
-  #
-  # @api public
-  def self.orm
-    @orm ||= :active_record
-  end
+  class << self
 
-  # Set which orm to load.
-  #
-  # @api public
-  def self.orm=(orm)
-    if defined?(Ardm::ActiveRecord) || defined?(Ardm::DataMapper)
-      raise "Cannot change Ardm.orm when #{orm} libs are already loaded."
+    # Setup the ORM using orm arg or $ORM, then require the correct shim libs.
+    #
+    # If an ORM is not specified as an argument, ENV['ORM'] will be used.
+    # If $ORM is not set, then Ardm will raise.
+    #
+    # Execute the block if one is given. This is a good time to require
+    # active_record or dm-core using Ardm.ar or Ardm.dm blocks.
+    #
+    #     Ardm.setup ENV['ORM'] do
+    #       Ardm.ar do
+    #         Bundler.require(:active_record)
+    #         require "active_record/railtie"
+    #       end
+    #       Ardm.dm { Bundler.require(:data_mapper) }
+    #     end
+    #
+    # The Ardm shim libs will be required after the block returns.
+    #
+    # @api public
+    def setup(orm=nil)
+      self.orm = orm if orm
+      yield self if block_given?
+      require lib
     end
 
-    @orm = case orm.to_s
-           when /active_?record/, '' then :active_record
-           when /data_?mapper/       then :data_mapper
-           else raise "Unknown ENV['ORM']: #{ENV['ORM']}"
-           end
-  end
+    # Check which ORM is loaded in Ardm.
+    #
+    # @api public
+    def orm
+      if @orm
+        return @orm
+      else
+        self.orm = ENV['ORM']
+      end
+      @orm
+    end
 
-  # Return true if Ardm has loaded ActiveRecord ORM.
-  #
-  # @api public
-  def self.active_record?
-    orm == :active_record
-  end
+    # Set which orm to load.
+    #
+    # @api public
+    def orm=(orm)
+      neworm =
+        case orm.to_s
+        when /(ar|active_?record)/ then :ar
+        when /(dm|data_?mapper)/   then :dm
+        when "" then raise "Specify Ardm.orm by assigning :ar or :dm or by setting ENV['ORM']"
+        else raise "Unknown Ardm.orm. Expected: (ar|dm). Got: #{orm.inspect}"
+        end
 
-  # Return true if Ardm has loaded DataMapper ORM.
-  #
-  # @api public
-  def self.data_mapper?
-    orm == :data_mapper
-  end
+      if @orm == neworm
+        return @orm
+      end
 
-  # Yield if Ardm has loaded ActiveRecord ORM.
-  #
-  # @api public
-  def self.active_record
-    yield if block_given? && active_record?
-  end
+      if defined?(Ardm::Ar) || defined?(Ardm::Dm)
+        raise "Cannot change Ardm.orm when #{self.orm} libs are already loaded."
+      end
 
-  def self.rails3?
-    self.active_record? && ::ActiveRecord::VERSION::STRING >= "3.0" && ::ActiveRecord::VERSION::STRING <= "4.0"
-  end
+      @orm = neworm
+    end
 
-  def self.rails4?
-    self.active_record? && !self.rails3?
-  end
+    def lib
+      "ardm/#{orm}"
+    end
 
-  # Yield if Ardm has loaded DataMapper ORM.
-  #
-  # @api public
-  def self.data_mapper
-    yield if block_given? && data_mapper?
-  end
+    # Return true if Ardm has loaded ActiveRecord ORM.
+    #
+    # @api public
+    def ar?
+      orm == :ar
+    end
+    alias activerecord? ar?
+    alias active_record? ar?
+
+    # Return true if Ardm has loaded DataMapper ORM.
+    #
+    # @api public
+    def dm?
+      orm == :dm
+    end
+    alias datamapper? dm?
+    alias data_mapper? dm?
 
-  def self.lib
-    "ardm/#{orm}"
+    # Yield if Ardm has loaded ActiveRecord ORM.
+    #
+    # @api public
+    def ar
+      yield if block_given? && ar?
+    end
+    alias activerecord ar
+    alias active_record ar
+
+    # Yield if Ardm has loaded DataMapper ORM.
+    #
+    # @api public
+    def dm
+      yield if block_given? && dm?
+    end
+
+    alias datamapper dm
+    alias data_mapper dm
+
+    def rails3?
+      ar? && ::ActiveRecord::VERSION::STRING >= "3.0" && ::ActiveRecord::VERSION::STRING <= "4.0"
+    end
+
+    def rails4?
+      ar? && !rails3?
+    end
   end
 end

data/spec/ardm/datamapper_constants_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Ardm::ActiveRecord::DataMapperConstantProxy do
+describe Ardm::Ar::DataMapperConstantProxy do
   it 'defines Resource' do
     expect(described_class::Resource).to be_kind_of(Module)
   end

data/spec/spec_helper.rb

@@ -1,11 +1,15 @@
-Bundler.require(:default, :test)
+#Bundler.require(:default, :test)
+require 'rspec'
 
-ENV['ORM'] ||= 'active_record'
-require 'ardm/env'
+require 'ardm'
+Ardm.orm = ENV['ORM'] || 'active_record'
+Ardm.setup
+
+require 'database_cleaner'
 
 Dir["#{Pathname(__FILE__).dirname.expand_path}/{shared,support}/*.rb"].each { |file| require file }
 
-Ardm.active_record do
+Ardm.ar do
   ActiveRecord::Base.configurations = { "ardm" => {
     "database" => "db/test.sqlite",
     "adapter" => "sqlite3"
@@ -20,12 +24,16 @@ Ardm.active_record do
   end
 end
 
-Ardm.data_mapper do
+Ardm.dm do
   Bundler.require(:datamapper)
   DataMapper.setup(:default, "sqlite3://#{File.expand_path("../../db/test.sqlite", __FILE__)}")
   DataMapper.auto_migrate!
 end
 
+Dir["#{Pathname(__FILE__).dirname.expand_path}/fixtures/*.rb"].each { |file| require file }
+
+Ardm::Record.finalize
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   if ENV["ORM"] == "active_record"

data/spec/support/logger.rb

@@ -1,7 +1,7 @@
 if defined?(::DataMapper)
-  module DataMapper::LogListener
+  module ::DataMapper::LogListener
     def log(message)
-      DataMapper.logger.info("#{message.query}")
+      ::DataMapper.logger.info("#{message.query}")
       super
     rescue Exception => e
       ::DataMapper.logger.error "[datamapper] #{e.class.name}: #{e.message}: #{message.inspect}}"
@@ -27,7 +27,7 @@ RSpec.configure do |config|
       require 'active_support/inflector'
       driver = DataObjects.const_get(ActiveSupport::Inflector.camelize('sqlite3'), false)
 
-      DataObjects::Connection.send(:include, DataMapper::LogListener)
+      DataObjects::Connection.send(:include, ::DataMapper::LogListener)
       # FIXME Setting DataMapper::Logger.new($stdout, :off) alone won't work because the #log
       # method is currently only available in DO and needs an explicit DO Logger instantiated.
       # We turn the logger :off because ActiveSupport::Notifications handles displaying log messages

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ardm
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -182,37 +182,36 @@ files:
 - ardm.gemspec
 - db/.gitignore
 - lib/ardm.rb
-- lib/ardm/active_record.rb
-- lib/ardm/active_record/associations.rb
-- lib/ardm/active_record/base.rb
-- lib/ardm/active_record/collection.rb
-- lib/ardm/active_record/data_mapper_constant.rb
-- lib/ardm/active_record/data_mapper_constant_proxy.rb
-- lib/ardm/active_record/dirty.rb
-- lib/ardm/active_record/finalize.rb
-- lib/ardm/active_record/hooks.rb
-- lib/ardm/active_record/inheritance.rb
-- lib/ardm/active_record/is.rb
-- lib/ardm/active_record/is/state_machine.rb
-- lib/ardm/active_record/persistence.rb
-- lib/ardm/active_record/predicate_builder.rb
-- lib/ardm/active_record/predicate_builder/array_handler.rb
-- lib/ardm/active_record/predicate_builder/rails3.rb
-- lib/ardm/active_record/predicate_builder/rails4.rb
-- lib/ardm/active_record/predicate_builder/relation_handler.rb
-- lib/ardm/active_record/property.rb
-- lib/ardm/active_record/query.rb
-- lib/ardm/active_record/record.rb
-- lib/ardm/active_record/relation.rb
-- lib/ardm/active_record/repository.rb
-- lib/ardm/active_record/serialization.rb
-- lib/ardm/active_record/storage_names.rb
-- lib/ardm/active_record/validations.rb
-- lib/ardm/data_mapper.rb
-- lib/ardm/data_mapper/collection.rb
-- lib/ardm/data_mapper/record.rb
+- lib/ardm/ar.rb
+- lib/ardm/ar/associations.rb
+- lib/ardm/ar/base.rb
+- lib/ardm/ar/collection.rb
+- lib/ardm/ar/data_mapper_constant.rb
+- lib/ardm/ar/data_mapper_constant_proxy.rb
+- lib/ardm/ar/dirty.rb
+- lib/ardm/ar/finalize.rb
+- lib/ardm/ar/hooks.rb
+- lib/ardm/ar/inheritance.rb
+- lib/ardm/ar/is.rb
+- lib/ardm/ar/is/state_machine.rb
+- lib/ardm/ar/persistence.rb
+- lib/ardm/ar/predicate_builder.rb
+- lib/ardm/ar/predicate_builder/array_handler.rb
+- lib/ardm/ar/predicate_builder/rails3.rb
+- lib/ardm/ar/predicate_builder/rails4.rb
+- lib/ardm/ar/predicate_builder/relation_handler.rb
+- lib/ardm/ar/property.rb
+- lib/ardm/ar/query.rb
+- lib/ardm/ar/record.rb
+- lib/ardm/ar/relation.rb
+- lib/ardm/ar/repository.rb
+- lib/ardm/ar/serialization.rb
+- lib/ardm/ar/storage_names.rb
+- lib/ardm/ar/validations.rb
 - lib/ardm/deprecation.rb
-- lib/ardm/env.rb
+- lib/ardm/dm.rb
+- lib/ardm/dm/collection.rb
+- lib/ardm/dm/record.rb
 - lib/ardm/property.rb
 - lib/ardm/property/api_key.rb
 - lib/ardm/property/bcrypt_hash.rb
@@ -256,7 +255,6 @@ files:
 - lib/ardm/query/expression.rb
 - lib/ardm/query/ext/symbol.rb
 - lib/ardm/query/operator.rb
-- lib/ardm/record.rb
 - lib/ardm/support/assertions.rb
 - lib/ardm/support/deprecate.rb
 - lib/ardm/support/descendant_set.rb

data/lib/ardm/active_record/base.rb

@@ -1,53 +0,0 @@
-require 'active_support/concern'
-
-require 'ardm/active_record/associations'
-require 'ardm/active_record/dirty'
-require 'ardm/active_record/finalize'
-require 'ardm/active_record/hooks'
-require 'ardm/active_record/is'
-require 'ardm/active_record/inheritance'
-require 'ardm/active_record/persistence'
-require 'ardm/active_record/property'
-require 'ardm/active_record/query'
-require 'ardm/active_record/repository'
-require 'ardm/active_record/storage_names'
-require 'ardm/active_record/validations'
-
-module Ardm
-  module ActiveRecord
-    # Include all the Ardm modules.
-    #
-    # You can use this directly if you want your own abstract base class.
-    #
-    #   require 'ardm/active_record/base'
-    #
-    #   class MyRecord < ActiveRecord::Base
-    #     include Ardm::ActiveRecord::Base
-    #   end
-    #
-    # Or Ardm::ActiveRecord::Base is built in to Ardm::Record
-    #
-    #   require 'ardm/active_record/record'
-    #
-    #   class MyRecord < Ardm::Record
-    #     # already included
-    #   end
-    #
-    module Base
-      extend ActiveSupport::Concern
-
-      include Ardm::ActiveRecord::Associations
-      include Ardm::ActiveRecord::Finalize
-      include Ardm::ActiveRecord::Hooks
-      include Ardm::ActiveRecord::Dirty
-      include Ardm::ActiveRecord::Is
-      include Ardm::ActiveRecord::Inheritance
-      include Ardm::ActiveRecord::Persistence
-      include Ardm::ActiveRecord::Property
-      include Ardm::ActiveRecord::Query
-      include Ardm::ActiveRecord::Repository
-      include Ardm::ActiveRecord::StorageNames
-      include Ardm::ActiveRecord::Validations
-    end
-  end
-end

data/lib/ardm/active_record/data_mapper_constant.rb

@@ -1 +0,0 @@
-::DataMapper = Ardm::ActiveRecord::DataMapperConstantProxy

data/lib/ardm/active_record/finalize.rb

@@ -1,19 +0,0 @@
-module Ardm
-  module ActiveRecord
-    module Finalize
-      extend ActiveSupport::Concern
-
-      def self.on_finalize(&block)
-        @on_finalize ||= []
-        @on_finalize << block if block_given?
-        @on_finalize
-      end
-
-      module ClassMethods
-        def finalize
-          Ardm::ActiveRecord::Finalize.on_finalize.each { |f| f.call }
-        end
-      end
-    end
-  end
-end

data/lib/ardm/active_record/predicate_builder.rb

@@ -1,19 +0,0 @@
-require 'active_record/relation/predicate_builder' # force it to load
-
-require 'ardm/active_record/predicate_builder/relation_handler'
-require 'ardm/active_record/predicate_builder/array_handler'
-
-if ::ActiveRecord::PredicateBuilder.respond_to? :expand
-  require 'ardm/active_record/predicate_builder/rails4'
-  ::ActiveRecord::PredicateBuilder.send(:include, Ardm::ActiveRecord::PredicateBuilder::Rails4)
-else
-  require 'ardm/active_record/predicate_builder/rails3'
-  ::ActiveRecord::PredicateBuilder.send(:include, Ardm::ActiveRecord::PredicateBuilder::Rails3)
-end
-
-::ActiveRecord::PredicateBuilder.class_eval do
-  # calls super instead of calling the method on the class
-  class << self
-    remove_method :build_from_hash
-  end
-end

data/lib/ardm/data_mapper/collection.rb

@@ -1,18 +0,0 @@
-DataMapper::Collection.class_eval do
-
-  alias_method :old_delegate_to_relationship, :delegate_to_relationship
-
-  def delegate_to_relationship(relationship, query = nil)
-    Ardm::Deprecation.warn("Relation chain #{model.name}.#{relationship.name}")
-    old_delegate_to_relationship(relationship, query)
-  end
-
-  def includes(*)
-    self
-  end
-
-  def references(*)
-    self
-  end
-end
-

data/lib/ardm/data_mapper.rb

@@ -1,10 +0,0 @@
-require 'ardm'
-require 'ardm/data_mapper/record'
-
-module Ardm
-  Record = Ardm::DataMapper::Record
-  SaveFailureError = ::DataMapper::SaveFailureError
-  RecordNotFound = ::DataMapper::ObjectNotFoundError
-  Property = ::DataMapper::Property
-  Collection = ::DataMapper::Collection
-end

data/lib/ardm/env.rb

@@ -1,5 +0,0 @@
-# Load Ardm based on the $ORM environment variable.
-#
-require 'ardm'
-Ardm.orm = ENV['ORM']
-require Ardm.lib

data/lib/ardm/record.rb

@@ -1 +0,0 @@
-require "ardm/#{Ardm.orm}/record"