Class: Listen::Record

Inherits:
Object
  • Object
show all
Includes:
Celluloid
Defined in:
lib/listen/record/entry.rb,
lib/listen/record.rb,
lib/listen/record/symlink_detector.rb

Defined Under Namespace

Classes: Entry, SymlinkDetector

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(listener) ⇒ Record

Returns a new instance of Record.



12
13
14
15
 
# File 'lib/listen/record.rb', line 12

def initialize(listener)
  @listener = listener
  @paths    = _auto_hash
end

Instance Attribute Details

#listener ⇒ Object

TODO: deprecate



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

def listener
  @listener
end

#paths ⇒ Object

TODO: deprecate



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

def paths
  @paths
end

Instance Method Details

#_auto_hash ⇒ Object (private) 



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

def _auto_hash
  Hash.new { |h, k| h[k] = Hash.new }
end

#_fast_build(root) ⇒ Object (private)

TODO: test with a file name given TODO: test other permissions TODO: test with mixed encoding



108
109
110
111
112
113
114
 
# File 'lib/listen/record.rb', line 108

def _fast_build(root)
  symlink_detector = SymlinkDetector.new
  @paths[root] = _auto_hash
  remaining = Queue.new
  remaining << Entry.new(root, nil, nil)
  _fast_build_dir(remaining, symlink_detector) until remaining.empty?
end

#_fast_build_dir(remaining, symlink_detector) ⇒ Object (private) 



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/listen/record.rb', line 116

def _fast_build_dir(remaining, symlink_detector)
  entry = remaining.pop
  children = entry.children # NOTE: children() implicitly tests if dir
  symlink_detector.verify_unwatched!(entry)
  children.each { |child| remaining << child }
  add_dir(entry.root, entry.record_dir_key)
rescue Errno::ENOTDIR
  _fast_try_file(entry)
rescue SystemCallError, SymlinkDetector::Error
  _fast_unset_path(entry.root, entry.relative, entry.name)
end

#_fast_try_file(entry) ⇒ Object (private) 



128
129
130
131
132
 
# File 'lib/listen/record.rb', line 128

def _fast_try_file(entry)
  _fast_update_file(entry.root, entry.relative, entry.name, entry.meta)
rescue SystemCallError
  _fast_unset_path(entry.root, entry.relative, entry.name)
end

#_fast_unset_path(dir, dirname, basename) ⇒ Object (private) 



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/listen/record.rb', line 92

def _fast_unset_path(dir, dirname, basename)
  root = @paths[dir.to_s]
  # this may need to be reworked to properly remove
  # entries from a tree, without adding non-existing dirs to the record
  if [nil, '', '.'].include? dirname
    return unless root.key?(basename)
    root.delete(basename)
  else
    return unless root.key?(dirname)
    root[dirname].delete(basename)
  end
end

#_fast_update_file(dir, dirname, basename, data) ⇒ Object (private) 



82
83
84
85
86
87
88
89
90
 
# File 'lib/listen/record.rb', line 82

def _fast_update_file(dir, dirname, basename, data)
  root = @paths[dir.to_s]
  if [nil, '', '.'].include? dirname
    root[basename] = (root[basename] || {}).merge(data)
  else
    root[dirname] ||= {}
    root[dirname][basename] = (root[dirname][basename] || {}).merge(data)
  end
end

#add_dir(dir, rel_path) ⇒ Object 



17
18
19
20
 
# File 'lib/listen/record.rb', line 17

def add_dir(dir, rel_path)
  return if [nil, '', '.'].include? rel_path
  @paths[dir.to_s][rel_path] ||= {}
end

#build ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/listen/record.rb', line 61

def build
  start = Time.now.to_f
  @paths = _auto_hash

  # TODO: refactor this out (1 Record = 1 watched dir)
  listener.directories.each do |directory|
    _fast_build(directory.to_s)
  end

  Celluloid::Logger.info "Record.build(): #{Time.now.to_f - start} seconds"
rescue
  Celluloid::Logger.warn "build crashed: #{$ERROR_INFO.inspect}"
  raise
end

#dir_entries(dir, rel_path) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/listen/record.rb', line 45

def dir_entries(dir, rel_path)
  tree = if [nil, '', '.'].include? rel_path.to_s
           @paths[dir.to_s]
         else
           @paths[dir.to_s][rel_path.to_s] ||= _auto_hash
           @paths[dir.to_s][rel_path.to_s]
         end

  result = {}
  tree.each do |key, values|
    # only get data for file entries
    result[key] = values.key?(:mtime) ? values : {}
  end
  result
end

#file_data(dir, rel_path) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/listen/record.rb', line 32

def file_data(dir, rel_path)
  root = @paths[dir.to_s]
  dirname, basename = Pathname(rel_path).split.map(&:to_s)
  if [nil, '', '.'].include? dirname
    root[basename] ||= {}
    root[basename].dup
  else
    root[dirname] ||= {}
    root[dirname][basename] ||= {}
    root[dirname][basename].dup
  end
end

#unset_path(dir, rel_path) ⇒ Object 



27
28
29
30
 
# File 'lib/listen/record.rb', line 27

def unset_path(dir, rel_path)
  dirname, basename = Pathname(rel_path).split.map(&:to_s)
  _fast_unset_path(dir, dirname, basename)
end

#update_file(dir, rel_path, data) ⇒ Object 



22
23
24
25
 
# File 'lib/listen/record.rb', line 22

def update_file(dir, rel_path, data)
  dirname, basename = Pathname(rel_path).split.map(&:to_s)
  _fast_update_file(dir, dirname, basename, data)
end