pg_saurus 2.3.1 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e759d3f6f18831227c70d8d5609d0545053a3ec
-  data.tar.gz: 6bacd12ec585be568ad2863c9cc7dedb112b97fd
+  metadata.gz: c7a1e92934deea6ba975df2c5794d6cbbe018095
+  data.tar.gz: 897243ea0241e00197b1bae4085d1401530e0fcc
 SHA512:
-  metadata.gz: 66c2279cce0676edd0084721a66ef4faf325df16e43e77649b9cc0bf95bf6a41af41f43c645d14d711656ed1159c9ff80dec6e95b7ec450ee5f97fb257e3c910
-  data.tar.gz: 8d33063a06e25aaf16868674bee9c2c9811237ac82d2519c78cccdbdc45837027aba1fb18376ed495a3f460a23608b3eb0257944ec28cc1e95f03a59eec87f6f
+  metadata.gz: fc76e020d12815030f5fcea206bb639c70a3f97c16e8deeb75acbcc6dca011b5d299f8c1027e7265c35dd9a8bfb4ed2aa6474d6dedbd603a6e61483c1a6ce0d9
+  data.tar.gz: f255fb8349f53b7f7888486b841b8dcda64720032d3f27e010270f45903511430313ed37e0c054eba12224e5769dbf357ee50332a30f61e35470bf28835013ac

data/README.markdown

@@ -2,8 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/HornsAndHooves/pg_saurus.png)](http://travis-ci.org/HornsAndHooves/pg_saurus)
 [![Dependency Status](https://gemnasium.com/HornsAndHooves/pg_saurus.png)](https://gemnasium.com/HornsAndHooves/pg_saurus)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/HornsAndHooves/pg_saurus)
-
+[![Code Climate](https://codeclimate.com/github/HornsAndHooves/pg_saurus/badges/gpa.svg)](https://codeclimate.com/github/HornsAndHooves/pg_saurus)
 ActiveRecord extension to get more from PostgreSQL:
 
 * Create/drop schemas.
@@ -11,6 +10,8 @@ ActiveRecord extension to get more from PostgreSQL:
 * Use foreign keys.
 * Use partial indexes.
 * Run index creation concurrently.
+* Create/drop functions.
+* Create/drop triggers.
 
 PgSaurus is a fork of PgPower.
 
@@ -317,6 +318,7 @@ You can create, list, and drop functions.
 ### Examples
 
 ```ruby
+# Create a function
 pets_not_empty_function = <<-SQL
 BEGIN
   IF (SELECT COUNT(*) FROM pets) > 0
@@ -327,13 +329,39 @@ BEGIN
   END IF;
 END;
 SQL
-
+# Arguments are: function_name, return_type, function_definition, options (currently, only :schema)
 create_function 'pets_not_empty()', :boolean, pets_not_empty_function, schema: 'public'
-functions.any?{ |function| function.name == 'public.pets_not_empty()' }
-# => true
+
+# Drop a function
 drop_function 'pets_not_empty()'
-functions.any?{ |function| function.name == 'public.pets_not_empty()' }
-# => false
+
+# Get a list of defined functions
+ActiveRecord::Base.connection.functions
+```
+
+## Triggers
+
+You can create and remove triggers on tables and views.
+
+### Examples
+
+```ruby
+# Create a trigger
+create_trigger :pets,                           # Table or view name
+               :pets_not_empty_trigger_proc,    # Procedure name. Parentheses are optional if you have no arguments.
+               'AFTER INSERT',                  # Trigger event
+               for_each: 'ROW',                 # Can be row or statement. Default is row.
+               schema: 'public',                # Optional schema name
+               constraint: true,                # Sets if the trigger is a constraint. Default is false.
+               deferrable: true,                # Sets if the trigger is immediate or deferrable. Default is immediate.
+               initially_deferred: true,        # Sets if the trigger is initially deferred. Default is immediate. Only relevant if the trigger is deferrable.
+               condition: "new.name = 'fluffy'" # Optional when condition. Default is none.
+
+# Drop a trigger
+remove_trigger :pets, :pets_not_empty_trigger_proc
+
+# Get a list of defined triggers on a table or view
+ActiveRecord::Base.connection.triggers
 ```
 
 ## Tools
@@ -376,6 +404,10 @@ PgSaurus does not support Rails 3.
 
 ## TODO:
 
+Support for Rails 4.2+
+
+* This will likely necessitate a major rewrite.
+
 Support for JRuby:
 
 * Jdbc driver provides its own `create_schema(schema, user)` method - solve conflicts.

data/lib/pg_saurus/connection_adapters.rb

@@ -2,9 +2,10 @@ module PgSaurus::ConnectionAdapters # :nodoc:
   extend ActiveSupport::Autoload
 
   autoload :AbstractAdapter
-  autoload :PostgreSQLAdapter, 'pg_saurus/connection_adapters/postgresql_adapter'
+  autoload :PostgreSQLAdapter,  'pg_saurus/connection_adapters/postgresql_adapter'
   autoload :Table
   autoload :ForeignKeyDefinition
-  autoload :IndexDefinition, 'pg_saurus/connection_adapters/index_definition'
+  autoload :IndexDefinition,    'pg_saurus/connection_adapters/index_definition'
   autoload :FunctionDefinition, 'pg_saurus/connection_adapters/function_definition'
+  autoload :TriggerDefinition,  'pg_saurus/connection_adapters/trigger_definition'
 end

data/lib/pg_saurus/connection_adapters/abstract_adapter.rb

@@ -8,12 +8,14 @@ module PgSaurus::ConnectionAdapters::AbstractAdapter
   autoload :SchemaMethods
   autoload :IndexMethods
   autoload :FunctionMethods
+  autoload :TriggerMethods
 
   include CommentMethods
   include ForeignerMethods
   include SchemaMethods
   include IndexMethods
   include FunctionMethods
+  include TriggerMethods
 
   included do
     alias_method_chain :create_table, :schema_option

data/lib/pg_saurus/connection_adapters/abstract_adapter/function_methods.rb

@@ -7,11 +7,33 @@ module PgSaurus::ConnectionAdapters::AbstractAdapter::FunctionMethods
   end
 
   # Create a database function.
+  #
+  # Example:
+  #
+  #   # Arguments are: function_name, return_type, function_definition, options (currently, only :schema)
+  #   create_function 'pets_not_empty()', :boolean, <<-FUNCTION, schema: 'public'
+  #     BEGIN
+  #       IF (SELECT COUNT(*) FROM pets) > 0
+  #       THEN
+  #       RETURN true;
+  #       ELSE
+  #       RETURN false;
+  #      END IF;
+  #       END;
+  #     FUNCTION
+  #
+  # The schema is optional.
   def create_function(function_name, returning, definition, options = {})
 
   end
 
   # Delete the database function.
+  #
+  # Example:
+  #
+  #   drop_function 'pets_not_empty()', schema: 'public'
+  #
+  # The schema is optional.
   def drop_function(function_name, options)
 
   end

data/lib/pg_saurus/connection_adapters/abstract_adapter/trigger_methods.rb

@@ -0,0 +1,42 @@
+# Adapter definitions for db functions
+module PgSaurus::ConnectionAdapters::AbstractAdapter::TriggerMethods
+
+  # :nodoc
+  def supports_triggers?
+    false
+  end
+
+  # Returns the listing of currently defined db triggers
+  def triggers
+
+  end
+
+  # Creates a trigger.
+  #
+  # Example:
+  #
+  #   create_trigger :pets,                           # Table or view name
+  #                  :pets_not_empty_trigger_proc,    # Procedure name. Parentheses are optional if you have no arguments.
+  #                  'AFTER INSERT',                  # Trigger event
+  #                  for_each: 'ROW',                 # Can be row or statement. Default is row.
+  #                  schema: 'public',                # Optional schema name
+  #                  constraint: true,                # Sets if the trigger is a constraint. Default is false.
+  #                  deferrable: true,                # Sets if the trigger is immediate or deferrable. Default is immediate.
+  #                  initially_deferred: true,        # Sets if the trigger is initially deferred. Default is immediate. Only relevant if the trigger is deferrable.
+  #                  condition: "new.name = 'fluffy'" # Optional when condition. Default is none.
+  #
+  def create_trigger(table_name, proc_name, event, options = {})
+
+  end
+
+  # Removes a trigger.
+  #
+  # Example:
+  #
+  #   remove_trigger :pets, :pets_not_empty_trigger_proc
+  #
+  def remove_trigger(table_name, proc_name, options = {})
+
+  end
+
+end

data/lib/pg_saurus/connection_adapters/postgresql_adapter.rb

@@ -13,6 +13,7 @@ module PgSaurus::ConnectionAdapters::PostgreSQLAdapter
   autoload :TranslateException, 'pg_saurus/connection_adapters/postgresql_adapter/translate_exception'
   autoload :ViewMethods,        'pg_saurus/connection_adapters/postgresql_adapter/view_methods'
   autoload :FunctionMethods,    'pg_saurus/connection_adapters/postgresql_adapter/function_methods'
+  autoload :TriggerMethods,     'pg_saurus/connection_adapters/postgresql_adapter/trigger_methods'
 
   include ExtensionMethods
   include SchemaMethods
@@ -22,6 +23,7 @@ module PgSaurus::ConnectionAdapters::PostgreSQLAdapter
   include TranslateException
   include ViewMethods
   include FunctionMethods
+  include TriggerMethods
 
   included do
     alias_method_chain :tables, :non_public_schema_tables

data/lib/pg_saurus/connection_adapters/postgresql_adapter/function_methods.rb

@@ -102,7 +102,7 @@ module PgSaurus::ConnectionAdapters::PostgreSQLAdapter::FunctionMethods
   # Write out the fully qualified function name if the :schema option is passed.
   def full_function_name(function_name, options)
     schema        = options[:schema]
-    function_name = "#{schema}.#{function_name}" if schema
+    function_name = %Q{"#{schema}".#{function_name}} if schema
     function_name
   end
   private :full_function_name

data/lib/pg_saurus/connection_adapters/postgresql_adapter/trigger_methods.rb

@@ -0,0 +1,139 @@
+# Provides methods to extend {ActiveRecord::ConnectionAdapters::PostgreSQLAdapter}
+# to support db triggers.
+module PgSaurus::ConnectionAdapters::PostgreSQLAdapter::TriggerMethods
+
+  # :nodoc
+  def supports_triggers?
+    true
+  end
+
+  # See lib/pg_saurus/connection_adapters/trigger_methods.rb
+  def create_trigger(table_name, proc_name, event, options = {})
+    proc_name = "#{proc_name}"
+    proc_name = "#{proc_name}()" unless proc_name.end_with?(')')
+
+    for_each = options[:for_each] || 'ROW'
+    constraint = options[:constraint]
+
+    sql = if constraint
+            "CREATE CONSTRAINT TRIGGER #{trigger_name(proc_name, options)}\n  #{event}\n"
+          else
+            "CREATE TRIGGER #{trigger_name(proc_name, options)}\n  #{event}\n"
+          end
+
+    sql << "  ON #{quote_table_or_view(table_name, options)}\n"
+    if constraint
+      sql << if options[:deferrable]
+               "  DEFERRABLE INITIALLY #{!!options[:initially_deferred] ? 'DEFERRED' : 'IMMEDIATE'}\n"
+             else
+               "  NOT DEFERRABLE\n"
+             end
+    end
+    sql << "  FOR EACH #{for_each}\n"
+    if condition = options[:condition]
+      sql << "  WHEN (#{condition})\n"
+    end
+    sql << "  EXECUTE PROCEDURE #{proc_name}"
+
+    execute sql
+  end
+
+  # See lib/pg_saurus/connection_adapters/trigger_methods.rb
+  def remove_trigger(table_name, proc_name, options = {})
+    execute "DROP TRIGGER #{trigger_name(proc_name, options)} ON #{quote_table_or_view(table_name, options)}"
+  end
+
+  # Returns the listing of currently defined db triggers
+  #
+  # @return [Array<::PgSaurus::ConnectionAdapters::TriggerDefinition>]
+  def triggers
+    res = select_all <<-SQL
+      SELECT n.nspname as schema,
+             c.relname as table,
+             t.tgname as trigger_name,
+             t.tgenabled as enable_mode,
+             t.tgdeferrable as is_deferrable,
+             t.tginitdeferred as is_initially_deferrable,
+             pg_catalog.pg_get_triggerdef(t.oid, true) as trigger_definition
+      FROM pg_catalog.pg_trigger t
+        INNER JOIN pg_catalog.pg_class c ON c.oid = t.tgrelid
+        INNER JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+      WHERE c.relkind IN ('r', 'v')
+        AND NOT t.tgisinternal
+      ORDER BY 1, 2, 3;
+    SQL
+
+    res.inject([]) do |buffer, row|
+      schema                = row['schema']
+      table                 = row['table']
+      trigger_name          = row['trigger_name']
+      is_deferrable         = row['is_deferrable']
+      is_initially_deferred = row['is_initially_deferred']
+
+      trigger_definition = row['trigger_definition']
+
+      is_constraint = is_constraint?(trigger_definition)
+      proc_name     = parse_proc_name(trigger_definition)
+      event         = parse_event(trigger_definition, trigger_name)
+      condition     = parse_condition(trigger_definition)
+
+      for_every = !!(trigger_definition =~ /FOR[\s]EACH[\s]ROW/) ? :row : :statement
+
+      if proc_name && event
+        buffer << ::PgSaurus::ConnectionAdapters::TriggerDefinition.new(
+          trigger_name,
+          proc_name,
+          is_constraint,
+          event,
+          for_every,
+          is_deferrable,
+          is_initially_deferred,
+          condition,
+          table,
+          schema
+        )
+      end
+      buffer
+    end
+  end
+
+  def parse_condition(trigger_definition)
+    trigger_definition[/WHEN[\s](.*?)[\s]EXECUTE[\s]PROCEDURE/m, 1]
+  end
+  private :parse_condition
+
+  def parse_event(trigger_definition, trigger_name)
+    trigger_definition[/^CREATE[\sA-Z]+TRIGGER[\s]#{Regexp.escape(trigger_name)}[\s](.*?)[\s]ON[\s]/m, 1]
+  end
+  private :parse_event
+
+  def parse_proc_name(trigger_definition)
+    trigger_definition[/EXECUTE[\s]PROCEDURE[\s](.*?)$/m,1]
+  end
+  private :parse_proc_name
+
+  def is_constraint?(trigger_definition)
+    !!(trigger_definition =~ /^CREATE CONSTRAINT TRIGGER/)
+  end
+  private :is_constraint?
+
+  def quote_table_or_view(name, options)
+    schema = options[:schema]
+    if schema
+      "\"#{schema}\".\"#{name}\""
+    else
+      "\"#{name}\""
+    end
+  end
+  private :quote_table_or_view
+
+  def trigger_name(proc_name, options)
+    if name = options[:name]
+      name
+    else
+      "trigger_#{proc_name.gsub('(', '').gsub(')', '')}"
+    end
+  end
+  private :trigger_name
+
+end

data/lib/pg_saurus/connection_adapters/table.rb

@@ -6,10 +6,11 @@ module PgSaurus::ConnectionAdapters::Table
 
   autoload :CommentMethods
   autoload :ForeignerMethods
+  autoload :TriggerMethods
 
   include CommentMethods
   include ForeignerMethods
-
+  include TriggerMethods
 
   included do
     alias_method_chain :references, :foreign_keys

data/lib/pg_saurus/connection_adapters/table/trigger_methods.rb

@@ -0,0 +1,33 @@
+# Provides methods to extend ActiveRecord::ConnectionAdapters::Table
+# to support database triggers.
+module PgSaurus::ConnectionAdapters::Table::TriggerMethods
+
+  # Creates a trigger.
+  #
+  # Example:
+  #
+  #   change_table :pets do |t|
+  #     t.create_trigger :pets_not_empty_trigger_proc,
+  #                      'AFTER INSERT',
+  #                      for_each: 'ROW',
+  #                      schema: 'public',
+  #                      constraint: true,
+  #                      deferrable: true,
+  #                      initially_deferred: true
+  #   end
+  def create_trigger(proc_name, event, options = {})
+    @base.create_trigger(@table_name, proc_name, event, options)
+  end
+
+  # Removes a trigger.
+  #
+  # Example:
+  #
+  #   change_table :pets do |t|
+  #     t.remove_trigger :pets_not_empty_trigger_proc
+  #   end
+  def remove_trigger(proc_name, options = {})
+    @base.remove_trigger(@table_name, proc_name, options)
+  end
+
+end

data/lib/pg_saurus/connection_adapters/trigger_definition.rb

@@ -0,0 +1,16 @@
+module PgSaurus::ConnectionAdapters
+
+  # Struct definition for a DB trigger.
+  class TriggerDefinition < Struct.new( :name,
+                                        :proc_name,
+                                        :constraint,
+                                        :event,
+                                        :for_each,
+                                        :deferrable,
+                                        :initially_deferred,
+                                        :condition,
+                                        :table,
+                                        :schema )
+
+  end
+end

data/lib/pg_saurus/migration/command_recorder.rb

@@ -9,6 +9,7 @@ module PgSaurus::Migration::CommandRecorder
   autoload :ForeignerMethods
   autoload :ViewMethods
   autoload :FunctionMethods
+  autoload :TriggerMethods
 
   include ExtensionMethods
   include SchemaMethods
@@ -16,4 +17,5 @@ module PgSaurus::Migration::CommandRecorder
   include ForeignerMethods
   include ViewMethods
   include FunctionMethods
+  include TriggerMethods
 end

data/lib/pg_saurus/migration/command_recorder/function_methods.rb

@@ -1,15 +1,15 @@
 # Methods to extend ActiveRecord::Migration::CommandRecorder to
-# support comments feature.
+# support database functions.
 module  PgSaurus::Migration::CommandRecorder::FunctionMethods
 
   # :nodoc
   def create_function(*args)
-    record :create_function, *args
+    record :create_function, args
   end
 
   # :nodoc
   def drop_function(*args)
-    record :drop_function, *args
+    record :drop_function, args
   end
 
   # :nodoc

data/lib/pg_saurus/migration/command_recorder/trigger_methods.rb

@@ -0,0 +1,23 @@
+# Methods to extend ActiveRecord::Migration::CommandRecorder to
+# support database triggers.
+module PgSaurus::Migration::CommandRecorder::TriggerMethods
+
+  # :nodoc:
+  def create_trigger(*args)
+    record :create_trigger, args
+  end
+
+  # :nodoc:
+  def remove_trigger(*args)
+    record :remove_trigger, args
+  end
+
+  # :nodoc:
+  def invert_create_trigger(args)
+    table_name, proc_name, _, options = *args
+    options ||= {}
+
+    [:remove_trigger, [table_name, proc_name, options]]
+  end
+
+end

data/lib/pg_saurus/schema_dumper.rb

@@ -11,6 +11,7 @@ module PgSaurus::SchemaDumper
   autoload :ForeignerMethods
   autoload :ViewMethods
   autoload :FunctionMethods
+  autoload :TriggerMethods
 
   include ExtensionMethods
   include CommentMethods
@@ -18,6 +19,7 @@ module PgSaurus::SchemaDumper
   include ForeignerMethods
   include ViewMethods
   include FunctionMethods
+  include TriggerMethods
 
   included do
     alias_method_chain :header, :schemas
@@ -26,6 +28,7 @@ module PgSaurus::SchemaDumper
     alias_method_chain :tables, :views
     alias_method_chain :tables, :foreign_keys
     alias_method_chain :tables, :functions
+    alias_method_chain :tables, :triggers
     alias_method_chain :tables, :comments
   end
 end

data/lib/pg_saurus/schema_dumper/trigger_methods.rb

@@ -0,0 +1,33 @@
+# Support for dumping database triggers.
+module PgSaurus::SchemaDumper::TriggerMethods
+
+  # :nodoc
+  def tables_with_triggers(stream)
+    tables_without_triggers(stream)
+
+    dump_triggers(stream)
+    stream.puts
+
+    stream
+  end
+
+  # Write out a command to create each detected trigger.
+  def dump_triggers(stream)
+    @connection.triggers.each do |trigger|
+      statement = "  create_trigger '#{trigger.table}', '#{trigger.proc_name}', '#{trigger.event}', " \
+        "name: '#{trigger.name}', " \
+        "constraint: #{trigger.constraint ? :true : :false}, " \
+        "for_each: :#{trigger.for_each}, " \
+        "deferrable: #{trigger.deferrable ? :true : :false}, " \
+        "initially_deferred: #{trigger.initially_deferred ? :true : :false}, " \
+        "schema: '#{trigger.schema}'"
+
+      if trigger.condition
+        statement << %Q{, condition: '#{trigger.condition.gsub("'", %q(\\\'))}'}
+      end
+
+      stream.puts "#{statement}\n"
+    end
+  end
+
+end

data/lib/pg_saurus/version.rb

@@ -1,4 +1,4 @@
 module PgSaurus
   # Version of pg_saurus gem.
-  VERSION = '2.3.1'
+  VERSION = "2.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_saurus
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.1
 platform: ruby
 authors:
 - Potapov Sergey
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -177,6 +177,7 @@ files:
 - lib/pg_saurus/connection_adapters/abstract_adapter/function_methods.rb
 - lib/pg_saurus/connection_adapters/abstract_adapter/index_methods.rb
 - lib/pg_saurus/connection_adapters/abstract_adapter/schema_methods.rb
+- lib/pg_saurus/connection_adapters/abstract_adapter/trigger_methods.rb
 - lib/pg_saurus/connection_adapters/foreign_key_definition.rb
 - lib/pg_saurus/connection_adapters/function_definition.rb
 - lib/pg_saurus/connection_adapters/index_definition.rb
@@ -188,10 +189,13 @@ files:
 - lib/pg_saurus/connection_adapters/postgresql_adapter/index_methods.rb
 - lib/pg_saurus/connection_adapters/postgresql_adapter/schema_methods.rb
 - lib/pg_saurus/connection_adapters/postgresql_adapter/translate_exception.rb
+- lib/pg_saurus/connection_adapters/postgresql_adapter/trigger_methods.rb
 - lib/pg_saurus/connection_adapters/postgresql_adapter/view_methods.rb
 - lib/pg_saurus/connection_adapters/table.rb
 - lib/pg_saurus/connection_adapters/table/comment_methods.rb
 - lib/pg_saurus/connection_adapters/table/foreigner_methods.rb
+- lib/pg_saurus/connection_adapters/table/trigger_methods.rb
+- lib/pg_saurus/connection_adapters/trigger_definition.rb
 - lib/pg_saurus/create_index_concurrently.rb
 - lib/pg_saurus/engine.rb
 - lib/pg_saurus/errors.rb
@@ -202,6 +206,7 @@ files:
 - lib/pg_saurus/migration/command_recorder/foreigner_methods.rb
 - lib/pg_saurus/migration/command_recorder/function_methods.rb
 - lib/pg_saurus/migration/command_recorder/schema_methods.rb
+- lib/pg_saurus/migration/command_recorder/trigger_methods.rb
 - lib/pg_saurus/migration/command_recorder/view_methods.rb
 - lib/pg_saurus/migration/set_role_method.rb
 - lib/pg_saurus/schema_dumper.rb
@@ -210,6 +215,7 @@ files:
 - lib/pg_saurus/schema_dumper/foreigner_methods.rb
 - lib/pg_saurus/schema_dumper/function_methods.rb
 - lib/pg_saurus/schema_dumper/schema_methods.rb
+- lib/pg_saurus/schema_dumper/trigger_methods.rb
 - lib/pg_saurus/schema_dumper/view_methods.rb
 - lib/pg_saurus/tools.rb
 - lib/pg_saurus/version.rb