fx 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa4dae8b8e550ee4ddc34b4d0d78c50cc085d01662993f0874f804525fdd51f
-  data.tar.gz: 6e57a6df8b97e7638de3b05d9204c4bdcf2db90b585dfb617a1c2e3492d9f8b5
+  metadata.gz: 817dff811b3dc0f946828957f9274117436ac97b273416cfdffdcf7bccf493fd
+  data.tar.gz: 88d246804584933f266198d0edf384bfdd09eb0f6e7f57be5d4cbebcb8f7843e
 SHA512:
-  metadata.gz: c4cf689e5a1847b7ad45b2679dd45046555f750fb7bc8ed9dc2c473da1e6a6eba344a312fa0b33852197ec7c5d81dc92a3ff416939ba8f5435f8a5da16c928df
-  data.tar.gz: 1d59049f9bb409bcbb56c3126f9675f1492e0a3d434858d2cb44af8a3d5aba74ee1fe5f78bbc73bab707aae05cfe8d8ed671a4a7e5dc8fa4841df176ebd88c30
+  metadata.gz: f414bb7dc859d720dc4d9e4e5f48a37cb0745e63a03d109824c5d17230d1384f53eb013c122a675c17c78e8e9d8f4c71dbf944ec351b8ee8c3df0e406556e241
+  data.tar.gz: d5caa370b2a0f132fd7aff53de631a2a836ba71ea8ac4c2eec79b73ea151d5df9615183855e3a2e0a4a608e45d8d43f2ea9c28ef66f53320ca6cc95ad2bdd215

data/.github/workflows/ci.yml

@@ -14,14 +14,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1", "3.2"]
-        rails: ["6.0", "6.1", "7.0"]
+        ruby: ["3.2", "3.3", "3.4"]
+        rails: ["7.2", "8.0", "8.1"]
         continue-on-error: [false]
-        exclude:
-          - ruby: "3.2"
-            rails: "6.0"
-          - ruby: "3.2"
-            rails: "6.1"
 
     services:
       postgres:

data/CHANGELOG.md

@@ -0,0 +1,150 @@
+# Changelog
+
+The noteworthy changes for each version are included here. For a complete
+changelog, see the [commits] for each version via the version links.
+
+[commits]: https://github.com/teoljungberg/fx/commits/master
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/teoljungberg/fx/compare/v0.10.0..HEAD
+
+## [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]
+
+[0.9.0]: https://github.com/teoljungberg/fx/compare/v0.8.0...v0.9.0
+
+- Drop EOL Rails versions (6.2)
+- Add Ruby 3.4.0 preview's to the test matrix (#152)
+- Add Rails 8.0.0 to the test matrix (#152)
+- Add Rails 7.2 to the test matrix (#150)
+- Fix deprecation warnings in Rails (#148)
+- Mark `Fx::CommandRecorder::Arguments` as private.
+- Add Ruby 3.3 to the test matrix (#144)
+- Internal refactorings:
+  - Move development dependencies to Gemfile (#145)
+  - Inline `Fx::CommandRecorder::Arguments`
+  - Inline `Fx::{CommandRecorder,SchemaDumper,Statements}::{Function,Trigger}`
+  - Move configuration methods to `Fx`
+- Add `Fx::Definition.{function,trigger}` (#119)
+- Add Rails 7.1 to the test matrix (#136)
+- Add Rubygems metadata to gemspec (#132)
+- Disable RSpec's monkey patching (#121)
+- Raise on warnings (#124)
+- Require Ruby >= 3.0 (#128)
+- Require Rails >= 6.1 (#127)
+
+## [0.8.0]
+
+[0.8.0]: https://github.com/teoljungberg/fx/compare/v0.7.0...v0.8.0
+
+- Replace Travis CI with GitHub Actions.
+- Bump minimum Ruby version to 2.7.
+   - Ruby 2.7 will be dropped in end of March 2023, so a release to drop it will
+     happen afterwards.
+- Bump minimum Rails version to 6.0.0
+   - Rails 6.0 will be dropped in June 2023, so a release to drop it will happen
+     afterwards
+- Adopt standard.rb
+- Contributing improvements
+- Test-suite improvements
+
+## [0.7.0]
+
+[0.7.0]: https://github.com/teoljungberg/fx/compare/v0.6.2...v0.7.0
+
+- Support Ruby 3 (#76)
+- Preserve backslashes when dumping the schema (#71)
+- Add a link to F(x) SqlServer Adapter in the README (#80)
+
+## [0.6.2]
+
+[0.6.2]: https://github.com/teoljungberg/fx/compare/v0.6.1...v0.6.2
+
+- Add support for Ruby 3
+
+## [0.6.1]
+
+[0.6.1]: https://github.com/teoljungberg/fx/compare/v0.6.0...v0.6.1
+
+- Fix: Support --no-migration generator flag (#62)
+
+## [0.6.0]
+
+[0.6.0]: https://github.com/teoljungberg/fx/compare/v0.5.0...v0.6.0
+
+- Support unique functions with parameters (#27)
+- Use db connection provided by Rails (#49)
+- Support `--no-migration` generator flag (#60)
+- Use current ActiveRecord version in migrations (#59)
+- Does not include aggregates when dumping schema (#50)
+- Dump functions in the beginning of the schema (#53)
+
+## [0.5.0]
+
+[0.5.0]: https://github.com/teoljungberg/fx/compare/v0.4.0...v0.5.0
+
+- Drop EOL Ruby versions.
+- Drop EOL Rails versions.
+
+## [0.4.0]
+
+[0.4.0]: https://github.com/teoljungberg/fx/compare/v0.3.1...v0.4.0
+
+- Add table_name to README (#15)
+- Reverse function/trigger order in README (#17)
+- Split up Trigger#definition test (#19)
+- Find definitions in engines (#18)
+
+## [0.3.1]
+
+[0.3.1]: https://github.com/teoljungberg/fx/compare/v0.3.0...v0.3.1
+
+- Strip shared leading whitespace from sql_definitions (#13)
+- Update documentation for `drop_function`
+- Document `Fx::Adapters::Postgres#initialize`
+- Fix test suite issues:
+   - Add unit test coverage for `Fx::Adapters::Triggers`
+   - Add unit test coverage for `Fx::Adapters::Functions`
+   - Add unit test coverage for `Fx::Trigger`
+   - Add unit test coverage for `Fx::Function`
+
+## [0.3.0]
+
+[0.3.0]: https://github.com/teoljungberg/fx/compare/v0.2.0...v0.3.0
+
+## [0.2.0]
+
+[0.2.0]: https://github.com/teoljungberg/fx/compare/v0.1.0...v0.2.0
+
+## [0.1.0]
+
+F(x) adds methods to `ActiveRecord::Migration` to create and manage database
+functions and triggers in Rails.
+
+[0.1.0]: https://github.com/teoljungberg/fx/compare/4ccf986643d9de82038977eff8c6b1a4a716d698...v0.1.0

data/CONTRIBUTING.md

@@ -1,9 +1,9 @@
 # Contributing
 
-We love contributions from everyone.  By participating in this project, you
+We love contributions from everyone. By participating in this project, you
 agree to abide by our [code of conduct].
 
-[code of conduct]: CODE_OF_CONDUCT.md
+[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
 
 ## Contributing Code
 
@@ -19,6 +19,6 @@ agree to abide by our [code of conduct].
 
 [good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 
-Others will give constructive feedback.  This is a time for discussion and
+Others will give constructive feedback. This is a time for discussion and
 improvements, and making the necessary changes will be required before we can
 merge the contribution.

data/Gemfile

@@ -1,4 +1,14 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in fx.gemspec
 gemspec
+
+gem "bundler", ">= 1.5"
+gem "database_cleaner"
+gem "pg"
+gem "pry"
+gem "rake"
+gem "redcarpet"
+gem "rspec", ">= 3.3"
+gem "standardrb"
+gem "yard"
+gem "warning"

data/README.md

@@ -110,6 +110,8 @@ column value instead of a plain string.
 
 ## Plugins/Adapters
 
+- [MySQL](https://github.com/f-mer/fx-adapters-mysql/)
+- [Oracle](https://github.com/zygotecnologia/fx-oracle-adapter)
 - [SQLserver](https://github.com/tarellel/fx-sqlserver-adapter)
 
 ## Contributing

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

@@ -8,29 +8,24 @@ Gem::Specification.new do |spec|
   spec.authors = ["Teo Ljungberg"]
   spec.email = ["teo@teoljungberg.com"]
   spec.summary = "Support for database functions and triggers in Rails migrations"
-  spec.description = <<-DESCRIPTION
+  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.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.require_paths = ["lib"]
 
-  spec.add_development_dependency "ammeter", ">= 1.1.3"
-  spec.add_development_dependency "bundler", ">= 1.5"
-  spec.add_development_dependency "database_cleaner"
-  spec.add_development_dependency "pg"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "redcarpet"
-  spec.add_development_dependency "rspec", ">= 3.3"
-  spec.add_development_dependency "standardrb"
-  spec.add_development_dependency "yard"
+  spec.add_dependency "activerecord", ">= 7.2", "< 8.2"
+  spec.add_dependency "railties", ">= 7.2", "< 8.2"
 
-  spec.add_dependency "activerecord", ">= 6.0.0"
-  spec.add_dependency "railties", ">= 6.0.0"
-
-  spec.required_ruby_version = ">= 2.7"
+  spec.required_ruby_version = ">= 3.2"
 end

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

@@ -10,6 +10,26 @@ module Fx
       #
       # @api private
       class Connection < SimpleDelegator
+        # 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
+          server_version >= POSTGRES_VERSIONS[:v10]
+        end
+
+        private
+
+        def server_version
+          undecorated_connection.raw_connection.server_version
+        end
+
+        def undecorated_connection
+          __getobj__
+        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,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(*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)
+          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(*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)
+          QueryExecutor.call(
+            connection: connection,
+            query: TRIGGERS_WITH_DEFINITIONS_QUERY,
+            model_class: Fx::Trigger
+          )
         end
       end
     end

data/lib/fx/adapters/postgres.rb

@@ -65,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.
@@ -77,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.
@@ -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,14 +121,14 @@ 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)
-        if support_drop_function_without_args
-          execute "DROP FUNCTION #{name};"
+        if connection.support_drop_function_without_args
+          execute("DROP FUNCTION #{name};")
         else
-          execute "DROP FUNCTION #{name}();"
+          execute("DROP FUNCTION #{name}();")
         end
       end
 
@@ -137,12 +137,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
@@ -154,14 +154,6 @@ module Fx
       def connection
         Connection.new(connectable.connection)
       end
-
-      def support_drop_function_without_args
-        # https://www.postgresql.org/docs/9.6/sql-dropfunction.html
-        # https://www.postgresql.org/docs/10/sql-dropfunction.html
-
-        pg_connection = connectable.connection.raw_connection
-        pg_connection.server_version >= 10_00_00
-      end
     end
   end
 end