pg_saurus 2.2.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc9bebafd878bea837a77e847e87acb017eaf59b
-  data.tar.gz: 3abfea5605d0181799be4d013c1cc6e67ebef965
+  metadata.gz: 3e759d3f6f18831227c70d8d5609d0545053a3ec
+  data.tar.gz: 6bacd12ec585be568ad2863c9cc7dedb112b97fd
 SHA512:
-  metadata.gz: 597de2bbbdb25a36efda49b39796bda5f0ee3ca234495e0b429b2a08ff95fcbd0a43d71b4ba0cc4238a11b2278dec0a1e6a18e776a45d6185589ffa9ecc893e9
-  data.tar.gz: 9f4825c215da71f42800a60fc0a3dc788bc77bf9ef618a3d67930f3e8f074c00a119a510136b2e51611c8ec135a54863a26e183004edd15c663d898f67823b6e
+  metadata.gz: 66c2279cce0676edd0084721a66ef4faf325df16e43e77649b9cc0bf95bf6a41af41f43c645d14d711656ed1159c9ff80dec6e95b7ec450ee5f97fb257e3c910
+  data.tar.gz: 8d33063a06e25aaf16868674bee9c2c9811237ac82d2519c78cccdbdc45837027aba1fb18376ed495a3f460a23608b3eb0257944ec28cc1e95f03a59eec87f6f

data/README.markdown

@@ -310,6 +310,32 @@ PgSaurus.configre do |config|
 end
 ```
 
+## Functions
+
+You can create, list, and drop functions.
+
+### Examples
+
+```ruby
+pets_not_empty_function = <<-SQL
+BEGIN
+  IF (SELECT COUNT(*) FROM pets) > 0
+  THEN
+    RETURN true;
+  ELSE
+    RETURN false;
+  END IF;
+END;
+SQL
+
+create_function 'pets_not_empty()', :boolean, pets_not_empty_function, schema: 'public'
+functions.any?{ |function| function.name == 'public.pets_not_empty()' }
+# => true
+drop_function 'pets_not_empty()'
+functions.any?{ |function| function.name == 'public.pets_not_empty()' }
+# => false
+```
+
 ## Tools
 
 PgSaurus::Tools provides a number of useful methods:
@@ -357,14 +383,14 @@ Support for JRuby:
 ## Credits
 
 * [Potapov Sergey](https://github.com/greyblake) - schema support
-* [Arthur Shagall](https://github.com/albertosaurus) - thanks for [pg_comment](https://github.com/albertosaurus/pg_comment)
+* [Arthur Shagall](https://github.com/albertosaurus) - function support - and thanks for [pg_comment](https://github.com/albertosaurus/pg_comment)
 * [Matthew Higgins](https://github.com/matthuhiggins) - thanks for [foreigner](https://github.com/matthuhiggins/foreigner), which was used as a base for the foreign key support
 * [Artem Ignatyev](https://github.com/cryo28) - extension modules load/unload support
 * [Marcelo Silveira](https://github.com/mhfs) - thanks for rails partial index support that was backported into this gem
 
 ## Copyright and License
 
-* Copyright (c) 2014 HornsAndHooves.
+* Copyright (c) 2015 HornsAndHooves.
 * Initial foreign key code taken from foreigner, Copyright (c) 2009 Matthew Higgins
 * pg_comment Copyright (c) 2011 Arthur Shagall
 * Partial index Copyright (c) 2012 Marcelo Silveira

data/lib/pg_saurus/connection_adapters.rb

@@ -6,4 +6,5 @@ module PgSaurus::ConnectionAdapters # :nodoc:
   autoload :Table
   autoload :ForeignKeyDefinition
   autoload :IndexDefinition, 'pg_saurus/connection_adapters/index_definition'
+  autoload :FunctionDefinition, 'pg_saurus/connection_adapters/function_definition'
 end

data/lib/pg_saurus/connection_adapters/abstract_adapter.rb

@@ -7,11 +7,13 @@ module PgSaurus::ConnectionAdapters::AbstractAdapter
   autoload :ForeignerMethods
   autoload :SchemaMethods
   autoload :IndexMethods
+  autoload :FunctionMethods
 
   include CommentMethods
   include ForeignerMethods
   include SchemaMethods
   include IndexMethods
+  include FunctionMethods
 
   included do
     alias_method_chain :create_table, :schema_option

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

@@ -0,0 +1,24 @@
+# Adapter definitions for DB functions.
+module PgSaurus::ConnectionAdapters::AbstractAdapter::FunctionMethods
+
+  # :nodoc
+  def supports_functions?
+    false
+  end
+
+  # Create a database function.
+  def create_function(function_name, returning, definition, options = {})
+
+  end
+
+  # Delete the database function.
+  def drop_function(function_name, options)
+
+  end
+
+  # Return the listing of currently defined DB functions.
+  def functions
+
+  end
+
+end

data/lib/pg_saurus/connection_adapters/function_definition.rb

@@ -0,0 +1,10 @@
+module PgSaurus::ConnectionAdapters
+  # Struct definition for a DB function.
+  class FunctionDefinition < Struct.new( :name,
+                                         :returning,
+                                         :definition,
+                                         :function_type,
+                                         :language,
+                                         :oid )
+  end
+end

data/lib/pg_saurus/connection_adapters/postgresql_adapter.rb

@@ -12,6 +12,7 @@ module PgSaurus::ConnectionAdapters::PostgreSQLAdapter
   autoload :IndexMethods,       'pg_saurus/connection_adapters/postgresql_adapter/index_methods'
   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'
 
   include ExtensionMethods
   include SchemaMethods
@@ -20,6 +21,7 @@ module PgSaurus::ConnectionAdapters::PostgreSQLAdapter
   include IndexMethods
   include TranslateException
   include ViewMethods
+  include FunctionMethods
 
   included do
     alias_method_chain :tables, :non_public_schema_tables

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

@@ -0,0 +1,109 @@
+# Methods to extend {ActiveRecord::ConnectionAdapters::PostgreSQLAdapter}
+# to support database functions.
+module PgSaurus::ConnectionAdapters::PostgreSQLAdapter::FunctionMethods
+
+  # Return +true+.
+  def supports_functions?
+    true
+  end
+
+  # Return a list of defined DB functions. Ignore function definitions that can't be parsed.
+  def functions
+    res = select_all <<-SQL
+      SELECT n.nspname AS "Schema",
+        p.proname AS "Name",
+        pg_catalog.pg_get_function_result(p.oid) AS "Returning",
+       CASE
+        WHEN p.proisagg    THEN 'agg'
+        WHEN p.proiswindow THEN 'window'
+        WHEN p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype
+        THEN 'trigger'
+        ELSE 'normal'
+       END   AS "Type",
+       p.oid AS "Oid"
+      FROM pg_catalog.pg_proc p
+           LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace
+      WHERE pg_catalog.pg_function_is_visible(p.oid)
+            AND n.nspname <> 'pg_catalog'
+            AND n.nspname <> 'information_schema'
+      ORDER BY 1, 2, 3, 4;
+    SQL
+    res.inject([]) do |buffer, row|
+      returning     = row['Returning']
+      function_type = row['Type']
+      oid           = row['Oid']
+
+      function_str = select_value("SELECT pg_get_functiondef(#{oid});")
+
+      name       = parse_function_name(function_str)
+      language   = parse_function_language(function_str)
+      definition = parse_function_definition(function_str)
+
+      if definition
+        buffer << ::PgSaurus::ConnectionAdapters::FunctionDefinition.new(name,
+                                                                         returning,
+                                                                         definition.strip,
+                                                                         function_type,
+                                                                         language,
+                                                                         oid)
+      end
+      buffer
+    end
+  end
+
+  # Create a new database function.
+  def create_function(function_name, returning, definition, options = {})
+
+    function_name = full_function_name(function_name, options)
+    language      = options[:language] || 'plpgsql'
+    replace       = if options[:replace] == false
+                      ''
+                    else
+                      'OR REPLACE '
+                    end
+
+    sql = <<-SQL.gsub(/^[ ]{6}/, "")
+      CREATE #{replace}FUNCTION #{function_name}
+        RETURNS #{returning}
+        LANGUAGE #{language}
+      AS $function$
+      #{definition.strip}
+      $function$
+    SQL
+
+    execute(sql)
+  end
+
+  # Drop the given database function.
+  def drop_function(function_name, options = {})
+    function_name = full_function_name(function_name, options)
+
+    execute "DROP FUNCTION #{function_name}"
+  end
+
+  # Retrieve the function name from the function SQL.
+  def parse_function_name(function_str)
+    function_str.split("\n").find { |line| line =~ /^CREATE[\s\S]+FUNCTION/ }.split(' ').last
+  end
+  private :parse_function_name
+
+  # Retrieve the function language from the function SQL.
+  def parse_function_language(function_str)
+    function_str.split("\n").find { |line| line =~ /LANGUAGE/ }.split(' ').last
+  end
+  private :parse_function_language
+
+  # Retrieve the function definition from the function SQL.
+  def parse_function_definition(function_str)
+    function_str[/#{Regexp.escape("AS $function$\n")}(.*?)#{Regexp.escape("$function$")}/m, 1]
+  end
+  private :parse_function_definition
+
+  # 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
+  end
+  private :full_function_name
+end

data/lib/pg_saurus/migration/command_recorder.rb

@@ -8,10 +8,12 @@ module PgSaurus::Migration::CommandRecorder
   autoload :CommentMethods
   autoload :ForeignerMethods
   autoload :ViewMethods
+  autoload :FunctionMethods
 
   include ExtensionMethods
   include SchemaMethods
   include CommentMethods
   include ForeignerMethods
   include ViewMethods
+  include FunctionMethods
 end

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

@@ -0,0 +1,23 @@
+# Methods to extend ActiveRecord::Migration::CommandRecorder to
+# support comments feature.
+module  PgSaurus::Migration::CommandRecorder::FunctionMethods
+
+  # :nodoc
+  def create_function(*args)
+    record :create_function, *args
+  end
+
+  # :nodoc
+  def drop_function(*args)
+    record :drop_function, *args
+  end
+
+  # :nodoc
+  def invert_create_function(args)
+    function_name = args.first
+    schema        = args.last[:schema]
+
+    [:drop_function, [function_name, { schema: schema }]]
+  end
+
+end

data/lib/pg_saurus/schema_dumper.rb

@@ -10,19 +10,22 @@ module PgSaurus::SchemaDumper
   autoload :SchemaMethods
   autoload :ForeignerMethods
   autoload :ViewMethods
+  autoload :FunctionMethods
 
   include ExtensionMethods
   include CommentMethods
   include SchemaMethods
   include ForeignerMethods
   include ViewMethods
+  include FunctionMethods
 
   included do
     alias_method_chain :header, :schemas
     alias_method_chain :header, :extensions
 
     alias_method_chain :tables, :views
-    alias_method_chain :tables, :comments
     alias_method_chain :tables, :foreign_keys
+    alias_method_chain :tables, :functions
+    alias_method_chain :tables, :comments
   end
 end

data/lib/pg_saurus/schema_dumper/function_methods.rb

@@ -0,0 +1,24 @@
+# Support for dumping database functions.
+module PgSaurus::SchemaDumper::FunctionMethods
+
+  # :nodoc
+  def tables_with_functions(stream)
+    tables_without_functions(stream)
+
+    dump_functions stream
+
+    stream
+  end
+
+  # Writes out a command to create each detected function.
+  def dump_functions(stream)
+    @connection.functions.each do |function|
+      statement = "  create_function '#{function.name}', :#{function.returning}, <<-FUNCTION_DEFINITION.gsub(/^[\s]{4}/, '')"
+      statement << "\n#{function.definition.split("\n").map{|line| "    #{line}" }.join("\n")}"
+      statement << "\n  FUNCTION_DEFINITION\n\n"
+
+      stream.puts statement
+    end
+  end
+
+end

data/lib/pg_saurus/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_saurus
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Potapov Sergey
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -33,6 +33,9 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -40,6 +43,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -168,14 +174,17 @@ files:
 - lib/pg_saurus/connection_adapters/abstract_adapter.rb
 - lib/pg_saurus/connection_adapters/abstract_adapter/comment_methods.rb
 - lib/pg_saurus/connection_adapters/abstract_adapter/foreigner_methods.rb
+- 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/foreign_key_definition.rb
+- lib/pg_saurus/connection_adapters/function_definition.rb
 - lib/pg_saurus/connection_adapters/index_definition.rb
 - lib/pg_saurus/connection_adapters/postgresql_adapter.rb
 - lib/pg_saurus/connection_adapters/postgresql_adapter/comment_methods.rb
 - lib/pg_saurus/connection_adapters/postgresql_adapter/extension_methods.rb
 - lib/pg_saurus/connection_adapters/postgresql_adapter/foreigner_methods.rb
+- lib/pg_saurus/connection_adapters/postgresql_adapter/function_methods.rb
 - 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
@@ -191,6 +200,7 @@ files:
 - lib/pg_saurus/migration/command_recorder/comment_methods.rb
 - lib/pg_saurus/migration/command_recorder/extension_methods.rb
 - 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/view_methods.rb
 - lib/pg_saurus/migration/set_role_method.rb
@@ -198,6 +208,7 @@ files:
 - lib/pg_saurus/schema_dumper/comment_methods.rb
 - lib/pg_saurus/schema_dumper/extension_methods.rb
 - 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/view_methods.rb
 - lib/pg_saurus/tools.rb
@@ -223,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: ActiveRecord extensions for PostgreSQL.