mv-core 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Valeriy Prokopchuk
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,88 @@
+= Abbreviations
+
+MV - Migration Validators Projects. All gems that belongs to that project are prefixed with mv-*
+
+= Project goals
+
+Main goal of the project is to allow developer to express database constraints in a Ruby like manner. 
+
+= mv-core
+
+mv-core is a set of core classes that are used everywhere across Migration Validators project gems. 
+
+= Usage
+
+  Create new table:
+
+  create_table do |t|
+    t.string :str_column, :validates => {:uniqueness => true, :inclusion => {:in => 1..3}}
+    t.column :column_name, :integer, :validates => {:exclusion => {:in => [1,2,3]}}
+  end
+
+  Modify existing table: 
+
+  change_table do |t|
+    t.change :str_column, :integer, :validates => {:exclusion => {:in => [1,2,3]}}
+    t.change_validates :column_name, :inclusion => {:in => 1..3}
+  end
+
+  Update existing table with new validators: 
+
+  validate_column :table_name, :str_column, :exclusion => {:in => [1,2,3]}
+
+  Remove existing validators: 
+
+  change_table do |t|
+    t.change :str_column, :integer, :validates => {:exclusion => false}
+  end
+  validate_column table_name, :str_column, :exclusion => false
+
+  Define the way how validator will be created:
+
+  as trigger:
+
+  validate_column :table_name, :str_column, :validates => {:uniqueness => true, :as => :trigger }
+
+  as check constraint:
+
+  validate_column :table_name, :str_column, :validates => {:uniqueness => true, :as => :check }
+
+  Define event that will be validates:
+
+  while new record creation: 
+
+  validate_column :table_name, :str_column, :validates => {:uniqueness => true, :on => :create }
+
+  or while updating of existing record:
+
+  validate_column :table_name, :str_column, :validates => {:uniqueness => true, :on => :create }
+
+  Supported validators and their properties might vary from one db driver to another. See detailed properties description in correspondent driver section.  
+
+= Drivers
+
+Currently there are drivers for MySQL, PostgreSQL and SQLite RDBMS
+
+So - see detailed info here: 
+
+PostgreSQL: https://github.com/vprokopchuk256/mv-postgresql
+
+MySQL: https://github.com/vprokopchuk256/mv-mysql
+
+SQLite: https://github.com/vprokopchuk256/mv-sqlite
+
+
+== Contributing to mv-core
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Valeriy Prokopchuk. See LICENSE.txt for
+further details.

data/lib/migration_validators/active_record/base.rb

@@ -0,0 +1,24 @@
+module MigrationValidators
+  module ActiveRecord
+    module Base
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          class << self
+            alias_method_chain :establish_connection, :validators
+          end
+        end
+      end
+
+      module ClassMethods
+        def establish_connection_with_validators *args
+          establish_connection_without_validators *args
+
+          connection.class.class_eval {
+            include MigrationValidators::ActiveRecord::ConnectionAdapters::NativeAdapter
+          } unless connection.class.include?(MigrationValidators::ActiveRecord::ConnectionAdapters::NativeAdapter)
+        end
+      end
+    end
+  end
+end

data/lib/migration_validators/active_record/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,36 @@
+module MigrationValidators
+  module ActiveRecord
+    module ConnectionAdapters 
+      module AbstractAdapter 
+        def self.included(base)
+          base.class_eval do
+            alias_method_chain :initialize_schema_migrations_table, :validators
+          end
+        end
+
+        def initialize_migration_validators_table
+          migrations_table = MigrationValidators.migration_validators_table_name
+
+          unless table_exists?(migrations_table)
+            create_table migrations_table do |t|
+              t.string :table_name, :null => false, :limit => 255
+              t.string :column_name, :null => true, :limit => 255
+              t.string :validator_name, :null => false, :limit => 255
+              t.text :options
+              t.text :constraints
+            end 
+
+            add_index migrations_table, :table_name
+            add_index migrations_table, [:table_name, :column_name], :name => 'mg_vld_tbl_clm'
+            add_index migrations_table, [:table_name, :column_name, :validator_name], :name => 'mg_vld_tbl_clm_vldn', :unique => true
+          end
+        end
+
+        def initialize_schema_migrations_table_with_validators
+          initialize_schema_migrations_table_without_validators
+          initialize_migration_validators_table
+        end
+      end
+    end
+  end
+end

data/lib/migration_validators/active_record/connection_adapters/native_adapter.rb

@@ -0,0 +1,118 @@
+module MigrationValidators
+  module ActiveRecord
+    module ConnectionAdapters 
+      module NativeAdapter 
+        def self.included(base)
+          base.class_eval do
+            alias_method_chain :drop_table, :validators
+            alias_method_chain :remove_column, :validators
+            alias_method_chain :rename_column, :validators
+            alias_method_chain :change_column, :validators
+            alias_method_chain :add_column, :validators
+            alias_method_chain :rename_table, :validators
+            alias_method_chain :create_table, :validators
+          end
+        end
+
+        def validate_column table_name, column_name, opts
+          table_name = table_name || @context_table_name
+          raise MigrationValidatorsException.new("at least one column validator should be defined") if opts.blank?
+          
+
+          opts.each do |validator_name, validator_options|
+            if validator_options.blank?
+              raise MigrationValidatorsException.new("use false to remove column validator") unless validator_options == false
+
+              MigrationValidators::Core::DbValidator.remove_column_validator table_name, column_name, validator_name
+            else 
+              validator_options = {} if validator_options == true
+              MigrationValidators::Core::DbValidator.add_column_validator table_name, column_name, validator_name, validator_options
+            end
+          end
+        end
+
+        def in_context_of_table table_name
+          @context_table_name = table_name
+          res = yield if block_given?
+          @context_table_name = nil
+          res
+        end
+
+        def do_internally
+          disable_migration_validators
+          yield
+          enable_migration_validators
+        end
+
+        private
+
+        def disable_migration_validators
+          @migration_validators_call_stack = [0, @migration_validators_call_stack ||= 0].max + 1
+        end
+
+        def enable_migration_validators
+          @migration_validators_call_stack = [0, @migration_validators_call_stack ||= 0].max - 1
+        end
+
+        def migration_validators_enabled
+          (@migration_validators_call_stack ||= 0) <= 0
+        end
+
+
+        def do_enabled
+          yield if migration_validators_enabled
+        end
+
+
+        def drop_table_with_validators table_name
+          do_enabled { MigrationValidators::Core::DbValidator.remove_table_validators table_name }
+          do_internally { drop_table_without_validators table_name }
+        end
+
+        def remove_column_with_validators table_name, *column_names
+          do_enabled do
+            column_names.flatten.each do |column_name| 
+              MigrationValidators::Core::DbValidator.remove_column_validators table_name, column_name 
+            end
+          end
+
+          do_internally { remove_column_without_validators table_name, *column_names }
+        end
+
+        def rename_column_with_validators table_name, old_column_name, new_column_name
+          do_enabled { MigrationValidators::Core::DbValidator.rename_column table_name, old_column_name, new_column_name }
+          do_internally { rename_column_without_validators table_name, old_column_name, new_column_name }
+        end
+
+        def add_column_with_validators table_name, column_name, type, opts
+          validates = opts.delete(:validates)
+
+          do_internally { add_column_without_validators table_name, column_name, type, opts }
+
+          do_enabled { validate_column(table_name, column_name, validates) } unless validates.blank?
+        end
+
+        def rename_table_with_validators old_table_name, new_table_name
+          do_enabled { MigrationValidators::Core::DbValidator.rename_table old_table_name, new_table_name }
+          do_internally { rename_table_without_validators old_table_name, new_table_name }
+        end
+
+        def change_column_with_validators table_name, column_name, type, opts
+          validates = opts.delete(:validates)
+
+          do_enabled { MigrationValidators::Core::DbValidator.remove_column_validators table_name, column_name }
+
+          do_internally { change_column_without_validators table_name, column_name, type, opts }
+
+          do_enabled { validate_column(table_name, column_name, validates) } unless validates.blank?
+        end
+
+        def create_table_with_validators table_name, *args, &block
+          in_context_of_table table_name do
+            create_table_without_validators table_name, *args, &block
+          end
+       end
+      end
+    end
+  end
+end

data/lib/migration_validators/active_record/connection_adapters/table.rb

@@ -0,0 +1,15 @@
+module MigrationValidators
+  module ActiveRecord
+    module ConnectionAdapters
+      module Table
+        def self.included(base)
+          base.class_eval do
+            def change_validates column_name, opts
+              ::ActiveRecord::Base.connection.validate_column(@table_name, column_name, opts) unless opts.blank?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/migration_validators/active_record/connection_adapters/table_definition.rb

@@ -0,0 +1,24 @@
+module MigrationValidators
+  module ActiveRecord
+    module ConnectionAdapters
+      module TableDefinition
+        def self.included(base)
+          base.class_eval do
+            alias_method_chain :column, :validators
+
+            def change_validates *args
+            end
+          end
+        end
+
+        def column_with_validators name, type, options = {}
+          validates = options.delete(:validates)
+
+          column_without_validators name, type, options
+
+          ::ActiveRecord::Base.connection.validate_column(nil, name, validates) unless validates.blank?
+        end
+      end
+    end
+  end
+end

data/lib/migration_validators/active_record/migration.rb

@@ -0,0 +1,29 @@
+module MigrationValidators
+  module ActiveRecord
+    module Migration
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          class << self
+            alias_method_chain :migrate, :validators
+          end
+        end
+      end
+
+      module ClassMethods
+        def migrate_with_validators *args
+
+          connection.class.class_eval {
+            include MigrationValidators::ActiveRecord::ConnectionAdapters::NativeAdapter
+          } unless connection.class.include?(MigrationValidators::ActiveRecord::ConnectionAdapters::NativeAdapter)
+
+          connection.initialize_migration_validators_table
+
+          migrate_without_validators *args
+
+          MigrationValidators::Core::DbValidator.commit MigrationValidators.validator
+        end
+      end
+    end
+  end
+end

data/lib/migration_validators/active_record/schema.rb

@@ -0,0 +1,31 @@
+module MigrationValidators
+  module ActiveRecord
+    module Schema
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          class << self
+            alias_method_chain :define, :validators
+          end
+        end
+      end
+
+      module ClassMethods
+        def define_with_validators *args, &block
+
+          connection.class.class_eval {
+            include MigrationValidators::ActiveRecord::ConnectionAdapters::NativeAdapter
+          } unless connection.class.include?(MigrationValidators::ActiveRecord::ConnectionAdapters::NativeAdapter)
+
+          connection.initialize_migration_validators_table
+
+          res = define_without_validators *args, &block
+
+          MigrationValidators::Core::DbValidator.commit MigrationValidators.validator
+
+          res
+        end
+      end
+    end
+  end
+end

data/lib/migration_validators/active_record/schema_dumper.rb

@@ -0,0 +1,24 @@
+module MigrationValidators
+  module ActiveRecord
+    module SchemaDumper
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :tables, :validators
+        end
+      end
+
+      def tables_with_validators(stream)
+        tables_without_validators(stream)
+
+        stream.puts ""
+        stream.puts "  #Validators"
+        MigrationValidators::Core::DbValidator.find(:all, :order => "table_name, column_name").each do |validator|
+          stream.puts "  validate_column :#{validator.table_name}, :#{validator.column_name}, :#{validator.validator_name} => #{validator.options.inspect}"
+        end
+      end
+
+      private 
+        
+    end
+  end
+end

data/lib/migration_validators/adapters/base.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__)) + '/syntax'
+require File.expand_path(File.dirname(__FILE__)) + '/validator_definitions'
+require File.expand_path(File.dirname(__FILE__)) + '/containers'
+require File.expand_path(File.dirname(__FILE__)) + '/routing'
+
+module MigrationValidators
+  module Adapters
+    class Base
+      include MigrationValidators::Adapters::Syntax
+      include MigrationValidators::Adapters::ValidatorDefinitions
+      include MigrationValidators::Adapters::Containers
+      include MigrationValidators::Adapters::Routing
+    end
+  end
+end

data/lib/migration_validators/adapters/containers.rb

@@ -0,0 +1,102 @@
+module MigrationValidators
+  module Adapters
+    module Containers
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def containers
+          @containers ||= {}
+        end
+
+        def container name, &block
+          raise "Container name is not defined" if name.blank?
+
+          container = containers[name] ||= MigrationValidators::Core::ValidatorContainer.new(name, validators, syntax)
+          container.instance_eval(&block) if block
+          container
+        end
+
+        def define_base_containers
+          container :insert_trigger do
+            group do |validator|
+              [validator.table_name, (validator.options && validator.options[:insert_trigger_name]) || "trg_mgr_validates_#{validator.table_name}_ins"]
+            end
+
+            constraint_name do |group_name|
+              group_name.last
+            end
+
+            operation :create do |stmt, trigger_name, group_name|
+              "CREATE TRIGGER #{trigger_name} BEFORE INSERT ON #{group_name.first} FOR EACH ROW
+               BEGIN
+                #{stmt};
+               END;"
+            end
+
+            operation :drop do |stmt, trigger_name, group_name|
+              "DROP TRIGGER IF EXISTS #{trigger_name};"
+            end
+
+            operation :join do |stmt, value|
+              [stmt, value].delete_if(&:blank?).join(";\n")
+            end
+
+            operation :db_name do |value|
+              "NEW.#{value}"
+            end
+
+          end
+
+          container :update_trigger do
+            group do |validator|
+              [validator.table_name, (validator.options && validator.options[:update_trigger_name]) || "trg_mgr_validates_#{validator.table_name}_upd"]
+            end
+
+            constraint_name do |group_name|
+              group_name.last
+            end
+
+            operation :create do |stmt, trigger_name, group_name|
+              "CREATE TRIGGER #{trigger_name} BEFORE UPDATE ON #{group_name.first} FOR EACH ROW
+               BEGIN
+                #{stmt};
+               END;"
+            end
+
+            operation :drop do |stmt, trigger_name, group_name|
+              "DROP TRIGGER IF EXISTS #{trigger_name};"
+            end
+
+            operation :join do |stmt, value|
+              [stmt, value].delete_if(&:blank?).join(";\n")
+            end
+
+            operation :db_name do |value|
+              "NEW.#{value}"
+            end
+          end
+
+          container :check do
+            group do |validator|
+              [validator.table_name, (validator.options && validator.options[:check_name]) || "chk_#{validator.table_name}_#{validator.column_name}"]
+            end
+
+            constraint_name do |group_name|
+              group_name.last
+            end
+
+            operation :create do |stmt, check_name, group_name|
+              "ALTER TABLE #{group_name.first} ADD CONSTRAINT #{check_name} CHECK(#{stmt});"
+            end
+
+            operation :drop do |stmt, check_name, group_name|
+              "ALTER TABLE #{group_name.first} DROP CONSTRAINT #{check_name};"
+            end
+          end
+        end
+      end
+    end
+  end
+end