Merge pull request #96 from combinaut/add-trigger-filtering-support

Add trigger filtering support to schema dumper

Author: jenseng

README.md

@@ -240,6 +240,21 @@ As long as you don't delete old migrations and schema.rb prior to running
 If you have deleted all trigger migrations, you can regenerate a new
 baseline for model triggers via `rake db:generate_trigger_migration`.
 
+### Filtering
+
+It is possible to filter which triggers are dumped by setting any of these
+configuration values:
+
+```ruby
+HairTrigger::SchemaDumper::Configuration.ignore_triggers = 'exact_trigger_name'
+HairTrigger::SchemaDumper::Configuration.ignore_tables = [/partial_/, 'exact_table_name']
+HairTrigger::SchemaDumper::Configuration.allow_triggers = [/partial_/, 'exact_trigger_name']
+HairTrigger::SchemaDumper::Configuration.allow_tables = 'exact_table_name'
+```
+
+Each option can accept a single String or Regexp, or a mixed array of both.
+
+
 ## Testing
 
 To stay on top of things, it's strongly recommended that you add a test or

lib/hair_trigger/schema_dumper.rb

@@ -1,5 +1,12 @@
 module HairTrigger
   module SchemaDumper
+    module Configuration
+      mattr_accessor :allow_tables
+      mattr_accessor :allow_triggers
+      mattr_accessor :ignore_tables
+      mattr_accessor :ignore_triggers
+    end
+
     module TrailerWithTriggersSupport
       def trailer(stream)
         orig_show_warnings = Builder.show_warnings
@@ -91,9 +98,35 @@ def normalize_trigger(name, definition, type)
     end
 
     def whitelist_triggers(triggers)
-      triggers.reject do |name, source|
+      triggers = triggers.reject do |name, source|
         ActiveRecord::SchemaDumper.ignore_tables.any? { |ignored_table_name| source =~ /ON\s+#{@connection.quote_table_name(ignored_table_name)}\s/ }
       end
+
+      if Configuration.allow_tables.present?
+        triggers = triggers.select do |name, source|
+          Array(Configuration.allow_tables).any? { |allowed_table_name| source =~ /ON\s+#{@connection.quote_table_name(allowed_table_name)}\s/ }
+        end
+      end
+
+      if Configuration.allow_triggers.present?
+        triggers = triggers.select do |name, source|
+          Array(Configuration.allow_triggers).any? { |allowed_trigger_name| allowed_trigger_name === name } # Triple equals to allow regexps or strings as allowed_trigger_name
+        end
+      end
+
+      if Configuration.ignore_tables.present?
+        triggers = triggers.reject do |name, source|
+          Array(Configuration.ignore_tables).any? { |allowed_table_name| source =~ /ON\s+#{@connection.quote_table_name(allowed_table_name)}\s/ }
+        end
+      end
+
+      if Configuration.ignore_triggers.present?
+        triggers = triggers.reject do |name, source|
+          Array(Configuration.ignore_triggers).any? { |allowed_trigger_name| allowed_trigger_name === name } # Triple equals to allow regexps or strings as allowed_trigger_name
+        end
+      end
+
+      triggers
     end
 
     def self.included(base)

spec/schema_dumper_spec.rb

@@ -15,6 +15,98 @@
       db_triggers.grep(/bob_count \+ 1/).size.should eql(1)
     end
 
+    shared_examples_for 'filterable' do
+      it 'should take in consideration active record schema dumper ignore_tables option with regexp' do
+        ActiveRecord::SchemaDumper.ignore_tables = [/users/]
+
+        dump_schema.should_not match(/create_trigger/)
+      end
+
+      it 'should take in consideration active record schema dumper ignore_tables option with string' do
+        ActiveRecord::SchemaDumper.ignore_tables = ['users']
+
+        dump_schema.should_not match(/create_trigger/)
+      end
+
+      it 'should take in consideration active record schema dumper ignore_tables option with partial string' do
+        ActiveRecord::SchemaDumper.ignore_tables = ['user']
+
+        dump_schema.should match(/create_trigger/)
+      end
+
+      it 'should ignore configured ignore_tables option with regexp' do
+        HairTrigger::SchemaDumper::Configuration.stub(:ignore_tables).and_return([/users/])
+
+        dump_schema.should_not match(/create_trigger/)
+      end
+
+      it 'should ignore configured ignore_tables option with string' do
+        HairTrigger::SchemaDumper::Configuration.stub(:ignore_tables).and_return(['users'])
+
+        dump_schema.should_not match(/create_trigger/)
+      end
+
+      it 'should not ignore configured ignore_tables option with partial string' do
+        HairTrigger::SchemaDumper::Configuration.stub(:ignore_tables).and_return(['user'])
+
+        dump_schema.should match(/create_trigger/)
+      end
+
+      it 'should ignore configured ignore_triggers option with regexp' do
+        HairTrigger::SchemaDumper::Configuration.stub(:ignore_triggers).and_return([/bob/])
+
+        dump_schema.should_not match(/trigger.+bob/i)
+      end
+
+      it 'should ignore configured ignore_triggers option with string' do
+        HairTrigger::SchemaDumper::Configuration.stub(:ignore_triggers).and_return(['users_after_insert_row_when_new_name_bob__tr'])
+
+        dump_schema.should_not match(/trigger.+bob/i)
+      end
+
+      it 'should not ignore configured ignore_triggers option with partial string' do
+        HairTrigger::SchemaDumper::Configuration.stub(:ignore_triggers).and_return(['users_after_insert_row_when_new_name_bob'])
+
+        dump_schema.should match(/trigger.+bob/i)
+      end
+
+      it 'should allow configured allow_tables option with regexp' do
+        HairTrigger::SchemaDumper::Configuration.stub(:allow_tables).and_return([/users/])
+
+        dump_schema.should match(/create_trigger/)
+      end
+
+      it 'should allow configured allow_tables option with string' do
+        HairTrigger::SchemaDumper::Configuration.stub(:allow_tables).and_return(['users'])
+
+        dump_schema.should match(/create_trigger/)
+      end
+
+      it 'should not allow configured allow_tables option with partial string' do
+        HairTrigger::SchemaDumper::Configuration.stub(:allow_tables).and_return(['user'])
+
+        dump_schema.should_not match(/create_trigger/)
+      end
+
+      it 'should allow configured allow_triggers option with regexp' do
+        HairTrigger::SchemaDumper::Configuration.stub(:allow_triggers).and_return([/bob/])
+
+        dump_schema.should match(/trigger.+bob/i)
+      end
+
+      it 'should allow configured allow_triggers option with string' do
+        HairTrigger::SchemaDumper::Configuration.stub(:allow_triggers).and_return(['users_after_insert_row_when_new_name_bob__tr'])
+
+        dump_schema.should match(/trigger.+bob/i)
+      end
+
+      it 'should not allow configured allow_triggers option with partial string' do
+        HairTrigger::SchemaDumper::Configuration.stub(:allow_triggers).and_return(['users_after_insert_row_when_new_name_bob'])
+
+        dump_schema.should_not match(/trigger.+bob/i)
+      end
+    end
+
     context "without schema.rb" do
       it "should work" do
         schema_rb = dump_schema
@@ -45,25 +137,7 @@
         schema_rb.should_not match(/bob_count \+ 2/)
       end
 
-      it 'should take in consideration active record schema dumper ignore_tables option with regexp' do
-        ActiveRecord::SchemaDumper.ignore_tables = [/users/]
-
-        dump_schema.should_not match(/create_trigger/)
-      end
-
-      it 'should take in consideration active record schema dumper ignore_tables option with string' do
-        ActiveRecord::SchemaDumper.ignore_tables = ['users']
-
-        dump_schema.should_not match(/create_trigger/)
-      end
-
-      it 'should take in consideration active record schema dumper ignore_tables option with partial string' do
-        ActiveRecord::SchemaDumper.ignore_tables = ['user']
-
-        dump_schema.should match(/create_trigger/)
-      end
-
-
+      it_should_behave_like 'filterable'
     end
 
     context "with schema.rb" do
@@ -100,24 +174,7 @@
         schema_rb.should_not match(/bob_count \+ 2/)
       end
 
-      it 'should take in consideration active record schema dumper ignore_tables option with regexp' do
-        ActiveRecord::SchemaDumper.ignore_tables = [/users/]
-
-        dump_schema.should_not match(/create_trigger/)
-      end
-
-      it 'should take in consideration active record schema dumper ignore_tables option with string' do
-        ActiveRecord::SchemaDumper.ignore_tables = ['users']
-
-        dump_schema.should_not match(/create_trigger/)
-      end
-
-      it 'should take in consideration active record schema dumper ignore_tables option with partial string' do
-        ActiveRecord::SchemaDumper.ignore_tables = ['user']
-
-        dump_schema.should match(/create_trigger/)
-      end
-
+      it_should_behave_like 'filterable'
     end
 
   end