rspec_n 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7885109452933b4683af78f646bf3d9c86da1da0f14060effdb9f6f51402dd00
-  data.tar.gz: 1147d10d70982cf22c9da390507c4fea06da3504ed8cc837acb638eb1bdb77ed
+  metadata.gz: 7fa5af32a552646670769dd832d01ba4e1b4eaed5099048e2653fdb63936af16
+  data.tar.gz: 18a3426eebc20db6bbaa680b8653b3dd656f0f7e6e8889fc9be4fdc6825f8ee4
 SHA512:
-  metadata.gz: 41f20600834363b08a40db6f10f2c77a5ade7979d00d00e7911b548350e3df6a1576020d5a27ab6243213a7708a0874d01fdf2ea13dc94d531909513c30b847e
-  data.tar.gz: e9e2684e648dd911652678f3f052c6ee83457dac287c5aab21f50f82b8ebb47a02e11a9706a4512c668511c4939f86e1c16bc9780413955dcb373a7a6440b54f
+  metadata.gz: ef6b53c0016bd508a7e025c05b5af63105ae5ff88d050aff494535ad039ab1fd9d12952cb601bb8f13f3fd2c6df9bee261127f1916831095d8da7bbfe3638af6
+  data.tar.gz: a7edc252c7d543200e6583c264dcc8a041a90fe45aa332df0ba5323a6db3155cad464a45f6d34252bc7f3eaa75855b72b3336628e52e16d8fdbafcca1e380a49

data/.gitignore

@@ -11,3 +11,5 @@
 # rspec failure tracking
 .rspec_status
 Gemfile.lock
+
+rspec_n_iteration.*

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   rubocop_plus: config/rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
 
 Style/Documentation:
   Enabled: false

data/.travis.yml

@@ -3,12 +3,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.8
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-before_install: gem install bundler -v 2.0.2
+  - 2.6
+  - 2.7
+  - 3.0
+before_install: gem install bundler -v 2.2.17
 notifications:
   email:
     on_success: never # default: change

data/CHANGELOG.md

@@ -2,36 +2,45 @@
 
 Issues are tracked at https://github.com/roberts1000/rubocop_plus/issues. Changes marked as **(Internal)** support development/refactoring.
 
+## 1.4.0 (May 16, 2021)
+
+1. [#64](../../issues/64): Use `pry` `~> 0.14.0`. **(Internal)**
+1. [#66](../../issues/66): Update ruby & bundler versions in `.travis.yml`. **(Internal)**
+1. [#68](../../issues/68): Make Ruby 2.6 the minimum supported version.
+1. [#73](../../issues/73): Use `rake` `~> 13.0`. **(Internal)**
+1. [#78](../../issues/78): Require `Pathname`.
+1. [#83](../../issues/83): Use `rubocop_plus` `~> 2.0`. **(Internal)**
+
 ## 1.3.0 (Jan 13, 2020)
 
-[#49](../../issues/49): Make `--order project` work.
-[#55](../../issues/55): Add `--dir` and `--timestamp` output options.
-[#57](../../issues/57): Redesign the `CHANGELOG.md`.
+1. [#49](../../issues/49): Make `--order project` work.
+1. [#55](../../issues/55): Add `--dir` and `--timestamp` output options.
+1. [#57](../../issues/57): Redesign the `CHANGELOG.md`.
 
 ## 1.2.2 (Jun 22, 2019)
 
-[#36](../../issues/36): Add instructions for installing `rspec_n` in project Gemfiles.
-[#38](../../issues/38): Stop `--order rand` from being added to the final command when a custom order is specified.
-[#41](../../issues/41): Remove locking to a specify version of Ruby in development. **(Internal)**
-[#43](../../issues/43): Use pry 0.12.x for development. **(Internal)**
+1. [#36](../../issues/36): Add instructions for installing `rspec_n` in project Gemfiles.
+1. [#38](../../issues/38): Stop `--order rand` from being added to the final command when a custom order is specified.
+1. [#41](../../issues/41): Remove locking to a specify version of Ruby in development. **(Internal)**
+1. [#43](../../issues/43): Use pry 0.12.x for development. **(Internal)**
 
 ## 1.2.1 (Mar 06, 2019)
 
-[#30](../../issues/30): Make `-v` and `--version` work again.
+1. [#30](../../issues/30): Make `-v` and `--version` work again.
 
 ## 1.2.0 (Mar 03, 2019)
 
-[#26](../../issues/26): Write the command that was used to run rspec_n to the output files.
+1. [#26](../../issues/26): Write the command that was used to run rspec_n to the output files.
 
 ## 1.1.0 (Mar 03, 2019)
 
-[#19](../../issues/19): Add **Result Counts** column which shows the result counts for each run (e.g. "400 examples, 2 failures, 3 pending").
-[#20](../../issues/20): Accept an optional path argument, that is passed to RSpec, to target specs (e.g. `rspec_n 3 spec/features/example_spec.rb`, `rspec_n spec/features/example_spec.rb:5`, `rspec_n spec/features 4`).
-[#23](../../issues/23): Rename the `Result Counts` column to `Results` and remove the existing `Results` column.
+1. [#19](../../issues/19): Add **Result Counts** column which shows the result counts for each run (e.g. "400 examples, 2 failures, 3 pending").
+1. [#20](../../issues/20): Accept an optional path argument, that is passed to RSpec, to target specs (e.g. `rspec_n 3 spec/features/example_spec.rb`, `rspec_n spec/features/example_spec.rb:5`, `rspec_n spec/features 4`).
+1. [#23](../../issues/23): Rename the `Result Counts` column to `Results` and remove the existing `Results` column.
 
 ## 1.0.0 (Feb 18, 2019)
 
-[#1](../../issues/1): Add initial core logic.
-[#4](../../issues/4): Add initial CLI.
-[#5](../../issues/5): Write results of each iteration to a separate file.
-[#6](../../issues/6): Add `-s` option to stop on first failure.
+1. [#1](../../issues/1): Add initial core logic.
+1. [#4](../../issues/4): Add initial CLI.
+1. [#5](../../issues/5): Write results of each iteration to a separate file.
+1. [#6](../../issues/6): Add `-s` option to stop on first failure.

data/README.md

@@ -1,6 +1,6 @@
 # rspec_n
 
-rspec_n is a Ruby gem that makes it easy to run a project's RSpec test suite N times.  You can customize the command that is used to start RSpec, or let rspec_n guess the best command (based on the files in your project).  rspec_n is useful for finding repeatability or flakiness issues in automated test suites.
+rspec_n is a Ruby gem that makes it easy to run a project's RSpec test suite N times. You can customize the command that is used to start RSpec, or let rspec_n guess the best command (based on the files in your project). rspec_n is useful for finding repeatability issues in automated test suites.
 
 ![example](https://user-images.githubusercontent.com/2053901/53691471-c6956880-3d4c-11e9-8248-68bbb4c24786.png)
 
@@ -8,25 +8,31 @@ rspec_n is a Ruby gem that makes it easy to run a project's RSpec test suite N t
 
 Releases are versioned using [semver 2.0.0](https://semver.org/spec/v2.0.0.html).
 
-## Supported Rubies
+Ruby versions that reach EOL will be removed without a major version bump.
 
-Ruby 2.3.0+ is supported.
+## Supported Ruby Versions
+
+Ruby 2.6.0+ is supported.
 
 ## Installation
 
-Install by executing
+Install by executing:
 
     $ gem install rspec_n
 
-The gem will install an exectuable called `rspec_n` on your system.  You may also want to add `rspec_n_iteration.*` to your `.gitignore` to exclude the output generated by rspec_n from your project's repo.
+The gem will install an executable called `rspec_n`. 
+
+Add the following to your project's `.gitignore` to exclude the output generated by rspec_n from your project's repo:
 
-#### Using in a Gemfile
+    rspec_n_iteration.*
 
-If you want to add rspec_n to your Gemfile, make sure you use the `require: false` option so rspec_n files aren't loaded into your application.  rspec_n doesn't provide any runtime benefit to an app and requiring it will add unnecessary code to your project.  Also, rspec_n is designed as a standalone commandline tool and isn't tested for compatibility inside other apps.
+#### Usage in a Gemfile
 
-    ```ruby
-    gem 'rspec_n', require: false
-    ```
+If you want to add rspec_n to your Gemfile, use the `require: false` option so rspec_n files aren't loaded into your app. rspec_n doesn't provide any runtime benefit to apps and requiring it will add unnecessary code to your project. Also, rspec_n is designed as a standalone commandline tool and isn't tested for compatibility inside other apps.
+
+```ruby
+gem 'rspec_n', require: false
+```
 
 ## Usage
 
@@ -34,16 +40,16 @@ The simplest way to run rspec_n is to give it a positive integer which tells it
 
     $ rspec_n 5
 
-As each iteration completes, output will be sent to the screen and dumped to a file.  If you need to examine the detailed output of a run, it is available in the output files.
+As each iteration completes, output is sent to the screen and dumped to a file. If you need to examine the detailed output of a run, it is available in the output files.
 
-You can also list one or more paths to target specs.  You can do anything you would normally do when giving RSpec paths:
+You can also list one or more paths to target specs. You can do anything you would normally do when giving RSpec paths:
 
     $ rspec_n 5 spec/path/to/something_spec.rb
     $ rspec_n 5 spec/path/to/folder spec/path/to/some/other/file_spec.rb
     $ rspec_n 5 spec/path/to/folder
     $ rspec_n 5 spec/path/to/something_spec.rb:5
 
-By default, `--order rand` is sent to RSpec to force it to run specs in random order.  You can use a `defined` order if you don't want randomness:
+By default, `--order rand` is sent to RSpec to force it to run specs in random order. You can use a `defined` order if you don't want randomness:
 
     $ rspec_n 5 --order defined
 
@@ -53,50 +59,76 @@ Or, let the configuration files in the project determine the order:
 
 #### Automatic Command Selection
 
-rspec_n will inspect the files in your project and pick the best way to start RSpec.  If it can't make an educated guess, it will use `bundle exec rspec` as the base command and add any extra information you've entered on the command line (like the order or paths).  The following is a list of project types that rspec_n can identify and the associated commands it will try to execute:
+rspec_n inspects files in your project so it can pick the best way to start RSpec. If it can't make an educated guess, it will use `bundle exec rspec` as the base command and add any extra information you've entered on the command line (like the order or paths). The following is a list of project types that rspec_n can identify and the associated commands it will try to execute:
 
 1. Ruby on Rails Applications: `DISABLE_DATABASE_ENVIRONMENT_CHECK=1 RAILS_ENV=test bundle exec rake db:drop db:create db:migrate && bundle exec rspec`.
 2. Everything else: `bundle exec rspec`.
 
 #### Use Custom Command to Start RSpec
 
-If you don't want rspec_n to automatically pick the best command, you can use the `-c` option and specify a command.  The following example deletes the `tmp` folder before starting RSpec:
+Use the `-c` option if you want to specify your own command. The following example deletes the `tmp` folder before starting RSpec:
 
     $ rspec_n 5 -c 'rm -rf tmp && bundle exec rspec'
 
 There are couple points to consider:
 
-1. Wrap your entire command in a single or double quoted string so rspec_n can acturately determine the command.
-1. You can use the `&&` operator to join commands.
-1. rspec_n was partially created to help discover flaky test suites so it will add `--order rand` to a custom command even if don't specify the order.  You must explicitly use `--order defined` or `--order project` if you want something else.
+1. Wrap your entire command in a single or double quoted string.
+1. Use the `&&` operator to join commands.
+1. rspec_n was created to help discover flaky test suites so it adds `--order rand` to your custom command by default. You must use `--order defined` or `--order project` if you want something else.
 
 #### Control File Output
 
-rspec_n writes output for each iteration in a sequence of files `rspec_n_iteration.1`, `rspec_n_iteration.2`, etc...  This saves you from having to rerun your test suite when you find a particular seed that causes your test suite to fail.  If you want to disable this, add the `--no-file` option to the command.
+rspec_n writes output for each iteration in a sequence of files `rspec_n_iteration.1`, `rspec_n_iteration.2`, etc... If you want to disable this, add the `--no-file` option to the command.
 
     $ rspec_n 5 --no-file
 
-**Note:** rspec_n deletes all files matching `rspec_n_iteration.*` when it starts so be sure tomove those files to another location if you want to save them.
+**Note:** rspec_n deletes all files matching `rspec_n_iteration.*` when it starts, so be sure to move those files to another location if you want to save them.
 
 #### Stop on First Failure
 
-You can tell rspec_n to abort the first time an iteration fails by using the `-s` flag.  Any remaining iterations will be skipped.
+You can tell rspec_n to abort the first time an iteration fails by using the `-s` flag. All remaining iterations are skipped.
 
 ## Understanding the Results
 
-rspec_n uses the STDOUT, STDERR and EXIT STATUS of the `rspec` command  to figure out what to show in the **Results** column.  The general results are determined by finding the line in RSpec's STDOUT that says `xyz examples, xyz failures, xyz pending`.  rspec_n considers the run to be successful if RSpec returns an EXIT STATUS of 0 **regardless of any content in the STDERR stream**; it considers the run to be a failure if RSpec's EXIT STATUS > 0.
+rspec_n uses the `STDOUT`, `STDERR` and `EXIT STATUS` of the `rspec` command to decide if the run passed or failed. The run is considered successful if RSpec returns an `EXIT STATUS` of `0` **regardless of any content in the STDERR stream**. rspec_n considers the run to be a failure if RSpec's `EXIT STATUS` `> 0`.
+
+There are times when `STDERR` has content, even though RSpec returns an `EXIT STATUS` of `0`. This frequently happens with deprecation notices and RSpec itself will pass the test suite in this situation. Also, it's not uncommon for code to write messages to `STDERR` that look like errors, but not actually cause RSpec to fail a spec example. If rspec_n is able to detect this situation, it adds `(Warning)` to the results to indicate there's something extra in the `STDERR` that you might want to investigate.
 
-There are times when RSpec's STDERR might have content, even though it returns an EXIT STATUS of 0. This frequently happens with deprecation notices and RSpec itself will pass the test suite in this situation. Unfortunately, it's not uncommon for code to write messages that look like errors to STDERR, but not actually raise an error and cause RSpec to fail a spec example.  rspec_n reports this situation by adding a `(Warning)` label to the results to indicate there's something extra in the STDERR that you might want to investigate.
+The results of each run (number of tests, number of failures, etc...) are determined by parsing `STDOUT` and extracting information from the line that says `xyz examples, xyz failures, xyz pending`.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for a Pry console, or `rake console` for an IRB console, that will allow you to experiment.
+### Setup
+
+Install dependencies:
+
+    $ bin/setup
+
+That's it!
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Run Automated Tests
+
+Run the automated test suite with:
+
+    $ rake spec
+
+### Start a Console
+
+Choose one of the following to start a conole with the gem loaded:
+
+```bash
+$ bin/console  # for Pry
+$ rake console # for IRB
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/roberts1000/rspec_n.
+Contributions are welcome. Please us the following process when submitting work:
+
+1. Create an issue on the [issue page](https://github.com/roberts1000/rspec_n/issues) that targets a single problem/enhancement. All PRs should be tied to an issue.
+1. Fork the project.
+1. Create a branch. The name of the branch should start with the issue number that the branch will address.
+1. Submit the PR. In the PR comment (in the UI), add `Closes #xyz` or `Supports #xyz` where `xyz` is the issue number that the PR addresses. The title of the PR (in the UI) should start with `[PR for #xyz] `.
 
 ## License
 

data/Rakefile

@@ -5,6 +5,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
+desc "Start an irb console"
 task :console do
   # exec "pry -r rspec_n -I ./lib"
   exec "irb -r rspec_n -I ./lib"

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/rspec_n.rb

@@ -3,6 +3,7 @@ require "rspec_n/version"
 require "colorize"
 require "cri"
 require "open3"
+require "pathname"
 
 require "rspec_n/helpers/time_helpers"
 require "rspec_n/helpers/core_ext/array"

data/lib/rspec_n/errors/bad_option.rb

@@ -6,7 +6,7 @@ module RspecN
     end
 
     def message
-      allowed = RspecN::ALLOWED_ORDER_OPTIONS.collect { |val| "'" + val + "'" }
+      allowed = RspecN::ALLOWED_ORDER_OPTIONS.collect { |val| "'#{val}'" }
       "Order must be #{allowed.to_sentence}.  '#{@details}' is not allowed.\n"
     end
   end

data/lib/rspec_n/formatters/table_formatter.rb

@@ -62,7 +62,7 @@ module RspecN
       end
 
       def padded_header_column_labels
-        columns.collect { |name, max_width| padded_header_column_label(name, max_width) }.join("")
+        columns.collect { |name, max_width| padded_header_column_label(name, max_width) }.join
       end
 
       def max_column_width_for(name)
@@ -92,10 +92,8 @@ module RspecN
 
       def result_color_symbol(run)
         case run.status_string
-        when "Pass (Warnings)" then :green
-        when "Pass" then :green
+        when "Pass", "Pass (Warnings)" then :green
         when "Fail" then :red
-        when "Skip" then :yellow
         else :yellow
         end
       end

data/lib/rspec_n/helpers/core_ext/string.rb

@@ -1,7 +1,7 @@
 class String
   # https://stackoverflow.com/questions/39743299/check-if-a-string-contains-only-digits-in-ruby
   def all_digits?
-    self =~ /\A\d+\z/ ? true : false
+    match?(/\A\d+\z/)
   end
 
   def remove_color

data/lib/rspec_n/input.rb

@@ -1,6 +1,7 @@
 module RspecN
   class Input
     attr_accessor :iterations, :command, :stop_fast, :write_files, :log_path
+
     def initialize(options, args)
       @args = args
       @unprocessed_args_array = args.entries
@@ -23,7 +24,8 @@ module RspecN
     private
 
     def validate_order
-      return unless (order = @options.fetch(:order, nil))
+      order = @options.fetch(:order, nil)
+      return unless order
 
       raise BadOption, order unless RspecN::ALLOWED_ORDER_OPTIONS.include?(order)
     end
@@ -45,8 +47,8 @@ module RspecN
 
     def determine_command
       command = @options.fetch(:command, guessed_command)
-      command += " " + @spec_path if @spec_path
-      command += " --order " + @order if should_append_order?(command)
+      command += " #{@spec_path}" if @spec_path
+      command += " --order #{@order}" if should_append_order?(command)
       command
     end
 
@@ -70,7 +72,7 @@ module RspecN
     def should_append_order?(command)
       return false if @order == "project"
 
-      command.match(/--order/).nil?
+      !command.include?("--order")
     end
 
     def determine_log_path

data/lib/rspec_n/version.rb

@@ -1,3 +1,3 @@
 module RspecN
-  VERSION = "1.3.0".freeze
+  VERSION = "1.4.0".freeze
 end

data/rspec_n.gemspec

@@ -33,12 +33,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.6.0'
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "pry", "~> 0.12.0"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "pry", "~> 0.14.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop_plus", "~> 2.0"
 
   spec.add_dependency "colorize", "~> 0.8.0"
   spec.add_dependency "cri", "~> 2.15.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_n
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - roberts1000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2021-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop_plus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +156,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: A ruby gem that runs RSpec N times.