Class: Listen::Adapter::Base

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

Direct Known Subclasses

BSD, Darwin, Linux, Polling, Windows

Constant Summary collapse

DEFAULTS =

TODO: only used by tests

{}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Base

Returns a new instance of Base.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/listen/adapter/base.rb', line 16

def initialize(config)
  @started = false
  @config = config

  @configured = nil

  fail 'No directories to watch!' if config.directories.empty?

  defaults = self.class.const_get('DEFAULTS')
  @options = Listen::Options.new(config.adapter_options, defaults)
rescue
  _log_exception 'adapter config failed: %s:%s called from: %s', caller
  raise
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



11
12
13
 
# File 'lib/listen/adapter/base.rb', line 11

def config
  @config
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



11
12
13
 
# File 'lib/listen/adapter/base.rb', line 11

def options
  @options
end

Class Method Details

.usable? ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/listen/adapter/base.rb', line 123

def usable?
  const_get('OS_REGEXP') =~ RbConfig::CONFIG['target_os']
end

Instance Method Details

#_log_exception(msg, caller_stack) ⇒ Object (private) 



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/listen/adapter/base.rb', line 111

def _log_exception(msg, caller_stack)
  formatted = format(
    msg,
    $ERROR_INFO,
    $ERROR_POSITION * "\n",
    caller_stack * "\n"
  )

  Listen.logger.error(formatted)
end

#_queue_change(type, dir, rel_path, options) ⇒ Object (private)

TODO: allow backend adapters to pass specific invalidation objects e.g. Darwin -> DirRescan, INotify -> MoveScan, etc.



107
108
109
 
# File 'lib/listen/adapter/base.rb', line 107

def _queue_change(type, dir, rel_path, options)
  @snapshots[dir].invalidate(type, rel_path, options)
end

#_stop ⇒ Object (private) 



90
91
92
93
 
# File 'lib/listen/adapter/base.rb', line 90

def _stop
  @run_thread&.kill
  @run_thread = nil
end

#_timed(title) ⇒ Object (private) 



95
96
97
98
99
100
101
102
103
 
# File 'lib/listen/adapter/base.rb', line 95

def _timed(title)
  start = MonotonicTime.now
  yield
  diff = MonotonicTime.now - start
  Listen.logger.info format('%s: %.05f seconds', title, diff)
rescue
  Listen.logger.warn "#{title} crashed: #{$ERROR_INFO.inspect}"
  raise
end

#configure ⇒ Object

TODO: it's a separate method as a temporary workaround for tests rubocop:disable Metrics/MethodLength



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
 
# File 'lib/listen/adapter/base.rb', line 33

def configure
  if @configured
    Listen.logger.warn('Adapter already configured!')
    return
  end

  @configured = true

  @callbacks ||= {}
  config.directories.each do |dir|
    callback = @callbacks[dir] || lambda do |event|
      _process_event(dir, event)
    end
    @callbacks[dir] = callback
    _configure(dir, &callback)
  end

  @snapshots ||= {}
  # TODO: separate config per directory (some day maybe)
  change_config = Change::Config.new(config.queue, config.silencer)
  config.directories.each do |dir|
    record = Record.new(dir, config.silencer)
    snapshot = Change.new(change_config, record)
    @snapshots[dir] = snapshot
  end
end

#start ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/listen/adapter/base.rb', line 65

def start
  configure

  if started?
    Listen.logger.warn('Adapter already started!')
    return
  end

  @started = true

  @run_thread = Listen::Thread.new("run_thread") do
    @snapshots.each_value do |snapshot|
      _timed('Record.build()') { snapshot.record.build }
    end
    _run
  end
end

#started? ⇒ Boolean

rubocop:enable Metrics/MethodLength

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/listen/adapter/base.rb', line 61

def started?
  @started
end

#stop ⇒ Object 



83
84
85
86
 
# File 'lib/listen/adapter/base.rb', line 83

def stop
  _stop
  config.queue.close # this causes queue.pop to return `nil` to the front-end
end