-
Notifications
You must be signed in to change notification settings - Fork 246
/
listener.rb
225 lines (203 loc) · 6.43 KB
/
listener.rb
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
require 'pathname'
module Listen
class Listener
attr_reader :directory, :directory_record, :adapter
# The default value for using relative paths in the callback.
DEFAULT_TO_RELATIVE_PATHS = false
# Initializes the directory listener.
#
# @param [String] directory the directory to listen to
# @param [Hash] options the listen options
# @option options [Regexp] ignore a pattern for ignoring paths
# @option options [Regexp] filter a pattern for filtering paths
# @option options [Float] latency the delay between checking for changes in seconds
# @option options [Boolean] relative_paths whether or not to use relative-paths in the callback
# @option options [Boolean] force_polling whether to force the polling adapter or not
# @option options [String, Boolean] polling_fallback_message to change polling fallback message or remove it
#
# @yield [modified, added, removed] the changed files
# @yieldparam [Array<String>] modified the list of modified files
# @yieldparam [Array<String>] added the list of added files
# @yieldparam [Array<String>] removed the list of removed files
#
def initialize(directory, options = {}, &block)
@block = block
@directory = Pathname.new(directory).realpath.to_s
@directory_record = DirectoryRecord.new(@directory)
@use_relative_paths = DEFAULT_TO_RELATIVE_PATHS
@use_relative_paths = options.delete(:relative_paths) if options[:relative_paths]
@directory_record.ignore(*options.delete(:ignore)) if options[:ignore]
@directory_record.filter(*options.delete(:filter)) if options[:filter]
@adapter_options = options
end
# Starts the listener by initializing the adapter and building
# the directory record concurrently, then it starts the adapter to watch
# for changes.
#
# @param [Boolean] blocking whether or not to block the current thread after starting
#
def start(blocking = true)
t = Thread.new { @directory_record.build }
@adapter = initialize_adapter
t.join
@adapter.start(blocking)
end
# Stops the listener.
#
def stop
@adapter.stop
end
# Pauses the listener.
#
# @return [Listen::Listener] the listener
#
def pause
@adapter.paused = true
self
end
# Unpauses the listener.
#
# @return [Listen::Listener] the listener
#
def unpause
@directory_record.build
@adapter.paused = false
self
end
# Returns whether the listener is paused or not.
#
# @return [Boolean] adapter paused status
#
def paused?
!!@adapter && @adapter.paused == true
end
# Adds ignoring patterns to the listener.
#
# @param (see Listen::DirectoryRecord#ignore)
#
# @return [Listen::Listener] the listener
#
def ignore(*regexps)
@directory_record.ignore(*regexps)
self
end
# Replaces ignoring patterns in the listener.
#
# @param (see Listen::DirectoryRecord#ignore!)
#
# @return [Listen::Listener] the listener
#
def ignore!(*regexps)
@directory_record.ignore!(*regexps)
self
end
# Adds filtering patterns to the listener.
#
# @param (see Listen::DirectoryRecord#filter)
#
# @return [Listen::Listener] the listener
#
def filter(*regexps)
@directory_record.filter(*regexps)
self
end
# Replacing filtering patterns in the listener.
#
# @param (see Listen::DirectoryRecord#filter!)
#
# @return [Listen::Listener] the listener
#
def filter!(*regexps)
@directory_record.filter!(*regexps)
self
end
# Sets the latency for the adapter. This is a helper method
# to simplify changing the latency directly from the listener.
#
# @example Wait 0.5 seconds each time before checking changes
# latency 0.5
#
# @param [Float] seconds the amount of delay, in seconds
#
# @return [Listen::Listener] the listener
#
def latency(seconds)
@adapter_options[:latency] = seconds
self
end
# Sets whether the use of the polling adapter
# should be forced or not.
#
# @example Forcing the use of the polling adapter
# force_polling true
#
# @param [Boolean] value whether to force the polling adapter or not
#
# @return [Listen::Listener] the listener
#
def force_polling(value)
@adapter_options[:force_polling] = value
self
end
# Sets whether the paths in the callback should be
# relative or absolute.
#
# @example Enabling relative paths in the callback
# relative_paths true
#
# @param [Boolean] value whether to enable relative paths in the callback or not
#
# @return [Listen::Listener] the listener
#
def relative_paths(value)
@use_relative_paths = value
self
end
# Defines a custom polling fallback message of disable it.
#
# @example Disabling the polling fallback message
# polling_fallback_message false
#
# @param [String, Boolean] value to change polling fallback message or remove it
#
# @return [Listen::Listener] the listener
#
def polling_fallback_message(value)
@adapter_options[:polling_fallback_message] = value
self
end
# Sets the callback that gets called on changes.
#
# @example Assign a callback to be called on changes
# callback = lambda { |modified, added, removed| ... }
# change &callback
#
# @param [Proc] block the callback proc
#
# @return [Listen::Listener] the listener
#
def change(&block) # modified, added, removed
@block = block
self
end
# Runs the callback passing it the changes if there are any.
#
# @param (see Listen::DirectoryRecord#fetch_changes)
#
def on_change(directories, options = {})
changes = @directory_record.fetch_changes(directories, options.merge(
:relative_paths => @use_relative_paths
))
unless changes.values.all? { |paths| paths.empty? }
@block.call(changes[:modified],changes[:added],changes[:removed])
end
end
private
# Initializes an adapter passing it the callback and adapters' options.
#
def initialize_adapter
callback = lambda { |changed_dirs, options| self.on_change(changed_dirs, options) }
Adapter.select_and_initialize(@directory, @adapter_options, &callback)
end
end
end