guard-rspec 0.6.0 → 0.7.0

data/README.md

@@ -1,19 +1,19 @@
-Guard::RSpec ![travis-ci](http://travis-ci.org/guard/guard-rspec.png)
-=============
+# Guard::RSpec [![Build Status](https://secure.travis-ci.org/guard/guard-rspec.png?branch=master)](http://travis-ci.org/guard/guard-rspec)
 
 RSpec guard allows to automatically & intelligently launch specs when files are modified.
 
-* Compatible with RSpec 1.x & RSpec 2.x (>= 2.4 needed for the notification feature)
-* Tested against Ruby 1.8.7, 1.9.2, REE, JRuby & Rubinius.
+* Compatible with RSpec 1.x & RSpec 2.x (>= 2.4 needed for the notification feature).
+* Tested against Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest versions of JRuby & Rubinius.
 
-Install
--------
+## Install
 
 Please be sure to have [Guard](https://github.com/guard/guard) installed before continue.
 
 Install the gem:
 
-    $ gem install guard-rspec
+```
+$ gem install guard-rspec
+```
 
 Add it to your Gemfile (inside development group):
 
@@ -25,15 +25,15 @@ end
 
 Add guard definition to your Guardfile by running this command:
 
-    $ guard init rspec
+```
+$ guard init rspec
+```
 
-Usage
------
+## Usage
 
 Please read [Guard usage doc](https://github.com/guard/guard#readme)
 
-Guardfile
----------
+## Guardfile
 
 RSpec guard can be really adapted to all kind of projects.
 
@@ -64,8 +64,7 @@ end
 
 Please read [Guard doc](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
 
-Options
--------
+## Options
 
 By default, Guard::RSpec automatically detect your RSpec version (with the `spec_helper.rb` syntax or with Bundler) but you can force the version with the `:version` option:
 
@@ -99,7 +98,7 @@ end
 ```
 
 
-Former `:color`, `:drb`, `:fail_fast` and `:formatter` options are thus deprecated and have no effect anymore.
+Former `:color`, `:drb`, `:fail_fast` and `:formatter` options are deprecated and have no effect anymore.
 
 ### List of available options:
 
@@ -117,6 +116,14 @@ Former `:color`, `:drb`, `:fail_fast` and `:formatter` options are thus deprecat
 :spec_paths => ["spec"]      # specify an array of paths that contain spec files
 ```
 
+### DRb mode
+
+When you specify `--drb` within `:cli`, guard-rspec will circumvent the `rspec` command line tool by
+directly communicating with the RSpec DRb server.  This avoids the extra overhead incurred by your
+shell, bundler and loading RSpec's environment just to send a DRb message.  It shaves off a
+second or two before the specs start to run; they should run almost immediately.
+
+
 Notification
 ------------
 

data/lib/guard/rspec.rb

@@ -6,23 +6,20 @@ module Guard
     autoload :Runner,    'guard/rspec/runner'
     autoload :Inspector, 'guard/rspec/inspector'
 
-    def initialize(watchers=[], options={})
+    def initialize(watchers = [], options = {})
       super
       @options = {
         :all_after_pass => true,
         :all_on_start   => true,
         :keep_failed    => true,
-        :spec_paths     => ["spec"]
-      }.update(options)
+        :spec_paths     => ["spec"],
+        :run_all        => {}
+      }.merge(options)
       @last_failed  = false
       @failed_paths = []
 
-      @runner = Runner.new
-      @inspector = Inspector.new
-
-      @runner.set_rspec_version(options)
-      @inspector.excluded = @options[:exclude]
-      @inspector.spec_paths = @options[:spec_paths]
+      @inspector = Inspector.new(@options)
+      @runner    = Runner.new(@options)
     end
 
     # Call once when guard starts
@@ -32,10 +29,9 @@ module Guard
     end
 
     def run_all
-      passed = @runner.run(options[:spec_paths], options.merge(options[:run_all] || {}).merge(:message => "Running all specs"))
+      passed = @runner.run(@options[:spec_paths], @options[:run_all].merge(:message => 'Running all specs'))
 
-      @last_failed = !passed
-      if passed
+      unless @last_failed = !passed
         @failed_paths = []
       else
         throw :task_has_failed
@@ -49,22 +45,33 @@ module Guard
     def run_on_change(paths)
       paths += @failed_paths if @options[:keep_failed]
       paths  = @inspector.clean(paths)
-      passed = @runner.run(paths, options)
 
-      if passed
-        # clean failed paths memory
-        @failed_paths -= paths if @options[:keep_failed]
-        # run all the specs if the changed specs failed, like autotest
-        run_all if @last_failed && @options[:all_after_pass]
+      if passed = @runner.run(paths)
+        remove_failed(paths)
+
+        # run all the specs if the run before this one failed
+        if @last_failed && @options[:all_after_pass]
+          @last_failed = false
+          run_all
+        end
       else
-        # remember failed paths for the next change
-        @failed_paths += paths if @options[:keep_failed]
-        # track whether the changed specs failed for the next change
         @last_failed = true
+        add_failed(paths)
+
         throw :task_has_failed
       end
     end
 
+  private
+
+    def remove_failed(paths)
+      @failed_paths -= paths if @options[:keep_failed]
+    end
+
+    def add_failed(paths)
+      @failed_paths += paths if @options[:keep_failed]
+    end
+
   end
 end
 

data/lib/guard/rspec/formatter.rb

@@ -37,7 +37,7 @@ module Guard::RSpec::Formatter
 
 private
 
-  def round_float(float, decimals=4)
+  def round_float(float, decimals = 4)
     if Float.instance_method(:round).arity == 0 # Ruby 1.8
       factor = 10**decimals
       (float*factor).round / factor.to_f

data/lib/guard/rspec/inspector.rb

@@ -1,20 +1,26 @@
 module Guard
   class RSpec
     class Inspector
+
+      def initialize(options = {})
+        self.excluded   = options[:exclude]
+        self.spec_paths = options[:spec_paths]
+      end
+
       def excluded
         @excluded || []
       end
 
-      def excluded=(glob)
-        @excluded = Dir[glob.to_s]
+      def excluded=(pattern)
+        @excluded = Dir[pattern.to_s]
       end
 
       def spec_paths
         @spec_paths || []
       end
 
-      def spec_paths=(path_array)
-        @spec_paths = Array(path_array)
+      def spec_paths=(paths)
+        @spec_paths = Array(paths)
       end
 
       def clean(paths)
@@ -42,15 +48,14 @@ module Guard
 
       def spec_folder?(path)
         path.match(%r{^(#{spec_paths.join("|")})[^\.]*$})
-        # path.match(%r{^spec[^\.]*$})
       end
 
       def spec_files
-        @spec_files ||= spec_paths.collect { |path| Dir[File.join(path, "**", "*_spec.rb")] }.flatten
+        @spec_files ||= spec_paths.collect { |path| Dir[File.join(path, "**{,/*/**}", "*_spec.rb")] }.flatten
       end
 
       def feature_files
-        @feature_files ||= spec_paths.collect { |path| Dir[File.join(path, "**", "*.feature")] }.flatten
+        @feature_files ||= spec_paths.collect { |path| Dir[File.join(path, "**{,/*/**}", "*.feature")] }.flatten
       end
 
       def clear_spec_files_list_after

data/lib/guard/rspec/runner.rb

@@ -3,104 +3,202 @@ module Guard
     class Runner
       attr_reader :rspec_version
 
-      def run(paths, options={})
+      FAILURE_EXIT_CODE = 2
+
+      def initialize(options = {})
+        @options = {
+          :bundler      => true,
+          :binstubs     => false,
+          :rvm          => nil,
+          :cli          => nil,
+          :notification => true
+        }.merge(options)
+
+        deprecations_warnings
+      end
+
+      def run(paths, options = {})
         return false if paths.empty?
+
         message = options[:message] || "Running: #{paths.join(' ')}"
         UI.info(message, :reset => true)
-        system(rspec_command(paths, options))
 
-        if options[:notification] != false && !drb?(options) && failure_exit_code_supported?(options) && $? && !$?.success? && $?.exitstatus != failure_exit_code
-          Notifier.notify("Failed", :title => "RSpec results", :image => :failed, :priority => 2)
+        options = @options.merge(options)
+
+        if drb_used?
+          run_via_drb(paths, options)
+        else
+          run_via_shell(paths, options)
         end
+      end
+
+      def rspec_version
+        @rspec_version ||= @options[:version] || determine_rspec_version
+      end
 
-        $?.success?
+      def rspec_executable
+        @rspec_executable ||= begin
+          exec = rspec_class.downcase
+          binstubs? ? "bin/#{exec}" : exec
+        end
       end
 
-      def set_rspec_version(options={})
-        @rspec_version = options[:version] || determine_rspec_version
+      def failure_exit_code_supported?
+        @failure_exit_code_supported ||= begin
+          cmd_parts = []
+          cmd_parts << "bundle exec" if bundler?
+          cmd_parts << rspec_executable
+          cmd_parts << "--help"
+          `#{cmd_parts.join(' ')}`.include? "--failure-exit-code"
+        end
+      end
+
+      def rspec_class
+        @rspec_class ||= case rspec_version
+                         when 1
+                           "Spec"
+                         when 2
+                           "RSpec"
+                         end
       end
 
     private
 
-      def rspec_command(paths, options={})
-        warn_deprectation(options)
+      def rspec_arguments(paths, options)
+        arg_parts = []
+        arg_parts << options[:cli]
+        arg_parts << "-f progress" if !options[:cli] || options[:cli].split(/[\s=]/).none? { |w| %w[-f --format].include?(w) }
+        if @options[:notification]
+          arg_parts << "-r #{File.dirname(__FILE__)}/formatters/notification_#{rspec_class.downcase}.rb"
+          arg_parts << "-f Guard::RSpec::Formatter::Notification#{rspec_class}#{rspec_version == 1 ? ":" : " --out "}/dev/null"
+        end
+        arg_parts << "--failure-exit-code #{FAILURE_EXIT_CODE}" if failure_exit_code_supported?
+        arg_parts << paths.join(' ')
+
+        arg_parts.compact.join(' ')
+      end
 
+      def rspec_command(paths, options)
         cmd_parts = []
-        cmd_parts << "rvm #{options[:rvm].join(',')} exec" if options[:rvm].is_a?(Array)
-        cmd_parts << "bundle exec" if (bundler? && options[:binstubs] == true && options[:bundler] != false) || (bundler? && options[:bundler] != false)
-        cmd_parts << rspec_exec(options)
-        cmd_parts << options[:cli] if options[:cli]
-        cmd_parts << "-f progress" if options[:cli].nil? || !options[:cli].split(/[\s=]/).any? { |w| %w[-f --format].include?(w) }
-        cmd_parts << "-r #{File.dirname(__FILE__)}/formatters/notification_#{rspec_class.downcase}.rb -f Guard::RSpec::Formatter::Notification#{rspec_class}#{rspec_version == 1 ? ":" : " --out "}/dev/null" if options[:notification] != false
-        cmd_parts << "--failure-exit-code #{failure_exit_code}" if failure_exit_code_supported?(options)
-        cmd_parts << paths.join(' ')
+        cmd_parts << "rvm #{@options[:rvm].join(',')} exec" if @options[:rvm].respond_to?(:join)
+        cmd_parts << "bundle exec" if bundler?
+        cmd_parts << rspec_executable
+        cmd_parts << rspec_arguments(paths, options)
 
-        cmd_parts.join(' ')
+        cmd_parts.compact.join(' ')
       end
 
-      def drb?(options)
-        !options[:cli].nil? && options[:cli].include?('--drb')
+      def run_via_shell(paths, options)
+        success = system(rspec_command(paths, options))
+
+        if @options[:notification] && !drb_used? && !success && rspec_command_exited_with_an_exception?
+          Notifier.notify("Failed", :title => "RSpec results", :image => :failed, :priority => 2)
+        end
+
+        success
       end
 
-      def bundler?
-        @bundler ||= File.exist?("#{Dir.pwd}/Gemfile")
+      def rspec_command_exited_with_an_exception?
+        failure_exit_code_supported? && $?.exitstatus != FAILURE_EXIT_CODE
       end
 
-      def failure_exit_code_supported?(options={})
-        return @failure_exit_code_supported if defined?(@failure_exit_code_supported)
-        @failure_exit_code_supported ||= begin
-          cmd_parts = []
-          cmd_parts << "bundle exec" if (bundler? && options[:bundler].is_a?(TrueClass)) || (bundler? && options[:binstubs].is_a?(TrueClass))
-          ( saved = true; options[:binstubs] = false ) if options[:binstubs].is_a?(TrueClass) # failure exit code support is independent of rspec location
-          cmd_parts << rspec_exec(options)
-          options[:binstubs] = true if saved
-          cmd_parts << "--help"
-          `#{cmd_parts.join(' ')}`.include? "--failure-exit-code"
+      # We can optimize this path by hitting up the drb server directly, circumventing the overhead
+      # of the user's shell, bundler and ruby environment.
+      def run_via_drb(paths, options)
+        require "shellwords"
+        argv = rspec_arguments(paths, options).shellsplit
+
+        # The user can specify --drb-port for rspec, we need to honor it.
+        if idx = argv.index("--drb-port")
+          port = argv[idx + 1].to_i
         end
+        port = ENV["RSPEC_DRB"] || 8989 unless port && port > 0
+
+        ret = drb_service(port.to_i).run(argv, $stderr, $stdout)
+        ret == 0
+      rescue DRb::DRbConnError
+        # Fall back to the shell runner; we don't want to mangle the environment!
+        run_via_shell(paths, options)
       end
 
-      def failure_exit_code
-        2
+      def drb_used?
+        if @drb_used.nil?
+          @drb_used = @options[:cli] && @options[:cli].include?('--drb')
+        else
+          @drb_used
+        end
       end
 
-      def determine_rspec_version
-        if File.exist?("#{Dir.pwd}/spec/spec_helper.rb")
-          File.new("#{Dir.pwd}/spec/spec_helper.rb").read.include?("Spec::Runner") ? 1 : 2
-        elsif bundler?
-          # Allow RSpactor to be tested with RSpactor (bundle show inside a bundle exec)
-          ENV['BUNDLE_GEMFILE'] = "#{Dir.pwd}/Gemfile"
-          `bundle show rspec`.include?("/rspec-1.") ? 1 : 2
+      # RSpec 1 & 2 use the same DRb call signature, and we can avoid loading a large chunk of rspec
+      # just to let DRb know what to do.
+      #
+      # For reference:
+      #
+      # * RSpec 1: https://github.com/myronmarston/rspec-1/blob/master/lib/spec/runner/drb_command_line.rb
+      # * RSpec 2: https://github.com/rspec/rspec-core/blob/master/lib/rspec/core/drb_command_line.rb
+      def drb_service(port)
+        require "drb/drb"
+
+        # Make sure we have a listener running
+        unless @drb_listener_running
+          begin
+            DRb.start_service("druby://localhost:0")
+          rescue SocketError, Errno::EADDRNOTAVAIL
+            DRb.start_service("druby://:0")
+          end
+
+          @drb_listener_running = true
+        end
+
+        @drb_services ||= {}
+        @drb_services[port.to_i] ||= DRbObject.new_with_uri("druby://127.0.0.1:#{port}")
+      end
+
+      def bundler_allowed?
+        if @bundler_allowed.nil?
+          @bundler_allowed = File.exist?("#{Dir.pwd}/Gemfile")
         else
-          2
+          @bundler_allowed
         end
       end
 
-      def rspec_class
-        case rspec_version
-        when 1
-          "Spec"
-        when 2
-          "RSpec"
+      def bundler?
+        if @bundler.nil?
+          @bundler = bundler_allowed? && @options[:bundler]
+        else
+          @bundler
         end
       end
 
-      def rspec_exec(options = {})
-        case rspec_version
-        when 1
-          options[:binstubs] == true && options[:bundler] != false ? "bin/spec" : "spec"
-        when 2
-          options[:binstubs] == true && options[:bundler] != false ? "bin/rspec" : "rspec"
+      def binstubs?
+        if @binstubs.nil?
+          @binstubs = bundler? && @options[:binstubs]
+        else
+          @binstubs
         end
       end
 
-      def warn_deprectation(options={})
-        [:color, :drb, :fail_fast, [:formatter, "format"]].each do |option|
-          key, value = option.is_a?(Array) ? option : [option, option.to_s.gsub('_', '-')]
-          if options.key?(key)
+      def determine_rspec_version
+        if File.exist?("#{Dir.pwd}/spec/spec_helper.rb")
+          File.new("#{Dir.pwd}/spec/spec_helper.rb").read.include?("Spec::Runner") ? 1 : 2
+        elsif bundler_allowed?
+          ENV['BUNDLE_GEMFILE'] = "#{Dir.pwd}/Gemfile"
+          `bundle show rspec`.include?("/rspec-1.") ? 1 : 2
+        else
+          2
+        end
+      end
+
+      def deprecations_warnings
+        [:color, :drb, [:fail_fast, "fail-fast"], [:formatter, "format"]].each do |option|
+          key, value = option.is_a?(Array) ? option : [option, option.to_s]
+          if @options.key?(key)
+            @options.delete(key)
             UI.info %{DEPRECATION WARNING: The :#{key} option is deprecated. Pass standard command line argument "--#{value}" to RSpec with the :cli option.}
           end
         end
       end
+
     end
   end
 end

data/lib/guard/rspec/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module RSpecVersion
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-rspec
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000 Z
+date: 2012-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70106639786600 !ruby/object:Gem::Requirement
+  requirement: &70179267450520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70106639786600
+  version_requirements: *70179267450520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70106639786020 !ruby/object:Gem::Requirement
+  requirement: &70179267449820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70106639786020
+  version_requirements: *70179267449820
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70106639811000 !ruby/object:Gem::Requirement
+  requirement: &70179267449300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70106639811000
+  version_requirements: *70179267449300
 description: Guard::RSpec automatically run your specs (much like autotest).
 email:
 - thibaud@thibaud.me
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: guard-rspec
-rubygems_version: 1.8.12
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Guard gem for RSpec