aboutsummaryrefslogtreecommitdiffstats
path: root/railties/test/paths_test.rb
blob: 9f5bb37c20b4d77bc282ee2fca70013c9c69e42a (plain) (blame)
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
# frozen_string_literal: true

require "abstract_unit"
require "rails/paths"
require "minitest/mock"

class PathsTest < ActiveSupport::TestCase
  def setup
    @root = Rails::Paths::Root.new("/foo/bar")
  end

  test "the paths object is initialized with the root path" do
    root = Rails::Paths::Root.new("/fiz/baz")
    assert_equal "/fiz/baz", root.path
  end

  test "the paths object can be initialized with nil" do
    assert_nothing_raised do
      Rails::Paths::Root.new(nil)
    end
  end

  test "a paths object initialized with nil can be updated" do
    root = Rails::Paths::Root.new(nil)
    root.add "app"
    root.path = "/root"
    assert_equal ["app"], root["app"].to_ary
    assert_equal ["/root/app"], root["app"].to_a
  end

  test "creating a root level path" do
    @root.add "app"
    assert_equal ["/foo/bar/app"], @root["app"].to_a
  end

  test "creating a root level path with options" do
    @root.add "app", with: "/foo/bar"
    assert_equal ["/foo/bar"], @root["app"].to_a
  end

  test "raises exception if root path never set" do
    root = Rails::Paths::Root.new(nil)
    root.add "app"
    assert_raises RuntimeError do
      root["app"].to_a
    end
  end

  test "creating a child level path" do
    @root.add "app"
    @root.add "app/models"
    assert_equal ["/foo/bar/app/models"], @root["app/models"].to_a
  end

  test "creating a child level path with option" do
    @root.add "app"
    @root.add "app/models", with: "/foo/bar/baz"
    assert_equal ["/foo/bar/baz"], @root["app/models"].to_a
  end

  test "child level paths are relative from the root" do
    @root.add "app"
    @root.add "app/models", with: "baz"
    assert_equal ["/foo/bar/baz"], @root["app/models"].to_a
  end

  test "absolute current path" do
    @root.add "config"
    @root.add "config/locales"

    assert_equal "/foo/bar/config/locales", @root["config/locales"].absolute_current
  end

  test "adding multiple physical paths as an array" do
    @root.add "app", with: ["/app", "/app2"]
    assert_equal ["/app", "/app2"], @root["app"].to_a
  end

  test "adding multiple physical paths using #push" do
    @root.add "app"
    @root["app"].push "app2"
    assert_equal ["/foo/bar/app", "/foo/bar/app2"], @root["app"].to_a
  end

  test "adding multiple physical paths using <<" do
    @root.add "app"
    @root["app"] << "app2"
    assert_equal ["/foo/bar/app", "/foo/bar/app2"], @root["app"].to_a
  end

  test "adding multiple physical paths using concat" do
    @root.add "app"
    @root["app"].concat ["app2", "/app3"]
    assert_equal ["/foo/bar/app", "/foo/bar/app2", "/app3"], @root["app"].to_a
  end

  test "adding multiple physical paths using #unshift" do
    @root.add "app"
    @root["app"].unshift "app2"
    assert_equal ["/foo/bar/app2", "/foo/bar/app"], @root["app"].to_a
  end

  test "it is possible to add a path that should be autoloaded only once" do
    File.stub(:exist?, true) do
      @root.add "app", with: "/app"
      @root["app"].autoload_once!
      assert_predicate @root["app"], :autoload_once?
      assert_includes @root.autoload_once, @root["app"].expanded.first
    end
  end

  test "it is possible to remove a path that should be autoloaded only once" do
    @root["app"] = "/app"
    @root["app"].autoload_once!
    assert_predicate @root["app"], :autoload_once?

    @root["app"].skip_autoload_once!
    assert_not_predicate @root["app"], :autoload_once?
    assert_not_includes @root.autoload_once, @root["app"].expanded.first
  end

  test "it is possible to add a path without assignment and specify it should be loaded only once" do
    File.stub(:exist?, true) do
      @root.add "app", with: "/app", autoload_once: true
      assert_predicate @root["app"], :autoload_once?
      assert_includes @root.autoload_once, "/app"
    end
  end

  test "it is possible to add multiple paths without assignment and specify it should be loaded only once" do
    File.stub(:exist?, true) do
      @root.add "app", with: ["/app", "/app2"], autoload_once: true
      assert_predicate @root["app"], :autoload_once?
      assert_includes @root.autoload_once, "/app"
      assert_includes @root.autoload_once, "/app2"
    end
  end

  test "making a path autoload_once more than once only includes it once in @root.load_once" do
    File.stub(:exist?, true) do
      @root["app"] = "/app"
      @root["app"].autoload_once!
      @root["app"].autoload_once!
      assert_equal 1, @root.autoload_once.select { |p| p == @root["app"].expanded.first }.size
    end
  end

  test "paths added to a load_once path should be added to the autoload_once collection" do
    File.stub(:exist?, true) do
      @root["app"] = "/app"
      @root["app"].autoload_once!
      @root["app"] << "/app2"
      assert_equal 2, @root.autoload_once.size
    end
  end

  test "it is possible to mark a path as eager loaded" do
    File.stub(:exist?, true) do
      @root["app"] = "/app"
      @root["app"].eager_load!
      assert_predicate @root["app"], :eager_load?
      assert_includes @root.eager_load, @root["app"].to_a.first
    end
  end

  test "it is possible to skip a path from eager loading" do
    @root["app"] = "/app"
    @root["app"].eager_load!
    assert_predicate @root["app"], :eager_load?

    @root["app"].skip_eager_load!
    assert_not_predicate @root["app"], :eager_load?
    assert_not_includes @root.eager_load, @root["app"].to_a.first
  end

  test "it is possible to add a path without assignment and mark it as eager" do
    File.stub(:exist?, true) do
      @root.add "app", with: "/app", eager_load: true
      assert_predicate @root["app"], :eager_load?
      assert_includes @root.eager_load, "/app"
    end
  end

  test "it is possible to add multiple paths without assignment and mark them as eager" do
    File.stub(:exist?, true) do
      @root.add "app", with: ["/app", "/app2"], eager_load: true
      assert_predicate @root["app"], :eager_load?
      assert_includes @root.eager_load, "/app"
      assert_includes @root.eager_load, "/app2"
    end
  end

  test "it is possible to create a path without assignment and mark it both as eager and load once" do
    File.stub(:exist?, true) do
      @root.add "app", with: "/app", eager_load: true, autoload_once: true
      assert_predicate @root["app"], :eager_load?
      assert_predicate @root["app"], :autoload_once?
      assert_includes @root.eager_load, "/app"
      assert_includes @root.autoload_once, "/app"
    end
  end

  test "making a path eager more than once only includes it once in @root.eager_paths" do
    File.stub(:exist?, true) do
      @root["app"] = "/app"
      @root["app"].eager_load!
      @root["app"].eager_load!
      assert_equal 1, @root.eager_load.select { |p| p == @root["app"].expanded.first }.size
    end
  end

  test "paths added to an eager_load path should be added to the eager_load collection" do
    File.stub(:exist?, true) do
      @root["app"] = "/app"
      @root["app"].eager_load!
      @root["app"] << "/app2"
      assert_equal 2, @root.eager_load.size
    end
  end

  test "it should be possible to add a path's default glob" do
    @root["app"] = "/app"
    @root["app"].glob = "*.rb"
    assert_equal "*.rb", @root["app"].glob
  end

  test "it should be possible to get extensions by glob" do
    @root["app"] = "/app"
    @root["app"].glob = "*.{rb,yml}"
    assert_equal ["rb", "yml"], @root["app"].extensions
  end

  test "it should be possible to override a path's default glob without assignment" do
    @root.add "app", with: "/app", glob: "*.rb"
    assert_equal "*.rb", @root["app"].glob
  end

  test "it should be possible to replace a path and persist the original paths glob" do
    @root.add "app", glob: "*.rb"
    @root["app"] = "app2"
    assert_equal ["/foo/bar/app2"], @root["app"].to_a
    assert_equal "*.rb", @root["app"].glob
  end

  test "a path can be added to the load path" do
    File.stub(:exist?, true) do
      @root["app"] = "app"
      @root["app"].load_path!
      @root["app/models"] = "app/models"
      assert_equal ["/foo/bar/app"], @root.load_paths
    end
  end

  test "a path can be added to the load path on creation" do
    File.stub(:exist?, true) do
      @root.add "app", with: "/app", load_path: true
      assert_predicate @root["app"], :load_path?
      assert_equal ["/app"], @root.load_paths
    end
  end

  test "a path can be marked as autoload path" do
    File.stub(:exist?, true) do
      @root["app"] = "app"
      @root["app"].autoload!
      @root["app/models"] = "app/models"
      assert_equal ["/foo/bar/app"], @root.autoload_paths
    end
  end

  test "a path can be marked as autoload on creation" do
    File.stub(:exist?, true) do
      @root.add "app", with: "/app", autoload: true
      assert_predicate @root["app"], :autoload?
      assert_equal ["/app"], @root.autoload_paths
    end
  end
end

class PathsIntegrationTest < ActiveSupport::TestCase
  test "A failed symlink is still a valid file" do
    Dir.mktmpdir do |dir|
      Dir.chdir(dir) do
        FileUtils.mkdir_p("foo")
        File.symlink("foo/doesnotexist.rb", "foo/bar.rb")
        assert_equal true, File.symlink?("foo/bar.rb")

        root = Rails::Paths::Root.new("foo")
        root.add "bar.rb"

        exception = assert_raises(RuntimeError) do
          root["bar.rb"].existent
        end
        assert_match File.expand_path("foo/bar.rb"), exception.message
      end
    end
  end
end