rubocop-rubomatic 1.0.0.pre.rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.adoc +10 -0
- data/LICENSE +22 -0
- data/README.adoc +87 -0
- data/config/bundler.yml +80 -0
- data/config/default.yml +16 -0
- data/config/gemspec.yml +2 -0
- data/config/gemspec_on.yml +74 -0
- data/config/layout.yml +1217 -0
- data/config/lint.yml +989 -0
- data/config/metrics.yml +120 -0
- data/config/migration.yml +6 -0
- data/config/naming.yml +316 -0
- data/config/performance.yml +266 -0
- data/config/rubocop.yml +36 -0
- data/config/rubomatic/layout.yml +4 -0
- data/config/rubomatic/rubocop.yml +5 -0
- data/config/rubomatic/style.yml +2 -0
- data/config/security.yml +53 -0
- data/config/style.yml +2545 -0
- data/docs/cops/layout/README.adoc +7 -0
- data/docs/cops/layout/multiline_array_line_breaks/README.adoc +44 -0
- data/docs/cops/style/README.adoc +7 -0
- data/docs/cops/style/disallowed_methods/README.adoc +28 -0
- data/lib/rubocop/cop/rubomatic/generator/cop_readme_injector.rb +51 -0
- data/lib/rubocop/cop/rubomatic/generator/dept_readme_injector.rb +114 -0
- data/lib/rubocop/cop/rubomatic/generator.rb +283 -0
- data/lib/rubocop/cop/rubomatic/layout/multiline_array_line_breaks.rb +28 -0
- data/lib/rubocop/cop/rubomatic/style/disallowed_methods.rb +50 -0
- data/lib/rubocop/cop/rubomatic_cops.rb +4 -0
- data/lib/rubocop/rubomatic/inject.rb +21 -0
- data/lib/rubocop/rubomatic/version.rb +7 -0
- data/lib/rubocop/rubomatic.rb +17 -0
- data/lib/rubocop-rubomatic.rb +12 -0
- metadata +108 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 210554ea177fd04a3b4f9687071db211b6ee41838f639f41b1bb53bac7fce235
|
4
|
+
data.tar.gz: dcd1688ae978db4b3596fbaae585ff123b6cf21a37beb836c2ec433c1c62b0c8
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e35bd525c77866392eeb276eb1858e16bb68c9b553f49477413a3644c7ae835b5d4076d2cd89db5df36dbf899ab31070554b10e1ba01cd89a5a0aa16c4fb0ad8
|
7
|
+
data.tar.gz: 54b238d1547b1989d37748c1347b7946c6450057a00b4d64be21646c8181ebb2f69b6329c7196bfa6e61d2e05b3a56c9b5679cc96d47125a6f01beab6f19a54d
|
data/CHANGELOG.adoc
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2023 Brands Insurance
|
2
|
+
|
3
|
+
Copyright for portions of project Rubocop are held by Bozhidar Batsov and other contributors, as part of project Rubocop.
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.adoc
ADDED
@@ -0,0 +1,87 @@
|
|
1
|
+
= Rubomatic
|
2
|
+
|
3
|
+
Gem for shared rubocop config and custom cops for BrandsInsurance
|
4
|
+
|
5
|
+
Put your Ruby code in the file ``lib/rubocop/rubomatic``.
|
6
|
+
To experiment with that code, run
|
7
|
+
``bin/console`` for an interactive prompt.
|
8
|
+
|
9
|
+
== Installation
|
10
|
+
|
11
|
+
Add this line to your application's Gemfile:
|
12
|
+
|
13
|
+
[source,ruby]
|
14
|
+
----
|
15
|
+
gem 'rubocop-rubomatic', require: false
|
16
|
+
----
|
17
|
+
|
18
|
+
And then execute:
|
19
|
+
|
20
|
+
$ bundle install
|
21
|
+
|
22
|
+
Or install it yourself as:
|
23
|
+
|
24
|
+
$ gem install rubocop-rubomatic
|
25
|
+
|
26
|
+
== Usage
|
27
|
+
|
28
|
+
Add the following to your ``.rubocop.yml`` config file
|
29
|
+
|
30
|
+
[source,yaml]
|
31
|
+
----
|
32
|
+
inherit_gem:
|
33
|
+
rubocop-rubomatic: config/rubocop.yml
|
34
|
+
----
|
35
|
+
|
36
|
+
If you need to override a setting:
|
37
|
+
|
38
|
+
[source,yaml]
|
39
|
+
----
|
40
|
+
# Add to Naming/VariableNumber.AllowedIdentifiers
|
41
|
+
inherit_gem:
|
42
|
+
rubocop-rubomatic: config/rubocop.yml
|
43
|
+
|
44
|
+
Naming/VariableNumber:
|
45
|
+
inherit_mode:
|
46
|
+
merge:
|
47
|
+
- AllowedIdentifiers
|
48
|
+
AllowedIdentifiers:
|
49
|
+
- street_2
|
50
|
+
----
|
51
|
+
|
52
|
+
[source,yaml]
|
53
|
+
----
|
54
|
+
# Completely override Naming/VariableNumber.AllowedIdentifiers
|
55
|
+
inherit_gem:
|
56
|
+
rubocop-rubomatic: config/rubocop.yml
|
57
|
+
|
58
|
+
Naming/VariableNumber:
|
59
|
+
inherit_mode:
|
60
|
+
override:
|
61
|
+
- AllowedIdentifiers
|
62
|
+
AllowedIdentifiers:
|
63
|
+
- street_2
|
64
|
+
----
|
65
|
+
|
66
|
+
== Custom Cops
|
67
|
+
|
68
|
+
Add ``Rubomatic/*`` cops to your ``.rubocop.yml`` config file
|
69
|
+
|
70
|
+
[source,yaml]
|
71
|
+
----
|
72
|
+
Rubomatic/Style/DisallowedMethods:
|
73
|
+
Enabled: true
|
74
|
+
----
|
75
|
+
|
76
|
+
== Departments
|
77
|
+
|
78
|
+
* xref:./docs/cops/layout/README.adoc[``Layout``]
|
79
|
+
* xref:./docs/cops/style/README.adoc[``Style``]
|
80
|
+
|
81
|
+
== Contributing
|
82
|
+
|
83
|
+
See xref:./CONTRIBUTING.adoc[CONTRIBUTING] for how to add your own rule
|
84
|
+
|
85
|
+
== Changelog
|
86
|
+
|
87
|
+
See xref:./CHANGELOG.adoc[CHANGELOG] see see changes * xref:./docs/cops/super_cool/README.adoc[``SuperCool``]
|
data/config/bundler.yml
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
Bundler/DuplicatedGem:
|
2
|
+
Description: 'Checks for duplicate gem entries in Gemfile.'
|
3
|
+
Enabled: true
|
4
|
+
Severity: warning
|
5
|
+
VersionAdded: '0.46'
|
6
|
+
VersionChanged: '1.40'
|
7
|
+
Include:
|
8
|
+
- '**/*.gemfile'
|
9
|
+
- '**/Gemfile'
|
10
|
+
- '**/gems.rb'
|
11
|
+
|
12
|
+
Bundler/GemComment:
|
13
|
+
Description: 'Add a comment describing each gem.'
|
14
|
+
Enabled: false
|
15
|
+
VersionAdded: '0.59'
|
16
|
+
VersionChanged: '0.85'
|
17
|
+
Include:
|
18
|
+
- '**/*.gemfile'
|
19
|
+
- '**/Gemfile'
|
20
|
+
- '**/gems.rb'
|
21
|
+
IgnoredGems: [ ]
|
22
|
+
OnlyFor: [ ]
|
23
|
+
|
24
|
+
Bundler/GemFilename:
|
25
|
+
Description: 'Enforces the filename for managing gems.'
|
26
|
+
Enabled: true
|
27
|
+
VersionAdded: '1.20'
|
28
|
+
EnforcedStyle: 'Gemfile'
|
29
|
+
SupportedStyles:
|
30
|
+
- 'Gemfile'
|
31
|
+
- 'gems.rb'
|
32
|
+
Include:
|
33
|
+
- '**/Gemfile'
|
34
|
+
- '**/gems.rb'
|
35
|
+
- '**/Gemfile.lock'
|
36
|
+
- '**/gems.locked'
|
37
|
+
|
38
|
+
Bundler/GemVersion:
|
39
|
+
Description: 'Requires or forbids specifying gem versions.'
|
40
|
+
Enabled: true
|
41
|
+
VersionAdded: '1.14'
|
42
|
+
EnforcedStyle: 'required'
|
43
|
+
SupportedStyles:
|
44
|
+
- 'required'
|
45
|
+
- 'forbidden'
|
46
|
+
Include:
|
47
|
+
- '**/*.gemfile'
|
48
|
+
- '**/Gemfile'
|
49
|
+
- '**/gems.rb'
|
50
|
+
AllowedGems: [ ]
|
51
|
+
|
52
|
+
Bundler/InsecureProtocolSource:
|
53
|
+
Description: >-
|
54
|
+
The source `:gemcutter`, `:rubygems` and `:rubyforge` are deprecated
|
55
|
+
because HTTP requests are insecure. Please change your source to
|
56
|
+
'https://rubygems.org' if possible, or 'http://rubygems.org' if not.
|
57
|
+
Enabled: true
|
58
|
+
Severity: warning
|
59
|
+
VersionAdded: '0.50'
|
60
|
+
VersionChanged: '1.40'
|
61
|
+
AllowHttpProtocol: true
|
62
|
+
Include:
|
63
|
+
- '**/*.gemfile'
|
64
|
+
- '**/Gemfile'
|
65
|
+
- '**/gems.rb'
|
66
|
+
|
67
|
+
Bundler/OrderedGems:
|
68
|
+
Description: >-
|
69
|
+
Gems within groups in the Gemfile should be alphabetically sorted.
|
70
|
+
Enabled: false
|
71
|
+
VersionAdded: '0.46'
|
72
|
+
VersionChanged: '0.47'
|
73
|
+
TreatCommentsAsGroupSeparators: true
|
74
|
+
# By default, "-" and "_" are ignored for order purposes.
|
75
|
+
# This can be overridden by setting this parameter to true.
|
76
|
+
ConsiderPunctuation: false
|
77
|
+
Include:
|
78
|
+
- '**/*.gemfile'
|
79
|
+
- '**/Gemfile'
|
80
|
+
- '**/gems.rb'
|
data/config/default.yml
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
Rubomatic/Layout/MultilineArrayLineBreaks:
|
2
|
+
Description: 'Extends base Layout/MultilineArrayLineBreaks cop'
|
3
|
+
Enabled: true
|
4
|
+
VersionAdded: '1.4.0'
|
5
|
+
AllowMultilineFinalElement: true
|
6
|
+
AllowPercentArray: true
|
7
|
+
|
8
|
+
Rubomatic/Style/DisallowedMethods:
|
9
|
+
Description: 'Disallows the usage of `#abort` and `#tap` methods'
|
10
|
+
Enabled: true
|
11
|
+
VersionAdded: '0.0.2'
|
12
|
+
|
13
|
+
Rubomatic/SuperCool/Cop:
|
14
|
+
Description: 'TODO: Write a description of the cop.'
|
15
|
+
Enabled: pending
|
16
|
+
VersionAdded: '<<next>>'
|
data/config/gemspec.yml
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
Gemspec/DependencyVersion:
|
2
|
+
Description: 'Requires or forbids specifying gem dependency versions.'
|
3
|
+
Enabled: true
|
4
|
+
VersionAdded: '1.29'
|
5
|
+
EnforcedStyle: 'required'
|
6
|
+
SupportedStyles:
|
7
|
+
- 'required'
|
8
|
+
- 'forbidden'
|
9
|
+
Include:
|
10
|
+
- '**/*.gemspec'
|
11
|
+
AllowedGems: [ ]
|
12
|
+
|
13
|
+
Gemspec/DeprecatedAttributeAssignment:
|
14
|
+
Description: Checks that deprecated attribute assignments are not set in a gemspec file.
|
15
|
+
Enabled: true
|
16
|
+
Severity: warning
|
17
|
+
VersionAdded: '1.30'
|
18
|
+
VersionChanged: '1.40'
|
19
|
+
Include:
|
20
|
+
- '**/*.gemspec'
|
21
|
+
|
22
|
+
Gemspec/DuplicatedAssignment:
|
23
|
+
Description: 'An attribute assignment method calls should be listed only once in a gemspec.'
|
24
|
+
Enabled: true
|
25
|
+
Severity: warning
|
26
|
+
VersionAdded: '0.52'
|
27
|
+
VersionChanged: '1.40'
|
28
|
+
Include:
|
29
|
+
- '**/*.gemspec'
|
30
|
+
|
31
|
+
Gemspec/OrderedDependencies:
|
32
|
+
Description: >-
|
33
|
+
Dependencies in the gemspec should be alphabetically sorted.
|
34
|
+
Enabled: true
|
35
|
+
VersionAdded: '0.51'
|
36
|
+
TreatCommentsAsGroupSeparators: true
|
37
|
+
# By default, "-" and "_" are ignored for order purposes.
|
38
|
+
# This can be overridden by setting this parameter to true.
|
39
|
+
ConsiderPunctuation: false
|
40
|
+
Include:
|
41
|
+
- '**/*.gemspec'
|
42
|
+
|
43
|
+
Gemspec/RequireMFA:
|
44
|
+
Description: 'Checks that the gemspec has metadata to require Multi-Factor Authentication from RubyGems.'
|
45
|
+
Enabled: true
|
46
|
+
Severity: warning
|
47
|
+
VersionAdded: '1.23'
|
48
|
+
VersionChanged: '1.40'
|
49
|
+
Reference:
|
50
|
+
- https://guides.rubygems.org/mfa-requirement-opt-in/
|
51
|
+
Include:
|
52
|
+
- '**/*.gemspec'
|
53
|
+
|
54
|
+
Gemspec/RequiredRubyVersion:
|
55
|
+
Description: 'Checks that `required_ruby_version` of gemspec is specified and equal to `TargetRubyVersion` of .rubocop.yml.'
|
56
|
+
Enabled: true
|
57
|
+
Severity: warning
|
58
|
+
VersionAdded: '0.52'
|
59
|
+
VersionChanged: '1.40'
|
60
|
+
Include:
|
61
|
+
- '**/*.gemspec'
|
62
|
+
|
63
|
+
Gemspec/RubyVersionGlobalsUsage:
|
64
|
+
Description: Checks usage of RUBY_VERSION in gemspec.
|
65
|
+
StyleGuide: '#no-ruby-version-in-the-gemspec'
|
66
|
+
Enabled: true
|
67
|
+
Severity: warning
|
68
|
+
VersionAdded: '0.72'
|
69
|
+
VersionChanged: '1.40'
|
70
|
+
Include:
|
71
|
+
- '**/*.gemspec'
|
72
|
+
|
73
|
+
Naming/FileName:
|
74
|
+
Enabled: false
|