spicycode-beholder 0.5.4 → 0.5.5

data/README.textile

@@ -52,7 +52,7 @@ map_for(:beholders_lair) do |wizard|
   wizard.keep_a_watchful_eye_for 'coverage'
   
   # Forget all other treasure maps loaded
-  # wizard.cast_feeble_mind
+  # wizard.clear_maps
  
   # Add your own rules
   # wizard.prepare_spell_for /\/foobar/ do
@@ -62,4 +62,6 @@ map_for(:beholders_lair) do |wizard|
   # You could set the list of all examples to be run after pressing ctrl-c once
   # it defaults to any files in examples, spec, and test
   wizard.all_examples = Dir['your/path/**/*_here.rb']
-end
+end
+
+Treasure maps are automatically reloaded when you change them, so you can fire up Beholder and start iterating on the config live.

data/Rakefile

@@ -1,66 +1,44 @@
-require 'rubygems'
-require 'rake/gempackagetask'
-require 'rubygems/specification'
-require 'date'
-require 'micronaut/rake_task'
-
-GEM = "beholder"
-GEM_VERSION = "0.5.4"
-AUTHOR = "Chad Humphries"
-EMAIL = "chad@spicycode.com"
-HOMEPAGE = "http://github.com/spicycode/beholder"
-SUMMARY = "An ancient beholder that watches your treasure, and deals with thiefs"
-
-spec = Gem::Specification.new do |s|
-  s.name = GEM
-  s.version = GEM_VERSION
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README.textile", "LICENSE", 'TODO']
-  s.summary = SUMMARY
-  s.description = s.summary
-  s.author = AUTHOR
-  s.email = EMAIL
-  s.homepage = HOMEPAGE
-  s.add_dependency "fsevents"
-  s.bindir = 'bin'
-  s.default_executable = 'beholder'
-  s.executables = ["beholder"]
-  s.require_path = 'lib'
-  s.autorequire = GEM
-  s.files = %w(LICENSE README.textile Rakefile TODO) + Dir.glob("{lib,examples}/**/*")
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
-desc "install the gem locally"
-task :install => [:package] do
-  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
-end
-
-desc "create a gemspec file"
-task :make_gemspec do
-  File.open("#{GEM}.gemspec", "w") do |file|
-    file.puts spec.to_ruby
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "beholder"
+    s.summary = "An ancient beholder that watches your treasure, and deals with thiefs"
+    s.email = "chad@spicycode.com, rsanheim@gmail.com"
+    s.homepage = "http://github.com/rsanheim/beholder"
+    s.description = "beholder"
+    s.authors = "Chad Humphries, Rob Sanheim"
+    s.has_rdoc = true
+    s.extra_rdoc_files = ["README.textile", "LICENSE", 'TODO']
+    s.add_dependency "fsevents"
+    s.bindir = 'bin'
+    s.default_executable = 'beholder'
+    s.executables = ["beholder"]
+    s.require_path = 'lib'
+    s.files = %w(LICENSE README.textile Rakefile TODO) + Dir.glob("{lib,examples}/**/*")
   end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
-desc "Run all micronaut examples"
-Micronaut::RakeTask.new :examples do |t|
-  t.pattern = "examples/**/*_example.rb"
-end
+begin
+  gem "spicycode-micronaut"
+  require 'micronaut/rake_task'
 
-namespace :examples do
-  
-  desc "Run all micronaut examples using rcov"
-  Micronaut::RakeTask.new :coverage do |t|
+  desc "Run all micronaut examples"
+  Micronaut::RakeTask.new :examples do |t|
     t.pattern = "examples/**/*_example.rb"
-    t.rcov = true
-    t.rcov_opts = "--exclude \"examples/*,gems/*,db/*,/Library/Frameworks/*,/Library/Ruby/*,config/*\" --text-summary  --sort coverage --no-validator-links" 
   end
 
-end
+  namespace :examples do
+    desc "Run all micronaut examples using rcov"
+    Micronaut::RakeTask.new :coverage do |t|
+      t.pattern = "examples/**/*_example.rb"
+      t.rcov = true
+      t.rcov_opts = "--exclude \"examples/*,gems/*,db/*,/Library/Frameworks/*,/Library/Ruby/*,config/*\" --text-summary  --sort coverage --no-validator-links" 
+    end
+  end
 
-task :default => 'examples:coverage'
+  task :default => 'examples:coverage'
+rescue LoadError
+  puts "Micronaut required to run examples. Install it with: sudo gem install spicycode-micronaut -s http://gems.github.com"
+end

data/bin/beholder

@@ -1,4 +1,4 @@
 #! /usr/bin/env ruby
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
 require 'beholder'
-Beholder.cast_thy_gaze
+Beholder.run

data/examples/example_helper.rb

@@ -4,7 +4,9 @@ $LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
 require 'beholder'
 require 'rubygems'
 require 'micronaut'
-gem :rr, '=0.7.0'
+gem :rr, '>=0.7.0'
+require 'log_buddy'
+LogBuddy.init
 
 def not_in_editor?
   ['TM_MODE', 'EMACS', 'VIM'].all? { |k| !ENV.has_key?(k) }
@@ -14,4 +16,5 @@ Micronaut.configure do |c|
   c.formatter = :documentation
   c.mock_with :rr
   c.color_enabled = not_in_editor?  
-end
+  c.filter_run :focused => true
+end

data/examples/lib/beholder_example.rb

@@ -2,85 +2,177 @@ require File.expand_path(File.dirname(__FILE__) + "/../example_helper")
 
 describe Beholder do
 
-  describe "when casting it's gaze" do
+  describe "when run is called" do
     
-    it "should begat a new beholder" do
-      beholder = stub(Beholder.new) { prepare_for_interlopers; open_your_eye; spawn_dragon }
+    it "should create a new beholder" do
+      beholder = stub(Beholder.new) { prepare; start }
       mock(Beholder).new { beholder }
       
-      Beholder.cast_thy_gaze
+      Beholder.run
     end
     
-    it "should prepare the child for interlopers" do
+    it "should prepare" do
       beholder = Beholder.new 
-      stub(beholder).open_your_eye
-      stub(beholder).spawn_dragon
-      mock(beholder).prepare_for_interlopers
+      stub(beholder).start
+      mock(beholder).prepare
       stub(Beholder).new { beholder }
       
-      Beholder.cast_thy_gaze
+      Beholder.run
     end
     
-    it "should open the child's eyes" do
+    it "should start" do
       beholder = Beholder.new 
-      mock(beholder).open_your_eye
-      stub(beholder).spawn_dragon
-      stub(beholder).prepare_for_interlopers
+      mock(beholder).start
+      stub(beholder).prepare
       stub(Beholder).new { beholder }
       
-      Beholder.cast_thy_gaze
+      Beholder.run
     end
     
   end
   
-  describe "when it notices a thief taking treasure" do
+  describe "when it notices file(s) changed" do
     
-    it "should identify what was stolen" do
-      treasures = ['pot_o_gold'] 
+    it "should identify what was changed" do
+      files = ['widgets'] 
       beholder = Beholder.new
-      mock(beholder).identify_stolen_treasure('pot_o_gold') { nil }
-      beholder.notice_thief_taking treasures
+      mock(beholder).find_matches('widgets') { nil }
+      beholder.on_change files
     end
     
-    it "should reclaim the stolen treasures" do
-      treasures = ['pot_o_gold'] 
+    it "should run tests for the file that changed" do
+      files = ['widgets'] 
       beholder = Beholder.new
-      stub(beholder).identify_stolen_treasure('pot_o_gold') { 'x marks the spot' }
-      mock(beholder).reclaim_stolen_treasure_at(['x marks the spot'])
-      beholder.notice_thief_taking treasures
+      stub(beholder).find_matches('widgets') { 'widgets_example' }
+      mock(beholder).run_tests(['widgets_example'])
+      beholder.on_change files
+    end
+    
+    it "should re-eval the treasure map if the map was modified" do
+      treasure_map = "#{Dir.pwd}/.treasure_map.rb"
+      beholder = Beholder.new
+      stub(File).exist?(treasure_map) { true }
+      mock(beholder).read_map_at(treasure_map)
+      beholder.on_change treasure_map
+    end
+    
+  end
+  
+  describe "build_cmd" do
+    it "contructs build cmd for a single file" do
+      beholder = Beholder.new
+      beholder.build_cmd(["test/foo_test.rb"]).should == %[ruby -e "%w[test/foo_test].each { |f| require f }"]
+    end
+    
+    it "contructs build cmd for a multiple files" do
+      beholder = Beholder.new
+      beholder.build_cmd(["test/foo_test.rb", "test/functionals/foo_test.rb"]).should == %[ruby -e "%w[test/foo_test test/functionals/foo_test].each { |f| require f }"]
     end
     
   end
   
-  describe "when blinking it's eye" do
+  describe "blink" do
     
     it "should forget about any interlopers" do
       beholder = Beholder.new
       beholder.instance_variable_set("@sent_an_int", true) # Not so hot, but I'm tired
 
       beholder.sent_an_int.should be_true
-      beholder.blink
+      beholder.__send__ :blink
       beholder.sent_an_int.should be_false
     end
     
   end
   
-  describe "when closing it's eye" do
+  describe "when shutting down" do
     
-    it "should stop watching for interlopers"  do
+    it "should stop watching for changes"  do
       beholder = Beholder.new
       stub(beholder).exit
-      stub(beholder).the_eye { mock!.shutdown }
-      beholder.close_your_eye
+      stub(beholder).watcher { mock!.shutdown }
+      beholder.shutdown
     end
     
-    it "should leave the dungeon" do
+    it "should exit" do
       beholder = Beholder.new
-      stub(beholder).the_eye { stub!.shutdown }
+      stub(beholder).watcher { stub!.shutdown }
       mock(beholder).exit
-      beholder.close_your_eye
+      beholder.shutdown
     end
     
   end
   
-end
+  describe "watch" do
+    
+    it "adds paths to watch" do
+      beholder = Beholder.new
+      beholder.watch "bar", "foo"
+      beholder.paths_to_watch.should == ["bar", "foo"]
+    end
+    
+    it "aliases keep_a_watchful_eye_for to watch" do
+      beholder = Beholder.new
+      beholder.keep_a_watchful_eye_for "bar", "foo"
+      beholder.paths_to_watch.should == ["bar", "foo"]
+    end
+    
+    it "should uniq and sort the paths" do
+      beholder = Beholder.new
+      beholder.watch "foo", "bar", "specs", "foo", "bar", "bar2"
+      beholder.paths_to_watch.should == ["bar", "bar2", "foo", "specs"]
+    end
+  end
+  
+  describe "add_mapping" do
+    
+    it "adds pattern and block to current_map" do
+      beholder = Beholder.new
+      blk = lambda { "something" }
+      beholder.map_for(:example) { |m| m.add_mapping(%r%example_helper\.rb%, &blk) }
+      beholder.treasure_maps[:example].should == [[ %r%example_helper\.rb%, blk ]]
+    end
+    
+    it "aliases prepare_spell_for to add_mapping" do
+      beholder = Beholder.new
+      blk = lambda { "something" }
+      beholder.map_for(:example) { |m| m.prepare_spell_for(%r%example_helper\.rb%, &blk) }
+      beholder.treasure_maps[:example].should == [[ %r%example_helper\.rb%, blk ]]
+    end
+  end
+  
+  describe "examples_matching" do
+
+    it "finds a fuzzy match from all_examples" do
+      beholder = Beholder.new
+      stub(beholder).all_examples { ["examples/unit/foo_example.rb", "examples/slow/foo_example.rb", "src/foo_system_example.rb", "examples/some/deeper/dir/foo_example.rb"] }
+      beholder.examples_matching("foo").should == ["examples/unit/foo_example.rb", "examples/slow/foo_example.rb", "examples/some/deeper/dir/foo_example.rb"]
+    end
+  end
+  
+  describe "read_map_at" do
+    
+    it "rescues exceptions from instance_eval'ing the map, and carries on" do
+      beholder = Beholder.new
+      stub(File).exist? { true }
+      mock(File).readlines("my_map.rb") { ["!and this is invalid Ruby;end\nand more"] }
+      stub(beholder).puts
+      lambda { beholder.read_map_at("my_map.rb") }.should_not raise_error
+    end
+    
+  end
+  
+  describe "say" do
+    
+    it "puts to stdout if verbose is true" do
+      begin 
+        ARGV.push("-v")
+        beholder = Beholder.new
+        mock(beholder).puts("yo dawg")
+        beholder.__send__ :say, "yo dawg"
+      ensure
+        ARGV.pop
+      end
+    end
+  end
+  
+end

data/lib/beholder.rb

@@ -2,101 +2,150 @@ require 'rubygems'
 gem :fsevents
 require 'fsevents'
 
-class Proc
-  alias :cast! :call
-end
-
 class Beholder
 
-  attr_reader :paths_to_watch, :sent_an_int, :mappings, :working_directory, :be_verbose
-  attr_reader :the_eye, :treasure_maps, :possible_map_locations, :all_examples
+  attr_reader :paths_to_watch, :sent_an_int, :mappings, :working_directory, :verbose
+  attr_reader :watcher, :treasure_maps, :possible_map_locations, :all_examples
   
   def initialize
+    @working_directory = Dir.pwd
     @paths_to_watch, @all_examples = [], []
     @mappings, @treasure_maps = {}, {}
     @sent_an_int = false
-    @working_directory = Dir.pwd
-    @be_verbose = ARGV.include?("-v") || ARGV.include?("--verbose")
+    @verbose = ARGV.include?("-v") || ARGV.include?("--verbose")
     @possible_map_locations = ["#{@working_directory}/.treasure_map.rb", "#{@working_directory}/treasure_map.rb", "#{@working_directory}/config/treasure_map.rb"]
   end
-
-  def self.cast_thy_gaze
+  
+  def run
+    read_all_maps
+    set_all_examples if all_examples.empty?
+    prepare    
+    start
+  end
+  
+  def self.run
     beholder = new
-    beholder.read_all_maps
-    beholder.set_all_examples if beholder.all_examples.empty?
-    beholder.prepare_for_interlopers    
-    beholder.open_your_eye
+    beholder.run
+    self
+  end
+  
+  def map_for(map_name)
+    @treasure_maps[map_name] ||= []
+    @current_map = @treasure_maps[map_name]
+    yield self if block_given?
+  ensure
+    @current_map = nil
+  end
+
+  def add_mapping(pattern, &blk)
+    @current_map << [pattern, blk]
+  end
+
+  def watch(*paths)
+    self.paths_to_watch.concat(paths)
+    self.paths_to_watch.uniq!
+    self.paths_to_watch.sort!
+  end
+  
+  alias :keep_a_watchful_eye_for :watch
+  alias :prepare_spell_for :add_mapping
+
+  def shutdown
+    watcher.shutdown
+    exit
+  end
+
+  def on_change(paths)
+    say "#{paths} changed" unless paths.nil? || paths.empty?
+    treasure_maps_changed = paths.select { |p| possible_map_locations.include?(p) }
+    treasure_maps_changed.each {|map_path| read_map_at(map_path) }
+    matches = paths.map { |path| find_matches(path) }.uniq.compact
+    run_tests matches
+  end
+  
+  def examples_matching(name, suffix = "example")
+    regex = %r%.*#{name}_#{suffix}\.rb$%
+    all_examples.find_all { |ex| ex =~ regex }
+  end
+
+  def build_cmd(paths)
+    classes = paths.map { |p| p.gsub(".rb", "") }.join(" ")
+    puts "\nRunning #{paths.join(', ').inspect}" 
+
+    execute = %[-e "%w[#{classes}].each { |f| require f }"]
+# Pickup command from treasure map here, probably
+    cmd = "ruby #{execute}"
+    say cmd
+    cmd
   end
 
   def read_all_maps
     read_default_map
-
-    possible_map_locations.each do |map_location|
-      if File.exist?(map_location)
-        say "Found a treasure map at #{map_location}"
-        instance_eval(File.readlines(map_location).join("\n"))
-        return
-      end
+    possible_map_locations.each { |path| read_map_at(path) }
+  end
+  
+  def read_map_at(path)
+    return unless File.exist?(path)
+    say "Found a map at #{path}"
+    begin
+      instance_eval(File.readlines(path).join("\n"))
+    rescue Object => e
+      puts "Exception caught trying to load map at #{path}"
+      puts e
     end
   end
 
-  def prepare_for_interlopers
+  protected
+
+  def prepare
     trap 'INT' do
       if @sent_an_int then      
         puts "   A second INT?  Ok, I get the message.  Shutting down now."
-        close_your_eye
+        shutdown
       else
         puts "   Did you just send me an INT? Ugh.  I'll quit for real if you do it again."
         @sent_an_int = true
         Kernel.sleep 1.5
-        reclaim_stolen_treasure_at all_examples
+        run_tests all_examples
       end
     end
   end    
 
-  def open_your_eye
-    say("Watching the following locations:\n  #{paths_to_watch.join(", ")}")
-    @the_eye = FSEvents::Stream.watch(paths_to_watch) do |treasure_chest|
-      notice_thief_taking(treasure_chest.modified_files)
-      puts "\n\nWaiting to hear from the disk since #{Time.now}"
+  def start
+    startup_msg
+    @watcher = FSEvents::Stream.watch(paths_to_watch) do |event|
+      on_change(event.modified_files)
+      puts "\n\nWaiting for changes since #{Time.now}"
     end
-    @the_eye.run
-  end    
+    @watcher.run
+  end
+  
+  def startup_msg
+    puts %[Beholder has loaded - CTRL-C once to reset, twice to quit.]
+    puts %[Watching the following paths: #{paths_to_watch.join(", ")}]
+  end
   
   def read_default_map
-    map_for(:default_dungeon) do |wizard|
+    map_for(:default) do |m|
 
-      wizard.keep_a_watchful_eye_for 'lib', 'examples'
+      m.watch 'lib', 'examples'
 
-      wizard.prepare_spell_for %r%examples/(.*)_example\.rb% do |spell_component|
-        ["examples/#{spell_component[1]}_example.rb"]
+      m.add_mapping %r%examples/(.*)_example\.rb% do |match|
+        ["examples/#{match[1]}_example.rb"]
       end
 
-      wizard.prepare_spell_for %r%examples/example_helper\.rb% do |spell_component|
+      m.add_mapping %r%examples/example_helper\.rb% do |match|
         Dir["examples/**/*_example.rb"]
       end
 
-      wizard.prepare_spell_for %r%lib/(.*)\.rb% do |spell_component|
-        ["examples/lib/#{spell_component[1]}_example.rb"]
+      m.add_mapping %r%lib/(.*)\.rb% do |match|
+        examples_matching match[1]
       end
 
     end
   end
-
-  def map_for(map_name)
-    @treasure_maps[map_name] ||= []
-    @current_map = @treasure_maps[map_name]
-    yield self if block_given?
-  ensure
-    @current_map = nil
-  end
-
-  def prepare_spell_for(arcane_enemy, &spell)
-    @current_map << [arcane_enemy, spell]
-  end
-  alias :add_mapping :prepare_spell_for
-
-  def cast_feeble_mind
+  
+  def clear_maps
     @treasure_maps = {}
   end
   
@@ -114,57 +163,41 @@ class Beholder
     end
   end
 
-  def keep_a_watchful_eye_for(*paths)
-    @paths_to_watch.concat(paths)
-  end
-
   def blink
     @sent_an_int = false
   end
 
-  def close_your_eye
-    the_eye.shutdown
-    exit
-  end
-
-  def identify_stolen_treasure(treasure)
-    treasure_maps.each do |name, treasure_locations|
-      treasure_locations.each do |stolen_by_enemy, spell| 
-        if spell_components = treasure.match(stolen_by_enemy)
-          say "Found the stolen treasure using the #{name} map "
-          return spell.cast!(spell_components)
+  def find_matches(path)
+    treasure_maps.each do |name, map|
+      map.each do |pattern, blk|
+        if match = path.match(pattern)
+          say "Found the match for #{path} using the #{name} map "
+          return blk.call(match)
         end
       end
     end
 
-    puts "Unknown file: #{treasure}"
+    puts "Unknown file: #{path}"
     return []
   end
 
-  def reclaim_stolen_treasure_at(coordinates)
-    coordinates.flatten!
+  def run_tests(paths)
+    paths.flatten!
 
-    coordinates.reject! do |coordinate|
-      found_treasure = File.exist?(coordinate)
-      puts "#{coordinate} does not exist." unless found_treasure
+    paths.reject! do |path|
+      found_treasure = File.exist?(path)
+      puts "#{path} does not exist." unless found_treasure
     end
 
-    return if coordinates.empty?
-
-    puts "\nRunning #{coordinates.join(', ').inspect}" 
-    system "ruby #{coordinates.join(' ')}"
+    return if paths.empty?
+    system build_cmd(paths)
     blink
   end
-
-  def notice_thief_taking(treasure)
-    say "#{treasure} changed" unless treasure.empty?
-    coordinates = treasure.map { |t| identify_stolen_treasure(t) }.uniq.compact
-    reclaim_stolen_treasure_at coordinates
-  end
-
+  
   private
-  def say(this_message_please)
-    puts this_message_please if be_verbose
+
+  def say(msg)
+    puts msg if verbose
   end
 
-end
+end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification 
 name: spicycode-beholder
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors: 
-- Chad Humphries
-autorequire: beholder
+- Chad Humphries, Rob Sanheim
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-01-18 00:00:00 -08:00
+date: 2009-04-05 00:00:00 -07:00
 default_executable: beholder
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fsevents
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -21,8 +22,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: An ancient beholder that watches your treasure, and deals with thiefs
-email: chad@spicycode.com
+description: beholder
+email: chad@spicycode.com, rsanheim@gmail.com
 executables: 
 - beholder
 extensions: []
@@ -42,10 +43,11 @@ files:
 - examples/lib/beholder_example.rb
 - bin/beholder
 has_rdoc: true
-homepage: http://github.com/spicycode/beholder
+homepage: http://github.com/rsanheim/beholder
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement