fx 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 817dff811b3dc0f946828957f9274117436ac97b273416cfdffdcf7bccf493fd
-  data.tar.gz: 88d246804584933f266198d0edf384bfdd09eb0f6e7f57be5d4cbebcb8f7843e
+  metadata.gz: c58b9ff49b98b110220c15bb8e017038a237e2583b86a771a4fdad267fed316d
+  data.tar.gz: 4309eea32302e5828871134973269edeb532da5aa817639e4b8b9b466a7d8f1f
 SHA512:
-  metadata.gz: f414bb7dc859d720dc4d9e4e5f48a37cb0745e63a03d109824c5d17230d1384f53eb013c122a675c17c78e8e9d8f4c71dbf944ec351b8ee8c3df0e406556e241
-  data.tar.gz: d5caa370b2a0f132fd7aff53de631a2a836ba71ea8ac4c2eec79b73ea151d5df9615183855e3a2e0a4a608e45d8d43f2ea9c28ef66f53320ca6cc95ad2bdd215
+  metadata.gz: '09a4bc41360e92347b92bc9a3cadf3acd04cef9a87baaf549504c6667bf621053c0a156f00aea267b61505e1d14abee4993a1ce9b4acddea0a22c7bd926672fa'
+  data.tar.gz: 72883cf8649ac59df101613905842ac034ae8ecf5f7533474185ee15bda83e3e27c3373f790dbabd9209b06ec969ba7119aa2ea94590858a11cb9269d0c97b93

data/.github/workflows/ci.yml

@@ -14,9 +14,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.2", "3.3", "3.4"]
-        rails: ["7.2", "8.0", "8.1"]
-        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,23 @@ changelog, see the [commits] for each version via the version links.
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/teoljungberg/fx/compare/v0.10.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]
 

data/Gemfile

@@ -1,9 +1,13 @@
 source "https://rubygems.org"
 
+rails_version = ENV.fetch("RAILS_VERSION", "8.1")
+
 gemspec
 
+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/lib/fx/adapters/postgres/functions.rb

@@ -30,7 +30,7 @@ module Fx
         #
         # @return [Array<Fx::Function>]
         def self.all(connection)
-          QueryExecutor.call(
+          Fx::Adapters::Postgres::QueryExecutor.call(
             connection: connection,
             query: FUNCTIONS_WITH_DEFINITIONS_QUERY,
             model_class: Fx::Function

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

@@ -30,7 +30,7 @@ module Fx
         #
         # @return [Array<Fx::Trigger>]
         def self.all(connection)
-          QueryExecutor.call(
+          Fx::Adapters::Postgres::QueryExecutor.call(
             connection: connection,
             query: TRIGGERS_WITH_DEFINITIONS_QUERY,
             model_class: Fx::Trigger

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

@@ -21,20 +21,16 @@ module Fx
       dumpable_functions_in_database = Fx.database.functions
 
       dumpable_functions_in_database.each do |function|
+        stream.puts
         stream.puts(function.to_schema)
       end
-
-      stream.puts if dumpable_functions_in_database.any?
     end
 
     def triggers(stream)
       dumpable_triggers_in_database = Fx.database.triggers
 
-      if dumpable_triggers_in_database.any?
-        stream.puts
-      end
-
       dumpable_triggers_in_database.each do |trigger|
+        stream.puts
         stream.puts(trigger.to_schema)
       end
     end

data/lib/fx/version.rb

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

data/lib/fx.rb

@@ -28,7 +28,7 @@ module Fx
 
   # @return [Fx::Configuration] F(x)'s current configuration
   def self.configuration
-    @_configuration ||= Configuration.new
+    @_configuration ||= Fx::Configuration.new
   end
 
   # Set F(x)'s configuration

data/lib/generators/fx/function/function_generator.rb

@@ -71,12 +71,8 @@ module Fx
           end
         end
 
-        def active_record_migration_class
-          migration_helper.active_record_migration_class
-        end
-
         def formatted_name
-          NameHelper.format_for_migration(singular_name)
+          Fx::Generators::NameHelper.format_for_migration(singular_name)
         end
       end
 

data/lib/generators/fx/function/templates/db/migrate/create_function.erb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < <%= active_record_migration_class %>
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   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 %> < <%= active_record_migration_class %>
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     update_function <%= formatted_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
   end

data/lib/generators/fx/migration_helper.rb

@@ -10,14 +10,6 @@ module Fx
         !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

data/lib/generators/fx/trigger/templates/db/migrate/create_trigger.erb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < <%= active_record_migration_class %>
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   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 %> < <%= active_record_migration_class %>
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     update_trigger <%= formatted_name %>, on: <%= formatted_table_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
   end

data/lib/generators/fx/trigger/trigger_generator.rb

@@ -65,16 +65,12 @@ module Fx
           end
         end
 
-        def active_record_migration_class
-          migration_helper.active_record_migration_class
-        end
-
         def formatted_name
-          NameHelper.format_for_migration(singular_name)
+          Fx::Generators::NameHelper.format_for_migration(singular_name)
         end
 
         def formatted_table_name
-          NameHelper.format_table_name_from_hash(table_name)
+          Fx::Generators::NameHelper.format_table_name_from_hash(table_name)
         end
       end
 

data/spec/acceptance_helper.rb

@@ -5,32 +5,35 @@ ENV["RAILS_ENV"] = "test"
 RSpec.configure do |config|
   config.around(:each) do |example|
     Dir.chdir("spec/dummy") do
+      DatabaseReset.call
+
       example.run
+
+      DatabaseReset.call
     end
   end
 
   config.before(:suite) do
     Dir.chdir("spec/dummy") do
-      system <<~CMD
-        git init -b master 1>/dev/null &&
-        git config user.email "fx@example.com" &&
-        git config user.name "Fx" &&
-        git add -A &&
-        git commit --no-gpg-sign --message 'initial' 1>/dev/null
-      CMD
+      system [
+        "git init -b master 1>/dev/null",
+        "git config user.email 'fx@example.com'",
+        "git config user.name 'Fx'",
+        "git add -A",
+        "git commit --no-gpg-sign --message 'initial' 1>/dev/null"
+      ].join(" && ")
     end
   end
 
   config.after(:suite) do
     Dir.chdir("spec/dummy") do
       ActiveRecord::Base.connection.disconnect!
-      system <<~CMD
-        echo &&
-        rake db:environment:set db:drop db:create 1>/dev/null &&
-        git add -A &&
-        git reset --hard HEAD 1>/dev/null &&
-        rm -rf .git/ 1>/dev/null
-      CMD
+      DatabaseReset.call
+      system [
+        "git add -A",
+        "git reset --hard HEAD 1>/dev/null",
+        "rm -rf .git/ 1>/dev/null"
+      ].join(" && ")
     end
   end
 

data/spec/dummy/config/application.rb

@@ -12,10 +12,6 @@ module Dummy
     config.eager_load = false
     config.active_support.deprecation = :stderr
 
-    config.load_defaults 7.0
-
-    if Rails.version >= "8.0"
-      config.active_support.to_time_preserves_timezone = :zone
-    end
+    config.load_defaults 7.2
   end
 end

data/spec/fx/schema_dumper_spec.rb

@@ -155,10 +155,82 @@ RSpec.describe Fx::SchemaDumper, :db do
     expect(output.scan("create_trigger :test_public_trigger").size).to eq(1)
     expect(output.scan("create_function :test_schema_func").size).to eq(1)
     expect(output.scan("create_trigger :test_schema_trigger").size).to eq(1)
-
+  ensure
     connection.schema_search_path = "public"
   end
 
+  it "puts a blank line before each function and trigger" do
+    connection.create_table :users do |t|
+      t.string :name
+      t.string :upper_name
+      t.string :down_name
+    end
+    Fx.database.create_function <<~SQL
+      CREATE OR REPLACE FUNCTION uppercase_users_name()
+      RETURNS trigger AS $$
+      BEGIN
+        NEW.upper_name = UPPER(NEW.name);
+        RETURN NEW;
+      END;
+      $$ LANGUAGE plpgsql;
+    SQL
+    sql_definition = <<~SQL
+      CREATE TRIGGER uppercase_users_name
+          BEFORE INSERT ON users
+          FOR EACH ROW
+          EXECUTE FUNCTION uppercase_users_name();
+    SQL
+    connection.create_trigger(
+      :uppercase_users_name,
+      sql_definition: sql_definition
+    )
+    Fx.database.create_function <<~SQL
+      CREATE OR REPLACE FUNCTION downcase_users_name()
+      RETURNS trigger AS $$
+      BEGIN
+        NEW.down_name = LOWER(NEW.name);
+        RETURN NEW;
+      END;
+      $$ LANGUAGE plpgsql;
+    SQL
+    sql_definition = <<~SQL
+      CREATE TRIGGER downcase_users_name
+          BEFORE INSERT ON users
+          FOR EACH ROW
+          EXECUTE FUNCTION downcase_users_name();
+    SQL
+    connection.create_trigger(
+      :downcase_users_name,
+      sql_definition: sql_definition
+    )
+    stream = StringIO.new
+    output = stream.string
+
+    dump(connection: connection, stream: stream)
+
+    pattern = /(end|SQL)\n\n  (create_function|create_trigger)/
+    # a blank line between:
+    # - the table and the uppercase_users_name function,
+    # - the uppercase_users_name function and the downcase_users_name function,
+    # - the downcase_users_name function and the uppercase_users_name trigger,
+    # - the uppercase_users_name trigger and the downcase_users_name trigger,
+    expect(output.scan(pattern).size).to eq(4)
+  end
+
+  it "does not add blank lines when there are no functions or triggers" do
+    connection.create_table :users do |t|
+      t.string :name
+    end
+    stream = StringIO.new
+    output = stream.string
+
+    dump(connection: connection, stream: stream)
+
+    expect(output).not_to match(/create_function/)
+    expect(output).not_to match(/create_trigger/)
+    expect(output).not_to match(/end\n\n\nend/)
+  end
+
   def dump(connection:, stream:)
     if Rails.version >= "7.2"
       ActiveRecord::SchemaDumper.dump(connection.pool, stream)

data/spec/generators/fx/migration_helper_spec.rb

@@ -16,31 +16,6 @@ RSpec.describe Fx::Generators::MigrationHelper do
     end
   end
 
-  describe "#active_record_migration_class" do
-    it "returns versioned migration class when current_version is available" do
-      allow(ActiveRecord::Migration).to receive(:current_version)
-        .and_return(7.0)
-
-      helper = described_class.new({})
-
-      expect(helper.active_record_migration_class).to eq(
-        "ActiveRecord::Migration[7.0]"
-      )
-    end
-
-    it "returns base migration class when current_version is not available" do
-      allow(ActiveRecord::Migration).to receive(:respond_to?)
-        .with(:current_version)
-        .and_return(false)
-
-      helper = described_class.new({})
-
-      expect(helper.active_record_migration_class).to eq(
-        "ActiveRecord::Migration"
-      )
-    end
-  end
-
   describe "#update_migration_class_name" do
     it "generates correct class name for functions" do
       helper = described_class.new({})

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 ENV["RAILS_ENV"] = "test"
-require "database_cleaner"
 
 require File.expand_path("../dummy/config/environment", __FILE__)
 Dir["spec/support/**/*.rb"].sort.each { |file| load file }
@@ -11,14 +10,20 @@ RSpec.configure do |config|
   config.order = "random"
   config.disable_monkey_patching!
 
-  DatabaseCleaner.strategy = :transaction
+  config.define_derived_metadata(file_path: %r{spec/(fx|features)/}) do |metadata|
+    metadata[:db] = true
+  end
+
+  config.before(:suite) do
+    DatabaseReset.call
+  end
 
   config.around(:each, db: true) do |example|
-    ActiveRecord::Base.connection.execute("SET search_path TO DEFAULT;")
+    DatabaseReset.call
 
-    DatabaseCleaner.start
     example.run
-    DatabaseCleaner.clean
+
+    DatabaseReset.call
   end
 
   unless defined?(silence_stream)

data/spec/support/database_reset.rb

@@ -0,0 +1,24 @@
+module DatabaseReset
+  def self.call
+    connection = ActiveRecord::Base.connection
+    connection.execute("SET search_path TO DEFAULT;")
+
+    connection.execute <<~SQL
+      DO $$
+      DECLARE
+        schema_name TEXT;
+      BEGIN
+        FOR schema_name IN
+          SELECT nspname FROM pg_namespace
+          WHERE nspname NOT LIKE 'pg_%'
+            AND nspname != 'information_schema'
+        LOOP
+          EXECUTE format('DROP SCHEMA IF EXISTS %I CASCADE', schema_name);
+        END LOOP;
+      END $$;
+    SQL
+
+    connection.execute("CREATE SCHEMA public;")
+    connection.schema_search_path = "public"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fx
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Teo Ljungberg
 bindir: bin
 cert_chain: []
-date: 1980-01-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -139,6 +139,7 @@ files:
 - spec/generators/fx/trigger/trigger_generator_spec.rb
 - spec/generators/fx/version_helper_spec.rb
 - spec/spec_helper.rb
+- spec/support/database_reset.rb
 - spec/support/definition_helpers.rb
 - spec/support/generator_setup.rb
 - spec/support/migration_helpers.rb
@@ -148,7 +149,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/teoljungberg/fx/issues
-  changelog_uri: https://github.com/teoljungberg/fx/blob/v0.10.0/CHANGELOG.md
+  changelog_uri: https://github.com/teoljungberg/fx/blob/v0.10.1/CHANGELOG.md
   homepage_uri: https://github.com/teoljungberg/fx
   source_code_uri: https://github.com/teoljungberg/fx
 rdoc_options: []
@@ -165,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Support for database functions and triggers in Rails migrations
 test_files: []