rails_sql_triggers 0.0.1

data/CHANGELOG

@@ -0,0 +1,18 @@
+0.1.0 - Released Dec 27, 2006
+ * Initial release
+
+0.5.0 - Released Dec 29, 2006
+ * Added support for PostgreSQL (Michael Schuerig)
+ * Fixed the schema dumper
+ 
+0.5.1 - Released Jan 10, 2007
+ * Patch by Clifford T. Matthews to use String.dump to dump out the view select statement
+ 
+0.6.0 - Released May 9, 2007
+ * Added support for SQL Server (Seth Ladd)-
+ * Added support for using views to map non-friendly database field names to AR-friendly names (Nathan Vack)
+ * Added support for Oracle (Alistair Davidson)
+
+0.6.1 - Released June 6, 2007
+ * Added test for union support
+ * Updated tests to include new table to support union test

data/README

@@ -0,0 +1,72 @@
+== Rails SQL Triggers
+
+Library which adds SQL Triggers to Rails. Adds create_trigger and drop_trigger to the ActiveRecord::ConnectionAdapters::AbstractAdapter (which makes them available to migrations) and adds support for dumping triggers in the ActiveRecord::SchemaDumper.
+
+== Installation
+
+To install:
+
+  gem install rails_sql_triggers
+ 
+Then add the following to your Rails config/environment.rb:
+
+  require_gem 'rails_sql_triggers'
+  require 'rails_sql_triggers'
+
+== Usage
+
+You can then use create_trigger and drop_trigger in your migrations. For example:
+
+  class CreatePersonChangeTrigger < ActiveRecord::Migration
+    def self.up
+      create_table :person_changes do |t|
+        t.integer :person_id, :null => false
+        t.string :first_name, :null => false
+        t.string :last_name, :null => false
+        t.string :email, :null => false
+        t.datetime :effective_start
+        t.datetime :effective_end
+        t.integer :deleted_flag, :null => false, :default => 0
+        t.string :updated_by
+      end
+
+      create_trigger :person_change_trig, :people, [:insert, :update], <<EOSQL
+DECLARE @person_id INT
+DECLARE @first_name VARCHAR(255)
+DECLARE @last_name VARCHAR(255)
+DECLARE @email VARCHAR(255)
+DECLARE @effective_start DATETIME
+DECLARE @updated_by VARCHAR(255)
+SELECT @person_id = (SELECT id FROM inserted)
+SELECT @first_name = (SELECT first_name FROM inserted)
+SELECT @last_name = (SELECT last_name FROM inserted)
+SELECT @email = (SELECT email FROM inserted)
+SELECT @effective_start = (SELECT updated_at FROM inserted)
+SELECT @updated_by = (SELECT updated_by FROM inserted)
+UPDATE person_changes SET effective_end = @effective_start
+  WHERE person_id = @person_id AND effective_end IS NULL
+INSERT INTO person_changes (person_id, first_name, last_name, email, effective_start, updated_by) 
+  VALUES (@person_id, @first_name, @last_name, @email, @effective_start, @updated_by)
+EOSQL
+    end
+
+    def self.down
+      drop_trigger :person_change_trig
+    end
+  end
+  
+This extension also adds support for triggers in the ActiveRecord::SchemaDumper class.
+
+The following drivers are supported:
+
+ SQL Server
+
+== Known Issues
+
+* Drivers not mentioned above are not supported.
+
+If you find any issues please send an email to stewbawka@gmail.com .
+
+== Contributing
+
+If you would like to implement trigger support for other adapters then please drop me an email. Better yet, write up the adapter modifications and send them to me. :-)

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "rails_sql_triggers"
+    gemspec.summary = "sql triggers in migrations"
+    gemspec.description = "Provide create_trigger and drop_trigger in migrations. Also extends SchemaDumper to clue in about triggers"
+    gemspec.email = "stewbawka@gmail.com"
+    gemspec.homepage = "http://blog.stewbawka.com""
+    gemspec.authors = ["Stuart Wade"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end

data/lib/core_ext/module.rb

@@ -0,0 +1,11 @@
+# This is required for 1.1.6 support
+class Module
+  def alias_method_chain(target, feature)
+    # Strip out punctuation on predicates or bang methods since
+    # e.g. target?_without_feature is not a valid method name.
+    aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+    yield(aliased_target, punctuation) if block_given?
+    alias_method "#{aliased_target}_without_#{feature}#{punctuation}", target
+    alias_method target, "#{aliased_target}_with_#{feature}#{punctuation}"
+  end
+end

data/lib/rails_sql_triggers/connection_adapters/abstract/schema_definitions.rb

@@ -0,0 +1,16 @@
+module RailsSqlTriggers
+  module ConnectionAdapters #:nodoc:
+    # Abstract definition of a View
+    class TriggerDefinition
+      attr_accessor :name, :target, :events, :sql
+      
+      def initialize(base, name, target, events, sql)
+        @base = base
+        @name = name
+        @target = target
+        @events = events
+        @sql = sql
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module RailsSqlriggers
+  module ConnectionAdapters # :nodoc:
+    module SchemaStatements
+      # Create a trigger.
+      def create_trigger(name, target, events, sql, options={})
+        if supports_triggers?
+          trigger_definition = TriggerDefinition.new(self, name, target, events, sql)
+
+          if options[:force]
+            drop_trigger(name) rescue nil
+          end
+
+          create_sql = "CREATE TRIGGER "
+          create_sql << "#{name} ON #{target} AFTER #{(events*', ').upcase} AS"
+          create_sql << trigger_definition.sql
+          execute create_sql
+        end
+      end
+
+      # Drop a trigger.
+      def drop_trigger(name, options={})
+        if supports_triggers?
+          drop_sql = "DROP TRIGGER #{name}"
+          execute drop_sql
+        end
+      end
+    end
+  end
+end

data/lib/rails_sql_triggers/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,20 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class AbstractAdapter
+      # Subclasses should override and return true if they support triggers.
+      def supports_triggers?
+        return false
+      end
+      
+      # Get a list of all triggers for the current database
+      def triggers(name = nil)
+        raise NotImplementedError, "triggers is an abstract method"
+      end
+      
+      # Get the select statement for the specified trigger
+      def trigger_select_statement(trigger, name=nil)
+        raise NotImplementedError, "trigger_select_statement is an abstract method"
+      end
+    end
+  end
+end

data/lib/rails_sql_triggers/connection_adapters/mysql_adapter.rb

@@ -0,0 +1,35 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class MysqlAdapter
+      # Returns true as this adapter supports views.
+      def supports_views?
+        true
+      end
+      
+      def tables(name = nil) #:nodoc:
+        tables = []
+        execute("SHOW TABLE STATUS", name).each { |row| tables << row[0] if row[17] != 'VIEW' }
+        tables
+      end
+      
+      def views(name = nil) #:nodoc:
+        views = []
+        execute("SHOW TABLE STATUS", name).each { |row| views << row[0] if row[17] == 'VIEW' }
+        views
+      end
+      
+      # Get the view select statement for the specified table.
+      def view_select_statement(view, name=nil)
+        row = execute("SHOW CREATE VIEW #{view}", name).each do |row|
+          return convert_statement(row[1]) if row[0] == view
+        end
+        raise "No view called #{view} found"
+      end
+      
+      private
+      def convert_statement(s)
+        s.gsub!(/.* AS (select .*)/, '\1')
+      end
+    end
+  end
+end

data/lib/rails_sql_triggers/connection_adapters/oci_adapter.rb

@@ -0,0 +1,32 @@
+module ActiveRecord
+ module ConnectionAdapters
+   class OciAdapter
+     # Returns true as this adapter supports views.
+     def supports_views?
+       true
+     end
+
+     def tables(name = nil) #:nodoc:
+       tables = []
+       execute("SELECT TABLE_NAME FROM USER_TABLES", name).each { |row| tables << row[0]  }
+       tables
+     end
+
+     def views(name = nil) #:nodoc:
+       views = []
+       execute("SELECT VIEW_NAME FROM USER_VIEWS", name).each { |row| views << row[0] }
+       views
+     end
+
+     # Get the view select statement for the specified table.
+     def view_select_statement(view, name=nil)
+       row = execute("SELECT TEXT FROM USER_VIEWS WHERE VIEW_NAME = '#{view}'", name).each do |row|
+         return row[0]
+       end
+       raise "No view called #{view} found"
+     end
+
+
+   end
+ end
+end

data/lib/rails_sql_triggers/connection_adapters/oracle_adapter.rb

@@ -0,0 +1,32 @@
+module ActiveRecord
+ module ConnectionAdapters
+   class OracleAdapter
+     # Returns true as this adapter supports views.
+     def supports_views?
+       true
+     end
+
+     def tables(name = nil) #:nodoc:
+       tables = []
+       execute("SELECT TABLE_NAME FROM USER_TABLES", name).each { |row| tables << row[0]  }
+       tables
+     end
+
+     def views(name = nil) #:nodoc:
+       views = []
+       execute("SELECT VIEW_NAME FROM USER_VIEWS", name).each { |row| views << row[0] }
+       views
+     end
+
+     # Get the view select statement for the specified table.
+     def view_select_statement(view, name=nil)
+       row = execute("SELECT TEXT FROM USER_VIEWS WHERE VIEW_NAME = '#{view}'", name).each do |row|
+         return row[0]
+       end
+       raise "No view called #{view} found"
+     end
+
+
+   end
+ end
+end

data/lib/rails_sql_triggers/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,39 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter
+      # Returns true as this adapter supports views.
+      def supports_views?
+        true
+      end
+      
+      def views(name = nil) #:nodoc:
+        q = <<-SQL
+        SELECT table_name, table_type
+          FROM information_schema.tables
+         WHERE table_schema IN (#{schemas})
+           AND table_type = 'VIEW'
+        SQL
+        
+        query(q, name).map { |row| row[0] }
+      end
+
+      def view_select_statement(view, name = nil)
+        q = <<-SQL
+        SELECT view_definition
+          FROM information_schema.views 
+         WHERE table_catalog = (SELECT catalog_name FROM information_schema.information_schema_catalog_name)
+           AND table_schema IN (#{schemas})
+           AND table_name = '#{view}'
+        SQL
+        
+        select_value(q, name) or raise "No view called #{view} found"
+      end
+
+      private
+        
+      def schemas
+        schema_search_path.split(/,/).map { |p| quote(p) }.join(',')
+      end
+    end
+  end
+end

data/lib/rails_sql_triggers/connection_adapters/sqlserver_adapter.rb

@@ -0,0 +1,48 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class SQLServerAdapter
+      # Returns true as this adapter supports views.
+      def supports_triggers?
+        true
+      end
+      
+      # Returns all the trigger names from the currently connected schema.
+      def triggers(name = nil)
+        select_values("SELECT name FROM sys.triggers", name)
+      end
+
+      def trigger_sp_helptext(trigger, name=nil)
+       q =<<-ENDSQL
+          EXEC sp_helptext '#{trigger}'
+        ENDSQL
+ 
+        trigger_def = select_values(q, name).join
+ 
+       if !trigger_def.blank?
+          return trigger_def
+        else
+          raise "No trigger called #{trigger} found"
+        end
+ 
+      end
+
+      def trigger_target(trigger, name=nil)
+        trigger_def = trigger_sp_helptext(trigger, name)
+        trigger =~ /^CREATE.* ON (.*) AFTER /, '')
+        $1       
+      end 
+
+      def trigger_events(trigger, name=nil)
+        trigger_def = trigger_sp_helptext(trigger, name)
+        trigger =~ /^CREATE.* AFTER (.*) AS /, '')
+        $1.split(', ').collect {|t| t.downcase.to_sym}       
+      end 
+ 
+      def trigger_code(trigger, name=nil)
+        trigger_def = trigger_sp_helptext(trigger, name)
+        trigger.sub(/^CREATE.* AS /, '')       
+      end 
+     
+    end
+  end
+end

data/lib/rails_sql_triggers/schema_dumper.rb

@@ -0,0 +1,65 @@
+module ActiveRecord
+  class SchemaDumper
+    
+    # A list of triggers which should not be dumped to the schema. 
+    # Acceptable values are strings as well as regexp.
+    # This setting is only used if ActiveRecord::Base.schema_format == :ruby
+    cattr_accessor :ignore_triggers 
+    @@ignore_triggers = []
+    
+    def trailer_with_triggers(stream)
+      # do nothing...we'll call this later
+    end
+    alias_method_chain :trailer, :triggers
+    
+    # Add triggers to the end of the dump stream
+    def dump_with_triggers(stream)
+      dump_without_triggers(stream)
+      begin
+        if @connection.supports_triggers?
+          triggers(stream)
+        end
+      rescue => e
+        ActiveRecord::Base.logger.error "Unable to dump triggers: #{e}"
+      end
+      trailer_without_triggers(stream)
+      stream
+    end
+    alias_method_chain :dump, :triggers
+    
+    # Add triggers to the stream
+    def triggers(stream)
+      @connection.triggers.sort.each do |t|
+        next if ["schema_info", ignore_triggers].flatten.any? do |ignored|
+          case ignored
+          when String: t == ignored
+          when Regexp: t =~ ignored
+          else
+            raise StandardError, 'ActiveRecord::SchemaDumper.ignore_views accepts an array of String and / or Regexp values.'
+          end
+        end 
+        trigger(t, stream)
+      end
+    end
+    
+    # Add the specified trigger to the stream
+    def trigger(trigger, stream)
+      begin
+        t = StringIO.new
+        t.print "  create_trigger #{trigger.to_sym.inspect}"
+        t.print ", #{@connection.trigger_target(trigger)}" 
+        t.print ", #{@connection.trigger_events(trigger).inspect}"
+        t.print ", #{@connection.trigger_code(trigger)}"
+        t.print ", :force => true"
+        t.rewind
+        stream.print t.read
+      rescue => e
+        stream.puts "# Could not dump trigger #{trigger.inspect} because of following #{e.class}"
+        stream.puts "#   #{e.message}"
+        stream.puts
+      end
+      
+      stream
+    end
+  end
+end

data/lib/rails_sql_triggers/version.rb

@@ -0,0 +1,9 @@
+module RailsSqlTriggers
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/rails_sql_triggers.rb

@@ -0,0 +1,52 @@
+#--
+# Copyright (c) 2006 Anthony Eden
+#
+# 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.
+#++
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+  
+require 'rubygems'
+unless Kernel.respond_to?(:gem)
+  Kernel.send :alias_method, :gem, :require_gem
+end
+  
+unless defined?(ActiveRecord)
+  begin
+    $:.unshift(File.dirname(__FILE__) + "/../../activerecord/lib")
+    require 'active_record'
+  rescue LoadError
+    gem 'activerecord'
+  end
+end
+
+require 'core_ext/module'
+
+require 'rails_sql_triggers/connection_adapters/abstract/schema_definitions'
+require 'rails_sql_triggers/connection_adapters/abstract/schema_statements'
+#require 'rails_sql_triggers/connection_adapters/mysql_adapter'
+#require 'rails_sql_triggers/connection_adapters/postgresql_adapter'
+require 'rails_sql_triggers/connection_adapters/sqlserver_adapter'
+require 'rails_sql_triggers/schema_dumper'
+
+class ActiveRecord::ConnectionAdapters::AbstractAdapter
+  include RailsSqlTriggers::ConnectionAdapters::SchemaStatements
+end

data/rails_sql_triggers.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = "rails_sql_triggers"
+  s.version     = "0.0.1"
+  s.author      = "Stuart Wade"
+  s.email       = "stewbawka@gmail.com"
+  s.homepage    = "http://blog.stewbawka.com"
+  s.summary = "sql triggers in migrations"
+  s.description = "Provide create_trigger and drop_trigger in migrations. Also extends SchemaDumper to clue in about triggers"
+  s.files        = Dir["{lib,test}/**/*"] + Dir["[A-Z]*"]
+  s.require_path = "lib"
+  
+  s.rubyforge_project = s.name
+  s.required_rubygems_version = ">= 1.3.4"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: rails_sql_triggers
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stuart Wade
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-04 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Provide create_trigger and drop_trigger in migrations. Also extends SchemaDumper to clue in about triggers
+email: stewbawka@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/core_ext/module.rb
+- lib/rails_sql_triggers/connection_adapters/abstract/schema_definitions.rb
+- lib/rails_sql_triggers/connection_adapters/abstract/schema_statements.rb
+- lib/rails_sql_triggers/connection_adapters/abstract_adapter.rb
+- lib/rails_sql_triggers/connection_adapters/mysql_adapter.rb
+- lib/rails_sql_triggers/connection_adapters/oci_adapter.rb
+- lib/rails_sql_triggers/connection_adapters/oracle_adapter.rb
+- lib/rails_sql_triggers/connection_adapters/postgresql_adapter.rb
+- lib/rails_sql_triggers/connection_adapters/sqlserver_adapter.rb
+- lib/rails_sql_triggers/schema_dumper.rb
+- lib/rails_sql_triggers/version.rb
+- lib/rails_sql_triggers.rb
+- CHANGELOG
+- rails_sql_triggers.gemspec
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://blog.stewbawka.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: rails_sql_triggers
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: sql triggers in migrations
+test_files: []
+