hairtrigger 0.1.3 → 0.1.4

data/README.rdoc

@@ -62,7 +62,7 @@ declarations and any auto-generated triggers from previous migrations.
 You can also manage triggers manually in your migrations via create_trigger and
 drop_trigger. They are a little more verbose than model triggers, and they can
 be more work since you need to figure out the up/down create/drop logic when
-you change things. An sample trigger:
+you change things. A sample trigger:
 
  create_trigger.on(:users).after(:insert) do
    "UPDATE accounts SET user_count = user_count + 1 WHERE id = NEW.account_id;"
@@ -154,15 +154,16 @@ when you attempt to run the migration.
 
 Generation warnings are similar but they don't stop the trigger from being
 generated. If you do something adapter-specific supported by your database,
-you will still get a warning that your trigger is not portable. You can
-silence warnings via "HairTrigger::Builder.show_warnings = false"
+you will still get a warning ($stderr) that your trigger is not portable. You
+can silence warnings via "HairTrigger::Builder.show_warnings = false"
 
 You can validate your triggers beforehand using the Builder#validate! method.
-It will throw the approriate errors/warnings so that you know what to fix, e.g.
+It will throw the appropriate errors/warnings so that you know what to fix,
+e.g.
 
  > User.triggers.each(&:validate!)
 
-HairTrigger does not validate your SQL, so be sure to test it in all database
+HairTrigger does not validate your SQL, so be sure to test it in all databases
 you want to support.
 
 == Gotchas, Known Issues

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/hair_trigger/base.rb

@@ -7,6 +7,7 @@ module HairTrigger
         options = name
         name = nil
       end
+      options[:compatibility] ||= ::HairTrigger::Builder::compatibility
       @triggers ||= []
       trigger = ::HairTrigger::Builder.new(name, options)
       @triggers << trigger

data/lib/hair_trigger/builder.rb

@@ -9,6 +9,7 @@ module HairTrigger
 
     def initialize(name = nil, options = {})
       @adapter = options[:adapter]
+      @compatibility = options.delete(:compatibility) || self.class.compatibility
       @options = {}
       @chained_calls = []
       @errors = []
@@ -194,7 +195,7 @@ module HairTrigger
           str << actions_to_ruby("#{indent}  ") + "\n"
           str << "#{indent}end"
         else
-          str = "#{indent}create_trigger(#{prepared_name.inspect}, :generated => true).\n" +
+          str = "#{indent}create_trigger(#{prepared_name.inspect}, :generated => true, :compatibility => #{@compatibility}).\n" +
           "#{indent}    " + chained_calls_to_ruby(".\n#{indent}    ")
           if @triggers
             str << " do |t|\n"
@@ -220,7 +221,7 @@ module HairTrigger
 
     def hash
       prepare!
-      [self.options.hash, self.prepared_actions.hash, self.prepared_where.hash, self.triggers.hash].hash
+      [self.options.hash, self.prepared_actions.hash, self.prepared_where.hash, self.triggers.hash, @compatibility].hash
     end
 
     def errors
@@ -261,6 +262,7 @@ module HairTrigger
         raise DeclarationError, "trigger group did not define any triggers" if @triggers.empty?
       else
         @actions = block.call
+        @actions.sub!(/(\s*)\z/, ';\1') if @actions && !(@actions =~ /;\s*\z/)
       end
       # only the top-most block actually executes
       Array(generate).each{ |action| adapter.execute(action)} if options[:execute] && !@trigger_group
@@ -307,7 +309,7 @@ END;
     end
 
     def generate_trigger_postgresql
-      raise GenerationError, "truncate triggers are only supported on postgres 8.4 and greater" if version < 80400 && options[:events].include?('TRUNCATE')
+      raise GenerationError, "truncate triggers are only supported on postgres 8.4 and greater" if db_version < 80400 && options[:events].include?('TRUNCATE')
       raise GenerationError, "FOR EACH ROW triggers may not be triggered by truncate events" if options[:for_each] == 'ROW' && options[:events].include?('TRUNCATE')
       security = options[:security] if options[:security] && options[:security] != :invoker
       sql = <<-SQL
@@ -315,18 +317,28 @@ CREATE FUNCTION #{prepared_name}()
 RETURNS TRIGGER AS $$
 BEGIN
       SQL
-      if prepared_where && version < 90000
+      if prepared_where && db_version < 90000
         sql << normalize("IF #{prepared_where} THEN", 1)
         sql << normalize(prepared_actions, 2)
         sql << normalize("END IF;", 1)
       else
         sql << normalize(prepared_actions, 1)
       end
+      # if no return is specified at the end, be sure we set a sane one
+      unless prepared_actions =~ /return [^;]+;\s*\z/i
+        if options[:timing] == "AFTER" || options[:for_each] == 'STATEMENT'
+          sql << normalize("RETURN NULL;", 1)
+        elsif options[:events].include?('DELETE')
+          sql << normalize("RETURN OLD;", 1)
+        else
+          sql << normalize("RETURN NEW;", 1)
+        end
+      end
       sql << <<-SQL
 END;
 $$ LANGUAGE plpgsql#{security ? " SECURITY #{security.to_s.upcase}" : ""};
 CREATE TRIGGER #{prepared_name} #{options[:timing]} #{options[:events].join(" OR ")} ON #{options[:table]}
-FOR EACH #{options[:for_each]}#{prepared_where && version >= 90000 ? " WHEN (" + prepared_where + ')': ''} EXECUTE PROCEDURE #{prepared_name}();
+FOR EACH #{options[:for_each]}#{prepared_where && db_version >= 90000 ? " WHEN (" + prepared_where + ')': ''} EXECUTE PROCEDURE #{prepared_name}();
       SQL
     end
 
@@ -349,8 +361,8 @@ BEGIN
       sql << "END\n";
     end
 
-    def version
-      @version ||= case adapter_name
+    def db_version
+      @db_version ||= case adapter_name
         when :postgresql
           adapter.send(:postgresql_version)
       end
@@ -375,13 +387,38 @@ BEGIN
     class << self
       attr_writer :tab_spacing
       attr_writer :show_warnings
+
       def tab_spacing
         @tab_spacing ||= 4
       end
+
       def show_warnings
         @show_warnings = true if @show_warnings.nil?
         @show_warnings
       end
+
+      def compatibility
+        @compatibility ||= begin
+          gem_version = (File.read(File.dirname(__FILE__) + '/../../VERSION').chomp rescue '0.1.3').split(/\./).map(&:to_i)
+          gem_version.instance_eval(<<-METHODS)
+            def <=>(other)
+              [size, other.size].max.times do |i|
+                c = self[i].to_i <=> other[i].to_i
+                return c unless c == 0
+              end
+              0
+            end
+            extend Comparable
+          METHODS
+          if gem_version <= [0, 1, 3]
+            0 # initial releases
+          else
+            1 # postgres RETURN bugfix
+          # TODO: add more as we implement things that change the generated
+          # triggers (e.g. chained call merging)
+          end
+        end
+      end
     end
   end
 end

data/lib/hair_trigger/migration.rb

@@ -4,13 +4,14 @@ module HairTrigger
 
     def method_missing_with_trigger_building(method, *arguments, &block)
       if extract_trigger_builders
-        if method.to_sym == :create_trigger
+        if method.to_sym == :create_trigger && arguments[1].delete(:generated)
           arguments.unshift(nil) if arguments.first.is_a?(Hash)
-          trigger = ::HairTrigger::Builder.new(*arguments) if arguments[1].delete(:generated)
+          arguments[1][:compatibility] ||= 0
+          trigger = ::HairTrigger::Builder.new(*arguments)
           (@trigger_builders ||= []) << trigger
           trigger
-        elsif method.to_sym == :drop_trigger
-          trigger = ::HairTrigger::Builder.new(arguments[0], {:table => arguments[1], :drop => true}) if arguments[2] && arguments[2].delete(:generated)
+        elsif method.to_sym == :drop_trigger && arguments[2] && arguments[2].delete(:generated)
+          trigger = ::HairTrigger::Builder.new(arguments[0], {:table => arguments[1], :drop => true})
           (@trigger_builders ||= []) << trigger
           trigger
         end

data/lib/tasks/hair_trigger.rake

@@ -61,11 +61,11 @@ namespace :db do
 
 class #{migration_name} < ActiveRecord::Migration
   def self.up
-    #{(up_drop_triggers + up_create_triggers).map{ |t| t.to_ruby('    ') }.join("\n").lstrip}
+    #{(up_drop_triggers + up_create_triggers).map{ |t| t.to_ruby('    ') }.join("\n\n").lstrip}
   end
 
   def self.down
-    #{(down_drop_triggers + down_create_triggers).map{ |t| t.to_ruby('    ') }.join("\n").lstrip}
+    #{(down_drop_triggers + down_create_triggers).map{ |t| t.to_ruby('    ') }.join("\n\n").lstrip}
   end
 end
       MIGRATION

data/spec/builder_spec.rb

@@ -25,6 +25,20 @@ describe "builder" do
     end
   end
 
+  context "comparison" do
+    it "should view identical triggers as identical" do
+      @adapter = MockAdapter.new("mysql")
+      builder.on(:foos).after(:update){ "FOO" }.
+      should eql(builder.on(:foos).after(:update){ "FOO" })
+    end
+
+    it "should view incompatible triggers as different" do
+      @adapter = MockAdapter.new("mysql")
+      HairTrigger::Builder.new(nil, :adapter => @adapter, :compatibility => 0).on(:foos).after(:update){ "FOO" }.
+      should_not eql(builder.on(:foos).after(:update){ "FOO" })
+    end
+  end
+
   context "mysql" do
     before(:each) do
       @adapter = MockAdapter.new("mysql")
@@ -137,6 +151,11 @@ describe "builder" do
       }.should raise_error
     end
 
+    it "should add a return statement if none is provided" do
+      builder.on(:foos).after(:update){ "FOO" }.generate.
+      grep(/RETURN NULL;/).size.should eql(1)
+    end
+
     context "legacy" do
       it "should reject truncate pre-8.4" do
         @adapter = MockAdapter.new("postgresql", :postgresql_version => 80300)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hairtrigger
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Jon Jensen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 -06:00
+date: 2011-03-25 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency