dm-constraints 0.10.2 → 1.0.0.rc1

data/.gitignore

@@ -0,0 +1,37 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+
+## PROJECT::GENERAL
+*.gem
+coverage
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.local
+Gemfile.lock
+
+## PROJECT::SPECIFIC
+spec/db/
+spec/log/

data/Gemfile

@@ -0,0 +1,141 @@
+# If you're working on more than one datamapper gem at a time, then it's
+# recommended to create a local Gemfile and use this instead of the git
+# sources. This will make sure that you are  developing against your
+# other local datamapper sources that you currently work on. Gemfile.local
+# will behave identically to the standard Gemfile apart from the fact that
+# it fetches the datamapper gems from local paths. This means that you can use
+# the same environment variables, like ADAPTER(S) or PLUGIN(S) when running
+# bundle commands. Gemfile.local is added to .gitignore, so you don't need to
+# worry about accidentally checking local development paths into git.
+# In order to create a local Gemfile, all you need to do is run:
+#
+#   bundle exec rake local_gemfile
+#
+# This will give you a Gemfile.local file that points to your local clones of
+# the various datamapper gems. It's assumed that all datamapper repo clones
+# reside in the same directory. You can use the Gemfile.local like so for
+# running any bundle command:
+#
+#   BUNDLE_GEMFILE=Gemfile.local bundle foo
+#
+# You can also specify which adapter(s) should be part of the bundle by setting
+# an environment variable. This of course also works when using the Gemfile.local
+#
+#   bundle foo                        # dm-sqlite-adapter
+#   ADAPTER=mysql bundle foo          # dm-mysql-adapter
+#   ADAPTERS=sqlite,mysql bundle foo  # dm-sqlite-adapter and dm-mysql-adapter
+#
+# Of course you can also use the ADAPTER(S) variable when using the Gemfile.local
+# and running specs against selected adapters.
+#
+# For easily working with adapters supported on your machine, it's recommended
+# that you first install all adapters that you are planning to use or work on
+# by doing something like
+#
+#   ADAPTERS=sqlite,mysql,postgres bundle install
+#
+# This will clone the various repositories and make them available to bundler.
+# Once you have them installed you can easily switch between adapters for the
+# various development tasks. Running something like
+#
+#   ADAPTER=mysql bundle exec rake spec
+#
+# will make sure that the dm-mysql-adapter is part of the bundle, and will be used
+# when running the specs.
+#
+# You can also specify which plugin(s) should be part of the bundle by setting
+# an environment variable. This also works when using the Gemfile.local
+#
+#   bundle foo                                 # dm-migrations
+#   PLUGINS=dm-validations bundle foo          # dm-migrations and dm-validations
+#   PLUGINS=dm-validations,dm-types bundle foo # dm-migrations, dm-validations and dm-types
+#
+# Of course you can combine the PLUGIN(S) and ADAPTER(S) env vars to run specs
+# for certain adapter/plugin combinations.
+#
+# Finally, to speed up running specs and other tasks, it's recommended to run
+#
+#   bundle lock
+#
+# after running 'bundle install' for the first time. This will make 'bundle exec' run
+# a lot faster compared to the unlocked version. With an unlocked bundle you would
+# typically just run 'bundle install' from time to time to fetch the latest sources from
+# upstream. When you locked your bundle, you need to run
+#
+#   bundle install --relock
+#
+# to make sure to fetch the latest updates and then lock the bundle again. Gemfile.lock
+# is added to the .gitignore file, so you don't need to worry about accidentally checking
+# it into version control.
+
+source 'http://rubygems.org'
+
+DATAMAPPER = 'git://github.com/datamapper'
+DM_VERSION = '~> 1.0.0.rc1'
+
+group :runtime do # Runtime dependencies (as in the gemspec)
+
+  if ENV['EXTLIB']
+    gem 'extlib',        '~> 0.9.15',      :git => "#{DATAMAPPER}/extlib.git"
+  else
+    gem 'activesupport', '~> 3.0.0.beta3', :git => 'git://github.com/rails/rails.git', :require => nil
+  end
+
+  gem 'dm-core', DM_VERSION, :git => "#{DATAMAPPER}/dm-core.git"
+
+end
+
+group(:development) do # Development dependencies (as in the gemspec)
+
+  gem 'rake',           '~> 0.8.7'
+  gem 'rspec',          '~> 1.3'
+  gem 'jeweler',        '~> 1.4'
+
+end
+
+group :quality do # These gems contain rake tasks that check the quality of the source code
+
+  gem 'metric_fu',      '~> 1.3'
+  gem 'rcov',           '~> 0.9.7'
+  gem 'reek',           '~> 1.2.7'
+  gem 'roodi',          '~> 2.1'
+  gem 'yard',           '~> 0.5'
+  gem 'yardstick',      '~> 0.1'
+
+end
+
+group :datamapper do # We need this because we want to pin these dependencies to their git master sources
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.gsub(',',' ').split(' ') - ['in_memory']
+
+  unless adapters.empty?
+
+    DO_VERSION     = '~> 0.10.2'
+    DM_DO_ADAPTERS = %w[sqlite postgres mysql oracle sqlserver]
+
+    gem 'data_objects',  DO_VERSION, :git => "#{DATAMAPPER}/do.git"
+
+    adapters.each do |adapter|
+      if DM_DO_ADAPTERS.any? { |dm_do_adapter| dm_do_adapter =~ /#{adapter}/  }
+        adapter = 'sqlite3' if adapter == 'sqlite'
+        gem "do_#{adapter}", DO_VERSION, :git => "#{DATAMAPPER}/do.git"
+      end
+    end
+
+    gem 'dm-do-adapter', DM_VERSION, :git => "#{DATAMAPPER}/dm-do-adapter.git"
+
+    adapters.each do |adapter|
+      gem "dm-#{adapter}-adapter", DM_VERSION, :git => "#{DATAMAPPER}/dm-#{adapter}-adapter.git"
+    end
+
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = (plugins.to_s.gsub(',',' ').split(' ') + ['dm-migrations']).uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION, :git => "#{DATAMAPPER}/#{plugin}.git"
+  end
+
+end

data/Rakefile

@@ -15,10 +15,10 @@ begin
 
     gem.rubyforge_project = 'datamapper'
 
-    gem.add_dependency 'dm-core', '~> 0.10.2'
+    gem.add_dependency 'dm-core',       '~> 1.0.0.rc1'
+    gem.add_dependency 'dm-migrations', '~> 1.0.0.rc1'
 
-    gem.add_development_dependency 'rspec', '~> 1.2.9'
-    gem.add_development_dependency 'yard',  '~> 0.4.0'
+    gem.add_development_dependency 'rspec', '~> 1.3'
   end
 
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.10.2
+1.0.0.rc1

data/dm-constraints.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-constraints}
-  s.version = "0.10.2"
+  s.version = "1.0.0.rc1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dirkjan Bussink"]
-  s.date = %q{2009-12-11}
+  s.date = %q{2010-05-19}
   s.description = %q{DataMapper plugin constraining relationships}
   s.email = %q{d.bussink [a] gmail [d] com}
   s.extra_rdoc_files = [
@@ -17,19 +17,33 @@ Gem::Specification.new do |s|
      "README.rdoc"
   ]
   s.files = [
-    "LICENSE",
+    ".gitignore",
+     "Gemfile",
+     "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "dm-constraints.gemspec",
      "lib/dm-constraints.rb",
+     "lib/dm-constraints/adapters/dm-abstract-adapter.rb",
+     "lib/dm-constraints/adapters/dm-do-adapter.rb",
+     "lib/dm-constraints/adapters/dm-mysql-adapter.rb",
+     "lib/dm-constraints/adapters/dm-oracle-adapter.rb",
+     "lib/dm-constraints/adapters/dm-postgres-adapter.rb",
+     "lib/dm-constraints/adapters/dm-sqlite-adapter.rb",
+     "lib/dm-constraints/adapters/dm-sqlserver-adapter.rb",
      "lib/dm-constraints/delete_constraint.rb",
      "lib/dm-constraints/migrations.rb",
+     "lib/dm-constraints/relationships.rb",
      "spec/integration/constraints_spec.rb",
+     "spec/isolated/require_after_setup_spec.rb",
+     "spec/isolated/require_before_setup_spec.rb",
+     "spec/isolated/require_spec.rb",
      "spec/rcov.opts",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "tasks/ci.rake",
+     "tasks/local_gemfile.rake",
      "tasks/metrics.rake",
      "tasks/spec.rake",
      "tasks/yard.rake",
@@ -39,26 +53,33 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{datamapper}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{DataMapper plugin constraining relationships}
+  s.test_files = [
+    "spec/integration/constraints_spec.rb",
+     "spec/isolated/require_after_setup_spec.rb",
+     "spec/isolated/require_before_setup_spec.rb",
+     "spec/isolated/require_spec.rb",
+     "spec/spec_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<dm-core>, ["~> 0.10.2"])
-      s.add_development_dependency(%q<rspec>, ["~> 1.2.9"])
-      s.add_development_dependency(%q<yard>, ["~> 0.4.0"])
+      s.add_runtime_dependency(%q<dm-core>, ["~> 1.0.0.rc1"])
+      s.add_runtime_dependency(%q<dm-migrations>, ["~> 1.0.0.rc1"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3"])
     else
-      s.add_dependency(%q<dm-core>, ["~> 0.10.2"])
-      s.add_dependency(%q<rspec>, ["~> 1.2.9"])
-      s.add_dependency(%q<yard>, ["~> 0.4.0"])
+      s.add_dependency(%q<dm-core>, ["~> 1.0.0.rc1"])
+      s.add_dependency(%q<dm-migrations>, ["~> 1.0.0.rc1"])
+      s.add_dependency(%q<rspec>, ["~> 1.3"])
     end
   else
-    s.add_dependency(%q<dm-core>, ["~> 0.10.2"])
-    s.add_dependency(%q<rspec>, ["~> 1.2.9"])
-    s.add_dependency(%q<yard>, ["~> 0.4.0"])
+    s.add_dependency(%q<dm-core>, ["~> 1.0.0.rc1"])
+    s.add_dependency(%q<dm-migrations>, ["~> 1.0.0.rc1"])
+    s.add_dependency(%q<rspec>, ["~> 1.3"])
   end
 end
 

data/lib/dm-constraints/adapters/dm-abstract-adapter.rb

@@ -0,0 +1,22 @@
+module DataMapper
+  module Constraints
+    module Adapters
+
+      module AbstractAdapter
+
+        def constraint_exists?(*)
+          false
+        end
+
+        def create_relationship_constraint(*)
+          false
+        end
+
+        def destroy_relationship_constraint(*)
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/dm-constraints/adapters/dm-do-adapter.rb

@@ -0,0 +1,189 @@
+module DataMapper
+  module Constraints
+    module Adapters
+
+      module DataObjectsAdapter
+        ##
+        # Determine if a constraint exists for a table
+        #
+        # @param storage_name [Symbol]
+        #   name of table to check constraint on
+        # @param constraint_name [~String]
+        #   name of constraint to check for
+        #
+        # @return [Boolean]
+        #
+        # @api private
+        def constraint_exists?(storage_name, constraint_name)
+          statement = <<-SQL.compress_lines
+            SELECT COUNT(*)
+            FROM "information_schema"."table_constraints"
+            WHERE "constraint_type" = 'FOREIGN KEY'
+            AND "table_schema" = ?
+            AND "table_name" = ?
+            AND "constraint_name" = ?
+          SQL
+
+          select(statement, schema_name, storage_name, constraint_name).first > 0
+        end
+
+        ##
+        # Create the constraint for a relationship
+        #
+        # @param relationship [Relationship]
+        #   the relationship to create the constraint for
+        #
+        # @return [true, false]
+        #   true if creating the constraints was successful
+        #
+        # @api semipublic
+        def create_relationship_constraint(relationship)
+          return false unless valid_relationship_for_constraint?(relationship)
+
+          source_model = relationship.source_model
+          source_table = source_model.storage_name(name)
+          source_key   = relationship.source_key
+
+          constraint_name = constraint_name(source_table, relationship.name)
+          return false if constraint_exists?(source_table, constraint_name)
+
+          constraint_type = case relationship.inverse.constraint
+            when :protect            then 'NO ACTION'
+            when :destroy, :destroy! then 'CASCADE'
+            when :set_nil            then 'SET NULL'
+          end
+
+          return false if constraint_type.nil?
+
+          storage_name           = relationship.source_model.storage_name(name)
+          reference_storage_name = relationship.target_model.storage_name(name)
+
+          foreign_keys   = relationship.source_key.map { |p| property_to_column_name(p, false) }
+          reference_keys = relationship.target_key.map { |p| property_to_column_name(p, false) }
+
+          execute(create_constraints_statement(storage_name, constraint_name, constraint_type, foreign_keys, reference_storage_name, reference_keys))
+        end
+
+        ##
+        # Remove the constraint for a relationship
+        #
+        # @param relationship [Relationship]
+        #   the relationship to remove the constraint for
+        #
+        # @return [true, false]
+        #   true if destroying the constraint was successful
+        #
+        # @api semipublic
+        def destroy_relationship_constraint(relationship)
+          return false unless valid_relationship_for_constraint?(relationship)
+
+          source_model = relationship.source_model
+          source_table = source_model.storage_name(name)
+
+          constraint_name = constraint_name(source_table, relationship.name)
+          return false unless constraint_exists?(source_table, constraint_name)
+
+          execute(destroy_constraints_statement(source_table, constraint_name))
+        end
+
+        private
+
+        ##
+        # Check to see if the relationship's constraints can be used
+        #
+        # Only one-to-one, one-to-many, and many-to-many relationships
+        # can be used for constraints.  They must also be in the same
+        # repository as the adapter is connected to.
+        #
+        # @param relationship [Relationship]
+        #   the relationship to check
+        #
+        # @return [true, false]
+        #   true if a constraint can be established for relationship
+        #
+        # @api private
+        def valid_relationship_for_constraint?(relationship)
+          return false unless relationship.source_repository_name == name || relationship.source_repository_name.nil?
+          return false unless relationship.target_repository_name == name || relationship.target_repository_name.nil?
+          return false unless relationship.kind_of?(Associations::ManyToOne::Relationship)
+          true
+        end
+
+        module SQL
+          private
+
+          ##
+          # Generates the SQL statement to create a constraint
+          #
+          # @param constraint_name [String]
+          #   name of the foreign key constraint
+          # @param constraint_type [String]
+          #   type of foreign key constraint to add to the table
+          # @param storage_name [String]
+          #   name of table to constrain
+          # @param foreign_keys [Array[String]]
+          #   columns in the table that refer to foreign table
+          # @param reference_storage_name [String]
+          #   table the foreign key refers to
+          # @param reference_storage_name [Array[String]]
+          #   columns the foreign table that are referred to
+          #
+          # @return [String]
+          #   SQL DDL Statement to create a constraint
+          #
+          # @api private
+          def create_constraints_statement(storage_name, constraint_name, constraint_type, foreign_keys, reference_storage_name, reference_keys)
+            <<-SQL.compress_lines
+              ALTER TABLE #{quote_name(storage_name)}
+              ADD CONSTRAINT #{quote_name(constraint_name)}
+              FOREIGN KEY (#{foreign_keys.join(', ')})
+              REFERENCES #{quote_name(reference_storage_name)} (#{reference_keys.join(', ')})
+              ON DELETE #{constraint_type}
+              ON UPDATE #{constraint_type}
+            SQL
+          end
+
+          ##
+          # Generates the SQL statement to destroy a constraint
+          #
+          # @param storage_name [String]
+          #   name of table to constrain
+          # @param constraint_name [String]
+          #   name of foreign key constraint
+          #
+          # @return [String]
+          #   SQL DDL Statement to destroy a constraint
+          #
+          # @api private
+          def destroy_constraints_statement(storage_name, constraint_name)
+            <<-SQL.compress_lines
+              ALTER TABLE #{quote_name(storage_name)}
+              DROP CONSTRAINT #{quote_name(constraint_name)}
+            SQL
+          end
+
+          ##
+          # generates a unique constraint name given a table and a relationships
+          #
+          # @param storage_name [String]
+          #   name of table to constrain
+          # @param relationships_name [String]
+          #   name of the relationship to constrain
+          #
+          # @return [String]
+          #   name of the constraint
+          #
+          # @api private
+          def constraint_name(storage_name, relationship_name)
+            identifier = "#{storage_name}_#{relationship_name}"[0, self.class::IDENTIFIER_MAX_LENGTH - 3]
+            "#{identifier}_fk"
+          end
+        end
+
+        include SQL
+
+      end # module DataObjectsAdapter
+
+    end # module Adapters
+  end # module Constraints
+end # module DataMapper

data/lib/dm-constraints/adapters/dm-mysql-adapter.rb

@@ -0,0 +1,40 @@
+require 'dm-constraints/adapters/dm-do-adapter'
+
+module DataMapper
+  module Constraints
+    module Adapters
+
+      module MysqlAdapter
+
+        include DataObjectsAdapter
+
+        module SQL
+        private
+
+          ##
+          # MySQL specific query to drop a foreign key
+          #
+          # @param storage_name [String]
+          #   name of table to constrain
+          # @param constraint_name [String]
+          #   name of foreign key constraint
+          #
+          # @return [String]
+          #   SQL DDL Statement to destroy a constraint
+          #
+          # @api private
+          def destroy_constraints_statement(storage_name, constraint_name)
+            <<-SQL.compress_lines
+              ALTER TABLE #{quote_name(storage_name)}
+              DROP FOREIGN KEY #{quote_name(constraint_name)}
+            SQL
+          end
+        end
+
+        include SQL
+
+      end # module MysqlAdapter
+
+    end # module Adapters
+  end # module Constraints
+end # module DataMapper

data/lib/dm-constraints/adapters/dm-oracle-adapter.rb

@@ -0,0 +1,13 @@
+require 'dm-constraints/adapters/dm-do-adapter'
+
+module DataMapper
+  module Constraints
+    module Adapters
+
+      module OracleAdapter
+        include DataObjectsAdapter
+      end
+
+    end
+  end
+end

data/lib/dm-constraints/adapters/dm-postgres-adapter.rb

@@ -0,0 +1,13 @@
+require 'dm-constraints/adapters/dm-do-adapter'
+
+module DataMapper
+  module Constraints
+    module Adapters
+
+      module PostgresAdapter
+        include DataObjectsAdapter
+      end
+
+    end
+  end
+end

data/lib/dm-constraints/adapters/dm-sqlite-adapter.rb

@@ -0,0 +1,22 @@
+module DataMapper
+  module Constraints
+    module Adapters
+
+      module SqliteAdapter
+
+        def constraint_exists?(*)
+          false
+        end
+
+        def create_relationship_constraint(*)
+          false
+        end
+
+        def destroy_relationship_constraint(*)
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/dm-constraints/adapters/dm-sqlserver-adapter.rb

@@ -0,0 +1,13 @@
+require 'dm-constraints/adapters/dm-do-adapter'
+
+module DataMapper
+  module Constraints
+    module Adapters
+
+      module SqlserverAdapter
+        include DataObjectsAdapter
+      end
+
+    end
+  end
+end