activerecord-postgresql-extensions 0.4.0 → 0.5.0

data/Gemfile

@@ -10,7 +10,7 @@ end
 
 gem "rdoc", "~> 3.12"
 gem "rake", "~> 10.0"
-gem "minitest"
+gem "minitest", "~> 4.7"
 gem "minitest-reporters"
 gem "guard-minitest"
 gem "simplecov"

data/activerecord-postgresql-extensions.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.description = "A whole bunch of extensions the ActiveRecord PostgreSQL adapter."
   s.summary = s.description
   s.email = "code@zoocasa.com"
+  s.license = "MIT"
   s.extra_rdoc_files = [
     "README.rdoc"
   ]

data/lib/active_record/postgresql_extensions/functions.rb

@@ -28,9 +28,14 @@ module ActiveRecord
 
   module ConnectionAdapters
     class PostgreSQLAdapter
+      # :call-seq:
+      #   create_function(name, arguments, returns, language, options = {}, &block)
+      #   create_function(name, arguments, returns, language, body, options = {})
+      #   create_function(name, returns, language, options = {}, &block)
+      #
       # Creates a PostgreSQL function/stored procedure.
       #
-      # +args+ is a simple String that you can use to represent the
+      # +arguments+ is a simple String that you can use to represent the
       # function arguments.
       #
       # +returns+ is the return type for the function.
@@ -44,7 +49,8 @@ module ActiveRecord
       # C, this will be an Array containing two items: the object file
       # the function is found in and the link symbol for the function.
       # In all other cases, this argument will be a String containing
-      # the actual function code.
+      # the actual function code. You can also provide either a block that
+      # returns the function body as a String or a :body option.
       #
       # ==== Options
       #
@@ -83,6 +89,8 @@ module ActiveRecord
       #   with the parameters as keys and the values to set as values.
       #   When using a Hash, the value <tt>:from_current</tt> can be
       #   used to specify the actual <tt>FROM CURRENT</tt> clause.
+      # * <tt>:body</tt> - allows you to set a function body when the arguments
+      #   to <tt>create_function</tt> are ambiguous.
       #
       # You should definitely check out the PostgreSQL documentation
       # on creating stored procedures, because it can get pretty
@@ -112,10 +120,25 @@ module ActiveRecord
       #   # LANGUAGE "sql"
       #   #   IMMUTABLE
       #   #   SET "search_path" FROM CURRENT;
-      def create_function(name, arguments, returns, language, *args)
+      def create_function(name, *args)
         options = args.extract_options!
 
-        body = if args.first.present?
+        raise ArgumentError.new("Expected 3-6 arguments") unless args.length.between?(2, 4)
+        raise ArgumentError.new("Ambiguous arguments: can't specify a function body as an argument without any function arguments. Hint: Use a :body option.") if args.length <= 3 && !block_given? && !options.key?(:body)
+
+        arguments, returns, language = if args.length >= 3
+          args.shift(3)
+        else
+          [ nil ] + args.shift(2)
+        end
+
+        body = if options.key?(:body)
+          if block_given? || args.first.present?
+            raise ArgumentError.new("Can't have both a :body option as well as a block or body argument in create_function")
+          end
+
+          options[:body].to_s
+        elsif args.first.present?
           if block_given?
             raise ArgumentError.new("Can't have both a function body argument as well as a block in create_function")
           end
@@ -135,27 +158,50 @@ module ActiveRecord
       # * <tt>:if_exists</tt> - adds an <tt>IF EXISTS</tt> clause.
       # * <tt>:cascade</tt> - cascades the operation on to any objects
       #   referring to the function.
-      def drop_function(name, args, options = {})
+      def drop_function(name, *args)
+        raise ArgumentError.new("Expected 2-3 arguments") unless args.length.between?(1, 2)
+
+        options = args.extract_options!
+        arguments = args.first
+
         sql = 'DROP FUNCTION '
         sql << 'IF EXISTS ' if options[:if_exists]
-        sql << "#{quote_function(name)}(#{args})"
+        sql << "#{quote_function(name)}(#{arguments})"
         sql << ' CASCADE' if options[:cascade]
         execute "#{sql};"
       end
 
       # Renames a function.
-      def rename_function(name, args, rename_to, options = {})
-        execute PostgreSQLFunctionAlterer.new(self, name, args, :rename_to => rename_to).to_s
+      def rename_function(name, *args)
+        raise ArgumentError.new("Expected 2-3 arguments") unless args.length.between?(1, 2)
+
+        options = args.extract_options!
+        rename_to = args.pop
+        arguments = args.pop
+
+        execute PostgreSQLFunctionAlterer.new(self, name, arguments, :rename_to => rename_to).to_s
       end
 
       # Changes the function's owner.
-      def alter_function_owner(name, args, owner_to, options = {})
-        execute PostgreSQLFunctionAlterer.new(self, name, args, :owner_to => owner_to).to_s
+      def alter_function_owner(name, *args)
+        raise ArgumentError.new("Expected 2-3 arguments") unless args.length.between?(1, 2)
+
+        options = args.extract_options!
+        owner_to = args.pop
+        arguments = args.pop
+
+        execute PostgreSQLFunctionAlterer.new(self, name, arguments, :owner_to => owner_to).to_s
       end
 
       # Changes the function's schema.
-      def alter_function_schema(name, args, set_schema, options = {})
-        execute PostgreSQLFunctionAlterer.new(self, name, args, :set_schema => set_schema).to_s
+      def alter_function_schema(name, *args)
+        raise ArgumentError.new("Expected 2-3 arguments") unless args.length.between?(1, 2)
+
+        options = args.extract_options!
+        set_schema = args.pop
+        arguments = args.pop
+
+        execute PostgreSQLFunctionAlterer.new(self, name, arguments, :set_schema => set_schema).to_s
       end
 
       # Alters a function. There's a ton of stuff you can do here, and
@@ -187,8 +233,12 @@ module ActiveRecord
       #   #
       #   # ALTER FUNCTION "my_function"(integer) OWNER TO "jdoe";
       #   # ALTER FUNCTION "my_function"(integer) RENAME TO "another_function";
-      def alter_function(name, args, options = {})
-        alterer = PostgreSQLFunctionAlterer.new(self, name, args, options)
+      def alter_function(name, *args)
+        raise ArgumentError.new("Expected 2-3 arguments") unless args.length.between?(0, 2)
+
+        options = args.extract_options!
+        arguments = args.pop
+        alterer = PostgreSQLFunctionAlterer.new(self, name, arguments, options)
 
         if block_given?
           yield alterer

data/lib/active_record/postgresql_extensions/version.rb

@@ -1,7 +1,7 @@
 
 module ActiveRecord
   module PostgreSQLExtensions
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end
 

data/test/functions_tests.rb

@@ -46,6 +46,49 @@ class FunctionsTests < PostgreSQLExtensionsTestCase
     assert_equal(expected, statements)
   end
 
+  def test_create_function_with_empty_arguments
+    ARBC.create_function(:test, :integer, :sql) do
+      "select 10;"
+    end
+
+    ARBC.create_function(:test, :integer, :sql, {
+      :force => true,
+      :delimiter => '$__$',
+      :behavior => :immutable,
+      :on_null_input => :strict,
+      :cost => 1,
+      :rows => 10,
+      :set => {
+        'TIME ZONE' => 'America/Halifax'
+      }
+    }) do
+      "return 10;"
+    end
+
+    expected = []
+
+    expected << strip_heredoc(<<-SQL)
+      CREATE FUNCTION "test"() RETURNS integer AS $$
+      select 10;
+      $$
+      LANGUAGE "sql";
+    SQL
+
+    expected << strip_heredoc(<<-SQL)
+      CREATE OR REPLACE FUNCTION "test"() RETURNS integer AS $__$
+      return 10;
+      $__$
+      LANGUAGE "sql"
+          IMMUTABLE
+          STRICT
+          COST 1
+          ROWS 10
+          SET TIME ZONE "America/Halifax";
+    SQL
+
+    assert_equal(expected, statements)
+  end
+
   def test_create_function_with_body_argument
     ARBC.create_function(:test, :integer, :integer, :sql, "select 10;")
 
@@ -85,6 +128,50 @@ class FunctionsTests < PostgreSQLExtensionsTestCase
     assert_equal(expected, statements)
   end
 
+  def test_create_function_with_body_argument_and_empty_arguments
+    assert_raises(ArgumentError) do
+      ARBC.create_function(:test, :integer, :sql, "select 10;")
+    end
+
+    assert_raises(ArgumentError) do
+      ARBC.create_function(:test, :integer, :sql, "select 10;", {
+        :force => true
+      })
+    end
+
+    assert_raises(ArgumentError) do
+      ARBC.create_function(:test, :integer, :sql, {
+        :body => "select 20"
+      }) do
+        "select 30"
+      end
+    end
+
+    ARBC.create_function(:test, :integer, :sql, :body => "select 20;")
+    ARBC.create_function(:test, :integer, :sql, {
+      :body => "select 20;",
+      :force => true
+    })
+
+    expected = []
+
+    expected << strip_heredoc(<<-SQL)
+      CREATE FUNCTION "test"() RETURNS integer AS $$
+      select 20;
+      $$
+      LANGUAGE "sql";
+    SQL
+
+    expected << strip_heredoc(<<-SQL)
+      CREATE OR REPLACE FUNCTION "test"() RETURNS integer AS $$
+      select 20;
+      $$
+      LANGUAGE "sql";
+    SQL
+
+    assert_equal(expected, statements)
+  end
+
   def test_drop_function
     ARBC.drop_function(:test, :integer)
     ARBC.drop_function(:test, :integer, :if_exists => true, :cascade => true)
@@ -97,31 +184,39 @@ class FunctionsTests < PostgreSQLExtensionsTestCase
 
   def test_rename_function
     ARBC.rename_function(:test, 'integer, text', :foo)
+    ARBC.rename_function(:test, :foo)
 
     assert_equal([
-      %{ALTER FUNCTION "test"(integer, text) RENAME TO "foo";}
+      %{ALTER FUNCTION "test"(integer, text) RENAME TO "foo";},
+      %{ALTER FUNCTION "test"() RENAME TO "foo";}
     ], statements)
   end
 
   def test_alter_function_owner
     ARBC.alter_function_owner(:test, 'integer, text', :admin)
+    ARBC.alter_function_owner(:test, :admin)
 
     assert_equal([
-      %{ALTER FUNCTION "test"(integer, text) OWNER TO "admin";}
+      %{ALTER FUNCTION "test"(integer, text) OWNER TO "admin";},
+      %{ALTER FUNCTION "test"() OWNER TO "admin";}
     ], statements)
   end
 
   def test_alter_function_schema
     ARBC.alter_function_schema(:test, 'integer, text', :geospatial)
+    ARBC.alter_function_schema(:test, :geospatial)
 
     assert_equal([
-      %{ALTER FUNCTION "test"(integer, text) SET SCHEMA "geospatial";}
+      %{ALTER FUNCTION "test"(integer, text) SET SCHEMA "geospatial";},
+      %{ALTER FUNCTION "test"() SET SCHEMA "geospatial";}
     ], statements)
   end
 
   def test_alter_function
     ARBC.alter_function('my_function', 'integer', :rename_to => 'another_function')
+    ARBC.alter_function('my_function', :rename_to => 'another_function')
     ARBC.alter_function('another_function', 'integer', :owner_to => 'jdoe')
+    ARBC.alter_function('another_function', :owner_to => 'jdoe')
     ARBC.alter_function('my_function', 'integer') do |f|
       f.rename_to 'another_function'
       f.owner_to 'jdoe'
@@ -137,9 +232,15 @@ class FunctionsTests < PostgreSQLExtensionsTestCase
       f.reset %w{ debug_assertions trace_notify }
     end
 
+    ARBC.alter_function('my_function') do |f|
+      f.rename_to 'another_function'
+    end
+
     expected = [
       %{ALTER FUNCTION "my_function"(integer) RENAME TO "another_function";},
-      %{ALTER FUNCTION "another_function"(integer) OWNER TO "jdoe";}
+      %{ALTER FUNCTION "my_function"() RENAME TO "another_function";},
+      %{ALTER FUNCTION "another_function"(integer) OWNER TO "jdoe";},
+      %{ALTER FUNCTION "another_function"() OWNER TO "jdoe";}
     ]
 
     expected << strip_heredoc(<<-SQL)
@@ -155,6 +256,8 @@ class FunctionsTests < PostgreSQLExtensionsTestCase
       ALTER FUNCTION "another_function"(integer) RESET "debug_assertions" RESET "trace_notify";
     SQL
 
+    expected << %{ALTER FUNCTION "my_function"() RENAME TO "another_function";}
+
     assert_equal(expected, statements)
   end
 end

metadata

@@ -1,29 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgresql-extensions
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - J Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :runtime
-  prerelease: false
   name: activerecord
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.3'
-  requirement: !ruby/object:Gem::Requirement
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.3'
+    none: false
+  prerelease: false
 description: A whole bunch of extensions the ActiveRecord PostgreSQL adapter.
 email: code@zoocasa.com
 executables: []
@@ -89,8 +92,8 @@ files:
 - test/vacuum_tests.rb
 - test/views_tests.rb
 homepage: http://github.com/zoocasa/activerecord-postgresql-extensions
-licenses: []
-metadata: {}
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -99,17 +102,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 1506709517929414109
       version: '0'
+  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A whole bunch of extensions the ActiveRecord PostgreSQL adapter.
 test_files:
 - test/adapter_extensions_tests.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OGY1YjMzZWU1ZmNjN2VmZDU5ODQyM2Q0ZDg3N2JjNjkwZTFkMTkwYQ==
-  data.tar.gz: !binary |-
-    ZGMxNWRjNjEwNzVhZjU1MzMxYTQ4ZTk0NWU2MjljYzViMDM5YzdjNQ==
-SHA512:
-  metadata.gz: !binary |-
-    NWRkMmZiNWViMzE4ZjBhNDEzOWFlNGJkOTIxZjg1MjljM2IyOWVmM2QzODA2
-    OGQzOWY2YjRhY2UzMzE5MzBlN2YxYzM3MjZkMTUzYzc4NDM3Zjc3NzliZWZm
-    MTc5NDU2NGE2MjY2YjUxYzhiYTI5MTVlNmZiNDFjMmZkOWFlM2U=
-  data.tar.gz: !binary |-
-    YjQyYWU2ZDM3MjQ0NmFhNDVmOWI3N2U0MWZkZDM5MTRiNTRhZmFlM2M4N2Jj
-    YjdkZTUyODk5ZmFlYmJhNzVhMjdjZDc5YjdmY2QyODMxZmY2ZmIwZTBiNmE5
-    YmZkMjE4NmZhNjAzNWI4MjIwOThkNjYzMzg3ZjQyMTQ1ODQ3NTE=