fx 0.3.1 → 0.6.2

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.3.1"
+  VERSION = "0.6.2"
 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,17 @@ 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
+
+      # True unless explicitly false
+      def migration
+        options[:migration] != false
+      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,17 @@ 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
+
+      # True unless explicitly false
+      def migration
+        options[:migration] != false
+      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/triggers_spec.rb

@@ -34,9 +34,10 @@ module Fx
           first = triggers.first
           expect(triggers.size).to eq 1
           expect(first.name).to eq "uppercase_users_name"
-          expect(first.definition).to eq <<-EOS.strip_heredoc.strip
-            CREATE TRIGGER uppercase_users_name BEFORE INSERT ON users FOR EACH ROW EXECUTE PROCEDURE uppercase_users_name()
-          EOS
+          expect(first.definition).to include("BEFORE INSERT")
+          expect(first.definition).to match(/ON [public\.users|users]/)
+          expect(first.definition).to include("FOR EACH ROW")
+          expect(first.definition).to include("EXECUTE PROCEDURE uppercase_users_name()")
         end
       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/definition_spec.rb

@@ -28,6 +28,29 @@ describe Fx::Definition do
           %r(Define function in db/functions/test_v01.sql before migrating),
         )
       end
+
+      context "when definition is at Rails engine" do
+        it "returns the content of a function definition" do
+          sql_definition = <<-EOS
+            CREATE OR REPLACE FUNCTION test()
+            RETURNS text AS $$
+            BEGIN
+                RETURN 'test';
+            END;
+            $$ LANGUAGE plpgsql;
+          EOS
+          engine_path = Rails.root.join("tmp", "engine")
+          FileUtils.mkdir_p(engine_path.join("db", "functions"))
+          File.write(engine_path.join("db", "functions", "custom_test_v01.sql"), sql_definition)
+          Rails.application.config.paths["db/migrate"].push(engine_path.join("db", "migrate"))
+
+          definition = Fx::Definition.new(name: "custom_test", version: 1)
+
+          expect(definition.to_sql).to eq sql_definition
+
+          FileUtils.rm_rf(engine_path)
+        end
+      end
     end
 
     context "representing a trigger definition" do

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", {"table_name" => "some_table"}, "--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.3.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Teo Ljungberg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-08 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -191,12 +191,12 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
 - Appraisals
 - CONTRIBUTING.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/appraisal
@@ -206,16 +206,12 @@ files:
 - bin/setup
 - bin/yard
 - fx.gemspec
-- gemfiles/rails40.gemfile
-- gemfiles/rails40.gemfile.lock
-- gemfiles/rails41.gemfile
-- gemfiles/rails41.gemfile.lock
 - gemfiles/rails42.gemfile
-- gemfiles/rails42.gemfile.lock
 - gemfiles/rails50.gemfile
-- gemfiles/rails50.gemfile.lock
+- gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
 - gemfiles/rails_edge.gemfile
-- gemfiles/rails_edge.gemfile.lock
 - lib/fx.rb
 - lib/fx/adapters/postgres.rb
 - lib/fx/adapters/postgres/connection.rb
@@ -228,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
@@ -286,13 +283,13 @@ homepage: https://github.com/teoljungberg/fx
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -301,9 +298,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: Support for database functions and triggers in Rails migrations
 test_files: