rubocop_plus 2.2.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2a5a3f7096bc2cc65ad56ea55001eca69499179a70438ee5180daca45847d48
-  data.tar.gz: 7d54cf03fe39f2d52eb25a6cbe7e64fc96907d013010b23e557e3003a325157f
+  metadata.gz: 9c9a1c6966b574e5c3a72c6b74bd80834ead7de48fa82f66c6aa35f2fce35685
+  data.tar.gz: b4df45db1891c418608fe6dda375f8aa039d62dc759245e1349927970e5b6578
 SHA512:
-  metadata.gz: e6dc50ba8c07766287a025ef1fed3810cfbe958662360bb117cd258ce66b2dc3e0b14f1a076b209d98891de757f474548cf03198b02e4d78d812127877a2cae8
-  data.tar.gz: f88de6bb68e29536d8b08956e5790b0487825eac4a48171c0f22679b00bb564bad9d91d637893ff16f54419bbcb4f295430ca6669193c715a2a185d61811af25
+  metadata.gz: 25a6375aca381ac1da296c546d2142134ac00930263d83ceeb69f992ec4bda80beb234b8e2263a468e1da80c73f2f189b913ec5aaa91ca5e30929e5fbb909243
+  data.tar.gz: 06da6d5e5e7a5535cec1f4017c5d8bf78bde2d00e9a2d33bca915087e7aa23bd5650eb09df23e0d03ea2ac9ce78f3429e4afc156f9fbc3089f3aa6f620f954f4

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.6', '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.6']
+    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 exe/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 "Sucess: Found $count RuboCop issue(s), which is less than the limit of $RUBOCOP_ISSUE_THRESHOLD"
+          fi

data/CHANGELOG.md

@@ -1,6 +1,40 @@
 # CHANGELOG
 
-Issues are tracked at https://github.com/roberts1000/rubocop_plus/issues. Changes marked as **(Internal)** support  development or refactoring.
+Issues are tracked at https://github.com/roberts1000/rubocop_plus/issues. Issues marked as **(Internal)** only affect development.
+
+## 2.6.0 (Jan 09, 2022)
+
+1. [#170](../../issues/170): Use `rubocop-rspec` `2.7.0`.
+1. [#172](../../issues/172): Support Ruby 3.1. **(Internal)**
+1. [#174](../../issues/174): Use `rubocop-rails` `2.13.0`.
+1. [#176](../../issues/176): Use `rubocop-performance` `1.13.1`.
+1. [#178](../../issues/178): Use `rubocop` `1.24.1`.
+
+## 2.5.0 (Oct 31, 2021)
+
+1. [#153](../../issues/153): Use `rspec_starter` `~> 2.0`. **(Internal)**
+1. [#155](../../issues/155): Exclude `bin/yarn` and `spec/dummy/bin/yarn` for all cops.
+1. [#157](../../issues/157): Make the PR workflow execute `exe/rubo`. **(Internal)**
+1. [#159](../../issues/159): Use `rubocop` `1.22.3`.
+1. [#162](../../issues/162): Use `rubocop-performance` `1.12.0`.
+1. [#164](../../issues/164): Use `rubocop-rails` `2.12.4`.
+1. [#166](../../issues/166): Use `rubocop-rspec` `2.5.0`.
+
+## 2.4.0 (Aug 03, 2021)
+
+1. [#147](../../issues/147): Exclude `spec/dummy/config/environments` files for all cops.
+1. [#149](../../issues/149): Exclude `spec/dummy/config/puma.rb` file for all cops.
+
+## 2.3.0 (Jul 29, 2021)
+
+1. [#129](../../issues/129): Use `rubocop` `1.18.4`.
+1. [#131](../../issues/131): Remove Travis CI integration. **(Internal)**
+1. [#133](../../issues/133): Add GitHub action workflow to check pull requests. **(Internal)**
+1. [#135](../../issues/135): Use `rubocop-performance` `1.11.4`.
+1. [#137](../../issues/137): Use `rubocop-rails` `2.11.3`.
+1. [#139](../../issues/139): Use `rubocop-rake` `0.6.0`.
+1. [#141](../../issues/141): Use `rubocop-rspec` `2.4.0`.
+1. [#143](../../issues/143): Disable the `Style/StringLiterals` cop.
 
 ## 2.2.0 (May 16, 2021)
 

data/Gemfile

@@ -6,5 +6,5 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 group :development do
-  gem 'rspec_starter', "~> 1.5", require: false
+  gem 'rspec_starter', "~> 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,16 +1,13 @@
 # rubocop_plus
 
-`rubocop_plus` is a Ruby gem that wraps around the community [rubocop](https://github.com/bbatsov/rubocop) gem. It makes changes and enhancements to the base `rubocop` gem by altering configuration and code. All configuration changes can be found in the `config` folder.
+`rubocop_plus` is a Ruby gem that wraps around the [rubocop](https://github.com/bbatsov/rubocop) gem. It makes changes and enhancements to `rubocop` by altering configuration and code. All configuration changes can be found in the `config` folder.
 
-#### Disclaimer
+**Disclaimer:** rubocop_plus was built to store **my preferred** rubocop configuration and enhancements. **There is no association with the base rubocop project.** rubocop_plus was made public so it could be used by projects that I support, and to serve as a reference gem to anyone who wants to do something similar.
 
-`rubocop_plus` was built to store **my preferred** `rubocop` configuration and enhancements. **There is absolutely no association with the base rubocop project.** `rubocop_plus` was made public so it could be used by projects that I support, and to serve as a reference gem to anyone who wants to do something similar.
+## Versioning Strategy
 
-## Version Policy
-
-Releases are versioned using [semver 2.0.0](https://semver.org/spec/v2.0.0.html).
-
-Ruby versions that reach EOL will be removed without a major version bump.
+1. Releases are versioned using [semver 2.0.0](https://semver.org/spec/v2.0.0.html).
+1. Ruby versions that reach EOL are removed in a major or minor release.
 
 ## Supported Ruby Versions
 
@@ -18,43 +15,47 @@ Ruby 2.6.0+ is supported.
 
 ## Installation
 
-Install `rubocop_plus` manually by executing:
+Install rubocop_plus manually by executing:
 
     $ gem install rubocop_plus
 
-You can also place `rubocop_plus` into the `:development` group of your project's `Gemfile`:
+You can also add rubocop_plus to the `:development` group of your project's `Gemfile`:
 
 ```ruby
-gem 'rubocop_plus', group: :development
+group :development do
+  gem 'rubocop_plus', require: false
+end
 ```
 
-If the `rubocop` gem is listed in the `Gemfile`, remove it. `rubocop_plus` will install the version of `rubocop` that it wants to use.
+If you add rubocop_plus to your `Gemfile`, it is recommended that you use `require: false`. There's no need to load rubocop_plus files when your project runs.
+
+**Keep in mind**, if you place rubocop_plus in a project's `Gemfile`, it will **lock** your project to the version of rubocop_plus that gets written to the `Gemfile.lock`. If you're using a CI tool like Jenkins, this will likely make the CI tool use that same version - which is not always the desired outcome.
 
-Next, bundle the app:
+Next, remove the `rubocop` gem if it's listed in the `Gemfile`. rubocop_plus will install the version of rubocop that it needs.
+
+Bundle the app:
 
     $ bundle
 
-Initialize your project's `rubocop` configuration
+Initialize your project's rubocop configuration:
 
     $ rubo --init
 
-This will create a specially configured `.rubocop.yml` inside the project root.
-
-**Note:** Keep in mind, if you place `rubocop_plus` in a projects Gemfile, it will **lock** your project to the version of `rubocop_plus` that gets written to the Gemfile.lock file. If you're using a continuous integration platform, like Jenkins or Travis, this will likely restrict the CI tool to that same version - which is not always ideal. Some people prefer to have the CI platform **tell** the project which version of `rubocop_plus` to use. In that case, you should not put the `rubocop_plus` in the project's Gemfile.
+This will create a `.rubocop.yml` inside the project root. By default, this file has configuration that tells rubocop to look in the rubocop_plus gem for custom RuboCop configuration. You can add additional configuration to this file if you would like to make other changes to RuboCop.
 
 ## Usage
 
-`rubocop_plus` provides a `rubo` command that you can use run to invoke `rubocop` in a standard manner. It will write all output to the `rubocop` folder inside the project. You can run `rubo --help` to see a list of commands. If `rubocop_plus` is included the project's Gemfile, rubo will execute the locked version. Otherwise, it will execute the latest version on the system.
+rubocop_plus provides a `rubo` command that you can use run to invoke rubocop in a standard manner. It will write all output to the `rubocop/` folder inside the project. You can run `rubo --help` to see a list of commands. If rubocop_plus is included the project's Gemfile, rubo will execute the locked version. Otherwise, it will execute the latest version on the system.
 
 #### Total Violation Count
 
-The `rubo` command will create a `rubocop/total-violations-count.txt file` as part of the output. This file holds a single number that represents the total number of violations that were found by `rubocop`. This file was created so continuous integration tools like Jenkins or Travis could be configured to fail builds that have "too many" violations.
+The `rubo` command creates a `rubocop/total-violations-count.txt file` as part of the output. This file holds a single number that represents the total number of violations that were found by rubocop. This file was created so continuous integration tools like Jenkins could be configured to fail builds that have "too many" violations.
 
 ## Development
 
 ### Setup
 
-Checkout the repo, `cd` into the project and run:
+Checkout the repo, then `cd` into the project and run:
 
     $ bin/setup
 
@@ -66,25 +67,28 @@ Run the test suite:
 
 ### Start a Development Console
 
-Start an interactive prompt that will allow you to experiment:
+Start an interactive prompt that will allow you to experiment (choose either):
 
-    $ bin/console
+```bash
+$ bin/console  # for Pry
+$ rake console # for IRB
+```
 
 ### Workflow Advice
 
-The easiest way to develop with the gem locally is to `cd` into another ruby project that can serve as a test bed. From the sample project's root folder, execute `../path/to/rubocop_rspec/exe/rubo`.
+The easiest way to develop with the gem locally is to `cd` into another ruby project that can serve as a test bed. From the sample project's root folder, execute `/path/to/rubocop_plus/exe/rubo` to execute the development version of rubocop_plus.
 
 ### Release a New Version
 
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`. This will create a git tag for the version, push git commits and tags, and push the gem to [rubygems.org](https://rubygems.org).
+To release a new version, update the version number in `version.rb`, and then run `rake release`. This will create a git tag for the version, push git commits and tags, and push the gem to [rubygems.org](https://rubygems.org).
 
 ### Run rubocop_plus on Itself
 
-To run `rubocop_plus` on itself, `cd` to the root of `rubocop_plus` and run `exe/rubo`. If you just run `rubo`, you will invoke the installed version of `rubo` and not the version of `rubo` within the cloned project folder.
+To run rubocop_plus on itself, `cd` to the root of the `rubocop_plus` development folder and run `exe/rubo`. If you just run `rubo`, you will invoke the `rubo` for the latest **installed** rubocop_plus gem and not the version of `rubo` within the development folder.
 
 ## Contributing
 
-Contributions are welcome, but please be aware that `rubocop_plus` was created to serve the projects and teams that I directly support. Their needs and style preferences will always come first. To contribute, create an issue on the [GitHub Issue board](https://github.com/roberts1000/rubocop_plus/issues) and wait for feedback. Once the idea is approved, submit a Pull Request.
+Contributions are welcome, but please be aware that rubocop_plus was created to serve the projects and teams that I directly support. Their needs and style preferences will come first. To contribute, create an issue on the [GitHub Issue board](https://github.com/roberts1000/rubocop_plus/issues) and wait for feedback. Once the idea is approved, submit a Pull Request.
 
 ## License
 

data/Rakefile

@@ -5,8 +5,8 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
-desc "Start a console with rubocop_plus loaded"
+desc "Start an IRB console with rubocop_plus loaded"
 task :console do
-  exec "pry -r rubocop_plus -I ./lib"
-  # exec "irb -r rubocop_plus -I ./lib"
+  # exec "pry -r rubocop_plus -I ./lib"
+  exec "irb -r rubocop_plus -I ./lib"
 end

data/config/group/style.yml

@@ -53,6 +53,10 @@ Style/MixinUsage:
 Style/PreferredHashMethods:
   EnforcedStyle: verbose
 
+# See the commment for Style/StringLiterals.
+Style/QuotedSymbols:
+  Enabled: false
+
 # Style/StringLiterals enforces the use of single quotes around string literals. The major argument for using single quotes is
 # they should be faster than double quotes (which need to be parsed for possible uses of interpolation). Also, they help reveal
 # intention by alerting developers that there is no interpolation in the string. However, there is no performance difference

data/config/rubocop.yml

@@ -6,12 +6,18 @@ require:
 
 AllCops:
   Exclude:  # skip all of the following....
+    - bin/yarn # A 3rd-party auto-generated file
     - db/schema.rb  # An auto-generated file
     - spec/dummy/db/schema.rb # An auto-generated file
     - lib/tasks/cucumber.rake # A 3rd-party auto-generated file
     - vendor/**/* # Contains 3rd party libs; no need to check code that originated outside the project
     - node_modules/**/* # Yarn 3rd party dependencies; no need to check code that originated outside the project
     - client/**/* # It's mostly JavaScript, but it may contain 3rd party that was written outside of the project
+    - spec/dummy/bin/yarn # A 3rd-party auto-generated file
+    - spec/dummy/config/environments/production.rb # A 3rd-party auto-generated file
+    - spec/dummy/config/environments/development.rb # A 3rd-party auto-generated file
+    - spec/dummy/config/environments/test.rb # A 3rd-party auto-generated file
+    - spec/dummy/config/puma.rb # A 3rd-party auto-generated file
   NewCops: enable
 
 inherit_from:

data/exe/rubo

@@ -26,14 +26,14 @@ command = Cri::Command.define do
   usage       'rubo [options]'
   # aliases     :ds, :stuff
   # summary     'foo'
-  description 'rubo is an executable installed by the rubocop_plus gem.  It invokes rubocop with a custom set of ' \
-    "rules.  The following status codes are returned:\n\n" \
-    "STATUS CODES\n\n" \
-    "0 - rubocop ran and results were written to the 'rubocop' folder........\n" \
-    "1 - the project root does not contain a .rubocop.yml file...............\n" \
-    "2 - the .rubocop.yml file does not have the correct content.............\n" \
-    "3 - the 'rubocop' command cound not be found (likely due to missing gem)\n" \
-    "4 - the output from the 'rubo' command is missing or corrupt............\n"
+  description "rubo is an executable installed by the rubocop_plus gem.  It invokes rubocop with a custom set of " \
+              "rules.  The following status codes are returned:\n\n" \
+              "STATUS CODES\n\n" \
+              "0 - rubocop ran and results were written to the 'rubocop' folder........\n" \
+              "1 - the project root does not contain a .rubocop.yml file...............\n" \
+              "2 - the .rubocop.yml file does not have the correct content.............\n" \
+              "3 - the 'rubocop' command cound not be found (likely due to missing gem)\n" \
+              "4 - the output from the 'rubo' command is missing or corrupt............\n"
 
   flag :h, :help, 'show help for this command' do |_value, cmd|
     puts cmd.help

data/lib/rubocop_plus/version.rb

@@ -1,4 +1,4 @@
 module RubocopPlus
-  VERSION = "2.2.0".freeze
-  RUBOCOP_VERSION = '1.14.0'.freeze
+  VERSION = "2.6.0".freeze
+  RUBOCOP_VERSION = '1.24.1'.freeze
 end

data/rubocop_plus.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "cri", "~> 2.0"
   spec.add_dependency "rubocop", RubocopPlus::RUBOCOP_VERSION.to_s
-  spec.add_dependency "rubocop-performance", "1.11.3"
-  spec.add_dependency "rubocop-rails", "2.10.1"
-  spec.add_dependency "rubocop-rake", "0.5.1"
-  spec.add_dependency "rubocop-rspec", "2.3.0"
+  spec.add_dependency "rubocop-performance", "1.13.1"
+  spec.add_dependency "rubocop-rails", "2.13.0"
+  spec.add_dependency "rubocop-rake", "0.6.0"
+  spec.add_dependency "rubocop-rspec", "2.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_plus
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.6.0
 platform: ruby
 authors:
 - roberts1000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,70 +86,70 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.24.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.3
+        version: 1.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.3
+        version: 1.13.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.1
+        version: 2.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.1
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.7.0
 description: Enhancements to the standard rubocop gem.
 email:
 - roberts@corlewsolutions.com
@@ -158,10 +158,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/check_pull_request.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: Enhancements to the standard rubocop gem.

data/.travis.yml

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