rubocop_plus 1.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9339fafc44664971f7130176d7f8e219300d6040c129571c5133a6899b294c54
+  data.tar.gz: f11445ad0bc0ad86dadcdf98809f9973449b1fdd4f3d4a80b36d1f6d7d9f7930
+SHA512:
+  metadata.gz: 4121486fdc872b3a3eefbc04a0d77cfe69bbc257b46aa53dfbbd428729f0fae36b71584b3a6824dba908a9d205169fde7b33a8b9a5734318dd96d308828b7c5e
+  data.tar.gz: 885d103f4ee897ede61a19be1560b8dcf9efb4d9aa13585a8d24c06a37b7b553dfb3b8dff1bb3370b007191faf6cb3f4ee1264287b959274a5e89b5cc6aa0016

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore output from rspec_n gem
+rspec_n_iteration.*
+
+/rubocop/
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - config/rubocop.yml
+
+Rails:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4
+notifications:
+  email:
+    on_success: never # default: change
+    on_failure: never # default: always

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+# CHANGELOG
+
+Issues are tracked at https://github.com/roberts1000/rubocop_plus/issues. Changes marked as **(Internal)** support  development or refactoring.
+
+## 1.11.0 (Jan 31, 2020)
+
+1. [#58](../../issues/58): Disable the `RSpec/FilePath` cop.
+
+## 1.10.0 (Jan 31, 2020)
+
+1. [#54](../../issues/54): Disable the `RSpec/DescribedClass` cop.
+
+## 1.9.0 (Jan 31, 2020)
+
+1. [#50](../../issues/50): Allow `feature` and `scenario` with the `Capybara/FeatureMethods` cop.
+
+## 1.8.0 (Jan 31, 2020)
+
+1. [#46](../../issues/46): Make `RSpec/NotToNot` use `to_not`.
+
+## 1.7.0 (Jan 31, 2020)
+
+1. [#37](../../issues/37): Use lists in the `CHANGELOG.md`. **(Internal)**
+1. [#39](../../issues/39): Add Ruby 2.7 support.
+1. [#42](../../issues/42): Disable `RSpec/InstanceVariable`.
+
+## 1.6.0 (Jan 13, 2020)
+
+1. [#29](../../issues/29): Use new rspec_starter interface.
+1. [#31](../../issues/31): Disable the `RSpec/MultipleExpectations` cop.
+1. [#33](../../issues/33): Set `RSpec/ExampleLength` `Max` to 8.
+
+## 1.5.0 (Jan 13, 2020)
+
+1. [#25](../../issues/25): Add `rubocop-rspec ~> 1.37.1`.
+
+## 1.4.0 (Jan 07, 2020)
+
+1. [#21](../../issues/21): Use `rubocop 0.79.0`.
+
+## 1.3.0 (Jan 03, 2020)
+
+1. [#13](../../issues/13): Use `rubocop 0.78.0`.
+1. [#15](../../issues/15): Use `rspec ~> 3.9.0` for development. **(Internal)**
+1. [#17](../../issues/17): Use `rake ~> 13.0` for development. **(Internal)**
+
+## 1.2.0 (Jan 02, 2020)
+
+1. [#9](../../issues/9): Use `rubocop-performance ~> 1.5.2`.
+
+## 1.1.0 (Dec 29, 2019)
+
+1. [#5](../../issues/5): Use `rubocop-rails ~> 2.4.1`.
+
+## 1.0.0 (Aug 19, 2019)
+
+1. [#1](../../issues/1): Create initial release using rubocop 0.74.0.

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rubocop_plus.gemspec
+gemspec
+
+group :development do
+  gem 'rspec_starter', "~> 1.5", require: false
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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
+in the Software without restriction, including without limitation the rights
+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 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.

data/README.md

@@ -0,0 +1,73 @@
+# rubocop_plus
+
+rubocop_plus is a gem that wraps around the community [rubocop gem](https://github.com/bbatsov/rubocop).  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.
+
+#### Disclaimer
+
+rubocop_plus was built as a place to store **my preferred** rubocop configuration and enhancements, in a single location.  **There is absolutely no association with the base rubocop project.**  rubocop_plus was made public so it could be shared between multiple organizations that I support, and to serve as a reference gem to anyone who wants to do some similar.
+
+## Version Policy
+
+Releases are versioned using [semver 2.0.0](https://semver.org/spec/v2.0.0.html).
+
+## Installation
+
+You can install rubocop_plus manually by performing
+
+    $ gem install rubocop_plus
+
+You can also place rubocop_plus in your project's Gemfile
+
+```ruby
+gem 'rubocop_plus'
+```
+
+Remove rubocop from the project's Gemfile and Gemfile.lock.  rubocop_plus will install the version of rubocop that it wants to use.
+
+Then run
+
+    $ bundle
+
+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.
+
+## 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.
+
+#### 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.
+
+#### Specifying the Correct Ruby
+
+rubocop needs to know which version of ruby to use to have a basis for evaluating your application.  rubocop_plus does not perform any magic here, but we offer a recommendation on how to proceed:
+
+1. Make sure your `.rubocop.yml` does not include the `TargetRubyVersion` key under `AllCops:`.  If it is present, rubocop will always use that value.
+1. Create a `.ruby-version` file and define your ruby version inside this file.  The file should have a single value specifying the full ruby version (i.e 2.5.0).
+1. Specify the `ruby` version in the Gemfile by adding `ruby File.read('.ruby-version', mode: 'rb').chomp` to the Gemfile.  This will avoid duplication by reading the value out of the `.ruby-version` file.
+
+As of rubocop 0.52.1 (01/15/2018), rubocop does not look at the Gemfile to determine the ruby version.  Hopefully that will change in the future.  Until then, rubocop will pull the value out of the `.ruby-version` file and other services can read the value from `.ruby-version` or the `Gemfile`.
+
+## 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 an interactive prompt that will allow you to experiment.
+
+The easiest way to test the gem locally is to `cd` into a ruby project that can serve as a test bed.  From the sample project's root folder, execute `rubo` by typing the relative (or full path) to the `rubo` command where you cloned the rubocop_plus project.  If your sample_app and rubocop_plus folder were in the same parent folder, your command would look like `../rubocop_plus/exe/rubo`.
+
+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).
+
+To run rubocop_plus on itself, `cd` to the root of `rubocop_plus` and run `exe/rubo`. If you just run `rubo`, you'll be invoking the version of `rubo` that was installed by the latest installed version of the gem...not the version of `rubo` within the development folder of the gem.
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "pry -r rubocop_plus -I ./lib"
+  # exec "irb -r rubocop_plus -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop_plus"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/start_rspec

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+# Execute this script to run RSpec for the app.
+# To run all specs, navigate to the application's root folder and execute
+#   bin/start_rspec
+# rspec_starter takes command line options and forwards unknown options to rspec
+#   bin/start_rspec --no-prep-db spec/features
+# See the help output for more advanced ways to run the script
+#   bin/start_rspec --help
+
+require "bundler/setup"
+require "rspec_starter"
+
+# The path to the application's root folder.
+APP_ROOT = Pathname.new File.expand_path('..', __dir__)
+
+# Create a custom task. For more information about custom tasks, see
+# https://github.com/roberts1000/rspec_starter. Once defined, add
+# 'task :my_custom_task' to the start block to execute.
+#
+# class MyCustomTask < RspecStarterTask
+#   # Specify a message to show users when the task executes.
+#   def starting_message
+#     "Executing My Custom Task"
+#   end
+#
+#   # Execute task code.
+#   def execute
+#   end
+# end
+
+# Tasks are run from the top down.
+RspecStarter.start do
+  task :verify_display_server
+  task :remove_tmp_folder
+  task :start_rspec
+end

data/config/group/layout.yml

@@ -0,0 +1,81 @@
+# Layout/ArgumentAlignment checks alignment of arguments in multi-line method calls. rubocop defaults to `with_first_parameter`
+# which expects:
+#
+#     method_call(a,
+#                 b)
+#
+# rubocop_plus prefers the indented style
+#
+#     method_call(a,
+#       b)
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation # with_first_parameter is the default
+
+# Layout/AlignParameters checks alignment of parameters in multi-line method calls. rubocop defaults to `with_first_parameter`
+# which expects:
+#
+#     method_call(a,
+#                 b)
+#
+# rubocop_plus prefers the indented style
+#
+#     method_call(a,
+#       b)
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation # with_first_parameter is the default
+
+# This cop checks the indentation of the right hand side operand in operations that span more than one line.
+# Rubocop defaults to 'aligned'.
+#
+#   if first_method +
+#      second_method +
+#      third_method
+#   end
+#
+# Prefer the 'indented' style.
+#
+#   if first_method +
+#        second_method +
+#        third_method
+#   end
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented # aligned is the default
+  IndentationWidth: 3 # the default seems to be 2 which makes methods indent 1 space past the first method
+
+# Layout/MultilineMethodCallIndentation checks the indentation of chained method calls. rubocop defaults to 'aligned':
+#
+#   SomeReallyExceptionallyLongClassName.some_exceptionally_long_method_number_1(plus_variable_one, variable_two_...)
+#                                       .some_exceptionally_long_method_number_2(plus_variable_one, variable_two_...)
+#
+# This can easily cause line length length violations (particularly with ActiveRecord queries), plus it wastes alot of white
+# space at the beginning. The 'indented' style is preferred since it is more compact (although it uses an extra line).
+#
+#   SomeReallyExceptionallyLongClassName
+#     .some_exceptionally_long_method_number_1(plus_variable_one, variable_two_...)
+#     .some_exceptionally_long_method_number_2(plus_variable_one, variable_two_...)
+#
+# This has the added benefit of oriented the method calls directly under the object which is receiving the message, which
+# is more readable.
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# This cop checks for spaces around the '=' sign in a method's attribute list. Prefer no spaces since it more compact.
+#
+#   = Recommended =                 = Default =
+#   def the_method(foo=1)     vs    def the_method(foo = 1)
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# Metrics/LineLength checks the length of lines. The 80 character default to too restrictive. It does have the advantage of
+# saving horizontal screen space, which is useful for some layouts/workflows. However, it has some issues:
+#   1. It doesn't take advantage of available horizontal screen width, which is widely available due to the proliferation
+#      wide screen monitors.
+#   2. It adds more lines to a class, which makes it more likely that rubocop's ClassLength cop will be exceeded.
+#   3. Ruby code only represents part of a web application.  It is acceptable for HTML in the view to frequently exceed 80
+#      characters and it is typically uses word-wrap which doesn't use ANY width limits. View code represents a large portion
+#      of an application; if it is going to regularly exceed 80, why restrict the Ruby code to 80?
+#   4. Many other projects, like Rails, exceed 80 so it doesn't appear to be a hard standard (at least not anymore).
+# As a result, a larger line length was adopted to strike a better balance between, readability, scrolling frequency and
+# layout concerns.
+Layout/LineLength:
+  Max: 130 # default is 80.

data/config/group/lint.yml

@@ -0,0 +1,4 @@
+# Some 3rd party bin files suppress exceptions. Ignore them since the code doesn't originate in the project.
+Lint/SuppressedException:
+  Exclude:
+    - bin/spring

data/config/group/metrics.yml

@@ -0,0 +1,29 @@
+# This cop checks that the ABC size of methods is not higher than the configured maximum. The current default is a little
+# low and produces many false positives.
+Metrics/AbcSize:
+  Max: 40 # The default is 15.
+
+# Metrics/BlockLength checks the lines in a block. The default is 25.
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/* # The RSpec DSL uses large blocks.
+    - db/migrate/**/* # The Rails migrate folder has large blocks.
+    - config/routes.rb # The Rails routes file is one large block.
+
+# Metrics/ClassLength checks the number of lines in a class.
+Metrics/ClassLength:
+  Max: 200 # 100 is the default which is too restrictive.
+
+# Metrics/MethodLength checks the number of lines in a method.
+Metrics/MethodLength:
+  Max: 15
+  Exclude:  # skip all of the following....
+    - db/migrate/**/*
+
+# Metrics/ModuleLength checks the number of lines in a module.
+Metrics/ModuleLength:
+  Max: 200 # 100 is the default which is too restrictive.
+
+# Metrics/ParameterLists validates the number of parameters that a method can take.
+Metrics/ParameterLists:
+  Max: 7 # The default limit is 5 which is a bit restrictive.

data/config/group/naming.yml

@@ -0,0 +1,4 @@
+# This cop checks for the use of 'is_', 'has_' and 'have_' in front of methods.  By default, it recommends that they be removed.
+# Predicates are useful in many situations. It's conterproductive to enforce a single style.
+Naming/PredicateName:
+  Enabled: false

data/config/group/rails.yml

@@ -0,0 +1,7 @@
+# Rails/FilePath ensures Rails.root.join('path', 'to') is used instead of "#{Rails.root}/path/to". This cop isn't necessary
+# since Ruby will automatically convert file path separators.
+Rails/FilePath:
+  Enabled: false
+
+Performance/RedundantMerge:
+  Enabled: false

data/config/group/rspec.yml

@@ -0,0 +1,37 @@
+# Blocks the use of Capybara style methods like `feature`, `scenario, `given`, etc... Allow the use of some of these methods.
+# https://github.com/rubocop-hq/rubocop-rspec/blob/v1.37.1/lib/rubocop/cop/rspec/capybara/feature_methods.rb
+Capybara/FeatureMethods:
+  EnabledMethods:
+    - feature
+    - scenario
+
+# Checks if the first element of a describe block is a class and if described_class is used in examples. Prefer the flexibility
+# of using strings with `describe` and putting the described class directly in an example.
+# https://github.com/rubocop-hq/rubocop-rspec/blob/v1.37.1/lib/rubocop/cop/rspec/described_class.rb
+RSpec/DescribedClass:
+  Enabled: false
+
+# Checks the number of lines in the spec example. The default is 5, which frequently can be a bit tight.
+# https://github.com/rubocop-hq/rubocop-rspec/blob/v1.37.1/lib/rubocop/cop/rspec/example_length.rb#L28
+RSpec/ExampleLength:
+  Max: 8
+
+# Checks that spec file paths are consistent with the test subject. Cop is too strict.
+# https://github.com/rubocop-hq/rubocop-rspec/blob/v1.37.1/lib/rubocop/cop/rspec/file_path.rb
+RSpec/FilePath:
+  Enabled: false
+
+# Checks for the use of instance variables in specs. Prefer allowing instance variables ('let' should be used when possible).
+# https://github.com/rubocop-hq/rubocop-rspec/blob/v1.37.1/lib/rubocop/cop/rspec/instance_variable.rb
+RSpec/InstanceVariable:
+  Enabled: false
+
+# Checks for multiple expectations in a test. Prefer allowing any number of expecations.
+# https://github.com/rubocop-hq/rubocop-rspec/blob/v1.37.1/lib/rubocop/cop/rspec/multiple_expectations.rb#L48
+RSpec/MultipleExpectations:
+  Enabled: false
+
+# Checks for the use of not_to instead of to_not. Prefer to_not.
+# https://github.com/rubocop-hq/rubocop-rspec/blob/v1.37.1/lib/rubocop/cop/rspec/not_to_not.rb
+RSpec/NotToNot:
+  EnforcedStyle: to_not