summaryrefslogtreecommitdiff
path: root/spec/ruby/core/kernel/require_relative_spec.rb
blob: 04cf5444d2404ab59b42594dca2f46b911516cbe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
require File.expand_path('../../../spec_helper', __FILE__)
require File.expand_path('../../../fixtures/code_loading', __FILE__)

describe "Kernel#require_relative with a relative path" do
  it "needs to be reviewed for spec completeness"

  before :each do
    CodeLoadingSpecs.spec_setup
    @dir = "../../fixtures/code"
    @abs_dir = File.realpath(@dir, File.dirname(__FILE__))
    @path = "#{@dir}/load_fixture.rb"
    @abs_path = File.realpath(@path, File.dirname(__FILE__))
  end

  after :each do
    CodeLoadingSpecs.spec_cleanup
  end

  platform_is_not :windows do
    describe "when file is a symlink" do
      before :each do
        @link = tmp("symlink.rb", false)
        @real_path = "#{@abs_dir}/symlink/symlink1.rb"
        File.symlink(@real_path, @link)
      end

      after :each do
        rm_r @link
      end

      it "loads a path relative to current file" do
        require_relative(@link).should be_true
        ScratchPad.recorded.should == [:loaded]
      end
    end
  end

  it "loads a path relative to the current file" do
    require_relative(@path).should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  it "loads a file defining many methods" do
    require_relative("#{@dir}/methods_fixture.rb").should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  it "raises a LoadError if the file does not exist" do
    lambda { require_relative("#{@dir}/nonexistent.rb") }.should raise_error(LoadError)
    ScratchPad.recorded.should == []
  end

  it "raises a LoadError if basepath does not exist" do
    lambda { eval("require_relative('#{@dir}/nonexistent.rb')") }.should raise_error(LoadError)
  end

  it "stores the missing path in a LoadError object" do
    path = "#{@dir}/nonexistent.rb"

    lambda {
      require_relative(path)
    }.should(raise_error(LoadError) { |e|
      e.path.should == File.expand_path(path, @abs_dir)
    })
  end

  it "calls #to_str on non-String objects" do
    name = mock("load_fixture.rb mock")
    name.should_receive(:to_str).and_return(@path)
    require_relative(name).should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  it "raises a TypeError if argument does not respond to #to_str" do
    lambda { require_relative(nil) }.should raise_error(TypeError)
    lambda { require_relative(42) }.should raise_error(TypeError)
    lambda {
      require_relative([@path,@path])
    }.should raise_error(TypeError)
  end

  it "raises a TypeError if passed an object that has #to_s but not #to_str" do
    name = mock("load_fixture.rb mock")
    name.stub!(:to_s).and_return(@path)
    lambda { require_relative(name) }.should raise_error(TypeError)
  end

  it "raises a TypeError if #to_str does not return a String" do
    name = mock("#to_str returns nil")
    name.should_receive(:to_str).at_least(1).times.and_return(nil)
    lambda { require_relative(name) }.should raise_error(TypeError)
  end

  it "calls #to_path on non-String objects" do
    name = mock("load_fixture.rb mock")
    name.should_receive(:to_path).and_return(@path)
    require_relative(name).should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  it "calls #to_str on non-String objects returned by #to_path" do
    name = mock("load_fixture.rb mock")
    to_path = mock("load_fixture_rb #to_path mock")
    name.should_receive(:to_path).and_return(to_path)
    to_path.should_receive(:to_str).and_return(@path)
    require_relative(name).should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  describe "(file extensions)" do
    it "loads a .rb extensioned file when passed a non-extensioned path" do
      require_relative("#{@dir}/load_fixture").should be_true
      ScratchPad.recorded.should == [:loaded]
    end

    it "loads a .rb extensioned file when a C-extension file of the same name is loaded" do
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.bundle"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.dylib"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.so"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.dll"
      require_relative(@path).should be_true
      ScratchPad.recorded.should == [:loaded]
    end

    it "does not load a C-extension file if a .rb extensioned file is already loaded" do
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.rb"
      require_relative("#{@dir}/load_fixture").should be_false
      ScratchPad.recorded.should == []
    end

    it "loads a .rb extensioned file when passed a non-.rb extensioned path" do
      require_relative("#{@dir}/load_fixture.ext").should be_true
      ScratchPad.recorded.should == [:loaded]
      $LOADED_FEATURES.should include "#{@abs_dir}/load_fixture.ext.rb"
    end

    it "loads a .rb extensioned file when a complex-extensioned C-extension file of the same name is loaded" do
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.bundle"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.dylib"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.so"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.dll"
      require_relative("#{@dir}/load_fixture.ext").should be_true
      ScratchPad.recorded.should == [:loaded]
      $LOADED_FEATURES.should include "#{@abs_dir}/load_fixture.ext.rb"
    end

    it "does not load a C-extension file if a complex-extensioned .rb file is already loaded" do
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.rb"
      require_relative("#{@dir}/load_fixture.ext").should be_false
      ScratchPad.recorded.should == []
    end
  end

  describe "($LOADED_FEATURES)" do
    it "stores an absolute path" do
      require_relative(@path).should be_true
      $LOADED_FEATURES.should include(@abs_path)
    end

    it "does not store the path if the load fails" do
      saved_loaded_features = $LOADED_FEATURES.dup
      lambda { require_relative("#{@dir}/raise_fixture.rb") }.should raise_error(RuntimeError)
      $LOADED_FEATURES.should == saved_loaded_features
    end

    it "does not load an absolute path that is already stored" do
      $LOADED_FEATURES << @abs_path
      require_relative(@path).should be_false
      ScratchPad.recorded.should == []
    end

    it "adds the suffix of the resolved filename" do
      require_relative("#{@dir}/load_fixture").should be_true
      $LOADED_FEATURES.should include("#{@abs_dir}/load_fixture.rb")
    end

    it "loads a path for a file already loaded with a relative path" do
      $LOAD_PATH << File.expand_path(@dir)
      $LOADED_FEATURES << "load_fixture.rb" << "load_fixture"
      require_relative(@path).should be_true
      $LOADED_FEATURES.should include(@abs_path)
      ScratchPad.recorded.should == [:loaded]
    end
  end
end

describe "Kernel#require_relative with an absolute path" do
  it "needs to be reviewed for spec completeness"

  before :each do
    CodeLoadingSpecs.spec_setup
    @dir = File.expand_path "../../fixtures/code", File.dirname(__FILE__)
    @abs_dir = @dir
    @path = File.join @dir, "load_fixture.rb"
    @abs_path = @path
  end

  after :each do
    CodeLoadingSpecs.spec_cleanup
  end

  it "loads a path relative to the current file" do
    require_relative(@path).should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  it "loads a file defining many methods" do
    require_relative("#{@dir}/methods_fixture.rb").should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  it "raises a LoadError if the file does not exist" do
    lambda { require_relative("#{@dir}/nonexistent.rb") }.should raise_error(LoadError)
    ScratchPad.recorded.should == []
  end

  it "raises a LoadError if basepath does not exist" do
    lambda { eval("require_relative('#{@dir}/nonexistent.rb')") }.should raise_error(LoadError)
  end

  it "stores the missing path in a LoadError object" do
    path = "#{@dir}/nonexistent.rb"

    lambda {
      require_relative(path)
    }.should(raise_error(LoadError) { |e|
      e.path.should == File.expand_path(path, @abs_dir)
    })
  end

  it "calls #to_str on non-String objects" do
    name = mock("load_fixture.rb mock")
    name.should_receive(:to_str).and_return(@path)
    require_relative(name).should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  it "raises a TypeError if argument does not respond to #to_str" do
    lambda { require_relative(nil) }.should raise_error(TypeError)
    lambda { require_relative(42) }.should raise_error(TypeError)
    lambda {
      require_relative([@path,@path])
    }.should raise_error(TypeError)
  end

  it "raises a TypeError if passed an object that has #to_s but not #to_str" do
    name = mock("load_fixture.rb mock")
    name.stub!(:to_s).and_return(@path)
    lambda { require_relative(name) }.should raise_error(TypeError)
  end

  it "raises a TypeError if #to_str does not return a String" do
    name = mock("#to_str returns nil")
    name.should_receive(:to_str).at_least(1).times.and_return(nil)
    lambda { require_relative(name) }.should raise_error(TypeError)
  end

  it "calls #to_path on non-String objects" do
    name = mock("load_fixture.rb mock")
    name.should_receive(:to_path).and_return(@path)
    require_relative(name).should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  it "calls #to_str on non-String objects returned by #to_path" do
    name = mock("load_fixture.rb mock")
    to_path = mock("load_fixture_rb #to_path mock")
    name.should_receive(:to_path).and_return(to_path)
    to_path.should_receive(:to_str).and_return(@path)
    require_relative(name).should be_true
    ScratchPad.recorded.should == [:loaded]
  end

  describe "(file extensions)" do
    it "loads a .rb extensioned file when passed a non-extensioned path" do
      require_relative("#{@dir}/load_fixture").should be_true
      ScratchPad.recorded.should == [:loaded]
    end

    it "loads a .rb extensioned file when a C-extension file of the same name is loaded" do
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.bundle"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.dylib"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.so"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.dll"
      require_relative(@path).should be_true
      ScratchPad.recorded.should == [:loaded]
    end

    it "does not load a C-extension file if a .rb extensioned file is already loaded" do
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.rb"
      require_relative("#{@dir}/load_fixture").should be_false
      ScratchPad.recorded.should == []
    end

    it "loads a .rb extensioned file when passed a non-.rb extensioned path" do
      require_relative("#{@dir}/load_fixture.ext").should be_true
      ScratchPad.recorded.should == [:loaded]
      $LOADED_FEATURES.should include "#{@abs_dir}/load_fixture.ext.rb"
    end

    it "loads a .rb extensioned file when a complex-extensioned C-extension file of the same name is loaded" do
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.bundle"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.dylib"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.so"
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.dll"
      require_relative("#{@dir}/load_fixture.ext").should be_true
      ScratchPad.recorded.should == [:loaded]
      $LOADED_FEATURES.should include "#{@abs_dir}/load_fixture.ext.rb"
    end

    it "does not load a C-extension file if a complex-extensioned .rb file is already loaded" do
      $LOADED_FEATURES << "#{@abs_dir}/load_fixture.ext.rb"
      require_relative("#{@dir}/load_fixture.ext").should be_false
      ScratchPad.recorded.should == []
    end
  end

  describe "($LOAD_FEATURES)" do
    it "stores an absolute path" do
      require_relative(@path).should be_true
      $LOADED_FEATURES.should include(@abs_path)
    end

    it "does not store the path if the load fails" do
      saved_loaded_features = $LOADED_FEATURES.dup
      lambda { require_relative("#{@dir}/raise_fixture.rb") }.should raise_error(RuntimeError)
      $LOADED_FEATURES.should == saved_loaded_features
    end

    it "does not load an absolute path that is already stored" do
      $LOADED_FEATURES << @abs_path
      require_relative(@path).should be_false
      ScratchPad.recorded.should == []
    end

    it "adds the suffix of the resolved filename" do
      require_relative("#{@dir}/load_fixture").should be_true
      $LOADED_FEATURES.should include("#{@abs_dir}/load_fixture.rb")
    end

    it "loads a path for a file already loaded with a relative path" do
      $LOAD_PATH << File.expand_path(@dir)
      $LOADED_FEATURES << "load_fixture.rb" << "load_fixture"
      require_relative(@path).should be_true
      $LOADED_FEATURES.should include(@abs_path)
      ScratchPad.recorded.should == [:loaded]
    end
  end
end