hairtrigger 0.2.6 → 0.2.7

data/README.md

@@ -7,31 +7,8 @@ and a simple rake task does all the dirty work for you.
 
 ## Installation
 
-### Rails 3 or 4
-
-If you are using Rails 3 or 4, just `gem 'hairtrigger'`
-
-### Rails 2
-
-#### Step 1.
-
-Put hairtrigger in your Gemfile, or if you're not using bundler, you can
-`gem install hairtrigger` and then put hairtrigger in environment.rb
-
-#### Step 2.
-
-Create lib/tasks/hair_trigger.rake with the following:
-
-```ruby
-$VERBOSE = nil
-Dir["#{Gem::Specification.find_by_name('hairtrigger').full_gem_path}/lib/tasks/*.rake"].each { |ext| load ext }
-```
-
-This will give you the `db:generate_trigger_migration` task, and will ensure
-that hairtrigger hooks into `db:schema:dump`.
-
-If you are unpacking the gem in vendor/plugins, this step is not needed
-(though you'll then want to delete its Gemfile to avoid possible conflicts).
+If you are using Rails 3 or beyond, just add `gem 'hairtrigger'` to your
+Gemfile. For Rails 2, it's [slightly more involved](RAILS2.md)
 
 ## Usage
 
@@ -135,6 +112,11 @@ For MySQL, this will just create a single trigger with conditional logic
 distinct triggers. This same notation is also used within trigger migrations.
 MySQL does not currently support nested trigger groups.
 
+Because of these differences in how the triggers are created, take care
+when setting the `name` for triggers or groups. In other words,
+PostgreSQL/SQLite will use the `name`s specified on the individual
+triggers; MySQL will use the `name` specified on the group.
+
 ### Database-specific trigger bodies
 
 Although HairTrigger aims to be totally db-agnostic, at times you do need a
@@ -173,6 +155,11 @@ create_trigger(:compatibility => 1).on(:users).after(:insert) do
 end
 ```
 
+Because `create_trigger` may drop an existing trigger of the same name,
+you need to actually implement `up`/`down` methods in your migration
+(rather than `change`) so that it does the right thing when
+rolling back.
+
 #### Manual triggers and :compatibility
 
 As bugs are fixed and features are implemented in hairtrigger, it's possible

data/lib/hair_trigger.rb

@@ -70,7 +70,7 @@ module HairTrigger
       if previous_schema = (options.has_key?(:previous_schema) ? options[:previous_schema] : File.exist?(schema_rb_path) && File.read(schema_rb_path))
         base_triggers = MigrationReader.get_triggers(previous_schema, options)
         unless base_triggers.empty?
-          version = (previous_schema =~ /ActiveRecord::Schema\.define\(:version => (\d+)\)/) && $1.to_i
+          version = (previous_schema =~ /ActiveRecord::Schema\.define\(.*?(\d+)\)/) && $1.to_i
           migrations.unshift [OpenStruct.new({:version => version}), base_triggers]
         end
       end

data/lib/hair_trigger/builder.rb

@@ -15,6 +15,7 @@ module HairTrigger
       @options = {}
       @chained_calls = []
       @errors = []
+      @warnings = []
       set_name(name) if name
       {:timing => :after, :for_each => :row}.update(options).each do |key, value|
         if respond_to?("set_#{key}")
@@ -30,6 +31,7 @@ module HairTrigger
       @triggers = nil
       @chained_calls = []
       @errors = []
+      @warnings = []
       @options = @options.dup
       @options.delete(:name) # this will be inferred (or set further down the line)
       @options.each do |key, value|
@@ -112,9 +114,15 @@ module HairTrigger
       [prepared_name] + (@triggers ? @triggers.map(&:prepared_name) : [])
     end
 
+    def all_triggers(include_self = true)
+      triggers = []
+      triggers << self if include_self
+      (@triggers || []).map(&:all_triggers).inject(triggers, &:concat)
+    end
+
     def self.chainable_methods(*methods)
       methods.each do |method|
-        class_eval <<-METHOD
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
           alias #{method}_orig #{method}
           def #{method}(*args)
             @chained_calls << :#{method}
@@ -128,7 +136,7 @@ module HairTrigger
               @chained_calls.pop # the subtrigger will get this, we don't need it
               @chained_calls = @chained_calls.uniq
               @triggers << trigger = clone
-              trigger.#{method}(*args, &Proc.new)
+              trigger.#{method}(*args, &(block_given? ? Proc.new : nil))
             else
               #{method}_orig(*args)
               maybe_execute(&Proc.new) if block_given?
@@ -160,6 +168,10 @@ module HairTrigger
         raise GenerationError, error if adapters.include?(adapter_name)
         $stderr.puts "WARNING: " + error if self.class.show_warnings
       end
+      @warnings.each do |(error, *adapters)|
+        $stderr.puts "WARNING: " + error if adapters.include?(adapter_name) && self.class.show_warnings
+      end
+
       if direction != :up
         @triggers.each{ |t| t.validate!(:down) } if @triggers
       end
@@ -247,7 +259,11 @@ module HairTrigger
     end
 
     def errors
-      (@triggers || []).inject(@errors){ |errors, t| errors + t.errors }
+      (@triggers || []).map(&:errors).inject(@errors, &:+)
+    end
+
+    def warnings
+      (@triggers || []).map(&:warnings).inject(@warnings, &:+)
     end
 
     private
@@ -289,10 +305,25 @@ module HairTrigger
         end
       end
       # only the top-most block actually executes
-      Array(generate).each{ |action| adapter.execute(action)} if options[:execute] && !@trigger_group
+      if !@trigger_group
+        validate_names!
+        if options[:execute]
+          Array(generate).each{ |action| adapter.execute(action)}
+        end
+      end
       self
     end
 
+    def validate_names!
+      subtriggers = all_triggers(false)
+      named_subtriggers = subtriggers.select{ |t| t.options[:name] }
+      if named_subtriggers.present? && !options[:name]
+        @warnings << ["nested triggers have explicit names, but trigger group does not. trigger name will be inferred", :mysql]
+      elsif subtriggers.present? && !named_subtriggers.present? && options[:name]
+        @warnings << ["trigger group has an explicit name, but nested triggers do not. trigger names will be inferred", :postgresql, :sqlite]
+      end
+    end
+
     def adapter_name
       @adapter_name ||= HairTrigger.adapter_name_for(adapter)
     end

data/lib/hair_trigger/migration_reader.rb

@@ -23,6 +23,7 @@ module HairTrigger
           # find the block of the up method
           sexps = sexps.last if sexps.last.is_a?(Sexp) && sexps.last[0] == :block
           sexps = sexps.detect{ |s| s.is_a?(Sexp) && (s[0] == :defs && s[1] && s[1][0] == :self && s[2] == :up || s[0] == :defn && s[1] == :up) }
+          return [] unless sexps # no `up` method... unsupported `change` perhaps?
           sexps.each do |sexp|
             next unless (method = extract_method_call(sexp)) && [:create_trigger, :drop_trigger].include?(method)
             trigger = instance_eval("generate_" + generator.process(sexp))
@@ -32,6 +33,7 @@ module HairTrigger
         triggers
       rescue
         $stderr.puts "Error reading triggers in #{source.filename rescue "schema.rb"}: #{$!}"
+        []
       end
 
       private
@@ -48,6 +50,7 @@ module HairTrigger
       def generate_create_trigger(*arguments)
         arguments.unshift({}) if arguments.empty?
         arguments.unshift(nil) if arguments.first.is_a?(Hash)
+        arguments.push({}) if arguments.size == 1
         arguments[1][:compatibility] ||= HairTrigger::Builder.base_compatibility
         ::HairTrigger::Builder.new(*arguments)
       end

data/lib/hair_trigger/schema_dumper.rb

@@ -1,8 +1,12 @@
 module HairTrigger
   module SchemaDumper
     def trailer_with_triggers(stream)
+      orig_show_warnings = Builder.show_warnings
+      Builder.show_warnings = false # we already show them when running the migration
       triggers(stream)
       trailer_without_triggers(stream)
+    ensure
+      Builder.show_warnings = orig_show_warnings
     end
 
     def triggers(stream)
@@ -84,4 +88,4 @@ module HairTrigger
       end
     end
   end
-end
+end

data/lib/hair_trigger/version.rb

@@ -1,5 +1,5 @@
 module HairTrigger
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 
   def VERSION.<=>(other)
     split(/\./).map(&:to_i) <=> other.split(/\./).map(&:to_i)

data/spec/builder_spec.rb

@@ -60,6 +60,19 @@ describe "builder" do
     end
   end
 
+  describe "groups" do
+    it "should allow chained methods" do
+      triggers = builder.on(:foos){ |t|
+        t.where('bar=1').name('bar'){ 'BAR;' }
+        t.where('baz=1').name('baz'){ 'BAZ;' }
+      }.triggers
+      triggers.map(&:prepare!)
+      triggers.map(&:prepared_name).should == ['bar', 'baz']
+      triggers.map(&:prepared_where).should == ['bar=1', 'baz=1']
+      triggers.map(&:prepared_actions).should == ['BAR;', 'BAZ;']
+    end
+  end
+
   context "adapter-specific actions" do
     before(:each) do
       @adapter = MockAdapter.new("mysql")
@@ -112,6 +125,15 @@ describe "builder" do
       }.should raise_error
     end
 
+    it "should warn on explicit subtrigger names and no group name" do
+      trigger = builder.on(:foos){ |t|
+        t.where('bar=1').name('bar'){ 'BAR;' }
+        t.where('baz=1').name('baz'){ 'BAZ;' }
+      }
+      trigger.warnings.size.should == 1
+      trigger.warnings.first.first.should =~ /nested triggers have explicit names/
+    end
+
     it "should accept security" do
       builder.on(:foos).after(:update).security(:definer){ "FOO" }.generate.
         grep(/DEFINER/).size.should eql(0) # default, so we don't include it
@@ -170,6 +192,15 @@ describe "builder" do
       trigger.generate.grep(/CREATE.*TRIGGER/).size.should eql(3)
     end
 
+    it "should warn on an explicit group names and no subtrigger names" do
+      trigger = builder.on(:foos).name('foos'){ |t|
+        t.where('bar=1'){ 'BAR;' }
+        t.where('baz=1'){ 'BAZ;' }
+      }
+      trigger.warnings.size.should == 1
+      trigger.warnings.first.first.should =~ /trigger group has an explicit name/
+    end
+
     it "should accept security" do
       builder.on(:foos).after(:update).security(:invoker){ "FOO" }.generate.
         grep(/SECURITY/).size.should eql(0) # default, so we don't include it
@@ -251,6 +282,15 @@ describe "builder" do
       trigger.generate.grep(/CREATE.*TRIGGER/).size.should eql(3)
     end
 
+    it "should warn on an explicit group names and no subtrigger names" do
+      trigger = builder.on(:foos).name('foos'){ |t|
+        t.where('bar=1'){ 'BAR;' }
+        t.where('baz=1'){ 'BAZ;' }
+      }
+      trigger.warnings.size.should == 1
+      trigger.warnings.first.first.should =~ /trigger group has an explicit name/
+    end
+
     it "should reject security" do
       lambda {
         builder.on(:foos).after(:update).security(:definer){ "FOO" }.generate

data/spec/migrations_spec.rb

@@ -6,9 +6,9 @@ require 'spec_helper'
 
 describe "migrations" do
   include_context "hairtrigger utils"
+  let(:adapter) { :sqlite3 }
 
   describe "migrations_current?" do
-    let(:adapter) { :sqlite3 }
 
     it "should return false if there are pending model triggers" do
       reset_tmp(:migration_glob => "*initial_tables*")
@@ -37,4 +37,24 @@ describe "migrations" do
       HairTrigger.should be_migrations_current
     end
   end
+
+  describe "current_triggers" do
+    it "should be inferred from self.up methods" do
+      reset_tmp(:migration_glob => "20110331212*")
+      initialize_db
+
+      migrations = HairTrigger.current_migrations
+      migrations.size.should == 1
+      migrations[0][1].prepared_name.should == "users_after_insert_row_when_new_name_bob__tr"
+    end
+
+    it "should not be inferred from change methods" do
+      reset_tmp(:migration_glob => "*manual*")
+      replace_file_contents("tmp/migrations/20110417185102_manual_user_trigger.rb", "def up", "def change")
+      initialize_db
+
+      migrations = HairTrigger.current_migrations
+      migrations.size.should == 0
+    end
+  end
 end

metadata

@@ -1,172 +1,167 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hairtrigger
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.7
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 6
-  version: 0.2.6
 platform: ruby
-authors: 
+authors:
 - Jon Jensen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-03-25 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ruby_parser
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 3
-        - 5
-        version: "3.5"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.5'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: ruby2ruby
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: ruby2ruby
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        - 6
+      - !ruby/object:Gem::Version
         version: 2.0.6
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 2
-        - 12
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.12.0
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: mysql
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: mysql
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 41
-        segments: 
-        - 2
-        - 9
-        - 1
+      - !ruby/object:Gem::Version
         version: 2.9.1
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: mysql2
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 3
-        - 11
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.3.11
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: pg
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 33
-        segments: 
-        - 0
-        - 15
-        - 1
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.11
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.15.1
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 3
-        - 7
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.3.7
   type: :development
-  version_requirements: *id009
-description: allows you to declare database triggers in ruby in your models, and then generate appropriate migrations as they change
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+description: allows you to declare database triggers in ruby in your models, and then
+  generate appropriate migrations as they change
 email: jenseng@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - LICENSE.txt
 - Rakefile
 - README.md
@@ -193,43 +188,30 @@ files:
 - spec/models/user.rb
 - spec/schema_dumper_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/jenseng/hair_trigger
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 17
-      segments: 
-      - 1
-      - 3
-      - 5
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: easy database triggers for active record
 test_files: []
-
+has_rdoc: