spicycode-beholder 1.0.1 → 3.0.0

data/Rakefile

@@ -1,44 +1,58 @@
 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}/**/*")
+  Jeweler::Tasks.new do |gem|
+    gem.name = "beholder"
+    gem.summary = "An ancient beholder that watches your treasure, and deals with thiefs"
+    gem.email = "chad@spicycode.com, rsanheim@gmail.com"
+    gem.homepage = "http://github.com/rsanheim/beholder"
+    gem.description = "beholder"
+    gem.authors = "Chad Humphries, Rob Sanheim"
+    gem.has_rdoc = true
+    gem.extra_rdoc_files = ["README.md", "LICENSE"]
+    gem.bindir = 'bin'
+    gem.default_executable = 'beholder'
+    gem.executables = ["beholder"]
+    gem.require_path = 'lib'
+    gem.files = %w(LICENSE README.md Rakefile) + Dir.glob("{lib,spec}/**/*")
+    gem.add_dependency "fsevents"
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "yard"
+    gem.add_development_dependency "rr", ">= 0.7.0"
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
-begin
-  gem "spicycode-micronaut"
-  require 'micronaut/rake_task'
+begin 
+  require 'spec/rake/spectask'
 
-  desc "Run all micronaut examples"
-  Micronaut::RakeTask.new :examples do |t|
-    t.pattern = "examples/**/*_example.rb"
+  Spec::Rake::SpecTask.new(:spec) do |spec|
+    spec.libs << 'lib' << 'spec'
+    spec.spec_files = FileList['spec/**/*_spec.rb']
+    spec.spec_opts = ['-c', '-fn']
   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
+  Spec::Rake::SpecTask.new(:rcov) do |spec|
+    spec.libs << 'lib' << 'spec'
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rcov = true
+    spec.spec_opts = ['-c', '-fn']
   end
 
-  task :default => 'examples:coverage'
+  task :spec => :check_dependencies
+
+  task :default => :spec
 rescue LoadError
-  puts "Micronaut required to run examples. Install it with: sudo gem install spicycode-micronaut -s http://gems.github.com"
-end
+  task :default do
+    abort "Rspec is not available."
+  end
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/lib/beholder.rb

@@ -1,25 +1,66 @@
 require 'rubygems'
-gem 'fsevents'
 require 'fsevents'
 
 class Beholder
+  DEFAULT_RUNNER = 'ruby'
 
-  attr_reader :paths_to_watch, :sent_an_int, :mappings, :working_directory, :verbose
-  attr_reader :watcher, :treasure_maps, :possible_map_locations, :all_examples, :default_runner
+  class << self
+    attr_writer :runner, :test_types, :possible_treasure_map_locations
+    
+    def runner
+      @runner ||= ::Beholder::DEFAULT_RUNNER
+    end
+
+    def possible_treasure_map_locations
+      @possible_treasure_map_locations ||= ["#{Dir.pwd}/.treasure_map.rb", "#{Dir.pwd}/treasure_map.rb", "#{Dir.pwd}/config/treasure_map.rb"]
+    end
+
+    def test_types
+      @test_types ||= %w{spec examples test}
+    end
+
+    def test_extensions
+      @test_extensions ||= %w{spec example test}
+    end
+
+    def test_directories
+      return @test_directories if @test_directories
+      @test_directories = []
+      test_types.each do |test_type|
+        @test_directories << test_type if File.exist?(test_type) 
+      end
+      @test_directories
+    end
+
+    def all_tests
+      lambda { 
+        dirs = []
+        test_directories.each do |dir|
+          test_extensions.each do |test_ext|
+            files = Dir["#{dir}/**/*_#{test_ext}.rb"]
+            # Ignore tarantula tests for now until we add a cleaner way
+            files.reject! { |file| file.include?('tarantula/') }
+            next if files.empty?
+            dirs << files
+          end
+        end
+        dirs.flatten!
+      }.call
+    end
+  end
+
+  attr_reader :paths_to_watch, :sent_an_int, :mappings, :be_verbose
+  attr_reader :watcher, :treasure_maps
 
   def initialize
-    @working_directory = Dir.pwd
-    @paths_to_watch, @all_examples = [], []
+    @paths_to_watch = []
     @mappings, @treasure_maps = {}, {}
     @sent_an_int = false
-    @verbose = ARGV.include?("-v") || ARGV.include?("--verbose")
-    @default_runner = 'ruby'
-    @possible_map_locations = ["#{@working_directory}/.treasure_map.rb", "#{@working_directory}/treasure_map.rb", "#{@working_directory}/config/treasure_map.rb"]
+    @be_verbose = ARGV.include?("-v") || ARGV.include?("--verbose")
   end
 
   def run
     read_all_maps
-    set_all_examples if all_examples.empty?
     prepare    
     start
   end
@@ -39,22 +80,22 @@ class Beholder
   end
   
   def default_options
-    { :command => "ruby" }
+    { :command => ::Beholder.runner }
   end
 
-  def add_mapping(pattern, options = {}, &blk)
+  def prepare_spell_for(pattern, options = {}, &blk)
     options = default_options.merge(options)
     @current_map << [pattern, options, blk]
   end
 
-  def watch(*paths)
+  def keep_a_watchful_eye_for(*paths)
     @paths_to_watch.concat(paths)
     @paths_to_watch.uniq!
     @paths_to_watch.sort!
   end
 
-  alias :keep_a_watchful_eye_for :watch
-  alias :prepare_spell_for :add_mapping
+  alias :watch :keep_a_watchful_eye_for
+  alias :add_mapping :prepare_spell_for
 
   def shutdown
     watcher.shutdown
@@ -64,7 +105,7 @@ class Beholder
   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 = paths.select { |p| ::Beholder.possible_treasure_map_locations.include?(p) }
     treasure_maps_changed.each {|map_path| read_map_at(map_path) }
 
     runners_with_paths = {}
@@ -80,9 +121,9 @@ class Beholder
     run_tests runners_with_paths
   end
 
-  def examples_matching(name, suffix = "example")
-    regex = %r%.*#{name}_#{suffix}\.rb$%
-    all_examples.find_all { |ex| ex =~ regex }
+  def tests_matching(name)
+    regex = %r%.*#{name}.*\.rb$%
+    ::Beholder.all_tests.find_all { |ex| ex =~ regex }
   end
 
   def build_cmd(runner, paths)
@@ -94,7 +135,7 @@ class Beholder
 
   def read_all_maps
     read_default_map
-    possible_map_locations.each { |path| read_map_at(path) }
+    ::Beholder::possible_treasure_map_locations.each { |path| read_map_at(path) }
   end
 
   def read_map_at(path)
@@ -119,7 +160,7 @@ class Beholder
         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
-        run_tests default_runner => all_examples
+        run_tests ::Beholder.runner => ::Beholder.all_tests
       end
     end
   end    
@@ -139,20 +180,16 @@ class Beholder
   end
 
   def read_default_map
-    map_for(:default) do |m|
-
-      m.watch 'lib', 'examples'
-
-      m.add_mapping %r%examples/(.*)_example\.rb% do |match|
-        ["examples/#{match[1]}_example.rb"]
+    map_for(:and_lo_for_i_am_the_default_treasure_map) do |m|
+      
+      m.watch 'lib', *::Beholder.test_directories
+      
+      m.prepare_spell_for %r%lib/(.*)\.rb% do |match|
+       tests_matching match[1] 
       end
 
-      m.add_mapping %r%examples/example_helper\.rb% do |match|
-        Dir["examples/**/*_example.rb"]
-      end
-
-      m.add_mapping %r%lib/(.*)\.rb% do |match|
-        examples_matching match[1]
+      m.prepare_spell_for %r%.*#{::Beholder.test_extensions.join('|')}\.rb% do |match|
+       tests_matching match[1] 
       end
 
     end
@@ -162,21 +199,6 @@ class Beholder
     @treasure_maps = {}
   end
 
-  # TODO: These need to be lambdas to catch newly added files
-  def set_all_examples
-    if paths_to_watch.include?('examples')
-      @all_examples += Dir['examples/**/*_example.rb']
-    end
-
-    if paths_to_watch.include?('test')
-      @all_examples += Dir['test/**/*_test.rb']
-    end
-
-    if paths_to_watch.include?('spec')
-      @all_examples += Dir['spec/**/*_spec.rb']
-    end
-  end
-
   def blink
     @sent_an_int = false
   end
@@ -185,6 +207,7 @@ class Beholder
     treasure_maps.each do |name, map|
       map.each do |pattern, options, blk|
         run_using = options[:command]
+
         if match = path.match(pattern)
           say "Found the match for #{path} using the #{name} map "
           runners_with_paths[run_using] ||= []
@@ -215,15 +238,15 @@ class Beholder
     runners_with_paths.each do |runner, paths|
       paths.reject! do |path|
         found_treasure = File.exist?(path)
-        puts "#{path} does not exist." unless found_treasure
+        say "#{path} does not exist." unless found_treasure
       end
     end
     
     runners_with_paths.reject! { |runner, paths| paths.empty? }
   end
   
-  def say(msg)
-    puts msg if verbose
+  def say(this_message_please)
+    puts this_message_please if be_verbose
   end
 
 end

data/{examples/lib/beholder_example.rb → spec/beholder_spec.rb}

@@ -1,7 +1,21 @@
-require File.expand_path(File.dirname(__FILE__) + "/../example_helper")
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")                                                
 
 describe Beholder do
 
+  describe "runner" do
+    it "should be 'ruby'" do
+      Beholder.runner.should == 'ruby'
+    end
+  end
+
+  describe "test types" do
+    it "should include 'spec', 'examples', and 'test' by default" do
+      Beholder.test_types.should include('spec')
+      Beholder.test_types.should include('examples')
+      Beholder.test_types.should include('test')
+    end
+  end
+
   describe "when run is called" do
     
     it "should create a new beholder" do
@@ -115,36 +129,34 @@ describe Beholder do
     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%, {:command => "ruby"}, blk ]]
-    end
-    
-    it "aliases prepare_spell_for to add_mapping" do
-      beholder = Beholder.new
-      blk = lambda { "something" }
+  describe "prepare spell for" do
+    def generate_map(beholder, blk)
       beholder.map_for(:example) { |m| m.prepare_spell_for(%r%example_helper\.rb%, &blk) }
-      beholder.treasure_maps[:example].should == [[ %r%example_helper\.rb%, {:command => "ruby"}, blk ]]
     end
     
-    it "adds mapping using default command of ruby" 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%, {:command => "ruby"}, blk ]]
-    end
+      generate_map(beholder, blk)
+      # This is not ideal
+      # currently returns array, array 
+      beholder.treasure_maps[:example].first.first.should == %r%example_helper\.rb% 
+    end
+    
+    # it "adds mapping using default command of ruby" do
+      # beholder = Beholder.new
+      # blk = lambda { "something" }
+      # generate_map(beholder, blk)
+      # beholder.treasure_maps[:example].should == [[ %r%example_helper\.rb%, {:command => "ruby"}, blk ]]
+    # end
   end
   
-  describe "examples_matching" do
+  describe "tests_matching" do
 
-    it "finds a fuzzy match from all_examples" do
+    it "finds a fuzzy match from all tests" 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"]
+      stub(Beholder).all_tests { ["spec/unit/bar_example.rb", "src/foo_system_example.rb", "spec/some/deeper/dir/foo_example.rb"] }
+      beholder.tests_matching("foo").should == ["src/foo_system_example.rb", "spec/some/deeper/dir/foo_example.rb"]
     end
   end
   

data/spec/setup.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spicycode-beholder
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 3.0.0
 platform: ruby
 authors: 
 - Chad Humphries, Rob Sanheim
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-20 00:00:00 -07:00
+date: 2009-08-23 00:00:00 -07:00
 default_executable: beholder
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,36 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rr
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.0
+    version: 
 description: beholder
 email: chad@spicycode.com, rsanheim@gmail.com
 executables: 
@@ -30,18 +60,17 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.textile
-- TODO
 files: 
 - LICENSE
-- README.textile
 - Rakefile
-- TODO
-- examples/example_helper.rb
-- examples/lib/beholder_example.rb
 - lib/beholder.rb
-has_rdoc: true
+- spec/beholder_spec.rb
+- spec/setup.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
 homepage: http://github.com/rsanheim/beholder
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -62,10 +91,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: An ancient beholder that watches your treasure, and deals with thiefs
 test_files: 
-- examples/example_helper.rb
-- examples/lib/beholder_example.rb
+- spec/beholder_spec.rb
+- spec/setup.rb
+- spec/spec_helper.rb

data/README.textile

@@ -1,67 +0,0 @@
-h1. Beholder
-
-An ancient beholder that watches your treasure, and deals with thiefs.
-
-h2. What does it do?
-
-Think autotest, but powered by fseventd.
-
-h2. Requirements
-
-# OSX 10.5 or higher
-# RubyCocoa
-# fsevents gem
-
-
-
-The default treasure map:
-
-map_for(:default_dungeon) do |wizard|
-  
-  wizard.keep_a_watchful_eye_for 'app', 'config', 'lib', 'examples'
- 
-  wizard.prepare_spell_for /\/app\/(.*)\.rb/ do |spell_component|
-    ["examples/#{spell_component[1]}.rb"]
-  end
-  
-  wizard.prepare_spell_for /\/lib\/(.*)\.rb/ do |spell_component|
-    ["examples/lib/#{spell_component[1]}_example.rb"]
-  end
-  
-  wizard.prepare_spell_for /\/examples\/(.*)_example\.rb/ do |spell_component|
-    ["examples/#{spell_component[1]}_example.rb"]
-  end
-  
-  wizard.prepare_spell_for /\/examples\/example_helper\.rb/ do |spell_component|
-    Dir["examples/**/*_example.rb"]
-  end
-
-  wizard.prepare_spell_for /\/config/ do
-    Dir["examples/**/*_example.rb"]
-  end
-
-end
-
-
-In your own treasure map (stored as treasure_map.rb, .treasure_map.rb, or config/treasure_map.rb) you could do:
-
-map_for(:beholders_lair) do |wizard|
-  
-  # Clear all watched paths => wizard.paths_to_watch.clear
-  # Add these paths to the paths to watch
-  wizard.keep_a_watchful_eye_for 'coverage'
-  
-  # Forget all other treasure maps loaded
-  # wizard.clear_maps
- 
-  # Add your own rules
-  # wizard.prepare_spell_for /\/foobar/ do
-  #   Dir["examples/foobar/*_example.rb"]
-  # end
-
-  # 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
-
-Treasure maps are automatically reloaded when you change them, so you can fire up Beholder and start iterating on the config live.

data/TODO

@@ -1 +0,0 @@
-TODO:

data/examples/example_helper.rb

@@ -1,20 +0,0 @@
-lib_path = File.expand_path(File.dirname(__FILE__) + "/../lib")
-$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
-
-require 'beholder'
-require 'rubygems'
-require 'micronaut'
-gem 'rr', '>=0.7.0'
-require 'log_buddy'
-LogBuddy.init
-
-def not_in_editor?
-  ['TM_MODE', 'EMACS', 'VIM'].all? { |k| !ENV.has_key?(k) }
-end
-
-Micronaut.configure do |c|
-  c.formatter = :documentation
-  c.mock_with :rr
-  c.color_enabled = not_in_editor?  
-  c.filter_run :focused => true
-end