Module: RBS::Test::Hook

Defined in:
lib/rbs/test/hook.rb

Constant Summary collapse

OPERATORS =
{
  :[] => "indexlookup",
  :[]= => "indexset",
  :== => "eqeq",
  :=== => "eqeqeq",
  :!= => "noteq",
  :+ => "plus",
  :- => "minus",
  :* => "star",
  :/ => "slash",
  :> => "gt",
  :>= => "gteq",
  :< => "lt",
  :<= => "lteq",
  :<=> => "ufo",
  :& => "amp",
  :| => "vbar",
  :^ => "hat",
  :! => "not",
  :<< => "lshift",
  :>> => "rshift",
  :~ => "tilda",
  :=~ => "eqtilda",
  :% => "percent",
  :+@ => "unary_plus",
  :-@ => "unary_minus"
}

Class Method Summary collapse

Class Method Details

.alias_names(target, random) ⇒ Object



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/rbs/test/hook.rb', line 36

def self.alias_names(target, random)
  suffix = "#{RBS::Test.suffix}_#{random}"

  case target
  when *OPERATORS.keys
    name = OPERATORS[target]
    [
      "#{name}____with__#{suffix}",
      "#{name}____without__#{suffix}"
    ]
  else
    aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1

    [
      "#{aliased_target}__with__#{suffix}#{punctuation}",
      "#{aliased_target}__without__#{suffix}#{punctuation}"
    ]
  end
end

.hook_instance_method(klass, method, key:) ⇒ Object



193
194
195
196
197
198
199
200
# File 'lib/rbs/test/hook.rb', line 193

def self.hook_instance_method(klass, method, key:)
  random = SecureRandom.hex(4)
  params = klass.instance_method(method).parameters
  line, source = hook_method_source("#{klass}#", method, key, random: random, params: params)

  klass.module_eval(source, __FILE__, line)
  setup_alias_method_chain klass, method, random: random
end

.hook_method_source(prefix, method_name, key, random:, params:) ⇒ Object



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/rbs/test/hook.rb', line 76

def self.hook_method_source(prefix, method_name, key, random:, params:)
  with_name, without_name = alias_names(method_name, random)
  full_method_name = "#{prefix}#{method_name}"

  param_source = params.take_while {|param| param[0] == :req }
                       .map.with_index {|pair, index| pair[1] || "__req__#{random}__#{index}" }
  param_source.push("*rest_args__#{random}")
  block_param = "block__#{random}"

  RBS.logger.debug {
    "Generating method definition: def #{with_name}(#{param_source.join(", ")}, &#{block_param}) ..."
  }

  [__LINE__ + 1, <<RUBY]
def #{with_name}(#{param_source.join(", ")}, &#{block_param})
  args = [#{param_source.join(", ")}]
  ::RBS.logger.debug { "#{full_method_name} with arguments: [" + args.map(&:inspect).join(", ") + "]" }

  begin
    return_from_call = false
    block_calls = []

    if block_given?
block_receives_block = #{block_param}.parameters.last&.yield_self {|type, _| type == :block }

wrapped_block = Object.new.instance_exec do
  new_object = self

  proc do |*block_args, &block2|
    return_from_block = false

    begin
      block_result = if self.equal?(new_object)
                      if block_receives_block
                        #{block_param}.call(*block_args, &block2)
                      else
                        yield(*block_args)
                      end
                    else
                      # Detected that `self` inside `proc` is not equal to the `self` outside block (which is saved to `new_object`).
                      # This means that the block is called with `instance_exec` or `instance_eval`.
                      self.instance_exec(*block_args, &#{block_param})
                    end

      return_from_block = true
    ensure
      exn = $!

      case
      when return_from_block
        # Returned from yield
        block_calls << ::RBS::Test::ArgumentsReturn.return(
          arguments: block_args,
          value: block_result
        )
      when exn
        # Exception
        block_calls << ::RBS::Test::ArgumentsReturn.exception(
          arguments: block_args,
          exception: exn
        )
      else
        # break?
        block_calls << ::RBS::Test::ArgumentsReturn.break(
          arguments: block_args
        )
      end
    end

    block_result
  end.ruby2_keywords
end

result = __send__(:"#{without_name}", *args, &wrapped_block)
    else
result = __send__(:"#{without_name}", *args)
    end
    return_from_call = true
    result
  ensure
    exn = $!

    case
    when return_from_call
::RBS.logger.debug { "#{full_method_name} return with value: " + result.inspect }
method_call = ::RBS::Test::ArgumentsReturn.return(
  arguments: args,
  value: result
)
    when exn
::RBS.logger.debug { "#{full_method_name} exit with exception: " + exn.inspect }
method_call = ::RBS::Test::ArgumentsReturn.exception(
  arguments: args,
  exception: exn
)
    else
::RBS.logger.debug { "#{full_method_name} exit with jump" }
method_call = ::RBS::Test::ArgumentsReturn.break(arguments: args)
    end

    trace = ::RBS::Test::CallTrace.new(
method_name: #{method_name.inspect},
method_call: method_call,
block_calls: block_calls,
block_given: block_given?,
    )

    ::RBS::Test::Observer.notify(#{key.inspect}, self, trace)
  end

  result
end

ruby2_keywords :#{with_name}
RUBY
end

.hook_singleton_method(klass, method, key:) ⇒ Object



202
203
204
205
206
207
208
209
# File 'lib/rbs/test/hook.rb', line 202

def self.hook_singleton_method(klass, method, key:)
  random = SecureRandom.hex(4)
  params = klass.method(method).parameters
  line, source = hook_method_source("#{klass}.",method, key, random: random, params: params)

  klass.singleton_class.module_eval(source, __FILE__, line)
  setup_alias_method_chain klass.singleton_class, method, random: random
end

.setup_alias_method_chain(klass, target, random:) ⇒ Object



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/rbs/test/hook.rb', line 56

def self.setup_alias_method_chain(klass, target, random:)
  with_method, without_method = alias_names(target, random)

  RBS.logger.debug "alias name: #{target}, #{with_method}, #{without_method}"

  klass.instance_eval do
    alias_method without_method, target
    alias_method target, with_method

    case
    when public_method_defined?(without_method)
      public target
    when protected_method_defined?(without_method)
      protected target
    when private_method_defined?(without_method)
      private target
    end
  end
end