Class: Listen::Listener

Inherits:
Object
  • Object
show all
Defined in:
lib/listen/listener.rb

Direct Known Subclasses

TCP::Listener

Constant Summary collapse

RELATIVE_PATHS_WITH_MULTIPLE_DIRECTORIES_WARNING_MESSAGE = 
"The relative_paths option doesn't work when listening to multiple diretories."

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) {|modified, added, removed| ... } ⇒ Listener

Initializes the directories listener.

Parameters:

  • directory (String) —

    the directories to listen to

  • options (Hash) —

    the listen options (see Listen::Listener::Options)

Yields:

  • (modified, added, removed) —

    the changed files

Yield Parameters:

  • modified (Array<String>) —

    the list of modified files

  • added (Array<String>) —

    the list of added files

  • removed (Array<String>) —

    the list of removed files



24
25
26
27
28
29
30
31
32
 
# File 'lib/listen/listener.rb', line 24

def initialize(*args, &block)
  @options     = _init_options(args.last.is_a?(Hash) ? args.pop : {})
  @directories = args.flatten.map { |path| Pathname.new(path).realpath }
  @changes     = []
  @block       = block
  @registry    = Celluloid::Registry.new
  @supervisor  = Celluloid::SupervisionGroup.run!(@registry)
  _init_debug
end

Instance Attribute Details

#block ⇒ Object

Returns the value of attribute block.



9
10
11
 
# File 'lib/listen/listener.rb', line 9

def block
  @block
end

#changes ⇒ Object

Returns the value of attribute changes.



9
10
11
 
# File 'lib/listen/listener.rb', line 9

def changes
  @changes
end

#directories ⇒ Object

Returns the value of attribute directories.



9
10
11
 
# File 'lib/listen/listener.rb', line 9

def directories
  @directories
end

#options ⇒ Object

Returns the value of attribute options.



9
10
11
 
# File 'lib/listen/listener.rb', line 9

def options
  @options
end

#paused ⇒ Object

Returns the value of attribute paused.



9
10
11
 
# File 'lib/listen/listener.rb', line 9

def paused
  @paused
end

#registry ⇒ Object

Returns the value of attribute registry.



10
11
12
 
# File 'lib/listen/listener.rb', line 10

def registry
  @registry
end

#stopping ⇒ Object

Returns the value of attribute stopping.



9
10
11
 
# File 'lib/listen/listener.rb', line 9

def stopping
  @stopping
end

#supervisor ⇒ Object

Returns the value of attribute supervisor.



10
11
12
 
# File 'lib/listen/listener.rb', line 10

def supervisor
  @supervisor
end

#thread ⇒ Object

Returns the value of attribute thread.



9
10
11
 
# File 'lib/listen/listener.rb', line 9

def thread
  @thread
end

Instance Method Details

#_init_actors ⇒ Object (private) 



128
129
130
131
132
133
134
135
 
# File 'lib/listen/listener.rb', line 128

def _init_actors
  supervisor.add(Silencer, as: :silencer, args: self)
  supervisor.add(Record, as: :record, args: self)
  supervisor.pool(Change, as: :change_pool, args: self)

  adapter_class = Adapter.select(options)
  supervisor.add(adapter_class, as: :adapter, args: self)
end

#_init_debug ⇒ Object (private) 



120
121
122
123
124
125
126
 
# File 'lib/listen/listener.rb', line 120

def _init_debug
  if options[:debug]
    Celluloid.logger.level = Logger::INFO
  else
    Celluloid.logger = nil
  end
end

#_init_options(options = {}) ⇒ Object (private) 



112
113
114
115
116
117
118
 
# File 'lib/listen/listener.rb', line 112

def _init_options(options = {})
  { debug: false,
    latency: nil,
    wait_for_delay: 0.1,
    force_polling: false,
    polling_fallback_message: nil }.merge(options)
end

#_pop_changes ⇒ Object (private) 



154
155
156
157
158
159
160
161
 
# File 'lib/listen/listener.rb', line 154

def _pop_changes
  changes = { modified: [], added: [], removed: [] }
  until @changes.empty?
    change = @changes.pop
    change.each { |k, v| changes[k] << v.to_s }
  end
  changes.each { |_, v| v.uniq! }
end

#_wait_for_changes ⇒ Object (private) 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/listen/listener.rb', line 137

def _wait_for_changes
  loop do
    break if @stopping || Listen.stopping

    changes = _pop_changes
    unless changes.all? { |_,v| v.empty? }
      block.call(changes[:modified], changes[:added], changes[:removed])
    end
    sleep options[:wait_for_delay]
  end

  supervisor.finalize
rescue => ex
  Kernel.warn "[Listen warning]: Change block raised an exception: #{$!}"
  Kernel.warn "Backtrace:\n\t#{ex.backtrace.join("\n\t")}"
end

#ignore(regexps) ⇒ Object

Adds ignore patterns to the existing one (See DEFAULT_IGNORED_DIRECTORIES and DEFAULT_IGNORED_EXTENSIONS in Listen::Silencer)

Parameters:

  • new (Regexp, Array<Regexp>) —

    ignoring patterns.



86
87
88
89
 
# File 'lib/listen/listener.rb', line 86

def ignore(regexps)
  @options[:ignore] = [options[:ignore], regexps]
  registry[:silencer] = Silencer.new(self)
end

#ignore!(regexps) ⇒ Object

Overwrites ignore patterns (See DEFAULT_IGNORED_DIRECTORIES and DEFAULT_IGNORED_EXTENSIONS in Listen::Silencer)

Parameters:

  • new (Regexp, Array<Regexp>) —

    ignoring patterns.



95
96
97
98
99
 
# File 'lib/listen/listener.rb', line 95

def ignore!(regexps)
  @options.delete(:ignore)
  @options[:ignore!] = regexps
  registry[:silencer] = Silencer.new(self)
end

#listen? ⇒ Boolean

Returns true if Listener is neither paused nor stopped

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/listen/listener.rb', line 78

def listen?
  @paused == false && @stopping == false
end

#only(regexps) ⇒ Object

Sets only patterns, to listen only to specific regexps

Parameters:

  • new (Regexp, Array<Regexp>) —

    ignoring patterns.



105
106
107
108
 
# File 'lib/listen/listener.rb', line 105

def only(regexps)
  @options[:only] = regexps
  registry[:silencer] = Silencer.new(self)
end

#pause ⇒ Object

Pauses listening callback (adapter still running)



55
56
57
 
# File 'lib/listen/listener.rb', line 55

def pause
  @paused = true
end

#paused? ⇒ Boolean

Returns true if Listener is paused

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/listen/listener.rb', line 70

def paused?
  @paused == true
end

#start ⇒ Object

Starts the listener by initializing the adapter and building the directory record concurrently, then it starts the adapter to watch for changes. The current thread is not blocked after starting.



38
39
40
41
42
43
44
 
# File 'lib/listen/listener.rb', line 38

def start
  _init_actors
  unpause
  @stopping = false
  registry[:adapter].async.start
  @thread = Thread.new { _wait_for_changes }
end

#stop ⇒ Object

Terminates all Listen actors and kill the adapter.



48
49
50
51
 
# File 'lib/listen/listener.rb', line 48

def stop
  @stopping = true
  thread.join
end

#unpause ⇒ Object

Unpauses listening callback



61
62
63
64
 
# File 'lib/listen/listener.rb', line 61

def unpause
  registry[:record].build
  @paused = false
end