docquet 1.0.0
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.md +20 -0
- data/LICENSE +21 -0
- data/README.md +205 -0
- data/config/cops/bundler.yml +19 -0
- data/config/cops/capybara.yml +1 -0
- data/config/cops/capybara_rspec.yml +1 -0
- data/config/cops/gemspec.yml +4 -0
- data/config/cops/i18n_gettext.yml +2 -0
- data/config/cops/i18n_railsi18n.yml +1 -0
- data/config/cops/layout.yml +79 -0
- data/config/cops/lint.yml +7 -0
- data/config/cops/metrics.yml +14 -0
- data/config/cops/migration.yml +2 -0
- data/config/cops/naming.yml +4 -0
- data/config/cops/performance.yml +7 -0
- data/config/cops/rake.yml +5 -0
- data/config/cops/rspec.yml +41 -0
- data/config/cops/security.yml +1 -0
- data/config/cops/sequel.yml +2 -0
- data/config/cops/style.yml +153 -0
- data/config/cops/thread_safety.yml +5 -0
- data/config/defaults/bundler.yml +97 -0
- data/config/defaults/capybara.yml +103 -0
- data/config/defaults/capybara_rspec.yml +24 -0
- data/config/defaults/gemspec.yml +121 -0
- data/config/defaults/i18n_gettext.yml +20 -0
- data/config/defaults/i18n_railsi18n.yml +9 -0
- data/config/defaults/layout.yml +1121 -0
- data/config/defaults/lint.yml +1315 -0
- data/config/defaults/metrics.yml +119 -0
- data/config/defaults/migration.yml +9 -0
- data/config/defaults/naming.yml +332 -0
- data/config/defaults/performance.yml +445 -0
- data/config/defaults/rake.yml +34 -0
- data/config/defaults/rspec.yml +1081 -0
- data/config/defaults/security.yml +67 -0
- data/config/defaults/sequel.yml +59 -0
- data/config/defaults/style.yml +2985 -0
- data/config/defaults/thread_safety.yml +45 -0
- data/exe/docquet +7 -0
- data/lib/docquet/cli/base.rb +21 -0
- data/lib/docquet/cli/install_config.rb +75 -0
- data/lib/docquet/cli/regenerate_todo.rb +46 -0
- data/lib/docquet/cli.rb +6 -0
- data/lib/docquet/commands.rb +12 -0
- data/lib/docquet/config_processor.rb +52 -0
- data/lib/docquet/generators/rubocop_yml_generator.rb +78 -0
- data/lib/docquet/inflector.rb +22 -0
- data/lib/docquet/plugin_detector.rb +29 -0
- data/lib/docquet/rake_task.rb +126 -0
- data/lib/docquet/version.rb +6 -0
- data/lib/docquet.rb +17 -0
- data/templates/rubocop.yml.erb +35 -0
- metadata +172 -0
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Department 'Security' (7):
|
|
2
|
+
# https://docs.rubocop.org/rubocop/cops_security.html#securitycompoundhash
|
|
3
|
+
Security/CompoundHash:
|
|
4
|
+
Description: When overwriting Object#hash to combine values, prefer delegating to
|
|
5
|
+
Array#hash over writing a custom implementation.
|
|
6
|
+
Enabled: true # was pending
|
|
7
|
+
Safe: false
|
|
8
|
+
VersionAdded: '1.28'
|
|
9
|
+
VersionChanged: '1.51'
|
|
10
|
+
|
|
11
|
+
# https://docs.rubocop.org/rubocop/cops_security.html#securityeval
|
|
12
|
+
Security/Eval:
|
|
13
|
+
Description: The use of eval represents a serious security risk.
|
|
14
|
+
Enabled: true
|
|
15
|
+
VersionAdded: '0.47'
|
|
16
|
+
|
|
17
|
+
# Supports --autocorrect
|
|
18
|
+
# https://docs.rubocop.org/rubocop/cops_security.html#securityiomethods
|
|
19
|
+
Security/IoMethods:
|
|
20
|
+
Description: Checks for the first argument to `IO.read`, `IO.binread`, `IO.write`,
|
|
21
|
+
`IO.binwrite`, `IO.foreach`, and `IO.readlines`.
|
|
22
|
+
Enabled: true # was pending
|
|
23
|
+
Safe: false
|
|
24
|
+
VersionAdded: '1.22'
|
|
25
|
+
|
|
26
|
+
# Supports --autocorrect
|
|
27
|
+
# https://docs.rubocop.org/rubocop/cops_security.html#securityjsonload
|
|
28
|
+
Security/JSONLoad:
|
|
29
|
+
Description: Prefer usage of `JSON.parse` over `JSON.load` due to potential security
|
|
30
|
+
issues. See reference for more information.
|
|
31
|
+
References:
|
|
32
|
+
- https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html#method-i-load
|
|
33
|
+
- https://bugs.ruby-lang.org/issues/19528
|
|
34
|
+
Enabled: true
|
|
35
|
+
VersionAdded: '0.43'
|
|
36
|
+
VersionChanged: '1.22'
|
|
37
|
+
SafeAutoCorrect: false
|
|
38
|
+
|
|
39
|
+
# https://docs.rubocop.org/rubocop/cops_security.html#securitymarshalload
|
|
40
|
+
Security/MarshalLoad:
|
|
41
|
+
Description: Avoid using of `Marshal.load` or `Marshal.restore` due to potential security
|
|
42
|
+
issues. See reference for more information.
|
|
43
|
+
References:
|
|
44
|
+
- https://ruby-doc.org/core-2.7.0/Marshal.html#module-Marshal-label-Security+considerations
|
|
45
|
+
Enabled: true
|
|
46
|
+
VersionAdded: '0.47'
|
|
47
|
+
|
|
48
|
+
# https://docs.rubocop.org/rubocop/cops_security.html#securityopen
|
|
49
|
+
Security/Open:
|
|
50
|
+
Description: The use of `Kernel#open` and `URI.open` represent a serious security
|
|
51
|
+
risk.
|
|
52
|
+
Enabled: true
|
|
53
|
+
VersionAdded: '0.53'
|
|
54
|
+
VersionChanged: '1.0'
|
|
55
|
+
Safe: false
|
|
56
|
+
|
|
57
|
+
# Supports --autocorrect
|
|
58
|
+
# https://docs.rubocop.org/rubocop/cops_security.html#securityyamlload
|
|
59
|
+
Security/YAMLLoad:
|
|
60
|
+
Description: Prefer usage of `YAML.safe_load` over `YAML.load` due to potential security
|
|
61
|
+
issues. See reference for more information.
|
|
62
|
+
References:
|
|
63
|
+
- https://ruby-doc.org/stdlib-2.7.0/libdoc/yaml/rdoc/YAML.html#module-YAML-label-Security
|
|
64
|
+
Enabled: true
|
|
65
|
+
VersionAdded: '0.47'
|
|
66
|
+
SafeAutoCorrect: false
|
|
67
|
+
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Department 'Sequel' (6):
|
|
2
|
+
# https://docs.rubocop.org/rubocop-sequel/cops_sequel.html#sequelconcurrentindex
|
|
3
|
+
Sequel/ConcurrentIndex:
|
|
4
|
+
Description: Encourages the creation of indexes with the `NOT VALID` option to avoid
|
|
5
|
+
locking tables.
|
|
6
|
+
Reference: https://www.rubydoc.info/gems/rubocop-sequel/RuboCop/Cop/Sequel/ConcurrentIndex
|
|
7
|
+
Enabled: true
|
|
8
|
+
VersionAdded: 0.0.1
|
|
9
|
+
VersionChanged: 0.3.3
|
|
10
|
+
|
|
11
|
+
# https://docs.rubocop.org/rubocop-sequel/cops_sequel.html#sequelirreversiblemigration
|
|
12
|
+
Sequel/IrreversibleMigration:
|
|
13
|
+
Description: Warns against using certain methods inside a migration file's `change`
|
|
14
|
+
block that would cause the migration to become irreversible.
|
|
15
|
+
Reference: https://www.rubydoc.info/gems/rubocop-sequel/RuboCop/Cop/Sequel/IrreversibleMigration
|
|
16
|
+
Enabled: true
|
|
17
|
+
VersionAdded: 0.3.5
|
|
18
|
+
VersionChanged: 0.3.8
|
|
19
|
+
|
|
20
|
+
# https://docs.rubocop.org/rubocop-sequel/cops_sequel.html#sequeljsoncolumn
|
|
21
|
+
Sequel/JSONColumn:
|
|
22
|
+
Description: Advocates the use of the `jsonb` column type over `json` or `hstore`
|
|
23
|
+
for performance benefits and additional functionality.
|
|
24
|
+
Reference: https://www.rubydoc.info/gems/rubocop-sequel/RuboCop/Cop/Sequel/JSONColumn
|
|
25
|
+
Enabled: true
|
|
26
|
+
Safe: false
|
|
27
|
+
VersionAdded: 0.0.1
|
|
28
|
+
VersionChanged: 0.3.3
|
|
29
|
+
|
|
30
|
+
# https://docs.rubocop.org/rubocop-sequel/cops_sequel.html#sequelmigrationname
|
|
31
|
+
Sequel/MigrationName:
|
|
32
|
+
Description: Helps to name migration files descriptively in order to avoid the use
|
|
33
|
+
of default or generic names.
|
|
34
|
+
Reference: https://www.rubydoc.info/gems/rubocop-sequel/RuboCop/Cop/Sequel/MigrationName
|
|
35
|
+
Enabled: true
|
|
36
|
+
VersionAdded: 0.0.1
|
|
37
|
+
VersionChanged: 0.3.3
|
|
38
|
+
DefaultName: new_migration
|
|
39
|
+
|
|
40
|
+
# https://docs.rubocop.org/rubocop-sequel/cops_sequel.html#sequelpartialconstraint
|
|
41
|
+
Sequel/PartialConstraint:
|
|
42
|
+
Description: Advises on the correct use of partial indexes by specifying the `where'
|
|
43
|
+
argument.
|
|
44
|
+
Reference: https://www.rubydoc.info/gems/rubocop-sequel/RuboCop/Cop/Sequel/PartialConstraint
|
|
45
|
+
Enabled: true
|
|
46
|
+
VersionAdded: 0.3.0
|
|
47
|
+
VersionChanged: 0.3.3
|
|
48
|
+
|
|
49
|
+
# Supports --autocorrect
|
|
50
|
+
# https://docs.rubocop.org/rubocop-sequel/cops_sequel.html#sequelsavechanges
|
|
51
|
+
Sequel/SaveChanges:
|
|
52
|
+
Description: Ensures the use of save_changes instead of save to persist changes to
|
|
53
|
+
models.
|
|
54
|
+
Reference: https://www.rubydoc.info/gems/rubocop-sequel/RuboCop/Cop/Sequel/SaveChanges
|
|
55
|
+
Enabled: true
|
|
56
|
+
SafeAutoCorrect: false
|
|
57
|
+
VersionAdded: 0.0.1
|
|
58
|
+
VersionChanged: 0.3.3
|
|
59
|
+
|