filemonitor 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-09-15
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.markdown
+Rakefile
+lib/FileMonitor.rb
+script/console
+script/destroy
+script/generate
+spec/FileMonitor_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.markdown

@@ -0,0 +1,45 @@
+# FileMonitor
+* http://github.com/joshaven/FileMonitor
+* Joshaven Potter: <yourtech@gmail.com>
+
+
+## DESCRIPTION
+
+Watches the file system for changes.
+
+## Usage
+    require 'filemonitor'
+    file_spy = FileMonitor.new
+    # Add one or more files or directories with a callback block
+    file_spy.add(Dir.pwd) do |i|
+      # This callback will be executed in the context of a single file, even if you added a directory
+      puts "you probably should handle the change in #{i.file}"
+    end
+    # run a background process that watches for changed files... which is cloesed along with the parent process.
+    file_spy.spawn 
+    
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2009 Joshaven Potter
+
+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

@@ -0,0 +1,25 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/FileMonitor'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'filemonitor' do
+  self.developer 'Joshaven Potter', 'yourtech@gmail.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+  self.readme_file = "README.markdown"
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/FileMonitor.rb

@@ -0,0 +1,111 @@
+# Purpose:
+# Watches the file system for changes
+#
+# Usage:
+# > require 'file_monitor'
+# > file_spy = FileMonitor.new
+# > file_spy.add(Dir.pwd) do |i|
+# >   puts "you probably should handle the change in #{i.file}"
+# > end
+# > file_spy.spawn
+
+require 'digest/md5'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+  
+module HashAccess
+  def method_missing(mth, *args)
+    return args.empty? ? self[mth] : self[mth.to_s.chomp('=').to_sym]=args.first
+  end
+end
+
+class FileMonitor
+  VERSION = '0.0.1'
+  attr_accessor :spawns
+  def initialize()
+    @watched = []
+  end
+
+  def add(item, &callback)
+    if File.file? item
+      h = {:file=>File.expand_path(item), :callback=>callback}
+      h.extend(HashAccess)
+      @watched << h
+    elsif File.directory? item
+      files_recursive(item).each {|f| add(f, &callback) }
+    end
+  end
+
+  def changes?
+    return first_changed
+  end
+
+  def process
+    # itterates watched files and runs callbacks when changes are detected.
+    @watched.each do |i|
+      key = digest(i.file)
+      i.digest = key if i.digest.nil?  # skip first change detection, its always unknown on first run
+      update(i, key) unless i.digest == key
+    end
+  end
+
+  def watching
+    # Returns an Array of files being watched
+    @watched
+  end
+
+  def monitor(interval = 1)
+    trap("INT") do 
+      STDERR.puts "  Interrupted by Control-C"
+      exit 2
+    end
+
+    while true
+      process
+      sleep interval
+    end
+  end
+
+  def spawn(interval = 1)
+    if @spawns.nil? 
+      @spawns = fork {monitor interval}
+      Process.detach(@spawns)
+      Kernel.at_exit do
+        Process.kill('HUP', @spawns)
+        @spawns = nil
+      end
+      true
+    else
+      @spawns
+    end
+    @spawns ||= []
+  end
+private
+  def update(item, key)
+    item.callback.call(item) unless item.callback.nil?
+    item.digest= key
+  end
+
+  def first_changed
+    # returns first changed item or false
+    @watched.each {|i| return i if changed? i}
+    false
+  end
+
+  def changed?(item)
+    # returns md5 if changed, returns false when not changed
+    md5 = digest(item.file) 
+    md5 == item.digest ? false : md5
+  end
+
+  def digest(file)
+    # returns the md5 of a file
+    Digest::MD5.hexdigest( File.read(file) )
+  end
+
+  def files_recursive(dirname)
+    # return an array of files from this (dirname) point forth.
+    Dir["#{dirname}/**/**"].collect {|f| f if File.file? f }.compact
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/FileMonitor.rb'}"
+puts "Loading FileMonitor gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/FileMonitor_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    # violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'FileMonitor'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: filemonitor
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshaven Potter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: Watches the file system for changes.
+email: 
+- yourtech@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.markdown
+- Rakefile
+- lib/FileMonitor.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/FileMonitor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/joshaven/FileMonitor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+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: []
+
+rubyforge_project: filemonitor
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Watches the file system for changes.
+test_files: []
+