fx 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1eaca24d4bb2262d766c845df89e92051c4824b6cf621714d4786a6b1f2eaaf
-  data.tar.gz: 32b2aaf58fbb8844adf514d5b3e15bf924bcc47d69f048135579cb002c15581b
+  metadata.gz: c58b9ff49b98b110220c15bb8e017038a237e2583b86a771a4fdad267fed316d
+  data.tar.gz: 4309eea32302e5828871134973269edeb532da5aa817639e4b8b9b466a7d8f1f
 SHA512:
-  metadata.gz: 0fffacf063521bd38e8f4343c4879b8872b9a750a50d278b90fc08434ca6fe6bfdaad7d79f96349b042d1fa0145f5254294d44b38cc0ca72d5516c8a08c023e7
-  data.tar.gz: 41c966c110817c920c4280f7a83ebfac59687cb98f0603bdf11fecd368332172441f6c1e428f364b1dfc7b7552fa896b82489979a1e2f5744b6b20c9c8e406ee
+  metadata.gz: '09a4bc41360e92347b92bc9a3cadf3acd04cef9a87baaf549504c6667bf621053c0a156f00aea267b61505e1d14abee4993a1ce9b4acddea0a22c7bd926672fa'
+  data.tar.gz: 72883cf8649ac59df101613905842ac034ae8ecf5f7533474185ee15bda83e3e27c3373f790dbabd9209b06ec969ba7119aa2ea94590858a11cb9269d0c97b93

data/.github/workflows/ci.yml

@@ -14,9 +14,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.0", "3.1", "3.2", "3.3", "3.4.0-preview2"]
-        rails: ["7.0", "7.1", "7.2", "8.0.0"]
-        continue-on-error: [false]
+        ruby: ["3.2", "4.0"]
+        rails: ["7.2", "8.1"]
 
     services:
       postgres:
@@ -35,9 +34,10 @@ jobs:
 
     env:
       POSTGRES_USER: postgres
+      RAILS_VERSION: ${{ matrix.rails }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -7,7 +7,49 @@ changelog, see the [commits] for each version via the version links.
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/teoljungberg/fx/compare/v0.8.0..HEAD
+[Unreleased]: https://github.com/teoljungberg/fx/compare/v0.10.1..HEAD
+
+## [0.10.1]
+
+[0.10.1]: https://github.com/teoljungberg/fx/compare/v0.10.0...v0.10.1
+
+- Fix spacing between functions and triggers in schema.rb (#195)
+- Remove `database_cleaner` dependency (#190)
+- Internal refactorings / improvements
+  - Improve schema dumper test coverage
+  - Use methods over instance variables (#192)
+  - Write out fully qualified path in definitions (#189)
+  - Improve test isolation with schema reset (#190)
+  - Rewrite shell command chains (#188)
+  - Inline `active_record_migration_class` (#187)
+  - Add Ruby 4.0 to CI matrix (#193)
+  - Minimize CI matrix to boundary versions (#196)
+
+## [0.10.0]
+
+[0.10.0]: https://github.com/teoljungberg/fx/compare/v0.9.0...v0.10.0
+
+- Scope functions and triggers to schema search path (#168)
+- Ensure multi-schema dumping in Rails 8.1.0 does not dump the same objects for
+  all schemas (#177)
+- Require Ruby >= 3.2 (#166)
+- Require Ruby >= 3.1 (#162)
+- New version support
+  - Add Rails 8.1 to the test matrix (#175)
+  - Add Ruby 3.4 to the test matrix (#161)
+- Removed version support
+  - Drop Rails 7.1 due to EOL (#176)
+  - Drop EOL Ruby versions (3.0) (#162)
+  - Drop EOL Rails versions (7.0) (#162)
+- Internal refactorings / improvements
+  - Extract validation methods in `Statements` module (#184)
+  - Refactor generators with helper classes and improvements (#183)
+  - Extract `QueryExecutor` to remove duplication (#182)
+  - Extract PostgreSQL version constants (#181)
+  - YARD documentation improvements (#179)
+  - Ensure fx has been loaded (#173)
+  - Replace ammeter (#172)
+  - Remove teardown phase (#171)
 
 ## [0.9.0]
 

data/Gemfile

@@ -1,10 +1,13 @@
 source "https://rubygems.org"
 
+rails_version = ENV.fetch("RAILS_VERSION", "8.1")
+
 gemspec
 
-gem "ammeter", ">= 1.1.3"
+gem "activerecord", "~> #{rails_version}.0"
+gem "railties", "~> #{rails_version}.0"
+
 gem "bundler", ">= 1.5"
-gem "database_cleaner"
 gem "pg"
 gem "pry"
 gem "rake"

data/README.md

@@ -114,6 +114,22 @@ column value instead of a plain string.
 - [Oracle](https://github.com/zygotecnologia/fx-oracle-adapter)
 - [SQLserver](https://github.com/tarellel/fx-sqlserver-adapter)
 
+## Version Support
+
+F(x) follows the maintenance policies of Ruby and Rails, supporting versions
+within their official maintenance windows.
+
+**Ruby:** 3.2+ ([maintenance branches])
+
+**Rails:** 7.2, 8.0, 8.1 ([maintenance policy])
+
+When a Ruby or Rails version reaches end-of-life, support will be dropped in the
+next minor release of F(x). Older versions may continue to work but are not
+tested or guaranteed.
+
+[maintenance branches]: https://www.ruby-lang.org/en/downloads/branches/
+[maintenance policy]: https://rubyonrails.org/maintenance
+
 ## Contributing
 
 See [contributing](CONTRIBUTING.md) for more details.

data/bin/rake

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -7,9 +8,7 @@
 # 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__)
 
 require "rubygems"
 require "bundler/setup"

data/bin/rspec

@@ -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/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

@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0")
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 7.0"
-  spec.add_dependency "railties", ">= 7.0"
+  spec.add_dependency "activerecord", ">= 7.2", "< 8.2"
+  spec.add_dependency "railties", ">= 7.2", "< 8.2"
 
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 3.2"
 end

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

@@ -10,15 +10,23 @@ module Fx
       #
       # @api private
       class Connection < SimpleDelegator
-        # https://www.postgresql.org/docs/9.6/sql-dropfunction.html
-        # https://www.postgresql.org/docs/10/sql-dropfunction.html
+        # PostgreSQL version constants for feature support
+        POSTGRES_VERSIONS = {
+          # PostgreSQL 10.0 - introduced DROP FUNCTION without args
+          # https://www.postgresql.org/docs/10/sql-dropfunction.html
+          v10: 10_00_00
+        }.freeze
+
         def support_drop_function_without_args
-          pg_connection = undecorated_connection.raw_connection
-          pg_connection.server_version >= 10_00_00
+          server_version >= POSTGRES_VERSIONS[:v10]
         end
 
         private
 
+        def server_version
+          undecorated_connection.raw_connection.server_version
+        end
+
         def undecorated_connection
           __getobj__
         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,7 +9,7 @@ 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 = <<~EOS.freeze
+        FUNCTIONS_WITH_DEFINITIONS_QUERY = <<~SQL.freeze
           SELECT
               pp.proname AS name,
               pg_get_functiondef(pp.oid) AS definition
@@ -19,39 +20,21 @@ module Fx
               ON pd.objid = pp.oid AND pd.deptype = 'e'
           LEFT JOIN pg_aggregate pa
               ON pa.aggfnoid = pp.oid
-          WHERE pn.nspname = 'public' AND pd.objid IS NULL
+          WHERE pn.nspname = ANY (current_schemas(false))
+              AND pd.objid IS NULL
               AND pa.aggfnoid IS NULL
           ORDER BY pp.oid;
-        EOS
+        SQL
 
         # Wraps #all as a static facade.
         #
         # @return [Array<Fx::Function>]
-        def self.all(...)
-          new(...).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 = <<~EOS.freeze
+        TRIGGERS_WITH_DEFINITIONS_QUERY = <<~SQL.freeze
           SELECT
               pt.tgname AS name,
               pg_get_triggerdef(pt.oid) AS definition
@@ -17,39 +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;
-        EOS
+        SQL
 
         # Wraps #all as a static facade.
         #
         # @return [Array<Fx::Trigger>]
-        def self.all(...)
-          new(...).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

@@ -47,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.
@@ -57,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.
@@ -65,7 +65,7 @@ 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)
@@ -77,7 +77,7 @@ 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)
@@ -89,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)
@@ -106,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:)
@@ -121,7 +121,7 @@ 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)
@@ -137,8 +137,8 @@ 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:)
@@ -152,7 +152,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

@@ -68,7 +68,7 @@ module Fx
       end
 
       def function
-        @args[0]
+        args[0]
       end
 
       def version
@@ -84,13 +84,15 @@ module Fx
       end
 
       def to_a
-        @args.to_a
+        args.to_a
       end
 
       private
 
+      attr_reader :args
+
       def options
-        @options ||= @args[1] || {}
+        @options ||= args[1] || {}
       end
 
       def options_for_revert

data/lib/fx/configuration.rb

@@ -4,7 +4,7 @@ module Fx
     # 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
@@ -12,7 +12,7 @@ module Fx
     # in statements below, i.e.: default column values.
     #
     # Defaults to false
-    # @return Boolean
+    # @return [Boolean] Boolean
     attr_accessor :dump_functions_at_beginning_of_schema
 
     def initialize

data/lib/fx/definition.rb

@@ -14,13 +14,13 @@ module Fx
 
     def initialize(name:, version:, type:)
       @name = name
-      @version = version.to_i
+      @version_number = version.to_i
       @type = type
     end
 
     def to_sql
       content = File.read(find_file || full_path)
-      raise "Define #{@type} in #{path} before migrating." if content.empty?
+      raise "Define #{type} in #{path} before migrating." if content.empty?
 
       content
     end
@@ -30,17 +30,19 @@ module Fx
     end
 
     def path
-      @_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
-      @_filename ||= "#{@name}_v#{version}.sql"
+      @_filename ||= "#{name}_v#{version}.sql"
     end
 
     def find_file

data/lib/fx/schema_dumper.rb

@@ -4,14 +4,12 @@ module Fx
     def tables(stream)
       if Fx.configuration.dump_functions_at_beginning_of_schema
         functions(stream)
-        empty_line(stream)
       end
 
       super
 
       unless Fx.configuration.dump_functions_at_beginning_of_schema
         functions(stream)
-        empty_line(stream)
       end
 
       triggers(stream)
@@ -19,32 +17,22 @@ module Fx
 
     private
 
-    def empty_line(stream)
-      stream.puts if dumpable_functions_in_database.any?
-    end
-
     def functions(stream)
+      dumpable_functions_in_database = Fx.database.functions
+
       dumpable_functions_in_database.each do |function|
+        stream.puts
         stream.puts(function.to_schema)
       end
     end
 
     def triggers(stream)
-      if dumpable_triggers_in_database.any?
-        stream.puts
-      end
+      dumpable_triggers_in_database = Fx.database.triggers
 
       dumpable_triggers_in_database.each do |trigger|
+        stream.puts
         stream.puts(trigger.to_schema)
       end
     end
-
-    def dumpable_functions_in_database
-      @_dumpable_functions_in_database ||= Fx.database.functions
-    end
-
-    def dumpable_triggers_in_database
-      @_dumpable_triggers_in_database ||= Fx.database.triggers
-    end
   end
 end