polymorphic_constraints 1.0.0

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "4.1.6"
+
+gemspec :path => "../"

data/lib/polymorphic_constraints.rb

@@ -0,0 +1,24 @@
+require 'active_support/all'
+
+module PolymorphicConstraints
+  extend ActiveSupport::Autoload
+  autoload :Adapter
+
+  module ConnectionAdapters
+    extend ActiveSupport::Autoload
+
+    autoload_under 'abstract' do
+      autoload :SchemaStatements
+    end
+  end
+
+  module Migration
+    autoload :CommandRecorder, 'polymorphic_constraints/migration/command_recorder'
+  end
+end
+
+PolymorphicConstraints::Adapter.register 'sqlite3', 'polymorphic_constraints/connection_adapters/sqlite3_adapter'
+PolymorphicConstraints::Adapter.register 'postgresql', 'polymorphic_constraints/connection_adapters/postgresql_adapter'
+PolymorphicConstraints::Adapter.register 'mysql2', 'polymorphic_constraints/connection_adapters/mysql2_adapter'
+
+require 'polymorphic_constraints/railtie' if defined?(Rails)

data/lib/polymorphic_constraints/adapter.rb

@@ -0,0 +1,34 @@
+module PolymorphicConstraints
+  class Adapter
+    class_attribute :registered
+    self.registered = {}
+
+    class << self
+      def register(adapter_name, file_name)
+        registered[adapter_name] = file_name
+      end
+
+      def load!
+        if registered.key?(configured_name)
+          require registered[configured_name]
+        else
+          p "Database adapter #{configured_name} not supported. Use:\n" +
+                "PolymorphicConstraints::Adapter.register '#{configured_name}', 'path/to/adapter'"
+        end
+      end
+
+      def configured_name
+        @configured_name ||= ActiveRecord::Base.connection_pool.spec.config[:adapter]
+      end
+
+      def safe_include(adapter_class_name, adapter_ext)
+        ActiveRecord::ConnectionAdapters.const_get(adapter_class_name).class_eval do
+          unless ancestors.include? adapter_ext
+            include adapter_ext
+          end
+        end
+      rescue
+      end
+    end
+  end
+end

data/lib/polymorphic_constraints/connection_adapters/abstract/schema_statements.rb

@@ -0,0 +1,23 @@
+module PolymorphicConstraints
+  module ConnectionAdapters
+    module SchemaStatements
+      def self.included(base)
+        base::AbstractAdapter.class_eval do
+          include PolymorphicConstraints::ConnectionAdapters::AbstractAdapter
+        end
+      end
+    end
+
+    module AbstractAdapter
+      def supports_polymorphic_constraints?
+        false
+      end
+
+      def add_polymorphic_constraints(relation, associated_model, options = {})
+      end
+
+      def remove_polymorphic_constraints(relation)
+      end
+    end
+  end
+end

data/lib/polymorphic_constraints/connection_adapters/mysql2_adapter.rb

@@ -0,0 +1,167 @@
+require 'active_support/inflector'
+require_relative '../utils/sql_string'
+require_relative '../utils/polymorphic_model_finder'
+
+module PolymorphicConstraints
+  module ConnectionAdapters
+    module Mysql2Adapter
+      include PolymorphicConstraints::Utils::SqlString
+      include PolymorphicConstraints::Utils::PolymorphicModelFinder
+
+      def supports_polymorphic_constraints?
+        true
+      end
+
+      def add_polymorphic_constraints(relation, associated_table, options = {})
+        polymorphic_models = options.fetch(:polymorphic_models) { get_polymorphic_models(relation) }
+
+        statements = constraints_remove_statements(relation)
+        statements << generate_insert_constraints(relation, associated_table, polymorphic_models)
+        statements << generate_update_constraints(relation, associated_table, polymorphic_models)
+
+        polymorphic_models.each do |polymorphic_model|
+          statements << generate_delete_constraints(relation, associated_table, polymorphic_model)
+        end
+
+        statements.each { |statement| execute statement }
+      end
+
+      def remove_polymorphic_constraints(relation)
+        statements = constraints_remove_statements(relation)
+        statements.each { |statement| execute statement }
+      end
+
+      alias_method :update_polymorphic_constraints, :add_polymorphic_constraints
+
+      private
+
+      def constraints_remove_statements(relation)
+        polymorphic_models = get_polymorphic_models(relation)
+
+        statements = []
+        statements << drop_trigger(relation, 'insert')
+        statements << drop_trigger(relation, 'update')
+
+        polymorphic_models.each do |polymorphic_model|
+          statements << drop_delete_trigger(relation, polymorphic_model)
+        end
+
+        statements
+      end
+
+      def drop_trigger(relation, action)
+        sql = <<-SQL
+          DROP TRIGGER IF EXISTS check_#{relation}_#{action}_integrity;
+        SQL
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def drop_delete_trigger(relation, polymorphic_model)
+        table_name = polymorphic_model.to_s.classify.constantize.table_name
+
+        sql = <<-SQL
+          DROP TRIGGER IF EXISTS check_#{relation}_#{table_name}_delete_integrity;
+        SQL
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def generate_insert_constraints(relation, associated_table, polymorphic_models)
+        associated_table = associated_table.to_s
+
+        sql = <<-SQL
+          CREATE TRIGGER check_#{relation}_insert_integrity
+            BEFORE INSERT ON #{associated_table}
+        SQL
+
+        sql << common_upsert_sql(relation, polymorphic_models)
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def generate_update_constraints(relation, associated_table, polymorphic_models)
+        associated_table = associated_table.to_s
+
+        sql = <<-SQL
+          CREATE TRIGGER check_#{relation}_update_integrity
+            BEFORE UPDATE ON #{associated_table}
+        SQL
+
+        sql << common_upsert_sql(relation, polymorphic_models)
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def generate_delete_constraints(relation, associated_table, polymorphic_model)
+        associated_table = associated_table.to_s
+        polymorphic_model = polymorphic_model.to_s
+
+        sql = <<-SQL
+          CREATE TRIGGER check_#{relation}_#{polymorphic_model.classify.constantize.table_name}_delete_integrity
+            BEFORE DELETE ON #{polymorphic_model.classify.constantize.table_name}
+            FOR EACH ROW
+            BEGIN
+              IF EXISTS (SELECT id FROM #{associated_table}
+                         WHERE #{relation}_type = '#{polymorphic_model.classify}'
+                         AND #{relation}_id = OLD.id) THEN
+                SIGNAL SQLSTATE '45000'
+                  SET MESSAGE_TEXT = 'Polymorphic reference exists.
+                                      There are records in the #{associated_table} table that refer to the
+                                      table #{polymorphic_model.classify.constantize.table_name}.
+                                      You must delete those records of table #{associated_table} first.';
+              END IF;
+            END;
+        SQL
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def common_upsert_sql(relation, polymorphic_models)
+        polymorphic_models = polymorphic_models.map(&:to_s)
+
+        sql = <<-SQL
+          FOR EACH ROW
+          BEGIN
+            IF
+        SQL
+
+        polymorphic_models.each do |polymorphic_model|
+          sql << <<-SQL
+            NEW.#{relation}_type != '#{polymorphic_model.classify}'
+          SQL
+
+          unless polymorphic_model == polymorphic_models.last
+            sql << <<-SQL
+              AND
+            SQL
+          end
+        end
+
+        sql << <<-SQL
+          THEN SIGNAL SQLSTATE '45000'
+            SET MESSAGE_TEXT = 'Polymorphic record not found. No model by that name.';
+        SQL
+
+
+        polymorphic_models.each do |polymorphic_model|
+          sql << <<-SQL
+            ELSEIF NEW.#{relation}_type = '#{polymorphic_model.classify}' AND
+                   NOT EXISTS (SELECT id FROM #{polymorphic_model.classify.constantize.table_name}
+                               WHERE id = NEW.#{relation}_id) THEN
+
+              SIGNAL SQLSTATE '45000'
+                SET MESSAGE_TEXT = 'Polymorphic record not found. No #{polymorphic_model.classify} with that id.';
+          SQL
+        end
+
+        sql << <<-SQL
+            END IF;
+          END;
+        SQL
+      end
+    end
+  end
+end
+
+PolymorphicConstraints::Adapter.safe_include :Mysql2Adapter, PolymorphicConstraints::ConnectionAdapters::Mysql2Adapter

data/lib/polymorphic_constraints/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,147 @@
+require 'active_support/inflector'
+require_relative '../utils/sql_string'
+require_relative '../utils/polymorphic_model_finder'
+
+module PolymorphicConstraints
+  module ConnectionAdapters
+    module PostgreSQLAdapter
+      include PolymorphicConstraints::Utils::SqlString
+      include PolymorphicConstraints::Utils::PolymorphicModelFinder
+
+      def supports_polymorphic_constraints?
+        true
+      end
+
+      def add_polymorphic_constraints(relation, associated_table, options = {})
+        polymorphic_models = options.fetch(:polymorphic_models) { get_polymorphic_models(relation) }
+
+        statements = []
+        statements << drop_constraints(relation)
+        statements << generate_upsert_constraints(relation, associated_table, polymorphic_models)
+        statements << generate_delete_constraints(relation, associated_table, polymorphic_models)
+
+        statements.each { |statement| execute statement }
+      end
+
+      def remove_polymorphic_constraints(relation)
+        statement = drop_constraints(relation)
+        execute statement
+      end
+
+      alias_method :update_polymorphic_constraints, :add_polymorphic_constraints
+
+      private
+
+      def generate_upsert_constraints(relation, associated_table, polymorphic_models)
+        associated_table = associated_table.to_s
+        polymorphic_models = polymorphic_models.map(&:to_s)
+
+        sql = <<-SQL
+          CREATE FUNCTION check_#{relation}_upsert_integrity()
+            RETURNS TRIGGER AS '
+              BEGIN
+                IF NEW.#{relation}_type = ''#{polymorphic_models[0].classify}'' AND
+                   EXISTS (SELECT id FROM #{polymorphic_models[0].classify.constantize.table_name}
+                           WHERE id = NEW.#{relation}_id) THEN
+
+                  RETURN NEW;
+        SQL
+
+        polymorphic_models[1..-1].each do |polymorphic_model|
+          sql << <<-SQL
+            ELSEIF NEW.#{relation}_type = ''#{polymorphic_model.classify}'' AND
+                   EXISTS (SELECT id FROM #{polymorphic_model.classify.constantize.table_name}
+                           WHERE id = NEW.#{relation}_id) THEN
+
+              RETURN NEW;
+          SQL
+        end
+
+        sql << <<-SQL
+            ELSE
+              RAISE EXCEPTION ''Polymorphic record not found.
+                                No % model with id %.'', NEW.#{relation}_type, NEW.#{relation}_id;
+              RETURN NULL;
+            END IF;
+          END'
+          LANGUAGE plpgsql;
+
+          CREATE TRIGGER check_#{relation}_upsert_integrity_trigger
+            BEFORE INSERT OR UPDATE ON #{associated_table}
+            FOR EACH ROW
+            EXECUTE PROCEDURE check_#{relation}_upsert_integrity();
+        SQL
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def generate_delete_constraints(relation, associated_table, polymorphic_models)
+        associated_table = associated_table.to_s
+        polymorphic_models = polymorphic_models.map(&:to_s)
+
+        sql = <<-SQL
+          CREATE FUNCTION check_#{relation}_delete_integrity()
+            RETURNS TRIGGER AS '
+              BEGIN
+                IF TG_TABLE_NAME = ''#{polymorphic_models[0].classify.constantize.table_name}'' AND
+                   EXISTS (SELECT id FROM #{associated_table}
+                           WHERE #{relation}_type = ''#{polymorphic_models[0].classify}''
+                           AND #{relation}_id = OLD.id) THEN
+
+                  RAISE EXCEPTION ''Polymorphic reference exists.
+                                    There are records in #{associated_table} that refer to the table % with id %.
+                                    You must delete those records of table #{associated_table} first.'', TG_TABLE_NAME, OLD.id;
+                  RETURN NULL;
+        SQL
+
+        polymorphic_models[1..-1].each do |polymorphic_model|
+          sql << <<-SQL
+            ELSEIF TG_TABLE_NAME = ''#{polymorphic_model.classify.constantize.table_name}'' AND
+                   EXISTS (SELECT id FROM #{associated_table}
+                           WHERE #{relation}_type = ''#{polymorphic_model.classify}''
+                           AND #{relation}_id = OLD.id) THEN
+
+              RAISE EXCEPTION ''Polymorphic reference exists.
+                                There are records in #{associated_table} that refer to the table % with id %.
+                                You must delete those records of table #{associated_table} first.'', TG_TABLE_NAME, OLD.id;
+              RETURN NULL;
+          SQL
+        end
+
+        sql << <<-SQL
+              ELSE
+                RETURN OLD;
+              END IF;
+            END'
+          LANGUAGE plpgsql;
+        SQL
+
+        polymorphic_models.each do |polymorphic_model|
+          table_name = polymorphic_model.classify.constantize.table_name
+
+          sql << <<-SQL
+            CREATE TRIGGER check_#{relation}_#{table_name}_delete_integrity_trigger
+              BEFORE DELETE ON #{table_name}
+              FOR EACH ROW
+              EXECUTE PROCEDURE check_#{relation}_delete_integrity();
+          SQL
+        end
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def drop_constraints(relation)
+        sql = <<-SQL
+          DROP FUNCTION IF EXISTS check_#{relation}_upsert_integrity()
+            CASCADE;
+          DROP FUNCTION IF EXISTS check_#{relation}_delete_integrity()
+            CASCADE;
+        SQL
+
+        strip_non_essential_spaces(sql)
+      end
+    end
+  end
+end
+
+PolymorphicConstraints::Adapter.safe_include :PostgreSQLAdapter, PolymorphicConstraints::ConnectionAdapters::PostgreSQLAdapter

data/lib/polymorphic_constraints/connection_adapters/sqlite3_adapter.rb

@@ -0,0 +1,166 @@
+require 'active_support/inflector'
+require_relative '../utils/sql_string'
+require_relative '../utils/polymorphic_model_finder'
+
+module PolymorphicConstraints
+  module ConnectionAdapters
+    module SQLite3Adapter
+      include PolymorphicConstraints::Utils::SqlString
+      include PolymorphicConstraints::Utils::PolymorphicModelFinder
+
+      def supports_polymorphic_constraints?
+        true
+      end
+
+      def add_polymorphic_constraints(relation, associated_table, options = {})
+        polymorphic_models = options.fetch(:polymorphic_models) { get_polymorphic_models(relation) }
+
+        statements = constraints_remove_statements(relation)
+        statements << generate_create_constraints(relation, associated_table, polymorphic_models)
+        statements << generate_update_constraints(relation, associated_table, polymorphic_models)
+
+        polymorphic_models.each do |polymorphic_model|
+          statements << generate_delete_constraints(relation, associated_table, polymorphic_model)
+        end
+
+        statements.each { |statement| execute statement }
+      end
+
+      def remove_polymorphic_constraints(relation)
+        statements = constraints_remove_statements(relation)
+        statements.each { |statement| execute statement }
+      end
+
+      alias_method :update_polymorphic_constraints, :add_polymorphic_constraints
+
+      private
+
+      def constraints_remove_statements(relation)
+        polymorphic_models = get_polymorphic_models(relation)
+
+        statements = []
+        statements << drop_trigger(relation, 'insert')
+        statements << drop_trigger(relation, 'update')
+
+        polymorphic_models.each do |polymorphic_model|
+          statements << drop_delete_trigger(relation, polymorphic_model)
+        end
+
+        statements
+      end
+
+      def drop_trigger(relation, action)
+        sql = <<-SQL
+          DROP TRIGGER IF EXISTS check_#{relation}_#{action}_integrity;
+        SQL
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def drop_delete_trigger(relation, polymorphic_model)
+        table_name = polymorphic_model.to_s.classify.constantize.table_name
+
+        sql = <<-SQL
+          DROP TRIGGER IF EXISTS check_#{relation}_#{table_name}_delete_integrity;
+        SQL
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def generate_create_constraints(relation, associated_table, polymorphic_models)
+        associated_table = associated_table.to_s
+
+        sql = <<-SQL
+          CREATE TRIGGER check_#{relation}_insert_integrity
+            BEFORE INSERT ON #{associated_table}
+        SQL
+
+        sql << common_upsert_sql(relation, polymorphic_models)
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def generate_update_constraints(relation, associated_table, polymorphic_models)
+        associated_table = associated_table.to_s
+        polymorphic_models = polymorphic_models.map(&:to_s)
+
+        sql = <<-SQL
+          CREATE TRIGGER check_#{relation}_update_integrity
+            BEFORE UPDATE ON #{associated_table}
+        SQL
+
+        sql << common_upsert_sql(relation, polymorphic_models)
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def generate_delete_constraints(relation, associated_table, polymorphic_model)
+        associated_table = associated_table.to_s
+        polymorphic_model = polymorphic_model.to_s
+        
+        sql = <<-SQL
+          CREATE TRIGGER check_#{relation}_#{polymorphic_model.classify.constantize.table_name}_delete_integrity
+            BEFORE DELETE ON #{polymorphic_model.classify.constantize.table_name}
+            BEGIN
+              SELECT CASE
+                WHEN EXISTS (SELECT id FROM #{associated_table}
+                             WHERE #{relation}_type = '#{polymorphic_model.classify}'
+                             AND #{relation}_id = OLD.id) THEN
+                  RAISE(ABORT, 'Polymorphic reference exists.
+                                There are records in the #{associated_table} table that refer to the
+                                table #{polymorphic_model.classify.constantize.table_name}.
+                                You must delete those records of table #{associated_table} first.')
+              END;
+            END;
+        SQL
+
+        strip_non_essential_spaces(sql)
+      end
+
+      def common_upsert_sql(relation, polymorphic_models)
+        polymorphic_models = polymorphic_models.map(&:to_s)
+
+        sql = <<-SQL
+          BEGIN
+            SELECT CASE
+        SQL
+
+        sql << <<-SQL
+          WHEN (
+        SQL
+
+        polymorphic_models.each do |polymorphic_model|
+          sql << <<-SQL
+            NEW.#{relation}_type != '#{polymorphic_model.classify}'
+          SQL
+
+          unless polymorphic_model == polymorphic_models.last
+            sql << <<-SQL
+              AND
+            SQL
+          end
+        end
+
+        sql << <<-SQL
+          ) THEN RAISE(ABORT, 'Polymorphic record not found. No model by that name.')
+        SQL
+
+        polymorphic_models.each do |polymorphic_model|
+          sql << <<-SQL
+            WHEN ((NEW.#{relation}_type = '#{polymorphic_model.classify}') AND
+                  NOT EXISTS (SELECT id FROM #{polymorphic_model.classify.constantize.table_name}
+                              WHERE id = NEW.#{relation}_id)) THEN
+              RAISE(ABORT, 'Polymorphic record not found. No #{polymorphic_model.classify} with that id.')
+          SQL
+        end
+
+        sql << <<-SQL
+            END;
+          END;
+        SQL
+      end
+    end
+  end
+end
+
+PolymorphicConstraints::Adapter.safe_include :SQLite3Adapter, PolymorphicConstraints::ConnectionAdapters::SQLite3Adapter