fx 0.1.0 → 0.11.0

data/bin/setup

@@ -5,8 +5,5 @@ set -e
 gem install bundler --conservative
 bundle check || bundle install
 
-if [ -z "$CI" ]; then
-  bundle exec appraisal install
-fi
-
+bundle exec rake dummy:db:drop
 bundle exec rake dummy:db:create

data/bin/standardrb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/bin/yard

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -7,9 +8,18 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
 
 require "rubygems"
 require "bundler/setup"

data/fx.gemspec

@@ -1,38 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "fx/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "fx"
-  spec.version       = Fx::VERSION
-  spec.authors       = ["Teo Ljungberg"]
-  spec.email         = ["teo@teoljungberg.com"]
-  spec.summary       = %q{Support for database functions and triggers in Rails migrations}
-  spec.description   = <<-DESCRIPTION
+  spec.name = "fx"
+  spec.version = Fx::VERSION
+  spec.authors = ["Teo Ljungberg"]
+  spec.email = ["teo@teoljungberg.com"]
+  spec.summary = "Support for database functions and triggers in Rails migrations"
+  spec.description = <<~DESCRIPTION
     Adds methods to ActiveRecord::Migration to create and manage database functions
     and triggers in Rails
   DESCRIPTION
-  spec.homepage      = "https://github.com/teoljungberg/fx"
-  spec.license       = 'MIT'
+  spec.homepage = "https://github.com/teoljungberg/fx"
+  spec.license = "MIT"
+  spec.metadata = {
+    "bug_tracker_uri" => "#{spec.homepage}/issues",
+    "changelog_uri" => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md",
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage
+  }
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^spec/})
-  spec.require_paths = ['lib']
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "bundler", '>= 1.5'
-  spec.add_development_dependency "database_cleaner"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", '>= 3.3'
-  spec.add_development_dependency "pg"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "ammeter", '>= 1.1.3'
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "redcarpet"
+  spec.add_dependency "activerecord", ">= 7.2"
+  spec.add_dependency "railties", ">= 7.2"
 
-  spec.add_dependency "activerecord", '>= 4.0.0'
-  spec.add_dependency "railties", '>= 4.0.0'
-
-  spec.required_ruby_version = "~> 2.1"
+  spec.required_ruby_version = ">= 3.3"
 end

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

@@ -10,6 +10,12 @@ module Fx
       #
       # @api private
       class Connection < SimpleDelegator
+        # All supported PostgreSQL versions (14+) support DROP FUNCTION
+        # without argument lists.
+        # https://www.postgresql.org/docs/10/sql-dropfunction.html
+        def support_drop_function_without_args
+          true
+        end
       end
     end
   end

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

@@ -1,4 +1,5 @@
 require "fx/function"
+require "fx/adapters/postgres/query_executor"
 
 module Fx
   module Adapters
@@ -8,46 +9,33 @@ module Fx
       class Functions
         # The SQL query used by F(x) to retrieve the functions considered
         # dumpable into `db/schema.rb`.
-        FUNCTIONS_WITH_DEFINITIONS_QUERY = <<~SQL
+        FUNCTIONS_WITH_DEFINITIONS_QUERY = <<~SQL.freeze
           SELECT
               pp.proname AS name,
-              pg_get_functiondef(pp.oid) AS definition
+              pg_get_functiondef(pp.oid) AS definition,
+              pg_get_function_identity_arguments(pp.oid) AS arguments
           FROM pg_proc pp
           JOIN pg_namespace pn
               ON pn.oid = pp.pronamespace
           LEFT JOIN pg_depend pd
               ON pd.objid = pp.oid AND pd.deptype = 'e'
-          WHERE pn.nspname = 'public' AND pd.objid IS NULL;
+          LEFT JOIN pg_aggregate pa
+              ON pa.aggfnoid = pp.oid
+          WHERE pn.nspname = ANY (current_schemas(false))
+              AND pd.objid IS NULL
+              AND pa.aggfnoid IS NULL
+          ORDER BY pp.oid;
         SQL
 
         # Wraps #all as a static facade.
         #
         # @return [Array<Fx::Function>]
-        def self.all(*args)
-          new(*args).all
-        end
-
-        def initialize(connection)
-          @connection = connection
-        end
-
-        # All of the functions that this connection has defined.
-        #
-        # @return [Array<Fx::Function>]
-        def all
-          functions_from_postgres.map { |function| to_fx_function(function) }
-        end
-
-        private
-
-        attr_reader :connection
-
-        def functions_from_postgres
-          connection.execute(FUNCTIONS_WITH_DEFINITIONS_QUERY)
-        end
-
-        def to_fx_function(result)
-          Fx::Function.new(result)
+        def self.all(connection)
+          Fx::Adapters::Postgres::QueryExecutor.call(
+            connection: connection,
+            query: FUNCTIONS_WITH_DEFINITIONS_QUERY,
+            model_class: Fx::Function
+          )
         end
       end
     end

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

@@ -0,0 +1,34 @@
+module Fx
+  module Adapters
+    class Postgres
+      # Executes database queries and maps results to domain objects.
+      # @api private
+      class QueryExecutor
+        def self.call(...)
+          new(...).call
+        end
+
+        def initialize(connection:, query:, model_class:)
+          @connection = connection
+          @query = query
+          @model_class = model_class
+        end
+
+        # Executes the query and maps results to domain objects.
+        #
+        # @return [Array] Array of domain objects (Functions or Triggers)
+        def call
+          results_from_postgres.map { |result| model_class.new(result) }
+        end
+
+        private
+
+        attr_reader :connection, :query, :model_class
+
+        def results_from_postgres
+          connection.execute(query)
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 require "fx/trigger"
+require "fx/adapters/postgres/query_executor"
 
 module Fx
   module Adapters
@@ -8,7 +9,7 @@ module Fx
       class Triggers
         # The SQL query used by F(x) to retrieve the triggers considered
         # dumpable into `db/schema.rb`.
-        TRIGGERS_WITH_DEFINITIONS_QUERY = <<~SQL
+        TRIGGERS_WITH_DEFINITIONS_QUERY = <<~SQL.freeze
           SELECT
               pt.tgname AS name,
               pg_get_triggerdef(pt.oid) AS definition
@@ -17,38 +18,23 @@ module Fx
               ON (pc.oid = pt.tgrelid)
           JOIN pg_proc pp
               ON (pp.oid = pt.tgfoid)
-          WHERE pt.tgname
-          NOT ILIKE '%constraint%' AND pt.tgname NOT ILIKE 'pg%';
+          JOIN pg_namespace pn
+              ON pn.oid = pc.relnamespace
+          WHERE pn.nspname = ANY (current_schemas(false))
+              AND pt.tgname NOT ILIKE '%constraint%'
+              AND pt.tgname NOT ILIKE 'pg%'
+          ORDER BY pc.oid;
         SQL
 
         # Wraps #all as a static facade.
         #
         # @return [Array<Fx::Trigger>]
-        def self.all(*args)
-          new(*args).all
-        end
-
-        def initialize(connection)
-          @connection = connection
-        end
-
-        # All of the triggers that this connection has defined.
-        #
-        # @return [Array<Fx::Trigger>]
-        def all
-          triggers_from_postgres.map { |trigger| to_fx_trigger(trigger) }
-        end
-
-        private
-
-        attr_reader :connection
-
-        def triggers_from_postgres
-          connection.execute(TRIGGERS_WITH_DEFINITIONS_QUERY)
-        end
-
-        def to_fx_trigger(result)
-          Fx::Trigger.new(result)
+        def self.all(connection)
+          Fx::Adapters::Postgres::QueryExecutor.call(
+            connection: connection,
+            query: TRIGGERS_WITH_DEFINITIONS_QUERY,
+            model_class: Fx::Trigger
+          )
         end
       end
     end

data/lib/fx/adapters/postgres.rb

@@ -23,6 +23,19 @@ module Fx
     #    config.adapter = Fx::Adapters::Postgres.new
     #  end
     class Postgres
+      # Creates an instance of the F(x) Postgres adapter.
+      #
+      # This is the default adapter for F(x). Configuring it via
+      # {Fx.configure} is not required, but the example below shows how one
+      # would explicitly set it.
+      #
+      # @param [#connection] connectable An object that returns the connection
+      #   for F(x) to use. Defaults to `ActiveRecord::Base`.
+      #
+      # @example
+      #  Fx.configure do |config|
+      #    config.adapter = Fx::Adapters::Postgres.new
+      #  end
       def initialize(connectable = ActiveRecord::Base)
         @connectable = connectable
       end
@@ -34,7 +47,7 @@ module Fx
       #
       # @return [Array<Fx::Function>]
       def functions
-        Functions.all(connection)
+        Fx::Adapters::Postgres::Functions.all(connection)
       end
 
       # Returns an array of triggers in the database.
@@ -44,7 +57,7 @@ module Fx
       #
       # @return [Array<Fx::Trigger>]
       def triggers
-        Triggers.all(connection)
+        Fx::Adapters::Postgres::Triggers.all(connection)
       end
 
       # Creates a function in the database.
@@ -52,11 +65,11 @@ module Fx
       # This is typically called in a migration via
       # {Fx::Statements::Function#create_function}.
       #
-      # @param sql_definition The SQL schema for the function.
+      # @param sql_definition [String] The SQL schema for the function.
       #
       # @return [void]
       def create_function(sql_definition)
-        execute sql_definition
+        execute(sql_definition)
       end
 
       # Creates a trigger in the database.
@@ -64,11 +77,11 @@ module Fx
       # This is typically called in a migration via
       # {Fx::Statements::Trigger#create_trigger}.
       #
-      # @param sql_definition The SQL schema for the trigger.
+      # @param sql_definition [String] The SQL schema for the trigger.
       #
       # @return [void]
       def create_trigger(sql_definition)
-        execute sql_definition
+        execute(sql_definition)
       end
 
       # Updates a function in the database.
@@ -76,8 +89,8 @@ module Fx
       # This is typically called in a migration via
       # {Fx::Statements::Function#update_function}.
       #
-      # @param name The name of the function.
-      # @param sql_definition The SQL schema for the function.
+      # @param name [String, Symbol] The name of the function.
+      # @param sql_definition [String] The SQL schema for the function.
       #
       # @return [void]
       def update_function(name, sql_definition)
@@ -93,9 +106,9 @@ module Fx
       # This is typically called in a migration via
       # {Fx::Statements::Function#update_trigger}.
       #
-      # @param name The name of the trigger.
-      # @param on The associated table for the trigger to drop
-      # @param sql_definition The SQL schema for the function.
+      # @param name [String, Symbol] The name of the trigger.
+      # @param on [String, Symbol] The associated table for the trigger to update
+      # @param sql_definition [String] The SQL schema for the trigger.
       #
       # @return [void]
       def update_trigger(name, on:, sql_definition:)
@@ -108,11 +121,11 @@ module Fx
       # This is typically called in a migration via
       # {Fx::Statements::Function#drop_function}.
       #
-      # @param name The name of the function to drop
+      # @param name [String, Symbol] The name of the function to drop
       #
       # @return [void]
       def drop_function(name)
-        execute "DROP FUNCTION #{name}();"
+        execute("DROP FUNCTION #{name};")
       end
 
       # Drops the trigger from the database
@@ -120,12 +133,12 @@ module Fx
       # This is typically called in a migration via
       # {Fx::Statements::Trigger#drop_trigger}.
       #
-      # @param name The name of the trigger to drop
-      # @param on The associated table for the trigger to drop
+      # @param name [String, Symbol] The name of the trigger to drop
+      # @param on [String, Symbol] The associated table for the trigger to drop
       #
       # @return [void]
       def drop_trigger(name, on:)
-        execute "DROP TRIGGER #{name} ON #{on};"
+        execute("DROP TRIGGER #{name} ON #{on};")
       end
 
       private
@@ -135,7 +148,7 @@ module Fx
       delegate :execute, to: :connection
 
       def connection
-        Connection.new(connectable.connection)
+        Fx::Adapters::Postgres::Connection.new(connectable.connection)
       end
     end
   end

data/lib/fx/command_recorder.rb

@@ -1,29 +1,120 @@
-require "fx/command_recorder/arguments"
-require "fx/command_recorder/function"
-require "fx/command_recorder/trigger"
-
 module Fx
   # @api private
   module CommandRecorder
-    include Function
-    include Trigger
+    def create_function(*args, &block)
+      record(:create_function, args, &block)
+    end
+    ruby2_keywords :create_function
+
+    def drop_function(*args, &block)
+      record(:drop_function, args, &block)
+    end
+    ruby2_keywords :drop_function
+
+    def update_function(*args, &block)
+      record(:update_function, args, &block)
+    end
+    ruby2_keywords :update_function
+
+    def invert_create_function(args)
+      [:drop_function, args]
+    end
+
+    def invert_drop_function(args)
+      perform_inversion(:create_function, args)
+    end
+
+    def invert_update_function(args)
+      perform_inversion(:update_function, args)
+    end
+
+    def create_trigger(*args, &block)
+      record(:create_trigger, args, &block)
+    end
+    ruby2_keywords :create_trigger
+
+    def drop_trigger(*args, &block)
+      record(:drop_trigger, args, &block)
+    end
+    ruby2_keywords :drop_trigger
+
+    def update_trigger(*args, &block)
+      record(:update_trigger, args, &block)
+    end
+    ruby2_keywords :update_trigger
+
+    def invert_create_trigger(args)
+      [:drop_trigger, args]
+    end
+
+    def invert_drop_trigger(args)
+      perform_inversion(:create_trigger, args)
+    end
+
+    def invert_update_trigger(args)
+      perform_inversion(:update_trigger, args)
+    end
 
     private
 
+    MESSAGE_IRREVERSIBLE = "`%s` is reversible only if given a `revert_to_version`".freeze
+
     def perform_inversion(method, args)
       arguments = Arguments.new(args)
 
       if arguments.revert_to_version.nil?
-        message = "`#{method}` is reversible only if given a `revert_to_version`"
-        raise ActiveRecord::IrreversibleMigration, message
+        raise ActiveRecord::IrreversibleMigration, format(MESSAGE_IRREVERSIBLE, method)
       end
 
       [method, arguments.invert_version.to_a]
     end
+
+    class Arguments
+      def initialize(args)
+        @args = args.freeze
+      end
+
+      def function
+        args.fetch(0)
+      end
+
+      def version
+        options.fetch(:version)
+      end
+
+      def revert_to_version
+        options.fetch(:revert_to_version, nil)
+      end
+
+      def invert_version
+        self.class.new([function, options_for_revert])
+      end
+
+      def to_a
+        args.to_a
+      end
+
+      private
+
+      attr_reader :args
+
+      def options
+        @options ||= args.fetch(1, {}).dup
+      end
+
+      def options_for_revert
+        opts = options.clone.tap do |revert_options|
+          revert_options[:version] = revert_to_version
+          revert_options.delete(:revert_to_version)
+        end
+
+        keyword_hash(opts)
+      end
+
+      def keyword_hash(hash)
+        Hash.ruby2_keywords_hash(hash)
+      end
+    end
+    private_constant :Arguments
   end
 end
-
-ActiveRecord::Migration::CommandRecorder.send(
-  :include,
-  Fx::CommandRecorder,
-)

data/lib/fx/configuration.rb

@@ -1,38 +1,23 @@
 module Fx
-  # @return [Fx::Configuration] F(x)'s current configuration
-  def self.configuration
-    @_configuration ||= Configuration.new
-  end
-
-  # Set F(x)'s configuration
-  #
-  # @param config [Fx::Configuration]
-  def self.configuration=(config)
-    @_configuration = config
-  end
-
-  # Modify F(x)'s current configuration
-  #
-  # @yieldparam [Fx::Configuration] config current F(x) config
-  # ```
-  # Fx.configure do |config|
-  #   config.database = Fx::Adapters::Postgres
-  # end
-  # ```
-  def self.configure
-    yield configuration
-  end
-
   # F(x)'s configuration object.
   class Configuration
     # The F(x) database adapter instance to use when executing SQL.
     #
     # Defaults to an instance of {Fx::Adapters::Postgres}
-    # @return Fx adapter
+    # @return [Fx::Adapters::Postgres] 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] 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/definition.rb

@@ -1,18 +1,28 @@
 module Fx
   # @api private
   class Definition
-    def initialize(name:, version:, type: "function")
+    FUNCTION = "function".freeze
+    TRIGGER = "trigger".freeze
+
+    def self.function(name:, version:)
+      new(name: name, version: version, type: FUNCTION)
+    end
+
+    def self.trigger(name:, version:)
+      new(name: name, version: version, type: TRIGGER)
+    end
+
+    def initialize(name:, version:, type:)
       @name = name
-      @version = version.to_i
+      @version_number = version.to_i
       @type = type
     end
 
     def to_sql
-      File.read(full_path).tap do |content|
-        if content.empty?
-          raise "Define #{@type} in #{path} before migrating."
-        end
-      end
+      content = File.read(find_file || full_path)
+      raise "Define #{type} in #{path} before migrating." if content.empty?
+
+      content
     end
 
     def full_path
@@ -20,17 +30,29 @@ module Fx
     end
 
     def path
-      File.join("db", @type.pluralize, filename)
+      @_path ||= File.join("db", type.pluralize, filename)
     end
 
     def version
-      @version.to_s.rjust(2, "0")
+      version_number.to_s.rjust(2, "0")
     end
 
     private
 
+    attr_reader :name, :version_number, :type
+
     def filename
-      "#{@name}_v#{version}.sql"
+      @_filename ||= "#{name}_v#{version}.sql"
+    end
+
+    def find_file
+      migration_paths.lazy
+        .map { |migration_path| File.expand_path(File.join("..", "..", path), migration_path) }
+        .find { |definition_path| File.exist?(definition_path) }
+    end
+
+    def migration_paths
+      Rails.application.config.paths["db/migrate"].expanded
     end
   end
 end