marcinbunsch-bolt 0.2.6 → 0.2.7

data/lib/bolt.rb

@@ -23,19 +23,25 @@ module Bolt
   # read the .bolt file for configuration
   def self.read_dotfile
     if File.exists?('.bolt')
-      $stdout.puts "** Found .bolt file" if Bolt['verbose']
-      read = YAML.load_file('.bolt')
-      @@config.merge!(read) if read
+      parsed_dotfile = YAML.load_file('.bolt')
+      @@config.merge!(parsed_dotfile) if parsed_dotfile
+      $stdout.puts "** Found .bolt file" if Bolt.verbose?
     end
   end
   
   # read the arguments passed in cli
   def self.read_argv
     ARGV.each do |arg|
-      self['verbose'] = true if arg == '-v'
+      @@config['verbose'] = true if arg == '-v'
     end
   end
   
+  # check for verbose execution
+  def self.verbose?
+    @@config['verbose'] || false
+  end
+  
+  # start bolt
   def self.start
     $stdout.puts "** Starting Bolt..."
     

data/lib/bolt/adapters/rails.rb

@@ -1,6 +1,6 @@
-module Bolt
-  module Adapters
-    module Rails
+module Bolt #:nodoc:    
+  module Adapters #:nodoc:    
+    module Rails #:nodoc:    
     end
   end
 end
@@ -10,9 +10,9 @@ ENV['RAILS_ENV'] = 'test'
 require 'config/environment.rb'
 
 # This is a hack for Rails Test::Unit to prevent raising errors when a test file is loaded again
-module ActiveSupport
-  module Testing
-    module Declarative
+module ActiveSupport #:nodoc:    
+  module Testing #:nodoc:    
+    module Declarative #:nodoc:    
       # test "verify something" do
       #   ...
       # end
@@ -35,7 +35,7 @@ end
 # These hacks disable caching in views
 module ActionView #:nodoc:
   class PathSet #:nodoc:    
-    class Path
+    class Path #:nodoc:    
       def eager_load_templates?
         false
       end
@@ -45,8 +45,8 @@ end
 
 # disable the class check in initialize for path
 module ActionView #:nodoc:
-  class Template
-    class Path
+  class Template #:nodoc:    
+    class Path #:nodoc:    
       def initialize(path)
         # raise ArgumentError, "path already is a Path class" if path.is_a?(Path)
         @path = path.freeze
@@ -70,10 +70,10 @@ end
 
 # Rails < 2.3.0
 if Rails::VERSION::STRING =~ /^2\.3\.0/ || Rails::VERSION::STRING =~ /^2\.[0-2]\.[0-9]/
-  module ActionView
+  module ActionView #:nodoc:    
     # NOTE: The template that this mixin is being included into is frozen
     # so you cannot set or modify any instance variables
-    module Renderable
+    module Renderable #:nodoc:    
       private
         def recompile?(path)
           true
@@ -84,7 +84,7 @@ if Rails::VERSION::STRING =~ /^2\.3\.0/ || Rails::VERSION::STRING =~ /^2\.[0-2]\
   module ActionView #:nodoc:
     class PathSet #:nodoc:    
        
-       class Path
+       class Path #:nodoc:    
          
          # make it always return a refreshed template!
          def [](template_path)

data/lib/bolt/listener.rb

@@ -14,7 +14,7 @@ module Bolt
       # find appropriate listener
       listener
       
-      $stdout.puts "** Using #{listener.class} " if Bolt['verbose']
+      $stdout.puts "** Using #{listener.class} " if Bolt.verbose?
       
       # trap the INT signal 
       add_sigint_handler
@@ -59,11 +59,11 @@ module Bolt
       if Bolt['listener'] and ['generic', 'osx'].include?(Bolt['listener'])
         self.selected= Bolt::Listeners::Generic.new if Bolt['listener'] == 'generic'
         self.selected= Bolt::Listeners::Osx.new if Bolt['listener'] == 'osx'
-        $stdout.puts "** Found listener setting in .bolt" if Bolt['verbose']
+        $stdout.puts "** Found listener setting in .bolt" if Bolt.verbose?
         return self.selected
       end
         
-      $stdout.puts "** Determining listener..." if Bolt['verbose']
+      $stdout.puts "** Determining listener..." if Bolt.verbose?
       
       # TODO: os identification via RUBY_PLATFORM is flawed as it will return 'java' in jruby. Look for a different solution
       os_string = RUBY_PLATFORM.downcase

data/lib/bolt/listeners/generic.rb

@@ -9,19 +9,22 @@ module Bolt
     class Generic
       attr_accessor :files, :interval, :busy, :notifier, :parent, :mappings
       
+      # constructor
       def initialize
         self.interval = 1 # decrease the CPU load by increasing the interval
         self.busy     = false
       end 
       
+      # find files and start the listener
       def start
-        puts "** #{self.class} is scanning for files... " if Bolt['verbose']
+        puts "** #{self.class} is scanning for files... " if Bolt.verbose?
         # build a file collection
         find_files
         puts "** #{self.class} watching #{files.size} files... "
         wait  
       end
       
+      # wait for a specified interval and check files for changes
       # source: ZenTest/autotest.rb
       def wait
         Kernel.sleep self.interval until check_files
@@ -32,12 +35,20 @@ module Bolt
         return if busy # if working on something already, skip the iteration
         updated = []
         files.each do |filename, mtime| 
-          current_mtime = File.stat(filename).mtime
+          begin
+            current_mtime = File.stat(filename).mtime
+          rescue Errno::ENOENT
+            # file was not found and was probably deleted
+            # remove the file from the file list 
+            files.delete(filename)
+            puts "=> ERROR: #{filename} not found, ignoring" if Bolt.verbose?
+            next
+          end
           if current_mtime != mtime  
             updated << filename
             # update the mtime in file registry so we it's only send once
             files[filename] = current_mtime
-            $stdout.puts ">> Spotted change in #{filename}" if Bolt['verbose']
+            $stdout.puts ">> Spotted change in #{filename}" if Bolt.verbose?
           end
         end
         parent.handle(updated) if updated != []
@@ -55,15 +66,15 @@ module Bolt
         targets.each do |target|
           order = []
           Find.find(target) do |f|
-            
             in_mappings = f =~ self.mappings
             next if in_mappings.nil?
             next if test ?d, f
             next if f =~ /(swp|~|rej|orig)$/ # temporary/patch files
-            next if f =~ /\/\.?#/            # Emacs autosave/cvs merge files
+            next if f =~ /(\.svn|\.git)$/ # subversion/git
+            next if f =~ /\/\.?#/ # Emacs autosave/cvs merge files
 
             filename = f.sub(/^\.\//, '')
-            
+
             result[filename] = File.stat(filename).mtime rescue next
           end
         end

data/lib/bolt/notifier.rb

@@ -9,26 +9,25 @@ module Bolt
     
     # Constructor
     def initialize 
-      # find appropriate notifier
+      # find an appropriate notifier
       notifier
       # present
-      $stdout.puts "** Using #{notifier.class} \n" if Bolt['verbose']
+      $stdout.puts "** Using #{notifier.class} \n" if Bolt.verbose?
     end
 
-    # Pick a listener to launch
+    # Pick a notifier to launch
     def notifier
       return selected if selected
       
-
       if Bolt['notifier'] and ['generic', 'growl'].include?(Bolt['notifier'])
         self.selected= Bolt::Notifiers::Growl.new if Bolt['notifier'] == 'growl'
         self.selected= Bolt::Notifiers::Generic.new if Bolt['notifier'] == 'generic'
         self.selected= Bolt::Notifiers::NotifyOsd.new if Bolt['notifier'] == 'notify_send'
-        $stdout.puts "** Found 'notifier' setting in .bolt" if Bolt['verbose']
+        $stdout.puts "** Found 'notifier' setting in .bolt" if Bolt.verbose?
         return self.selected
       end
       
-      $stdout.puts "** Determining notifier... \n" if Bolt['verbose']
+      $stdout.puts "** Determining notifier... \n" if Bolt.verbose?
       
       # default - growl (if growlnotify is present)
       output = %x[which growlnotify]

data/lib/bolt/runner.rb

@@ -12,7 +12,7 @@ module Bolt
       # find appropriate runner
       runner
       
-      $stdout.puts "** Using #{selected.class} \n" if Bolt['verbose']
+      $stdout.puts "** Using #{selected.class} \n" if Bolt.verbose?
     end
     
     # Pick a listener to launch
@@ -23,10 +23,10 @@ module Bolt
         self.selected= Bolt::Runners::TestUnit.new if Bolt['runner'] == 'test_unit'
         self.selected= Bolt::Runners::RSpec.new if Bolt['runner'] == 'rspec'
         self.selected= Bolt::Runners::Cucumber.new if Bolt['runner'] == 'cucumber'
-        $stdout.puts "** Found 'runner' setting in .bolt" if Bolt['verbose']
+        $stdout.puts "** Found 'runner' setting in .bolt" if Bolt.verbose?
         return self.selected
       end
-      $stdout.puts "** Determining runner... \n" if Bolt['verbose']
+      $stdout.puts "** Determining runner... \n" if Bolt.verbose?
       self.selected= Bolt::Runners::TestUnit.new
       self.selected= Bolt::Runners::RSpec.new  if File.directory?('spec')
       self.selected

data/lib/bolt/runners/base.rb

@@ -24,7 +24,7 @@ module Bolt
         
         reload filename
         
-        puts "=> #{self.class} running test for #{filename}" if Bolt['verbose']
+        puts "=> #{self.class} running test for #{filename}" if Bolt.verbose?
         test_files = translate(filename)
         
         return if test_files == []

data/lib/bolt/runners/cucumber.rb

@@ -18,20 +18,24 @@ module Bolt
       # step mother storage
       @@mother = nil
       
+      # Save a reference for supplied StepMother 
       def self.mother=(step_mother)
         @@mother = step_mother
       end
       
+      # Get the referenced StepMother
       def self.mother
         @@mother
       end
       
+      # Create a new Cucumber Runner
       def initialize
         self.controllers = {}
         self.models = {}
         read_map
       end
       
+      # Read the feature map located in .bolt file
       def read_map
         if !Bolt['feature_map']
           puts "** ERROR: could not find feature_map in .bolt"
@@ -66,7 +70,11 @@ module Bolt
         end
         
       end
-      # mapping is a copied and modified version of mislav/rspactor Inspector#translate
+      
+      # Translate a filename into an array of feature filenames
+      # 
+      # This is a modified version of mislav/rspactor Inspector#translate
+      #
       def translate(file)
         self.heard = file
                 
@@ -97,7 +105,8 @@ module Bolt
 
       end
       
-      def run(files)
+      # Run an array of feature files
+      def run(features)
                 
         # redirect spec output to StringIO
         io = StringIO.new
@@ -109,7 +118,7 @@ module Bolt
 
         Bolt::Runners::Cucumber.mother.reload_definitions! if Bolt::Runners::Cucumber.mother and self.heard.match('_steps.rb')
         
-        ::Cucumber::Cli::Main.execute(files)
+        ::Cucumber::Cli::Main.execute(features)
 
         Bolt::Runners::Cucumber.mother.clear_steps_and_scenarios!
         # read the buffer
@@ -124,7 +133,7 @@ module Bolt
         last_three = last_three.gsub("\e[32m", '').gsub("\e[0m", '').gsub("\e[36m", '').gsub("\e[31m", '') # get ri of the color codes
         
         # sent result to notifier
-        notifier.result(files.join(' '), last_three)
+        notifier.result(features.join(' '), last_three)
         
       end
       
@@ -133,13 +142,20 @@ module Bolt
 end
 
 # Cucumber hacks
+
+# Load Cucumber requirements
 require 'cucumber'
-require 'cucumber/rspec_neuter'
+begin
+  require 'cucumber/rspec_neuter'
+rescue LoadError
+  puts '** ERROR: Could not load cucumber/rspec_neuter' if Bolt.verbose?
+end
 require 'cucumber/cli/main'
 
-module Cucumber
-  module StepMother
+module Cucumber #:nodoc:
+  module StepMother #:nodoc:
     
+    # Clear the step definitions and reload them
     def reload_definitions!
       step_definitions.clear
       Dir['features/step_definitions/*'].map do |f| 
@@ -148,15 +164,17 @@ module Cucumber
       end
     end
     
+    # Clear the steps and scenarios to always start fresh
     def clear_steps_and_scenarios!
       steps.clear
       scenarios.clear
     end  
   end
   
-  module Cli
-    class Main
+  module Cli #:nodoc:
+    class Main #:nodoc:
 
+      # Overwritten execute to create a reference for StepMother
       def self.execute(args)
         instance = new(args)
         instance.execute!(@step_mother)

data/lib/bolt/runners/test_unit.rb

@@ -35,7 +35,10 @@ module Bolt
         Thread.current["test_runner_io"] = io
       end
     
-      # mapping is a copied and modified version of mislav/rspactor Inspector#translate
+      # Translate a filename into a test filename
+      # 
+      # This is a copied and modified version of mislav/rspactor Inspector#translate
+      #
       def translate(file)
         
         basename = File.basename(file)
@@ -67,12 +70,13 @@ module Bolt
           candidates << test_filename
         end
         if candidates == []
-          puts "=> NOTICE: could not find test file for: #{file}" if Bolt['verbose']
+          puts "=> NOTICE: could not find test file for: #{file}" if Bolt.verbose?
         end
         # puts candidates.inspect
         candidates
       end
       
+      # Run the supplied files (tests)
       def run(files)
         file = files.first
         puts "** Running #{file}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marcinbunsch-bolt
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors: 
 - Marcin Bunsch