diff options
| -rw-r--r-- | activesupport/lib/active_support/file_evented_update_checker.rb | 99 | ||||
| -rw-r--r-- | activesupport/test/file_evented_update_checker_test.rb | 60 |
2 files changed, 126 insertions, 33 deletions
diff --git a/activesupport/lib/active_support/file_evented_update_checker.rb b/activesupport/lib/active_support/file_evented_update_checker.rb index 18ac398a43..a4dd4ff30c 100644 --- a/activesupport/lib/active_support/file_evented_update_checker.rb +++ b/activesupport/lib/active_support/file_evented_update_checker.rb @@ -3,17 +3,19 @@ require 'set' require 'pathname' module ActiveSupport - class FileEventedUpdateChecker + class FileEventedUpdateChecker #:nodoc: all def initialize(files, dirs={}, &block) - @files = files.map {|f| expand_path(f)}.to_set + @ph = PathHelper.new + @files = files.map {|f| @ph.xpath(f)}.to_set @dirs = {} dirs.each do |dir, exts| - @dirs[expand_path(dir)] = Array(exts).map(&:to_s) + @dirs[@ph.xpath(dir)] = Array(exts).map {|ext| @ph.normalize_extension(ext)} end - @block = block + @block = block @modified = false + @lcsp = @ph.longest_common_subpath(@dirs.keys) if (watch_dirs = base_directories).any? Listen.to(*watch_dirs, &method(:changed)).start @@ -39,35 +41,31 @@ module ActiveSupport private - def expand_path(fname) - File.expand_path(fname) - end - def changed(modified, added, removed) - return if updated? - - if (modified + added + removed).any? {|f| watching?(f)} - @modified = true + unless updated? + @modified = (modified + added + removed).any? {|f| watching?(f)} end end def watching?(file) - file = expand_path(file) - return true if @files.member?(file) + file = @ph.xpath(file) - file = Pathname.new(file) + return true if @files.member?(file) return false if file.directory? - ext = file.extname.sub(/\A\./, '') + ext = @ph.normalize_extension(file.extname) dir = file.dirname loop do - if @dirs.fetch(dir.to_path, []).include?(ext) + if @dirs.fetch(dir, []).include?(ext) break true else - if dir.root? # TODO: find a common parent directory in initialize - break false + if @lcsp + break false if dir == @lcsp + else + break false if dir.root? end + dir = dir.parent end end @@ -76,27 +74,62 @@ module ActiveSupport # TODO: Better return a list of non-nested directories. def base_directories [].tap do |bd| - bd.concat @files.map {|f| existing_parent(File.dirname(f))} - bd.concat @dirs.keys.map {|dir| existing_parent(dir)} + bd.concat @files.map {|f| @ph.existing_parent(f.dirname)} + bd.concat @dirs.keys.map {|dir| @ph.existing_parent(dir)} bd.compact! bd.uniq! end end - def existing_parent(dir) - dir = Pathname.new(expand_path(dir)) + class PathHelper + def xpath(path) + Pathname.new(path).expand_path + end - loop do - if dir.directory? - break dir.to_path - else - if dir.root? - # Edge case in which not even the root exists. For example, Windows - # paths could have a non-existing drive letter. Since the parent of - # root is root, we need to break to prevent an infinite loop. - break + def normalize_extension(ext) + ext.to_s.sub(/\A\./, '') + end + + # Given a collection of Pathname objects returns the longest subpath + # common to all of them, or +nil+ if there is none. + def longest_common_subpath(paths) + return if paths.empty? + + csp = Pathname.new(paths[0]) + + paths[1..-1].each do |path| + loop do + break if path.ascend do |ascendant| + break true if ascendant == csp + end + + if csp.root? + # A root directory is not an ascendant of path. This may happen + # if there are paths in different drives on Windows. + return + else + csp = csp.parent + end + end + end + + csp + end + + # Returns the deepest existing ascendant, which could be the argument itself. + def existing_parent(dir) + loop do + if dir.directory? + break dir else - dir = dir.parent + if dir.root? + # Edge case in which not even the root exists. For example, Windows + # paths could have a non-existing drive letter. Since the parent of + # root is root, we need to break to prevent an infinite loop. + break + else + dir = dir.parent + end end end end diff --git a/activesupport/test/file_evented_update_checker_test.rb b/activesupport/test/file_evented_update_checker_test.rb index 10b7a5c979..727b99958e 100644 --- a/activesupport/test/file_evented_update_checker_test.rb +++ b/activesupport/test/file_evented_update_checker_test.rb @@ -1,6 +1,7 @@ require 'abstract_unit' require 'fileutils' require 'thread' +require 'pathname' require 'file_update_checker_with_enumerable_test_cases' class FileEventedUpdateCheckerTest < ActiveSupport::TestCase @@ -10,3 +11,62 @@ class FileEventedUpdateCheckerTest < ActiveSupport::TestCase ActiveSupport::FileEventedUpdateChecker.new(files, dirs, &block) end end + +class FileEventedUpdateCheckerPathHelperTest < ActiveSupport::TestCase + def pn(path) + Pathname.new(path) + end + + setup do + @ph = ActiveSupport::FileEventedUpdateChecker::PathHelper.new + end + + test '#xpath returns the expanded path as a Pathname object' do + assert_equal pn(__FILE__).expand_path, @ph.xpath(__FILE__) + end + + test '#normalize_extension returns a bare extension as is' do + assert_equal 'rb', @ph.normalize_extension('rb') + end + + test '#normalize_extension removes a leading dot' do + assert_equal 'rb', @ph.normalize_extension('.rb') + end + + test '#normalize_extension supports symbols' do + assert_equal 'rb', @ph.normalize_extension(:rb) + end + + test '#longest_common_subpath finds the longest common subpath, if there is one' do + paths = %w( + /foo/bar + /foo/baz + /foo/bar/baz/woo/zoo + ).map {|path| pn(path)} + + assert_equal pn('/foo'), @ph.longest_common_subpath(paths) + end + + test '#longest_common_subpath returns the root directory as an edge case' do + paths = %w( + /foo/bar + /foo/baz + /foo/bar/baz/woo/zoo + /wadus + ).map {|path| pn(path)} + + assert_equal pn('/'), @ph.longest_common_subpath(paths) + end + + test '#longest_common_subpath returns nil for an empty collection' do + assert_nil @ph.longest_common_subpath([]) + end + + test '#existing_parent returns the most specific existing ascendant' do + wd = Pathname.getwd + + assert_equal wd, @ph.existing_parent(wd) + assert_equal wd, @ph.existing_parent(wd.join('non-existing/directory')) + assert_equal pn('/'), @ph.existing_parent(pn('/non-existing/directory')) + end +end |