-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
dir.cr
353 lines (312 loc) · 8.49 KB
/
dir.cr
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
350
351
352
353
require "crystal/system/dir"
# Objects of class `Dir` are directory streams representing directories in the underlying file system.
# They provide a variety of ways to list directories and their contents.
#
# The directory used in these examples contains the two regular files (`config.h` and `main.rb`),
# the parent directory (`..`), and the directory itself (`.`).
#
# See also: `File`.
class Dir
include Enumerable(String)
include Iterable(String)
# Returns the path of this directory.
#
# ```
# Dir.mkdir("testdir")
# dir = Dir.new("testdir")
# Dir.mkdir("testdir/extendeddir")
# dir2 = Dir.new("testdir/extendeddir")
#
# dir.path # => "testdir"
# dir2.path # => "testdir/extendeddir"
# ```
getter path : String
# Returns a new directory object for the named directory.
def initialize(path : Path | String)
@path = path.to_s
@dir = Crystal::System::Dir.open(@path)
@closed = false
end
# Alias for `new(path)`
def self.open(path : Path | String) : self
new path
end
# Opens a directory and yields it, closing it at the end of the block.
# Returns the value of the block.
def self.open(path : Path | String, & : self ->)
dir = new path
begin
yield dir
ensure
dir.close
end
end
# Calls the block once for each entry in this directory,
# passing the filename of each entry as a parameter to the block.
#
# ```
# Dir.mkdir("testdir")
# File.write("testdir/config.h", "")
#
# d = Dir.new("testdir")
# d.each { |x| puts "Got #{x}" }
# ```
#
# produces:
#
# ```text
# Got .
# Got ..
# Got config.h
# ```
def each(& : String ->) : Nil
while entry = read
yield entry
end
end
def each : Iterator(String)
EntryIterator.new(self)
end
# Returns an array containing all of entries in the given directory including "." and "..".
#
# ```
# Dir.mkdir("testdir")
# File.touch("testdir/file_1")
# File.touch("testdir/file_2")
#
# Dir.new("testdir").entries # => ["..", "file_1", "file_2", "."]
# ```
def entries : Array(String)
entries = [] of String
each do |filename|
entries << filename
end
entries
end
# Calls the block once for each entry except for `.` and `..` in this directory,
# passing the filename of each entry as a parameter to the block.
#
# ```
# Dir.mkdir("testdir")
# File.write("testdir/config.h", "")
#
# d = Dir.new("testdir")
# d.each_child { |x| puts "Got #{x}" }
# ```
#
# produces:
#
# ```text
# Got config.h
# ```
def each_child(& : String ->) : Nil
excluded = {".", ".."}
while entry = read
yield entry unless excluded.includes?(entry)
end
end
# Returns an iterator over of the all entries in this directory except for `.` and `..`.
#
# See `#each_child(&)`
#
# ```
# Dir.mkdir("test")
# File.touch("test/foo")
# File.touch("test/bar")
#
# dir = Dir.new("test")
# iter = d.each_child
#
# iter.next # => "foo"
# iter.next # => "bar"
# ```
def each_child : Iterator(String)
ChildIterator.new(self)
end
# Returns an array containing all of the filenames except for `.` and `..`
# in the given directory.
def children : Array(String)
entries = [] of String
each_child do |filename|
entries << filename
end
entries
end
# Reads the next entry from dir and returns it as a string. Returns `nil` at the end of the stream.
#
# ```
# d = Dir.new("testdir")
# array = [] of String
# while file = d.read
# array << file
# end
# array.sort # => [".", "..", "config.h"]
# ```
def read : String?
Crystal::System::Dir.next(@dir, path)
end
# Repositions this directory to the first entry.
def rewind : self
Crystal::System::Dir.rewind(@dir)
self
end
# This method is faster than `.info` and avoids race conditions if a `Dir` is already open on POSIX systems, but not necessarily on windows.
def info : File::Info
Crystal::System::Dir.info(@dir, path)
end
# Closes the directory stream.
def close : Nil
return if @closed
Crystal::System::Dir.close(@dir, path)
@closed = true
end
# Returns an absolute path to the current working directory.
#
# The result is similar to the shell commands `pwd` (POSIX) and `cd` (Windows).
#
# On POSIX systems, it respects the environment value `$PWD` if available and
# if it points to the current working directory.
def self.current : String
Crystal::System::Dir.current
end
# Changes the current working directory of the process to the given string.
def self.cd(path : Path | String) : String
Crystal::System::Dir.current = path.to_s
end
# Changes the current working directory of the process to the given string
# and invokes the block, restoring the original working directory
# when the block exits.
def self.cd(path : Path | String, &)
old = current
begin
cd(path)
yield
ensure
cd(old)
end
end
# Returns the tmp dir used for tempfile.
#
# ```
# Dir.tempdir # => "/tmp"
# ```
def self.tempdir : String
Crystal::System::Dir.tempdir
end
# See `#each`.
def self.each(dirname : Path | String, & : String ->)
Dir.open(dirname) do |dir|
dir.each do |filename|
yield filename
end
end
end
# See `#entries`.
def self.entries(dirname : Path | String) : Array(String)
Dir.open(dirname) do |dir|
return dir.entries
end
end
# See `#each_child`.
def self.each_child(dirname : Path | String, & : String ->)
Dir.open(dirname) do |dir|
dir.each_child do |filename|
yield filename
end
end
end
# See `#children`.
def self.children(dirname : Path | String) : Array(String)
Dir.open(dirname) do |dir|
return dir.children
end
end
# Returns `true` if the given path exists and is a directory
def self.exists?(path : Path | String) : Bool
if info = File.info?(path)
info.type.directory?
else
false
end
end
# Returns `true` if the directory at *path* is empty, otherwise returns `false`.
# Raises `File::NotFoundError` if the directory at *path* does not exist.
#
# ```
# Dir.mkdir("bar")
# Dir.empty?("bar") # => true
# File.write("bar/a_file", "The content")
# Dir.empty?("bar") # => false
# ```
def self.empty?(path : Path | String) : Bool
each_child(path) do |f|
return false
end
true
end
# Creates a new directory at the given path. The linux-style permission mode
# can be specified, with a default of 777 (0o777).
#
# NOTE: *mode* is ignored on windows.
def self.mkdir(path : Path | String, mode = 0o777) : Nil
Crystal::System::Dir.create(path.to_s, mode)
end
# Creates a new directory at the given path, including any non-existing
# intermediate directories. The linux-style permission mode can be specified,
# with a default of 777 (0o777).
def self.mkdir_p(path : Path | String, mode = 0o777) : Nil
return if Dir.exists?(path)
path = Path.new path
path.each_parent do |parent|
mkdir(parent, mode) unless Dir.exists?(parent)
end
mkdir(path, mode) unless Dir.exists?(path)
end
# Removes the directory at *path*. Raises `File::Error` on failure.
#
# On Windows, also raises `File::Error` if *path* points to a directory that
# is a reparse point, such as a symbolic link. Those directories can be
# deleted using `File.delete` instead.
def self.delete(path : Path | String) : Nil
Crystal::System::Dir.delete(path.to_s, raise_on_missing: true)
end
# Removes the directory at *path*, or returns `false` if the directory does
# not exist. Raises `File::Error` on other kinds of failure.
#
# On Windows, also raises `File::Error` if *path* points to a directory that
# is a reparse point, such as a symbolic link. Those directories can be
# deleted using `File.delete?` instead.
def self.delete?(path : Path | String) : Bool
Crystal::System::Dir.delete(path.to_s, raise_on_missing: false)
end
def to_s(io : IO) : Nil
io << "#<Dir:" << @path << '>'
end
def inspect(io : IO) : Nil
to_s(io)
end
def pretty_print(pp)
pp.text inspect
end
private struct EntryIterator
include Iterator(String)
def initialize(@dir : Dir)
end
def next
@dir.read || stop
end
end
private struct ChildIterator
include Iterator(String)
def initialize(@dir : Dir)
end
def next
excluded = {".", ".."}
while entry = @dir.read
return entry unless excluded.includes?(entry)
end
stop
end
end
end
require "./dir/*"