tripwire 1.1.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-04-15
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/tripwire
+lib/tripwire.rb
+lib/tripwire/cli.rb
+lib/tripwire/runner.rb
+lib/tripwire/scanner.rb
+spec/scanner_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+temp
+

data/README.txt

@@ -0,0 +1,56 @@
+= tripwire
+
+  http://github.com/brendan/tripwire
+
+== DESCRIPTION:
+
+Tripwire is a simple tool for watching a set of files/folders for changes
+and then triggering a shell command to execute when a change occurs.
+
+It was written because I love the concepts behind autotest and rstakeout
+but the difference is that it will watch for the addition of files and
+subfolders where those tools only seemed to register a set of files at
+startup and never seemed to pick up on when you created new ones.
+
+Tripwire uses very simple Dir.glob-ing
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+  sudo gem install brendan-tripwire
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIX
+
+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,35 @@
+require 'rubygems'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tripwire"
+    gem.summary = "Executes a shell command every time file/folder changes"
+    gem.description = "Similar to rstakeout and autotest except more options"
+    gem.email = "brendan@usergenic.com"
+    gem.homepage = "http://github.com/brendan/tripwire"
+    gem.authors = ["Brendan Baldwin"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  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
+

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/bin/tripwire

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# This file needs to be readable and executable by all.
+
+me = __FILE__
+me = File.readlink(me) while(File.symlink?(me))
+require File.expand_path(File.join(File.dirname(me), "..", "lib","tripwire"))
+require 'tripwire/cli'
+
+Tripwire::CLI.new(ARGV)

data/lib/tripwire.rb

@@ -0,0 +1,8 @@
+$: << File.dirname(__FILE__)
+
+module Tripwire
+  VERSION = '1.1.0'
+end
+
+require 'tripwire/scanner'
+

data/lib/tripwire/cli.rb

@@ -0,0 +1,46 @@
+require 'optparse'
+require 'tripwire/runner'
+
+module Tripwire
+  class CLI
+
+    private
+    
+    def initialize(args)
+      
+      trap('INT') do
+        puts "\nQuitting..."
+        exit
+      end
+      
+      scanner = Tripwire::Scanner.new
+      recursive = true
+      delay = 1
+      option_parser = OptionParser.new do |opt|
+        opt.banner = "Usage: tripwire [options] <command> <filespec>+"
+        opt.on("-e","--exclude <pattern>", String, "a pattern defining files/folders to ignore") do |e|
+          scanner.exclude_patterns << e
+        end
+        opt.on("-d","--delay <seconds>", Integer, "number of seconds between each scan (defaults to 1)") do |d|
+          delay = d
+        end
+        opt.on("-q","--quiet", "suppresses output") do
+          scanner.quiet = true
+        end
+        opt.on("-n","--non-recursive", "tells tripwire *not* to scan folders recursively") do
+          recursive = false
+        end
+      end
+
+      option_parser.parse!(args)
+            
+      command = args.shift
+      args.map!{|arg| File.directory?(arg) ? "#{arg}/**/*" : arg} if recursive
+      scanner.scan_patterns.concat(args)
+      runner = Tripwire::Runner.new(scanner, command, :delay => delay)
+      runner.run! rescue puts "#{$!}\n(type tripwire -h for help)"
+      
+    end
+    
+  end
+end

data/lib/tripwire/runner.rb

@@ -0,0 +1,30 @@
+module Tripwire
+  class Runner
+    
+    attr_accessor :scanner
+    attr_accessor :command
+    attr_accessor :delay
+
+    def run!
+      raise "No command specified.  Please specify a command to run." if !command
+      raise "No files/folders specified.  Please specify files/patterns to scan." if scanner.scan_patterns.empty?
+      original_quiet = scanner.quiet
+      scanner.quiet = true
+      scanner.scan # do this because we don't care about the initial updates collection
+      scanner.quiet = original_quiet
+      loop do
+        sleep delay
+        system(command) unless scanner.scan.empty?
+      end  
+    end
+    
+    private
+    
+    def initialize(scanner, command, options={})
+      self.scanner = scanner
+      self.command = command
+      self.delay = options[:delay] || 1
+    end
+    
+  end
+end

data/lib/tripwire/scanner.rb

@@ -0,0 +1,58 @@
+module Tripwire
+  class Scanner
+    attr_accessor :exclude_patterns
+    attr_accessor :scan_patterns
+    attr_accessor :scanned_files
+    attr_accessor :scanned_file_mtimes
+    attr_accessor :updates
+    attr_accessor :quiet
+
+    def scan
+      updates.clear
+      files = scan_patterns.map {|scan_pattern| Dir.glob(scan_pattern) }.flatten.uniq
+      exclude_list = exclude_patterns.map {|exclude_pattern| Dir.glob(exclude_pattern) }.flatten
+      files -= exclude_list
+      excluded_folders = exclude_list.select {|item| File.directory?(item) }
+      excluded_folders.each do |folder|
+        regexp = /^#{Regexp.escape(folder)}\//
+        files -= files.select {|file| file.match(regexp)}
+      end
+      files.each do |file|
+        mtime = File.mtime(file)
+        previous_mtime = scanned_file_mtimes[file]
+        if mtime != previous_mtime
+          if !previous_mtime
+            updates << "A #{file}"
+          else
+            updates << "M #{file}"
+          end
+          scanned_file_mtimes[file] = mtime
+        end
+      end
+      missing_files = scanned_files - files
+      missing_files.each do |file|
+        scanned_file_mtimes.delete(file)
+        updates << "D #{file}"
+      end
+      self.scanned_files.replace(files)
+      puts updates unless quiet
+      updates
+    end
+    
+    def tripped?
+      !updates.empty?
+    end
+    
+    private
+    
+    def initialize
+      self.exclude_patterns = []
+      self.scan_patterns = []
+      self.scanned_files = []
+      self.scanned_file_mtimes = {}
+      self.updates = []
+      self.quiet = false
+    end
+    
+  end
+end

data/spec/scanner_spec.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__),"spec_helper")
+
+describe "A Tripwire Scanner" do
+
+  attr_accessor :scanner
+
+  temp = File.join(File.dirname(__FILE__),"../temp")
+
+  define_method :clear_temp_folder do
+    Dir.glob("#{temp}/**/*").sort.reverse.each do |item|
+      File.file?(item) ? File.delete(item) : Dir.delete(item)
+    end
+  end
+
+  before :each do
+    clear_temp_folder
+    self.scanner = Tripwire::Scanner.new
+    scanner.quiet = true
+    scanner.scan_patterns << "#{temp}/**/*"
+  end
+  
+  after :all do
+    clear_temp_folder
+  end
+
+  it "should detect that a folder is added to a watched folder" do
+    Dir.mkdir("#{temp}/subfolder")
+    scanner.scan.should_not be_empty
+    scanner.scan.should be_empty
+  end
+
+  it "should detect that a file is added to a watched folder" do
+    scanner.scan.should be_empty
+    File.open("#{temp}/testfile", "w") {}
+    scanner.scan.should_not be_empty
+    scanner.scan.should be_empty
+  end
+  
+  it "should detect that a watched file is modified" do
+    scanner.scan.should be_empty
+    File.open("#{temp}/testfile", "w") {}
+    scanner.scan.should_not be_empty
+    scanner.scan.should be_empty
+    sleep 1
+    File.open("#{temp}/testfile", "w") {|f| f.write("something")}
+    scanner.scan.should_not be_empty
+  end
+  
+  it "should detect that a watched file is deleted" do
+    scanner.scan.should be_empty
+    File.open("#{temp}/testfile", "w") {}
+    scanner.scan.should_not be_empty
+    scanner.scan.should be_empty
+    File.delete("#{temp}/testfile")
+    scanner.scan.should_not be_empty
+    scanner.scan.should be_empty
+  end
+  
+  it "should not watch a file matching an exclude pattern" do
+    scanner.exclude_patterns << "#{temp}/**/irrelevant"
+    scanner.scan.should be_empty
+    File.open("#{temp}/irrelevant", "w") {}
+    scanner.scan.should be_empty
+  end
+
+  it "should not watch a folder matching an exclude pattern" do
+    scanner.exclude_patterns << "#{temp}/**/irrelevant"
+    scanner.scan.should be_empty
+    Dir.mkdir("#{temp}/irrelevant")
+    scanner.scan.should be_empty
+    File.open("#{temp}/irrelevant/testfile", "w") {}
+    scanner.scan.should be_empty
+  end
+
+end
+

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'spec'
+require File.join(File.dirname(__FILE__),"..","lib","tripwire")

data/tripwire.gemspec

@@ -0,0 +1,60 @@
+# 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{tripwire}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brendan Baldwin"]
+  s.date = %q{2010-01-09}
+  s.default_executable = %q{tripwire}
+  s.description = %q{Similar to rstakeout and autotest except more options}
+  s.email = %q{brendan@usergenic.com}
+  s.executables = ["tripwire"]
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "Manifest.txt",
+     "README.txt",
+     "Rakefile",
+     "VERSION",
+     "bin/tripwire",
+     "lib/tripwire.rb",
+     "lib/tripwire/cli.rb",
+     "lib/tripwire/runner.rb",
+     "lib/tripwire/scanner.rb",
+     "spec/scanner_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tripwire.gemspec"
+  ]
+  s.homepage = %q{http://github.com/brendan/tripwire}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Executes a shell command every time file/folder changes}
+  s.test_files = [
+    "spec/scanner_spec.rb",
+     "spec/spec_helper.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
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: tripwire
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Brendan Baldwin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-09 00:00:00 -08:00
+default_executable: tripwire
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Similar to rstakeout and autotest except more options
+email: brendan@usergenic.com
+executables: 
+- tripwire
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- .gitignore
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- VERSION
+- bin/tripwire
+- lib/tripwire.rb
+- lib/tripwire/cli.rb
+- lib/tripwire/runner.rb
+- lib/tripwire/scanner.rb
+- spec/scanner_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tripwire.gemspec
+has_rdoc: true
+homepage: http://github.com/brendan/tripwire
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Executes a shell command every time file/folder changes
+test_files: 
+- spec/scanner_spec.rb
+- spec/spec_helper.rb