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
|
require 'helper'
class TestRegenerator < JekyllUnitTest
context "The site regenerator" do
setup do
FileUtils.rm_rf(source_dir(".jekyll-metadata"))
@site = fixture_site({
"collections" => {
"methods" => {
"output" => true
}
},
"incremental" => true
})
@site.read
@page = @site.pages.first
@post = @site.posts.first
@document = @site.docs_to_write.first
@asset_file = @site.pages.find(&:asset_file?)
@regenerator = @site.regenerator
end
should "regenerate documents and assets if changed or not in metadata" do
assert @regenerator.regenerate?(@page)
assert @regenerator.regenerate?(@post)
assert @regenerator.regenerate?(@document)
assert @regenerator.regenerate?(@asset_file)
end
should "not regenerate if not changed" do
# Process files
@regenerator.regenerate?(@page)
@regenerator.regenerate?(@post)
@regenerator.regenerate?(@document)
@regenerator.regenerate?(@asset_file)
# we need to create the destinations for these files,
# because regenerate? checks if the destination exists
[@page, @post, @document, @asset_file].each do |item|
if item.respond_to?(:destination)
dest = item.destination(@site.dest)
FileUtils.mkdir_p(File.dirname(dest))
FileUtils.touch(dest)
end
end
@regenerator.write_metadata
@regenerator = Regenerator.new(@site)
# these should pass, since nothing has changed, and the
# loop above made sure the designations exist
assert !@regenerator.regenerate?(@page)
assert !@regenerator.regenerate?(@post)
assert !@regenerator.regenerate?(@document)
end
should "regenerate if destination missing" do
# Process files
@regenerator.regenerate?(@page)
@regenerator.regenerate?(@post)
@regenerator.regenerate?(@document)
@regenerator.regenerate?(@asset_file)
@regenerator.write_metadata
@regenerator = Regenerator.new(@site)
# make sure the files don't actually exist
[@page, @post, @document, @asset_file].each do |item|
if item.respond_to?(:destination)
dest = item.destination(@site.dest)
File.unlink(dest) unless !File.exist?(dest)
end
end
# while nothing has changed, the output files were not
# generated, so they still need to be regenerated
assert @regenerator.regenerate?(@page)
assert @regenerator.regenerate?(@post)
assert @regenerator.regenerate?(@document)
end
should "always regenerate asset files" do
assert @regenerator.regenerate?(@asset_file)
end
should "always regenerate objects that don't respond to :path" do
assert @regenerator.regenerate?(Object.new)
end
end
context "The site regenerator" do
setup do
FileUtils.rm_rf(source_dir(".jekyll-metadata"))
@site = fixture_site({
"incremental" => true
})
@site.read
@post = @site.posts.first
@regenerator = @site.regenerator
@regenerator.regenerate?(@post)
@layout_path = source_dir("_layouts/default.html")
end
teardown do
File.rename(@layout_path + ".tmp", @layout_path)
end
should "handle deleted/nonexistent dependencies" do
assert_equal 1, @regenerator.metadata.size
path = @regenerator.metadata.keys[0]
assert_exist @layout_path
@regenerator.add_dependency(path, @layout_path)
File.rename(@layout_path, @layout_path + ".tmp")
refute File.exist?(@layout_path)
@regenerator.clear_cache
assert @regenerator.regenerate?(@post)
end
end
context "The site metadata" do
setup do
FileUtils.rm_rf(source_dir(".jekyll-metadata"))
@site = Site.new(Jekyll.configuration({
"source" => source_dir,
"destination" => dest_dir,
"incremental" => true
}))
@site.process
@path = @site.in_source_dir(@site.pages.first.path)
@regenerator = @site.regenerator
end
should "store modification times" do
assert_equal File.mtime(@path), @regenerator.metadata[@path]["mtime"]
end
should "cache processed entries" do
assert @regenerator.cache[@path]
end
should "clear the cache on clear_cache" do
# @path will be in the cache because the
# site will have processed it
assert @regenerator.cache[@path]
@regenerator.clear_cache
assert_equal @regenerator.cache, {}
end
should "write to the metadata file" do
@regenerator.clear
@regenerator.add(@path)
@regenerator.write_metadata
assert File.file?(source_dir(".jekyll-metadata"))
end
should "read from the metadata file" do
@regenerator = Regenerator.new(@site)
assert_equal File.mtime(@path), @regenerator.metadata[@path]["mtime"]
end
should "read legacy yaml metadata" do
metadata_file = source_dir(".jekyll-metadata")
@regenerator = Regenerator.new(@site)
File.open(metadata_file, 'w') do |f|
f.write(@regenerator.metadata.to_yaml)
end
@regenerator = Regenerator.new(@site)
assert_equal File.mtime(@path), @regenerator.metadata[@path]["mtime"]
end
should "not crash when reading corrupted marshal file" do
metadata_file = source_dir(".jekyll-metadata")
File.open(metadata_file, "w") do |file|
file.puts Marshal.dump({ foo: 'bar' })[0,5]
end
@regenerator = Regenerator.new(@site)
assert_equal({}, @regenerator.metadata)
end
# Methods
should "be able to add a path to the metadata" do
@regenerator.clear
@regenerator.add(@path)
assert_equal File.mtime(@path), @regenerator.metadata[@path]["mtime"]
assert_equal [], @regenerator.metadata[@path]["deps"]
assert @regenerator.cache[@path]
end
should "return true on nonexistent path" do
@regenerator.clear
assert @regenerator.add("/bogus/path.md")
assert @regenerator.modified?("/bogus/path.md")
end
should "be able to force a path to regenerate" do
@regenerator.clear
@regenerator.force(@path)
assert @regenerator.cache[@path]
assert @regenerator.modified?(@path)
end
should "be able to clear metadata and cache" do
@regenerator.clear
@regenerator.add(@path)
assert_equal 1, @regenerator.metadata.length
assert_equal 1, @regenerator.cache.length
@regenerator.clear
assert_equal 0, @regenerator.metadata.length
assert_equal 0, @regenerator.cache.length
end
should "not regenerate a path if it is not modified" do
@regenerator.clear
@regenerator.add(@path)
@regenerator.write_metadata
@regenerator = Regenerator.new(@site)
assert !@regenerator.modified?(@path)
end
should "not regenerate if path in cache is false" do
@regenerator.clear
@regenerator.add(@path)
@regenerator.write_metadata
@regenerator = Regenerator.new(@site)
assert !@regenerator.modified?(@path)
assert !@regenerator.cache[@path]
assert !@regenerator.modified?(@path)
end
should "regenerate if path in not in metadata" do
@regenerator.clear
@regenerator.add(@path)
assert @regenerator.modified?(@path)
end
should "regenerate if path in cache is true" do
@regenerator.clear
@regenerator.add(@path)
assert @regenerator.modified?(@path)
assert @regenerator.cache[@path]
assert @regenerator.modified?(@path)
end
should "regenerate if file is modified" do
@regenerator.clear
@regenerator.add(@path)
@regenerator.metadata[@path]["mtime"] = Time.at(0)
@regenerator.write_metadata
@regenerator = Regenerator.new(@site)
refute_same File.mtime(@path), @regenerator.metadata[@path]["mtime"]
assert @regenerator.modified?(@path)
end
should "regenerate if dependency is modified" do
@regenerator.clear
@regenerator.add(@path)
@regenerator.write_metadata
@regenerator = Regenerator.new(@site)
@regenerator.add_dependency(@path, "new.dependency")
assert_equal ["new.dependency"], @regenerator.metadata[@path]["deps"]
assert @regenerator.modified?("new.dependency")
assert @regenerator.modified?(@path)
end
should "not regenerate again if multiple dependencies" do
multi_deps = @regenerator.metadata.select {|k,v| v['deps'].length > 2}
multi_dep_path = multi_deps.keys.first
assert @regenerator.metadata[multi_dep_path]["deps"].length > 2
assert @regenerator.modified?(multi_dep_path)
@site.process
@regenerator.clear_cache
refute @regenerator.modified?(multi_dep_path)
end
should "regenerate everything if metadata is disabled" do
@site.config["incremental"] = false
@regenerator.clear
@regenerator.add(@path)
@regenerator.write_metadata
@regenerator = Regenerator.new(@site)
assert @regenerator.modified?(@path)
end
end
context "when incremental regen is disabled" do
setup do
FileUtils.rm_rf(source_dir(".jekyll-metadata"))
@site = Site.new(Jekyll.configuration({
"source" => source_dir,
"destination" => dest_dir,
"incremental" => false
}))
@site.process
@path = @site.in_source_dir(@site.pages.first.path)
@regenerator = @site.regenerator
end
should "not create .jekyll-metadata" do
refute File.file?(source_dir(".jekyll-metadata"))
end
end
end
|
