watch 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 139939cce511392cc1c3172230654f39f2d15bf88f624185e1543e31e6750df7
+  data.tar.gz: eb852ac92d9187981d6622b9aca55648b2d222b6e848da09764929e97f8829cd
+SHA512:
+  metadata.gz: 24abf286cd6a02c038d4f23fb1408507c9d4b5a1582d9cb00296c90c3054a84e229cd903184666575374bd22a5a224694dad7df58e04d6f0e9be6d9375a5240d
+  data.tar.gz: 7da08315e9cb05d6a34bbc914ac59b881f438b7701f9b0abd09e4e05f0c8243ef9427b05bee9a866496cb1f9078802fb01cf3bd378b607352cec2ffb3fe0126a

data/README.md

@@ -5,6 +5,35 @@ be executed when something changes
 
     Watch.new("**/*") { puts "file added, removed or changed" }
 
+### Options
+
+`prefire` (default `true`) runs the block once at startup, before anything has
+changed. Pass `false` to only run it on an actual change.
+
+    Watch.new("**/*", prefire: false) { puts "something changed" }
+
+`wait` (default `0.5`) is the number of seconds to sleep between checks.
+
+    Watch.new("**/*", wait: 2) { puts "checked every two seconds" }
+
+## Why write another directory watcher? 
+
+Simplicity.
+
+If you've checked already, there are many implementations of the same kind of code.
+[kicker](http://github.com/alloy/kicker/), [watchr](http://github.com/mynyml/watchr/) and [directory_watcher](http://github.com/TwP/directory_watcher/) are all pretty awesome, only the code bases are lengthy.
+
+
+    | Library           | SLOC    |
+    |:-----------------:|:--------:|
+    |kicker             | 676      |
+    |directory_watcher  | 478      |
+    |watchr             | 268      |
+    |watch              | 34       |
+
+All three of these libraries of course had far different goals than I did for watch. They're all well tested and pretty awesome too. Use them if watch isn't enough for you.
+
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/watch.rb

@@ -1,34 +1,43 @@
 class Watch
-  def initialize(glob, &block)
+  def initialize(glob, prefire: true, wait: 0.5, &block)
     raise "must pass a block" unless block_given?
-    
-    @path = glob
-    @files = []
+
+    @glob = glob
+    @wait = wait
     @block = block
-    
-    @block.call
-    
+
+    snapshot!
+    @block.call if prefire
+
     run_loop
   end
-  
+
   private
+
   def run_loop
     loop do
-      @block.call if changed?    
-      setup
-      sleep 0.5
+      if changes?
+        @block.call
+        snapshot!
+      end
+
+      sleep @wait
     end
   end
-  
-  def changed?
-    file_list != @files
+
+  def changes?
+    @timestamps != timestamps
   end
-  
-  def setup
-    @files = file_list
+
+  def snapshot!
+    @timestamps = timestamps
   end
-  
-  def file_list
-    Dir[@path].map {|file| File.mtime(file) }
+
+  def timestamps
+    Dir[@glob].map do |file|
+      File.mtime(file)
+    rescue Errno::ENOENT
+      nil
+    end
   end
-end
+end

metadata

@@ -1,76 +1,74 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: watch
-version: !ruby/object:Gem::Version 
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Ben Schwarz
-autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-01-01 00:00:00 +11:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.9
-    version: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
 description: A dirt simple mechanism to tell if files have changed
 email: ben.schwarz@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.md
-files: 
-- .document
-- .gitignore
+extra_rdoc_files: []
+files:
 - LICENSE
 - README.md
-- Rakefile
 - VERSION
 - lib/watch.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/watcher_spec.rb
-- watch.gemspec
-has_rdoc: true
-homepage: http://github.com/benschwarz/watch
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+homepage: https://github.com/benschwarz/watch
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/benschwarz/watch
+  bug_tracker_uri: https://github.com/benschwarz/watch/issues
+  changelog_uri: https://github.com/benschwarz/watch/releases
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.5
-signing_key: 
-specification_version: 3
-summary: A simple directory
-test_files: 
-- spec/spec_helper.rb
-- spec/watcher_spec.rb
+rubygems_version: 4.0.16
+specification_version: 4
+summary: A simple directory watcher
+test_files: []

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/Rakefile

@@ -1,45 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "watch"
-    gem.summary = %Q{A simple directory}
-    gem.description = %Q{A dirt simple mechanism to tell if files have changed}
-    gem.email = "ben.schwarz@gmail.com"
-    gem.homepage = "http://github.com/benschwarz/watch"
-    gem.authors = ["Ben Schwarz"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "watch #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/spec/spec.opts

@@ -1 +0,0 @@
---color

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'watch'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
-end

data/spec/watcher_spec.rb

@@ -1,31 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-class BlockRun
-  def self.call
-  end
-end
-
-describe "watch" do    
-  before :all do
-    @watch = Watch.new("tmp/**/*") { BlockRun.call }
-  end
-  
-  it 'should run the block on startup' do
-    BlockRun.should_receive(:call)
-  end
-  
-  it 'should run the block when a file is added' do
-    BlockRun.should_receive(:call)
-    File.open("tmp/file", "w+") {|f| f << "abc"}
-  end
-
-  it 'should run the block on a file modification' do
-    BlockRun.should_receive(:call)
-    File.open("tmp/file", "w+") {|f| f << "def"}
-  end
-
-  it 'should run the block when a file is removed' do
-    BlockRun.should_receive(:call)
-    File.delete("tmp/file")
-  end
-end

data/watch.gemspec

@@ -1,55 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{watch}
-  s.version = "0.1.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ben Schwarz"]
-  s.date = %q{2010-01-01}
-  s.description = %q{A dirt simple mechanism to tell if files have changed}
-  s.email = %q{ben.schwarz@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.md"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "lib/watch.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "spec/watcher_spec.rb",
-     "watch.gemspec"
-  ]
-  s.homepage = %q{http://github.com/benschwarz/watch}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{A simple directory}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/watcher_spec.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-    else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-  end
-end
-