rubocop-lts 10.0.1 → 11.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (10) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -73
  3. data/README.md +266 -31
  4. data/SECURITY.md +0 -11
  5. data/lib/rubocop/lts/version.rb +1 -1
  6. data/rubocop-lts.yml +1 -1
  7. data/spec/config/rspec/rspec_core.rb +13 -0
  8. data/spec/rubocop/lts_spec.rb +7 -0
  9. data/spec/spec_helper.rb +7 -0
  10. metadata +19 -13
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 90af3b50241ba9d819e16a52b9f76fe92d70af87be7622d9e0d00c6890d23fb6
4
- data.tar.gz: 40e4c0e936388631a27bf64838cdc08a876ab92bf6625456c584c941e5b2b309
3
+ metadata.gz: e226a3b918d1e382d5226befbbb41dda1cc4e70bff9f81ca75285af1afd3c787
4
+ data.tar.gz: e0abd6da490a7d7620759205ca487a660be9f7c8a3bedbeeff13d134588034a1
5
5
  SHA512:
6
- metadata.gz: 4c57979935b057d343ec249cd2b8e99d274e41fe0a187e5e399764bb03b45cf68a0314d8298f1884f366ab720206ade9a1d7068657b4c91ab787776b118c3dd4
7
- data.tar.gz: 46f9b4a1f22cd07293f73b59788eb1617a0b3ead3eea8358b1966fc8a130f59a21a02123014751a7852dbd06b92410b8827714e57d759f021918a599caf7e5f1
6
+ metadata.gz: c741de0603b0f9b032f926edd1ddd3ff447f862c322e1aa11d69f6450fef1a14663637df0aea85dbfe636ac02d2a912050ccfefe5bf2a9f52c55602639f71f45
7
+ data.tar.gz: 774c57599dc4270e2c04d9c59547811d5ad4af50a49d9affb49d2c9815a556021bff0a68697cf4497d11abe1fa4c1e26f3c67b572c361891dde288d2a12d0130
data/CHANGELOG.md CHANGED
@@ -13,58 +13,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
13
13
 
14
14
  ### Removed
15
15
 
16
- ## [10.0.1] - 2022-06-09
17
- ### Fixed
18
- - Allow install up to Ruby < 4, which allows running against current Ruby HEAD @ 3.2-dev
16
+ ## [11.0.0] - 2022-05-23
19
17
  ### Added
20
- - Improve, and dry up documentation
18
+ - Initial odd release supporting Ruby ~> 2.4
21
19
 
22
20
  ## [10.0.0] - 2022-05-23
23
21
  ### Added
24
22
  - Initial even release supporting Ruby >= 2.3
25
23
 
26
- ## [9.0.1] - 2022-06-09
27
- ### Added
28
- - Improve, and dry up documentation
29
-
30
24
  ## [9.0.0] - 2022-05-23
31
25
  ### Added
32
26
  - Initial odd release supporting Ruby ~> 2.3
33
27
 
34
- ## [8.0.2] - 2022-06-09
35
- ### Fixed
36
- - Allow install up to Ruby < 4, which allows running against current Ruby HEAD @ 3.2-dev
37
-
38
- ## [8.0.1] - 2022-06-09
39
- ### Added
40
- - Improve, and dry up documentation
41
-
42
28
  ## [8.0.0] - 2022-05-23
43
29
  ### Added
44
30
  - Initial even release supporting Ruby >= 2.2
45
31
 
46
- ## [7.0.1] - 2022-06-08
47
- ### Added
48
- - Improve, and dry up documentation
49
-
50
32
  ## [7.0.0] - 2022-05-23
51
33
  ### Added
52
34
  - Initial odd release supporting Ruby ~> 2.2
53
35
 
54
- ## [6.0.1] - 2022-06-08
55
- ### Fixed
56
- - Allow install up to Ruby < 4, which allows running against current Ruby HEAD @ 3.2-dev
57
- ### Added
58
- - Improve, and dry up documentation
59
-
60
36
  ## [6.0.0] - 2022-05-23
61
37
  ### Added
62
38
  - Initial even release supporting Ruby >= 2.1
63
39
 
64
- ## [5.0.2] - 2022-06-08
65
- ### Added
66
- - Improve, and dry up documentation
67
-
68
40
  ## [5.0.1] - 2022-05-23
69
41
  ### Fixed
70
42
  - Make rubocop config files load ruby specific config from relevant rubocop-ruby*_* gem
@@ -73,10 +45,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
73
45
  ### Added
74
46
  - Initial odd release supporting Ruby ~> 2.1
75
47
 
76
- ## [4.0.3] - 2022-06-08
77
- ### Fixed
78
- - Allow install up to Ruby < 4, which allows running against current Ruby HEAD @ 3.2-dev
79
-
80
48
  ## [4.0.2] - 2022-05-23
81
49
  ### Fixed
82
50
  - Make rubocop config files load ruby specific config from relevant rubocop-ruby*_* gem
@@ -90,10 +58,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
90
58
  ### Added
91
59
  - Initial even release supporting Ruby >= 2.0
92
60
 
93
- ## [3.0.3] - 2022-06-08
94
- ### Added
95
- - Improve, and dry up documentation
96
-
97
61
  ## [3.0.2] - 2022-05-23
98
62
  ### Fixed
99
63
  - Make rubocop config files load ruby specific config from relevant rubocop-ruby*_* gem
@@ -107,14 +71,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
107
71
  ### Added
108
72
  - Initial odd release supporting Ruby ~> 2.0
109
73
 
110
- ## [2.0.5] - 2022-06-08
111
- ### Added
112
- - Improve, and dry up documentation
113
-
114
- ## [2.0.4] - 2022-06-08
115
- ### Fixed
116
- - Allow install up to Ruby < 4, which allows running against current Ruby HEAD @ 3.2-dev
117
-
118
74
  ## [2.0.3] - 2022-05-23
119
75
  ### Fixed
120
76
  - Make rubocop config files load ruby specific config from relevant rubocop-ruby*_* gem
@@ -133,11 +89,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
133
89
  ### Added
134
90
  - Initial even release supporting Ruby >= 1.9
135
91
 
136
- ## [1.0.4] - 2022-06-08
137
- ### Added
138
- - Security Policy @ SECURITY.md
139
- - Improve, and dry up documentation
140
-
141
92
  ## [1.0.3] - 2022-05-23
142
93
  ### Fixed
143
94
  - Make rubocop config files load ruby specific config from relevant rubocop-ruby*_* gem
@@ -156,36 +107,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
156
107
  ### Added
157
108
  - Initial odd release supporting Ruby ~> 1.9
158
109
 
159
- [Unreleased]: https://github.com/rubocop-lts/rubocop-lts/compare/v10.0.1...HEAD
160
- [10.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v10.0.0...v10.0.1
161
- [10.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v9.0.1...v10.0.0
162
- [9.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v9.0.0...v9.0.1
163
- [9.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v8.0.2...v9.0.0
164
- [8.0.2]: https://github.com/rubocop-lts/rubocop-lts/compare/v8.0.1...v8.0.2
165
- [8.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v8.0.0...v8.0.1
166
- [8.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v7.0.1...v8.0.0
167
- [7.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v7.0.0...v7.0.1
168
- [7.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v6.0.1...v7.0.0
169
- [6.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v6.0.0...v6.0.1
170
- [6.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v5.0.2...v6.0.0
171
- [5.0.2]: https://github.com/rubocop-lts/rubocop-lts/compare/v5.0.1...v5.0.2
110
+ [Unreleased]: https://github.com/rubocop-lts/rubocop-lts/compare/v11.0.0...HEAD
111
+ [11.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v10.0.0...v11.0.0
112
+ [10.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v9.0.0...v10.0.0
113
+ [9.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v8.0.0...v9.0.0
114
+ [8.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v7.0.0...v8.0.0
115
+ [7.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v6.0.0...v7.0.0
116
+ [6.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v5.0.1...v6.0.0
172
117
  [5.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v5.0.0...v5.0.1
173
- [5.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v4.0.3...v5.0.0
174
- [4.0.3]: https://github.com/rubocop-lts/rubocop-lts/compare/v4.0.2...v4.0.3
118
+ [5.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v4.0.2...v5.0.0
175
119
  [4.0.2]: https://github.com/rubocop-lts/rubocop-lts/compare/v4.0.1...v4.0.2
176
120
  [4.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v4.0.0...v4.0.1
177
- [4.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v3.0.3...v4.0.0
178
- [3.0.3]: https://github.com/rubocop-lts/rubocop-lts/compare/v3.0.2...v3.0.3
121
+ [4.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v3.0.2...v4.0.0
179
122
  [3.0.2]: https://github.com/rubocop-lts/rubocop-lts/compare/v3.0.1...v3.0.2
180
123
  [3.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v3.0.0...v3.0.1
181
- [3.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.5...v3.0.0
182
- [2.0.5]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.4...v2.0.5
183
- [2.0.4]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.3...v2.0.4
124
+ [3.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.3...v3.0.0
184
125
  [2.0.3]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.2...v2.0.3
185
126
  [2.0.2]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.1...v2.0.2
186
127
  [2.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v2.0.0...v2.0.1
187
- [2.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v1.0.4...v2.0.0
188
- [1.0.4]: https://github.com/rubocop-lts/rubocop-lts/compare/v1.0.3...v1.0.4
128
+ [2.0.0]: https://github.com/rubocop-lts/rubocop-lts/compare/v1.0.3...v2.0.0
189
129
  [1.0.3]: https://github.com/rubocop-lts/rubocop-lts/compare/v1.0.2...v1.0.3
190
130
  [1.0.2]: https://github.com/rubocop-lts/rubocop-lts/compare/v1.0.1...v1.0.2
191
131
  [1.0.1]: https://github.com/rubocop-lts/rubocop-lts/compare/v1.0.0...v1.0.1
data/README.md CHANGED
@@ -16,38 +16,149 @@
16
16
  </a>
17
17
  </p>
18
18
 
19
- # RuboCop LTS
20
-
21
- ## PROJECT DOCUMENTATION
22
-
23
- |🌱 [Why Build This?][Why-Build-This]
24
- |🌱 [Convention > Configuration][Convention-Over-Configuration]
25
- --⊕🌱 [Even Releases][Even-Major-Release]
26
- --⊕🌱 [Odd Releases][Odd-Major-Release]
27
- |🌱 [How to Upgrade Ruby (1.8 to 3.2)!][How-To-Upgrade-Ruby]
28
- |👩‍💻 [Org Health](https://github.com/rubocop-lts/.github/blob/main/profile/README.md#👩‍💻-project-health])
29
- --⊕👩‍💻 [Project Health](#👩‍💻-project-health)
30
- |🌳 [This Branch](#🌳-this-branch)
31
- |✨ [Installation](#✨-installation)
32
- |🔧 [Usage](https://github.com/rubocop-lts/.github/blob/main/profile/README.md#🔧-usage)
33
- |🏗️ [Development](https://github.com/rubocop-lts/.github/blob/main/profile/README.md#🏗️-development)
34
- --⊕⚡️ [Contributing](https://github.com/rubocop-lts/.github/blob/main/profile/README.md#⚡️-contributing)
35
- --⊕🌈 [Contributors](https://github.com/rubocop-lts/.github/blob/main/profile/README.md#🌈-contributors)
36
- |📄 [License](https://github.com/rubocop-lts/.github/blob/main/profile/README.md#📄-license)
37
- |⊕© [Copyright](https://github.com/rubocop-lts/.github/blob/main/profile/README.md#©-copyright)
38
- |🤝 [Code of Conduct](https://github.com/rubocop-lts/.github/blob/main/profile/README.md#🤝-code-of-conduct)
39
- |📌 [Versioning](https://github.com/rubocop-lts/.github/blob/main/profile/README.md#📌-versioning)
40
-
41
- [Why-Build-This]: https://github.com/rubocop-lts/.github/blob/main/profile/WHY_BUILD_THIS.md
42
- [Convention-Over-Configuration]: https://github.com/rubocop-lts/.github/blob/main/profile/CONV_OVER_CONF.md
43
- [Even-Major-Release]: https://github.com/rubocop-lts/.github/blob/main/profile/CONV_OVER_CONF.md#even-major-release
44
- [Odd-Major-Release]: https://github.com/rubocop-lts/.github/blob/main/profile/CONV_OVER_CONF.md#odd-major-release
45
- [How-To-Upgrade-Ruby]: https://github.com/rubocop-lts/.github/blob/main/profile/HOW_TO_UPGRADE_RUBY.md
46
-
47
- ## 🌳 This Branch
19
+ # Rubocop LTS
20
+
21
+ ## 🙋‍♀️ How often has RuboCop broken your build?
22
+
23
+ This is both good (literally its job) _and_ bad (when it's for the wrong reasons).
24
+
25
+ It's supposed to break the build when it finds violations.
26
+ It should not break the build due to incompatibility with your environment. RuboCop
27
+ doesn't [follow SemVer](https://dev.to/pboling/rubocop-ruby-matrix-gems-nj), and occasionally it will unexpectedly break things.
28
+
29
+ ## 🗿 Stable
30
+
31
+ All releases are stable releases. The major version you need depends on the supported version(s) of Ruby for your project.
32
+
33
+ Projects that support a single version of Ruby (like many closed-source applications) will use the [Odd releases][even-release].
34
+
35
+ Projects that support multiple versions of Ruby simultaneously (like many open-source applications and libraries) will use the [Even releases][even-release].
48
36
 
49
37
  <!-- FIND VERSION -->
50
- **This README is for the even release of `rubocop-lts` supporting Ruby >= 2.3.0.**
38
+ **This README is for the odd release of `rubocop-lts` supporting Ruby ~> 2.4.0.**
39
+
40
+ [odd-release]: https://github.com/rubocop-lts/rubocop-lts#odd-major-release
41
+ [even-release]: https://github.com/rubocop-lts/rubocop-lts#even-major-release
42
+
43
+ ## Version Conventions
44
+
45
+ ### Odd Major Release
46
+
47
+ Versions like:
48
+ ```ruby
49
+ "1.0.0"
50
+ "3.0.0"
51
+ "5.0.0"
52
+ # ... etc
53
+ ```
54
+ Locked to a single minor version of Ruby, e.g. version 15.0 has a `required_ruby_version` of `['>= 2.6.0', '< 2.7']`, which will install only on `2.6.x` versions of Ruby.
55
+
56
+ #### Implementation
57
+
58
+ Intended for applications and libraries that only lint against a single Ruby version.
59
+
60
+ Odd versions should be attached to a project's trunk (e.g. the main branch), for long-term stability (ahem, _lts_, anyone?) of the style rules.
61
+
62
+ | Your Ruby | Your Gemfile | Your Gemfile.lock | Your .rubocop.yml |
63
+ |-----------------------------------|--------------------------------|-------------------|------------------------------------------------|
64
+ | `1.9.x` (`['>= 1.9.0', '< 2']`) | `gem "rubocop-lts", "~> 1.0"` | `rubocop-ruby1_9` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
65
+ | `2.0.x` (`['>= 2.0.0', '< 2.1']`) | `gem "rubocop-lts", "~> 3.0"` | `rubocop-ruby2_0` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
66
+ | `2.1.x` (`['>= 2.1.0', '< 2.2']`) | `gem "rubocop-lts", "~> 5.0"` | `rubocop-ruby2_1` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
67
+ | `2.2.x` (`['>= 2.2.0', '< 2.3']`) | `gem "rubocop-lts", "~> 7.0"` | `rubocop-ruby2_2` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
68
+ | `2.3.x` (`['>= 2.3.0', '< 2.4']`) | `gem "rubocop-lts", "~> 9.0"` | `rubocop-ruby2_3` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
69
+ | `2.4.x` (`['>= 2.4.0', '< 2.5']`) | `gem "rubocop-lts", "~> 11.0"` | `rubocop-ruby2_4` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
70
+ | `2.5.x` (`['>= 2.5.0', '< 2.6']`) | `gem "rubocop-lts", "~> 13.0"` | `rubocop-ruby2_5` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
71
+ | `2.6.x` (`['>= 2.6.0', '< 2.7']`) | `gem "rubocop-lts", "~> 15.0"` | `rubocop-ruby2_6` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
72
+ | `2.7.x` (`['>= 2.7.0', '< 3.0']`) | `gem "rubocop-lts", "~> 17.0"` | `rubocop-ruby2_7` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
73
+ | `3.0.x` (`['>= 3.0.0', '< 3.1']`) | `gem "rubocop-lts", "~> 19.0"` | `rubocop-ruby3_0` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
74
+ | `3.1.x` (`['>= 3.1.0', '< 3.2']`) | `gem "rubocop-lts", "~> 21.0"` | `rubocop-ruby3_1` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
75
+ | `3.2.x` / ruby-head | `gem "rubocop-lts", "~> 23.0"` | `rubocop-ruby3_2` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
76
+
77
+ ### Even Major Release
78
+
79
+ Versions like:
80
+ ```ruby
81
+ "2.0.0"
82
+ "4.0.0"
83
+ "6.0.0"
84
+ # ... etc
85
+ ```
86
+ Locked to the forward range of Rubies on which the gem can be installed (though rubocop may not execute on all),
87
+ e.g. version 16.0 has a `required_ruby_version` of `['>= 2.6.0', '< 3.2']` will install on any released version
88
+ of ruby from `2.6` on.
89
+
90
+ #### Implementation
91
+
92
+ Intended for applications and libraries that lint against a range of Ruby versions.
93
+
94
+ Even versions will help projects upgrade to newer Rubies while keeping the same underlying version of Rubocop version, so change can be introduced one step at a time.
95
+
96
+ | Minimum Ruby | Your Gemfile | Your Gemfile.lock | Your .rubocop.yml |
97
+ |-----------------------------------|--------------------------------|-------------------|------------------------------------------------|
98
+ | `1.9.x` (`['>= 1.9.0', '< 3.2']`) | `gem "rubocop-lts", "~> 2.0"` | `rubocop-ruby1_9` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
99
+ | `2.0.x` (`['>= 2.0.0', '< 3.2']`) | `gem "rubocop-lts", "~> 4.0"` | `rubocop-ruby2_0` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
100
+ | `2.1.x` (`['>= 2.1.0', '< 3.2']`) | `gem "rubocop-lts", "~> 6.0"` | `rubocop-ruby2_1` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
101
+ | `2.2.x` (`['>= 2.2.0', '< 3.2']`) | `gem "rubocop-lts", "~> 8.0"` | `rubocop-ruby2_2` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
102
+ | `2.3.x` (`['>= 2.3.0', '< 3.2']`) | `gem "rubocop-lts", "~> 10.0"` | `rubocop-ruby2_3` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
103
+ | `2.4.x` (`['>= 2.4.0', '< 3.2']`) | `gem "rubocop-lts", "~> 12.0"` | `rubocop-ruby2_4` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
104
+ | `2.5.x` (`['>= 2.5.0', '< 3.2']`) | `gem "rubocop-lts", "~> 14.0"` | `rubocop-ruby2_5` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
105
+ | `2.6.x` (`['>= 2.6.0', '< 3.2']`) | `gem "rubocop-lts", "~> 16.0"` | `rubocop-ruby2_6` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
106
+ | `2.7.x` (`['>= 2.7.0', '< 3.2']`) | `gem "rubocop-lts", "~> 18.0"` | `rubocop-ruby2_7` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
107
+ | `3.0.x` (`['>= 3.0.0', '< 3.2']`) | `gem "rubocop-lts", "~> 20.0"` | `rubocop-ruby3_0` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
108
+ | `3.1.x` (`['>= 3.1.0', '< 3.2']`) | `gem "rubocop-lts", "~> 22.0"` | `rubocop-ruby3_1` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
109
+ | `3.2.x` / ruby-head | `gem "rubocop-lts", "~> 24.0"` | `rubocop-ruby3_2` | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
110
+
111
+ ### All together now!
112
+
113
+ Upgrading a single step from odd to even will allow upgrading Ruby.
114
+
115
+ Upgrading a single step from even to odd will keep the same version of Ruby, and instead upgrade to the next RuboCop milestone.
116
+
117
+ Each major version will have a tracking branch named accordingly, [for development](https://github.com/rubocop-lts/rubocop-lts#git-branch-names).
118
+
119
+ ### 🪢 How To Untie Gorgon's Knot
120
+
121
+ > NOTE: The ruby specific versions, e.g. `rubocop-ruby2_7`, can be used if you won't be upgrading ruby. Keep scrolling down for links to each of them.
122
+
123
+ How to upgrade a project from yesterday, to today.
124
+
125
+ 1. Have good code coverage.
126
+ 2. Upgrade one step at a time.
127
+ 3. Re-run `bundle exec rubocop -a` in between each step.
128
+ 4. Re-run `bundle exec rubocop --auto-gen-config` in between each step.
129
+ 5. Commit and push to CI in between each step.
130
+
131
+ | Your Ruby | Your Gemfile | required_ruby_version | Your Gemfile.lock | Your .rubocop.yml |
132
+ |---------------|--------------------------------------|-------------------------|------------------------------|------------------------------------------------|
133
+ | `1.9.x` | `gem "rubocop-lts", "~> 1.0"` | `['>= 1.9.0', '< 2']` | [`rubocop-ruby1_9`][⛳️19-gh] | `inherit_gem:\n rubocop-lts: rubocop-lts.yml` |
134
+ | ⬆️ to `2.0.x` | ⬆️ to `gem "rubocop-lts", "~> 2.0"` | `['>= 1.9.0', '< 3.2']` | no change | no change |
135
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 3.0"` | `['>= 2.0.0', '< 2.1']` | [`rubocop-ruby2_0`][⛳️20-gh] | no change |
136
+ | ⬆️ to `2.1.x` | ⬆️ to `gem "rubocop-lts", "~> 4.0"` | `['>= 2.0.0', '< 3.2']` | no change | no change |
137
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 5.0"` | `['>= 2.1.0', '< 2.2']` | [`rubocop-ruby2_1`][⛳️21-gh] | no change |
138
+ | ⬆️ to `2.2.x` | ⬆️ to `gem "rubocop-lts", "~> 6.0"` | `['>= 2.1.0', '< 3.2']` | no change | no change |
139
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 7.0"` | `['>= 2.2.0', '< 2.3']` | [`rubocop-ruby2_2`][⛳️22-gh] | no change |
140
+ | ⬆️ to `2.3.x` | ⬆️ to `gem "rubocop-lts", "~> 8.0"` | `['>= 2.2.0', '< 3.2']` | no change | no change |
141
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 9.0"` | `['>= 2.3.0', '< 2.4']` | [`rubocop-ruby2_3`][⛳️23-gh] | no change |
142
+ | ⬆️ to `2.4.x` | ⬆️ to `gem "rubocop-lts", "~> 10.0"` | `['>= 2.3.0', '< 3.2']` | no change | no change |
143
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 11.0"` | `['>= 2.4.0', '< 2.5']` | [`rubocop-ruby2_4`][⛳️24-gh] | no change |
144
+ | ⬆️ to `2.5.x` | ⬆️ to `gem "rubocop-lts", "~> 12.0"` | `['>= 2.4.0', '< 3.2']` | no change | no change |
145
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 13.0"` | `['>= 2.5.0', '< 2.6']` | [`rubocop-ruby2_5`][⛳️25-gh] | no change |
146
+ | ⬆️ to `2.6.x` | ⬆️ to `gem "rubocop-lts", "~> 14.0"` | `['>= 2.5.0', '< 3.2']` | no change | no change |
147
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 15.0"` | `['>= 2.6.0', '< 2.7']` | [`rubocop-ruby2_6`][⛳️26-gh] | no change |
148
+ | ⬆️ to `2.7.x` | ⬆️ to `gem "rubocop-lts", "~> 16.0"` | `['>= 2.6.0', '< 3.2']` | no change | no change |
149
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 17.0"` | `['>= 2.7.0', '< 3.0']` | [`rubocop-ruby2_7`][⛳️27-gh] | no change |
150
+ | ⬆️ to `3.0.x` | ⬆️ to `gem "rubocop-lts", "~> 18.0"` | `['>= 2.7.0', '< 3.2']` | no change | no change |
151
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 19.0"` | `['>= 3.0.0', '< 3.1']` | [`rubocop-ruby3_0`][⛳️30-gh] | no change |
152
+ | ⬆️ to `3.1.x` | ⬆️ to `gem "rubocop-lts", "~> 20.0"` | `['>= 3.0.0', '< 3.2']` | no change | no change |
153
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 21.0"` | `['>= 3.1.0', '< 3.2']` | [`rubocop-ruby3_1`][⛳️31-gh] | no change |
154
+ | ⬆️ to `3.2.x` | ⬆️ to `gem "rubocop-lts", "~> 22.0"` | `['>= 3.1.0', '< 3.2']` | no change | no change |
155
+ | no change | ⬆️ to `gem "rubocop-lts", "~> 23.0"` | `['>= 3.2.0', '< 3.3']` | [`rubocop-ruby3_2`][⛳️32-gh] | no change |
156
+ | ⬆️ to `3.3.x` | ⬆️ to `gem "rubocop-lts", "~> 24.0"` | `['>= 3.2.0', '< 3.3']` | no change | no change |
157
+
158
+ > NOTE: `required_ruby_version` means the gem will install on a version of Ruby within the range.
159
+ > Versions of this gem intended for ancient Rubies may not execute on more modern Rubies, _despite installing_.
160
+ > As such you might consider limiting linting to only a single version of Ruby, the oldest one supported.
161
+ > Speaking of old rubies... 👇
51
162
 
52
163
  ### 📼 Supporting Ruby 1.8
53
164
 
@@ -91,13 +202,137 @@ Add this line to your application's Gemfile:
91
202
 
92
203
  <!-- FIND VERSION -->
93
204
  ```ruby
94
- gem 'rubocop-lts', '~> 10.0', require: false
205
+ gem 'rubocop-lts', '~> 11.0', require: false
95
206
  ```
96
207
 
97
208
  And then execute:
98
209
 
99
210
  $ bundle
100
211
 
212
+ ## 🔧 Usage
213
+
214
+ The following is optional. We'll discuss why you might want to do this after you see what it does.
215
+
216
+ Add to the top of your project's `.rubocop.yml` configuration file:
217
+
218
+ ```yaml
219
+ inherit_gem:
220
+ - rubocop-lts.yml
221
+ ```
222
+
223
+ ## Development
224
+
225
+ 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.
226
+
227
+ To install this gem onto your local machine, run `bundle exec rake install`. 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
228
+
229
+ ### Git Branch Names
230
+
231
+ #### Naming Scheme
232
+
233
+ ```ruby
234
+ "r{{ ruby major }}_{{ ruby minor }}-{{ parity }}-v{{ gem-version }}"
235
+ ```
236
+
237
+ ##### Parity
238
+
239
+ Even versions use the token `even` in the branch name.
240
+ Odd versions use the token `odd` in the branch name.
241
+
242
+ #### Version - Branch Matrix
243
+
244
+ | Ruby Version | Parity | Gem Version | Branch Name | Purpose |
245
+ |-----------------|--------|-------------|-----------------|-----------------------------------|
246
+ | 1.9 | odd | 1.x | `r1_9-odd-v1` | LTS, trunk, single-ruby-linting |
247
+ | 1.9 | even | 2.x | `r1_9-even-v2` | Upgrade, feat, multi-ruby-linting |
248
+ | 2.0 | odd | 3.x | `r2_0-odd-v3` | LTS, trunk, single-ruby-linting |
249
+ | 2.0 | even | 4.x | `r2_0-even-v4` | Upgrade, feat, multi-ruby-linting |
250
+ | 2.1 | odd | 5.x | `r2_1-odd-v5` | LTS, trunk, single-ruby-linting |
251
+ | 2.1 | even | 6.x | `r2_1-even-v6` | Upgrade, feat, multi-ruby-linting |
252
+ | 2.2 | odd | 7.x | `r2_2-odd-v7` | LTS, trunk, single-ruby-linting |
253
+ | 2.2 | even | 8.x | `r2_2-even-v8` | Upgrade, feat, multi-ruby-linting |
254
+ | 2.3 | odd | 9.x | `r2_3-odd-v9` | LTS, trunk, single-ruby-linting |
255
+ | 2.3 | even | 10.x | `r2_3-even-v10` | Upgrade, feat, multi-ruby-linting |
256
+ | 2.4 | odd | 11.x | `r2_4-odd-v11` | LTS, trunk, single-ruby-linting |
257
+ | 2.4 | even | 12.x | `r2_4-even-v12` | Upgrade, feat, multi-ruby-linting |
258
+ | 2.5 | odd | 13.x | `r2_5-odd-v13` | LTS, trunk, single-ruby-linting |
259
+ | 2.5 | even | 14.x | `r2_5-even-v14` | Upgrade, feat, multi-ruby-linting |
260
+ | 2.6 | odd | 15.x | `r2_6-odd-v15` | LTS, trunk, single-ruby-linting |
261
+ | 2.6 | even | 16.x | `r2_6-even-v16` | Upgrade, feat, multi-ruby-linting |
262
+ | 2.7 | odd | 17.x | `r2_7-odd-v17` | LTS, trunk, single-ruby-linting |
263
+ | 2.7 | even | 18.x | `r2_7-even-v18` | Upgrade, feat, multi-ruby-linting |
264
+ | 3.0 | odd | 19.x | `r3_0-odd-v19` | LTS, trunk, single-ruby-linting |
265
+ | 3.0 | even | 20.x | `r3_0-even-v20` | Upgrade, feat, multi-ruby-linting |
266
+ | 3.1 | odd | 21.x | `r3_1-odd-v21` | LTS, trunk, single-ruby-linting |
267
+ | 3.1 | even | 22.x | `r3_1-even-v22` | Upgrade, feat, multi-ruby-linting |
268
+ | 3.2 / ruby-head | odd | 23.x | `r3_2-odd-v23` | LTS, trunk, single-ruby-linting |
269
+ | 3.2 / ruby-head | even | 24.x | `r3_2-even-v24` | Upgrade, feat, multi-ruby-linting |
270
+
271
+ > NOTE: For more on how Ruby 1.8 support works, see [above][lts1_8]
272
+
273
+ [lts1_8]: https://github.com/rubocop-lts/rubocop-lts#supporting-ruby-18
274
+
275
+ ## ⚡️ Contributing
276
+
277
+ See [CONTRIBUTING.md][contributing]
278
+
279
+ ## 🌈 Contributors
280
+
281
+ [![Contributors](https://contrib.rocks/image?repo=rubocop-lts/rubocop-lts)]("https://github.com/rubocop-lts/rubocop-lts/graphs/contributors")
282
+
283
+ Made with [contributors-img](https://contrib.rocks).
284
+
285
+ ## 📄 License
286
+
287
+ The gem is available as open source under the terms of
288
+ the [MIT License][license] [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)][license-ref].
289
+ See [LICENSE][license] for the official [Copyright Notice][copyright-notice-explainer].
290
+
291
+ <details>
292
+ <summary>Project Logos (rubocop-lts)</summary>
293
+
294
+ See [docs/images/logo/README.txt][project-logos]
295
+ </details>
296
+
297
+ <details>
298
+ <summary>Organization Logo (rubocop-semver)</summary>
299
+
300
+ Author: [Yusuf Evli][org-logo-author]
301
+ Source: [Unsplash][org-logo-source]
302
+ License: [Unsplash License][org-logo-license]
303
+ </details>
304
+
305
+ [project-logos]: https://github.com/rubocop-lts/rubocop-lts/blob/main/docs/images/logo/README.txt
306
+ [org-logo-author]: https://unsplash.com/@yusufevli
307
+ [org-logo-source]: https://unsplash.com/photos/yaSLNLtKRIU
308
+ [org-logo-license]: https://unsplash.com/license
309
+
310
+ ### © Copyright
311
+
312
+ * Copyright (c) 2022 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
313
+
314
+ ## 🤝 Code of Conduct
315
+
316
+ Everyone interacting in Rubocop LTS codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rubocop-lts/rubocop-lts/blob/main/CODE_OF_CONDUCT.md).
317
+
318
+ ## 📌 Versioning
319
+
320
+ This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations of this scheme should be reported as
321
+ bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be
322
+ immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new
323
+ major versions.
324
+
325
+ As a result of this policy, you can (and should) specify a dependency on this gem using
326
+ the [Pessimistic Version Constraint][pvc] with two digits of precision.
327
+
328
+ For example:
329
+
330
+ <!-- FIND VERSION -->
331
+ ```ruby
332
+ spec.add_dependency "rubocop-lts", "~> 11.0"
333
+ ```
334
+
335
+
101
336
  <!-- columnar badge #s for Project Health table:
102
337
  ⛳️
103
338
  🖇
data/SECURITY.md CHANGED
@@ -15,17 +15,6 @@
15
15
  | 9.x | :white_check_mark: |
16
16
  | 10.x | :white_check_mark: |
17
17
  | 11.x | :white_check_mark: |
18
- | 12.x | :white_check_mark: |
19
- | 13.x | :white_check_mark: |
20
- | 14.x | :white_check_mark: |
21
- | 15.x | :white_check_mark: |
22
- | 16.x | :white_check_mark: |
23
- | 17.x | :white_check_mark: |
24
- | 18.x | :white_check_mark: |
25
- | 19.x | :white_check_mark: |
26
- | 20.x | :white_check_mark: |
27
- | 21.x | :white_check_mark: |
28
- | 22.x | :white_check_mark: |
29
18
 
30
19
  ## Reporting a Vulnerability
31
20
 
data/lib/rubocop/lts/version.rb CHANGED
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Rubocop
4
4
  module Lts
5
- VERSION = "10.0.1"
5
+ VERSION = "11.0.0"
6
6
  end
7
7
  end
data/rubocop-lts.yml CHANGED
@@ -1,2 +1,2 @@
1
1
  inherit_gem:
2
- rubocop-ruby2_3: rubocop.yml
2
+ rubocop-ruby2_4: rubocop.yml
data/spec/config/rspec/rspec_core.rb ADDED
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ RSpec.configure do |config|
4
+ # Enable flags like --only-failures and --next-failure
5
+ config.example_status_persistence_file_path = ".rspec_status"
6
+
7
+ # Disable RSpec exposing methods globally on `Module` and `main`
8
+ config.disable_monkey_patching!
9
+
10
+ config.expect_with :rspec do |c|
11
+ c.syntax = :expect
12
+ end
13
+ end
data/spec/rubocop/lts_spec.rb ADDED
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ RSpec.describe Rubocop::Lts do
4
+ it "has a version number" do
5
+ expect(Rubocop::Lts::VERSION).not_to be nil
6
+ end
7
+ end
data/spec/spec_helper.rb ADDED
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This gem
4
+ require "rubocop/lts"
5
+
6
+ # RSpec Configs
7
+ require "config/rspec/rspec_core"
metadata CHANGED
@@ -1,17 +1,17 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rubocop-lts
3
3
  version: !ruby/object:Gem::Version
4
- version: 10.0.1
4
+ version: 11.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Peter Boling
8
- autorequire:
8
+ autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2022-06-09 00:00:00.000000000 Z
11
+ date: 2022-05-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
- name: rubocop-ruby2_3
14
+ name: rubocop-ruby2_4
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
17
  - - "~>"
@@ -41,18 +41,21 @@ files:
41
41
  - lib/rubocop/lts/version.rb
42
42
  - rubocop-lts.yml
43
43
  - sig/rubocop/lts.rbs
44
+ - spec/config/rspec/rspec_core.rb
45
+ - spec/rubocop/lts_spec.rb
46
+ - spec/spec_helper.rb
44
47
  homepage: https://github.com/rubocop-lts/rubocop-lts
45
48
  licenses:
46
49
  - MIT
47
50
  metadata:
48
51
  homepage_uri: https://github.com/rubocop-lts/rubocop-lts
49
- source_code_uri: https://github.com/rubocop-lts/rubocop-lts/tree/v10.0.1
50
- changelog_uri: https://github.com/rubocop-lts/rubocop-lts/blob/v10.0.1/CHANGELOG.md
52
+ source_code_uri: https://github.com/rubocop-lts/rubocop-lts/tree/v11.0.0
53
+ changelog_uri: https://github.com/rubocop-lts/rubocop-lts/blob/v11.0.0/CHANGELOG.md
51
54
  bug_tracker_uri: https://github.com/rubocop-lts/rubocop-lts/issues
52
- documentation_uri: https://www.rubydoc.info/gems/rubocop-lts/10.0.1
55
+ documentation_uri: https://www.rubydoc.info/gems/rubocop-lts/11.0.0
53
56
  wiki_uri: https://github.com/rubocop-lts/rubocop-lts/wiki
54
57
  rubygems_mfa_required: 'true'
55
- post_install_message:
58
+ post_install_message:
56
59
  rdoc_options: []
57
60
  require_paths:
58
61
  - lib
@@ -60,18 +63,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
60
63
  requirements:
61
64
  - - ">="
62
65
  - !ruby/object:Gem::Version
63
- version: 2.3.0
66
+ version: 2.4.0
64
67
  - - "<"
65
68
  - !ruby/object:Gem::Version
66
- version: '4.0'
69
+ version: '2.5'
67
70
  required_rubygems_version: !ruby/object:Gem::Requirement
68
71
  requirements:
69
72
  - - ">="
70
73
  - !ruby/object:Gem::Version
71
74
  version: '0'
72
75
  requirements: []
73
- rubygems_version: 3.3.15
74
- signing_key:
76
+ rubygems_version: 3.3.14
77
+ signing_key:
75
78
  specification_version: 4
76
79
  summary: Rubocop LTS - Semantically Versioned
77
- test_files: []
80
+ test_files:
81
+ - spec/spec_helper.rb
82
+ - spec/config/rspec/rspec_core.rb
83
+ - spec/rubocop/lts_spec.rb