datamapper-dm-core 0.9.11 → 0.10.0

data/lib/dm-core.rb

@@ -4,27 +4,20 @@
 # * Requires fastthread, support libs, and base.
 # * Sets the application root and environment for compatibility with frameworks
 #   such as Rails or Merb.
-# * Checks for the database.yml and loads it if it exists.
-# * Sets up the database using the config from the Yaml file or from the
-#   environment.
 #
 
+require 'addressable/uri'
+require 'base64'
+require 'bigdecimal'
+require 'bigdecimal/util'
 require 'date'
+require 'extlib'
 require 'pathname'
-require 'rubygems'
 require 'set'
 require 'time'
 require 'yaml'
 
-gem 'addressable', '~>2.0.1'
-require 'addressable/uri'
-
-gem 'extlib', '~>0.9.11'
-require 'extlib'
-require 'extlib/inflection'
-
 begin
-  gem 'fastthread', '~>1.0.1'
   require 'fastthread'
 rescue LoadError
   # fastthread not installed
@@ -32,30 +25,58 @@ end
 
 dir = Pathname(__FILE__).dirname.expand_path / 'dm-core'
 
-require dir / 'support'
-require dir / 'resource'
+require dir / 'support' / 'chainable'
+require dir / 'support' / 'deprecate'
+require dir / 'support' / 'equalizer'
+
 require dir / 'model'
+require dir / 'model' / 'descendant_set'
+require dir / 'model' / 'hook'
+require dir / 'model' / 'is'
+require dir / 'model' / 'scope'
+require dir / 'model' / 'relationship'
+require dir / 'model' / 'property'
 
-require dir / 'dependency_queue'
-require dir / 'type'
-require dir / 'type_map'
-require dir / 'types'
-require dir / 'hook'
-require dir / 'associations'
-require dir / 'auto_migrations'
+require dir / 'collection'
+
+require dir / 'adapters'
+require dir / 'adapters' / 'abstract_adapter'
+require dir / 'associations' / 'relationship'
+require dir / 'associations' / 'one_to_many'
+require dir / 'associations' / 'one_to_one'
+require dir / 'associations' / 'many_to_one'
+require dir / 'associations' / 'many_to_many'
 require dir / 'identity_map'
-require dir / 'logger'
-require dir / 'migrator'
-require dir / 'naming_conventions'
+require dir / 'migrations'                      # TODO: move to dm-more
+require dir / 'property'
 require dir / 'property_set'
 require dir / 'query'
-require dir / 'transaction'
+require dir / 'query' / 'conditions' / 'operation'
+require dir / 'query' / 'conditions' / 'comparison'
+require dir / 'query' / 'operator'
+require dir / 'query' / 'direction'
+require dir / 'query' / 'path'
+require dir / 'query' / 'sort'
 require dir / 'repository'
-require dir / 'scope'
-require dir / 'property'
-require dir / 'adapters'
-require dir / 'collection'
-require dir / 'is'
+require dir / 'resource'
+require dir / 'support' / 'logger'
+require dir / 'support' / 'naming_conventions'
+require dir / 'transaction'                     # TODO: move to dm-more
+require dir / 'type'
+require dir / 'types' / 'boolean'
+require dir / 'types' / 'discriminator'
+require dir / 'types' / 'text'
+require dir / 'types' / 'paranoid_datetime'     # TODO: move to dm-more
+require dir / 'types' / 'paranoid_boolean'      # TODO: move to dm-more
+require dir / 'types' / 'object'
+require dir / 'types' / 'serial'
+require dir / 'version'
+
+require dir / 'core_ext' / 'kernel'             # TODO: do not load automatically
+require dir / 'core_ext' / 'symbol'             # TODO: do not load automatically
+
+# A logger should always be present. Lets be consistent with DO
+DataMapper::Logger.new(StringIO.new, :fatal)
 
 # == Setup and Configuration
 # DataMapper uses URIs or a connection hash to connect to your data-store.
@@ -76,10 +97,10 @@ require dir / 'is'
 # address the data-store on the server.
 #
 # Here's some examples
-#   DataMapper.setup(:default, "sqlite3://path/to/your/project/db/development.db")
-#   DataMapper.setup(:default, "mysql://localhost/dm_core_test")
+#   DataMapper.setup(:default, 'sqlite3://path/to/your/project/db/development.db')
+#   DataMapper.setup(:default, 'mysql://localhost/dm_core_test')
 #     # no auth-info
-#   DataMapper.setup(:default, "postgres://root:supahsekret@127.0.0.1/dm_core_test")
+#   DataMapper.setup(:default, 'postgres://root:supahsekret@127.0.0.1/dm_core_test')
 #     # with auth-info
 #
 #
@@ -88,7 +109,7 @@ require dir / 'is'
 #
 #   DataMapper.setup(:default, {
 #     :adapter  => 'adapter_name_here',
-#     :database => "path/to/repo",
+#     :database => 'path/to/repo',
 #     :username => 'username',
 #     :password => 'password',
 #     :host     => 'hostname'
@@ -97,67 +118,71 @@ require dir / 'is'
 # === Logging
 # To turn on error logging to STDOUT, issue:
 #
-#   DataMapper::Logger.new(STDOUT, 0)
+#   DataMapper::Logger.new(STDOUT, :debug)
 #
 # You can pass a file location ("/path/to/log/file.log") in place of STDOUT.
 # see DataMapper::Logger for more information.
 #
 module DataMapper
-  extend Assertions
+  extend Extlib::Assertions
+
+  # TODO: move to dm-validations
+  class ValidationError < StandardError; end
+
+  class ObjectNotFoundError < StandardError; end
+
+  class RepositoryNotSetupError < StandardError; end
+
+  class IncompleteModelError < StandardError; end
 
+  class PluginNotFoundError < StandardError; end
+
+  class UpdateConflictError < StandardError; end
+
+  class UnknownRelationshipError < StandardError; end
+
+  # Raised on attempt to operate on collection of child objects
+  # when parent object is not yet saved.
+  # For instance, if your article object is not saved,
+  # but you try to fetch or scope down comments (1:n case), or
+  # publications (n:m case), operation cannot be completed
+  # because parent object's keys are not yet persisted,
+  # and thus there is no FK value to use in the query.
+  class UnsavedParentError < RuntimeError; end
+
+  # TODO: document
+  # @api private
   def self.root
-    @root ||= Pathname(__FILE__).dirname.parent.expand_path
+    @root ||= Pathname(__FILE__).dirname.parent.expand_path.freeze
   end
 
-  ##
   # Setups up a connection to a data-store
   #
-  # @param Symbol name a name for the context, defaults to :default
-  # @param [Hash{Symbol => String}, Addressable::URI, String] uri_or_options
+  # @param [Symbol] name
+  #   a name for the context, defaults to :default
+  # @param [Hash(Symbol => String), Addressable::URI, String] uri_or_options
   #   connection information
   #
-  # @return Repository the resulting setup repository
+  # @return [DataMapper::Adapters::AbstractAdapter]
+  #   the resulting setup adapter
   #
-  # @raise ArgumentError "+name+ must be a Symbol, but was..." indicates that
-  #   an invalid argument was passed for name[Symbol]
-  # @raise [ArgumentError] "+uri_or_options+ must be a Hash, URI or String,
-  #   but was..." indicates that connection information could not be gleaned
-  #   from the given uri_or_options<Hash, Addressable::URI, String>
+  # @raise [ArgumentError] "+name+ must be a Symbol, but was..."
+  #   indicates that an invalid argument was passed for name[Symbol]
+  # @raise [ArgumentError] "+uri_or_options+ must be a Hash, URI or String, but was..."
+  #   indicates that connection information could not be gleaned from
+  #   the given uri_or_options[Hash, Addressable::URI, String]
   #
-  # -
   # @api public
-  def self.setup(name, uri_or_options)
-    assert_kind_of 'name',           name,           Symbol
-    assert_kind_of 'uri_or_options', uri_or_options, Addressable::URI, Hash, String
-
-    case uri_or_options
-      when Hash
-        adapter_name = uri_or_options[:adapter].to_s
-      when String, DataObjects::URI, Addressable::URI
-        uri_or_options = DataObjects::URI.parse(uri_or_options) if uri_or_options.kind_of?(String)
-        adapter_name = uri_or_options.scheme
-    end
-
-    class_name = Extlib::Inflection.classify(adapter_name) + 'Adapter'
-
-    unless Adapters::const_defined?(class_name)
-      lib_name = "#{Extlib::Inflection.underscore(adapter_name)}_adapter"
-      begin
-        require root / 'lib' / 'dm-core' / 'adapters' / lib_name
-      rescue LoadError => e
-        begin
-          require lib_name
-        rescue Exception
-          # library not found, raise the original error
-          raise e
-        end
-      end
+  def self.setup(*args)
+    adapter = if args.first.kind_of?(Adapters::AbstractAdapter)
+      args.first
+    else
+      DataMapper::Adapters.new(*args)
     end
 
-    Repository.adapters[name] = Adapters::const_get(class_name).new(name, uri_or_options)
+    Repository.adapters[adapter.name] = adapter
   end
 
-  ##
   # Block Syntax
   #   Pushes the named repository onto the context-stack,
   #   yields a new session, and pops the context-stack.
@@ -167,12 +192,14 @@ module DataMapper
   #   a new Session.
   #
   # @param [Symbol] args the name of a repository to act within or return, :default is default
+  #
   # @yield [Proc] (optional) block to execute within the context of the named repository
-  # @demo spec/integration/repository_spec.rb
-  def self.repository(name = nil) # :yields: current_context
+  #
+  # @api public
+  def self.repository(name = nil)
     current_repository = if name
-      raise ArgumentError, "First optional argument must be a Symbol, but was #{name.inspect}" unless name.is_a?(Symbol)
-      Repository.context.detect { |r| r.name == name } || Repository.new(name)
+      assert_kind_of 'name', name, Symbol
+      Repository.context.detect { |repository| repository.name == name } || Repository.new(name)
     else
       Repository.context.last || Repository.new(Repository.default_name)
     end
@@ -183,35 +210,4 @@ module DataMapper
       current_repository
     end
   end
-
-  # A logger should always be present. Lets be consistent with DO
-  Logger.new(nil, :off)
-
-  ##
-  # destructively migrates the repository upwards to match model definitions
-  #
-  # @param [Symbol] name repository to act on, :default is the default
-  def self.migrate!(name = Repository.default_name)
-    repository(name).migrate!
-  end
-
-  ##
-  # drops and recreates the repository upwards to match model definitions
-  #
-  # @param [Symbol] name repository to act on, :default is the default
-  def self.auto_migrate!(repository_name = nil)
-    AutoMigrator.auto_migrate(repository_name)
-  end
-
-  def self.auto_upgrade!(repository_name = nil)
-    AutoMigrator.auto_upgrade(repository_name)
-  end
-
-  def self.prepare(*args, &blk)
-    yield repository(*args)
-  end
-
-  def self.dependency_queue
-    @dependency_queue ||= DependencyQueue.new
-  end
 end

data/script/performance.rb

@@ -1,19 +1,19 @@
-#!/usr/bin/env ruby
-
-require File.join(File.dirname(__FILE__), '..', 'lib', 'dm-core')
-require File.join(File.dirname(__FILE__), '..', 'lib', 'dm-core', 'version')
+#!/usr/bin/env ruby -KU
 
 require 'ftools'
 require 'rubygems'
 
-gem 'rbench', '~>0.2.3'
-require 'rbench'
+gem 'activerecord', '~>2.3.2'
+gem 'addressable',  '~>2.0'
+gem 'faker',        '~>0.3.1'
+gem 'rbench',       '~>0.2.3'
 
-gem 'faker', '~>0.3.1'
+require 'active_record'
+require 'addressable/uri'
 require 'faker'
+require 'rbench'
 
-gem 'activerecord', '~>2.2.2'
-require 'active_record'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'dm-core'))
 
 socket_file = Pathname.glob(%w[
   /opt/local/var/run/mysql5/mysqld.sock
@@ -29,7 +29,7 @@ configuration_options = {
   :adapter => 'mysql',
   :username => 'root',
   :password => '',
-  :database => 'data_mapper_1',
+  :database => 'dm_core_test',
 }
 
 configuration_options[:socket] = socket_file unless socket_file.nil?
@@ -38,12 +38,12 @@ log_dir = DataMapper.root / 'log'
 log_dir.mkdir unless log_dir.directory?
 
 DataMapper::Logger.new(log_dir / 'dm.log', :off)
-adapter = DataMapper.setup(:default, "mysql://root@localhost/data_mapper_1?socket=#{socket_file}")
+adapter = DataMapper.setup(:default, "mysql://root@localhost/dm_core_test?socket=#{socket_file}")
 
 if configuration_options[:adapter]
-  sqlfile = File.join(File.dirname(__FILE__),'..','tmp','performance.sql')
-  mysql_bin = %w[mysql mysql5].select{|bin| `which #{bin}`.length > 0 }
-  mysqldump_bin = %w[mysqldump mysqldump5].select{|bin| `which #{bin}`.length > 0 }
+  sqlfile       = File.join(File.dirname(__FILE__), '..', 'tmp', 'performance.sql')
+  mysql_bin     = %w[ mysql mysql5 ].select { |bin| `which #{bin}`.length > 0 }
+  mysqldump_bin = %w[ mysqldump mysqldump5 ].select { |bin| `which #{bin}`.length > 0 }
 end
 
 ActiveRecord::Base.logger = Logger.new(log_dir / 'ar.log')
@@ -61,46 +61,45 @@ class ARUser < ActiveRecord::Base #:nodoc:
   set_table_name 'users'
 
   has_many :exhibits, :foreign_key => 'user_id'
-
 end
 
 ARExhibit.find_by_sql('SELECT 1')
 
-class Exhibit
+class User
   include DataMapper::Resource
 
   property :id,         Serial
   property :name,       String
-  property :zoo_id,     Integer
-  property :user_id,    Integer
-  property :notes,      Text, :lazy => true
+  property :email,      String
+  property :about,      Text,   :lazy => false
   property :created_on, Date
-
-  belongs_to :user
-#  property :updated_at, DateTime
 end
 
-class User
+class Exhibit
   include DataMapper::Resource
 
-  property :id,    Serial
-  property :name,  String
-  property :email, String
-  property :about, Text, :lazy => true
+  property :id,         Serial
+  property :name,       String
+  property :zoo_id,     Integer
+  property :user_id,    Integer
+  property :notes,      Text,    :lazy => false
   property :created_on, Date
 
+  belongs_to :user
 end
 
-touch_attributes = lambda do |exhibits|
-  [*exhibits].each do |exhibit|
+DataMapper.auto_migrate!
+
+def touch_attributes(*exhibits)
+  exhibits.flatten.each do |exhibit|
     exhibit.id
     exhibit.name
     exhibit.created_on
   end
 end
 
-touch_relationships = lambda do |exhibits|
-  [*exhibits].each do |exhibit|
+def touch_relationships(*exhibits)
+  exhibits.flatten.each do |exhibit|
     exhibit.id
     exhibit.name
     exhibit.created_on
@@ -108,7 +107,6 @@ touch_relationships = lambda do |exhibits|
   end
 end
 
-
 c = configuration_options
 
 if sqlfile && File.exists?(sqlfile)
@@ -116,14 +114,7 @@ if sqlfile && File.exists?(sqlfile)
   #adapter.execute("LOAD DATA LOCAL INFILE '#{sqlfile}' INTO TABLE exhibits")
   `#{mysql_bin} -u #{c[:username]} #{"-p#{c[:password]}" unless c[:password].blank?} #{c[:database]} < #{sqlfile}`
 else
-
-  puts "Generating data for benchmarking..."
-
-  User.auto_migrate!
-  Exhibit.auto_migrate!
-
-  users = []
-  exhibits = []
+  puts 'Generating data for benchmarking...'
 
   # pre-compute the insert statements and fake data compilation,
   # so the benchmarks below show the actual runtime for the execute
@@ -131,35 +122,30 @@ else
 
   # Using the same paragraph for all exhibits because it is very slow
   # to generate unique paragraphs for all exhibits.
-  paragraph = Faker::Lorem.paragraphs.join($/)
-
-  10_000.times do |i|
-    users << [
-      'INSERT INTO `users` (`name`,`email`,`created_on`) VALUES (?, ?, ?)',
-      Faker::Name.name,
-      Faker::Internet.email,
-      Date.today
-    ]
-
-    exhibits << [
-      'INSERT INTO `exhibits` (`name`, `zoo_id`, `user_id`, `notes`, `created_on`) VALUES (?, ?, ?, ?, ?)',
-      Faker::Company.name,
-      rand(10).ceil,
-      i,
-      paragraph,#Faker::Lorem.paragraphs.join($/),
-      Date.today
-    ]
+  notes = Faker::Lorem.paragraphs.join($/)
+  today = Date.today
+
+  puts 'Inserting 10,000 users and exhibits...'
+  10_000.times do
+    user = User.create(
+      :created_on => today,
+      :name       => Faker::Name.name,
+      :email      => Faker::Internet.email
+    )
+
+    Exhibit.create(
+      :created_on => today,
+      :name       => Faker::Company.name,
+      :user       => user,
+      :notes      => notes,
+      :zoo_id     => rand(10).ceil
+    )
   end
 
-  puts "Inserting 10,000 users..."
-  10_000.times { |i| adapter.execute(*users.at(i)) }
-  puts "Inserting 10,000 exhibits..."
-  10_000.times { |i| adapter.execute(*exhibits.at(i)) }
-
   if sqlfile
     answer = nil
     until answer && answer[/^$|y|yes|n|no/]
-      print("Would you like to dump data into tmp/performance.sql (for faster setup)? [Yn]");
+      print('Would you like to dump data into tmp/performance.sql (for faster setup)? [Yn]');
       STDOUT.flush
       answer = gets
     end
@@ -171,13 +157,12 @@ else
       puts "File saved\n"
     end
   end
-
 end
 
-TIMES = ENV['x'] ? ENV['x'].to_i : 10_000
+TIMES = ENV.key?('x') ? ENV['x'].to_i : 10_000
 
-puts "You can specify how many times you want to run the benchmarks with rake:perf x=(number)"
-puts "Some tasks will be run 10 and 1000 times less than (number)"
+puts 'You can specify how many times you want to run the benchmarks with rake:perf x=(number)'
+puts 'Some tasks will be run 10 and 1000 times less than (number)'
 puts "Benchmarks will now run #{TIMES} times"
 # Inform about slow benchmark
 # answer = nil
@@ -193,90 +178,98 @@ puts "Benchmarks will now run #{TIMES} times"
 RBench.run(TIMES) do
 
   column :times
-  column :ar, :title => "AR 2.1"
+  column :ar, :title => 'AR 2.3.2'
   column :dm, :title => "DM #{DataMapper::VERSION}"
-  column :diff, :compare => [:ar,:dm]
+  column :diff, :compare => [:ar, :dm]
+
+  report 'Model#id', (TIMES * 100).ceil do
+    ar_obj = ARExhibit.find(1)
+    dm_obj = Exhibit.get(1)
+
+    ar { ar_obj.id }
+    dm { dm_obj.id }
+  end
 
-  report "Model.new (instantiation)" do
+  report 'Model.new (instantiation)' do
     ar { ARExhibit.new }
     dm { Exhibit.new }
   end
 
-  report "Model.new (setting attributes)" do
-    attrs = {:name => 'sam', :zoo_id => 1}
+  report 'Model.new (setting attributes)' do
+    attrs = { :name => 'sam', :zoo_id => 1 }
     ar { ARExhibit.new(attrs) }
     dm { Exhibit.new(attrs) }
   end
 
-  report "Model.get specific (not cached)" do
-    ActiveRecord::Base.uncached { ar { touch_attributes[ARExhibit.find(1)] } }
-    dm { touch_attributes[Exhibit.get(1)] }
+  report 'Model.get specific (not cached)' do
+    ActiveRecord::Base.uncached { ar { touch_attributes(ARExhibit.find(1)) } }
+    dm { touch_attributes(Exhibit.get(1)) }
   end
 
-  report "Model.get specific (cached)" do
-    ActiveRecord::Base.cache    { ar { touch_attributes[ARExhibit.find(1)] } }
-    Exhibit.repository(:default) { dm { touch_attributes[Exhibit.get(1)] } }
+  report 'Model.get specific (cached)' do
+    ActiveRecord::Base.cache     { ar { touch_attributes(ARExhibit.find(1)) } }
+    Exhibit.repository(:default) { dm { touch_attributes(Exhibit.get(1)) } }
   end
 
-  report "Model.first" do
-    ar { touch_attributes[ARExhibit.first] }
-    dm { touch_attributes[Exhibit.first] }
+  report 'Model.first' do
+    ar { touch_attributes(ARExhibit.first) }
+    dm { touch_attributes(Exhibit.first) }
   end
 
-  report "Model.all limit(100)", (TIMES / 10.0).ceil do
-    ar { touch_attributes[ARExhibit.find(:all, :limit => 100)] }
-    dm { touch_attributes[Exhibit.all(:limit => 100)] }
+  report 'Model.all limit(100)', (TIMES / 10).ceil do
+    ar { touch_attributes(ARExhibit.find(:all, :limit => 100)) }
+    dm { touch_attributes(Exhibit.all(:limit => 100)) }
   end
 
-  report "Model.all limit(100) with relationship", (TIMES / 10.0).ceil do
-    ar { touch_relationships[ARExhibit.all(:limit => 100, :include => [:user])] }
-    dm { touch_relationships[Exhibit.all(:limit => 100)] }
+  report 'Model.all limit(100) with relationship', (TIMES / 10).ceil do
+    ar { touch_relationships(ARExhibit.all(:limit => 100, :include => [ :user ])) }
+    dm { touch_relationships(Exhibit.all(:limit => 100)) }
   end
 
-  report "Model.all limit(10,000)", (TIMES / 1000.0).ceil do
-    ar { touch_attributes[ARExhibit.find(:all, :limit => 10_000)] }
-    dm { touch_attributes[Exhibit.all(:limit => 10_000)] }
+  report 'Model.all limit(10,000)', (TIMES / 1000).ceil do
+    ar { touch_attributes(ARExhibit.find(:all, :limit => 10_000)) }
+    dm { touch_attributes(Exhibit.all(:limit => 10_000)) }
   end
 
-  create_exhibit = {
+  exhibit = {
     :name       => Faker::Company.name,
     :zoo_id     => rand(10).ceil,
     :notes      => Faker::Lorem.paragraphs.join($/),
     :created_on => Date.today
   }
 
-  report "Model.create" do
-    ar { ARExhibit.create(create_exhibit) }
-    dm { Exhibit.create(create_exhibit) }
+  report 'Model.create' do
+    ar { ARExhibit.create(exhibit) }
+    dm { Exhibit.create(exhibit) }
   end
 
-  report "Resource#attributes" do
-    attrs_first  = {:name => 'sam', :zoo_id => 1}
-    attrs_second = {:name => 'tom', :zoo_id => 1}
-    ar { e = ARExhibit.new(attrs_first); e.attributes = attrs_second }
-    dm { e = Exhibit.new(attrs_first); e.attributes = attrs_second }
+  report 'Resource#attributes=' do
+    attrs_first  = { :name => 'sam', :zoo_id => 1 }
+    attrs_second = { :name => 'tom', :zoo_id => 1 }
+    ar { exhibit = ARExhibit.new(attrs_first); exhibit.attributes = attrs_second }
+    dm { exhibit = Exhibit.new(attrs_first);   exhibit.attributes = attrs_second }
   end
 
-  report "Resource#update" do
-    ar { e = ARExhibit.find(1); e.name = 'bob'; e.save }
-    dm { e = Exhibit.get(1); e.name = 'bob'; e.save }
+  report 'Resource#update' do
+    ar { ARExhibit.find(1).update_attributes(:name => 'bob') }
+    dm { Exhibit.get(1).update(:name => 'bob') }
   end
 
-  report "Resource#destroy" do
+  report 'Resource#destroy' do
     ar { ARExhibit.first.destroy }
     dm { Exhibit.first.destroy }
   end
 
-  report "Model.transaction" do
+  report 'Model.transaction' do
     ar { ARExhibit.transaction { ARExhibit.new } }
     dm { Exhibit.transaction { Exhibit.new } }
   end
 
-  summary "Total"
+  summary 'Total'
 end
 
-connection = adapter.send(:create_connection)
-command = connection.create_command("DROP TABLE exhibits")
-command = connection.create_command("DROP TABLE users")
+connection = adapter.send(:open_connection)
+command = connection.create_command('DROP TABLE exhibits')
+command = connection.create_command('DROP TABLE users')
 command.execute_non_query rescue nil
 connection.close