1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/activesupport/test/lazy_load_hooks_test.rb
Edouard CHIN 6cf7a0b0e9 Use class_eval or instance_eval when triggering lazy load hooks:
- When lazy load hooks were triggered we were using
  `Object.instance_eval` which evaluates the block in the context of
  the class being passed. Most of the time that class was a
  `Class`. If one wants to define a instance method on the class then
  it wasn't possible.

  ```ruby
    class A; end;
    A.instance_eval do
      def foo
        puts 'bar'
      end
    end
    A.new.foo #> NoMethodError: undefined method `foo`
    A.foo #> bar
  ```
- This PR checks what object is passed when triggering the hooks and
  either call `class_eval` or `instance_eval`. My rational and assumptions being
  that if an instance of a class is passed, then the blocks needs to
  evaluate in the context of that instance (i.e. defining a method
  should only define it on that instance).
  On the other hand, if a Class or Module is passed when triggering
  hooks, then defining a method should define it on the class itself
- #32776 Pushed me to introduce this change
2018-07-03 23:29:43 -04:00

189 lines
5.3 KiB
Ruby

# frozen_string_literal: true
require "abstract_unit"
require "active_support/core_ext/module/remove_method"
class LazyLoadHooksTest < ActiveSupport::TestCase
def test_basic_hook
i = 0
ActiveSupport.on_load(:basic_hook) { i += 1 }
ActiveSupport.run_load_hooks(:basic_hook)
assert_equal 1, i
end
def test_basic_hook_with_two_registrations
i = 0
ActiveSupport.on_load(:basic_hook_with_two) { i += incr }
assert_equal 0, i
ActiveSupport.run_load_hooks(:basic_hook_with_two, FakeContext.new(2))
assert_equal 2, i
ActiveSupport.run_load_hooks(:basic_hook_with_two, FakeContext.new(5))
assert_equal 7, i
end
def test_basic_hook_with_two_registrations_only_once
i = 0
block = proc { i += incr }
ActiveSupport.on_load(:basic_hook_with_two_once, run_once: true, &block)
ActiveSupport.on_load(:basic_hook_with_two_once) do
i += incr
end
ActiveSupport.on_load(:different_hook, run_once: true, &block)
ActiveSupport.run_load_hooks(:different_hook, FakeContext.new(2))
assert_equal 2, i
ActiveSupport.run_load_hooks(:basic_hook_with_two_once, FakeContext.new(2))
assert_equal 6, i
ActiveSupport.run_load_hooks(:basic_hook_with_two_once, FakeContext.new(5))
assert_equal 11, i
end
def test_hook_registered_after_run
i = 0
ActiveSupport.run_load_hooks(:registered_after)
assert_equal 0, i
ActiveSupport.on_load(:registered_after) { i += 1 }
assert_equal 1, i
end
def test_hook_registered_after_run_with_two_registrations
i = 0
ActiveSupport.run_load_hooks(:registered_after_with_two, FakeContext.new(2))
ActiveSupport.run_load_hooks(:registered_after_with_two, FakeContext.new(5))
assert_equal 0, i
ActiveSupport.on_load(:registered_after_with_two) { i += incr }
assert_equal 7, i
end
def test_hook_registered_after_run_with_two_registrations_only_once
i = 0
ActiveSupport.run_load_hooks(:registered_after_with_two_once, FakeContext.new(2))
ActiveSupport.run_load_hooks(:registered_after_with_two_once, FakeContext.new(5))
assert_equal 0, i
ActiveSupport.on_load(:registered_after_with_two_once, run_once: true) { i += incr }
assert_equal 2, i
end
def test_hook_registered_interleaved_run_with_two_registrations
i = 0
ActiveSupport.run_load_hooks(:registered_interleaved_with_two, FakeContext.new(2))
assert_equal 0, i
ActiveSupport.on_load(:registered_interleaved_with_two) { i += incr }
assert_equal 2, i
ActiveSupport.run_load_hooks(:registered_interleaved_with_two, FakeContext.new(5))
assert_equal 7, i
end
def test_hook_registered_interleaved_run_with_two_registrations_once
i = 0
ActiveSupport
.run_load_hooks(:registered_interleaved_with_two_once, FakeContext.new(2))
assert_equal 0, i
ActiveSupport.on_load(:registered_interleaved_with_two_once, run_once: true) do
i += incr
end
assert_equal 2, i
ActiveSupport
.run_load_hooks(:registered_interleaved_with_two_once, FakeContext.new(5))
assert_equal 2, i
end
def test_hook_receives_a_context
i = 0
ActiveSupport.on_load(:contextual) { i += incr }
assert_equal 0, i
ActiveSupport.run_load_hooks(:contextual, FakeContext.new(2))
assert_equal 2, i
end
def test_hook_receives_a_context_afterward
i = 0
ActiveSupport.run_load_hooks(:contextual_after, FakeContext.new(2))
assert_equal 0, i
ActiveSupport.on_load(:contextual_after) { i += incr }
assert_equal 2, i
end
def test_hook_with_yield_true
i = 0
ActiveSupport.on_load(:contextual_yield, yield: true) do |obj|
i += obj.incr + incr_amt
end
assert_equal 0, i
ActiveSupport.run_load_hooks(:contextual_yield, FakeContext.new(2))
assert_equal 7, i
end
def test_hook_with_yield_true_afterward
i = 0
ActiveSupport.run_load_hooks(:contextual_yield_after, FakeContext.new(2))
assert_equal 0, i
ActiveSupport.on_load(:contextual_yield_after, yield: true) do |obj|
i += obj.incr + incr_amt
end
assert_equal 7, i
end
def test_hook_uses_class_eval_when_base_is_a_class
ActiveSupport.on_load(:uses_class_eval) do
def first_wrestler
"John Cena"
end
end
ActiveSupport.run_load_hooks(:uses_class_eval, FakeContext)
assert_equal "John Cena", FakeContext.new(0).first_wrestler
ensure
FakeContext.remove_possible_method(:first_wrestler)
end
def test_hook_uses_class_eval_when_base_is_a_module
mod = Module.new
ActiveSupport.on_load(:uses_class_eval2) do
def last_wrestler
"Dwayne Johnson"
end
end
ActiveSupport.run_load_hooks(:uses_class_eval2, mod)
klass = Class.new do
include mod
end
assert_equal "Dwayne Johnson", klass.new.last_wrestler
end
def test_hook_uses_instance_eval_when_base_is_an_instance
ActiveSupport.on_load(:uses_instance_eval) do
def second_wrestler
"Hulk Hogan"
end
end
context = FakeContext.new(1)
ActiveSupport.run_load_hooks(:uses_instance_eval, context)
assert_raises NoMethodError do
FakeContext.new(2).second_wrestler
end
assert_raises NoMethodError do
FakeContext.second_wrestler
end
assert_equal "Hulk Hogan", context.second_wrestler
end
private
def incr_amt
5
end
class FakeContext
attr_reader :incr
def initialize(incr)
@incr = incr
end
end
end