fx 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f93c422563a987d0fe73c448281d14f34380b5eb8fd90b1673083f72497746f
-  data.tar.gz: 0ef187b03d6dc9fd3930744adff67f8b7275cc9a75b0d13195c190d4050821fd
+  metadata.gz: d43846b73aa7466215723a28e398085fdcbb0a99f8b376cdda619abf91a8c8ba
+  data.tar.gz: 38de2d17cfca402804b1b9fa2148488abeadb8e4da7f28cfd0850601d99f7fa5
 SHA512:
-  metadata.gz: 720481484ebb0d87e0b1f18d95a0eb73aa3675b847f302218c942433d8c037170fd2f3ca7c5b32336d3ef4c284faf1d768b7a0064eed7918d3b130b08bb6c2e7
-  data.tar.gz: 84e37e4a184a75b62d332b882bb759c9561938a8988fe5375581562c258a85e23c1b94c128265757e7010a5ecbc2b2dad1e10cd9e0eb8ae4c4184523cb4fb85e
+  metadata.gz: 586e3528b79ab504d0667136e819488c1b6338de3e765baaabcf545570d40ea816e5a2ec052be33d1ed48c4a3492cffd8cc1dafed39c1d011730c439f40a5d30
+  data.tar.gz: f648185b7c8857263415a7c8287eb0f258d195cca05a481c86ceff3c7bdd818bddb8eac65258c2f8023f8cd6716f2458145e5a9094e25806f2569606d86524d4

data/.travis.yml

@@ -1,5 +1,9 @@
 addons:
-  postgresql: "9.4"
+  postgresql: "10"
+  apt:
+    packages:
+    - postgresql-10
+    - postgresql-client-10
 before_install:
   - "echo '--colour' > ~/.rspec"
   - "echo 'gem: --no-document' > ~/.gemrc"
@@ -23,12 +27,13 @@ gemfile:
   - gemfiles/rails50.gemfile
   - gemfiles/rails51.gemfile
   - gemfiles/rails52.gemfile
+  - gemfiles/rails60.gemfile
   - gemfiles/rails_edge.gemfile
 matrix:
   allow_failures:
     - gemfile: gemfiles/rails_edge.gemfile
-    - gemfile: gemfiles/rails40.gemfile
-    - gemfile: gemfiles/rails41.gemfile
   exclude:
     - rvm: 2.4
       gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.4
+      gemfile: gemfiles/rails60.gemfile

data/Appraisals

@@ -20,6 +20,11 @@ if RUBY_VERSION > "2.2.0"
     gem "railties", "~> 5.2"
   end
 
+  appraise "rails60" do
+    gem "activerecord", "~> 6.0"
+    gem "railties", "~> 6.0"
+  end
+
   appraise "rails-edge" do
     gem "rails", github: "rails/rails"
     gem "arel", :github => "rails/arel"

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2016 Teo Ljungberg
+
+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.

data/README.md

@@ -84,3 +84,30 @@ def change
   drop_function :uppercase_users_name, revert_to_version: 2
 end
 ```
+
+## What if I need to use a function as the default value of a column?
+
+You need to set F(x) to dump the functions in the beginning of db/schema.rb in a
+initializer:
+
+```ruby
+# config/initializers/fx.rb
+Fx.configure do |config|
+  config.dump_functions_at_beginning_of_schema = true
+end
+```
+
+And then you can use a lambda in your migration file:
+
+```ruby
+create_table :my_table do |t|
+  t.string :my_column, default: -> { "my_function()" }
+end
+```
+
+That's how you tell Rails to use the default as a literal SQL for the default
+column value instead of a plain string.
+
+## Contributing
+
+See [contributing](CONTRIBUTING.md) for more details.

data/gemfiles/rails60.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0"
+gem "railties", "~> 6.0"
+
+gemspec path: "../"

data/lib/fx.rb

@@ -7,10 +7,32 @@ require "fx/function"
 require "fx/statements"
 require "fx/schema_dumper"
 require "fx/trigger"
+require "fx/railtie"
 
 # F(x) adds methods `ActiveRecord::Migration` to create and manage database
 # triggers and functions in Rails applications.
 module Fx
+  # Hooks Fx into Rails.
+  #
+  # Enables fx migration methods, migration reversability, and `schema.rb`
+  # dumping.
+  def self.load
+    ActiveRecord::Migration::CommandRecorder.send(
+      :include,
+      Fx::CommandRecorder,
+    )
+
+    ActiveRecord::SchemaDumper.send(
+      :prepend,
+      Fx::SchemaDumper,
+    )
+
+    ActiveRecord::ConnectionAdapters::AbstractAdapter.send(
+      :include,
+      Fx::Statements,
+    )
+  end
+
   # The current database adapter used by F(x).
   #
   # This defaults to {Fx::Adapters::Postgres} but can be overridden

data/lib/fx/adapters/postgres.rb

@@ -125,7 +125,11 @@ module Fx
       #
       # @return [void]
       def drop_function(name)
-        execute "DROP FUNCTION #{name}();"
+        if support_drop_function_without_args
+          execute "DROP FUNCTION #{name};"
+        else
+          execute "DROP FUNCTION #{name}();"
+        end
       end
 
       # Drops the trigger from the database
@@ -150,6 +154,14 @@ module Fx
       def connection
         Connection.new(connectable.connection)
       end
+
+      def support_drop_function_without_args
+        # https://www.postgresql.org/docs/9.6/sql-dropfunction.html
+        # https://www.postgresql.org/docs/10/sql-dropfunction.html
+
+        pg_connection = connectable.connection.raw_connection
+        pg_connection.server_version >= 10_00_00
+      end
     end
   end
 end

data/lib/fx/adapters/postgres/functions.rb

@@ -17,7 +17,10 @@ module Fx
               ON pn.oid = pp.pronamespace
           LEFT JOIN pg_depend pd
               ON pd.objid = pp.oid AND pd.deptype = 'e'
+          LEFT JOIN pg_aggregate pa
+              ON pa.aggfnoid = pp.oid
           WHERE pn.nspname = 'public' AND pd.objid IS NULL
+              AND pa.aggfnoid IS NULL
           ORDER BY pp.oid;
         EOS
 

data/lib/fx/command_recorder.rb

@@ -22,8 +22,3 @@ module Fx
     end
   end
 end
-
-ActiveRecord::Migration::CommandRecorder.send(
-  :include,
-  Fx::CommandRecorder,
-)

data/lib/fx/configuration.rb

@@ -17,6 +17,7 @@ module Fx
   # ```
   # Fx.configure do |config|
   #   config.database = Fx::Adapters::Postgres
+  #   config.dump_functions_at_beginning_of_schema = true
   # end
   # ```
   def self.configure
@@ -31,8 +32,17 @@ module Fx
     # @return Fx adapter
     attr_accessor :database
 
+    # Prioritizes the order in the schema.rb of functions before other
+    # statements in order to make directly schema load work when using functions
+    # in statements below, i.e.: default column values.
+    #
+    # Defaults to false
+    # @return Boolean
+    attr_accessor :dump_functions_at_beginning_of_schema
+
     def initialize
       @database = Fx::Adapters::Postgres.new
+      @dump_functions_at_beginning_of_schema = false
     end
   end
 end

data/lib/fx/railtie.rb

@@ -0,0 +1,15 @@
+require "rails/railtie"
+
+module Fx
+  # Automatically initializes Fx in the context of a Rails application when
+  # ActiveRecord is loaded.
+  #
+  # @see Fx.load
+  class Railtie < Rails::Railtie
+    initializer "fx.load" do
+      ActiveSupport.on_load :active_record do
+        Fx.load
+      end
+    end
+  end
+end

data/lib/fx/schema_dumper.rb

@@ -8,8 +8,3 @@ module Fx
     include Trigger
   end
 end
-
-ActiveRecord::SchemaDumper.send(
-  :prepend,
-  Fx::SchemaDumper,
-)

data/lib/fx/schema_dumper/function.rb

@@ -5,15 +5,24 @@ module Fx
     # @api private
     module Function
       def tables(stream)
+        if Fx.configuration.dump_functions_at_beginning_of_schema
+          functions(stream)
+          empty_line(stream)
+        end
+
         super
-        functions(stream)
-      end
 
-      def functions(stream)
-        if dumpable_functions_in_database.any?
-          stream.puts
+        unless Fx.configuration.dump_functions_at_beginning_of_schema
+          functions(stream)
+          empty_line(stream)
         end
+      end
+
+      def empty_line(stream)
+        stream.puts if dumpable_functions_in_database.any?
+      end
 
+      def functions(stream)
         dumpable_functions_in_database.each do |function|
           stream.puts(function.to_schema)
         end

data/lib/fx/statements.rb

@@ -9,8 +9,3 @@ module Fx
     include Trigger
   end
 end
-
-ActiveRecord::ConnectionAdapters::AbstractAdapter.send(
-  :include,
-  Fx::Statements,
-)

data/lib/fx/version.rb

@@ -1,4 +1,4 @@
 module Fx
   # @api private
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/generators/fx/function/USAGE

@@ -2,6 +2,8 @@ Description:
   Create a new database function for your application. This will create a new
   function definition file and the accompanying migration.
 
+  When --no-migration is passed, skips generating a migration.
+
 Examples:
     rails generate fx:function test
 

data/lib/generators/fx/function/function_generator.rb

@@ -8,6 +8,8 @@ module Fx
       include Rails::Generators::Migration
       source_root File.expand_path("../templates", __FILE__)
 
+      class_option :migration, type: :boolean
+
       def create_functions_directory
         unless function_definition_path.exist?
           empty_directory(function_definition_path)
@@ -23,6 +25,7 @@ module Fx
       end
 
       def create_migration_file
+        return if skip_migration_creation?
         if updating_existing_function?
           migration_template(
             "db/migrate/update_function.erb",
@@ -61,7 +64,7 @@ module Fx
 
         def activerecord_migration_class
           if ActiveRecord::Migration.respond_to?(:current_version)
-            "ActiveRecord::Migration[5.0]"
+            "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
           else
             "ActiveRecord::Migration"
           end
@@ -101,6 +104,16 @@ module Fx
       def previous_definition
         Fx::Definition.new(name: file_name, version: previous_version)
       end
+
+      # Skip creating migration file if:
+      #   - migrations option is nil or false
+      def skip_migration_creation?
+        !migration
+      end
+
+      def migration
+        options[:migration]
+      end
     end
   end
 end

data/lib/generators/fx/trigger/USAGE

@@ -5,6 +5,8 @@ Description:
   If a trigger of the given name already exists, create a new version of the
   trigger and a migration to replace the old version with the new.
 
+  When --no-migration is passed, skips generating a migration.
+
 Examples:
 
     rails generate fx:trigger test

data/lib/generators/fx/trigger/trigger_generator.rb

@@ -9,6 +9,8 @@ module Fx
       source_root File.expand_path("../templates", __FILE__)
       argument :table_name, type: :hash, required: true
 
+      class_option :migration, type: :boolean
+
       def create_triggers_directory
         unless trigger_definition_path.exist?
           empty_directory(trigger_definition_path)
@@ -20,6 +22,7 @@ module Fx
       end
 
       def create_migration_file
+        return if skip_migration_creation?
         if updating_existing_trigger?
           migration_template(
             "db/migrate/update_trigger.erb",
@@ -58,7 +61,7 @@ module Fx
 
         def activerecord_migration_class
           if ActiveRecord::Migration.respond_to?(:current_version)
-            "ActiveRecord::Migration[5.0]"
+            "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
           else
             "ActiveRecord::Migration"
           end
@@ -111,6 +114,16 @@ module Fx
       def trigger_definition_path
         @_trigger_definition_path ||= Rails.root.join(*["db", "triggers"])
       end
+
+      # Skip creating migration file if:
+      #   - migrations option is nil or false
+      def skip_migration_creation?
+        !migration
+      end
+
+      def migration
+        options[:migration]
+      end
     end
   end
 end

data/spec/acceptance/user_manages_functions_spec.rb

@@ -34,4 +34,24 @@ describe "User manages functions" do
     result = execute("SELECT * FROM test() AS result")
     expect(result).to eq("result" => "testest")
   end
+
+  it "handles functions with arguments" do
+    successfully "rails generate fx:function adder"
+    write_function_definition "adder_v01", <<-EOS
+      CREATE FUNCTION adder(x int, y int)
+      RETURNS int AS $$
+      BEGIN
+          RETURN $1 + $2;
+      END;
+      $$ LANGUAGE plpgsql;
+    EOS
+    successfully "rake db:migrate"
+
+    result = execute("SELECT * FROM adder(1, 2) AS result")
+    result["result"] = result["result"].to_i
+    expect(result).to eq("result" => 3)
+
+    successfully "rails destroy fx:function adder"
+    successfully "rake db:migrate"
+  end
 end

data/spec/fx/adapters/postgres_spec.rb

@@ -53,22 +53,44 @@ module Fx::Adapters
     end
 
     describe "#drop_function" do
-      it "successfully drops a function" do
-        adapter = Postgres.new
-        adapter.create_function(
-          <<-EOS
-            CREATE OR REPLACE FUNCTION test()
-            RETURNS text AS $$
-            BEGIN
-                RETURN 'test';
-            END;
-            $$ LANGUAGE plpgsql;
-          EOS
-        )
+      context "when the function has arguments" do
+        it "successfully drops a function with the entire function signature" do
+          adapter = Postgres.new
+          adapter.create_function(
+            <<-EOS
+              CREATE FUNCTION adder(x int, y int)
+              RETURNS int AS $$
+              BEGIN
+                  RETURN $1 + $2;
+              END;
+              $$ LANGUAGE plpgsql;
+            EOS
+          )
+
+          adapter.drop_function(:adder)
+
+          expect(adapter.functions.map(&:name)).not_to include("adder")
+        end
+      end
+
+      context "when the function does not have arguments" do
+        it "successfully drops a function" do
+          adapter = Postgres.new
+          adapter.create_function(
+            <<-EOS
+              CREATE OR REPLACE FUNCTION test()
+              RETURNS text AS $$
+              BEGIN
+                  RETURN 'test';
+              END;
+              $$ LANGUAGE plpgsql;
+            EOS
+          )
 
-        adapter.drop_function(:test)
+          adapter.drop_function(:test)
 
-        expect(adapter.functions.map(&:name)).not_to include("test")
+          expect(adapter.functions.map(&:name)).not_to include("test")
+        end
       end
     end
 

data/spec/fx/schema_dumper/function_spec.rb

@@ -3,14 +3,69 @@ require "spec_helper"
 describe Fx::SchemaDumper::Function, :db do
   it "dumps a create_function for a function in the database" do
     sql_definition = <<-EOS
-      CREATE OR REPLACE FUNCTION test()
+      CREATE OR REPLACE FUNCTION my_function()
       RETURNS text AS $$
       BEGIN
           RETURN 'test';
       END;
       $$ LANGUAGE plpgsql;
     EOS
+    connection.create_function :my_function, sql_definition: sql_definition
+    connection.create_table :my_table
+    stream = StringIO.new
+    output = stream.string
+
+    ActiveRecord::SchemaDumper.dump(connection, stream)
+
+    expect(output).to(
+      match(/table "my_table".*function :my_function.*RETURN 'test';/m),
+    )
+  end
+
+  it "dumps a create_function for a function in the database" do
+    Fx.configuration.dump_functions_at_beginning_of_schema = true
+    sql_definition = <<-EOS
+      CREATE OR REPLACE FUNCTION my_function()
+      RETURNS text AS $$
+      BEGIN
+          RETURN 'test';
+      END;
+      $$ LANGUAGE plpgsql;
+    EOS
+    connection.create_function :my_function, sql_definition: sql_definition
+    connection.create_table :my_table
+    stream = StringIO.new
+    output = stream.string
+
+    ActiveRecord::SchemaDumper.dump(connection, stream)
+
+    expect(output).to(
+      match(/function :my_function.*RETURN 'test';.*table "my_table"/m),
+    )
+  ensure
+    Fx.configuration.dump_functions_at_beginning_of_schema = false
+  end
+
+  it "does not dump a create_function for aggregates in the database" do
+    sql_definition = <<-EOS
+      CREATE OR REPLACE FUNCTION test(text, text)
+      RETURNS text AS $$
+      BEGIN
+          RETURN 'test';
+      END;
+      $$ LANGUAGE plpgsql;
+    EOS
+
+    aggregate_sql_definition = <<-EOS
+      CREATE AGGREGATE aggregate_test(text)
+      (
+          sfunc = test,
+          stype = text
+      );
+    EOS
+
     connection.create_function :test, sql_definition: sql_definition
+    connection.execute aggregate_sql_definition
     stream = StringIO.new
 
     ActiveRecord::SchemaDumper.dump(connection, stream)
@@ -18,5 +73,6 @@ describe Fx::SchemaDumper::Function, :db do
     output = stream.string
     expect(output).to include "create_function :test, sql_definition: <<-SQL"
     expect(output).to include "RETURN 'test';"
+    expect(output).not_to include "aggregate_test"
   end
 end

data/spec/generators/fx/function/function_generator_spec.rb

@@ -13,6 +13,18 @@ describe Fx::Generators::FunctionGenerator, :generator do
     expect(migration_file(migration)).to contain "CreateFunctionTest"
   end
 
+  context "when passed --no-migration" do
+    it "creates a only function definition file" do
+      migration = file("db/migrate/create_function_test.rb")
+      function_definition = file("db/functions/test_v01.sql")
+
+      run_generator ["test", "--no-migration"]
+
+      expect(function_definition).to exist
+      expect(migration_file(migration)).not_to exist
+    end
+  end
+
   it "updates an existing function" do
     with_function_definition(
       name: "test",

data/spec/generators/fx/trigger/trigger_generator_spec.rb

@@ -14,6 +14,18 @@ describe Fx::Generators::TriggerGenerator, :generator do
     expect(migration_file(migration)).to contain "on: :some_table"
   end
 
+  context "when passed --no-migration" do
+    it "creates a only trigger definition file" do
+      migration = file("db/migrate/create_trigger_test.rb")
+      trigger_definition = file("db/triggers/test_v01.sql")
+
+      run_generator ["test", "--no-migration"]
+
+      expect(trigger_definition).to exist
+      expect(migration_file(migration)).not_to exist
+    end
+  end
+
   it "supports naming the table as `on` aswell as `table_name`" do
     migration = file("db/migrate/create_trigger_test.rb")
     trigger_definition = file("db/triggers/test_v01.sql")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fx
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Teo Ljungberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2020-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -196,6 +196,7 @@ files:
 - Appraisals
 - CONTRIBUTING.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/appraisal
@@ -209,6 +210,7 @@ files:
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
 - gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/fx.rb
 - lib/fx/adapters/postgres.rb
@@ -222,6 +224,7 @@ files:
 - lib/fx/configuration.rb
 - lib/fx/definition.rb
 - lib/fx/function.rb
+- lib/fx/railtie.rb
 - lib/fx/schema_dumper.rb
 - lib/fx/schema_dumper/function.rb
 - lib/fx/schema_dumper/trigger.rb
@@ -295,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Support for database functions and triggers in Rails migrations