123456789_123456789_123456789_123456789_123456789_

Class: ActiveSupport::EventedFileUpdateChecker

Do not use. This class is for internal use only.
Relationships & Source Files
Namespace Children
Classes:
Core
Inherits: Object
Defined in: activesupport/lib/active_support/evented_file_update_checker.rb

Overview

Allows you to “listen” to changes in a file system. The evented file updater does not hit disk when checking for updates. Instead, it uses platform-specific file system events to trigger a change in state.

The file checker takes an array of files to watch or a hash specifying directories and file extensions to watch. It also takes a block that is called when #execute is run or when #execute_if_updated is run and there have been changes to the file system.

Example:

checker = ActiveSupport::EventedFileUpdateChecker.new(["/tmp/foo"]) { puts "changed" }
checker.updated?
# => false
checker.execute_if_updated
# => nil

FileUtils.touch("/tmp/foo")

checker.updated?
# => true
checker.execute_if_updated
# => "changed"

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(files, dirs = {}, &block) ⇒ EventedFileUpdateChecker

[ GitHub ] 

  


# File 'activesupport/lib/active_support/evented_file_update_checker.rb', line 36



def initialize(files, dirs = {}, &block)
  unless block
    raise ArgumentError, "A block is required to initialize an EventedFileUpdateChecker"
  end

  @block = block
  @core = Core.new(files, dirs)
  ObjectSpace.define_finalizer(self, @core.finalizer)
end


  







Instance Attribute Details



  

    #updated?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/evented_file_update_checker.rb', line 50



def updated?
  if @core.restart?
    @core.thread_safely(&:restart)
    @core.updated.make_true
  end

  @core.updated.true?
end


  







Instance Method Details



  

    #execute  
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/evented_file_update_checker.rb', line 59



def execute
  @core.updated.make_false
  @block.call
end


  








  

    #execute_if_updated  
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/evented_file_update_checker.rb', line 64



def execute_if_updated
  if updated?
    yield if block_given?
    execute
    true
  end
end


  








  

    #inspect  
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/evented_file_update_checker.rb', line 46



def inspect
  "#<ActiveSupport::EventedFileUpdateChecker:#{object_id} @files=#{@core.files.to_a.inspect}"
end