fx 0.9.0 → 0.10.0

data/lib/fx/statements.rb

@@ -4,13 +4,13 @@ module Fx
     # Create a new database function.
     #
     # @param name [String, Symbol] The name of the database function.
-    # @param version [Fixnum] The version number of the function, used to
+    # @param version [Integer] The version number of the function, used to
     #   find the definition file in `db/functions`. This defaults to `1` if
     #   not provided.
     # @param sql_definition [String] The SQL query for the function schema.
     #   If both `sql_definition` and `version` are provided,
-    #   `sql_definition` takes prescedence.
-    # @return The database response from executing the create statement.
+    #   `sql_definition` takes precedence.
+    # @return [void] The database response from executing the create statement.
     #
     # @example Create from `db/functions/uppercase_users_name_v02.sql`
     #   create_function(:uppercase_users_name, version: 2)
@@ -30,14 +30,8 @@ module Fx
       version = options.fetch(:version, 1)
       sql_definition = options[:sql_definition]
 
-      if version.nil? && sql_definition.nil?
-        raise(
-          ArgumentError,
-          "version or sql_definition must be specified"
-        )
-      end
-      sql_definition = sql_definition.strip_heredoc if sql_definition
-      sql_definition ||= Fx::Definition.function(name: name, version: version).to_sql
+      validate_version_or_sql_definition_present!(version, sql_definition)
+      sql_definition = resolve_sql_definition(sql_definition, name, version, :function)
 
       Fx.database.create_function(sql_definition)
     end
@@ -45,10 +39,10 @@ module Fx
     # Drop a database function by name.
     #
     # @param name [String, Symbol] The name of the database function.
-    # @param revert_to_version [Fixnum] Used to reverse the `drop_function`
+    # @param revert_to_version [Integer] Used to reverse the `drop_function`
     #   command on `rake db:rollback`. The provided version will be passed as
     #   the `version` argument to {#create_function}.
-    # @return The database response from executing the drop statement.
+    # @return [void] The database response from executing the drop statement.
     #
     # @example Drop a function, rolling back to version 2 on rollback
     #   drop_function(:uppercase_users_name, revert_to_version: 2)
@@ -60,13 +54,13 @@ module Fx
     # Update a database function.
     #
     # @param name [String, Symbol] The name of the database function.
-    # @param version [Fixnum] The version number of the function, used to
+    # @param version [Integer] The version number of the function, used to
     #   find the definition file in `db/functions`. This defaults to `1` if
     #   not provided.
     # @param sql_definition [String] The SQL query for the function schema.
     #   If both `sql_definition` and `version` are provided,
-    #   `sql_definition` takes prescedence.
-    # @return The database response from executing the create statement.
+    #   `sql_definition` takes precedence.
+    # @return [void] The database response from executing the create statement.
     #
     # @example Update function to a given version
     #   update_function(
@@ -90,15 +84,9 @@ module Fx
       version = options[:version]
       sql_definition = options[:sql_definition]
 
-      if version.nil? && sql_definition.nil?
-        raise(
-          ArgumentError,
-          "version or sql_definition must be specified"
-        )
-      end
+      validate_version_or_sql_definition_present!(version, sql_definition)
 
-      sql_definition = sql_definition.strip_heredoc if sql_definition
-      sql_definition ||= Fx::Definition.function(name: name, version: version).to_sql
+      sql_definition = resolve_sql_definition(sql_definition, name, version, :function)
 
       Fx.database.update_function(name, sql_definition)
     end
@@ -106,13 +94,13 @@ module Fx
     # Create a new database trigger.
     #
     # @param name [String, Symbol] The name of the database trigger.
-    # @param version [Fixnum] The version number of the trigger, used to
+    # @param version [Integer] The version number of the trigger, used to
     #   find the definition file in `db/triggers`. This defaults to `1` if
     #   not provided.
     # @param sql_definition [String] The SQL query for the function. An error
     #   will be raised if `sql_definition` and `version` are both set,
     #   as they are mutually exclusive.
-    # @return The database response from executing the create statement.
+    # @return [void] The database response from executing the create statement.
     #
     # @example Create trigger from `db/triggers/uppercase_users_name_v01.sql`
     #   create_trigger(:uppercase_users_name, version: 1)
@@ -127,22 +115,13 @@ module Fx
     #
     def create_trigger(name, options = {})
       version = options[:version]
-      _on = options[:on]
       sql_definition = options[:sql_definition]
 
-      if version.present? && sql_definition.present?
-        raise(
-          ArgumentError,
-          "sql_definition and version cannot both be set"
-        )
-      end
+      validate_version_and_sql_definition_exclusive!(version, sql_definition)
 
-      if version.nil?
-        version = 1
-      end
+      version ||= 1
 
-      sql_definition = sql_definition.strip_heredoc if sql_definition
-      sql_definition ||= Fx::Definition.trigger(name: name, version: version).to_sql
+      sql_definition = resolve_sql_definition(sql_definition, name, version, :trigger)
 
       Fx.database.create_trigger(sql_definition)
     end
@@ -152,10 +131,10 @@ module Fx
     # @param name [String, Symbol] The name of the database trigger.
     # @param on [String, Symbol] The name of the table the database trigger
     #   is associated with.
-    # @param revert_to_version [Fixnum] Used to reverse the `drop_trigger`
+    # @param revert_to_version [Integer] Used to reverse the `drop_trigger`
     #   command on `rake db:rollback`. The provided version will be passed as
     #   the `version` argument to {#create_trigger}.
-    # @return The database response from executing the drop statement.
+    # @return [void] The database response from executing the drop statement.
     #
     # @example Drop a trigger, rolling back to version 3 on rollback
     #   drop_trigger(:log_inserts, on: :users, revert_to_version: 3)
@@ -171,15 +150,15 @@ module Fx
     # and `version` parameter.
     #
     # @param name [String, Symbol] The name of the database trigger.
-    # @param version [Fixnum] The version number of the trigger.
+    # @param version [Integer] The version number of the trigger.
     # @param on [String, Symbol] The name of the table the database trigger
     #   is associated with.
     # @param sql_definition [String] The SQL query for the function. An error
     #   will be raised if `sql_definition` and `version` are both set,
     #   as they are mutually exclusive.
-    # @param revert_to_version [Fixnum] The version number to rollback to on
+    # @param revert_to_version [Integer] The version number to rollback to on
     #   `rake db rollback`
-    # @return The database response from executing the create statement.
+    # @return [void] The database response from executing the create statement.
     #
     # @example Update trigger to a given version
     #   update_trigger(
@@ -202,26 +181,14 @@ module Fx
       on = options[:on]
       sql_definition = options[:sql_definition]
 
-      if version.nil? && sql_definition.nil?
-        raise(
-          ArgumentError,
-          "version or sql_definition must be specified"
-        )
-      end
-
-      if version.present? && sql_definition.present?
-        raise(
-          ArgumentError,
-          "sql_definition and version cannot both be set"
-        )
-      end
+      validate_version_or_sql_definition_present!(version, sql_definition)
+      validate_version_and_sql_definition_exclusive!(version, sql_definition)
 
       if on.nil?
         raise ArgumentError, "on is required"
       end
 
-      sql_definition = sql_definition.strip_heredoc if sql_definition
-      sql_definition ||= Fx::Definition.trigger(name: name, version: version).to_sql
+      sql_definition = resolve_sql_definition(sql_definition, name, version, :trigger)
 
       Fx.database.update_trigger(
         name,
@@ -229,5 +196,41 @@ module Fx
         sql_definition: sql_definition
       )
     end
+
+    private
+
+    VERSION_OR_SQL_DEFINITION_REQUIRED = "version or sql_definition must be specified".freeze
+    private_constant :VERSION_OR_SQL_DEFINITION_REQUIRED
+
+    VERSION_AND_SQL_DEFINITION_EXCLUSIVE = "sql_definition and version cannot both be set".freeze
+    private_constant :VERSION_AND_SQL_DEFINITION_EXCLUSIVE
+
+    def validate_version_or_sql_definition_present!(version, sql_definition)
+      if version.nil? && sql_definition.nil?
+        raise ArgumentError, VERSION_OR_SQL_DEFINITION_REQUIRED, caller
+      end
+    end
+
+    def validate_version_and_sql_definition_exclusive!(version, sql_definition)
+      if version.present? && sql_definition.present?
+        raise ArgumentError, VERSION_AND_SQL_DEFINITION_EXCLUSIVE, caller
+      end
+    end
+
+    def resolve_sql_definition(sql_definition, name, version, type)
+      return sql_definition.strip_heredoc if sql_definition
+
+      definition =
+        case type
+        when :function
+          Fx::Definition.function(name: name, version: version)
+        when :trigger
+          Fx::Definition.trigger(name: name, version: version)
+        else
+          raise ArgumentError, "Unknown type: #{type}. Must be :function or :trigger", caller
+        end
+
+      definition.to_sql
+    end
   end
 end

data/lib/fx/version.rb

@@ -1,4 +1,4 @@
 module Fx
   # @api private
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

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.function(name: file_name, version: version)
+        version_helper.definition_for_version(version: version, type: :function)
       end
 
       def previous_definition
-        Fx::Definition.function(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