guard-rspec 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1dc600657deb79e8869f2128d794a1c3324c665
-  data.tar.gz: 32efeed7f726f7d57dd4a2da8fca8192305b69ce
+  metadata.gz: 72a879771ebb51c3975137af34723ce17a908abe
+  data.tar.gz: e6f562c2149e0d7a7312831a706565be60bdc018
 SHA512:
-  metadata.gz: 6e600eccab4db141d8d50c5b8df3ae5fd2c01c0cbb5e5208fdeb6c6b03e59d61826c1b96fc905c2eee92e28ba0fa8b5ecc10365927cd9cd4fa0fc92b4405e557
-  data.tar.gz: a72d49552ebe12e9b85b8121ea4de2a9bd6ebb24fc3ce960a953e0a9789cea684ae3f75a9f7e2043d82dd49af31f7824013f414e7c45fe4c3f2f9c57f44a1a7d
+  metadata.gz: ea1fd12cd64193718d5be568ff09ede36a6dafadf4f30a3bfa3050842aa73b1e0ccdc036985a513c0a6898328d0fcf28b997ce84423efba52180cef5e5ddb095
+  data.tar.gz: ce1aa592392b715825347bbcc3c95c85eb3e795488c3aeb37f650583524a3784fd8a127e3a09bd31b100058a88d431f7c26c3d31d37fa8bd49c515defa7e1e38

data/.gitignore

@@ -0,0 +1,8 @@
+pkg/*
+*.gem
+.bundle
+.DS_Store
+.rvmrc
+.rbx/*
+Gemfile.lock
+coverage/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+bundler_args: --without tool
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+Contribute to Guard::RSpec
+==========================
+
+File an issue
+-------------
+
+You can report bugs and feature requests to [GitHub Issues](https://github.com/guard/guard-rspec/issues).
+
+**Please don't ask question in the issue tracker**, instead ask them on at Stack Overflow and use the
+[guard](http://stackoverflow.com/questions/tagged/guard) tag and/or [guard-rspec](http://stackoverflow.com/questions/tagged/guard-rspec).
+
+Try to figure out where the issue belongs to: Is it an issue with Guard::RSpec itself or with Guard?
+
+When you file a bug, please try to follow these simple rules if applicable:
+
+* Make sure you've read the README carefully.
+* Make sure you run Guard with `bundle exec` first.
+* Add debug information to the issue by running Guard with the `--debug` option.
+* Add your `Guardfile` and `Gemfile` to the issue.
+* Make sure that the issue is reproducible with your description.
+
+**It's most likely that your bug gets resolved faster if you provide as much information as possible!**
+
+Development
+-----------
+
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard-rspec/master/frames).
+* Source hosted at [GitHub](https://github.com/guard/guard-rspec).
+
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
+
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested. All specs run with `rake spec:portability` must pass.
+* Update the [README](https://github.com/guard/guard-rspec/blob/master/README.md).
+* Please **do not change** the version number.
+
+For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'coveralls', require: false
+end
+
+group :tool do
+  gem 'ruby_gntp', require: false
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/{LICENSE → LICENSE.txt}

@@ -1,5 +1,7 @@
 Copyright (c) 2010-2013 Thibaud Guillaume-Gentil
 
+MIT License
+
 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

data/README.md

@@ -1,27 +1,18 @@
 # Guard::RSpec
+
 [![Gem Version](https://badge.fury.io/rb/guard-rspec.png)](http://badge.fury.io/rb/guard-rspec) [![Build Status](https://secure.travis-ci.org/guard/guard-rspec.png?branch=master)](http://travis-ci.org/guard/guard-rspec) [![Dependency Status](https://gemnasium.com/guard/guard-rspec.png)](https://gemnasium.com/guard/guard-rspec) [![Code Climate](https://codeclimate.com/github/guard/guard-rspec.png)](https://codeclimate.com/github/guard/guard-rspec) [![Coverage Status](https://coveralls.io/repos/guard/guard-rspec/badge.png?branch=master)](https://coveralls.io/r/guard/guard-rspec)
 
-RSpec guard allows to automatically & intelligently launch specs when files are modified.
+Guard::RSpec allows to automatically & intelligently launch specs when files are modified.
 
-* Compatible with RSpec >= 2.13 (use guard-rspec 1.2.x for older release, including RSpec 1.x)
-* Tested against Ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0, Ruby head, REE, JRuby (1.8 mode, 1.9 mode & head) & Rubinius (1.8 mode, 1.9 mode & head).
+* Compatible with RSpec ~> 2.14
+* Tested against Ruby 1.9.3, 2.0.0, JRuby and Rubinius.
 
 ## Install
 
-Please be sure to have [Guard](https://github.com/guard/guard) installed before continuing.
-
-Install the gem:
-
-```
-$ gem install guard-rspec
-```
-
-Add it to your Gemfile (inside development group):
+Add the gem to your Gemfile (inside development group):
 
 ``` ruby
-group :development do
-  gem 'guard-rspec'
-end
+ gem 'guard-rspec', require: false
 ```
 
 Add guard definition to your Guardfile by running this command:
@@ -36,7 +27,7 @@ Please read [Guard usage doc](https://github.com/guard/guard#readme).
 
 ## Guardfile
 
-RSpec guard can be adapted to all kinds of projects.
+Guard::RSpec can be adapted to all kinds of projects, some examples:
 
 ### Standard RubyGem project
 
@@ -62,157 +53,44 @@ guard :rspec do
   watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
 end
 ```
+
 Please read [Guard doc](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
 
 ## Options
 
-You can pass any of the standard RSpec CLI options using the `:cli` option:
-
-``` ruby
-guard 'rspec', :cli => "--color --format nested --fail-fast --drb" do
-  # ...
-end
-```
-
-By default, Guard::RSpec will only look for spec files within `spec` in your project root. You can configure Guard::RSpec to look in additional paths by using the `:spec_paths` option:
-
-``` ruby
-guard 'rspec', :spec_paths => ["spec", "vendor/engines/reset/spec"] do
-  # ...
-end
-```
-If you have only one path to look in, you can configure the `:spec_paths` option with a string:
-
-``` ruby
-guard 'rspec', :spec_paths => "test" do
-  # ...
-end
-```
-If you want to set an environment variable, you can configure the `:env` option with a hash:
+Guard::RSpec 4.0 use now a more simple approach with the new `cmd` option that let you precisely define which rspec command will be launched on each run. As example if you want to support Spring with a custom formatter (progress by default) use:
 
 ``` ruby
-guard 'rspec', :env => {'RAILS_ENV' => 'guard'} do
-  # ...
-end
-```
-[Turnip](https://github.com/jnicklas/turnip) is supported (Ruby 1.9.X only), but you must enable it:
-``` ruby
-guard 'rspec', :turnip => true do
-  # ...
-end
-```
-[Spring](https://github.com/jonleighton/spring) is supported (Ruby 1.9.X / Rails 3.2+ only), but you must enable it:
-``` ruby
-guard 'rspec', :spring => true do
-  # ...
-end
-```
-[ParallelTests](https://github.com/grosser/parallel_tests) is supported, but you must enable it:
-``` ruby
-guard 'rspec', :parallel => true, :parallel_cli => '-n 2' do
+guard :rspec, cdm: 'spring rspec -f doc' do
   # ...
 end
 ```
-[Foreman](https://github.com/ddollar/foreman) is supported, but you must enable it:
-``` ruby
-guard 'rspec', :foreman => true do
-  # ...
-end
-```
-
-Former `:color`, `:drb`, `:fail_fast` and `:formatter` options are deprecated and no longer have effect.
 
 ### List of available options:
 
 ``` ruby
-:cli => "-c -f doc"          # pass arbitrary RSpec CLI arguments, default: "-f progress"
-:bundler => false            # use "bundle exec" to run the RSpec command, default: true
-:binstubs => true            # use "bin/rspec" to run the RSpec command (takes precedence over :bundle), default: false
-:rvm => ['1.8.7', '1.9.2']   # directly run your specs on multiple Rubies, default: nil
-:notification => false       # display Growl (or Libnotify) notification after the specs are done running, default: true
-:all_after_pass => true     # run all specs after changed specs pass, default: false
-:all_on_start => true       # run all the specs at startup, default: false
-:keep_failed => true        # keep failed specs until they pass, default: false
-:run_all => { :cli => "-p", :parallel => true, :parallel_cli => '-n 2' } # cli arguments to use when running all specs, default: same as :cli; parallel_rspec arguments, default:  same as :parallel_cli
-:spec_paths => ["spec"]      # specify an array of paths that contain spec files
-:exclude => "spec/foo/**/*"  # exclude files based on glob
-:spring => true              # enable spring support; default: false
-:turnip => true              # enable turnip support; default: false
-:zeus => true                # enable zeus support; default: false
-:foreman => true             # enable foreman support; default: false
-:focus_on_failed => false    # focus on the first 10 failed specs first, rerun till they pass
-:parallel => true            # run all specs in parallel using [ParallelTests](https://github.com/grosser/parallel_tests) gem, default: false
-:parallel_cli => "-n 2"      # pass arbitrary Parallel Tests arguments, default: ""
-:launchy => nil              # pass a path to an rspec results file, e.g. ./tmp/spec_results.html
+cmd: 'zeus rspec'      # specify a custom rpsec command to run, default: 'rspec'
+spec_paths: ['spec']   # specify a custom array of paths that contain spec files
+focus_on_failed: false # focus on the first 10 failed specs, rerun till they pass, default: true
+keep_failed: true      # keep failed specs until they pass (add them to new ones), default: false
+all_after_pass: true   # run all specs after changed specs pass, default: false
+all_on_start: true     # run all the specs at startup, default: false
+launchy: nil           # pass a path to an rspec results file, e.g. ./tmp/spec_results.html
+notification: false    # display notification after the specs are done running, default: true
+run_all: { cmd: 'custom rspec command', message: 'custom message' } # Custom options to use when running all specs.
 ```
 
-You can also use a custom binstubs directory using `:binstubs => 'some-dir'`.
-
 ### Using Launchy to view rspec results
-guard-rspec can be configured to launch a results file in lieu of outputing rspec results to the terminal.
-Configure your Guardfile with the launchy option
-``` ruby
-guard 'rspec', :cli=>'--color --format html --out ./tmp/spec_results.html' do
-  :launchy => "./tmp/spec_results.html"
-  # ...
-end
-```
-
-### 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
-
-The notification feature is only available for RSpec < 2, and RSpec >= 2.4 (due to the multiple-formatters feature that was present in RSpec 1, was removed in RSpec 2 and reintroduced in RSpec 2.4). So if you are using a version between 2 and 2.4, you should disable the notification with <tt>:notification => false</tt>. Otherwise, nothing will be displayed in the terminal when your specs will run.
 
-Note that setting the environment variable `SPEC_OPTS` can cause notifications to fail.
-
-The best solution is still to update RSpec to the latest version!
-
-## Formatters
-
-The `:formatter` option has been removed since CLI arguments can be passed through the `:cli` option. If you want to use the former Instafail formatter, you need to use the [rspec-instafail](http://rubygems.org/gems/rspec-instafail) gem instead:
+guard-rspec can be configured to launch a results file in lieu of outputing rspec results to the terminal.
+Configure your Guardfile with the launchy option:
 
 ``` ruby
-# in your Gemfile
-gem 'rspec-instafail'
-
-# in your Guardfile
-guard 'rspec', :cli => '-r rspec/instafail -f RSpec::Instafail' do
+guard :rspec, cmd: 'rspec -f html -o ./tmp/spec_results.html', launchy: './tmp/spec_results.html' do
   # ...
 end
 ```
 
-Default formatter is the `progress` formatter (same as RSpec default).
-
-## Running a subset of all specs
-
-The `:all_on_start` and `:all_after_pass` options cause all specs located in the `spec` directory to be run. If there
-are some specs you want to skip, you can tag them with RSpec metadata (such as `:slow => true`)
-and skip them with the cli `--tag` option (i.e. `--tag ~slow`).
-
-You can also use option :spec_paths to override paths used when running all specs.
-You can use this feature to create multiple groups of guarded specs with distinct paths, and execute each in its own process:
-
-``` ruby
-# in your Guardfile
-group 'acceptance-tests' do
-  guard 'rspec', :spec_paths => ['spec/acceptance'] do
-    # ...
-  end
-end
-
-group 'unit-tests' do
-  guard 'rspec', :spec_paths => ['spec/models', 'spec/controllers', 'spec/routing'] do
-    # ...
-  end
-end
-```
-
 ## Development
 
 * Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard-rspec/master/frames).
@@ -228,13 +106,9 @@ Pull requests are very welcome! Please try to follow these simple rules if appli
 For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
 `#guard` (irc.freenode.net).
 
-### Testing
-
-Please run `rake spec:prepare_fixtures` once before launching specs.
-
 ### Author
 
-[Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](http://twitter.com/thibaudgg))
+[Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg))
 
 ### Contributors
 

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/guard-rspec.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/rspec/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'guard-rspec'
+  s.version     = Guard::RSpecVersion::VERSION
+  s.author      = 'Thibaud Guillaume-Gentil'
+  s.email       = 'thibaud@thibaud.me'
+  s.summary     = 'Guard gem for RSpec'
+  s.description = 'Guard::RSpec automatically run your specs (much like autotest).'
+  s.homepage    = 'https://rubygems.org/gems/guard-rspec'
+  s.license     = 'MIT'
+
+  s.files        = `git ls-files`.split($/)
+  s.test_files   = s.files.grep(%r{^spec/})
+  s.require_path = 'lib'
+
+  s.add_dependency 'guard', '~> 2.0'
+  s.add_dependency 'rspec', '~> 2.14'
+  s.add_development_dependency 'bundler', '>= 1.3.5'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'launchy'
+end

data/lib/guard/rspec.rb

@@ -1,126 +1,45 @@
 require 'guard'
-require 'guard/guard'
+require 'guard/plugin'
 
 module Guard
-  class RSpec < Guard
-    autoload :Runner,    'guard/rspec/runner'
-    autoload :Inspector, 'guard/rspec/inspector'
+  class RSpec < Plugin
+    require 'guard/rspec/deprecator'
+    require 'guard/rspec/runner'
 
-    attr_accessor :last_failed, :failed_paths, :runner, :inspector
+    attr_accessor :options, :runner
 
-    def initialize(watchers = [], options = {})
+    def initialize(options = {})
       super
       @options = {
-        :focus_on_failed => false,
-        :all_after_pass => false,
-        :all_on_start   => false,
-        :keep_failed    => false,
-        :spec_paths     => ["spec"],
-        :run_all        => {}
+        all_on_start: false
       }.merge(options)
-      @last_failed  = false
-      @failed_paths = []
 
-      @inspector = Inspector.new(@options)
-      @runner    = Runner.new(@options)
+      Deprecator.warns_about_deprecated_options(@options)
+      @runner = Runner.new(@options)
     end
 
-    # Call once when guard starts
     def start
       UI.info "Guard::RSpec is running"
-      run_all if @options[:all_on_start]
+      run_all if options[:all_on_start]
     end
 
     def run_all
-      passed = @runner.run(@inspector.spec_paths, @options[:run_all].merge(:message => 'Running all specs', :run_all_specs => true))
-
-      unless @last_failed = !passed
-        @failed_paths = []
-      else
-        throw :task_has_failed
-      end
+      _throw_if_failed { runner.run_all }
     end
 
     def reload
-      @failed_paths = []
-    end
-
-    def run_on_changes(paths)
-
-      original_paths = paths.dup
-
-      focused = false
-      if last_failed && @options[:focus_on_failed]
-        path = './tmp/rspec_guard_result'
-        if File.exist?(path)
-          single_spec = paths && paths.length == 1 && paths[0].include?("_spec") ? paths[0] : nil
-          failed_specs = File.open(path) { |file| file.read.split("\n") }
-
-          File.delete(path)
-
-          if single_spec && @inspector.clean([single_spec]).length == 1
-            failed_specs = failed_specs.select{|p| p.include? single_spec}
-          end
-
-          if failed_specs.any?
-            # some sane limit, stuff will explode if all tests fail
-            #   ... cap at 10
-
-            paths = failed_specs[0..10]
-            focused = true
-          end
-
-          # switch focus to the single spec
-          if single_spec and failed_specs.length > 0
-            focused = true
-          end
-        end
-      end
-
-      if focused
-        add_failed(original_paths)
-        add_failed(paths.map{|p| p.split(":")[0]})
-      else
-        paths += failed_paths if @options[:keep_failed]
-        paths  = @inspector.clean(paths).uniq
-      end
-
-      if passed = @runner.run(paths)
-        unless focused
-          remove_failed(paths)
-        end
-
-        if last_failed && focused
-          run_on_changes(failed_paths)
-        # run all the specs if the run before this one failed
-        elsif last_failed && @options[:all_after_pass]
-          @last_failed = false
-          run_all
-        end
-      else
-        @last_failed = true
-        unless focused
-          add_failed(paths)
-        end
-
-        throw :task_has_failed
-      end
+      runner.reload
     end
 
-  private
-
-    def run(paths)
+    def run_on_modifications(paths)
+      return false if paths.empty?
+      _throw_if_failed { runner.run(paths) }
     end
 
-    def remove_failed(paths)
-      @failed_paths -= paths if @options[:keep_failed]
-    end
+    private
 
-    def add_failed(paths)
-      if @options[:keep_failed]
-        @failed_paths += paths
-        @failed_paths.uniq!
-      end
+    def _throw_if_failed
+      throw :task_has_failed unless yield
     end
 
   end