directory_watcher 1.4.1 → 1.5.1

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+
+require File.expand_path('../../lib/directory_watcher', __FILE__)
+
+require 'logging'
+require 'rspec/logging_helper'
+require 'rspec/autorun'
+require 'scanner_scenarios'
+require 'utility_classes'
+
+include Logging.globally
+
+#Thread.abort_on_exception = true
+
+module DirectoryWatcherSpecs::Helpers
+  def scratch_path( *parts )
+    File.join( @scratch_dir, *parts )
+  end
+
+  # NOTE : touch will only work on *nix/BSD style systems
+  # Touch the file with the given timestamp
+  def touch( fname, time = Time.now )
+    stamp = time.strftime("%Y%m%d%H%M.%S")
+    %x[ touch -m -t #{stamp} #{fname} ]
+  end
+
+  def append_to( fname, count = 1 )
+    File.open( fname, "a" ) { |f| count.times { f.puts Time.now }}
+  end
+
+  # create a unique list of numbers with size 'count' and from the range
+  # 0..range
+  def unique_integer_list( count, range )
+    random = (0..range).to_a.sort_by { rand }
+    return random[0,count]
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    @spec_dir = DirectoryWatcher.sub_path( "spec" )
+    @scratch_dir = File.join(@spec_dir, "scratch")
+    FileUtils.rm_rf @scratch_dir if File.directory?( @scratch_dir )
+    FileUtils.mkdir @scratch_dir unless File.directory?( @scratch_dir )
+  end
+
+  config.after(:each) do
+    FileUtils.rm_rf @scratch_dir if File.directory?(@scratch_dir)
+  end
+
+  config.include DirectoryWatcherSpecs::Helpers
+
+  include RSpec::LoggingHelper
+  config.capture_log_messages
+end
+
+RSpec::Matchers.define :be_events_like do |expected|
+  match do |actual|
+    a = actual.kind_of?( Array ) ?
+            actual.map {|e| [ e.type, File.basename( e.path ) ]} :
+            [ actual.type, File.basename( actual.path ) ]
+    a == expected
+  end
+
+  failure_message_for_should do |actual|
+    s = StringIO.new
+    s.puts [ "Actual".ljust(20), "Expected".ljust(20), "Same?".ljust(20) ].join(" ")
+    s.puts [ "-"*20, "-"*20, "-"*20 ].join(" ")
+    [ actual.size, expected.size ].max.times do |x|
+      a = actual[x]
+      a = a.kind_of?( Array ) ?
+              a.map {|e| [ e.type, File.basename( e.path ) ]} :
+              [ a.type, File.basename( a.path ) ]
+      e = expected[x]
+      r = (a == e) ? "OK" : "Differ"
+      s.puts [ a.inspect.ljust(20), e.inspect.ljust(20), r ].join(" ")
+    end
+    s.string
+  end
+end

data/spec/utility_classes.rb

@@ -0,0 +1,117 @@
+module DirectoryWatcherSpecs
+  # EventObserver just hangs out and collects all the events that are sent to it
+  # It is used by the Scenario
+  class EventObserver
+    attr_reader :events
+    attr_reader :logger
+
+    def initialize( logger )
+      @logger = logger
+      @events = []
+    end
+
+    def update( *event_list )
+      logger.debug "got event #{event_list}"
+      @events.concat event_list
+    end
+  end
+
+  # Scenario is a utility to wrap up how to run a directory watcher scenario.
+  # You would use it as such:
+  #
+  #   dws = Scenario.new( watcher )
+  #   dws.do_after_events(2) do |scenario|
+  #     # do something
+  #   end.until_events(1)
+  #
+  # This will create a scenario, run the block after 2 events have been
+  # collected, and then return again after 1 more event has been collected.
+  #
+  # You can then check the events with the custom matcher
+  #
+  #  dws.events.should be_events_like( ... )
+  #
+  class Scenario
+    include DirectoryWatcher::Logable
+
+    attr_reader :watcher
+    def initialize( watcher )
+      @watcher = watcher
+      @config = watcher.config
+      @observer = EventObserver.new( logger )
+      @watcher.add_observer( @observer )
+      reset
+    end
+
+    def run_and_wait_for_event_count(count, &block )
+      before_count = @observer.events.size
+      @watcher.resume
+      logger.debug "Before yielding event_count = #{before_count}"
+      logger.debug @observer.events.inspect
+      yield self
+      wait_for_events( before_count + count )
+      return self
+    end
+
+    def run_and_wait_for_scan_count(count, &block)
+      @watcher.resume
+      yield self
+      wait_for_scan_count( count )
+      return self
+    end
+
+    def events
+      @observer.events
+    end
+
+    def stop
+      @watcher.stop
+    end
+
+    def pause
+      @watcher.pause
+    end
+
+    def resume
+      @watcher.resume
+    end
+
+    def reset
+      @observer.events.clear
+      @watcher.start
+      @watcher.pause
+      logger.debug "Scenario#reset with pause"
+    end
+
+    def run_once_and_wait_for_event_count( count, &block )
+      @watcher.resume
+      @watcher.stop
+      before_count = @observer.events.size
+      yield self
+      @watcher.run_once
+      wait_for_events( before_count + count )
+      return self
+    end
+
+    private
+
+    def wait_for_events( limit )
+      #Thread.pass until @observer.events.size >= limit
+      until @observer.events.size >= limit do
+        Thread.pass
+        sleep(0.01)
+        logger.debug "Waiting for #{limit} events, I have #{@observer.events.size}"
+      end
+    end
+
+    def wait_for_scan_count( limit )
+      @watcher.maximum_iterations = limit
+      #Thread.pass until @watcher.finished_scans?
+      until @watcher.finished_scans?
+        sleep(0.01)
+        logger.debug "Waiting for scan count #{limit} got #{@watcher.scans} #{@watcher.maximum_iterations}"
+      end
+    end
+
+  end
+end

data/version.txt

@@ -1 +1 @@
-1.4.1
+1.5.1

metadata

@@ -1,60 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: directory_watcher
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.1
   prerelease: 
 platform: ruby
 authors:
 - Tim Pease
+- Jeremy Hinegardner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-30 00:00:00.000000000Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bones-git
-  requirement: &2154666820 !ruby/object:Gem::Requirement
+  name: rev
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: 0.3.2
   type: :development
   prerelease: false
-  version_requirements: *2154666820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
-  name: rev
-  requirement: &2154666220 !ruby/object:Gem::Requirement
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.3
   type: :development
   prerelease: false
-  version_requirements: *2154666220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
-  name: eventmachine
-  requirement: &2154665460 !ruby/object:Gem::Requirement
+  name: cool.io
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.12.10
+        version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *2154665460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bones-git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+- !ruby/object:Gem::Dependency
+  name: bones-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2154664820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :development
   prerelease: false
-  version_requirements: *2154664820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 description: ! 'The directory watcher operates by scanning a directory at some interval
   and
 
@@ -66,25 +151,40 @@ description: ! 'The directory watcher operates by scanning a directory at some i
 
   added, modified, and removed.'
 email: tim.pease@gmail.com
-executables:
-- dw
+executables: []
 extensions: []
 extra_rdoc_files:
 - History.txt
 - README.txt
-- bin/dw
 files:
+- .gitignore
 - History.txt
 - README.txt
 - Rakefile
-- bin/dw
 - lib/directory_watcher.rb
+- lib/directory_watcher/collector.rb
+- lib/directory_watcher/configuration.rb
 - lib/directory_watcher/coolio_scanner.rb
 - lib/directory_watcher/em_scanner.rb
+- lib/directory_watcher/event.rb
+- lib/directory_watcher/eventable_scanner.rb
+- lib/directory_watcher/file_stat.rb
+- lib/directory_watcher/logable.rb
+- lib/directory_watcher/notifier.rb
+- lib/directory_watcher/paths.rb
 - lib/directory_watcher/rev_scanner.rb
+- lib/directory_watcher/scan.rb
+- lib/directory_watcher/scan_and_queue.rb
 - lib/directory_watcher/scanner.rb
+- lib/directory_watcher/threaded.rb
+- lib/directory_watcher/version.rb
+- spec/directory_watcher_spec.rb
+- spec/paths_spec.rb
+- spec/scanner_scenarios.rb
+- spec/spec_helper.rb
+- spec/utility_classes.rb
 - version.txt
-homepage: http://gemcutter.org/gems/directory_watcher
+homepage: http://rubygems.org/gems/directory_watcher
 licenses: []
 post_install_message: 
 rdoc_options:
@@ -106,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: directory_watcher
-rubygems_version: 1.8.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A class for watching files within a directory and generating events when

data/bin/dw

@@ -1,2 +0,0 @@
-#!/usr/bin/env ruby
-