rubocop-lts 4.2.0 → 4.3.1

data/RUBOCOP.md

@@ -0,0 +1,71 @@
+# RuboCop Usage Guide
+
+## Overview
+
+A tale of two RuboCop plugin gems.
+
+### RuboCop Gradual
+
+This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
+
+### RuboCop LTS
+
+This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
+RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
+
+## Checking RuboCop Violations
+
+To check for RuboCop violations in this project, always use:
+
+```bash
+bundle exec rake rubocop_gradual:check
+```
+
+**Do not use** the standard RuboCop commands like:
+- `bundle exec rubocop`
+- `rubocop`
+
+## Understanding the Lock File
+
+The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
+
+1. Prevent new violations while gradually fixing existing ones
+2. Track progress on code style improvements
+3. Ensure CI builds don't fail due to pre-existing violations
+
+## Common Commands
+
+- **Check violations**
+    - `bundle exec rake rubocop_gradual`
+    - `bundle exec rake rubocop_gradual:check`
+- **(Safe) Autocorrect violations, and update lockfile if no new violations**
+  - `bundle exec rake rubocop_gradual:autocorrect`
+- **Force update the lock file (w/o autocorrect) to match violations present in code**
+  - `bundle exec rake rubocop_gradual:force_update`
+
+## Workflow
+
+1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
+   a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
+2. If there are new violations, either:
+   - Fix them in your code
+   - Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
+3. Commit the updated `.rubocop_gradual.lock` file along with your changes
+
+## Never add inline RuboCop disables
+
+Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
+
+- Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
+- Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
+  - `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
+  - If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
+
+In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
+
+## Benefits of rubocop_gradual
+
+- Allows incremental adoption of code style rules
+- Prevents CI failures due to pre-existing violations
+- Provides a clear record of code style debt
+- Enables focused efforts on improving code quality over time

data/SECURITY.md

@@ -2,40 +2,20 @@
 
 ## Supported Versions
 
-Major even versions are supported.
+| Version  | Supported |
+|----------|-----------|
+| 4.3.latest | ✅         |
 
-Major odd versions are not supported, and no further odd major releases are planned.
+## Security contact information
 
-| Version   | Supported |
-|-----------|-----------|
-| 0.latest  | ✅         |
-| 1.latest  | ❌         |
-| 2.latest  | ✅         |
-| 3.latest  | ❌         |
-| 4.latest  | ✅         |
-| 5.latest  | ❌         |
-| 6.latest  | ✅         |
-| 7.latest  | ❌         |
-| 8.latest  | ✅         |
-| 9.latest  | ❌         |
-| 10.latest | ✅         |
-| 11.latest | ❌         |
-| 12.latest | ✅         |
-| 13.latest | ❌         |
-| 14.latest | ✅         |
-| 15.latest | ❌         |
-| 16.latest | ✅         |
-| 17.latest | ❌         |
-| 18.latest | ✅         |
-| 19.latest | ❌         |
-| 20.latest | ✅         |
-| 21.latest | ❌         |
-| 22.latest | ✅         |
-| 23.latest | ❌         |
-| 24.latest | ✅         |
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
 
-## Reporting a Vulnerability
+## Additional Support
 
-Peter Boling is the primary maintainer of this gem. Please find a way
-to [contact him directly](https://railsbling.com/contact) to report the issue. Include as much relevant information as
-possible.
+If you are interested in support for versions older than the latest release,
+please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
+or find other sponsorship links in the [README].
+
+[README]: README.md

data/certs/pboling.pem

@@ -0,0 +1,27 @@
+-----BEGIN CERTIFICATE-----
+MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
+ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
+DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAruUoo0WA
+uoNuq6puKWYeRYiZekz/nsDeK5x/0IEirzcCEvaHr3Bmz7rjo1I6On3gGKmiZs61
+LRmQ3oxy77ydmkGTXBjruJB+pQEn7UfLSgQ0xa1/X3kdBZt6RmabFlBxnHkoaGY5
+mZuZ5+Z7walmv6sFD9ajhzj+oIgwWfnEHkXYTR8I6VLN7MRRKGMPoZ/yvOmxb2DN
+coEEHWKO9CvgYpW7asIihl/9GMpKiRkcYPm9dGQzZc6uTwom1COfW0+ZOFrDVBuV
+FMQRPswZcY4Wlq0uEBLPU7hxnCL9nKK6Y9IhdDcz1mY6HZ91WImNslOSI0S8hRpj
+yGOWxQIhBT3fqCBlRIqFQBudrnD9jSNpSGsFvbEijd5ns7Z9ZMehXkXDycpGAUj1
+to/5cuTWWw1JqUWrKJYoifnVhtE1o1DZ+LkPtWxHtz5kjDG/zR3MG0Ula0UOavlD
+qbnbcXPBnwXtTFeZ3C+yrWpE4pGnl3yGkZj9SMTlo9qnTMiPmuWKQDatAgMBAAGj
+fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQE8uWvNbPVNRXZ
+HlgPbc2PCzC4bjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
+A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
+ggGBAJbnUwfJQFPkBgH9cL7hoBfRtmWiCvdqdjeTmi04u8zVNCUox0A4gT982DE9
+wmuN12LpdajxZONqbXuzZvc+nb0StFwmFYZG6iDwaf4BPywm2e/Vmq0YG45vZXGR
+L8yMDSK1cQXjmA+ZBKOHKWavxP6Vp7lWvjAhz8RFwqF9GuNIdhv9NpnCAWcMZtpm
+GUPyIWw/Cw/2wZp74QzZj6Npx+LdXoLTF1HMSJXZ7/pkxLCsB8m4EFVdb/IrW/0k
+kNSfjtAfBHO8nLGuqQZVH9IBD1i9K6aSs7pT6TW8itXUIlkIUI2tg5YzW6OFfPzq
+QekSkX3lZfY+HTSp/o+YvKkqWLUV7PQ7xh1ZYDtocpaHwgxe/j3bBqHE+CUPH2vA
+0V/FwdTRWcwsjVoOJTrYcff8pBZ8r2MvtAc54xfnnhGFzeRHfcltobgFxkAXdE6p
+DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
+L9nRqA==
+-----END CERTIFICATE-----

data/config/rails.yml

@@ -1,4 +1,4 @@
 inherit_from: ./base.yml
 
 inherit_gem:
-  rubocop-ruby2_0: rubocop-lts/rails.yml
+  rubocop-ruby1_8: rubocop-lts/rails.yml

data/config/rails_rspec.yml

@@ -2,4 +2,4 @@
 inherit_from: ./base.yml
 
 inherit_gem:
-  rubocop-ruby2_0: rubocop-lts/rails_rspec.yml
+  rubocop-ruby1_8: rubocop-lts/rails_rspec.yml

data/config/rspec.yml

@@ -1,4 +1,4 @@
 inherit_from: ./base.yml
 
 inherit_gem:
-  rubocop-ruby2_0: rubocop-lts/rspec.yml
+  rubocop-ruby1_8: rubocop-lts/rspec.yml

data/config/ruby.yml

@@ -1,4 +1,4 @@
 inherit_from: ./base.yml
 
 inherit_gem:
-  rubocop-ruby2_0: rubocop-lts/ruby.yml
+  rubocop-ruby1_8: rubocop-lts/ruby.yml

data/config/ruby_rspec.yml

@@ -2,4 +2,4 @@
 inherit_from: ./base.yml
 
 inherit_gem:
-  rubocop-ruby2_0: rubocop-lts/ruby_rspec.yml
+  rubocop-ruby1_8: rubocop-lts/ruby_rspec.yml

data/config/rubygem.yml

@@ -1,4 +1,4 @@
 inherit_from: ./base.yml
 
 inherit_gem:
-  rubocop-ruby2_0: rubocop-lts/rubygem.yml
+  rubocop-ruby1_8: rubocop-lts/rubygem.yml

data/config/rubygem_rspec.yml

@@ -2,4 +2,4 @@
 inherit_from: ./base.yml
 
 inherit_gem:
-  rubocop-ruby2_0: rubocop-lts/rubygem_rspec.yml
+  rubocop-ruby1_8: rubocop-lts/rubygem_rspec.yml

data/lib/rubocop/lts/version.rb

@@ -3,7 +3,8 @@
 module Rubocop
   module Lts
     module Version
-      VERSION = "4.2.0"
+      VERSION = "4.3.1"
     end
+    VERSION = Version::VERSION # Traditional Constant Location
   end
 end

data/lib/rubocop/lts.rb

@@ -1,8 +1,9 @@
+# encoding: utf-8
 # frozen_string_literal: true
 
 # external libs
 require "version_gem"
-require "rubocop/ruby2_0"
+require "rubocop/ruby1_8"
 
 require_relative "lts/version"
 
@@ -11,7 +12,7 @@ module Rubocop
     class Error < StandardError; end
 
     module_function def install_tasks
-      Rubocop::Ruby20.install_tasks
+      Rubocop::Ruby18.install_tasks
     end
   end
 end

data/sig/rubocop/lts/version.rbs

@@ -0,0 +1,8 @@
+module Rubocop
+  module Lts
+    module Version
+      VERSION: String
+    end
+    VERSION: String
+  end
+end

data/sig/rubocop/lts.rbs

@@ -1,7 +1,6 @@
 module Rubocop
   module Lts
     module Version
-      VERSION: String
       # See the writing guide of rbs: https://github.com/ruby/rbs#guides
     end
   end