rspec_n 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fa5af32a552646670769dd832d01ba4e1b4eaed5099048e2653fdb63936af16
-  data.tar.gz: 18a3426eebc20db6bbaa680b8653b3dd656f0f7e6e8889fc9be4fdc6825f8ee4
+  metadata.gz: 0d531fc0cb07d13bf1700f6809c0566cc72dfe887af684b5493821a1d60e0956
+  data.tar.gz: 6bfe142183b285877bb067b1049bcc02139050d69ea123352904db52b34cfce7
 SHA512:
-  metadata.gz: ef6b53c0016bd508a7e025c05b5af63105ae5ff88d050aff494535ad039ab1fd9d12952cb601bb8f13f3fd2c6df9bee261127f1916831095d8da7bbfe3638af6
-  data.tar.gz: a7edc252c7d543200e6583c264dcc8a041a90fe45aa332df0ba5323a6db3155cad464a45f6d34252bc7f3eaa75855b72b3336628e52e16d8fdbafcca1e380a49
+  metadata.gz: ab882b6d984ef3565d26c4d72357802a6daf058374c175e10b267f1bfcfb825e50f4ddcbda66d96dbebadeeecee7d4ac2f4c89d53276b217804436adbc300ef6
+  data.tar.gz: 681e5b4f42152b285174535231ef0d07054fefa57c9fcbabdc1e23ad466ebcf3d8e84dd5829afd8b91db733636fd9d6e50b5d4986d99493b17122a6406a8092b

data/.github/workflows/check_pull_request.yml

@@ -0,0 +1,54 @@
+# This workflow will download prebuilt Ruby versions, install dependencies and run checks against Pull Requests.
+
+name: Check Pull Request
+on:
+  pull_request:
+    branches: [ master ]
+env:
+  # The pull request can have less than, or equal to, this number of rubocop issues and pass.
+  RUBOCOP_ISSUE_THRESHOLD: 5
+jobs:
+  rspec:
+    name: Run RSpec
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Execute rspec command
+        run: bundle exec rspec
+  rubocop:
+    name: Run Rubocop
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Execute rubo command
+        run: bundle exec rubo
+      - name: Evaluate rubo threshold
+        run: |
+          count=$(cat rubocop/total-violations-count.txt)
+          if [[ "$count" -gt $RUBOCOP_ISSUE_THRESHOLD ]]; then
+              echo "Failure: Found $count RuboCop issue(s). It must have $RUBOCOP_ISSUE_THRESHOLD or less. \
+          Run 'rubo' and resolve the issues listed in rubocop/style-issues.html"
+              exit 1
+          else
+              echo "Success: Found $count RuboCop issue(s), which is less than the limit of $RUBOCOP_ISSUE_THRESHOLD"
+          fi

data/.rubocop.yml

@@ -1,8 +1,18 @@
+# DO NOT MODIFY THIS FILE unless you want to deviate from the rubocop_plus ruleset.
+
+# This file defines the settings used by rubocop when it runs. You would normally add your customizations directly to this
+# file, but this file has been pre configured to read settings out of the rubocop_plus gem instead.
+
+# Tell rubocop to load its settings from the rubocop_plus gem.
+
 inherit_gem:
   rubocop_plus: config/rubocop.yml
 
+# Place custom settings below this comment. All customizations will OVERRIDE rubocop_plus rules. rubocop_plus & rubocop
+# do not attempt to merge these settings with their defaults. Long term changes should be ported to the rubocop_plus gem.
+
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -1,12 +1,18 @@
 # CHANGELOG
 
-Issues are tracked at https://github.com/roberts1000/rubocop_plus/issues. Changes marked as **(Internal)** support development/refactoring.
+Issues are tracked at https://github.com/roberts1000/rspec_n/issues. Issues marked as **(Internal)** only affect development.
+
+## 1.5.0 (Aug 28, 2022)
+
+1. [#87](../../issues/87): Add GitHub action workflow to check pull requests. **(Internal)**
+1. [#93](../../issues/93): Make Ruby 2.7.0 the min supported Ruby.
+1. [#97](../../issues/97): Add Ruby 3.1 support.
 
 ## 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. [#68](../../issues/68): Make Ruby 2.6.0 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)**
@@ -22,7 +28,7 @@ Issues are tracked at https://github.com/roberts1000/rubocop_plus/issues. Change
 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. [#43](../../issues/43): Use `pry` `0.12.x` for development. **(Internal)**
 
 ## 1.2.1 (Mar 06, 2019)
 

data/Gemfile

@@ -2,3 +2,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in rspec_n.gemspec
 gemspec
+
+group :development do
+  gem 'rubocop_plus', '~> 2.0', require: false
+end

data/LICENSE.md

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2019 roberts1000
+Copyright (c) 2021 roberts1000
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,18 +1,18 @@
 # 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 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 RSpec test suites.
 
 ![example](https://user-images.githubusercontent.com/2053901/53691471-c6956880-3d4c-11e9-8248-68bbb4c24786.png)
 
-## Version Strategy
+## Versioning Strategy
 
-Releases are versioned using [semver 2.0.0](https://semver.org/spec/v2.0.0.html).
+Releases are versioned using [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) with the following caveats:
 
-Ruby versions that reach EOL will be removed without a major version bump.
+1. Support for Ruby versions, that reach EOL, can be removed in a major **or** minor release.
 
 ## Supported Ruby Versions
 
-Ruby 2.6.0+ is supported.
+Ruby 2.7, 3.0 and 3.1.
 
 ## Installation
 
@@ -20,7 +20,7 @@ Install by executing:
 
     $ gem install rspec_n
 
-The gem will install an executable called `rspec_n`. 
+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:
 
@@ -28,7 +28,7 @@ Add the following to your project's `.gitignore` to exclude the output generated
 
 #### Usage in a Gemfile
 
-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.
+If you add rspec_n to your Gemfile, use the `require: false` option so rspec_n isn'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
@@ -40,23 +40,38 @@ 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 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.
+As iterations complete, summary output is sent to the screen and detailed output is written to files (in the project's root).
 
-You can also list one or more paths to target specs. You can do anything you would normally do when giving RSpec paths:
+To target specific specs, provide one or more paths. You can do anything you would normally do when giving paths to RSpec:
 
     $ 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 always 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
 
-Or, let the configuration files in the project determine the order:
+Or, let the RSpec configuration in the project determine the order:
 
     $ rspec_n 5 --order project
 
+#### Config file
+
+You can create a `.rspec_n` file in your project's root and add command line options to it. They'll be used if `rspec_n` is run without options. Options are any arguments that start with `-` or `--`. For example, `rspec_n 10` or `rspec_n 10 spec/some_spec.rb` will make rspec_n consider `.rspec_n`, but `rspec_n 10 -c "rm -rf /tmp/* && bundle exec rspec"` won't.
+
+Example file format:
+
+```
+--no-file
+-s
+--order defined
+-c "rm -rf tmp && bundle exec rspec"
+```
+
+The config file can be multi line or single line.
+
 #### Automatic Command Selection
 
 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:
@@ -64,21 +79,21 @@ rspec_n inspects files in your project so it can pick the best way to start RSpe
 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
+#### Use a Custom Command to Start 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:
+There are a couple points to consider:
 
 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.
+1. Use `&&` to create compound commands.
+1. Avoid trying to change test order within a custom command. rspec_n was created to help discover flaky test suites so it adds `--order rand` to your custom command. Use the `--order defined` or `--order project` options to the control the order. 
 
 #### Control File Output
 
-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 writes output for each iteration to files with the iteration number (`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
 
@@ -110,11 +125,11 @@ That's it!
 
 Run the automated test suite with:
 
-    $ rake spec
+    $ rspec
 
 ### Start a Console
 
-Choose one of the following to start a conole with the gem loaded:
+Choose one of the following to start a console with the gem loaded:
 
 ```bash
 $ bin/console  # for Pry
@@ -129,7 +144,3 @@ Contributions are welcome. Please us the following process when submitting work:
 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
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -7,6 +7,6 @@ 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"
+  exec "pry -r rspec_n -I ./lib"
+  # exec "irb -r rspec_n -I ./lib"
 end

data/bin/console

@@ -6,8 +6,7 @@ require "rspec_n"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-require "pry"
-Pry.start
+# Run 'rake console' to start a pry console.
 
-# require "irb"
-# IRB.start(__FILE__)
+require "irb"
+IRB.start(__FILE__)

data/exe/rspec_n

@@ -18,17 +18,18 @@ require "cri"
 require "fileutils"
 require "rspec_n/version"
 require "rspec_n/constants"
+require "rspec_n/helpers/arguments_helper"
 require "rspec_n/errors/bad_option"
 
 # rubocop:disable Metrics/BlockLength
 command = Cri::Command.define do
   usage       'rspec_n [iterations] [options]'
   description "rspec_n is an executable installed by the rspec_n Ruby gem.  It provides a " \
-    "way to re-run an RSpec test suite 'N' times, which is useful when determining " \
-    "if a test suite is consistent.\n\n" \
-    "STATUS CODES\n\n" \
-    "0 - rspec_n ran successfully                                            \u00A0\n" \
-    "1 - problem with the commandline options                                \u00A0"
+              "way to re-run an RSpec test suite 'N' times, which is useful when determining " \
+              "if a test suite is consistent.\n\n" \
+              "STATUS CODES\n\n" \
+              "0 - rspec_n ran successfully                                            \u00A0\n" \
+              "1 - problem with the commandline options                                \u00A0"
 
   flag :h, :help, 'show help' do |_value, cmd|
     puts cmd.help
@@ -36,17 +37,17 @@ command = Cri::Command.define do
   end
 
   command_description = "By default, rspec_n will guess the best command to run RSpec; " \
-    "override it by setting a custom command; wrap the entire command in single or double quotes; " \
-    "join multiple commands with '&&'"
+                        "override it by setting a custom command; wrap the entire command in single or double quotes; " \
+                        "join multiple commands with '&&'"
   option :c, :command, command_description, argument: :required
 
   flag nil, "no-file", "Do not write iteration output to files"
 
   flag nil, "timestamp", "Write iteration output to a timestamped directory, which can " \
-    "prevent accidental loss. NOTE: It is up to the user to periodically clean up files."
+                         "prevent accidental loss. NOTE: It is up to the user to periodically clean up files."
 
   command_description = "Write iteration output to files in the provided directory " \
-    "rather than the current working directory. Can be used along with the timestamp flag."
+                        "rather than the current working directory. Can be used along with the timestamp flag."
   option :d, :dir, command_description, argument: :required
 
   flag :s, "stop-fast", "Stop when an iteration reports a failure."
@@ -71,7 +72,7 @@ end
 # rubocop:enable Metrics/BlockLength
 
 begin
-  command.run(ARGV)
+  command.run(ArgumentsHelper.arguments)
   exit 0
 rescue RspecN::BadOption => e
   warn e.message.colorize(:red)

data/lib/rspec_n/helpers/arguments_helper.rb

@@ -0,0 +1,26 @@
+require 'shellwords'
+
+class ArgumentsHelper
+  class << self
+    def arguments
+      if File.exist?(".rspec_n") && no_options_in_arguments?
+        options = read_options_from_file
+        if options.any?
+          print "Reading options from `.rspec_n` file\n"
+          return ARGV + options
+        end
+      end
+      ARGV
+    end
+
+    # Read arguments from the config file only if no arguments are provided by user
+    def no_options_in_arguments?
+      ARGV.grep(/^-/).empty? # Match args that start with - (or --). Those are the options.
+    end
+
+    # Options can be listed on a single line in the config file, or listed on separate lines.
+    def read_options_from_file
+      Shellwords.shellwords File.read(".rspec_n").to_s.gsub(/\n|\r\n/, " ")
+    end
+  end
+end

data/lib/rspec_n/version.rb

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

data/rspec_n.gemspec

@@ -2,7 +2,6 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "rspec_n/version"
 
-# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = "rspec_n"
   spec.version       = RspecN::VERSION
@@ -22,7 +21,7 @@ Gem::Specification.new do |spec|
     spec.metadata["changelog_uri"] = "https://github.com/roberts1000/rspec_n/blob/master/CHANGELOG.md"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+          "public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -33,15 +32,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.6.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_development_dependency "bundler", "~> 2.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"
 end
-# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_n
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - roberts1000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ 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
@@ -116,10 +102,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/check_pull_request.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -133,6 +119,7 @@ files:
 - lib/rspec_n/errors/bad_option.rb
 - lib/rspec_n/formatters/file_formatter.rb
 - lib/rspec_n/formatters/table_formatter.rb
+- lib/rspec_n/helpers/arguments_helper.rb
 - lib/rspec_n/helpers/core_ext/array.rb
 - lib/rspec_n/helpers/core_ext/string.rb
 - lib/rspec_n/helpers/time_helpers.rb
@@ -156,14 +143,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.20
 signing_key: 
 specification_version: 4
 summary: A ruby gem that runs RSpec N times.

data/.travis.yml

@@ -1,13 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6
-  - 2.7
-  - 3.0
-before_install: gem install bundler -v 2.2.17
-notifications:
-  email:
-    on_success: never # default: change
-    on_failure: never # default: always