2010-06-20 07:26:42 -04:00
|
|
|
module ActiveSupport
|
2011-12-13 05:23:21 -05:00
|
|
|
# \FileUpdateChecker specifies the API used by Rails to watch files
|
|
|
|
# and control reloading. The API depends on four methods:
|
|
|
|
#
|
|
|
|
# * +initialize+ which expects two parameters and one block as
|
|
|
|
# described below;
|
|
|
|
#
|
|
|
|
# * +updated?+ which returns a boolean if there were updates in
|
|
|
|
# the filesystem or not;
|
|
|
|
#
|
|
|
|
# * +execute+ which executes the given block on initialization
|
2012-04-03 19:17:45 -04:00
|
|
|
# and updates the latest watched files and timestamp;
|
2011-12-13 05:23:21 -05:00
|
|
|
#
|
|
|
|
# * +execute_if_updated+ which just executes the block if it was updated;
|
|
|
|
#
|
|
|
|
# After initialization, a call to +execute_if_updated+ must execute
|
|
|
|
# the block only if there was really a change in the filesystem.
|
|
|
|
#
|
|
|
|
# == Examples
|
|
|
|
#
|
|
|
|
# This class is used by Rails to reload the I18n framework whenever
|
|
|
|
# they are changed upon a new request.
|
2010-06-20 07:26:42 -04:00
|
|
|
#
|
2010-07-01 11:07:48 -04:00
|
|
|
# i18n_reloader = ActiveSupport::FileUpdateChecker.new(paths) do
|
|
|
|
# I18n.reload!
|
2010-06-20 07:26:42 -04:00
|
|
|
# end
|
|
|
|
#
|
2010-12-19 18:58:58 -05:00
|
|
|
# ActionDispatch::Reloader.to_prepare do
|
2010-07-01 11:07:48 -04:00
|
|
|
# i18n_reloader.execute_if_updated
|
2010-06-20 07:26:42 -04:00
|
|
|
# end
|
|
|
|
#
|
|
|
|
class FileUpdateChecker
|
2011-12-13 05:23:21 -05:00
|
|
|
# It accepts two parameters on initialization. The first is an array
|
|
|
|
# of files and the second is an optional hash of directories. The hash must
|
|
|
|
# have directories as keys and the value is an array of extensions to be
|
|
|
|
# watched under that directory.
|
2011-12-12 14:26:04 -05:00
|
|
|
#
|
2011-12-13 05:23:21 -05:00
|
|
|
# This method must also receive a block that will be called once a path changes.
|
2011-12-12 14:26:04 -05:00
|
|
|
#
|
2011-12-13 05:23:21 -05:00
|
|
|
# == Implementation details
|
2011-12-12 14:26:04 -05:00
|
|
|
#
|
2012-04-03 19:17:45 -04:00
|
|
|
# This particular implementation checks for added, updated, and removed
|
|
|
|
# files. Directories lookup are compiled to a glob for performance.
|
|
|
|
# Therefore, while someone can add new files to the +files+ array after
|
|
|
|
# initialization (and parts of Rails do depend on this feature), adding
|
|
|
|
# new directories after initialization is not supported.
|
2011-12-13 05:23:21 -05:00
|
|
|
#
|
2012-04-03 19:17:45 -04:00
|
|
|
# Notice that other objects that implement the FileUpdateChecker API may
|
2011-12-13 05:23:21 -05:00
|
|
|
# not even allow new files to be added after initialization. If this
|
|
|
|
# is the case, we recommend freezing the +files+ after initialization to
|
|
|
|
# avoid changes that won't make effect.
|
|
|
|
def initialize(files, dirs={}, &block)
|
|
|
|
@files = files
|
|
|
|
@glob = compile_glob(dirs)
|
2010-06-20 07:26:42 -04:00
|
|
|
@block = block
|
2012-04-03 19:17:45 -04:00
|
|
|
|
2012-04-05 13:44:05 -04:00
|
|
|
@watched = nil
|
|
|
|
@updated_at = nil
|
|
|
|
|
2012-04-03 19:17:45 -04:00
|
|
|
@last_watched = watched
|
|
|
|
@last_update_at = updated_at(@last_watched)
|
2010-06-20 07:26:42 -04:00
|
|
|
end
|
|
|
|
|
2012-04-03 19:17:45 -04:00
|
|
|
# Check if any of the entries were updated. If so, the watched and/or
|
|
|
|
# updated_at values are cached until the block is executed via +execute+
|
|
|
|
# or +execute_if_updated+
|
2011-12-12 16:51:33 -05:00
|
|
|
def updated?
|
2012-04-03 19:17:45 -04:00
|
|
|
current_watched = watched
|
|
|
|
if @last_watched.size != current_watched.size
|
|
|
|
@watched = current_watched
|
2011-12-12 16:51:33 -05:00
|
|
|
true
|
|
|
|
else
|
2012-04-03 19:17:45 -04:00
|
|
|
current_updated_at = updated_at(current_watched)
|
|
|
|
if @last_update_at < current_updated_at
|
|
|
|
@watched = current_watched
|
|
|
|
@updated_at = current_updated_at
|
|
|
|
true
|
|
|
|
else
|
|
|
|
false
|
|
|
|
end
|
2011-12-12 16:51:33 -05:00
|
|
|
end
|
2010-06-20 07:26:42 -04:00
|
|
|
end
|
|
|
|
|
2012-04-03 19:17:45 -04:00
|
|
|
# Executes the given block and updates the latest watched files and timestamp.
|
2011-12-13 04:07:02 -05:00
|
|
|
def execute
|
2012-04-03 19:17:45 -04:00
|
|
|
@last_watched = watched
|
|
|
|
@last_update_at = updated_at(@last_watched)
|
2011-12-13 04:07:02 -05:00
|
|
|
@block.call
|
|
|
|
ensure
|
2012-04-03 19:17:45 -04:00
|
|
|
@watched = nil
|
2011-12-12 16:51:33 -05:00
|
|
|
@updated_at = nil
|
|
|
|
end
|
|
|
|
|
2011-12-13 05:23:21 -05:00
|
|
|
# Execute the block given if updated.
|
2010-06-20 07:26:42 -04:00
|
|
|
def execute_if_updated
|
2011-12-12 16:51:33 -05:00
|
|
|
if updated?
|
2011-12-13 04:07:02 -05:00
|
|
|
execute
|
2011-12-12 12:19:28 -05:00
|
|
|
true
|
|
|
|
else
|
|
|
|
false
|
2010-06-20 07:26:42 -04:00
|
|
|
end
|
|
|
|
end
|
2011-12-12 14:26:04 -05:00
|
|
|
|
|
|
|
private
|
|
|
|
|
2012-04-03 19:17:45 -04:00
|
|
|
def watched
|
|
|
|
@watched || begin
|
2012-03-15 23:54:39 -04:00
|
|
|
all = @files.select { |f| File.exists?(f) }
|
2012-04-03 19:17:45 -04:00
|
|
|
all.concat(Dir[@glob]) if @glob
|
|
|
|
all
|
2011-12-12 16:51:33 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-04-03 19:17:45 -04:00
|
|
|
def updated_at(paths)
|
|
|
|
@updated_at || paths.map { |path| File.mtime(path) }.max || Time.at(0)
|
|
|
|
end
|
|
|
|
|
|
|
|
def compile_glob(hash)
|
2011-12-13 04:07:02 -05:00
|
|
|
hash.freeze # Freeze so changes aren't accidently pushed
|
2011-12-12 14:26:04 -05:00
|
|
|
return if hash.empty?
|
2011-12-13 04:07:02 -05:00
|
|
|
|
2012-03-15 23:54:39 -04:00
|
|
|
globs = hash.map do |key, value|
|
|
|
|
"#{escape(key)}/**/*#{compile_ext(value)}"
|
2011-12-12 14:26:04 -05:00
|
|
|
end
|
|
|
|
"{#{globs.join(",")}}"
|
|
|
|
end
|
|
|
|
|
2012-03-15 08:21:20 -04:00
|
|
|
def escape(key)
|
|
|
|
key.gsub(',','\,')
|
|
|
|
end
|
|
|
|
|
2012-04-03 19:17:45 -04:00
|
|
|
def compile_ext(array)
|
2012-01-05 23:03:53 -05:00
|
|
|
array = Array(array)
|
2011-12-12 14:26:04 -05:00
|
|
|
return if array.empty?
|
|
|
|
".{#{array.join(",")}}"
|
|
|
|
end
|
2010-06-20 07:26:42 -04:00
|
|
|
end
|
2010-06-21 04:28:02 -04:00
|
|
|
end
|