datamapper-dm-core 0.9.11

data/lib/dm-core/type_map.rb

@@ -0,0 +1,80 @@
+# TODO: move to dm-more/dm-migrations
+
+module DataMapper
+  class TypeMap
+
+    attr_accessor :parent, :chains
+
+    def initialize(parent = nil, &blk)
+      @parent, @chains = parent, {}
+
+      blk.call(self) unless blk.nil?
+    end
+
+    def map(type)
+      @chains[type] ||= TypeChain.new
+    end
+
+    def lookup(type)
+      if type_mapped?(type)
+        lookup_from_map(type)
+      else
+        lookup_by_type(type)
+      end
+    end
+
+    def lookup_from_map(type)
+      lookup_from_parent(type).merge(map(type).translate)
+    end
+
+    def lookup_from_parent(type)
+      if !@parent.nil? && @parent.type_mapped?(type)
+        @parent[type]
+      else
+        {}
+      end
+    end
+
+    # @raise <DataMapper::TypeMap::Error> if the type is not a default primitive or has a type map entry.
+    def lookup_by_type(type)
+      raise DataMapper::TypeMap::Error.new(type) unless type.respond_to?(:primitive) && !type.primitive.nil?
+
+      lookup(type.primitive).merge(Type::PROPERTY_OPTIONS.inject({}) {|h, k| h[k] = type.send(k); h})
+    end
+
+    alias [] lookup
+
+    def type_mapped?(type)
+      @chains.has_key?(type) || (@parent.nil? ? false : @parent.type_mapped?(type))
+    end
+
+    class TypeChain
+      attr_accessor :primitive, :attributes
+
+      def initialize
+        @attributes = {}
+      end
+
+      def to(primitive)
+        @primitive = primitive
+        self
+      end
+
+      def with(attributes)
+        raise "method 'with' expects a hash" unless attributes.kind_of?(Hash)
+        @attributes.merge!(attributes)
+        self
+      end
+
+      def translate
+        @attributes.merge((@primitive.nil? ? {} : {:primitive => @primitive}))
+      end
+    end # class TypeChain
+
+    class Error < StandardError
+      def initialize(type)
+        super("Type #{type} must have a default primitive or type map entry")
+      end
+    end
+  end # class TypeMap
+end # module DataMapper

data/lib/dm-core/types.rb

@@ -0,0 +1,19 @@
+dir = Pathname(__FILE__).dirname.expand_path / 'types'
+
+require dir / 'boolean'
+require dir / 'discriminator'
+require dir / 'text'
+require dir / 'paranoid_datetime'
+require dir / 'paranoid_boolean'
+require dir / 'object'
+require dir / 'serial'
+
+unless defined?(DM)
+  DM = DataMapper::Types
+end
+
+module DataMapper
+  module Resource
+    include Types
+  end # module Resource
+end # module DataMapper

data/lib/dm-core/types/boolean.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Types
+    class Boolean < DataMapper::Type
+      primitive TrueClass
+    end # class Boolean
+  end # module Types
+end # module DataMapper

data/lib/dm-core/types/discriminator.rb

@@ -0,0 +1,34 @@
+module DataMapper
+  module Types
+    class Discriminator < DataMapper::Type
+      primitive Class
+      track :set
+      default lambda { |r,p| p.model }
+      nullable false
+
+      def self.bind(property)
+        model = property.model
+
+        model.class_eval <<-EOS, __FILE__, __LINE__
+          def self.descendants
+            (@descendants ||= []).uniq!
+            @descendants
+          end
+
+          after_class_method :inherited, :add_scope_for_discriminator
+
+          def self.add_scope_for_discriminator(retval, target)
+            target.descendants << target
+            target.default_scope.update(#{property.name.inspect} => target.descendants)
+            propagate_descendants(target)
+          end
+
+          def self.propagate_descendants(target)
+            descendants << target
+            superclass.propagate_descendants(target) if superclass.respond_to?(:propagate_descendants)
+          end
+        EOS
+      end
+    end # class Discriminator
+  end # module Types
+end # module DataMapper

data/lib/dm-core/types/object.rb

@@ -0,0 +1,24 @@
+require "base64"
+
+module DataMapper
+  module Types
+    class Object < DataMapper::Type
+      primitive String
+      size 65535
+      lazy true
+      track :hash
+
+      def self.typecast(value, property)
+        value
+      end
+
+      def self.dump(value, property)
+        Base64.encode64(Marshal.dump(value))
+      end
+
+      def self.load(value, property)
+        value.nil? ? nil : Marshal.load(Base64.decode64(value))
+      end
+    end
+  end
+end

data/lib/dm-core/types/paranoid_boolean.rb

@@ -0,0 +1,34 @@
+module DataMapper
+  module Types
+    class ParanoidBoolean < DataMapper::Type(Boolean)
+      primitive TrueClass
+      default   false
+      lazy      true
+
+      def self.bind(property)
+        model = property.model
+        repository = property.repository
+
+        model.send(:set_paranoid_property, property.name){true}
+
+        model.class_eval <<-EOS, __FILE__, __LINE__
+
+          def self.with_deleted
+            with_exclusive_scope(#{property.name.inspect} => true) do
+              yield
+            end
+          end
+
+          def destroy
+            self.class.paranoid_properties.each do |name, blk|
+              attribute_set(name, blk.call(self))
+            end
+            save
+          end
+        EOS
+
+        model.default_scope(repository.name).update(property.name => false)
+      end
+    end # class ParanoidBoolean
+  end # module Types
+end # module DataMapper

data/lib/dm-core/types/paranoid_datetime.rb

@@ -0,0 +1,33 @@
+module DataMapper
+  module Types
+    class ParanoidDateTime < DataMapper::Type(DateTime)
+      primitive DateTime
+      lazy      true
+
+      def self.bind(property)
+        model = property.model
+        repository = property.repository
+
+        model.send(:set_paranoid_property, property.name){DateTime.now}
+
+        model.class_eval <<-EOS, __FILE__, __LINE__
+
+          def self.with_deleted
+            with_exclusive_scope(#{property.name.inspect}.not => nil) do
+              yield
+            end
+          end
+
+          def destroy
+            self.class.paranoid_properties.each do |name, blk|
+              attribute_set(name, blk.call(self))
+            end
+            save
+          end
+        EOS
+
+        model.default_scope(repository.name).update(property.name => nil)
+      end
+    end # class ParanoidDateTime
+  end # module Types
+end # module DataMapper

data/lib/dm-core/types/serial.rb

@@ -0,0 +1,9 @@
+# FIXME: can we alias this to the class Text if it isn't already defined?
+module DataMapper
+  module Types
+    class Serial < DataMapper::Type
+      primitive Integer
+      serial true
+    end # class Text
+  end # module Types
+end # module DataMapper

data/lib/dm-core/types/text.rb

@@ -0,0 +1,10 @@
+# FIXME: can we alias this to the class Text if it isn't already defined?
+module DataMapper
+  module Types
+    class Text < DataMapper::Type
+      primitive String
+      size 65535
+      lazy true
+    end # class Text
+  end # module Types
+end # module DataMapper

data/lib/dm-core/version.rb

@@ -0,0 +1,3 @@
+module DataMapper
+  VERSION = '0.9.11'.freeze
+end

data/script/all

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+ADAPTER=sqlite3  rake spec
+ADAPTER=mysql    rake spec
+ADAPTER=postgres rake spec

data/script/performance.rb

@@ -0,0 +1,282 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'dm-core')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'dm-core', 'version')
+
+require 'ftools'
+require 'rubygems'
+
+gem 'rbench', '~>0.2.3'
+require 'rbench'
+
+gem 'faker', '~>0.3.1'
+require 'faker'
+
+gem 'activerecord', '~>2.2.2'
+require 'active_record'
+
+socket_file = Pathname.glob(%w[
+  /opt/local/var/run/mysql5/mysqld.sock
+  tmp/mysqld.sock
+  /tmp/mysqld.sock
+  tmp/mysql.sock
+  /tmp/mysql.sock
+  /var/mysql/mysql.sock
+  /var/run/mysqld/mysqld.sock
+]).find { |path| path.socket? }
+
+configuration_options = {
+  :adapter => 'mysql',
+  :username => 'root',
+  :password => '',
+  :database => 'data_mapper_1',
+}
+
+configuration_options[:socket] = socket_file unless socket_file.nil?
+
+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}")
+
+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 }
+end
+
+ActiveRecord::Base.logger = Logger.new(log_dir / 'ar.log')
+ActiveRecord::Base.logger.level = 0
+
+ActiveRecord::Base.establish_connection(configuration_options)
+
+class ARExhibit < ActiveRecord::Base #:nodoc:
+  set_table_name 'exhibits'
+
+  belongs_to :user, :class_name => 'ARUser', :foreign_key => 'user_id'
+end
+
+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
+  include DataMapper::Resource
+
+  property :id,         Serial
+  property :name,       String
+  property :zoo_id,     Integer
+  property :user_id,    Integer
+  property :notes,      Text, :lazy => true
+  property :created_on, Date
+
+  belongs_to :user
+#  property :updated_at, DateTime
+end
+
+class User
+  include DataMapper::Resource
+
+  property :id,    Serial
+  property :name,  String
+  property :email, String
+  property :about, Text, :lazy => true
+  property :created_on, Date
+
+end
+
+touch_attributes = lambda do |exhibits|
+  [*exhibits].each do |exhibit|
+    exhibit.id
+    exhibit.name
+    exhibit.created_on
+  end
+end
+
+touch_relationships = lambda do |exhibits|
+  [*exhibits].each do |exhibit|
+    exhibit.id
+    exhibit.name
+    exhibit.created_on
+    exhibit.user
+  end
+end
+
+
+c = configuration_options
+
+if sqlfile && File.exists?(sqlfile)
+  puts "Found data-file. Importing from #{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 = []
+
+  # pre-compute the insert statements and fake data compilation,
+  # so the benchmarks below show the actual runtime for the execute
+  # method, minus the setup steps
+
+  # 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
+    ]
+  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]");
+      STDOUT.flush
+      answer = gets
+    end
+
+    if answer[/^$|y|yes/]
+      File.makedirs(File.dirname(sqlfile))
+      #adapter.execute("SELECT * INTO OUTFILE '#{sqlfile}' FROM exhibits;")
+      `#{mysqldump_bin} -u #{c[:username]} #{"-p#{c[:password]}" unless c[:password].blank?} #{c[:database]} exhibits users > #{sqlfile}`
+      puts "File saved\n"
+    end
+  end
+
+end
+
+TIMES = ENV['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 "Benchmarks will now run #{TIMES} times"
+# Inform about slow benchmark
+# answer = nil
+# until answer && answer[/^$|y|yes|n|no/]
+#   print("A slow benchmark exposing problems with SEL is newly added. It takes approx. 20s\n");
+#   print("you have scheduled it to run #{TIMES / 100} times.\nWould you still include the particular benchmark? [Yn]")
+#   STDOUT.flush
+#   answer = gets
+# end
+# run_rel_bench = answer[/^$|y|yes/] ? true : false
+
+
+RBench.run(TIMES) do
+
+  column :times
+  column :ar, :title => "AR 2.1"
+  column :dm, :title => "DM #{DataMapper::VERSION}"
+  column :diff, :compare => [:ar,:dm]
+
+  report "Model.new (instantiation)" do
+    ar { ARExhibit.new }
+    dm { Exhibit.new }
+  end
+
+  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)] }
+  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)] } }
+  end
+
+  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)] }
+  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)] }
+  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)] }
+  end
+
+  create_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) }
+  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 }
+  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 }
+  end
+
+  report "Resource#destroy" do
+    ar { ARExhibit.first.destroy }
+    dm { Exhibit.first.destroy }
+  end
+
+  report "Model.transaction" do
+    ar { ARExhibit.transaction { ARExhibit.new } }
+    dm { Exhibit.transaction { Exhibit.new } }
+  end
+
+  summary "Total"
+end
+
+connection = adapter.send(:create_connection)
+command = connection.create_command("DROP TABLE exhibits")
+command = connection.create_command("DROP TABLE users")
+command.execute_non_query rescue nil
+connection.close