fx 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa4dae8b8e550ee4ddc34b4d0d78c50cc085d01662993f0874f804525fdd51f
-  data.tar.gz: 6e57a6df8b97e7638de3b05d9204c4bdcf2db90b585dfb617a1c2e3492d9f8b5
+  metadata.gz: a1eaca24d4bb2262d766c845df89e92051c4824b6cf621714d4786a6b1f2eaaf
+  data.tar.gz: 32b2aaf58fbb8844adf514d5b3e15bf924bcc47d69f048135579cb002c15581b
 SHA512:
-  metadata.gz: c4cf689e5a1847b7ad45b2679dd45046555f750fb7bc8ed9dc2c473da1e6a6eba344a312fa0b33852197ec7c5d81dc92a3ff416939ba8f5435f8a5da16c928df
-  data.tar.gz: 1d59049f9bb409bcbb56c3126f9675f1492e0a3d434858d2cb44af8a3d5aba74ee1fe5f78bbc73bab707aae05cfe8d8ed671a4a7e5dc8fa4841df176ebd88c30
+  metadata.gz: 0fffacf063521bd38e8f4343c4879b8872b9a750a50d278b90fc08434ca6fe6bfdaad7d79f96349b042d1fa0145f5254294d44b38cc0ca72d5516c8a08c023e7
+  data.tar.gz: 41c966c110817c920c4280f7a83ebfac59687cb98f0603bdf11fecd368332172441f6c1e428f364b1dfc7b7552fa896b82489979a1e2f5744b6b20c9c8e406ee

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.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]
-        exclude:
-          - ruby: "3.2"
-            rails: "6.0"
-          - ruby: "3.2"
-            rails: "6.1"
 
     services:
       postgres:

data/CHANGELOG.md

@@ -0,0 +1,124 @@
+# 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.8.0..HEAD
+
+## [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,15 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in fx.gemspec
 gemspec
+
+gem "ammeter", ">= 1.1.3"
+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/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/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.0"
+  spec.add_dependency "railties", ">= 7.0"
 
-  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.0"
 end

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

@@ -10,6 +10,18 @@ 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
+        def support_drop_function_without_args
+          pg_connection = undecorated_connection.raw_connection
+          pg_connection.server_version >= 10_00_00
+        end
+
+        private
+
+        def undecorated_connection
+          __getobj__
+        end
       end
     end
   end

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

@@ -8,7 +8,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 = <<~EOS.freeze
           SELECT
               pp.proname AS name,
               pg_get_functiondef(pp.oid) AS definition
@@ -27,8 +27,8 @@ module Fx
         # Wraps #all as a static facade.
         #
         # @return [Array<Fx::Function>]
-        def self.all(*args)
-          new(*args).all
+        def self.all(...)
+          new(...).all
         end
 
         def initialize(connection)

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

@@ -8,7 +8,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 = <<~EOS.freeze
           SELECT
               pt.tgname AS name,
               pg_get_triggerdef(pt.oid) AS definition
@@ -25,8 +25,8 @@ module Fx
         # Wraps #all as a static facade.
         #
         # @return [Array<Fx::Trigger>]
-        def self.all(*args)
-          new(*args).all
+        def self.all(...)
+          new(...).all
         end
 
         def initialize(connection)

data/lib/fx/adapters/postgres.rb

@@ -69,7 +69,7 @@ module Fx
       #
       # @return [void]
       def create_function(sql_definition)
-        execute sql_definition
+        execute(sql_definition)
       end
 
       # Creates a trigger in the database.
@@ -81,7 +81,7 @@ module Fx
       #
       # @return [void]
       def create_trigger(sql_definition)
-        execute sql_definition
+        execute(sql_definition)
       end
 
       # Updates a function in the database.
@@ -125,10 +125,10 @@ module Fx
       #
       # @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
 
@@ -142,7 +142,7 @@ module Fx
       #
       # @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

data/lib/fx/command_recorder.rb

@@ -1,12 +1,53 @@
-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)
+      record(:create_function, args)
+    end
+
+    def drop_function(*args)
+      record(:drop_function, args)
+    end
+
+    def update_function(*args)
+      record(:update_function, args)
+    end
+
+    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)
+      record(:create_trigger, args)
+    end
+
+    def drop_trigger(*args)
+      record(:drop_trigger, args)
+    end
+
+    def update_trigger(*args)
+      record(:update_trigger, args)
+    end
+
+    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
 
@@ -20,5 +61,45 @@ module Fx
 
       [method, arguments.invert_version.to_a]
     end
+
+    class Arguments
+      def initialize(args)
+        @args = args.freeze
+      end
+
+      def function
+        @args[0]
+      end
+
+      def version
+        options[:version]
+      end
+
+      def revert_to_version
+        options[:revert_to_version]
+      end
+
+      def invert_version
+        Arguments.new([function, options_for_revert])
+      end
+
+      def to_a
+        @args.to_a
+      end
+
+      private
+
+      def options
+        @options ||= @args[1] || {}
+      end
+
+      def options_for_revert
+        options.clone.tap do |revert_options|
+          revert_options[:version] = revert_to_version
+          revert_options.delete(:revert_to_version)
+        end
+      end
+    end
+    private_constant :Arguments
   end
 end

data/lib/fx/configuration.rb

@@ -1,29 +1,4 @@
 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
-  #   config.dump_functions_at_beginning_of_schema = true
-  # 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.

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
       @type = type
     end
 
     def to_sql
-      File.read(find_file || 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

data/lib/fx/function.rb

@@ -6,9 +6,9 @@ module Fx
     attr_reader :name, :definition
     delegate :<=>, to: :name
 
-    def initialize(function_row)
-      @name = function_row.fetch("name")
-      @definition = function_row.fetch("definition")
+    def initialize(row)
+      @name = row.fetch("name")
+      @definition = row.fetch("definition")
     end
 
     def ==(other)

data/lib/fx/schema_dumper.rb

@@ -1,10 +1,50 @@
-require "fx/schema_dumper/function"
-require "fx/schema_dumper/trigger"
-
 module Fx
   # @api private
   module SchemaDumper
-    include Function
-    include Trigger
+    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)
+    end
+
+    private
+
+    def empty_line(stream)
+      stream.puts if dumpable_functions_in_database.any?
+    end
+
+    def functions(stream)
+      dumpable_functions_in_database.each do |function|
+        stream.puts(function.to_schema)
+      end
+    end
+
+    def triggers(stream)
+      if dumpable_triggers_in_database.any?
+        stream.puts
+      end
+
+      dumpable_triggers_in_database.each do |trigger|
+        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