Skip to content

Commit

Permalink
Use the caller location as default filename for eval family of methods
Browse files Browse the repository at this point in the history
[Feature #19755]

Before (in /tmp/test.rb):

```ruby
Object.class_eval("p __FILE__") # => "(eval)"
```

After:

```ruby
Object.class_eval("p __FILE__") # => "(eval at /tmp/test.rb:1)"
```

This makes it much easier to track down generated code in case
the author forgot to provide a filename argument.
  • Loading branch information
byroot authored and eregon committed Aug 2, 2023
1 parent 0c0ff72 commit ca60800
Show file tree
Hide file tree
Showing 7 changed files with 87 additions and 26 deletions.
7 changes: 7 additions & 0 deletions core/basicobject/instance_eval_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,13 @@ def foo

end

ruby_version_is "3.3" do
it "uses the caller location as default location" do
f = Object.new
f.instance_eval("[__FILE__, __LINE__]").should == ["(eval at #{__FILE__}:#{__LINE__})", 1]
end
end

it "has access to receiver's instance variables" do
BasicObjectSpecs::IVars.new.instance_eval { @secret }.should == 99
BasicObjectSpecs::IVars.new.instance_eval("@secret").should == 99
Expand Down
16 changes: 12 additions & 4 deletions core/binding/eval_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,12 @@
bind.eval("#foo\n__LINE__", "(test)", 88).should == 89
end

it "uses (eval) as __FILE__ if single argument given" do
obj = BindingSpecs::Demo.new(1)
bind = obj.get_binding
bind.eval("__FILE__").should == '(eval)'
ruby_version_is ""..."3.3" do
it "uses (eval) as __FILE__ if single argument given" do
obj = BindingSpecs::Demo.new(1)
bind = obj.get_binding
bind.eval("__FILE__").should == '(eval)'
end
end

it "uses 1 as __LINE__" do
Expand Down Expand Up @@ -104,4 +106,10 @@

bind.eval("'bar'.foo").should == "foo"
end

ruby_version_is "3.3" do
it "uses the caller location as default filename" do
binding.eval("[__FILE__, __LINE__]").should == ["(eval at #{__FILE__}:#{__LINE__})", 1]
end
end
end
39 changes: 28 additions & 11 deletions core/kernel/eval_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -159,20 +159,37 @@ class Object
end
end

it "uses (eval) filename if none is provided" do
eval("__FILE__").should == "(eval)"
eval("__FILE__", binding).should == "(eval)"
eval("__FILE__", binding, "success").should == "success"
eval("eval '__FILE__', binding").should == "(eval)"
eval("eval '__FILE__', binding", binding).should == "(eval)"
eval("eval '__FILE__', binding", binding, 'success').should == '(eval)'
eval("eval '__FILE__', binding, 'success'", binding).should == 'success'
end
ruby_version_is ""..."3.3" do
it "uses (eval) filename if none is provided" do
eval("__FILE__").should == "(eval)"
eval("__FILE__", binding).should == "(eval)"
eval("__FILE__", binding, "success").should == "success"
eval("eval '__FILE__', binding").should == "(eval)"
eval("eval '__FILE__', binding", binding).should == "(eval)"
eval("eval '__FILE__', binding", binding, 'success').should == '(eval)'
eval("eval '__FILE__', binding, 'success'", binding).should == 'success'
end

it 'uses (eval) for __FILE__ and 1 for __LINE__ with a binding argument' do
eval("[__FILE__, __LINE__]", binding).should == ["(eval)", 1]
it 'uses (eval) for __FILE__ and 1 for __LINE__ with a binding argument' do
eval("[__FILE__, __LINE__]", binding).should == ["(eval)", 1]
end
end

ruby_version_is "3.3" do
it "uses (eval at __FILE__:__LINE__) if none is provided" do
eval("__FILE__").should == "(eval at #{__FILE__}:#{__LINE__})"
eval("__FILE__", binding).should == "(eval at #{__FILE__}:#{__LINE__})"
eval("__FILE__", binding, "success").should == "success"
eval("eval '__FILE__', binding").should == "(eval at (eval at #{__FILE__}:#{__LINE__}):1)"
eval("eval '__FILE__', binding", binding).should == "(eval at (eval at #{__FILE__}:#{__LINE__}):1)"
eval("eval '__FILE__', binding", binding, 'success').should == "(eval at success:1)"
eval("eval '__FILE__', binding, 'success'", binding).should == 'success'
end

it 'uses (eval at __FILE__:__LINE__) for __FILE__ and 1 for __LINE__ with a binding argument' do
eval("[__FILE__, __LINE__]", binding).should == ["(eval at #{__FILE__}:#{__LINE__})", 1]
end
end
# Found via Rubinius bug github:#149
it "does not alter the value of __FILE__ in the binding" do
first_time = EvalSpecs.call_eval
Expand Down
6 changes: 6 additions & 0 deletions core/module/shared/class_eval.rb
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ def foo
ModuleSpecs.send(@method, "[__FILE__, __LINE__]", "test", 102).should == ["test", 102]
end

ruby_version_is "3.3" do
it "uses the caller location as default filename" do
ModuleSpecs.send(@method, "[__FILE__, __LINE__]").should == ["(eval at #{__FILE__}:#{__LINE__})", 1]
end
end

it "converts a non-string filename to a string using to_str" do
(file = mock(__FILE__)).should_receive(:to_str).and_return(__FILE__)
ModuleSpecs.send(@method, "1+1", file)
Expand Down
31 changes: 23 additions & 8 deletions core/tracepoint/path_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,29 @@
path.should == "#{__FILE__}"
end

it 'equals (eval) inside an eval for :end event' do
path = nil
TracePoint.new(:end) { |tp|
next unless TracePointSpec.target_thread?
path = tp.path
}.enable do
eval("module TracePointSpec; end")
ruby_version_is ""..."3.3" do
it 'equals (eval) inside an eval for :end event' do
path = nil
TracePoint.new(:end) { |tp|
next unless TracePointSpec.target_thread?
path = tp.path
}.enable do
eval("module TracePointSpec; end")
end
path.should == '(eval)'
end
end

ruby_version_is "3.3" do
it 'equals "(eval at __FILE__:__LINE__)" inside an eval for :end event' do
path = nil
TracePoint.new(:end) { |tp|
next unless TracePointSpec.target_thread?
path = tp.path
}.enable do
eval("module TracePointSpec; end")
end
path.should == "(eval at #{__FILE__}:#{__LINE__ - 2})"
end
path.should == '(eval)'
end
end
2 changes: 1 addition & 1 deletion language/defined_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@
it "warns about the void context when parsing it" do
-> {
eval "defined?(DefinedSpecs.side_effects / 2); 42"
}.should complain("(eval):1: warning: possibly useless use of defined? in void context\n", verbose: true)
}.should complain(/warning: possibly useless use of defined\? in void context/, verbose: true)
end
end
end
Expand Down
12 changes: 10 additions & 2 deletions language/file_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,16 @@
-> { eval("__FILE__ = 1") }.should raise_error(SyntaxError)
end

it "equals (eval) inside an eval" do
eval("__FILE__").should == "(eval)"
ruby_version_is ""..."3.3" do
it "equals (eval) inside an eval" do
eval("__FILE__").should == "(eval)"
end
end

ruby_version_is "3.3" do
it "equals (eval at __FILE__:__LINE__) inside an eval" do
eval("__FILE__").should == "(eval at #{__FILE__}:#{__LINE__})"
end
end
end

Expand Down

0 comments on commit ca60800

Please sign in to comment.