rspec-rerun 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f84f752f73a6cf918bccb79ac52aa94f784f905f
-  data.tar.gz: 85c72128204098706dcfc44747ba4723ab727c44
+  metadata.gz: 65364fcd0d558bc48418792fc46838cb31773447
+  data.tar.gz: 33af133659889ea4cca51bcc33da1de241269046
 SHA512:
-  metadata.gz: 554f23058d54bb1cf30f427d5abe96d9ef6b8df1ab79de7b712015302a125a0684812f937444da5142b24e4dc0bba0c6995ac5c05527cd61ccab036e8202d50c
-  data.tar.gz: 0009bca486f669a32beb4ceb50a241c57b88f6105f1cb1845ab0bdc00ce090ba174e0e6f6c2d2254c26212b230d4e2532478f7a6e453be5d74bb8e9b7d22a22e
+  metadata.gz: 98cafbb7c1a635cbd0a67f82088649021ae86aa05bea5eaa152e265597ec9e541a1e83b71784f077328504cfbf3cc202bcf6cc47b96117960033e588b31e3e31
+  data.tar.gz: 5fff934cf2f8e821088f186c4ea8d14141196d4314062da2460b2956889ec0be62c7e021fb75b394beb063ab2fcfaab7ff5d070dfc470c220e15175d338d279f

data/README.md

@@ -5,26 +5,29 @@
 [![Dependency Status](https://gemnasium.com/dblock/rspec-rerun.svg)](https://gemnasium.com/dblock/rspec-rerun)
 [![Code Climate](https://codeclimate.com/github/dblock/rspec-rerun.svg)](https://codeclimate.com/github/dblock/rspec-rerun)
 
-The **rspec-rerun** gem is a drop-in solution to retry (rerun) failed RSpec examples. It may be useful, for example, with finicky Capybara tests. The strategy to rerun failed specs is to output a file called `rspec.failures` that contains a list of failed examples and to feed that file back to RSpec via `-e`.
+**rspec-rerun** reruns failed RSpec examples (for brittle tests). 
+
+It writes failed examples to the file `rspec.failures` and feeds these back to RSpec via `-e`.
 
 Usage
 -----
-
-Add `rspec-rerun` to `Gemfile` in the `:development` and `:test` groups.
-If you're using RSpec 3, also add `rspec-legacy_formatters`.
+(For RSpec 2 use version '~> 0.3.1'. )
 
 ``` ruby
+# Gemfile
 group :development, :test do
   gem 'rspec-rerun'
-  gem 'rspec-legacy_formatters'
 end
 ```
 
-Require `rspec-rerun` and change the default task in `Rakefile`.
+```ruby
+# Rakefile
+require 'rspec-rerun/tasks'
+task default: 'rspec-rerun:spec'
+```
 
-``` ruby
-require 'rspec-rerun'
-task :default => 'rspec-rerun:spec'
+```bash
+echo rspec.failures >> .gitignore
 ```
 
 Run `rake` or `rake rspec-rerun:spec`. Failed examples will be rerun automatically.
@@ -43,11 +46,6 @@ You can set the following global environment variables:
 * `RSPEC_RERUN_TAG`: only execute the tag specified
 * `RSPEC_RERUN_VERBOSE`: if 'false', don't show the rspec command invoked by Rake
 
-Git Ignore
-----------
-
-A list of failed examples is stored in a file called `rspec.failures`. It might also be a good idea that you add `rspec.failures` to `.gitignore`.
-
 History
 -------
 

data/lib/rspec-rerun/formatter.rb

@@ -0,0 +1,30 @@
+require 'rspec/core'
+require 'rspec/legacy_formatters'
+require 'rspec/core/formatters/base_formatter'
+
+module RSpec
+  module Rerun
+    class Formatter < RSpec::Core::Formatters::BaseFormatter
+      FILENAME = 'rspec.failures'
+
+      def dump_failures
+        if failed_examples.empty?
+          clean!
+        else
+          rerun_commands = failed_examples.map { |e| retry_command(e) }
+          File.write(FILENAME, rerun_commands.join(''))
+        end
+      end
+
+      def clean!
+        File.delete FILENAME if File.exist? FILENAME
+      end
+
+      private
+
+      def retry_command(example)
+        example.location.gsub("\"", "\\\"") + "\n"
+      end
+    end
+  end
+end

data/lib/rspec-rerun/tasks.rb

@@ -1,61 +1,118 @@
+require 'rspec/core/rake_task'
+require 'rspec-rerun/formatter'
+
 module RSpec
   module Rerun
     module Tasks
       class << self
-        def rspec_opts(args, spec_files = nil)
-          opts = [
+        def rspec_options(args, spec_files = nil)
+          options = [
             spec_files,
-            '--require', File.join(File.dirname(__FILE__), '../rspec-rerun'),
-            '--format', 'RSpec::Rerun::Formatters::FailuresFormatter',
-            *dot_rspec_params
+            '--require', 'rspec-rerun/formatter',
+            '--format', 'RSpec::Rerun::Formatter',
+            *dot_rspec_options
           ].compact.flatten
           if args[:tag]
-            opts << '--tag'
-            opts << args[:tag]
+            options << '--tag'
+            options << args[:tag]
           end
-          opts
+          options
         end
 
         def parse_args(args)
-          opts = args.extras
+          options = args.extras
 
           # Error on multiple arguments
-          if opts.size > 1
+          if options.size > 1
             fail ArgumentError 'rspec-rerun can take an integer (retry_count) or options hash'
           else
-            opts = opts[0]
+            options = options[0]
           end
 
           # Handle if opts is just a retry_count integer
-          opts = if opts.is_a? Hash
-                   opts
-                 else
-                   { retry_count: opts }
-                 end
+          options = if options.is_a? Hash
+                      options
+                    else
+                      { retry_count: options }
+                    end
 
           # Parse environment variables
-          opts[:pattern] ||= ENV['RSPEC_RERUN_PATTERN'] if ENV['RSPEC_RERUN_PATTERN']
-          opts[:tag] ||= ENV['RSPEC_RERUN_TAG'] if ENV['RSPEC_RERUN_TAG']
-          opts[:retry_count] ||= ENV['RSPEC_RERUN_RETRY_COUNT'] if ENV['RSPEC_RERUN_RETRY_COUNT']
-          opts[:verbose] = (ENV['RSPEC_RERUN_VERBOSE'] != 'false') if opts[:verbose].nil?
+          options[:pattern] ||= ENV['RSPEC_RERUN_PATTERN'] if ENV['RSPEC_RERUN_PATTERN']
+          options[:tag] ||= ENV['RSPEC_RERUN_TAG'] if ENV['RSPEC_RERUN_TAG']
+          options[:retry_count] ||= ENV['RSPEC_RERUN_RETRY_COUNT'] if ENV['RSPEC_RERUN_RETRY_COUNT']
+          options[:verbose] = (ENV['RSPEC_RERUN_VERBOSE'] != 'false') if options[:verbose].nil?
+
+          options
+        end
+
+        def failing_specs
+          File.read(RSpec::Rerun::Formatter::FILENAME).split
+        end
 
-          opts
+        def failure_message
+          failed_count = failing_specs.count
+          "[#{Time.now}] Failed, #{failed_count} failure#{failed_count == 1 ? '' : 's'}"
+        end
+
+        def rerun(args)
+          Rake::Task['rspec-rerun:run'].execute(args)
         end
 
         private
 
-        def dot_rspec_params
+        def dot_rspec_options
           dot_rspec_file = ['.rspec', File.expand_path('~/.rspec')].detect { |f| File.exist?(f) }
-          dot_rspec = if dot_rspec_file
-                        file_contents = File.read(dot_rspec_file)
-                        file_contents.split(/\n+/).map(&:shellsplit).flatten
-                      else
-                        []
-                      end
-          dot_rspec.concat ['--format', 'progress'] unless dot_rspec.include?('--format')
-          dot_rspec
+          options = if dot_rspec_file
+                      file_contents = File.read(dot_rspec_file)
+                      file_contents.split(/\n+/).map(&:shellsplit).flatten
+                    else
+                      []
+                    end
+          options.concat ['--format', 'progress'] unless options.include?('--format')
+          options
         end
       end
     end
   end
 end
+
+desc 'Run RSpec examples.'
+RSpec::Core::RakeTask.new('rspec-rerun:run') do |t, args|
+  t.pattern = args[:pattern] if args[:pattern]
+  t.fail_on_error = false
+  t.verbose = false if args[:verbose] == false
+  t.rspec_opts = RSpec::Rerun::Tasks.rspec_options(args)
+end
+
+desc 'Re-run failed RSpec examples.'
+RSpec::Core::RakeTask.new('rspec-rerun:rerun') do |t, args|
+  failing_specs = RSpec::Rerun::Tasks.failing_specs
+
+  t.pattern = args[:pattern] if args[:pattern]
+  t.fail_on_error = false
+  t.verbose = false if args[:verbose] == false
+  t.rspec_opts =  RSpec::Rerun::Tasks.rspec_options(args, failing_specs.join(' '))
+end
+
+desc 'Run RSpec code examples.'
+task 'rspec-rerun:spec' do |_t, args|
+  parsed_args = RSpec::Rerun::Tasks.parse_args(args)
+  retry_count = (parsed_args[:retry_count] || 1).to_i
+
+  fail 'retry count must be >= 1' if retry_count <= 0
+  FileUtils.rm_f RSpec::Rerun::Formatter::FILENAME
+  RSpec::Rerun::Tasks.rerun(parsed_args)
+
+  until $?.success? || retry_count == 0
+    retry_count -= 1
+    msg = RSpec::Rerun::Tasks.failure_message
+    msg += ", re-running, #{retry_count} #{retry_count == 1 ? 'retry' : 'retries'} left" if retry_count > 0
+    $stderr.puts msg
+    RSpec::Rerun::Tasks.rerun(parsed_args)
+  end
+
+  unless $?.success?
+    $stderr.puts RSpec::Rerun::Tasks.failure_message
+    fail "#{failed_count} failure#{failed_count == 1 ? '' : 's'}"
+  end
+end

data/lib/rspec-rerun/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Rerun
-    VERSION = '0.3.1'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rerun
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-legacy_formatters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,12 +101,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/rspec-rerun.rb
-- lib/rspec-rerun/formatters/failures_formatter.rb
-- lib/rspec-rerun/rspec.rb
+- lib/rspec-rerun/formatter.rb
 - lib/rspec-rerun/tasks.rb
 - lib/rspec-rerun/version.rb
-- lib/tasks/rspec.rake
 homepage: https://github.com/dblock/rspec-rerun
 licenses:
 - MIT

data/lib/rspec-rerun.rb

@@ -1,8 +0,0 @@
-require 'rspec-rerun/version'
-require 'rspec-rerun/formatters/failures_formatter'
-
-if defined?(Rake)
-  Dir[File.join(File.dirname(__FILE__), '../lib/tasks/**/*.rake')].each do |f|
-    load f
-  end
-end

data/lib/rspec-rerun/formatters/failures_formatter.rb

@@ -1,44 +0,0 @@
-require 'rspec/core'
-require 'rspec-rerun/rspec'
-
-if RSpec::Rerun.rspec3?
-  begin
-    require 'rspec/legacy_formatters'
-  rescue LoadError => e
-    STDERR.puts '*' * 80
-    STDERR.puts e.message
-    STDERR.puts 'Please add rspec-legacy_formatters to your Gemfile.'
-    STDERR.puts 'See https://github.com/dblock/rspec-rerun/pull/22 for details.'
-    STDERR.puts '*' * 80
-    raise
-  end
-end
-
-require 'rspec/core/formatters/base_formatter'
-
-module RSpec
-  module Rerun
-    module Formatters
-      class FailuresFormatter < RSpec::Core::Formatters::BaseFormatter
-        FILENAME = 'rspec.failures'
-
-        def dump_failures
-          return if failed_examples.empty?
-          f = File.new(FILENAME, 'w+')
-          failed_examples.each do |example|
-            f.puts retry_command(example)
-          end
-          f.close
-        end
-
-        def retry_command(example)
-          example.location.gsub("\"", "\\\"")
-        end
-
-        def clean!
-          File.delete FILENAME if File.exist? FILENAME
-        end
-      end
-    end
-  end
-end

data/lib/rspec-rerun/rspec.rb

@@ -1,8 +0,0 @@
-module RSpec
-  module Rerun
-    def self.rspec3?
-      require 'rspec'
-      ::RSpec.const_defined?(:Support)
-    end
-  end
-end

data/lib/tasks/rspec.rake

@@ -1,43 +0,0 @@
-require 'rspec/core/rake_task'
-require 'rspec-rerun/tasks'
-
-desc 'Run RSpec examples.'
-RSpec::Core::RakeTask.new('rspec-rerun:run') do |t, args|
-  t.pattern = args[:pattern] if args[:pattern]
-  t.fail_on_error = false
-  t.verbose = false if args[:verbose] == false
-  t.rspec_opts = RSpec::Rerun::Tasks.rspec_opts(args)
-end
-
-desc 'Re-run failed RSpec examples.'
-RSpec::Core::RakeTask.new('rspec-rerun:rerun') do |t, args|
-  failing_specs = File.read(RSpec::Rerun::Formatters::FailuresFormatter::FILENAME).split
-
-  t.pattern = args[:pattern] if args[:pattern]
-  t.fail_on_error = false
-  t.verbose = false if args[:verbose] == false
-  t.rspec_opts =  RSpec::Rerun::Tasks.rspec_opts(args, failing_specs.join(' '))
-end
-
-desc 'Run RSpec code examples.'
-task 'rspec-rerun:spec' do |_t, args|
-  parsed_args = RSpec::Rerun::Tasks.parse_args(args)
-  retry_count = (parsed_args[:retry_count] || 1).to_i
-
-  fail 'retry count must be >= 1' if retry_count <= 0
-  FileUtils.rm_f RSpec::Rerun::Formatters::FailuresFormatter::FILENAME
-  Rake::Task['rspec-rerun:run'].execute(parsed_args)
-  while !$?.success? && retry_count > 0
-    retry_count -= 1
-    failed_count = File.read(RSpec::Rerun::Formatters::FailuresFormatter::FILENAME).split(/\n+/).count
-    msg = "[#{Time.now}] Failed, re-running #{failed_count} failure#{failed_count == 1 ? '' : 's'}"
-    msg += ", #{retry_count} #{retry_count == 1 ? 'retry' : 'retries'} left" if retry_count > 0
-    $stderr.puts "#{msg} ..."
-    Rake::Task['rspec-rerun:rerun'].execute(parsed_args)
-  end
-  unless $?.success?
-    failed_count = File.read(RSpec::Rerun::Formatters::FailuresFormatter::FILENAME).split(/\n+/).count
-    $stderr.puts "[#{Time.now}] #{failed_count} failure#{failed_count == 1 ? '' : 's'}."
-    fail "#{failed_count} failure#{failed_count == 1 ? '' : 's'}"
-  end
-end