fx 0.6.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e391283922484cf5a5b06c7de944c3162a85b7b49546f1fd1a017a6fc762898
-  data.tar.gz: 73b179c85ebc70977bf4d2afbe45088284a9730138c2a424d940d72fb2ab0a30
+  metadata.gz: bfa4dae8b8e550ee4ddc34b4d0d78c50cc085d01662993f0874f804525fdd51f
+  data.tar.gz: 6e57a6df8b97e7638de3b05d9204c4bdcf2db90b585dfb617a1c2e3492d9f8b5
 SHA512:
-  metadata.gz: 144fcbf71aad79383ee1ae98047b6fc018212ecd3ea2d747f883d7def2c649590b1d04fc77b0a84113fa832a6a0377857cf8482d2290c0c40f6496be0e6db470
-  data.tar.gz: 057f585e7e83a89aebfda256605813a7db9e7d01b5841f436be0a9f7323540fd5a49999e4bf3bbc6db33ab0342e4ad0727b1b9b16690ed3a1aea00ea3011ea2d
+  metadata.gz: c4cf689e5a1847b7ad45b2679dd45046555f750fb7bc8ed9dc2c473da1e6a6eba344a312fa0b33852197ec7c5d81dc92a3ff416939ba8f5435f8a5da16c928df
+  data.tar.gz: 1d59049f9bb409bcbb56c3126f9675f1492e0a3d434858d2cb44af8a3d5aba74ee1fe5f78bbc73bab707aae05cfe8d8ed671a4a7e5dc8fa4841df176ebd88c30

data/.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: CI
+
+on:
+  push:
+    branches: master
+  pull_request:
+    branches: "*"
+
+jobs:
+  tests:
+    name: Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
+        rails: ["6.0", "6.1", "7.0"]
+        continue-on-error: [false]
+        exclude:
+          - ruby: "3.2"
+            rails: "6.0"
+          - ruby: "3.2"
+            rails: "6.1"
+
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      POSTGRES_USER: postgres
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: latest
+
+      - name: Setup environment
+        run: bin/setup
+
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -1,5 +1,4 @@
 /.bundle/
-/gemfiles/*.gemfile.lock
 /.yardoc
 /Gemfile.lock
 /_yardoc/

data/.rspec

@@ -1,2 +1,2 @@
---color
+--no-color
 --require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+ignore:
+  - 'spec/dummy/db/schema.rb'
+  - '**/tmp/*'

data/CONTRIBUTING.md

@@ -1,12 +1,21 @@
 # Contributing
 
+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
+
+## Contributing Code
+
 1. Fork the repository.
 2. Run `bin/setup`, which will install dependencies and create the dummy
    application database.
-3. Run `bin/appraisal rake` to verify that the tests pass against all
-   supported versions of Rails.
-4. Make your change with new passing tests, following the existing style.
+3. Run `rake` to verify that the tests pass against the version of Rails you are
+   running locally.
+4. Make your change with new passing tests, following existing style.
 5. Write a [good commit message], push your fork, and submit a pull request.
+6. CI will run the test suite on all configured versions of Ruby and Rails.
+   Address any failures.
 
 [good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in fx.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # F(x)
 
-[![Build Status](https://travis-ci.com/teoljungberg/fx.svg?token=AgJn4nPeY6ue2Pvy23JQ&branch=master)](https://travis-ci.com/teoljungberg/fx)
+[![Build Status](https://github.com/teoljungberg/fx/actions/workflows/ci.yml/badge.svg)](https://github.com/teoljungberg/fx/actions/workflows/ci.yml)
 [![Documentation Quality](http://inch-ci.org/github/teoljungberg/fx.svg?branch=master)](http://inch-ci.org/github/teoljungberg/fx)
 
 F(x) adds methods to `ActiveRecord::Migration` to create and manage database
@@ -49,7 +49,7 @@ In our example, this might look something like this:
 CREATE TRIGGER uppercase_users_name
     BEFORE INSERT ON users
     FOR EACH ROW
-    EXECUTE PROCEDURE uppercase_users_name();
+    EXECUTE FUNCTION uppercase_users_name();
 ```
 
 The generated migrations contains `create_function` and `create_trigger`
@@ -108,6 +108,10 @@ end
 That's how you tell Rails to use the default as a literal SQL for the default
 column value instead of a plain string.
 
+## Plugins/Adapters
+
+- [SQLserver](https://github.com/tarellel/fx-sqlserver-adapter)
+
 ## Contributing
 
 See [contributing](CONTRIBUTING.md) for more details.

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "standard/rake"
 
 namespace :dummy do
   require_relative "spec/dummy/config/application"
@@ -20,4 +21,4 @@ RSpec::Core::RakeTask.new("spec:acceptance") do |task|
 end
 
 desc "Run the specs and acceptance tests"
-task default: %w(spec spec:acceptance)
+task default: %w[spec spec:acceptance standard]

data/bin/setup

@@ -5,9 +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/fx.gemspec

@@ -1,38 +1,36 @@
-# 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.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 "ammeter", ">= 1.1.3"
+  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 "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", '>= 4.0.0'
-  spec.add_dependency "railties", '>= 4.0.0'
+  spec.add_dependency "activerecord", ">= 6.0.0"
+  spec.add_dependency "railties", ">= 6.0.0"
 
-  spec.required_ruby_version = ">= 2.1"
+  spec.required_ruby_version = ">= 2.7"
 end

data/lib/fx/function.rb

@@ -16,10 +16,10 @@ module Fx
     end
 
     def to_schema
-      <<-SCHEMA.indent(2)
-create_function :#{name}, sql_definition: <<-\SQL
-#{definition.indent(4).rstrip}
-SQL
+      <<~SCHEMA.indent(2)
+        create_function :#{name}, sql_definition: <<-'SQL'
+        #{definition.indent(4).rstrip}
+        SQL
       SCHEMA
     end
   end

data/lib/fx/statements/function.rb

@@ -11,7 +11,7 @@ module Fx
       #   find the definition file in `db/functions`. This defaults to `1` if
       #   not provided.
       # @param sql_definition [String] The SQL query for the function schema.
-      #   If both `sql_defintion` and `version` are provided,
+      #   If both `sql_definition` and `version` are provided,
       #   `sql_definition` takes prescedence.
       # @return The database response from executing the create statement.
       #
@@ -29,11 +29,14 @@ module Fx
       #     $$ LANGUAGE plpgsql;
       #   SQL
       #
-      def create_function(name, version: 1, sql_definition: nil)
+      def create_function(name, options = {})
+        version = options.fetch(:version, 1)
+        sql_definition = options[:sql_definition]
+
         if version.nil? && sql_definition.nil?
           raise(
             ArgumentError,
-            "version or sql_definition must be specified",
+            "version or sql_definition must be specified"
           )
         end
         sql_definition = sql_definition.strip_heredoc if sql_definition
@@ -53,7 +56,7 @@ module Fx
       # @example Drop a function, rolling back to version 2 on rollback
       #   drop_function(:uppercase_users_name, revert_to_version: 2)
       #
-      def drop_function(name, revert_to_version: nil)
+      def drop_function(name, options = {})
         Fx.database.drop_function(name)
       end
 
@@ -64,7 +67,7 @@ module Fx
       #   find the definition file in `db/functions`. This defaults to `1` if
       #   not provided.
       # @param sql_definition [String] The SQL query for the function schema.
-      #   If both `sql_defintion` and `version` are provided,
+      #   If both `sql_definition` and `version` are provided,
       #   `sql_definition` takes prescedence.
       # @return The database response from executing the create statement.
       #
@@ -86,18 +89,21 @@ module Fx
       #     $$ LANGUAGE plpgsql;
       #   SQL
       #
-      def update_function(name, version: nil, sql_definition: nil, revert_to_version: nil)
+      def update_function(name, options = {})
+        version = options[:version]
+        sql_definition = options[:sql_definition]
+
         if version.nil? && sql_definition.nil?
           raise(
             ArgumentError,
-            "version or sql_definition must be specified",
+            "version or sql_definition must be specified"
           )
         end
 
         sql_definition = sql_definition.strip_heredoc if sql_definition
         sql_definition ||= Fx::Definition.new(
           name: name,
-          version: version,
+          version: version
         ).to_sql
 
         Fx.database.update_function(name, sql_definition)

data/lib/fx/statements/trigger.rb

@@ -3,7 +3,7 @@ module Fx
     # Methods that are made available in migrations for managing Fx triggers.
     module Trigger
       # @api private
-      DEFINTION_TYPE = "trigger".freeze
+      DEFINITION_TYPE = "trigger".freeze
 
       # Create a new database trigger.
       #
@@ -24,14 +24,18 @@ module Fx
       #     CREATE TRIGGER uppercase_users_name
       #         BEFORE INSERT ON users
       #         FOR EACH ROW
-      #         EXECUTE PROCEDURE uppercase_users_name();
+      #         EXECUTE FUNCTION uppercase_users_name();
       #    SQL
       #
-      def create_trigger(name, version: nil, on: nil, sql_definition: nil)
+      def create_trigger(name, options = {})
+        version = options[:version]
+        _on = options[:on]
+        sql_definition = options[:sql_definition]
+
         if version.present? && sql_definition.present?
           raise(
             ArgumentError,
-            "sql_definition and version cannot both be set",
+            "sql_definition and version cannot both be set"
           )
         end
 
@@ -43,7 +47,7 @@ module Fx
         sql_definition ||= Fx::Definition.new(
           name: name,
           version: version,
-          type: DEFINTION_TYPE,
+          type: DEFINITION_TYPE
         ).to_sql
 
         Fx.database.create_trigger(sql_definition)
@@ -62,7 +66,8 @@ module Fx
       # @example Drop a trigger, rolling back to version 3 on rollback
       #   drop_trigger(:log_inserts, on: :users, revert_to_version: 3)
       #
-      def drop_trigger(name, on:, revert_to_version: nil)
+      def drop_trigger(name, options = {})
+        on = options.fetch(:on)
         Fx.database.drop_trigger(name, on: on)
       end
 
@@ -95,21 +100,25 @@ module Fx
       #     CREATE TRIGGER uppercase_users_name
       #         BEFORE INSERT ON users
       #         FOR EACH ROW
-      #         EXECUTE PROCEDURE uppercase_users_name();
+      #         EXECUTE FUNCTION uppercase_users_name();
       #    SQL
       #
-      def update_trigger(name, version: nil, on: nil, sql_definition: nil, revert_to_version: nil)
+      def update_trigger(name, options = {})
+        version = options[:version]
+        on = options[:on]
+        sql_definition = options[:sql_definition]
+
         if version.nil? && sql_definition.nil?
           raise(
             ArgumentError,
-            "version or sql_definition must be specified",
+            "version or sql_definition must be specified"
           )
         end
 
         if version.present? && sql_definition.present?
           raise(
             ArgumentError,
-            "sql_definition and version cannot both be set",
+            "sql_definition and version cannot both be set"
           )
         end
 
@@ -121,13 +130,13 @@ module Fx
         sql_definition ||= Fx::Definition.new(
           name: name,
           version: version,
-          type: DEFINTION_TYPE,
+          type: DEFINITION_TYPE
         ).to_sql
 
         Fx.database.update_trigger(
           name,
           on: on,
-          sql_definition: sql_definition,
+          sql_definition: sql_definition
         )
       end
     end

data/lib/fx/version.rb

@@ -1,4 +1,4 @@
 module Fx
   # @api private
-  VERSION = "0.6.2"
+  VERSION = "0.8.0"
 end

data/lib/fx.rb

@@ -19,17 +19,17 @@ module Fx
   def self.load
     ActiveRecord::Migration::CommandRecorder.send(
       :include,
-      Fx::CommandRecorder,
+      Fx::CommandRecorder
     )
 
     ActiveRecord::SchemaDumper.send(
       :prepend,
-      Fx::SchemaDumper,
+      Fx::SchemaDumper
     )
 
     ActiveRecord::ConnectionAdapters::AbstractAdapter.send(
       :include,
-      Fx::Statements,
+      Fx::Statements
     )
   end
 

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

@@ -29,12 +29,12 @@ module Fx
         if updating_existing_function?
           migration_template(
             "db/migrate/update_function.erb",
-            "db/migrate/update_function_#{file_name}_to_version_#{version}.rb",
+            "db/migrate/update_function_#{file_name}_to_version_#{version}.rb"
           )
         else
           migration_template(
             "db/migrate/create_function.erb",
-            "db/migrate/create_function_#{file_name}.rb",
+            "db/migrate/create_function_#{file_name}.rb"
           )
         end
       end
@@ -45,9 +45,9 @@ module Fx
 
       no_tasks do
         def previous_version
-          @_previous_version ||= Dir.entries(function_definition_path).
-            map { |name| version_regex.match(name).try(:[], "version").to_i }.
-            max
+          @_previous_version ||= Dir.entries(function_definition_path)
+            .map { |name| version_regex.match(name).try(:[], "version").to_i }
+            .max
         end
 
         def version
@@ -82,7 +82,7 @@ module Fx
       private
 
       def function_definition_path
-        @_function_definition_path ||= Rails.root.join(*%w(db functions))
+        @_function_definition_path ||= Rails.root.join(*%w[db functions])
       end
 
       def version_regex

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

@@ -42,9 +42,9 @@ module Fx
 
       no_tasks do
         def previous_version
-          @_previous_version ||= Dir.entries(trigger_definition_path).
-            map { |name| version_regex.match(name).try(:[], "version").to_i }.
-            max
+          @_previous_version ||= Dir.entries(trigger_definition_path)
+            .map { |name| version_regex.match(name).try(:[], "version").to_i }
+            .max
         end
 
         def version
@@ -81,7 +81,7 @@ module Fx
           if name.nil?
             raise(
               ArgumentError,
-              "Either `table_name:NAME` or `on:NAME` must be specified",
+              "Either `table_name:NAME` or `on:NAME` must be specified"
             )
           end
 
@@ -107,12 +107,12 @@ module Fx
         Fx::Definition.new(
           name: file_name,
           version: version,
-          type: "trigger",
+          type: "trigger"
         )
       end
 
       def trigger_definition_path
-        @_trigger_definition_path ||= Rails.root.join(*["db", "triggers"])
+        @_trigger_definition_path ||= Rails.root.join("db", "triggers")
       end
 
       # Skip creating migration file if:

data/spec/acceptance/user_manages_functions_spec.rb

@@ -19,7 +19,7 @@ describe "User manages functions" do
     successfully "rails generate fx:function test"
     verify_identical_definitions(
       "db/functions/test_v01.sql",
-      "db/functions/test_v02.sql",
+      "db/functions/test_v02.sql"
     )
     write_function_definition "test_v02", <<-EOS
       CREATE OR REPLACE FUNCTION test()

data/spec/acceptance/user_manages_triggers_spec.rb

@@ -18,7 +18,7 @@ describe "User manages triggers" do
       CREATE TRIGGER uppercase_users_name
           BEFORE INSERT ON users
           FOR EACH ROW
-          EXECUTE PROCEDURE uppercase_users_name();
+          EXECUTE FUNCTION uppercase_users_name();
     EOS
     successfully "rake db:migrate"
 
@@ -36,7 +36,7 @@ describe "User manages triggers" do
       CREATE TRIGGER uppercase_users_name
           BEFORE UPDATE ON users
           FOR EACH ROW
-          EXECUTE PROCEDURE uppercase_users_name();
+          EXECUTE FUNCTION uppercase_users_name();
     EOS
     successfully "rake db:migrate"
     execute <<-EOS

data/spec/acceptance_helper.rb

@@ -12,7 +12,9 @@ RSpec.configure do |config|
   config.before(:suite) do
     Dir.chdir("spec/dummy") do
       system <<-CMD
-        git init 1>/dev/null &&
+        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
@@ -24,7 +26,7 @@ RSpec.configure do |config|
       ActiveRecord::Base.connection.disconnect!
       system <<-CMD
         echo &&
-        rake db:environment:set db:drop db:create &&
+        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

data/spec/dummy/Rakefile

@@ -1,13 +1,13 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path("../config/application", __FILE__)
 
 Rails.application.load_tasks
 
-unless Rake::Task.task_defined?('db:environment:set')
-  desc 'dummy task for rails versions where this task does not exist'
-  task 'db:environment:set' do
+unless Rake::Task.task_defined?("db:environment:set")
+  desc "dummy task for rails versions where this task does not exist"
+  task "db:environment:set" do
     # no-op
   end
 end

data/spec/dummy/bin/bundle

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-load Gem.bin_path('bundler', 'bundle')
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+load Gem.bin_path("bundler", "bundle")

data/spec/dummy/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'
+APP_PATH = File.expand_path("../../config/application", __FILE__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
+require_relative "../config/boot"
+require "rake"
 Rake.application.run

data/spec/dummy/config/application.rb

@@ -11,5 +11,7 @@ module Dummy
     config.cache_classes = true
     config.eager_load = false
     config.active_support.deprecation = :stderr
+
+    config.active_record.legacy_connection_handling = false
   end
 end

data/spec/dummy/config/database.yml

@@ -1,5 +1,7 @@
 development: &default
   adapter: postgresql
+  host: 127.0.0.1
+  user: <%= ENV['POSTGRES_USER'] %>
   database: dummy_development
   encoding: unicode
   pool: 5

data/spec/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path("../config/environment", __FILE__)
 run Rails.application

data/spec/features/functions/migrations_spec.rb

@@ -51,7 +51,7 @@ describe "Function migrations", :db do
     with_function_definition(
       name: :test,
       version: 2,
-      sql_definition: sql_definition,
+      sql_definition: sql_definition
     ) do
       migration = Class.new(migration_class) do
         def change