fx 0.12.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e55ba81a671beb4b89a67e2421ac1c93100cab371b32ebbb308a588db0df7f2a
4
- data.tar.gz: 8ff2a5d68f921822dee6c797f80722cc202aadc34d00de55e8754500cc498299
3
+ metadata.gz: 86339389c52fc208597ba254eb661c5a782f6eda44d35496b96a9898617118c1
4
+ data.tar.gz: a40802ca86c3cd43653d885d632c5bb2f0ace0bbb62e3c30ee8af6b17c61dd28
5
5
  SHA512:
6
- metadata.gz: 75051bba3585dbbaa3077e3b81ff39f2e403bbb71bae02407f59be10b072b1b15c1b715c56d7fda28a1d891acb275cacfe38540a83c924aaf64a21c18a4a46aa
7
- data.tar.gz: cba9c7339f05f35de4fc81ae0ceeed2b7b849814468159641889d39cf9e1b706bb3979b4980929f2385c2fb688ca4dfb1e9bda754f0fa0d8fc18211b52749f91
6
+ metadata.gz: 834b01beab7b10185983cd8d5f43296b4b56a4a2bc62763f413f954987e88aa3b164e9d67e599d0b3b01535af7c5ae80a605423f3ad9bd8ed260878a45b517c2
7
+ data.tar.gz: 0f59f6d007e0adf3097a733444f83eda7e00c2f59898e41d12ff7b46b62261434540ecf72e2692b5decbcfe4b1428fbe1f451c98c8eabb430d72571a220915c3
@@ -12,28 +12,17 @@ set -e
12
12
 
13
13
  WARN_DAYS="${WARN_DAYS:-90}"
14
14
 
15
- ruby_min=$(ruby -e "
16
- spec = Gem::Specification.load('fx.gemspec')
17
- puts spec.required_ruby_version.requirements
18
- .select { |op, _| op == '>=' }
19
- .map { |_, v| v.segments[0..1].join('.') }
20
- .first
21
- ")
15
+ ruby_min=$(grep -E '^[ ]*spec\.required_ruby_version' fx.gemspec |
16
+ sed -E 's/.*>= *([0-9]+\.[0-9]+).*/\1/')
22
17
 
23
- rails_min=$(ruby -e "
24
- spec = Gem::Specification.load('fx.gemspec')
25
- dep = spec.dependencies.find { |d| d.name == 'activerecord' }
26
- puts dep.requirement.requirements
27
- .select { |op, _| op == '>=' }
28
- .map { |_, v| v.segments[0..1].join('.') }
29
- .first
30
- ")
18
+ rails_min=$(grep 'add_dependency "activerecord"' fx.gemspec |
19
+ sed -E 's/.*>= *([0-9]+\.[0-9]+).*/\1/')
31
20
 
32
- postgres_min=$(ruby -ryaml -e "
33
- ci = YAML.load_file('.github/workflows/ci.yml')
34
- versions = ci.dig('jobs', 'tests', 'strategy', 'matrix', 'postgres')
35
- puts versions.map(&:to_i).min
36
- ")
21
+ postgres_min=$(grep -E '^[ ]*postgres:' .github/workflows/ci.yml |
22
+ grep 'postgres:.*\[' |
23
+ sed -E 's/.*\[["]?([0-9]+).*/\1/' |
24
+ sort -n |
25
+ head -n 1)
37
26
 
38
27
  echo "Ruby minimum: $ruby_min"
39
28
  echo "Rails minimum: $rails_min"
@@ -45,18 +34,8 @@ check_eol() {
45
34
  product="$1"
46
35
  version="$2"
47
36
 
48
- eol_date=$(curl -sf "https://endoflife.date/api/${product}/${version}.json" \
49
- | ruby -rjson -e '
50
- data = JSON.parse($stdin.read)
51
- eol = data["eol"]
52
- if eol == true
53
- puts "1970-01-01"
54
- elsif eol == false
55
- exit
56
- else
57
- puts eol
58
- end
59
- ') || return 0
37
+ eol_date=$(curl -sf "https://endoflife.date/api/${product}/${version}.json" |
38
+ jq -r '.eol | if . == true then "1970-01-01" elif . == false then empty else . end') || return 0
60
39
 
61
40
  if [ -z "$eol_date" ]; then
62
41
  echo "$product $version: no EOL date set (still supported)"
@@ -64,8 +43,8 @@ check_eol() {
64
43
  fi
65
44
 
66
45
  today=$(date -u +%Y-%m-%d)
67
- warn_date=$(date -u -d "$today + ${WARN_DAYS} days" +%Y-%m-%d 2>/dev/null \
68
- || date -u -v+"${WARN_DAYS}"d +%Y-%m-%d)
46
+ warn_date=$(date -u -d "$today + ${WARN_DAYS} days" +%Y-%m-%d 2>/dev/null ||
47
+ date -u -v+"${WARN_DAYS}"d +%Y-%m-%d)
69
48
 
70
49
  if [ "$eol_date" \< "$today" ] || [ "$eol_date" = "$today" ]; then
71
50
  echo "::error::$product $version reached EOL on $eol_date"
data/CHANGELOG.md CHANGED
@@ -5,6 +5,14 @@ changelog, see the [commits] for each version via the version links.
5
5
 
6
6
  [commits]: https://github.com/teoljungberg/fx/commits/master
7
7
 
8
+ ## [0.13.0]
9
+
10
+ [0.13.0]: https://github.com/teoljungberg/fx/compare/v0.12.0...v0.13.0
11
+
12
+ - Support reversible migrations on Rails 8.2 (#220)
13
+ - Drop a versioned `create_function` and `create_trigger` without its version when reverting
14
+ - Raise `ActiveRecord::IrreversibleMigration` when reverting `create_trigger` without `on:`
15
+
8
16
  ## [0.12.0]
9
17
 
10
18
  [0.12.0]: https://github.com/teoljungberg/fx/compare/v0.11.0...v0.12.0
@@ -0,0 +1,78 @@
1
+ module Fx
2
+ module CommandRecorder
3
+ # Inverts recorded fx migration commands, so `change` migrations can be
4
+ # reverted. Holds no state across invocations and knows nothing about
5
+ # how Active Record records commands.
6
+ #
7
+ # @api private
8
+ class Inversion
9
+ MESSAGE_IRREVERSIBLE = "`%s` is reversible only if given a `revert_to_version`".freeze
10
+ private_constant :MESSAGE_IRREVERSIBLE
11
+
12
+ MESSAGE_IRREVERSIBLE_WITHOUT_TABLE = "`create_trigger` is reversible only if given `on:`".freeze
13
+ private_constant :MESSAGE_IRREVERSIBLE_WITHOUT_TABLE
14
+
15
+ # @param command [Symbol] a recorded fx command, such as `:create_function`
16
+ # @param args [Array] positional arguments of the recorded command
17
+ # @param kwargs [Hash] keyword arguments of the recorded command
18
+ # @return [Array(Symbol, Array, Hash)] the command that undoes it
19
+ # @raise [ActiveRecord::IrreversibleMigration] when undoing a drop or
20
+ # update needs a `revert_to_version` that was not given, or undoing
21
+ # a `create_trigger` needs an `on:` that was not given
22
+ # @raise [ArgumentError] when the command is not an fx command
23
+ def self.invert(command, args, kwargs)
24
+ new(command, args, kwargs).invert
25
+ end
26
+
27
+ def initialize(command, args, kwargs)
28
+ @command = command
29
+ @args = args
30
+ @kwargs = kwargs
31
+ end
32
+
33
+ # @return [Array(Symbol, Array, Hash)] the command that undoes the
34
+ # recorded command
35
+ def invert
36
+ case command
37
+ when :create_function then drop_function
38
+ when :drop_function then revert_to_version(:create_function)
39
+ when :update_function then revert_to_version(:update_function)
40
+ when :create_trigger then drop_trigger
41
+ when :drop_trigger then revert_to_version(:create_trigger)
42
+ when :update_trigger then revert_to_version(:update_trigger)
43
+ else raise ArgumentError, "`#{command}` is not an fx command"
44
+ end
45
+ end
46
+
47
+ private
48
+
49
+ attr_reader :command, :args, :kwargs
50
+
51
+ def revert_to_version(inverse_command)
52
+ revert_to_version = kwargs[:revert_to_version]
53
+
54
+ if revert_to_version.nil?
55
+ raise ActiveRecord::IrreversibleMigration, format(MESSAGE_IRREVERSIBLE, inverse_command)
56
+ end
57
+
58
+ inverse_kwargs = kwargs.except(:revert_to_version).merge(version: revert_to_version)
59
+
60
+ [inverse_command, args, inverse_kwargs]
61
+ end
62
+
63
+ def drop_function
64
+ [:drop_function, args, {}]
65
+ end
66
+
67
+ def drop_trigger
68
+ if kwargs[:on].nil?
69
+ raise ActiveRecord::IrreversibleMigration, MESSAGE_IRREVERSIBLE_WITHOUT_TABLE
70
+ end
71
+
72
+ inverse_kwargs = kwargs.slice(:on)
73
+
74
+ [:drop_trigger, args, inverse_kwargs]
75
+ end
76
+ end
77
+ end
78
+ end
@@ -0,0 +1,89 @@
1
+ require "fx/command_recorder/inversion"
2
+
3
+ module Fx
4
+ module CommandRecorder
5
+ # Records fx migration commands for Active Record before 8.2, which
6
+ # passes keyword arguments as a trailing hash flagged as keywords.
7
+ #
8
+ # This module is prepended into Active Record's command recorder, so it
9
+ # contributes only the public command methods to that class; the
10
+ # pre-8.2 argument-shape translation lives in private proc constants,
11
+ # which prepending does not copy into the host.
12
+ #
13
+ # @api private
14
+ module Legacy
15
+ FOLD = ->(args, kwargs) do
16
+ if kwargs.empty?
17
+ args
18
+ else
19
+ [*args, Hash.ruby2_keywords_hash(kwargs)]
20
+ end
21
+ end
22
+ private_constant :FOLD
23
+
24
+ SPLIT = ->(args) do
25
+ if args.last.is_a?(Hash)
26
+ [args[0...-1], args.last]
27
+ else
28
+ [args, {}]
29
+ end
30
+ end
31
+ private_constant :SPLIT
32
+
33
+ INVERT = ->(command, args) do
34
+ inverse, inverse_args, inverse_kwargs = Inversion.invert(command, *SPLIT.call(args))
35
+
36
+ [inverse, FOLD.call(inverse_args, inverse_kwargs)]
37
+ end
38
+ private_constant :INVERT
39
+
40
+ def create_function(*args, **kwargs, &block)
41
+ record(:create_function, FOLD.call(args, kwargs), &block)
42
+ end
43
+
44
+ def drop_function(*args, **kwargs, &block)
45
+ record(:drop_function, FOLD.call(args, kwargs), &block)
46
+ end
47
+
48
+ def update_function(*args, **kwargs, &block)
49
+ record(:update_function, FOLD.call(args, kwargs), &block)
50
+ end
51
+
52
+ def invert_create_function(args)
53
+ INVERT.call(:create_function, args)
54
+ end
55
+
56
+ def invert_drop_function(args)
57
+ INVERT.call(:drop_function, args)
58
+ end
59
+
60
+ def invert_update_function(args)
61
+ INVERT.call(:update_function, args)
62
+ end
63
+
64
+ def create_trigger(*args, **kwargs, &block)
65
+ record(:create_trigger, FOLD.call(args, kwargs), &block)
66
+ end
67
+
68
+ def drop_trigger(*args, **kwargs, &block)
69
+ record(:drop_trigger, FOLD.call(args, kwargs), &block)
70
+ end
71
+
72
+ def update_trigger(*args, **kwargs, &block)
73
+ record(:update_trigger, FOLD.call(args, kwargs), &block)
74
+ end
75
+
76
+ def invert_create_trigger(args)
77
+ INVERT.call(:create_trigger, args)
78
+ end
79
+
80
+ def invert_drop_trigger(args)
81
+ INVERT.call(:drop_trigger, args)
82
+ end
83
+
84
+ def invert_update_trigger(args)
85
+ INVERT.call(:update_trigger, args)
86
+ end
87
+ end
88
+ end
89
+ end
@@ -1,120 +1,59 @@
1
+ require "fx/command_recorder/inversion"
2
+ require "fx/command_recorder/legacy"
3
+
1
4
  module Fx
5
+ # Records fx migration commands so `change` migrations can be reverted.
6
+ # Active Record 8.2+ passes positional and keyword arguments separately;
7
+ # {Fx::CommandRecorder::Legacy} covers earlier versions.
8
+ #
2
9
  # @api private
3
10
  module CommandRecorder
4
- def create_function(*args, &block)
5
- record(:create_function, args, &block)
6
- end
7
- ruby2_keywords :create_function
8
-
9
- def drop_function(*args, &block)
10
- record(:drop_function, args, &block)
11
- end
12
- ruby2_keywords :drop_function
13
-
14
- def update_function(*args, &block)
15
- record(:update_function, args, &block)
11
+ def create_function(*args, **kwargs, &block)
12
+ record(:create_function, args, kwargs, &block)
16
13
  end
17
- ruby2_keywords :update_function
18
14
 
19
- def invert_create_function(args)
20
- [:drop_function, args]
15
+ def drop_function(*args, **kwargs, &block)
16
+ record(:drop_function, args, kwargs, &block)
21
17
  end
22
18
 
23
- def invert_drop_function(args)
24
- perform_inversion(:create_function, args)
19
+ def update_function(*args, **kwargs, &block)
20
+ record(:update_function, args, kwargs, &block)
25
21
  end
26
22
 
27
- def invert_update_function(args)
28
- perform_inversion(:update_function, args)
23
+ def invert_create_function(args, kwargs)
24
+ Fx::CommandRecorder::Inversion.invert(:create_function, args, kwargs)
29
25
  end
30
26
 
31
- def create_trigger(*args, &block)
32
- record(:create_trigger, args, &block)
27
+ def invert_drop_function(args, kwargs)
28
+ Fx::CommandRecorder::Inversion.invert(:drop_function, args, kwargs)
33
29
  end
34
- ruby2_keywords :create_trigger
35
30
 
36
- def drop_trigger(*args, &block)
37
- record(:drop_trigger, args, &block)
31
+ def invert_update_function(args, kwargs)
32
+ Fx::CommandRecorder::Inversion.invert(:update_function, args, kwargs)
38
33
  end
39
- ruby2_keywords :drop_trigger
40
34
 
41
- def update_trigger(*args, &block)
42
- record(:update_trigger, args, &block)
35
+ def create_trigger(*args, **kwargs, &block)
36
+ record(:create_trigger, args, kwargs, &block)
43
37
  end
44
- ruby2_keywords :update_trigger
45
38
 
46
- def invert_create_trigger(args)
47
- [:drop_trigger, args]
39
+ def drop_trigger(*args, **kwargs, &block)
40
+ record(:drop_trigger, args, kwargs, &block)
48
41
  end
49
42
 
50
- def invert_drop_trigger(args)
51
- perform_inversion(:create_trigger, args)
43
+ def update_trigger(*args, **kwargs, &block)
44
+ record(:update_trigger, args, kwargs, &block)
52
45
  end
53
46
 
54
- def invert_update_trigger(args)
55
- perform_inversion(:update_trigger, args)
47
+ def invert_create_trigger(args, kwargs)
48
+ Fx::CommandRecorder::Inversion.invert(:create_trigger, args, kwargs)
56
49
  end
57
50
 
58
- private
59
-
60
- MESSAGE_IRREVERSIBLE = "`%s` is reversible only if given a `revert_to_version`".freeze
61
-
62
- def perform_inversion(method, args)
63
- arguments = Arguments.new(args)
64
-
65
- if arguments.revert_to_version.nil?
66
- raise ActiveRecord::IrreversibleMigration, format(MESSAGE_IRREVERSIBLE, method)
67
- end
68
-
69
- [method, arguments.invert_version.to_a]
51
+ def invert_drop_trigger(args, kwargs)
52
+ Fx::CommandRecorder::Inversion.invert(:drop_trigger, args, kwargs)
70
53
  end
71
54
 
72
- class Arguments
73
- def initialize(args)
74
- @args = args.freeze
75
- end
76
-
77
- def function
78
- args.fetch(0)
79
- end
80
-
81
- def version
82
- options.fetch(:version)
83
- end
84
-
85
- def revert_to_version
86
- options.fetch(:revert_to_version, nil)
87
- end
88
-
89
- def invert_version
90
- self.class.new([function, options_for_revert])
91
- end
92
-
93
- def to_a
94
- args.to_a
95
- end
96
-
97
- private
98
-
99
- attr_reader :args
100
-
101
- def options
102
- @options ||= args.fetch(1, {}).dup
103
- end
104
-
105
- def options_for_revert
106
- opts = options.clone.tap do |revert_options|
107
- revert_options[:version] = revert_to_version
108
- revert_options.delete(:revert_to_version)
109
- end
110
-
111
- keyword_hash(opts)
112
- end
113
-
114
- def keyword_hash(hash)
115
- Hash.ruby2_keywords_hash(hash)
116
- end
55
+ def invert_update_trigger(args, kwargs)
56
+ Fx::CommandRecorder::Inversion.invert(:update_trigger, args, kwargs)
117
57
  end
118
- private_constant :Arguments
119
58
  end
120
59
  end
data/lib/fx/version.rb CHANGED
@@ -1,4 +1,4 @@
1
1
  module Fx
2
2
  # @api private
3
- VERSION = "0.12.0"
3
+ VERSION = "0.13.0"
4
4
  end
data/lib/fx.rb CHANGED
@@ -19,7 +19,14 @@ module Fx
19
19
  # Enables fx migration methods, migration reversability, and `schema.rb`
20
20
  # dumping.
21
21
  def self.load
22
- ActiveRecord::Migration::CommandRecorder.include(Fx::CommandRecorder)
22
+ # Active Record 8.2 passes keyword arguments to `record` separately.
23
+ # Prepend, not include: if Rails ever defines these commands itself,
24
+ # fx's versions keep winning instead of silently losing to the class.
25
+ if ActiveRecord.gem_version >= Gem::Version.new("8.2.0.alpha")
26
+ ActiveRecord::Migration::CommandRecorder.prepend(Fx::CommandRecorder)
27
+ else
28
+ ActiveRecord::Migration::CommandRecorder.prepend(Fx::CommandRecorder::Legacy)
29
+ end
23
30
  ActiveRecord::ConnectionAdapters::AbstractAdapter.include(Fx::Statements)
24
31
  ActiveRecord::SchemaDumper.prepend(Fx::SchemaDumper)
25
32
 
@@ -25,6 +25,16 @@ RSpec.describe "Reverting migrations", :db do
25
25
  expect { run_migration(migration, [:up, :down]) }.not_to raise_error
26
26
  end
27
27
 
28
+ it "can run reversible migrations for creating functions at a version" do
29
+ migration = Class.new(migration_class) do
30
+ def change
31
+ create_function :test, version: 1
32
+ end
33
+ end
34
+
35
+ expect { run_migration(migration, [:up, :down]) }.not_to raise_error
36
+ end
37
+
28
38
  it "can run reversible migrations for dropping functions" do
29
39
  connection.create_function(:test)
30
40
 
@@ -42,6 +42,16 @@ RSpec.describe "Reverting migrations", :db do
42
42
  expect { run_migration(migration, [:up, :down]) }.not_to raise_error
43
43
  end
44
44
 
45
+ it "can run reversible migrations for creating triggers at a version" do
46
+ migration = Class.new(migration_class) do
47
+ def change
48
+ create_trigger :uppercase_users_name, on: :users, version: 1
49
+ end
50
+ end
51
+
52
+ expect { run_migration(migration, [:up, :down]) }.not_to raise_error
53
+ end
54
+
45
55
  it "can run reversible migrations for dropping triggers" do
46
56
  connection.create_trigger(:uppercase_users_name, on: :users)
47
57
 
@@ -0,0 +1,77 @@
1
+ require "spec_helper"
2
+
3
+ RSpec.describe Fx::CommandRecorder::Inversion do
4
+ describe ".invert" do
5
+ it "drops a created function" do
6
+ inverse = described_class.invert(:create_function, [:test], {})
7
+
8
+ expect(inverse).to eq([:drop_function, [:test], {}])
9
+ end
10
+
11
+ it "drops a created function without its version" do
12
+ inverse = described_class.invert(:create_function, [:test], {version: 2})
13
+
14
+ expect(inverse).to eq([:drop_function, [:test], {}])
15
+ end
16
+
17
+ it "creates a dropped function at its revert_to_version" do
18
+ inverse = described_class.invert(:drop_function, [:test], {revert_to_version: 3})
19
+
20
+ expect(inverse).to eq([:create_function, [:test], {version: 3}])
21
+ end
22
+
23
+ it "updates an updated function back to its revert_to_version" do
24
+ inverse = described_class.invert(:update_function, [:test], {version: 2, revert_to_version: 1})
25
+
26
+ expect(inverse).to eq([:update_function, [:test], {version: 1}])
27
+ end
28
+
29
+ it "drops a created trigger on its table" do
30
+ inverse = described_class.invert(:create_trigger, [:greetings], {on: :users})
31
+
32
+ expect(inverse).to eq([:drop_trigger, [:greetings], {on: :users}])
33
+ end
34
+
35
+ it "raises when a created trigger has no table" do
36
+ expect do
37
+ described_class.invert(:create_trigger, [:greetings], {})
38
+ end.to raise_error(ActiveRecord::IrreversibleMigration, /`on:`/)
39
+ end
40
+
41
+ it "drops a created trigger on its table without its version" do
42
+ inverse = described_class.invert(:create_trigger, [:greetings], {on: :users, version: 2})
43
+
44
+ expect(inverse).to eq([:drop_trigger, [:greetings], {on: :users}])
45
+ end
46
+
47
+ it "creates a dropped trigger at its revert_to_version" do
48
+ inverse = described_class.invert(:drop_trigger, [:greetings], {on: :users, revert_to_version: 3})
49
+
50
+ expect(inverse).to eq([:create_trigger, [:greetings], {on: :users, version: 3}])
51
+ end
52
+
53
+ it "updates an updated trigger back to its revert_to_version" do
54
+ inverse = described_class.invert(:update_trigger, [:greetings], {on: :users, version: 2, revert_to_version: 1})
55
+
56
+ expect(inverse).to eq([:update_trigger, [:greetings], {on: :users, version: 1}])
57
+ end
58
+
59
+ it "raises when a drop has no revert_to_version" do
60
+ expect do
61
+ described_class.invert(:drop_function, [:test], {})
62
+ end.to raise_error(ActiveRecord::IrreversibleMigration, /`create_function`/)
63
+ end
64
+
65
+ it "raises when an update has no revert_to_version" do
66
+ expect do
67
+ described_class.invert(:update_trigger, [:greetings], {version: 2})
68
+ end.to raise_error(ActiveRecord::IrreversibleMigration, /`update_trigger`/)
69
+ end
70
+
71
+ it "raises for a command fx does not record" do
72
+ expect do
73
+ described_class.invert(:create_table, [:users], {})
74
+ end.to raise_error(ArgumentError, /`create_table` is not an fx command/)
75
+ end
76
+ end
77
+ end
@@ -0,0 +1,74 @@
1
+ require "spec_helper"
2
+
3
+ RSpec.describe Fx::CommandRecorder::Legacy do
4
+ it "records keyword arguments as a trailing hash flagged as keywords" do
5
+ recorder = build_recorder
6
+
7
+ recorder.update_function(:test, version: 2)
8
+
9
+ command, args = recorder.recorded
10
+ expect(command).to eq(:update_function)
11
+ expect(args).to eq([:test, {version: 2}])
12
+ expect(Hash.ruby2_keywords_hash?(args.last)).to eq(true)
13
+ end
14
+
15
+ it "records commands without keyword arguments as positional arguments" do
16
+ recorder = build_recorder
17
+
18
+ recorder.create_function(:test)
19
+
20
+ expect(recorder.recorded).to eq([:create_function, [:test]])
21
+ end
22
+
23
+ it "documents a positional options hash end to end" do
24
+ recorder = build_recorder
25
+
26
+ # Ruby 3: braces with parentheses mean the options hash travels as a
27
+ # positional, non-keyword argument. Inversion keeps the recorded shape
28
+ # and the drop inverse takes no version.
29
+ recorder.create_function(:test, {version: 2})
30
+
31
+ command, args = recorder.recorded
32
+ expect(command).to eq(:create_function)
33
+ expect(args).to eq([:test, {version: 2}])
34
+ expect(Hash.ruby2_keywords_hash?(args.last)).to eq(false)
35
+
36
+ inverse_command, inverse_args = recorder.invert_create_function(args)
37
+ expect(inverse_command).to eq(:drop_function)
38
+ expect(inverse_args).to eq([:test])
39
+ end
40
+
41
+ it "inverts a trailing hash flagged as keywords" do
42
+ recorder = build_recorder
43
+ args = [:test, Hash.ruby2_keywords_hash({version: 2, revert_to_version: 1})]
44
+
45
+ command, inverse_args = recorder.invert_update_function(args)
46
+
47
+ expect(command).to eq(:update_function)
48
+ expect(inverse_args).to eq([:test, {version: 1}])
49
+ expect(Hash.ruby2_keywords_hash?(inverse_args.last)).to eq(true)
50
+ end
51
+
52
+ it "inverts a trailing hash not flagged as keywords" do
53
+ recorder = build_recorder
54
+ args = [:test, {revert_to_version: 1}]
55
+
56
+ command, inverse_args = recorder.invert_drop_function(args)
57
+
58
+ expect(command).to eq(:create_function)
59
+ expect(inverse_args).to eq([:test, {version: 1}])
60
+ expect(Hash.ruby2_keywords_hash?(inverse_args.last)).to eq(true)
61
+ end
62
+
63
+ def build_recorder
64
+ Class.new do
65
+ include Fx::CommandRecorder::Legacy
66
+
67
+ attr_reader :recorded
68
+
69
+ def record(*command)
70
+ @recorded = command
71
+ end
72
+ end.new
73
+ end
74
+ end
@@ -1,49 +1,54 @@
1
1
  require "spec_helper"
2
2
 
3
- RSpec.describe Fx::CommandRecorder, :db do
3
+ RSpec.describe "Fx command recorder", :db do
4
4
  describe "#create_function" do
5
5
  it "records the created function" do
6
6
  recorder = ActiveRecord::Migration::CommandRecorder.new
7
+ migration = double("migration", create_function: nil)
7
8
 
8
9
  recorder.create_function :test
10
+ recorder.replay(migration)
9
11
 
10
- expect(recorder.commands).to eq([[:create_function, [:test], nil]])
12
+ expect(migration).to have_received(:create_function).with(:test)
11
13
  end
12
14
 
13
15
  it "reverts to drop_function" do
14
16
  recorder = ActiveRecord::Migration::CommandRecorder.new
17
+ migration = double("migration", drop_function: nil)
15
18
 
16
19
  recorder.revert { recorder.create_function :test }
20
+ recorder.replay(migration)
17
21
 
18
- expect(recorder.commands).to eq([[:drop_function, [:test]]])
22
+ expect(migration).to have_received(:drop_function).with(:test)
19
23
  end
20
24
  end
21
25
 
22
26
  describe "#drop_function" do
23
27
  it "records the dropped function" do
24
28
  recorder = ActiveRecord::Migration::CommandRecorder.new
29
+ migration = double("migration", drop_function: nil)
25
30
 
26
31
  recorder.drop_function :test
32
+ recorder.replay(migration)
27
33
 
28
- expect(recorder.commands).to eq([[:drop_function, [:test], nil]])
34
+ expect(migration).to have_received(:drop_function).with(:test)
29
35
  end
30
36
 
31
37
  it "reverts to create_function with specified revert_to_version" do
32
38
  recorder = ActiveRecord::Migration::CommandRecorder.new
33
- args = [:test, {revert_to_version: 3}]
34
- revert_args = [:test, {version: 3}]
39
+ migration = double("migration", create_function: nil)
35
40
 
36
- recorder.revert { recorder.drop_function(*args) }
41
+ recorder.revert { recorder.drop_function(:test, revert_to_version: 3) }
42
+ recorder.replay(migration)
37
43
 
38
- expect(recorder.commands).to eq([[:create_function, revert_args]])
44
+ expect(migration).to have_received(:create_function).with(:test, version: 3)
39
45
  end
40
46
 
41
47
  it "raises when reverting without revert_to_version set" do
42
48
  recorder = ActiveRecord::Migration::CommandRecorder.new
43
- args = [:test, {another_argument: 1}]
44
49
 
45
50
  expect do
46
- recorder.revert { recorder.drop_function(*args) }
51
+ recorder.revert { recorder.drop_function(:test, another_argument: 1) }
47
52
  end.to raise_error(ActiveRecord::IrreversibleMigration)
48
53
  end
49
54
  end
@@ -51,29 +56,29 @@ RSpec.describe Fx::CommandRecorder, :db do
51
56
  describe "#update_function" do
52
57
  it "records the updated function" do
53
58
  recorder = ActiveRecord::Migration::CommandRecorder.new
54
- args = [:test, {version: 2}]
59
+ migration = double("migration", update_function: nil)
55
60
 
56
- recorder.update_function(*args)
61
+ recorder.update_function(:test, version: 2)
62
+ recorder.replay(migration)
57
63
 
58
- expect(recorder.commands).to eq([[:update_function, args, nil]])
64
+ expect(migration).to have_received(:update_function).with(:test, version: 2)
59
65
  end
60
66
 
61
67
  it "reverts to update_function with the specified revert_to_version" do
62
68
  recorder = ActiveRecord::Migration::CommandRecorder.new
63
- args = [:test, {version: 2, revert_to_version: 1}]
64
- revert_args = [:test, {version: 1}]
69
+ migration = double("migration", update_function: nil)
65
70
 
66
- recorder.revert { recorder.update_function(*args) }
71
+ recorder.revert { recorder.update_function(:test, version: 2, revert_to_version: 1) }
72
+ recorder.replay(migration)
67
73
 
68
- expect(recorder.commands).to eq([[:update_function, revert_args]])
74
+ expect(migration).to have_received(:update_function).with(:test, version: 1)
69
75
  end
70
76
 
71
77
  it "raises when reverting without revert_to_version set" do
72
78
  recorder = ActiveRecord::Migration::CommandRecorder.new
73
- args = [:test, {version: 42, another_argument: 1}]
74
79
 
75
80
  expect do
76
- recorder.revert { recorder.update_function(*args) }
81
+ recorder.revert { recorder.update_function(:test, version: 42, another_argument: 1) }
77
82
  end.to raise_error(ActiveRecord::IrreversibleMigration)
78
83
  end
79
84
  end
@@ -81,46 +86,59 @@ RSpec.describe Fx::CommandRecorder, :db do
81
86
  describe "#create_trigger" do
82
87
  it "records the created trigger" do
83
88
  recorder = ActiveRecord::Migration::CommandRecorder.new
89
+ migration = double("migration", create_trigger: nil)
84
90
 
85
91
  recorder.create_trigger :greetings
92
+ recorder.replay(migration)
86
93
 
87
- expect(recorder.commands).to eq([[:create_trigger, [:greetings], nil]])
94
+ expect(migration).to have_received(:create_trigger).with(:greetings)
88
95
  end
89
96
 
90
- it "reverts to drop_trigger" do
97
+ it "reverts to drop_trigger on its table" do
91
98
  recorder = ActiveRecord::Migration::CommandRecorder.new
99
+ migration = double("migration", drop_trigger: nil)
92
100
 
93
- recorder.revert { recorder.create_trigger :greetings }
101
+ recorder.revert { recorder.create_trigger(:greetings, on: :users) }
102
+ recorder.replay(migration)
94
103
 
95
- expect(recorder.commands).to eq([[:drop_trigger, [:greetings]]])
104
+ expect(migration).to have_received(:drop_trigger).with(:greetings, on: :users)
105
+ end
106
+
107
+ it "raises when reverting without on set" do
108
+ recorder = ActiveRecord::Migration::CommandRecorder.new
109
+
110
+ expect do
111
+ recorder.revert { recorder.create_trigger :greetings }
112
+ end.to raise_error(ActiveRecord::IrreversibleMigration)
96
113
  end
97
114
  end
98
115
 
99
116
  describe "#drop_trigger" do
100
117
  it "records the dropped trigger" do
101
118
  recorder = ActiveRecord::Migration::CommandRecorder.new
119
+ migration = double("migration", drop_trigger: nil)
102
120
 
103
121
  recorder.drop_trigger :users
122
+ recorder.replay(migration)
104
123
 
105
- expect(recorder.commands).to eq([[:drop_trigger, [:users], nil]])
124
+ expect(migration).to have_received(:drop_trigger).with(:users)
106
125
  end
107
126
 
108
127
  it "reverts to create_trigger with specified revert_to_version" do
109
128
  recorder = ActiveRecord::Migration::CommandRecorder.new
110
- args = [:users, {revert_to_version: 3}]
111
- revert_args = [:users, {version: 3}]
129
+ migration = double("migration", create_trigger: nil)
112
130
 
113
- recorder.revert { recorder.drop_trigger(*args) }
131
+ recorder.revert { recorder.drop_trigger(:users, revert_to_version: 3) }
132
+ recorder.replay(migration)
114
133
 
115
- expect(recorder.commands).to eq([[:create_trigger, revert_args]])
134
+ expect(migration).to have_received(:create_trigger).with(:users, version: 3)
116
135
  end
117
136
 
118
137
  it "raises when reverting without revert_to_version set" do
119
138
  recorder = ActiveRecord::Migration::CommandRecorder.new
120
- args = [:users, {another_argument: 1}]
121
139
 
122
140
  expect do
123
- recorder.revert { recorder.drop_trigger(*args) }
141
+ recorder.revert { recorder.drop_trigger(:users, another_argument: 1) }
124
142
  end.to raise_error(ActiveRecord::IrreversibleMigration)
125
143
  end
126
144
  end
@@ -128,29 +146,29 @@ RSpec.describe Fx::CommandRecorder, :db do
128
146
  describe "#update_trigger" do
129
147
  it "records the updated trigger" do
130
148
  recorder = ActiveRecord::Migration::CommandRecorder.new
131
- args = [:users, {version: 2}]
149
+ migration = double("migration", update_trigger: nil)
132
150
 
133
- recorder.update_trigger(*args)
151
+ recorder.update_trigger(:users, version: 2)
152
+ recorder.replay(migration)
134
153
 
135
- expect(recorder.commands).to eq([[:update_trigger, args, nil]])
154
+ expect(migration).to have_received(:update_trigger).with(:users, version: 2)
136
155
  end
137
156
 
138
157
  it "reverts to update_trigger with the specified revert_to_version" do
139
158
  recorder = ActiveRecord::Migration::CommandRecorder.new
140
- args = [:users, {version: 2, revert_to_version: 1}]
141
- revert_args = [:users, {version: 1}]
159
+ migration = double("migration", update_trigger: nil)
142
160
 
143
- recorder.revert { recorder.update_trigger(*args) }
161
+ recorder.revert { recorder.update_trigger(:users, version: 2, revert_to_version: 1) }
162
+ recorder.replay(migration)
144
163
 
145
- expect(recorder.commands).to eq([[:update_trigger, revert_args]])
164
+ expect(migration).to have_received(:update_trigger).with(:users, version: 1)
146
165
  end
147
166
 
148
167
  it "raises when reverting without revert_to_version set" do
149
168
  recorder = ActiveRecord::Migration::CommandRecorder.new
150
- args = [:users, {version: 42, another_argument: 1}]
151
169
 
152
170
  expect do
153
- recorder.revert { recorder.update_trigger(*args) }
171
+ recorder.revert { recorder.update_trigger(:users, version: 42, another_argument: 1) }
154
172
  end.to raise_error(ActiveRecord::IrreversibleMigration)
155
173
  end
156
174
  end
data/spec/fx_spec.rb CHANGED
@@ -7,11 +7,52 @@ RSpec.describe Fx do
7
7
 
8
8
  it "loads fx into ActiveRecord" do
9
9
  expect(Fx.load).to eq(true)
10
- expect(ActiveRecord::Migration::CommandRecorder).to include(Fx::CommandRecorder)
10
+ expect(ActiveRecord::Migration::CommandRecorder.ancestors.first)
11
+ .to eq(Fx::CommandRecorder).or eq(Fx::CommandRecorder::Legacy)
11
12
  expect(ActiveRecord::ConnectionAdapters::AbstractAdapter).to include(Fx::Statements)
12
13
  expect(ActiveRecord::SchemaDumper).to include(Fx::SchemaDumper)
13
14
  end
14
15
 
16
+ it "records fx commands through a plain CommandRecorder" do
17
+ Fx.load
18
+
19
+ recorder = ActiveRecord::Migration::CommandRecorder.new
20
+
21
+ recorder.create_function :horses, version: 2
22
+
23
+ expect(recorder.commands.first.first).to eq(:create_function)
24
+ end
25
+
26
+ it "inverts fx commands through a plain CommandRecorder" do
27
+ Fx.load
28
+
29
+ recorder = ActiveRecord::Migration::CommandRecorder.new
30
+
31
+ recorder.revert { recorder.create_function :horses, version: 2 }
32
+
33
+ expect(recorder.commands.last.first).to eq(:drop_function)
34
+ end
35
+
36
+ it "loads the command recorder on Active Record 8.2" do
37
+ command_recorder = stub_command_recorder
38
+ stub_active_record_version("8.2.0.alpha")
39
+
40
+ Fx.load
41
+
42
+ expect(command_recorder).to include(Fx::CommandRecorder)
43
+ expect(command_recorder).not_to include(Fx::CommandRecorder::Legacy)
44
+ end
45
+
46
+ it "loads the legacy command recorder before Active Record 8.2" do
47
+ command_recorder = stub_command_recorder
48
+ stub_active_record_version("8.1.1")
49
+
50
+ Fx.load
51
+
52
+ expect(command_recorder).to include(Fx::CommandRecorder::Legacy)
53
+ expect(command_recorder).not_to include(Fx::CommandRecorder)
54
+ end
55
+
15
56
  it "allows configuration" do
16
57
  adapter = double("Fx Adapter")
17
58
 
@@ -25,4 +66,12 @@ RSpec.describe Fx do
25
66
 
26
67
  Fx.configuration = nil
27
68
  end
69
+
70
+ def stub_command_recorder
71
+ stub_const("ActiveRecord::Migration::CommandRecorder", Class.new)
72
+ end
73
+
74
+ def stub_active_record_version(version)
75
+ allow(ActiveRecord).to receive(:gem_version).and_return(Gem::Version.new(version))
76
+ end
28
77
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fx
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.12.0
4
+ version: 0.13.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Teo Ljungberg
@@ -73,6 +73,8 @@ files:
73
73
  - lib/fx/adapters/postgres/query_executor.rb
74
74
  - lib/fx/adapters/postgres/triggers.rb
75
75
  - lib/fx/command_recorder.rb
76
+ - lib/fx/command_recorder/inversion.rb
77
+ - lib/fx/command_recorder/legacy.rb
76
78
  - lib/fx/configuration.rb
77
79
  - lib/fx/definition.rb
78
80
  - lib/fx/function.rb
@@ -115,6 +117,8 @@ files:
115
117
  - spec/fx/adapters/postgres/query_executor_spec.rb
116
118
  - spec/fx/adapters/postgres/triggers_spec.rb
117
119
  - spec/fx/adapters/postgres_spec.rb
120
+ - spec/fx/command_recorder/inversion_spec.rb
121
+ - spec/fx/command_recorder/legacy_spec.rb
118
122
  - spec/fx/command_recorder_spec.rb
119
123
  - spec/fx/configuration_spec.rb
120
124
  - spec/fx/definition_spec.rb
@@ -139,7 +143,7 @@ licenses:
139
143
  - MIT
140
144
  metadata:
141
145
  bug_tracker_uri: https://github.com/teoljungberg/fx/issues
142
- changelog_uri: https://github.com/teoljungberg/fx/blob/v0.12.0/CHANGELOG.md
146
+ changelog_uri: https://github.com/teoljungberg/fx/blob/v0.13.0/CHANGELOG.md
143
147
  homepage_uri: https://github.com/teoljungberg/fx
144
148
  source_code_uri: https://github.com/teoljungberg/fx
145
149
  rdoc_options: []
@@ -156,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
156
160
  - !ruby/object:Gem::Version
157
161
  version: '0'
158
162
  requirements: []
159
- rubygems_version: 4.0.3
163
+ rubygems_version: 4.0.6
160
164
  specification_version: 4
161
165
  summary: Support for database functions and triggers in Rails migrations
162
166
  test_files: []