fx 0.8.0 → 0.10.0

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

@@ -1,42 +1,49 @@
 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 FunctionGenerator < Rails::Generators::NamedBase
       include Rails::Generators::Migration
+
       source_root File.expand_path("../templates", __FILE__)
 
+      DEFINITION_PATH = %w[db functions].freeze
+
       class_option :migration, type: :boolean
 
       def create_functions_directory
-        unless function_definition_path.exist?
-          empty_directory(function_definition_path)
-        end
+        return if function_definition_path.exist?
+
+        empty_directory(function_definition_path)
       end
 
       def create_function_definition
-        if creating_new_function?
-          create_file definition.path
+        if version_helper.creating_new?
+          create_file(definition.path)
         else
-          copy_file previous_definition.full_path, definition.full_path
+          copy_file(previous_definition.full_path, definition.full_path)
         end
       end
 
       def create_migration_file
-        return if skip_migration_creation?
-        if updating_existing_function?
-          migration_template(
-            "db/migrate/update_function.erb",
-            "db/migrate/update_function_#{file_name}_to_version_#{version}.rb"
-          )
-        else
-          migration_template(
-            "db/migrate/create_function.erb",
-            "db/migrate/create_function_#{file_name}.rb"
-          )
-        end
+        return if migration_helper.skip_creation?
+
+        template_info = migration_helper.migration_template_info(
+          object_type: :function,
+          file_name: file_name,
+          updating_existing: version_helper.updating_existing?,
+          version: version_helper.current_version
+        )
+
+        migration_template(
+          template_info.fetch(:template),
+          template_info.fetch(:filename)
+        )
       end
 
       def self.next_migration_number(dir)
@@ -45,75 +52,65 @@ module Fx
 
       no_tasks do
         def previous_version
-          @_previous_version ||= Dir.entries(function_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_function?
-            "UpdateFunction#{class_name}ToVersion#{version}"
+          if version_helper.updating_existing?
+            migration_helper.update_migration_class_name(
+              object_type: :function,
+              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
       end
 
       private
 
       def function_definition_path
-        @_function_definition_path ||= Rails.root.join(*%w[db functions])
-      end
-
-      def version_regex
-        /\A#{file_name}_v(?<version>\d+)\.sql\z/
+        @_function_definition_path ||= Rails.root.join(*DEFINITION_PATH)
       end
 
-      def updating_existing_function?
-        previous_version > 0
+      def version_helper
+        @_version_helper ||= Fx::Generators::VersionHelper.new(
+          file_name: file_name,
+          definition_path: function_definition_path
+        )
       end
 
-      def creating_new_function?
-        previous_version == 0
+      def migration_helper
+        @_migration_helper ||= Fx::Generators::MigrationHelper.new(options)
       end
 
       def definition
-        Fx::Definition.new(name: file_name, version: version)
+        version_helper.definition_for_version(version: version, type: :function)
       end
 
       def previous_definition
-        Fx::Definition.new(name: file_name, version: previous_version)
+        version_helper.definition_for_version(version: previous_version, type: :function)
       end
 
-      # Skip creating migration file if:
-      #   - migrations option is nil or false
-      def skip_migration_creation?
-        !migration
+      def updating_existing_function?
+        version_helper.updating_existing?
       end
 
-      # True unless explicitly false
-      def migration
-        options[:migration] != false
+      def creating_new_function?
+        version_helper.creating_new?
       end
     end
   end

data/lib/generators/fx/function/templates/db/migrate/create_function.erb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < <%= activerecord_migration_class %>
+class <%= migration_class_name %> < <%= active_record_migration_class %>
   def change
     create_function <%= formatted_name %>
   end

data/lib/generators/fx/function/templates/db/migrate/update_function.erb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < <%= activerecord_migration_class %>
+class <%= migration_class_name %> < <%= active_record_migration_class %>
   def change
     update_function <%= formatted_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
   end

data/lib/generators/fx/migration_helper.rb

@@ -0,0 +1,53 @@
+module Fx
+  module Generators
+    # @api private
+    class MigrationHelper
+      def initialize(options)
+        @options = options
+      end
+
+      def skip_creation?
+        !should_create_migration?
+      end
+
+      def active_record_migration_class
+        if ActiveRecord::Migration.respond_to?(:current_version)
+          "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+        else
+          "ActiveRecord::Migration"
+        end
+      end
+
+      def update_migration_class_name(object_type:, class_name:, version:)
+        "Update#{object_type.capitalize}#{class_name}ToVersion#{version}"
+      end
+
+      def migration_template_info(
+        object_type:,
+        file_name:,
+        updating_existing:,
+        version:
+      )
+        if updating_existing
+          {
+            template: "db/migrate/update_#{object_type}.erb",
+            filename: "db/migrate/update_#{object_type}_#{file_name}_to_version_#{version}.rb"
+          }
+        else
+          {
+            template: "db/migrate/create_#{object_type}.erb",
+            filename: "db/migrate/create_#{object_type}_#{file_name}.rb"
+          }
+        end
+      end
+
+      private
+
+      attr_reader :options
+
+      def should_create_migration?
+        options.fetch(:migration, true)
+      end
+    end
+  end
+end

data/lib/generators/fx/name_helper.rb

@@ -0,0 +1,33 @@
+module Fx
+  module Generators
+    # @api private
+    class NameHelper
+      def self.format_for_migration(name)
+        if name.include?(".")
+          "\"#{name}\""
+        else
+          ":#{name}"
+        end
+      end
+
+      def self.format_table_name_from_hash(table_hash)
+        name = table_hash["table_name"] || table_hash["on"]
+
+        if name.nil?
+          raise(
+            ArgumentError,
+            "Either `table_name:NAME` or `on:NAME` must be specified"
+          )
+        end
+
+        format_for_migration(name)
+      end
+
+      def self.validate_and_format(name)
+        raise ArgumentError, "Name cannot be blank" if name.blank?
+
+        format_for_migration(name)
+      end
+    end
+  end
+end

data/lib/generators/fx/trigger/templates/db/migrate/create_trigger.erb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < <%= activerecord_migration_class %>
+class <%= migration_class_name %> < <%= active_record_migration_class %>
   def change
     create_trigger <%= formatted_name %>, on: <%= formatted_table_name %>
   end

data/lib/generators/fx/trigger/templates/db/migrate/update_trigger.erb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < <%= activerecord_migration_class %>
+class <%= migration_class_name %> < <%= active_record_migration_class %>
   def change
     update_trigger <%= formatted_name %>, on: <%= formatted_table_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
   end

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,88 +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.new(
-          name: file_name,
-          version: version,
-          type: "trigger"
+      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

@@ -1,16 +1,16 @@
 require "acceptance_helper"
 
-describe "User manages functions" do
+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 @@ 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 @@ 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

@@ -1,10 +1,10 @@
 require "acceptance_helper"
 
-describe "User manages triggers" do
+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 @@ 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

@@ -11,10 +11,10 @@ RSpec.configure do |config|
 
   config.before(:suite) do
     Dir.chdir("spec/dummy") do
-      system <<-CMD
+      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
@@ -24,7 +24,7 @@ RSpec.configure do |config|
   config.after(:suite) do
     Dir.chdir("spec/dummy") do
       ActiveRecord::Base.connection.disconnect!
-      system <<-CMD
+      system <<~CMD
         echo &&
         rake db:environment:set db:drop db:create 1>/dev/null &&
         git add -A &&

data/spec/dummy/config/application.rb

@@ -12,6 +12,10 @@ module Dummy
     config.eager_load = false
     config.active_support.deprecation = :stderr
 
-    config.active_record.legacy_connection_handling = false
+    config.load_defaults 7.0
+
+    if Rails.version >= "8.0"
+      config.active_support.to_time_preserves_timezone = :zone
+    end
   end
 end