rubocop 1.22.3 → 1.25.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.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.txt +1 -1
  3. data/README.md +2 -3
  4. data/config/default.yml +86 -5
  5. data/lib/rubocop/cli/command/auto_genenerate_config.rb +1 -1
  6. data/lib/rubocop/cli/command/init_dotfile.rb +1 -1
  7. data/lib/rubocop/cli/command/show_docs_url.rb +48 -0
  8. data/lib/rubocop/cli/command/suggest_extensions.rb +1 -1
  9. data/lib/rubocop/cli.rb +1 -0
  10. data/lib/rubocop/config_loader_resolver.rb +1 -1
  11. data/lib/rubocop/cop/bundler/duplicated_gem.rb +1 -1
  12. data/lib/rubocop/cop/correctors/each_to_for_corrector.rb +1 -1
  13. data/lib/rubocop/cop/correctors/if_then_corrector.rb +55 -0
  14. data/lib/rubocop/cop/documentation.rb +19 -2
  15. data/lib/rubocop/cop/gemspec/date_assignment.rb +2 -10
  16. data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +1 -10
  17. data/lib/rubocop/cop/gemspec/require_mfa.rb +144 -0
  18. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +10 -3
  19. data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +3 -10
  20. data/lib/rubocop/cop/generator.rb +5 -4
  21. data/lib/rubocop/cop/internal_affairs/redundant_method_dispatch_node.rb +47 -0
  22. data/lib/rubocop/cop/internal_affairs/undefined_config.rb +3 -1
  23. data/lib/rubocop/cop/internal_affairs.rb +1 -0
  24. data/lib/rubocop/cop/layout/argument_alignment.rb +36 -9
  25. data/lib/rubocop/cop/layout/comment_indentation.rb +31 -2
  26. data/lib/rubocop/cop/layout/dot_position.rb +4 -0
  27. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +22 -1
  28. data/lib/rubocop/cop/layout/hash_alignment.rb +1 -1
  29. data/lib/rubocop/cop/layout/space_after_colon.rb +1 -1
  30. data/lib/rubocop/cop/layout/space_before_first_arg.rb +4 -0
  31. data/lib/rubocop/cop/layout/space_in_lambda_literal.rb +11 -5
  32. data/lib/rubocop/cop/lint/ambiguous_range.rb +2 -2
  33. data/lib/rubocop/cop/lint/ambiguous_regexp_literal.rb +5 -1
  34. data/lib/rubocop/cop/lint/constant_definition_in_block.rb +1 -1
  35. data/lib/rubocop/cop/lint/deprecated_class_methods.rb +16 -4
  36. data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb +6 -0
  37. data/lib/rubocop/cop/lint/each_with_object_argument.rb +1 -1
  38. data/lib/rubocop/cop/lint/incompatible_io_select_with_fiber_scheduler.rb +10 -5
  39. data/lib/rubocop/cop/lint/number_conversion.rb +5 -2
  40. data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb +7 -4
  41. data/lib/rubocop/cop/lint/useless_ruby2_keywords.rb +117 -0
  42. data/lib/rubocop/cop/metrics/block_length.rb +1 -0
  43. data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb +0 -9
  44. data/lib/rubocop/cop/metrics/method_length.rb +1 -0
  45. data/lib/rubocop/cop/metrics/module_length.rb +1 -1
  46. data/lib/rubocop/cop/metrics/parameter_lists.rb +1 -1
  47. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +1 -1
  48. data/lib/rubocop/cop/metrics/utils/repeated_attribute_discount.rb +1 -1
  49. data/lib/rubocop/cop/mixin/enforce_superclass.rb +5 -0
  50. data/lib/rubocop/cop/mixin/gemspec_help.rb +30 -0
  51. data/lib/rubocop/cop/mixin/hash_alignment_styles.rb +4 -3
  52. data/lib/rubocop/cop/mixin/hash_shorthand_syntax.rb +68 -0
  53. data/lib/rubocop/cop/mixin/string_literals_help.rb +1 -5
  54. data/lib/rubocop/cop/naming/block_forwarding.rb +121 -0
  55. data/lib/rubocop/cop/naming/file_name.rb +37 -4
  56. data/lib/rubocop/cop/security/open.rb +11 -1
  57. data/lib/rubocop/cop/style/character_literal.rb +8 -1
  58. data/lib/rubocop/cop/style/collection_compact.rb +31 -13
  59. data/lib/rubocop/cop/style/combinable_loops.rb +2 -2
  60. data/lib/rubocop/cop/style/documentation.rb +1 -1
  61. data/lib/rubocop/cop/style/empty_case_condition.rb +10 -0
  62. data/lib/rubocop/cop/style/empty_method.rb +1 -1
  63. data/lib/rubocop/cop/style/file_read.rb +112 -0
  64. data/lib/rubocop/cop/style/file_write.rb +124 -0
  65. data/lib/rubocop/cop/style/format_string_token.rb +2 -1
  66. data/lib/rubocop/cop/style/hash_conversion.rb +2 -1
  67. data/lib/rubocop/cop/style/hash_syntax.rb +36 -0
  68. data/lib/rubocop/cop/style/hash_transform_keys.rb +6 -6
  69. data/lib/rubocop/cop/style/hash_transform_values.rb +6 -6
  70. data/lib/rubocop/cop/style/if_inside_else.rb +15 -0
  71. data/lib/rubocop/cop/style/if_with_boolean_literal_branches.rb +1 -1
  72. data/lib/rubocop/cop/style/map_to_hash.rb +68 -0
  73. data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +14 -0
  74. data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +3 -1
  75. data/lib/rubocop/cop/style/method_def_parentheses.rb +17 -13
  76. data/lib/rubocop/cop/style/numeric_literals.rb +10 -1
  77. data/lib/rubocop/cop/style/one_line_conditional.rb +18 -39
  78. data/lib/rubocop/cop/style/open_struct_use.rb +69 -0
  79. data/lib/rubocop/cop/style/parentheses_around_condition.rb +12 -2
  80. data/lib/rubocop/cop/style/quoted_symbols.rb +11 -1
  81. data/lib/rubocop/cop/style/redundant_interpolation.rb +17 -3
  82. data/lib/rubocop/cop/style/redundant_regexp_character_class.rb +5 -1
  83. data/lib/rubocop/cop/style/redundant_self.rb +1 -1
  84. data/lib/rubocop/cop/style/safe_navigation.rb +1 -5
  85. data/lib/rubocop/cop/style/sample.rb +5 -3
  86. data/lib/rubocop/cop/style/single_line_block_params.rb +2 -2
  87. data/lib/rubocop/cop/style/sole_nested_conditional.rb +3 -1
  88. data/lib/rubocop/cop/style/ternary_parentheses.rb +16 -2
  89. data/lib/rubocop/cop/team.rb +1 -1
  90. data/lib/rubocop/cop/util.rb +9 -1
  91. data/lib/rubocop/formatter/html_formatter.rb +5 -2
  92. data/lib/rubocop/formatter/json_formatter.rb +4 -1
  93. data/lib/rubocop/options.rb +6 -1
  94. data/lib/rubocop/remote_config.rb +2 -4
  95. data/lib/rubocop/result_cache.rb +1 -1
  96. data/lib/rubocop/version.rb +1 -1
  97. data/lib/rubocop/yaml_duplication_checker.rb +1 -1
  98. data/lib/rubocop.rb +11 -0
  99. metadata +20 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f74b024d0339618cd4782bd451e3bbe8be65eab0a5f3dbfc1d2137c74848c6fa
4
- data.tar.gz: ef762c615b2d68f52d5aac425abea13a40d097f1b7885cd1558a991dd23c136d
3
+ metadata.gz: 0e565e6065561954dc1aa6db221e2f6cf7753a96b40bf863a571243a2b567d84
4
+ data.tar.gz: e489fdb8174dcc6f755ae18bf57091188808e3649db33ae0c282c507b0ec4f54
5
5
  SHA512:
6
- metadata.gz: bfdba4bbc01e69d2a0873272815dc9c03d5e95f2dce5f02186b38f2f9e1e28ae34df246e6b548cdccf0831bace4f02bfad334f59548b2bf67430431b5760731b
7
- data.tar.gz: 662e06452c13b66a949e7a8035bc6b4b31e7af7a3cf161b9802634365a53a0b2452aeb7741ab13387186483cdf9027dc5cca736734d5d3022f78362bfabf9a5c
6
+ metadata.gz: 2c01d7352515c439403d4f479583d4099f4ac339ab8a26503ad6b6fd90db54d5a4bcddd6fc2d2e48f3de8faf2928f0f0930c938a5b22a7cfe1759199f68e873a
7
+ data.tar.gz: 3075cb42f837c728c31a936ddf1a61ba5d6aafcae9a984a97d05a519089ef7b9c4ff164cf9e3d45e1cd0ab6505a2348f4870bb6c0044e011c45eae04de123e45
data/LICENSE.txt CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2012-21 Bozhidar Batsov
1
+ Copyright (c) 2012-22 Bozhidar Batsov
2
2
 
3
3
  Permission is hereby granted, free of charge, to any person obtaining
4
4
  a copy of this software and associated documentation files (the
data/README.md CHANGED
@@ -9,7 +9,6 @@
9
9
  [![Actions Status](https://github.com/rubocop/rubocop/workflows/CI/badge.svg?branch=master)](https://github.com/rubocop/rubocop/actions?query=workflow%3ACI)
10
10
  [![Test Coverage](https://api.codeclimate.com/v1/badges/d2d67f728e88ea84ac69/test_coverage)](https://codeclimate.com/github/rubocop/rubocop/test_coverage)
11
11
  [![Maintainability](https://api.codeclimate.com/v1/badges/d2d67f728e88ea84ac69/maintainability)](https://codeclimate.com/github/rubocop/rubocop/maintainability)
12
- [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)
13
12
  [![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/wJjWvGRDmm)
14
13
 
15
14
  > Role models are important. <br/>
@@ -54,7 +53,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
54
53
  in your `Gemfile`:
55
54
 
56
55
  ```rb
57
- gem 'rubocop', '~> 1.22', require: false
56
+ gem 'rubocop', '~> 1.25', require: false
58
57
  ```
59
58
 
60
59
  See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.
@@ -245,5 +244,5 @@ RuboCop's changelog is available [here](CHANGELOG.md).
245
244
 
246
245
  ## Copyright
247
246
 
248
- Copyright (c) 2012-2021 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
247
+ Copyright (c) 2012-2022 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
249
248
  further details.
data/config/default.yml CHANGED
@@ -78,6 +78,8 @@ AllCops:
78
78
  # When specifying style guide URLs, any paths and/or fragments will be
79
79
  # evaluated relative to the base URL.
80
80
  StyleGuideBaseURL: https://rubystyle.guide
81
+ # Documentation URLs will be constructed using the base URL.
82
+ DocumentationBaseURL: https://docs.rubocop.org/rubocop
81
83
  # Extra details are not displayed in offense messages by default. Change
82
84
  # behavior by overriding ExtraDetails, or by giving the
83
85
  # `-E/--extra-details` option.
@@ -150,6 +152,7 @@ AllCops:
150
152
  rubocop-minitest: [minitest]
151
153
  rubocop-sequel: [sequel]
152
154
  rubocop-rake: [rake]
155
+ rubocop-graphql: [graphql]
153
156
 
154
157
  #################### Bundler ###############################
155
158
 
@@ -258,6 +261,15 @@ Gemspec/OrderedDependencies:
258
261
  Include:
259
262
  - '**/*.gemspec'
260
263
 
264
+ Gemspec/RequireMFA:
265
+ Description: 'Checks that the gemspec has metadata to require MFA from RubyGems.'
266
+ Enabled: pending
267
+ VersionAdded: '1.23'
268
+ Reference:
269
+ - https://guides.rubygems.org/mfa-requirement-opt-in/
270
+ Include:
271
+ - '**/*.gemspec'
272
+
261
273
  Gemspec/RequiredRubyVersion:
262
274
  Description: 'Checks that `required_ruby_version` of gemspec is specified and equal to `TargetRubyVersion` of .rubocop.yml.'
263
275
  Enabled: true
@@ -439,7 +451,11 @@ Layout/ClosingParenthesisIndentation:
439
451
  Layout/CommentIndentation:
440
452
  Description: 'Indentation of comments.'
441
453
  Enabled: true
454
+ # When true, allows comments to have extra indentation if that aligns them
455
+ # with a comment on the preceding line.
456
+ AllowForAlignment: false
442
457
  VersionAdded: '0.49'
458
+ VersionChanged: '1.24'
443
459
 
444
460
  Layout/ConditionPosition:
445
461
  Description: >-
@@ -511,13 +527,13 @@ Layout/EmptyLineBetweenDefs:
511
527
  StyleGuide: '#empty-lines-between-methods'
512
528
  Enabled: true
513
529
  VersionAdded: '0.49'
514
- VersionChanged: '1.7'
530
+ VersionChanged: '1.23'
515
531
  EmptyLineBetweenMethodDefs: true
516
532
  EmptyLineBetweenClassDefs: true
517
533
  EmptyLineBetweenModuleDefs: true
518
- # If `true`, this parameter means that single line method definitions don't
519
- # need an empty line between them.
520
- AllowAdjacentOneLineDefs: false
534
+ # `AllowAdjacentOneLineDefs` means that single line method definitions don't
535
+ # need an empty line between them. `true` by default.
536
+ AllowAdjacentOneLineDefs: true
521
537
  # Can be array to specify minimum and maximum number of empty lines, e.g. [1, 2]
522
538
  NumberOfEmptyLines: 1
523
539
 
@@ -1786,7 +1802,9 @@ Lint/ImplicitStringConcatenation:
1786
1802
  Lint/IncompatibleIoSelectWithFiberScheduler:
1787
1803
  Description: 'Checks for `IO.select` that is incompatible with Fiber Scheduler.'
1788
1804
  Enabled: pending
1805
+ SafeAutoCorrect: false
1789
1806
  VersionAdded: '1.21'
1807
+ VersionChanged: '1.24'
1790
1808
 
1791
1809
  Lint/IneffectiveAccessModifier:
1792
1810
  Description: >-
@@ -2308,6 +2326,11 @@ Lint/UselessMethodDefinition:
2308
2326
  Safe: false
2309
2327
  AllowComments: true
2310
2328
 
2329
+ Lint/UselessRuby2Keywords:
2330
+ Description: 'Finds unnecessary uses of `ruby2_keywords`.'
2331
+ Enabled: pending
2332
+ VersionAdded: '1.23'
2333
+
2311
2334
  Lint/UselessSetterCall:
2312
2335
  Description: 'Checks for useless setter call to a local variable.'
2313
2336
  Enabled: true
@@ -2464,6 +2487,17 @@ Naming/BinaryOperatorParameterName:
2464
2487
  VersionAdded: '0.50'
2465
2488
  VersionChanged: '1.2'
2466
2489
 
2490
+ Naming/BlockForwarding:
2491
+ Description: 'Use anonymous block forwarding.'
2492
+ StyleGuide: '#block-forwarding'
2493
+ Enabled: pending
2494
+ VersionAdded: '1.24'
2495
+ EnforcedStyle: anonymous
2496
+ SupportedStyles:
2497
+ - anonymous
2498
+ - explicit
2499
+ BlockForwardingName: block
2500
+
2467
2501
  Naming/BlockParameterName:
2468
2502
  Description: >-
2469
2503
  Checks for block parameter names that contain capital letters,
@@ -2501,6 +2535,7 @@ Naming/FileName:
2501
2535
  StyleGuide: '#snake-case-files'
2502
2536
  Enabled: true
2503
2537
  VersionAdded: '0.50'
2538
+ VersionChanged: '1.23'
2504
2539
  # Camel case file names listed in `AllCops:Include` and all file names listed
2505
2540
  # in `AllCops:Exclude` are excluded by default. Add extra excludes here.
2506
2541
  Exclude: []
@@ -2513,6 +2548,13 @@ Naming/FileName:
2513
2548
  # whether each source file's class or module name matches the file name --
2514
2549
  # not whether the nested module hierarchy matches the subdirectory path.
2515
2550
  CheckDefinitionPathHierarchy: true
2551
+ # paths that are considered root directories, for example "lib" in most ruby projects
2552
+ # or "app/models" in rails projects
2553
+ CheckDefinitionPathHierarchyRoots:
2554
+ - lib
2555
+ - spec
2556
+ - test
2557
+ - src
2516
2558
  # If non-`nil`, expect all source file names to match the following regex.
2517
2559
  # Only the file name itself is matched, not the entire file path.
2518
2560
  # Use anchors as necessary if you want to match the entire name rather than
@@ -3469,6 +3511,18 @@ Style/ExponentialNotation:
3469
3511
  - engineering
3470
3512
  - integral
3471
3513
 
3514
+ Style/FileRead:
3515
+ Description: 'Favor `File.(bin)read` convenience methods.'
3516
+ StyleGuide: '#file-read'
3517
+ Enabled: pending
3518
+ VersionAdded: '1.24'
3519
+
3520
+ Style/FileWrite:
3521
+ Description: 'Favor `File.(bin)write` convenience methods.'
3522
+ StyleGuide: '#file-write'
3523
+ Enabled: pending
3524
+ VersionAdded: '1.24'
3525
+
3472
3526
  Style/FloatDivision:
3473
3527
  Description: 'For performing float division, coerce one side only.'
3474
3528
  StyleGuide: '#float-division'
@@ -3627,7 +3681,7 @@ Style/HashSyntax:
3627
3681
  StyleGuide: '#hash-literals'
3628
3682
  Enabled: true
3629
3683
  VersionAdded: '0.9'
3630
- VersionChanged: '0.43'
3684
+ VersionChanged: '1.24'
3631
3685
  EnforcedStyle: ruby19
3632
3686
  SupportedStyles:
3633
3687
  # checks for 1.9 syntax (e.g. {a: 1}) for all symbol keys
@@ -3638,6 +3692,15 @@ Style/HashSyntax:
3638
3692
  - no_mixed_keys
3639
3693
  # enforces both ruby19 and no_mixed_keys styles
3640
3694
  - ruby19_no_mixed_keys
3695
+ # Force hashes that have a hash value omission
3696
+ EnforcedShorthandSyntax: always
3697
+ SupportedShorthandSyntax:
3698
+ # forces use of the 3.1 syntax (e.g. {foo:}) when the hash key and value are the same.
3699
+ - always
3700
+ # forces use of explicit hash literal value.
3701
+ - never
3702
+ # accepts both shorthand and explicit use of hash literal value.
3703
+ - either
3641
3704
  # Force hashes that have a symbol value to use hash rockets
3642
3705
  UseHashRocketsWithSymbolValues: false
3643
3706
  # Do not suggest { a?: 1 } over { :a? => 1 } in ruby19 style
@@ -3814,6 +3877,12 @@ Style/LineEndConcatenation:
3814
3877
  VersionAdded: '0.18'
3815
3878
  VersionChanged: '0.64'
3816
3879
 
3880
+ Style/MapToHash:
3881
+ Description: 'Prefer `to_h` with a block over `map.to_h`.'
3882
+ Enabled: pending
3883
+ VersionAdded: '1.24'
3884
+ Safe: false
3885
+
3817
3886
  Style/MethodCallWithArgsParentheses:
3818
3887
  Description: 'Use parentheses for method calls with arguments.'
3819
3888
  StyleGuide: '#method-invocation-parens'
@@ -4182,6 +4251,8 @@ Style/NumericLiterals:
4182
4251
  VersionChanged: '0.48'
4183
4252
  MinDigits: 5
4184
4253
  Strict: false
4254
+ # You can specify allowed numbers. (e.g. port number 3000, 8080, and etc)
4255
+ AllowedNumbers: []
4185
4256
 
4186
4257
  Style/NumericPredicate:
4187
4258
  Description: >-
@@ -4216,6 +4287,16 @@ Style/OneLineConditional:
4216
4287
  VersionAdded: '0.9'
4217
4288
  VersionChanged: '0.90'
4218
4289
 
4290
+ Style/OpenStructUse:
4291
+ Description: >-
4292
+ Avoid using OpenStruct. As of Ruby 3.0, use is officially discouraged due to performance,
4293
+ version compatibility, and potential security issues.
4294
+ Reference:
4295
+ - https://docs.ruby-lang.org/en/3.0.0/OpenStruct.html#class-OpenStruct-label-Caveats
4296
+
4297
+ Enabled: pending
4298
+ VersionAdded: '1.23'
4299
+
4219
4300
  Style/OptionHash:
4220
4301
  Description: "Don't use option hashes when you can use keyword arguments."
4221
4302
  Enabled: false
@@ -124,7 +124,7 @@ module RuboCop
124
124
  lines = /\S/.match?(rubocop_yml_contents) ? rubocop_yml_contents.split("\n", -1) : []
125
125
  doc_start_index = lines.index { |line| YAML_OPTIONAL_DOC_START.match?(line) } || -1
126
126
  lines.insert(doc_start_index + 1, "inherit_from:#{file_string}\n")
127
- File.open(file_name, 'w') { |f| f.write lines.join("\n") }
127
+ File.write(file_name, lines.join("\n"))
128
128
  end
129
129
  end
130
130
  end
@@ -31,7 +31,7 @@ module RuboCop
31
31
  # See https://docs.rubocop.org/rubocop/configuration
32
32
  DESC
33
33
 
34
- File.open(DOTFILE, 'w') { |f| f.write(description) }
34
+ File.write(DOTFILE, description)
35
35
 
36
36
  puts "Writing new #{DOTFILE} to #{path}"
37
37
 
@@ -0,0 +1,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ class CLI
5
+ module Command
6
+ # Prints out url to documentation of provided cops
7
+ # or documentation base url by default.
8
+ # @api private
9
+ class ShowDocsUrl < Base
10
+ self.command_name = :show_docs_url
11
+
12
+ def initialize(env)
13
+ super
14
+
15
+ @config = @config_store.for(Dir.pwd)
16
+ end
17
+
18
+ def run
19
+ print_documentation_url
20
+ end
21
+
22
+ private
23
+
24
+ def print_documentation_url
25
+ puts Cop::Documentation.default_base_url if cops_array.empty?
26
+
27
+ cops_array.each do |cop_name|
28
+ cop = registry_hash[cop_name]
29
+
30
+ next if cop.empty?
31
+
32
+ puts Cop::Documentation.url_for(cop.first, @config)
33
+ end
34
+
35
+ puts
36
+ end
37
+
38
+ def cops_array
39
+ @cops_array ||= @options[:show_docs_url]
40
+ end
41
+
42
+ def registry_hash
43
+ @registry_hash ||= Cop::Registry.global.to_h
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -22,7 +22,7 @@ module RuboCop
22
22
  'RuboCop extension libraries might be helpful:'
23
23
 
24
24
  extensions.sort.each do |extension|
25
- puts " * #{extension} (https://github.com/rubocop/#{extension})"
25
+ puts " * #{extension} (https://rubygems.org/gems/#{extension})"
26
26
  end
27
27
 
28
28
  puts
data/lib/rubocop/cli.rb CHANGED
@@ -131,6 +131,7 @@ module RuboCop
131
131
 
132
132
  run_command(:version) if @options[:version] || @options[:verbose_version]
133
133
  run_command(:show_cops) if @options[:show_cops]
134
+ run_command(:show_docs_url) if @options[:show_docs_url]
134
135
  raise Finished
135
136
  end
136
137
 
@@ -74,7 +74,7 @@ module RuboCop
74
74
  # Merges the given configuration with the default one. If
75
75
  # AllCops:DisabledByDefault is true, it changes the Enabled params so that
76
76
  # only cops from user configuration are enabled. If
77
- # AllCops::EnabledByDefault is true, it changes the Enabled params so that
77
+ # AllCops:EnabledByDefault is true, it changes the Enabled params so that
78
78
  # only cops explicitly disabled in user configuration are disabled.
79
79
  def merge_with_default(config, config_file, unset_nil:)
80
80
  default_configuration = ConfigLoader.default_configuration
@@ -68,7 +68,7 @@ module RuboCop
68
68
  end
69
69
 
70
70
  def conditional_declaration?(nodes)
71
- parent = nodes[0].parent
71
+ parent = nodes[0].each_ancestor.find { |ancestor| !ancestor.begin_type? }
72
72
  return false unless parent&.if_type? || parent&.when_type?
73
73
 
74
74
  root_conditional_node = parent.if_type? ? parent : parent.parent
@@ -11,7 +11,7 @@ module RuboCop
11
11
 
12
12
  def initialize(block_node)
13
13
  @block_node = block_node
14
- @collection_node = block_node.send_node.receiver
14
+ @collection_node = block_node.receiver
15
15
  @argument_node = block_node.arguments
16
16
  end
17
17
 
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Cop
5
+ # This class auto-corrects `if...then` structures to a multiline `if` statement
6
+ class IfThenCorrector
7
+ DEFAULT_INDENTATION_WIDTH = 2
8
+
9
+ def initialize(if_node, indentation: nil)
10
+ @if_node = if_node
11
+ @indentation = indentation || DEFAULT_INDENTATION_WIDTH
12
+ end
13
+
14
+ def call(corrector)
15
+ corrector.replace(if_node, replacement)
16
+ end
17
+
18
+ private
19
+
20
+ attr_reader :if_node, :indentation
21
+
22
+ def replacement(node = if_node, indentation = nil)
23
+ indentation = ' ' * node.source_range.column if indentation.nil?
24
+ if_branch_source = node.if_branch&.source || 'nil'
25
+ elsif_indentation = indentation if node.respond_to?(:elsif?) && node.elsif?
26
+
27
+ if_branch = <<~RUBY
28
+ #{elsif_indentation}#{node.keyword} #{node.condition.source}
29
+ #{indentation}#{branch_body_indentation}#{if_branch_source}
30
+ RUBY
31
+
32
+ else_branch = rewrite_else_branch(node.else_branch, indentation)
33
+ if_branch + else_branch
34
+ end
35
+
36
+ def rewrite_else_branch(else_branch, indentation)
37
+ if else_branch.nil?
38
+ 'end'
39
+ elsif else_branch.if_type? && else_branch.elsif?
40
+ replacement(else_branch, indentation)
41
+ else
42
+ <<~RUBY.chomp
43
+ #{indentation}else
44
+ #{indentation}#{branch_body_indentation}#{else_branch.source}
45
+ #{indentation}end
46
+ RUBY
47
+ end
48
+ end
49
+
50
+ def branch_body_indentation
51
+ @branch_body_indentation ||= (' ' * indentation).freeze
52
+ end
53
+ end
54
+ end
55
+ end
@@ -12,10 +12,27 @@ module RuboCop
12
12
  end
13
13
 
14
14
  # @api private
15
- def url_for(cop_class)
15
+ def url_for(cop_class, config = nil)
16
16
  base = department_to_basename(cop_class.department)
17
17
  fragment = cop_class.cop_name.downcase.gsub(/[^a-z]/, '')
18
- "https://docs.rubocop.org/rubocop/#{base}.html##{fragment}"
18
+ base_url = base_url_for(cop_class, config)
19
+
20
+ "#{base_url}/#{base}.html##{fragment}"
21
+ end
22
+
23
+ # @api private
24
+ def base_url_for(cop_class, config)
25
+ return default_base_url unless config
26
+
27
+ department_name = cop_class.department.to_s
28
+
29
+ config.for_department(department_name)['DocumentationBaseURL'] ||
30
+ config.for_all_cops['DocumentationBaseURL']
31
+ end
32
+
33
+ # @api private
34
+ def default_base_url
35
+ 'https://docs.rubocop.org/rubocop'
19
36
  end
20
37
  end
21
38
  end
@@ -21,21 +21,13 @@ module RuboCop
21
21
  #
22
22
  class DateAssignment < Base
23
23
  include RangeHelp
24
+ include GemspecHelp
24
25
  extend AutoCorrector
25
26
 
26
27
  MSG = 'Do not use `date =` in gemspec, it is set automatically when the gem is packaged.'
27
28
 
28
- # @!method gem_specification(node)
29
- def_node_matcher :gem_specification, <<~PATTERN
30
- (block
31
- (send
32
- (const
33
- (const {cbase nil?} :Gem) :Specification) :new)
34
- ...)
35
- PATTERN
36
-
37
29
  def on_block(block_node)
38
- return unless gem_specification(block_node)
30
+ return unless gem_specification?(block_node)
39
31
 
40
32
  block_parameter = block_node.arguments.first.source
41
33
 
@@ -36,20 +36,11 @@ module RuboCop
36
36
  # end
37
37
  class DuplicatedAssignment < Base
38
38
  include RangeHelp
39
+ include GemspecHelp
39
40
 
40
41
  MSG = '`%<assignment>s` method calls already given on line '\
41
42
  '%<line_of_first_occurrence>d of the gemspec.'
42
43
 
43
- # @!method gem_specification(node)
44
- def_node_search :gem_specification, <<~PATTERN
45
- (block
46
- (send
47
- (const
48
- (const {cbase nil?} :Gem) :Specification) :new)
49
- (args
50
- (arg $_)) ...)
51
- PATTERN
52
-
53
44
  # @!method assignment_method_declarations(node)
54
45
  def_node_search :assignment_method_declarations, <<~PATTERN
55
46
  (send
@@ -0,0 +1,144 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Cop
5
+ module Gemspec
6
+ # Requires a gemspec to have `rubygems_mfa_required` metadata set.
7
+ #
8
+ # This setting tells RubyGems that MFA is required for accounts to
9
+ # be able perform privileged operations, such as (see
10
+ # RubyGems' documentation for the full list of privileged operations):
11
+ #
12
+ # * `gem push`
13
+ # * `gem yank`
14
+ # * `gem owner --add/remove`
15
+ # * adding or removing owners using gem ownership page
16
+ #
17
+ # This helps make your gem more secure, as users can be more
18
+ # confident that gem updates were pushed by maintainers.
19
+ #
20
+ # @example
21
+ # # bad
22
+ # Gem::Specification.new do |spec|
23
+ # # no `rubygems_mfa_required` metadata specified
24
+ # end
25
+ #
26
+ # # good
27
+ # Gem::Specification.new do |spec|
28
+ # spec.metadata = {
29
+ # 'rubygems_mfa_required' => 'true'
30
+ # }
31
+ # end
32
+ #
33
+ # # good
34
+ # Gem::Specification.new do |spec|
35
+ # spec.metadata['rubygems_mfa_required'] = 'true'
36
+ # end
37
+ #
38
+ # # bad
39
+ # Gem::Specification.new do |spec|
40
+ # spec.metadata = {
41
+ # 'rubygems_mfa_required' => 'false'
42
+ # }
43
+ # end
44
+ #
45
+ # # good
46
+ # Gem::Specification.new do |spec|
47
+ # spec.metadata = {
48
+ # 'rubygems_mfa_required' => 'true'
49
+ # }
50
+ # end
51
+ #
52
+ # # bad
53
+ # Gem::Specification.new do |spec|
54
+ # spec.metadata['rubygems_mfa_required'] = 'false'
55
+ # end
56
+ #
57
+ # # good
58
+ # Gem::Specification.new do |spec|
59
+ # spec.metadata['rubygems_mfa_required'] = 'true'
60
+ # end
61
+ #
62
+ class RequireMFA < Base
63
+ include GemspecHelp
64
+ extend AutoCorrector
65
+
66
+ MSG = "`metadata['rubygems_mfa_required']` must be set to `'true'`."
67
+
68
+ # @!method metadata(node)
69
+ def_node_matcher :metadata, <<~PATTERN
70
+ `{
71
+ (send _ :metadata= $_)
72
+ (send (send _ :metadata) :[]= (str "rubygems_mfa_required") $_)
73
+ }
74
+ PATTERN
75
+
76
+ # @!method rubygems_mfa_required(node)
77
+ def_node_search :rubygems_mfa_required, <<~PATTERN
78
+ (pair (str "rubygems_mfa_required") $_)
79
+ PATTERN
80
+
81
+ # @!method true_string?(node)
82
+ def_node_matcher :true_string?, <<~PATTERN
83
+ (str "true")
84
+ PATTERN
85
+
86
+ def on_block(node) # rubocop:disable Metrics/MethodLength
87
+ gem_specification(node) do |block_var|
88
+ metadata_value = metadata(node)
89
+ mfa_value = mfa_value(metadata_value)
90
+
91
+ if mfa_value
92
+ unless true_string?(mfa_value)
93
+ add_offense(mfa_value) do |corrector|
94
+ change_value(corrector, mfa_value)
95
+ end
96
+ end
97
+ else
98
+ add_offense(node) do |corrector|
99
+ autocorrect(corrector, node, block_var, metadata_value)
100
+ end
101
+ end
102
+ end
103
+ end
104
+
105
+ private
106
+
107
+ def mfa_value(metadata_value)
108
+ return unless metadata_value
109
+ return metadata_value if metadata_value.str_type?
110
+
111
+ rubygems_mfa_required(metadata_value).first
112
+ end
113
+
114
+ def autocorrect(corrector, node, block_var, metadata)
115
+ if metadata
116
+ return unless metadata.hash_type?
117
+
118
+ correct_metadata(corrector, metadata)
119
+ else
120
+ insert_mfa_required(corrector, node, block_var)
121
+ end
122
+ end
123
+
124
+ def correct_metadata(corrector, metadata)
125
+ if metadata.pairs.any?
126
+ corrector.insert_after(metadata.pairs.last, ",\n'rubygems_mfa_required' => 'true'")
127
+ else
128
+ corrector.insert_before(metadata.loc.end, "'rubygems_mfa_required' => 'true'")
129
+ end
130
+ end
131
+
132
+ def insert_mfa_required(corrector, node, block_var)
133
+ corrector.insert_before(node.loc.end, <<~RUBY)
134
+ #{block_var}.metadata['rubygems_mfa_required'] = 'true'
135
+ RUBY
136
+ end
137
+
138
+ def change_value(corrector, value)
139
+ corrector.replace(value, "'true'")
140
+ end
141
+ end
142
+ end
143
+ end
144
+ end
@@ -68,8 +68,11 @@ module RuboCop
68
68
 
69
69
  # @!method defined_ruby_version(node)
70
70
  def_node_matcher :defined_ruby_version, <<~PATTERN
71
- {$(str _) $(array (str _) (str _))
72
- (send (const (const nil? :Gem) :Requirement) :new $(str _))}
71
+ {
72
+ $(str _)
73
+ $(array (str _) (str _))
74
+ (send (const (const nil? :Gem) :Requirement) :new $str+)
75
+ }
73
76
  PATTERN
74
77
 
75
78
  def on_new_investigation
@@ -97,7 +100,11 @@ module RuboCop
97
100
  def extract_ruby_version(required_ruby_version)
98
101
  return unless required_ruby_version
99
102
 
100
- if required_ruby_version.array_type?
103
+ if required_ruby_version.is_a?(Array)
104
+ required_ruby_version = required_ruby_version.detect do |v|
105
+ /[>=]/.match?(v.str_content)
106
+ end
107
+ elsif required_ruby_version.array_type?
101
108
  required_ruby_version = required_ruby_version.children.detect do |v|
102
109
  /[>=]/.match?(v.str_content)
103
110
  end