fx 0.9.0 → 0.10.0

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

@@ -1,39 +1,43 @@
 require "rails/generators"
 require "rails/generators/active_record"
+require "generators/fx/version_helper"
+require "generators/fx/migration_helper"
+require "generators/fx/name_helper"
 
 module Fx
   module Generators
     # @api private
     class TriggerGenerator < Rails::Generators::NamedBase
       include Rails::Generators::Migration
+
       source_root File.expand_path("../templates", __FILE__)
       argument :table_name, type: :hash, required: true
 
+      DEFINITION_PATH = %w[db triggers].freeze
+
       class_option :migration, type: :boolean
 
       def create_triggers_directory
-        unless trigger_definition_path.exist?
-          empty_directory(trigger_definition_path)
-        end
+        return if trigger_definition_path.exist?
+
+        empty_directory(trigger_definition_path)
       end
 
       def create_trigger_definition
-        create_file definition.path
+        create_file(definition.path)
       end
 
       def create_migration_file
-        return if skip_migration_creation?
-        if updating_existing_trigger?
-          migration_template(
-            "db/migrate/update_trigger.erb",
-            "db/migrate/update_trigger_#{file_name}_to_version_#{version}.rb"
-          )
-        else
-          migration_template(
-            "db/migrate/create_trigger.erb",
-            "db/migrate/create_trigger_#{file_name}.rb"
-          )
-        end
+        return if migration_helper.skip_creation?
+
+        template_info = migration_helper.migration_template_info(
+          object_type: :trigger,
+          file_name: file_name,
+          updating_existing: version_helper.updating_existing?,
+          version: version_helper.current_version
+        )
+
+        migration_template(template_info[:template], template_info[:filename])
       end
 
       def self.next_migration_number(dir)
@@ -42,84 +46,61 @@ module Fx
 
       no_tasks do
         def previous_version
-          @_previous_version ||= Dir.entries(trigger_definition_path)
-            .map { |name| version_regex.match(name).try(:[], "version").to_i }
-            .max
+          version_helper.previous_version
         end
 
         def version
-          @_version ||= previous_version.next
+          version_helper.current_version
         end
 
         def migration_class_name
-          if updating_existing_trigger?
-            "UpdateTrigger#{class_name}ToVersion#{version}"
+          if version_helper.updating_existing?
+            migration_helper.update_migration_class_name(
+              object_type: :trigger,
+              class_name: class_name,
+              version: version
+            )
           else
             super
           end
         end
 
-        def activerecord_migration_class
-          if ActiveRecord::Migration.respond_to?(:current_version)
-            "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
-          else
-            "ActiveRecord::Migration"
-          end
+        def active_record_migration_class
+          migration_helper.active_record_migration_class
         end
 
         def formatted_name
-          if singular_name.include?(".")
-            "\"#{singular_name}\""
-          else
-            ":#{singular_name}"
-          end
+          NameHelper.format_for_migration(singular_name)
         end
 
         def formatted_table_name
-          name = table_name["table_name"] || table_name["on"]
-
-          if name.nil?
-            raise(
-              ArgumentError,
-              "Either `table_name:NAME` or `on:NAME` must be specified"
-            )
-          end
-
-          if name.include?(".")
-            "\"#{name}\""
-          else
-            ":#{name}"
-          end
+          NameHelper.format_table_name_from_hash(table_name)
         end
       end
 
       private
 
-      def version_regex
-        /\A#{file_name}_v(?<version>\d+)\.sql\z/
-      end
-
-      def updating_existing_trigger?
-        previous_version > 0
+      def trigger_definition_path
+        @_trigger_definition_path ||= Rails.root.join(*DEFINITION_PATH)
       end
 
-      def definition
-        Fx::Definition.trigger(name: file_name, version: version)
+      def version_helper
+        @_version_helper ||= Fx::Generators::VersionHelper.new(
+          file_name: file_name,
+          definition_path: trigger_definition_path
+        )
       end
 
-      def trigger_definition_path
-        @_trigger_definition_path ||= Rails.root.join("db", "triggers")
+      def migration_helper
+        @_migration_helper ||= Fx::Generators::MigrationHelper.new(options)
       end
 
-      # Skip creating migration file if:
-      #   - migrations option is nil or false
-      def skip_migration_creation?
-        !migration
+      def definition
+        version_helper.definition_for_version(version: version, type: :trigger)
       end
 
-      # True unless explicitly false
-      def migration
-        options[:migration] != false
+      def updating_existing_trigger?
+        version_helper.updating_existing?
       end
     end
   end

data/lib/generators/fx/version_helper.rb

@@ -0,0 +1,55 @@
+module Fx
+  module Generators
+    # @api private
+    class VersionHelper
+      def initialize(file_name:, definition_path:)
+        @file_name = file_name
+        @definition_path = definition_path
+      end
+
+      def previous_version
+        @previous_version ||= existing_versions.max || 0
+      end
+
+      def current_version
+        previous_version.next
+      end
+
+      def updating_existing?
+        previous_version > 0
+      end
+
+      def creating_new?
+        previous_version == 0
+      end
+
+      def definition_for_version(version:, type:)
+        case type
+        when :function
+          Fx::Definition.function(name: file_name, version: version)
+        when :trigger
+          Fx::Definition.trigger(name: file_name, version: version)
+        else
+          raise(
+            ArgumentError,
+            "Unknown type: #{type}. Must be :function or :trigger"
+          )
+        end
+      end
+
+      private
+
+      VERSION_PATTERN = /v(\d+)/
+      private_constant :VERSION_PATTERN
+
+      attr_reader :file_name, :definition_path
+
+      def existing_versions
+        Dir
+          .glob("#{file_name}_v*.sql", base: definition_path)
+          .map { |file| file[VERSION_PATTERN, 1].to_i }
+          .compact
+      end
+    end
+  end
+end

data/spec/acceptance/user_manages_functions_spec.rb

@@ -3,14 +3,14 @@ require "acceptance_helper"
 RSpec.describe "User manages functions" do
   it "handles simple functions" do
     successfully "rails generate fx:function test"
-    write_function_definition "test_v01", <<~EOS
+    write_function_definition "test_v01", <<~SQL
       CREATE OR REPLACE FUNCTION test()
       RETURNS text AS $$
       BEGIN
           RETURN 'test';
       END;
       $$ LANGUAGE plpgsql;
-    EOS
+    SQL
     successfully "rake db:migrate"
 
     result = execute("SELECT * FROM test() AS result")
@@ -21,14 +21,14 @@ RSpec.describe "User manages functions" do
       "db/functions/test_v01.sql",
       "db/functions/test_v02.sql"
     )
-    write_function_definition "test_v02", <<~EOS
+    write_function_definition "test_v02", <<~SQL
       CREATE OR REPLACE FUNCTION test()
       RETURNS text AS $$
       BEGIN
           RETURN 'testest';
       END;
       $$ LANGUAGE plpgsql;
-    EOS
+    SQL
     successfully "rake db:migrate"
 
     result = execute("SELECT * FROM test() AS result")
@@ -37,14 +37,14 @@ RSpec.describe "User manages functions" do
 
   it "handles functions with arguments" do
     successfully "rails generate fx:function adder"
-    write_function_definition "adder_v01", <<~EOS
+    write_function_definition "adder_v01", <<~SQL
       CREATE FUNCTION adder(x int, y int)
       RETURNS int AS $$
       BEGIN
           RETURN $1 + $2;
       END;
       $$ LANGUAGE plpgsql;
-    EOS
+    SQL
     successfully "rake db:migrate"
 
     result = execute("SELECT * FROM adder(1, 2) AS result")

data/spec/acceptance/user_manages_triggers_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe "User manages triggers" do
   it "handles simple triggers" do
     successfully "rails generate model user name:string upper_name:string"
     successfully "rails generate fx:function uppercase_users_name"
-    write_function_definition "uppercase_users_name_v01", <<~EOS
+    write_function_definition "uppercase_users_name_v01", <<~SQL
       CREATE OR REPLACE FUNCTION uppercase_users_name()
       RETURNS trigger AS $$
       BEGIN
@@ -12,38 +12,38 @@ RSpec.describe "User manages triggers" do
         RETURN NEW;
       END;
       $$ LANGUAGE plpgsql;
-    EOS
+    SQL
     successfully "rails generate fx:trigger uppercase_users_name table_name:users"
-    write_trigger_definition "uppercase_users_name_v01", <<~EOS
+    write_trigger_definition "uppercase_users_name_v01", <<~SQL
       CREATE TRIGGER uppercase_users_name
           BEFORE INSERT ON users
           FOR EACH ROW
           EXECUTE FUNCTION uppercase_users_name();
-    EOS
+    SQL
     successfully "rake db:migrate"
 
-    execute <<~EOS
+    execute <<~SQL
       INSERT INTO users
       (name, created_at, updated_at)
       VALUES
       ('Bob', NOW(), NOW());
-    EOS
+    SQL
     result = execute("SELECT upper_name FROM users WHERE name = 'Bob';")
     expect(result).to eq("upper_name" => "BOB")
 
     successfully "rails generate fx:trigger uppercase_users_name table_name:users"
-    write_trigger_definition "uppercase_users_name_v02", <<~EOS
+    write_trigger_definition "uppercase_users_name_v02", <<~SQL
       CREATE TRIGGER uppercase_users_name
           BEFORE UPDATE ON users
           FOR EACH ROW
           EXECUTE FUNCTION uppercase_users_name();
-    EOS
+    SQL
     successfully "rake db:migrate"
-    execute <<~EOS
+    execute <<~SQL
       UPDATE users
       SET name = 'Alice'
       WHERE id = 1;
-    EOS
+    SQL
 
     result = execute("SELECT upper_name FROM users WHERE name = 'Alice';")
     expect(result).to eq("upper_name" => "ALICE")

data/spec/acceptance_helper.rb

@@ -13,8 +13,8 @@ RSpec.configure do |config|
     Dir.chdir("spec/dummy") do
       system <<~CMD
         git init -b master 1>/dev/null &&
-        git config user.email "fx@example.com"
-        git config user.name "Fx"
+        git config user.email "fx@example.com" &&
+        git config user.name "Fx" &&
         git add -A &&
         git commit --no-gpg-sign --message 'initial' 1>/dev/null
       CMD

data/spec/features/functions/migrations_spec.rb

@@ -2,14 +2,14 @@ require "spec_helper"
 
 RSpec.describe "Function migrations", :db do
   around do |example|
-    sql_definition = <<~EOS
+    sql_definition = <<~SQL
       CREATE OR REPLACE FUNCTION test()
       RETURNS text AS $$
       BEGIN
           RETURN 'test';
       END;
       $$ LANGUAGE plpgsql;
-    EOS
+    SQL
     with_function_definition(name: :test, sql_definition: sql_definition) do
       example.run
     end
@@ -40,14 +40,14 @@ RSpec.describe "Function migrations", :db do
   it "can run migrations that updates functions" do
     connection.create_function(:test)
 
-    sql_definition = <<~EOS
+    sql_definition = <<~SQL
       CREATE OR REPLACE FUNCTION test()
       RETURNS text AS $$
       BEGIN
           RETURN 'testest';
       END;
       $$ LANGUAGE plpgsql;
-    EOS
+    SQL
     with_function_definition(
       name: :test,
       version: 2,

data/spec/features/functions/revert_spec.rb

@@ -2,14 +2,14 @@ require "spec_helper"
 
 RSpec.describe "Reverting migrations", :db do
   around do |example|
-    sql_definition = <<~EOS
+    sql_definition = <<~SQL
       CREATE OR REPLACE FUNCTION test()
       RETURNS text AS $$
       BEGIN
           RETURN 'test';
       END;
       $$ LANGUAGE plpgsql;
-    EOS
+    SQL
     with_function_definition(name: :test, sql_definition: sql_definition) do
       example.run
     end
@@ -50,14 +50,14 @@ RSpec.describe "Reverting migrations", :db do
   it "can run reversible migrations for updating functions" do
     connection.create_function(:test)
 
-    sql_definition = <<~EOS
+    sql_definition = <<~SQL
       CREATE OR REPLACE FUNCTION test()
       RETURNS text AS $$
       BEGIN
         RETURN 'bar';
       END;
       $$ LANGUAGE plpgsql;
-    EOS
+    SQL
     with_function_definition(
       name: :test,
       version: 2,

data/spec/features/triggers/migrations_spec.rb

@@ -2,14 +2,14 @@ require "spec_helper"
 
 RSpec.describe "Trigger migrations", :db do
   around do |example|
-    connection.execute <<~EOS
+    connection.execute <<~SQL
       CREATE TABLE users (
           id int PRIMARY KEY,
           name varchar(256),
           upper_name varchar(256)
       );
-    EOS
-    Fx.database.create_function <<~EOS
+    SQL
+    Fx.database.create_function <<~SQL
       CREATE OR REPLACE FUNCTION uppercase_users_name()
       RETURNS trigger AS $$
       BEGIN
@@ -17,13 +17,13 @@ RSpec.describe "Trigger migrations", :db do
         RETURN NEW;
       END;
       $$ LANGUAGE plpgsql;
-    EOS
-    sql_definition = <<~EOS
+    SQL
+    sql_definition = <<~SQL
       CREATE TRIGGER uppercase_users_name
           BEFORE INSERT ON users
           FOR EACH ROW
           EXECUTE FUNCTION uppercase_users_name();
-    EOS
+    SQL
     with_trigger_definition(
       name: :uppercase_users_name,
       sql_definition: sql_definition

data/spec/features/triggers/revert_spec.rb

@@ -2,14 +2,14 @@ require "spec_helper"
 
 RSpec.describe "Reverting migrations", :db do
   around do |example|
-    connection.execute <<~EOS
+    connection.execute <<~SQL
       CREATE TABLE users (
           id int PRIMARY KEY,
           name varchar(256),
           upper_name varchar(256)
       );
-    EOS
-    Fx.database.create_function <<~EOS
+    SQL
+    Fx.database.create_function <<~SQL
       CREATE OR REPLACE FUNCTION uppercase_users_name()
       RETURNS trigger AS $$
       BEGIN
@@ -17,13 +17,13 @@ RSpec.describe "Reverting migrations", :db do
         RETURN NEW;
       END;
       $$ LANGUAGE plpgsql;
-    EOS
-    sql_definition = <<~EOS
+    SQL
+    sql_definition = <<~SQL
       CREATE TRIGGER uppercase_users_name
           BEFORE INSERT ON users
           FOR EACH ROW
           EXECUTE FUNCTION uppercase_users_name();
-    EOS
+    SQL
     with_trigger_definition(
       name: :uppercase_users_name,
       sql_definition: sql_definition
@@ -67,12 +67,12 @@ RSpec.describe "Reverting migrations", :db do
   it "can run reversible migrations for updating triggers" do
     connection.create_trigger(:uppercase_users_name)
 
-    sql_definition = <<~EOS
+    sql_definition = <<~SQL
       CREATE TRIGGER uppercase_users_name
           BEFORE UPDATE ON users
           FOR EACH ROW
           EXECUTE FUNCTION uppercase_users_name();
-    EOS
+    SQL
     with_trigger_definition(
       name: :uppercase_users_name,
       sql_definition: sql_definition,

data/spec/fx/adapters/postgres/functions_spec.rb

@@ -4,21 +4,21 @@ RSpec.describe Fx::Adapters::Postgres::Functions, :db do
   describe ".all" do
     it "returns `Function` objects" do
       connection = ActiveRecord::Base.connection
-      connection.execute <<~EOS
+      connection.execute <<~SQL
         CREATE OR REPLACE FUNCTION test()
         RETURNS text AS $$
         BEGIN
             RETURN 'test';
         END;
         $$ LANGUAGE plpgsql;
-      EOS
+      SQL
 
-      functions = Fx::Adapters::Postgres::Functions.new(connection).all
+      functions = Fx::Adapters::Postgres::Functions.all(connection)
 
       first = functions.first
       expect(functions.size).to eq(1)
       expect(first.name).to eq("test")
-      expect(first.definition).to eq(<<~EOS)
+      expect(first.definition).to eq(<<~SQL)
         CREATE OR REPLACE FUNCTION public.test()
          RETURNS text
          LANGUAGE plpgsql
@@ -27,7 +27,14 @@ RSpec.describe Fx::Adapters::Postgres::Functions, :db do
             RETURN 'test';
         END;
         $function$
-      EOS
+      SQL
+
+      connection.execute "CREATE SCHEMA IF NOT EXISTS other;"
+      connection.execute "SET search_path = 'other';"
+
+      functions = Fx::Adapters::Postgres::Functions.all(connection)
+
+      expect(functions).to be_empty
     end
   end
 end

data/spec/fx/adapters/postgres/query_executor_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+RSpec.describe Fx::Adapters::Postgres::QueryExecutor, :db do
+  it "executes the query and maps results to objects" do
+    connection = ActiveRecord::Base.connection
+    query = "SELECT 'Hello World' as message, 'english' as language"
+    greeter = Class.new do
+      attr_reader :message, :language
+
+      def initialize(row)
+        @message = row.fetch("message")
+        @language = row.fetch("language")
+      end
+    end
+
+    results = described_class.call(
+      connection: connection,
+      query: query,
+      model_class: greeter
+    )
+
+    expect(results.size).to eq(1)
+    expect(results.first).to be_a(greeter)
+    expect(results.first.message).to eq("Hello World")
+    expect(results.first.language).to eq("english")
+  end
+
+  it "executes query with multiple results" do
+    connection = ActiveRecord::Base.connection
+    query = <<~SQL
+      SELECT 'first' as name
+      UNION ALL
+      SELECT 'second' as name
+      ORDER BY name
+    SQL
+    simple_name = Class.new do
+      attr_reader :name
+
+      def initialize(row)
+        @name = row.fetch("name")
+      end
+    end
+
+    results = described_class.call(
+      connection: connection,
+      query: query,
+      model_class: simple_name
+    )
+
+    expect(results.size).to eq(2)
+    expect(results).to all(be_a(simple_name))
+    expect(results.first.name).to eq("first")
+    expect(results.last.name).to eq("second")
+  end
+
+  it "returns an empty array when query returns no results" do
+    connection = ActiveRecord::Base.connection
+    query = "SELECT 'test' as name WHERE 1 = 0"
+    simple_name = Class.new do
+      attr_reader :name
+
+      def initialize(row)
+        @name = row.fetch("name")
+      end
+    end
+
+    results = described_class.call(
+      connection: connection,
+      query: query,
+      model_class: simple_name
+    )
+
+    expect(results).to eq([])
+  end
+end

data/spec/fx/adapters/postgres/triggers_spec.rb

@@ -4,14 +4,14 @@ RSpec.describe Fx::Adapters::Postgres::Triggers, :db do
   describe ".all" do
     it "returns `Trigger` objects" do
       connection = ActiveRecord::Base.connection
-      connection.execute <<~EOS
+      connection.execute <<~SQL
         CREATE TABLE users (
             id int PRIMARY KEY,
             name varchar(256),
             upper_name varchar(256)
         );
-      EOS
-      connection.execute <<~EOS
+      SQL
+      connection.execute <<~SQL
         CREATE OR REPLACE FUNCTION uppercase_users_name()
         RETURNS trigger AS $$
         BEGIN
@@ -19,15 +19,15 @@ RSpec.describe Fx::Adapters::Postgres::Triggers, :db do
           RETURN NEW;
         END;
         $$ LANGUAGE plpgsql;
-      EOS
-      connection.execute <<~EOS
+      SQL
+      connection.execute <<~SQL
         CREATE TRIGGER uppercase_users_name
             BEFORE INSERT ON users
             FOR EACH ROW
             EXECUTE FUNCTION uppercase_users_name();
-      EOS
+      SQL
 
-      triggers = Fx::Adapters::Postgres::Triggers.new(connection).all
+      triggers = Fx::Adapters::Postgres::Triggers.all(connection)
 
       first = triggers.first
       expect(triggers.size).to eq(1)
@@ -36,6 +36,13 @@ RSpec.describe Fx::Adapters::Postgres::Triggers, :db do
       expect(first.definition).to match(/ON [public.ser|]/)
       expect(first.definition).to include("FOR EACH ROW")
       expect(first.definition).to include("EXECUTE FUNCTION uppercase_users_name()")
+
+      connection.execute "CREATE SCHEMA IF NOT EXISTS other;"
+      connection.execute "SET search_path = 'other';"
+
+      triggers = Fx::Adapters::Postgres::Triggers.all(connection)
+
+      expect(triggers).to be_empty
     end
   end
 end