class Listen::Record

@private api

@private api

Attributes

root[R]

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

Public Class Methods

new(directory, silencer) click to toggle source
# File lib/listen/record.rb, line 14
def initialize(directory, silencer)
  @tree = _auto_hash
  @root = directory.to_s
  @silencer = silencer
end

Public Instance Methods

add_dir(rel_path) click to toggle source
# File lib/listen/record.rb, line 20
def add_dir(rel_path)
  if ![nil, '', '.'].include?(rel_path)
    @tree[rel_path] ||= {}
  end
end
build() click to toggle source
# File lib/listen/record.rb, line 62
def build
  @tree = _auto_hash
  # 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) click to toggle source
# File lib/listen/record.rb, line 48
def dir_entries(rel_path)
  subtree = if ['', '.'].include? rel_path.to_s
    @tree
  else
    @tree[rel_path.to_s] ||= _auto_hash
    @tree[rel_path.to_s]
  end

  subtree.transform_values do |values|
    # only get data for file entries
    values.key?(:mtime) ? values : {}
  end
end
file_data(rel_path) click to toggle source
# File lib/listen/record.rb, line 36
def file_data(rel_path)
  dirname, basename = Pathname(rel_path).split.map(&:to_s)
  if [nil, '', '.'].include? dirname
    @tree[basename] ||= {}
    @tree[basename].dup
  else
    @tree[dirname] ||= {}
    @tree[dirname][basename] ||= {}
    @tree[dirname][basename].dup
  end
end
unset_path(rel_path) click to toggle source
# 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) click to toggle source
# 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

Private Instance Methods

_auto_hash() click to toggle source
# File lib/listen/record.rb, line 75
def _auto_hash
  Hash.new { |h, k| h[k] = {} }
end
_fast_build_dir(remaining, symlink_detector) click to toggle source
# File lib/listen/record.rb, line 100
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) click to toggle source
# File lib/listen/record.rb, line 114
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) click to toggle source
# File lib/listen/record.rb, line 88
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 [nil, '', '.'].include?(dirname)
    if @tree.key?(basename)
      @tree.delete(basename)
    end
  elsif @tree.key?(dirname)
    @tree[dirname].delete(basename)
  end
end
_fast_update_file(dirname, basename, data) click to toggle source
# File lib/listen/record.rb, line 79
def _fast_update_file(dirname, basename, data)
  if [nil, '', '.'].include?(dirname)
    @tree[basename] = (@tree[basename] || {}).merge(data)
  else
    @tree[dirname] ||= {}
    @tree[dirname][basename] = (@tree[dirname][basename] || {}).merge(data)
  end
end