directory_watcher 1.1.2 → 1.2.0

data/History.txt

@@ -1,3 +1,9 @@
+== 1.2.0 / 2009-04-12
+
+* 2 minor enhancements
+  - added an option to persist state to a file [Benjamin Thomas]
+  - the option to run the directory watcher scanner manually
+
 == 1.1.2 / 2008-12-14
 
 * 1 minor bugfix

data/Rakefile

@@ -3,7 +3,8 @@ begin
   require 'bones'
   Bones.setup
 rescue LoadError
-  load 'tasks/setup.rb'
+  begin; load 'tasks/setup.rb'
+  rescue LoadError; abort '### please install the "bones" gem ###'; end
 end
 
 ensure_in_path 'lib'
@@ -18,6 +19,7 @@ PROJ.email = 'tim.pease@gmail.com'
 PROJ.url = 'http://codeforpeople.rubyforge.org/directory_watcher'
 PROJ.version = DirectoryWatcher::VERSION
 PROJ.rubyforge.name = 'codeforpeople'
+PROJ.ignore_file = '.gitignore'
 
 PROJ.rdoc.remote_dir = 'directory_watcher'
 PROJ.spec.opts << '--color'

data/lib/directory_watcher.rb

@@ -5,6 +5,7 @@
 #
 
 require 'observer'
+require 'yaml'
 
 # == Synopsis
 #
@@ -132,6 +133,40 @@ require 'observer'
 #    gets      # when the user hits "enter" the script will terminate
 #    dw.stop
 #
+# === Persisting State
+#
+# A directory watcher can be configured to persist its current state to a
+# file when it is stopped and to load state from that same file when it
+# starts. Setting the +persist+ value to a filename will enable this
+# feature.
+#
+#    require 'directory_watcher'
+#
+#    dw = DirectoryWatcher.new '.', :glob => '**/*.rb'
+#    dw.interval = 5.0
+#    dw.persist = "dw_state.yml"
+#    dw.add_observer {|*args| args.each {|event| puts event}}
+#
+#    dw.start  # loads state from dw_state.yml
+#    gets      # when the user hits "enter" the script will terminate
+#    dw.stop   # stores state to dw_state.yml
+#
+# === Running Once
+#
+# Instead of using the built in run loop, the directory watcher can be run
+# one or many times using the +run_once+ method. The state of the directory
+# watcher can be loaded and dumped if so desired.
+#
+#    dw = DirectoryWatcher.new '.', :glob => '**/*.rb'
+#    dw.persist = "dw_state.yml"
+#    dw.add_observer {|*args| args.each {|event| puts event}}
+#
+#    dw.load!       # loads state from dw_state.yml
+#    dw.run_once
+#    sleep 5.0
+#    dw.run_once
+#    dw.persist!    # stores state to dw_state.yml
+#
 # == Contact
 #
 # A lot of discussion happens about Ruby in general on the ruby-talk
@@ -150,7 +185,7 @@ require 'observer'
 #
 class DirectoryWatcher
 
-  VERSION = '1.1.2'    # :nodoc:
+  VERSION = '1.2.0'    # :nodoc:
 
   # An +Event+ structure contains the _type_ of the event and the file _path_
   # to which the event pertains. The type can be one of the following:
@@ -161,11 +196,19 @@ class DirectoryWatcher
   #    :removed    =>  file has been removed from the directory
   #    :stable     =>  file has stabilized since being added or modified
   #
-  Event = Struct.new :type, :path
+  Event = Struct.new(:type, :path) do
+    def to_s( ) "#{type} '#{path}'" end
+  end
 
   # :stopdoc:
-  class Event
-    def to_s( ) "#{type} '#{path}'" end
+  # A persistable file stat structure used internally by the directory
+  # watcher.
+  #
+  FileStat = Struct.new(:mtime, :size, :stable) do
+    def <=>( other )
+      return unless other.is_a? ::DirectoryWatcher::FileStat
+      self.mtime <=> other.mtime
+    end
   end
   # :startdoc:
 
@@ -186,6 +229,9 @@ class DirectoryWatcher
   #                            round of file added events that would normally
   #                            be generated (glob pattern must also be
   #                            specified otherwise odd things will happen)
+  #    :persist   =>  file     the state will be persisted to and restored
+  #                            from the file when the directory watcher is
+  #                            stopped and started (respectively)
   #
   # The default glob pattern will scan all files in the configured directory.
   # Setting the :stable option to +nil+ will prevent stable events from being
@@ -205,6 +251,7 @@ class DirectoryWatcher
     self.glob = opts[:glob] || '*'
     self.interval = opts[:interval] || 30
     self.stable = opts[:stable] || nil
+    self.persist = opts[:persist]
 
     @files = (opts[:pre_load] ? scan_files : Hash.new)
     @events = []
@@ -279,9 +326,6 @@ class DirectoryWatcher
   end
   attr_reader :glob
 
-  # call-seq:
-  #    interval = 30.0
-  #
   # Sets the directory scan interval. The directory will be scanned every
   # _interval_ seconds for changes to files matching the glob pattern.
   # Raises +ArgumentError+ if the interval is zero or negative.
@@ -293,9 +337,6 @@ class DirectoryWatcher
   end
   attr_reader :interval
 
-  # call-seq:
-  #    stable = 2
-  #
   # Sets the number of intervals a file must remain unchanged before it is
   # considered "stable". When this condition is met, a stable event is
   # generated for the file. If stable is set to +nil+ then stable events
@@ -328,9 +369,35 @@ class DirectoryWatcher
   end
   attr_reader :stable
 
-  # call-seq:
-  #    running?
+  # Sets the name of the file to which the directory watcher state will be
+  # persisted when it is stopped. Setting the persist filename to +nil+ will
+  # disable this feature.
   #
+  def persist=( filename )
+    @persist = filename ? filename.to_s : nil
+  end
+  attr_reader :persist
+
+  # Write the current state of the directory watcher to the persist file.
+  # This method will do nothing if the directory watcher is running or if
+  # the persist file is not configured.
+  #
+  def persist!
+    return if running?
+    File.open(@persist, 'w') {|fd| fd.write YAML.dump(@files)} if @persist
+    self
+  end
+
+  # Loads the state of the directory watcher from the persist file. This
+  # method will do nothing if the directory watcher is running or if the
+  # persist file is not configured.
+  #
+  def load!
+    return if running?
+    @files = YAML.load_file(@persist) if @persist and test(?f, @persist)
+    self
+  end
+
   # Returns +true+ if the directory watcher is currently running. Returns
   # +false+ if this is not the case.
   #
@@ -338,23 +405,18 @@ class DirectoryWatcher
     !@thread.nil?
   end
 
-  # call-seq:
-  #    start
-  #
   # Start the directory watcher scanning thread. If the directory watcher is
   # already running, this method will return without taking any action.
   #
   def start
     return if running?
 
+    load!
     @stop = false
-    @thread = Thread.new(self) {|dw| dw.__send__ :run}
+    @thread = Thread.new(self) {|dw| dw.__send__ :run_loop}
     self
   end
 
-  # call-seq:
-  #    stop
-  #
   # Stop the directory watcher scanning thread. If the directory watcher is
   # already stopped, this method will return without taking any action.
   #
@@ -364,8 +426,10 @@ class DirectoryWatcher
     @stop = true
     @thread.wakeup if @thread.status == 'sleep'
     @thread.join
-    @thread = nil
     self
+  ensure
+    @thread = nil
+    persist!
   end
 
   # call-seq:
@@ -382,6 +446,7 @@ class DirectoryWatcher
     was_running = running?
 
     stop if was_running
+    File.delete(@persist) if @persist and test(?f, @persist)
     @files = (pre_load ? scan_files : Hash.new)
     start if was_running
   end
@@ -402,12 +467,28 @@ class DirectoryWatcher
     @thread.join limit
   end
 
+  # Performs exactly one scan of the directory for file changes and notifies
+  # the observers.
+  # 
+  # This method wil not persist file changes if that options is configured.
+  # The user must call persist! explicitly when using the run_once method.
+  #
+  def run_once
+    files = scan_files
+    keys = [files.keys, @files.keys]  # current files, previous files
+
+    find_added(files, *keys)
+    find_modified(files, *keys)
+    find_removed(*keys)
+
+    notify_observers
+    @files = files    # store the current file list for the next iteration
+    self
+  end
+
 
   private
 
-  # call-seq:
-  #    scan_files
-  #
   # Using the configured glob pattern, scan the directory for all files and
   # return a hash with the filenames as keys and +File::Stat+ objects as the
   # values. The +File::Stat+ objects contain the mtime and size of the file.
@@ -419,35 +500,24 @@ class DirectoryWatcher
         begin
           stat = File.stat fn
           next unless stat.file?
-          files[fn] = stat
+          files[fn] = DirectoryWatcher::FileStat.new(stat.mtime, stat.size)
         rescue SystemCallError; end
       end
     end
     files
   end
 
-  # call-seq:
-  #    run
-  #
   # Calling this method will enter the directory watcher's run loop. The
   # calling thread will not return until the +stop+ method is called.
   #
   # The run loop is responsible for scanning the directory for file changes,
   # and then dispatching events to registered listeners.
   #
-  def run
+  def run_loop
     until @stop
       start = Time.now.to_f
 
-      files = scan_files
-      keys = [files.keys, @files.keys]  # current files, previous files
-
-      find_added(files, *keys)
-      find_modified(files, *keys)
-      find_removed(*keys)
-
-      notify_observers
-      @files = files    # store the current file list for the next iteration
+      run_once
 
       nap_time = @interval - (Time.now.to_f - start)
       sleep nap_time if nap_time > 0
@@ -516,9 +586,6 @@ class DirectoryWatcher
     self
   end
 
-  # call-seq:
-  #    notify_observers
-  #
   # If there are queued files events, then invoke the update method of each
   # registered observer in turn passing the list of file events to each.
   # The file events array is cleared at the end of this method call.
@@ -534,11 +601,4 @@ class DirectoryWatcher
 
 end  # class DirectoryWatcher
 
-# :stopdoc:
-# We need to add a 'stable' attribute to the File::Stat object
-class File::Stat
-  attr_accessor :stable
-end
-# :startdoc:
-
 # EOF

data/tasks/gem.rake

@@ -37,8 +37,6 @@ class GemPackageTask < Rake::PackageTask
     local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
     if !test(?e, local_setup)
       Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
-      gem_spec.files = (gem_spec.files +
-          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
     end
   end
 
@@ -63,6 +61,10 @@ class GemPackageTask < Rake::PackageTask
 
     file package_dir_path => bones_files do
       mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
       bones_files.each do |fn|
         base_fn = File.join('tasks', File.basename(fn))
         f = File.join(package_dir_path, base_fn)
@@ -157,6 +159,13 @@ namespace :gem do
     puts PROJ.gem._spec.to_ruby
   end
 
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  end
+
   desc 'Install the gem'
   task :install => [:clobber, 'gem:package'] do
     sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"

data/tasks/post_load.rake

@@ -2,8 +2,8 @@
 # This file does not define any rake tasks. It is used to load some project
 # settings if they are not defined by the user.
 
-PROJ.rdoc.exclude << "^#{Regexp.escape(PROJ.manifest_file)}$"
 PROJ.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
+                 "^#{Regexp.escape(PROJ.ignore_file)}$",
                  "^#{Regexp.escape(PROJ.rdoc.dir)}/",
                  "^#{Regexp.escape(PROJ.rcov.dir)}/"]
 
@@ -25,12 +25,7 @@ PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
 
 PROJ.summary ||= PROJ.description.split('.').first
 
-PROJ.gem.files ||=
-  if test(?f, PROJ.manifest_file)
-    files = File.readlines(PROJ.manifest_file).map {|fn| fn.chomp.strip}
-    files.delete ''
-    files
-  else [] end
+PROJ.gem.files ||= manifest
 
 PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
 

data/tasks/rdoc.rake

@@ -19,10 +19,11 @@ namespace :doc do
             end
     rd.rdoc_files.push(*files)
 
-    title = "#{PROJ.name}-#{PROJ.version} Documentation"
-
+    name    = PROJ.name
     rf_name = PROJ.rubyforge.name
-    title = "#{rf_name}'s " + title if rf_name.valid? and rf_name != title
+
+    title = "#{name}-#{PROJ.version} Documentation"
+    title = "#{rf_name}'s " + title if rf_name.valid? and rf_name != name
 
     rd.options << "-t #{title}"
     rd.options.concat(rdoc.opts)

data/tasks/setup.rb

@@ -4,8 +4,9 @@ require 'rake'
 require 'rake/clean'
 require 'fileutils'
 require 'ostruct'
+require 'find'
 
-class OpenStruct; undef :gem; end
+class OpenStruct; undef :gem if defined? :gem; end 
 
 # TODO: make my own openstruct type object that includes descriptions
 # TODO: use the descriptions to output help on the available bones options
@@ -27,8 +28,8 @@ PROJ = OpenStruct.new(
   :ruby_opts => %w(-w),
   :libs => [],
   :history_file => 'History.txt',
-  :manifest_file => 'Manifest.txt',
   :readme_file => 'README.txt',
+  :ignore_file => '.bnsignore',
 
   # Announce
   :ann => OpenStruct.new(
@@ -123,9 +124,7 @@ import(*rakefiles)
 %w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
 
 # Setup some constants
-WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
-
-DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+DEV_NULL = File.exist?('/dev/null') ? '/dev/null' : 'NUL:'
 
 def quiet( &block )
   io = [STDOUT.dup, STDERR.dup]
@@ -138,23 +137,17 @@ ensure
   $stdout, $stderr = STDOUT, STDERR
 end
 
-DIFF = if WIN32 then 'diff.exe'
-       else
-         if quiet {system "gdiff", __FILE__, __FILE__} then 'gdiff'
-         else 'diff' end
-       end unless defined? DIFF
+DIFF = if system("gdiff '#{__FILE__}' '#{__FILE__}' > #{DEV_NULL} 2>&1") then 'gdiff'
+       else 'diff' end unless defined? DIFF
 
-SUDO = if WIN32 then ''
-       else
-         if quiet {system 'which sudo'} then 'sudo'
-         else '' end
-       end
+SUDO = if system("which sudo > #{DEV_NULL} 2>&1") then 'sudo'
+       else '' end unless defined? SUDO
 
-RCOV = WIN32 ? 'rcov.bat' : 'rcov'
-RDOC = WIN32 ? 'rdoc.bat' : 'rdoc'
-GEM  = WIN32 ? 'gem.bat'  : 'gem'
+RCOV = "#{RUBY} -S rcov"
+RDOC = "#{RUBY} -S rdoc"
+GEM  = "#{RUBY} -S gem"
 
-%w(rcov spec/rake/spectask rubyforge bones facets/ansicode).each do |lib|
+%w(rcov spec/rake/spectask rubyforge bones facets/ansicode zentest).each do |lib|
   begin
     require lib
     Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
@@ -254,9 +247,29 @@ end
 # Scans the current working directory and creates a list of files that are
 # candidates to be in the manifest.
 #
-def manifest_files
+def manifest
   files = []
-  exclude = Regexp.new(PROJ.exclude.join('|'))
+  exclude = PROJ.exclude.dup
+  comment = %r/^\s*#/
+ 
+  # process the ignore file and add the items there to the exclude list
+  if test(?f, PROJ.ignore_file)
+    ary = []
+    File.readlines(PROJ.ignore_file).each do |line|
+      next if line =~ comment
+      line.chomp!
+      line.strip!
+      next if line.nil? or line.empty?
+
+      glob = line =~ %r/\*\./ ? File.join('**', line) : line
+      Dir.glob(glob).each {|fn| ary << "^#{Regexp.escape(fn)}"}
+    end
+    exclude.concat ary
+  end
+
+  # generate a regular expression from the exclude list
+  exclude = Regexp.new(exclude.join('|'))
+
   Find.find '.' do |path|
     path.sub! %r/^(\.\/|\/)/o, ''
     next unless test ?f, path

data/tasks/zentest.rake

@@ -0,0 +1,36 @@
+if HAVE_ZENTEST
+
+# --------------------------------------------------------------------------
+if test(?e, PROJ.test.file) or not PROJ.test.files.to_a.empty?
+require 'autotest'
+
+namespace :test do
+  task :autotest do
+    Autotest.run
+  end
+end
+
+desc "Run the autotest loop"
+task :autotest => 'test:autotest'
+
+end  # if test
+
+# --------------------------------------------------------------------------
+if HAVE_SPEC_RAKE_SPECTASK and not PROJ.spec.files.to_a.empty?
+require 'autotest/rspec'
+
+namespace :spec do
+  task :autotest do
+    load '.autotest' if test(?f, '.autotest')
+    Autotest::Rspec.run
+  end
+end
+
+desc "Run the autotest loop"
+task :autotest => 'spec:autotest'
+
+end  # if rspec
+
+end  # if HAVE_ZENTEST
+
+# EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: directory_watcher
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-14 00:00:00 -07:00
+date: 2009-04-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.1.1
+        version: 2.5.0
     version: 
 description: ""
 email: tim.pease@gmail.com
@@ -33,7 +33,6 @@ extra_rdoc_files:
 - README.txt
 files: 
 - History.txt
-- Manifest.txt
 - README.txt
 - Rakefile
 - lib/directory_watcher.rb
@@ -41,7 +40,6 @@ files:
 - tasks/bones.rake
 - tasks/gem.rake
 - tasks/git.rake
-- tasks/manifest.rake
 - tasks/notes.rake
 - tasks/post_load.rake
 - tasks/rdoc.rake
@@ -50,6 +48,7 @@ files:
 - tasks/spec.rake
 - tasks/svn.rake
 - tasks/test.rake
+- tasks/zentest.rake
 has_rdoc: true
 homepage: http://codeforpeople.rubyforge.org/directory_watcher
 post_install_message: 

data/Manifest.txt

@@ -1,5 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-lib/directory_watcher.rb

data/tasks/manifest.rake

@@ -1,48 +0,0 @@
-
-require 'find'
-
-namespace :manifest do
-
-  desc 'Verify the manifest'
-  task :check do
-    fn = PROJ.manifest_file + '.tmp'
-    files = manifest_files
-
-    File.open(fn, 'w') {|fp| fp.puts files}
-    lines = %x(#{DIFF} -du #{PROJ.manifest_file} #{fn}).split("\n")
-    if HAVE_FACETS_ANSICODE and ENV.has_key?('TERM')
-      lines.map! do |line|
-        case line
-        when %r/^(-{3}|\+{3})/; nil
-        when %r/^@/; ANSICode.blue line
-        when %r/^\+/; ANSICode.green line
-        when %r/^\-/; ANSICode.red line
-        else line end
-      end
-    end
-    puts lines.compact
-    rm fn rescue nil
-  end
-
-  desc 'Create a new manifest'
-  task :create do
-    files = manifest_files
-    unless test(?f, PROJ.manifest_file)
-      files << PROJ.manifest_file
-      files.sort!
-    end
-    File.open(PROJ.manifest_file, 'w') {|fp| fp.puts files}
-  end
-
-  task :assert do
-    files = manifest_files
-    manifest = File.read(PROJ.manifest_file).split($/)
-    raise "ERROR: #{PROJ.manifest_file} is out of date" unless files == manifest
-  end
-
-end  # namespace :manifest
-
-desc 'Alias to manifest:check'
-task :manifest => 'manifest:check'
-
-# EOF