directory_watcher 1.1.0 → 1.1.1

data/History.txt

@@ -0,0 +1,25 @@
+== 1.1.1 / 2008-01-01
+
+* 1 minor enhancement
+  - now using Mr Bones framework instead of Hoe
+
+== 1.1.0 / 2007-11-28
+  * directory watcher now works with Ruby 1.9
+
+== 1.0.0 / 2007-08-21
+  * added a join method (much like Thread#join)
+
+== 0.1.4 / 2007-08-20
+  * added version information to the class
+
+== 0.1.3 / 2006-12-07
+  * fixed documentation generation bug
+
+== 0.1.2 / 2006-11-26
+  * fixed warnings
+
+== 0.1.1 / 2006-11-10
+  * removed explicit dependency on hoe
+
+== 0.1.0 / 2006-11-10
+  * initial release

data/Manifest.txt

@@ -1,4 +1,11 @@
+History.txt
 Manifest.txt
-Rakefile
 README.txt
+Rakefile
 lib/directory_watcher.rb
+tasks/annotations.rake
+tasks/doc.rake
+tasks/gem.rake
+tasks/manifest.rake
+tasks/rubyforge.rake
+tasks/setup.rb

data/README.txt

@@ -1,7 +1,47 @@
+directory_watcher
+    by Tim Pease
+    http://codeforpeople.rubyforge.org/directory_watcher
 
- == Directory Watcher
+== DESCRIPTION:
+  
+The directory watcher operates by scanning a directory at some interval and
+generating a list of files based on a user supplied glob pattern. As the file
+list changes from one interval to the next, events are generated and
+dispatched to registered observers. Three types of events are supported --
+added, modified, and removed.
 
- A class for watching files within a directory and generating events when
- those files change.
+== FEATURES:
+  
+See DirectoryWatcher for detailed documentation and usage.
 
- See DirectoryWatcher for detailed documentation and usage.
+== REQUIREMENTS:
+
+This is a pure ruby library. There are no requirements for using this code.
+
+== INSTALL:
+
+sudo gem install directory_watcher
+
+== LICENSE:
+
+MIT License
+Copyright (c) 2007 - 2008
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,45 +1,20 @@
+# $Id: Rakefile 442 2008-01-02 04:39:32Z tim_pease $
 
-require 'hoe'
+load 'tasks/setup.rb'
+ensure_in_path 'lib'
 require 'directory_watcher'
 
-PKG_VERSION = ENV['VERSION'] || DirectoryWatcher::VERSION
-
-Hoe.new('directory_watcher', PKG_VERSION) do |proj|
-  proj.rubyforge_name = 'codeforpeople'
-  proj.author = 'Tim Pease'
-  proj.email = 'tim.pease@gmail.com'
-  proj.url = nil
-  proj.extra_deps = []
-  proj.summary = 'A class for watching files within a directory and generating events when those files change'
-  proj.description = <<-DESC
-The directory watcher operates by scanning a directory at some interval and
-generating a list of files based on a user supplied glob pattern. As the file
-list changes from one interval to the next, events are generated and
-dispatched to registered observers. Three types of events are supported --
-added, modified, and removed.
-  DESC
-  proj.changes = <<-CHANGES
-Version 1.1.0 / 2007-11-28
-  * directory watcher now works with Ruby 1.9
-
-Version 1.0.0 / 2007-08-21
-  * added a join method (much like Thread#join)
-
-Version 0.1.4 / 2007-08-20
-  * added version information to the class
-
-Version 0.1.3 / 2006-12-07
-  * fixed documentation generation bug
-
-Version 0.1.2 / 2006-11-26
-  * fixed warnings
-
-Version 0.1.1 / 2006-11-10
-  * removed explicit dependency on hoe
-
-Version 0.1.0 / 2006-11-10
-  * initial release
-  CHANGES
-end
+task :default => 'spec:run'
+
+PROJ.name = 'directory_watcher'
+PROJ.summary = 'A class for watching files within a directory and generating events when those files change'
+PROJ.authors = 'Tim Pease'
+PROJ.email = 'tim.pease@gmail.com'
+PROJ.url = 'http://codeforpeople.rubyforge.org/directory_watcher'
+PROJ.description = paragraphs_of('README.txt', 1).join("\n\n")
+PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+PROJ.rubyforge_name = 'codeforpeople'
+PROJ.rdoc_remote_dir = 'directory_watcher'
+PROJ.version = DirectoryWatcher::VERSION
 
 # EOF

data/lib/directory_watcher.rb

@@ -150,7 +150,7 @@ require 'observer'
 #
 class DirectoryWatcher
 
-  VERSION = '1.1.0'    # :nodoc:
+  VERSION = '1.1.1'    # :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:

data/tasks/annotations.rake

@@ -0,0 +1,30 @@
+# $Id: annotations.rake 441 2008-01-02 04:25:01Z tim_pease $
+
+if HAVE_BONES
+
+desc "Enumerate all annotations"
+task :notes do
+  Bones::AnnotationExtractor.enumerate(
+      PROJ, "OPTIMIZE|FIXME|TODO", :tag => true)
+end
+
+namespace :notes do
+  desc "Enumerate all OPTIMIZE annotations"
+  task :optimize do
+    Bones::AnnotationExtractor.enumerate(PROJ, "OPTIMIZE")
+  end
+
+  desc "Enumerate all FIXME annotations"
+  task :fixme do
+    Bones::AnnotationExtractor.enumerate(PROJ, "FIXME")
+  end
+
+  desc "Enumerate all TODO annotations"
+  task :todo do
+    Bones::AnnotationExtractor.enumerate(PROJ, "TODO")
+  end
+end
+
+end  # if HAVE_BONES
+
+# EOF

data/tasks/doc.rake

@@ -0,0 +1,49 @@
+# $Id: doc.rake 441 2008-01-02 04:25:01Z tim_pease $
+
+require 'rake/rdoctask'
+
+namespace :doc do
+
+  desc 'Generate RDoc documentation'
+  Rake::RDocTask.new do |rd|
+    rd.main = PROJ.rdoc_main
+    rd.options << '-d' if !WIN32 and `which dot` =~ %r/\/dot/
+    rd.rdoc_dir = PROJ.rdoc_dir
+
+    incl = Regexp.new(PROJ.rdoc_include.join('|'))
+    excl = Regexp.new(PROJ.rdoc_exclude.join('|'))
+    files = PROJ.files.find_all do |fn|
+              case fn
+              when excl; false
+              when incl; true
+              else false end
+            end
+    rd.rdoc_files.push(*files)
+
+    title = "#{PROJ.name}-#{PROJ.version} Documentation"
+    title = "#{PROJ.rubyforge_name}'s " + title if PROJ.rubyforge_name != title
+
+    rd.options << "-t #{title}"
+  end
+
+  desc 'Generate ri locally for testing'
+  task :ri => :clobber_ri do
+    sh "#{RDOC} --ri -o ri ."
+  end
+
+  desc 'Remove ri products'
+  task :clobber_ri do
+    rm_r 'ri' rescue nil
+  end
+
+end  # namespace :doc
+
+desc 'Alias to doc:rdoc'
+task :doc => 'doc:rdoc'
+
+desc 'Remove all build products'
+task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)
+
+remove_desc_for_task %w(doc:clobber_rdoc doc:clobber_ri)
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,89 @@
+# $Id: gem.rake 441 2008-01-02 04:25:01Z tim_pease $
+
+require 'rake/gempackagetask'
+
+namespace :gem do
+
+  PROJ.spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge_name
+
+    s.description = PROJ.description
+
+    PROJ.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    s.files = PROJ.files
+    s.executables = PROJ.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc_include.join('|'))
+    excl = PROJ.rdoc_exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc_opts + ['--main', PROJ.rdoc_main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test_file
+      s.test_file = PROJ.test_file
+    else
+      s.test_files = PROJ.tests.to_a
+    end
+
+    # Do any extra stuff the user wants
+#   spec_extras.each do |msg, val|
+#     case val
+#     when Proc
+#       val.call(s.send(msg))
+#     else
+#       s.send "#{msg}=", val
+#     end
+#   end
+  end
+
+  desc 'Show information about the gem'
+  task :debug do
+    puts PROJ.spec.to_ruby
+  end
+
+  Rake::GemPackageTask.new(PROJ.spec) do |pkg|
+    pkg.need_tar = PROJ.need_tar
+    pkg.need_zip = PROJ.need_zip
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, :package] do
+    sh "#{SUDO} #{GEM} install pkg/#{PROJ.spec.file_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' #{PROJ.name}"
+  end
+
+end  # namespace :gem
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+
+remove_desc_for_task %w(gem:clobber_package)
+
+# EOF

data/tasks/manifest.rake

@@ -0,0 +1,41 @@
+# $Id: manifest.rake 441 2008-01-02 04:25:01Z tim_pease $
+
+require 'find'
+
+namespace :manifest do
+
+  desc 'Verify the manifest'
+  task :check do
+    fn = 'Manifest.tmp'
+    files = []
+    exclude = Regexp.new(PROJ.exclude.join('|'))
+    Find.find '.' do |path|
+      path.sub! %r/^(\.\/|\/)/o, ''
+      next unless test ?f, path
+      next if path =~ exclude
+      files << path
+    end
+
+    File.open(fn, 'w') {|fp| fp.puts files.sort}
+    system "#{DIFF} -du Manifest.txt #{fn}"
+    rm fn rescue nil
+  end
+
+  desc 'Create a new manifest'
+  task :create do
+    fn = 'Manifest.txt'
+    files = []
+    exclude = Regexp.new(PROJ.exclude.join('|'))
+    Find.find '.' do |path|
+      path.sub! %r/^(\.\/|\/)/o, ''
+      next unless test ?f, path
+      next if path =~ exclude
+      files << path
+    end
+
+    files << fn unless test ?f, fn
+    File.open(fn, 'w') {|fp| fp.puts files.sort}
+  end
+end
+
+# EOF

data/tasks/rubyforge.rake

@@ -0,0 +1,57 @@
+# $Id: rubyforge.rake 441 2008-01-02 04:25:01Z tim_pease $
+
+if PROJ.rubyforge_name && HAVE_RUBYFORGE
+
+require 'rubyforge'
+require 'rake/contrib/sshpublisher'
+
+namespace :gem do
+  desc 'Package and upload to RubyForge'
+  task :release => [:clobber, :package] do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+    pkg = "pkg/#{PROJ.spec.full_name}"
+
+    if $DEBUG then
+      puts "release_id = rf.add_release #{PROJ.rubyforge_name.inspect}, #{PROJ.name.inspect}, #{PROJ.version.inspect}, \"#{pkg}.tgz\""
+      puts "rf.add_file #{PROJ.rubyforge_name.inspect}, #{PROJ.name.inspect}, release_id, \"#{pkg}.gem\""
+    end
+
+    rf = RubyForge.new
+    puts 'Logging in'
+    rf.login
+
+    c = rf.userconfig
+    c['release_notes'] = PROJ.description if PROJ.description
+    c['release_changes'] = PROJ.changes if PROJ.changes
+    c['preformatted'] = true
+
+    files = [(PROJ.need_tar ? "#{pkg}.tgz" : nil),
+             (PROJ.need_zip ? "#{pkg}.zip" : nil),
+             "#{pkg}.gem"].compact
+
+    puts "Releasing #{PROJ.name} v. #{PROJ.version}"
+    rf.add_release PROJ.rubyforge_name, PROJ.name, PROJ.version, *files
+  end
+end  # namespace :gem
+
+
+namespace :doc do
+  desc "Publish RDoc to RubyForge"
+  task :release => %w(doc:clobber_rdoc doc:rdoc) do
+    config = YAML.load(
+        File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge_name}/"
+    remote_dir << PROJ.rdoc_remote_dir || PROJ.name
+    local_dir = PROJ.rdoc_dir
+
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end  # namespace :doc
+
+end  # if HAVE_RUBYFORGE
+
+# EOF

data/tasks/setup.rb

@@ -0,0 +1,144 @@
+# $Id: setup.rb 441 2008-01-02 04:25:01Z tim_pease $
+
+require 'rubygems'
+require 'rake'
+require 'fileutils'
+require 'ostruct'
+
+PROJ = OpenStruct.new
+
+PROJ.name = nil
+PROJ.summary = nil
+PROJ.description = nil
+PROJ.changes = nil
+PROJ.authors = nil
+PROJ.email = nil
+PROJ.url = nil
+PROJ.version = ENV['VERSION'] || '0.0.0'
+PROJ.rubyforge_name = nil
+PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn ^pkg ^doc)
+
+# Rspec
+PROJ.specs = FileList['spec/**/*_spec.rb']
+PROJ.spec_opts = []
+
+# Test::Unit
+PROJ.tests = FileList['test/**/test_*.rb']
+PROJ.test_file = 'test/all.rb'
+PROJ.test_opts = []
+
+# Rcov
+PROJ.rcov_opts = ['--sort', 'coverage', '-T']
+
+# Rdoc
+PROJ.rdoc_opts = []
+PROJ.rdoc_include = %w(^lib ^bin ^ext txt$)
+PROJ.rdoc_exclude = %w(extconf\.rb$ ^Manifest\.txt$)
+PROJ.rdoc_main = 'README.txt'
+PROJ.rdoc_dir = 'doc'
+PROJ.rdoc_remote_dir = nil
+
+# Extensions
+PROJ.extensions = FileList['ext/**/extconf.rb']
+PROJ.ruby_opts = %w(-w)
+PROJ.libs = []
+%w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
+
+# Gem Packaging
+PROJ.files =
+  if test ?f, 'Manifest.txt'
+    files = File.readlines('Manifest.txt').map {|fn| fn.chomp.strip}
+    files.delete ''
+    files
+  else [] end
+PROJ.executables = PROJ.files.find_all {|fn| fn =~ %r/^bin/}
+PROJ.dependencies = []
+PROJ.need_tar = true
+PROJ.need_zip = false
+
+# File Annotations
+PROJ.annotation_exclude = []
+PROJ.annotation_extensions = %w(.txt .rb .erb) << ''
+
+# Load the other rake files in the tasks folder
+Dir.glob('tasks/*.rake').sort.each {|fn| import fn}
+
+# Setup some constants
+WIN32 = %r/win32/ =~ RUBY_PLATFORM unless defined? WIN32
+
+DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+
+def quiet( &block )
+  io = [STDOUT.dup, STDERR.dup]
+  STDOUT.reopen DEV_NULL
+  STDERR.reopen DEV_NULL
+  block.call
+ensure
+  STDOUT.reopen io.first
+  STDERR.reopen io.last
+end
+
+DIFF = if WIN32 then 'diff.exe'
+       else
+         if quiet {system "gdiff", __FILE__, __FILE__} then 'gdiff'
+         else 'diff' end
+       end unless defined? DIFF
+
+SUDO = if WIN32 then ''
+       else
+         if quiet {system 'which sudo'} then 'sudo'
+         else '' end
+       end
+
+RCOV = WIN32 ? 'rcov.cmd'  : 'rcov'
+GEM  = WIN32 ? 'gem.cmd'   : 'gem'
+
+%w(rcov spec/rake/spectask rubyforge bones).each do |lib|
+  begin
+    require lib
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
+  rescue LoadError
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", false}
+  end
+end
+
+# Reads a file at +path+ and spits out an array of the +paragraphs+
+# specified.
+#
+#    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+#    summary, *description = paragraphs_of('README.txt', 3, 3..8)
+#
+def paragraphs_of(path, *paragraphs)
+  File.read(path).delete("\r").split(/\n\n+/).values_at(*paragraphs)
+end
+
+# Adds the given gem _name_ to the current project's dependency list. An
+# optional gem _version_ can be given. If omitted, the newest gem version
+# will be used.
+#
+def depend_on( name, version = nil )
+  spec = Gem.source_index.find_name(name).last
+  version = spec.version.to_s if version.nil? and !spec.nil?
+
+  PROJ.dependencies << (version.nil? ? [name] : [name, ">= #{version}"])
+end
+
+# Adds the given _path_ to the include path if it is not already there
+#
+def ensure_in_path( path )
+  path = File.expand_path(path)
+  $:.unshift(path) if test(?d, path) and not $:.include?(path)
+end
+
+# Find a rake task using the task name and remove any description text. This
+# will prevent the task from being displayed in the list of available tasks.
+#
+def remove_desc_for_task( names )
+  Array(names).each do |task_name|
+    task = Rake.application.tasks.find {|t| t.name == task_name}
+    next if task.nil?
+    task.instance_variable_set :@comment, nil
+  end
+end
+
+# EOF

metadata

@@ -1,59 +1,65 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: directory_watcher
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2007-11-28 00:00:00 -07:00
-summary: A class for watching files within a directory and generating events when those files change
-require_paths: 
-- lib
-email: tim.pease@gmail.com
-homepage: 
-rubyforge_project: codeforpeople
-description: The directory watcher operates by scanning a directory at some interval and generating a list of files based on a user supplied glob pattern. As the file list changes from one interval to the next, events are generated and dispatched to registered observers. Three types of events are supported -- added, modified, and removed.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.1.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Tim Pease
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "== DESCRIPTION:  The directory watcher operates by scanning a directory at some interval and generating a list of files based on a user supplied glob pattern. As the file list changes from one interval to the next, events are generated and dispatched to registered observers. Three types of events are supported -- added, modified, and removed."
+email: tim.pease@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
 files: 
+- History.txt
 - Manifest.txt
-- Rakefile
 - README.txt
+- Rakefile
 - lib/directory_watcher.rb
-test_files: []
-
+- tasks/annotations.rake
+- tasks/doc.rake
+- tasks/gem.rake
+- tasks/manifest.rake
+- tasks/rubyforge.rake
+- tasks/setup.rb
+has_rdoc: true
+homepage: http://codeforpeople.rubyforge.org/directory_watcher
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- Manifest.txt
-- README.txt
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+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: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.3.0
-    version: 
+rubyforge_project: codeforpeople
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A class for watching files within a directory and generating events when those files change
+test_files: []
+