diff options
Diffstat (limited to 'activesupport')
-rw-r--r-- | activesupport/lib/active_support/file_update_checker.rb | 79 | ||||
-rw-r--r-- | activesupport/lib/active_support/i18n_railtie.rb | 3 | ||||
-rw-r--r-- | activesupport/test/file_update_checker_test.rb | 66 |
3 files changed, 117 insertions, 31 deletions
diff --git a/activesupport/lib/active_support/file_update_checker.rb b/activesupport/lib/active_support/file_update_checker.rb index 9d617b39d4..4137bbf6a0 100644 --- a/activesupport/lib/active_support/file_update_checker.rb +++ b/activesupport/lib/active_support/file_update_checker.rb @@ -1,3 +1,6 @@ +require "active_support/core_ext/array/wrap" +require "active_support/core_ext/array/extract_options" + module ActiveSupport # This class is responsible to track files and invoke the given block # whenever one of these files are changed. For example, this class @@ -15,24 +18,86 @@ module ActiveSupport class FileUpdateChecker attr_reader :paths, :last_update_at + # It accepts two parameters on initialization. The first is + # the *paths* and the second is *calculate*, a boolean. + # + # paths must be an array of file paths but can contain a hash as + # last argument. The hash must have directories as keys and the + # value is an array of extensions to be watched under that directory. + # + # If *calculate* is true, the latest updated at will calculated + # on initialization, therefore, the first call to execute_if_updated + # will only evaluate the block if something really changed. + # + # This method must also receive a block that will be the block called + # once a file changes. + # + # This particular implementation checks for added files and updated files, + # but not removed files. Directories lookup are compiled to a glob for + # performance. def initialize(paths, calculate=false, &block) @paths = paths + @glob = compile_glob(@paths.extract_options!) @block = block + @updated_at = nil @last_update_at = calculate ? updated_at : nil end - def updated_at - # TODO: Use Enumerable check once we get rid of 1.8.7 - all = paths.is_a?(Array) ? paths : Dir[paths] - all.map { |path| File.mtime(path) }.max + # Check if any of the entries were updated. If so, the updated_at + # value is cached until flush! is called. + def updated? + current_updated_at = updated_at + if @last_update_at != current_updated_at + @updated_at = updated_at + true + else + false + end + end + + # Flush the cache so updated? is calculated again + def flush! + @updated_at = nil end + # Execute the block given if updated. This call + # always flush the cache. def execute_if_updated - current_update_at = self.updated_at - if @last_update_at != current_update_at - @last_update_at = current_update_at + if updated? + @last_update_at = updated_at @block.call + true + else + false end + ensure + flush! + end + + private + + def updated_at #:nodoc: + @updated_at || begin + all = [] + all.concat @paths + all.concat Dir[@glob] if @glob + all.map { |path| File.mtime(path) }.max + end + end + + def compile_glob(hash) #:nodoc: + return if hash.empty? + globs = [] + hash.each do |key, value| + globs << "#{key}/**/*#{compile_ext(value)}" + end + "{#{globs.join(",")}}" + end + + def compile_ext(array) #:nodoc: + array = Array.wrap(array) + return if array.empty? + ".{#{array.join(",")}}" end end end diff --git a/activesupport/lib/active_support/i18n_railtie.rb b/activesupport/lib/active_support/i18n_railtie.rb index 4c59fe9ac9..a989ff8f57 100644 --- a/activesupport/lib/active_support/i18n_railtie.rb +++ b/activesupport/lib/active_support/i18n_railtie.rb @@ -17,7 +17,8 @@ module I18n # point, no path was added to the reloader, I18n.reload! is not triggered # on to_prepare callbacks. This will only happen on the config.after_initialize # callback below. - initializer "i18n.callbacks" do + initializer "i18n.callbacks" do |app| + app.reloaders << I18n::Railtie.reloader ActionDispatch::Reloader.to_prepare do I18n::Railtie.reloader.execute_if_updated end diff --git a/activesupport/test/file_update_checker_test.rb b/activesupport/test/file_update_checker_test.rb index 425931f49a..52c1f3260d 100644 --- a/activesupport/test/file_update_checker_test.rb +++ b/activesupport/test/file_update_checker_test.rb @@ -4,21 +4,19 @@ require 'fileutils' MTIME_FIXTURES_PATH = File.expand_path("../fixtures", __FILE__) -module FileUpdateCheckerSuite +class FileUpdateCheckerWithEnumerableTest < Test::Unit::TestCase FILES = %w(1.txt 2.txt 3.txt) def setup + FileUtils.mkdir_p("tmp_watcher") FileUtils.touch(FILES) end def teardown + FileUtils.rm_rf("tmp_watcher") FileUtils.rm(FILES) end - def args - raise NotImplementedError - end - def test_should_not_execute_the_block_if_no_paths_are_given i = 0 checker = ActiveSupport::FileUpdateChecker.new([]){ i += 1 } @@ -28,42 +26,64 @@ module FileUpdateCheckerSuite def test_should_invoke_the_block_on_first_call_if_it_does_not_calculate_last_updated_at_on_load i = 0 - checker = ActiveSupport::FileUpdateChecker.new(args){ i += 1 } + checker = ActiveSupport::FileUpdateChecker.new(FILES){ i += 1 } checker.execute_if_updated assert_equal 1, i end def test_should_not_invoke_the_block_on_first_call_if_it_calculates_last_updated_at_on_load i = 0 - checker = ActiveSupport::FileUpdateChecker.new(args, true){ i += 1 } + checker = ActiveSupport::FileUpdateChecker.new(FILES, true){ i += 1 } checker.execute_if_updated assert_equal 0, i end def test_should_not_invoke_the_block_if_no_file_has_changed i = 0 - checker = ActiveSupport::FileUpdateChecker.new(args){ i += 1 } - 5.times { checker.execute_if_updated } - assert_equal 1, i + checker = ActiveSupport::FileUpdateChecker.new(FILES, true){ i += 1 } + 5.times { assert !checker.execute_if_updated } + assert_equal 0, i end def test_should_invoke_the_block_if_a_file_has_changed i = 0 - checker = ActiveSupport::FileUpdateChecker.new(args){ i += 1 } - checker.execute_if_updated + checker = ActiveSupport::FileUpdateChecker.new(FILES, true){ i += 1 } sleep(1) FileUtils.touch(FILES) - checker.execute_if_updated - assert_equal 2, i + assert checker.execute_if_updated + assert_equal 1, i end -end -class FileUpdateCheckerWithEnumerableTest < Test::Unit::TestCase - include FileUpdateCheckerSuite - def args; FILES; end -end + def test_should_cache_updated_result_until_flushed + i = 0 + checker = ActiveSupport::FileUpdateChecker.new(FILES, true){ i += 1 } + assert !checker.updated? + + sleep(1) + FileUtils.touch(FILES) + + assert checker.updated? + assert checker.execute_if_updated + assert !checker.updated? + end -class FileUpdateCheckerWithStringTest < Test::Unit::TestCase - include FileUpdateCheckerSuite - def args; "{1,2,3}.txt"; end -end + def test_should_invoke_the_block_if_a_watched_dir_changed_its_glob + i = 0 + checker = ActiveSupport::FileUpdateChecker.new([{"tmp_watcher" => [:txt]}], true){ i += 1 } + FileUtils.cd "tmp_watcher" do + FileUtils.touch(FILES) + end + assert checker.execute_if_updated + assert_equal 1, i + end + + def test_should_not_invoke_the_block_if_a_watched_dir_changed_its_glob + i = 0 + checker = ActiveSupport::FileUpdateChecker.new([{"tmp_watcher" => :rb}], true){ i += 1 } + FileUtils.cd "tmp_watcher" do + FileUtils.touch(FILES) + end + assert !checker.execute_if_updated + assert_equal 0, i + end +end
\ No newline at end of file |