Class: Listen::Record

Inherits:
Object
  • Object
show all
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(directory, silencer) ⇒ Record

Returns a new instance of Record.



14
15
16
17
18
 
# File 'lib/listen/record.rb', line 14

def initialize(directory, silencer)
  reset_tree
  @root = directory.to_s
  @silencer = silencer
end

Instance Attribute Details

#root ⇒ Object (readonly)

TODO: one Record object per watched directory? TODO: deprecate



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

def root
  @root
end

Instance Method Details

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



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/listen/record.rb', line 103

def _fast_build_dir(remaining, symlink_detector)
  entry = remaining.pop
  return if @silencer.silenced?(entry.record_dir_key, :dir)

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

#_fast_try_file(entry) ⇒ Object (private) 



117
118
119
120
121
 
# File 'lib/listen/record.rb', line 117

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

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



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

def _fast_unset_path(dirname, basename)
  # this may need to be reworked to properly remove
  # entries from a tree, without adding non-existing dirs to the record
  if empty_dirname?(dirname.to_s)
    if @tree.key?(basename)
      @tree.delete(basename)
    end
  elsif @tree.key?(dirname)
    @tree[dirname].delete(basename)
  end
end

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



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

def _fast_update_file(dirname, basename, data)
  if empty_dirname?(dirname.to_s)
    @tree[basename] = @tree[basename].merge(data)
  else
    @tree[dirname][basename] = (@tree[dirname][basename] || {}).merge(data)
  end
end

#add_dir(rel_path) ⇒ Object 



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

def add_dir(rel_path)
  if !empty_dirname?(rel_path.to_s)
    @tree[rel_path.to_s]
  end
end

#build ⇒ Object 



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

def build
  reset_tree
  # TODO: test with a file name given
  # TODO: test other permissions
  # TODO: test with mixed encoding
  symlink_detector = SymlinkDetector.new
  remaining = ::Queue.new
  remaining << Entry.new(root, nil, nil)
  _fast_build_dir(remaining, symlink_detector) until remaining.empty?
end

#dir_entries(rel_path) ⇒ Object 



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

def dir_entries(rel_path)
  rel_path_s = rel_path.to_s
  subtree = if empty_dirname?(rel_path_s)
    @tree
  else
    @tree[rel_path_s]
  end

  subtree.each_with_object({}) do |(key, values), result|
    # only return data for file entries inside the dir (which will each be sub-hashes)
    if values.is_a?(Hash)
      result[key] = values.has_key?(:mtime) ? values : {}
    end
  end
end

#empty_dirname?(dirname) ⇒ Boolean (private)

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/listen/record.rb', line 75

def empty_dirname?(dirname)
  ['.', ''].include?(dirname)
end

#file_data(rel_path) ⇒ Object 



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

def file_data(rel_path)
  dirname, basename = Pathname(rel_path).split.map(&:to_s)
  if empty_dirname?(dirname)
    @tree[basename].dup
  else
    @tree[dirname][basename] ||= {}
    @tree[dirname][basename].dup
  end
end

#reset_tree ⇒ Object (private) 



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

def reset_tree
  @tree = Hash.new { |h, k| h[k] = {} }
end

#unset_path(rel_path) ⇒ Object 



31
32
33
34
 
# File 'lib/listen/record.rb', line 31

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

#update_file(rel_path, data) ⇒ Object 



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

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