класс ActiveSupport::FileUpdateChecker

Родитель:: Объект

Проверка обновления файла

FileUpdateChecker определяет API, используемый Rails для наблюдения за файлами и управления перезагрузкой. API зависит от четырёх методов:

initialize , который ожидает два параметра и один блок, как описано ниже.
updated? , который возвращает булево значение, если в файловой системе были обновления или нет.
execute , который выполняет заданный блок при инициализации и обновляет последние наблюдаемые файлы и отметку времени.
execute_if_updated , который просто выполняет блок, если он был обновлён.

После инициализации вызов execute_if_updated должен выполнить блок только в том случае, если действительно произошли изменения в файловой системе.

Этот класс используется Rails для перезагрузки фреймворка I18n всякий раз, когда они изменяются при новом запросе.

i18n_reloader = ActiveSupport::FileUpdateChecker.new(paths) do
  I18n.reload!
end

ActiveSupport::Reloader.to_prepare do
  i18n_reloader.execute_if_updated
end

Публичные методы класса

new(files, dirs = {}, &block) Показать исходный код

# File activesupport/lib/active_support/file_update_checker.rb, line 44
def initialize(files, dirs = {}, &block)
  unless block
    raise ArgumentError, "A block is required to initialize a FileUpdateChecker"
  end

  @files = files.freeze
  @glob  = compile_glob(dirs)
  @block = block

  @watched    = nil
  @updated_at = nil

  @last_watched   = watched
  @last_update_at = updated_at(@last_watched)
end

При инициализации он принимает два параметра. Первый — массив файлов, а второй — необязательный хеш каталогов. Хеш должен иметь каталоги в качестве ключей, а значением — массив расширений, которые нужно отслеживать в этом каталоге.

Этот метод также должен получить блок, который будет вызван при изменении пути. Массив файлов и список каталогов не могут быть изменены после того, как FileUpdateChecker был инициализирован.

Публичные методы экземпляра

execute() Показать исходный код

# File activesupport/lib/active_support/file_update_checker.rb, line 82
def execute
  @last_watched   = watched
  @last_update_at = updated_at(@last_watched)
  @block.call
ensure
  @watched = nil
  @updated_at = nil
end

Выполняет заданный блок и обновляет последние наблюдаемые файлы и отметку времени.

execute_if_updated() { || ... } Показать исходный код

# File activesupport/lib/active_support/file_update_checker.rb, line 92
def execute_if_updated
  if updated?
    yield if block_given?
    execute
    true
  else
    false
  end
end

Выполняет заданный блок, если он был обновлён.

updated?() Показать исходный код

# File activesupport/lib/active_support/file_update_checker.rb, line 63
def updated?
  current_watched = watched
  if @last_watched.size != current_watched.size
    @watched = current_watched
    true
  else
    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
  end
end

Проверяет, были ли обновлены какие-либо записи. В случае обновления значения watched и/или updated_at кэшируются до тех пор, пока блок не будет выполнен через execute или execute_if_updated.