rspec_n 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d531fc0cb07d13bf1700f6809c0566cc72dfe887af684b5493821a1d60e0956
-  data.tar.gz: 6bfe142183b285877bb067b1049bcc02139050d69ea123352904db52b34cfce7
+  metadata.gz: 9ea1bbeb02bb4db25b1cf60151cc6d84023734914875d0b4f20d2fa8e9d25bac
+  data.tar.gz: db723b51e76c3d2d80f6875bd0706fd1dd720e0c067f9b31e1521852e15130e7
 SHA512:
-  metadata.gz: ab882b6d984ef3565d26c4d72357802a6daf058374c175e10b267f1bfcfb825e50f4ddcbda66d96dbebadeeecee7d4ac2f4c89d53276b217804436adbc300ef6
-  data.tar.gz: 681e5b4f42152b285174535231ef0d07054fefa57c9fcbabdc1e23ad466ebcf3d8e84dd5829afd8b91db733636fd9d6e50b5d4986d99493b17122a6406a8092b
+  metadata.gz: 7dfc98c7a039a9c334f87dba49b80b97167b7b30bfe55a22912a66afcf51fd080f2f8e6582deac86447ce7bfb8a1068288604b66eb1d09e119c4a143ecbd019d
+  data.tar.gz: c152cc6b58f3c0a9948e5486467eb8eaeb39d4e21307a198897de0480bb97e982fad1ab2faa58a1494185c1f826b6b7ae927cc586a6f60306ef48b7a92f1229d

data/.github/pull_request_template.md

@@ -0,0 +1,3 @@
+<!-- Replace XYZ with the related GitHub issue number -->
+
+Closes #XYZ

data/.github/workflows/check_pull_request.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby
@@ -30,7 +30,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7']
+        ruby-version: ['3.0']
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby

data/.rubocop.yml

@@ -12,7 +12,7 @@ inherit_gem:
 # do not attempt to merge these settings with their defaults. Long term changes should be ported to the rubocop_plus gem.
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -2,8 +2,17 @@
 
 Issues are tracked at https://github.com/roberts1000/rspec_n/issues. Issues marked as **(Internal)** only affect development.
 
+## 1.6.0 (Feb 19, 2024)
+
+1. [#105](../../issues/105): Use `colorize ~> 1.1.0`. **(Internal)**
+1. [#108](../../issues/108): Remove Ruby 2.7 support.
+1. [#110](../../issues/110): Add simple PR template.
+1. [#112](../../issues/112): Add Ruby 3.2 support.
+1. [#114](../../issues/114): Add Ruby 3.3 support.
+
 ## 1.5.0 (Aug 28, 2022)
 
+1. [#53](../../issues/53): Add support for a config file.
 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.

data/Gemfile

@@ -6,3 +6,10 @@ gemspec
 group :development do
   gem 'rubocop_plus', '~> 2.0', require: false
 end
+
+group :develoment, :test do
+  gem 'bundler', '~> 2.0'
+  gem 'pry', '~> 0.14.0'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.0'
+end

data/README.md

@@ -4,6 +4,15 @@ rspec_n is a Ruby gem that makes it easy to run a project's RSpec test suite N t
 
 ![example](https://user-images.githubusercontent.com/2053901/53691471-c6956880-3d4c-11e9-8248-68bbb4c24786.png)
 
+#### Automatic Command Selection
+
+rspec_n inspects files in your project and determines 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`.
+
+**Note:** You can override this behavior by using the `-c` option, which lets you specify your own command. See the [Use a Custom Command to Start RSpec](#Use-a-Custom-Command-to-Start-RSpec) section for more info.
+
 ## Versioning Strategy
 
 Releases are versioned using [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) with the following caveats:
@@ -12,7 +21,7 @@ Releases are versioned using [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html)
 
 ## Supported Ruby Versions
 
-Ruby 2.7, 3.0 and 3.1.
+Ruby 3.0+ is supported.
 
 ## Installation
 
@@ -28,7 +37,7 @@ Add the following to your project's `.gitignore` to exclude the output generated
 
 #### Usage in a Gemfile
 
-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.
+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 command line tool and isn't tested for compatibility inside other apps.
 
 ```ruby
 gem 'rspec_n', require: false
@@ -36,13 +45,15 @@ gem 'rspec_n', require: false
 
 ## Usage
 
+### Basic Usage
+
 The simplest way to run rspec_n is to give it a positive integer which tells it how many times to run RSpec:
 
     $ rspec_n 5
 
 As iterations complete, summary output is sent to the screen and detailed output is written to files (in the project's root).
 
-To target specific specs, provide one or more paths. You can do anything you would normally do when giving paths to RSpec:
+To target specific specs, provide one or more paths. You can do anything you would normally do when passing 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
@@ -57,29 +68,7 @@ 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:
-
-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 a 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:
 
@@ -89,20 +78,43 @@ There are a couple points to consider:
 
 1. Wrap your entire command in a single or double quoted string.
 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. 
+1. rspec_n was created to help discover flaky test suites so it will add `--order rand` to your custom command (which gets passed to RSpec and causes RSpec to run tests randomly). If you need to change the test order, you must add the `--order defined` or `--order project` options to the control the order like this:
 
-#### Control File Output
+    ```
+    $ rspec_n 5 -c 'rm -rf tmp && bundle exec rspec' --order defined
+    ```
+   
+### Control the File Output
 
-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 writes output to the project's root folder, for each iteration, to files with the iteration number in the name (`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 to move those files to another location if you want to save them.
 
-#### Stop on First Failure
+### Stop on First Failure
 
 You can tell rspec_n to abort the first time an iteration fails by using the `-s` flag. All remaining iterations are skipped.
 
+### Run Specs in Parallel
+
+rspec_n doesn't directly support running specs in parallel, however, you should be able to use the `-c` option to pass a rspec_n the command you use to run parallel specs.
+
+## Configuration
+
+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:
+
+```text
+--no-file
+-s
+--order defined
+-c "rm -rf tmp && bundle exec rspec"
+```
+
+The config file can be multi line or single line.
+
 ## Understanding the Results
 
 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`.

data/lib/rspec_n/runner.rb

@@ -46,7 +46,7 @@ module RspecN
     def run_tests
       found_failure = false
 
-      @runs.each do |_iteration, run|
+      @runs.each_value do |run|
         next run.skip if @input.stop_fast && found_failure
 
         run.start_clock

data/lib/rspec_n/version.rb

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

data/rspec_n.gemspec

@@ -32,13 +32,8 @@ 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.7.0'
+  spec.required_ruby_version = '>= 3.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_dependency "colorize", "~> 0.8.0"
+  spec.add_dependency "colorize", "~> 1.1.0"
   spec.add_dependency "cri", "~> 2.15.3"
 end

metadata

@@ -1,85 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec_n
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - roberts1000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: cri
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +46,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
 - ".github/workflows/check_pull_request.yml"
 - ".gitignore"
 - ".rspec"
@@ -143,14 +88,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: A ruby gem that runs RSpec N times.