Class: Listen::Adapter::Darwin

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

Overview

Adapter implementation for Mac OS X FSEvents.

Constant Summary collapse

OS_REGEXP = 
/darwin(?<major_version>(1|2)\d+)/i
DEFAULTS =

The default delay between checking for changes.

{ latency: 0.1 }.freeze
INCOMPATIBLE_GEM_VERSION = 
<<-EOS.gsub(/^ {8}/, '')
  rb-fsevent > 0.9.4 no longer supports OS X 10.6 through 10.8.

  Please add the following to your Gemfile to avoid polling for changes:
    require 'rbconfig'
    if RbConfig::CONFIG['target_os'] =~ /darwin(1[0-3])/i
      gem 'rb-fsevent', '<= 0.9.4'
    end
EOS

Instance Attribute Summary

Attributes inherited from Base

#config, #options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#_log_exception, #_queue_change, #_timed, #configure, #initialize, #start, #started?, #stop

Constructor Details

This class inherits a constructor from Listen::Adapter::Base

Class Method Details

.usable? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/listen/adapter/darwin.rb', line 25

def self.usable?
  version = RbConfig::CONFIG['target_os'][OS_REGEXP, :major_version]
  return false unless version
  return true if version.to_i >= 13 # darwin13 is OS X 10.9

  require 'rb-fsevent'
  fsevent_version = Gem::Version.new(FSEvent::VERSION)
  return true if fsevent_version <= Gem::Version.new('0.9.4')
  Listen.adapter_warn(INCOMPATIBLE_GEM_VERSION)
  false
end

Instance Method Details

#_configure(dir, &callback) ⇒ Object (private) 



39
40
41
 
# File 'lib/listen/adapter/darwin.rb', line 39

def _configure(dir, &callback)
  @callbacks[dir] = callback
end

#_process_changes(dirs) ⇒ Object (private) 



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/listen/adapter/darwin.rb', line 52

def _process_changes(dirs)
  dirs.each do |dir|
    dir = Pathname.new(dir.sub(%r{/$}, ''))

    @callbacks.each do |watched_dir, callback|
      if watched_dir.eql?(dir) || Listen::Directory.ascendant_of?(watched_dir, dir)
        callback.call(dir)
      end
    end
  end
end

#_process_event(dir, path) ⇒ Object (private) 



64
65
66
67
68
69
 
# File 'lib/listen/adapter/darwin.rb', line 64

def _process_event(dir, path)
  Listen.logger.debug { "fsevent: processing path: #{path.inspect}" }
  # TODO: does this preserve symlinks?
  rel_path = path.relative_path_from(dir).to_s
  _queue_change(:dir, dir, rel_path, recursive: true)
end

#_run ⇒ Object (private) 



43
44
45
46
47
48
49
50
 
# File 'lib/listen/adapter/darwin.rb', line 43

def _run
  require 'rb-fsevent'
  worker = FSEvent.new
  dirs_to_watch = @callbacks.keys.map(&:to_s)
  Listen.logger.info { "fsevent: watching: #{dirs_to_watch.inspect}" }
  worker.watch(dirs_to_watch, { latency: options.latency }, &method(:_process_changes))
  @worker_thread = Listen::Thread.new("worker_thread") { worker.run }
end

#_stop ⇒ Object (private) 



71
72
73
74
 
# File 'lib/listen/adapter/darwin.rb', line 71

def _stop
  @worker_thread&.kill
  super
end