rubocop 1.1.0 → 1.4.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.
Files changed (98) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +29 -12
  3. data/config/default.yml +113 -16
  4. data/exe/rubocop +1 -1
  5. data/lib/rubocop.rb +9 -0
  6. data/lib/rubocop/cli/command/execute_runner.rb +26 -11
  7. data/lib/rubocop/config_loader.rb +14 -5
  8. data/lib/rubocop/config_regeneration.rb +1 -1
  9. data/lib/rubocop/cop/bundler/duplicated_gem.rb +3 -3
  10. data/lib/rubocop/cop/bundler/gem_comment.rb +1 -1
  11. data/lib/rubocop/cop/commissioner.rb +1 -1
  12. data/lib/rubocop/cop/correctors/percent_literal_corrector.rb +1 -1
  13. data/lib/rubocop/cop/gemspec/duplicated_assignment.rb +3 -3
  14. data/lib/rubocop/cop/gemspec/required_ruby_version.rb +4 -5
  15. data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb +1 -1
  16. data/lib/rubocop/cop/generator.rb +2 -9
  17. data/lib/rubocop/cop/generator/configuration_injector.rb +1 -1
  18. data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +1 -1
  19. data/lib/rubocop/cop/layout/block_alignment.rb +3 -4
  20. data/lib/rubocop/cop/layout/class_structure.rb +15 -3
  21. data/lib/rubocop/cop/layout/else_alignment.rb +15 -2
  22. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +77 -7
  23. data/lib/rubocop/cop/layout/end_alignment.rb +3 -3
  24. data/lib/rubocop/cop/layout/hash_alignment.rb +4 -4
  25. data/lib/rubocop/cop/layout/line_length.rb +8 -1
  26. data/lib/rubocop/cop/layout/space_around_block_parameters.rb +24 -18
  27. data/lib/rubocop/cop/layout/space_around_method_call_operator.rb +1 -1
  28. data/lib/rubocop/cop/layout/space_inside_parens.rb +35 -13
  29. data/lib/rubocop/cop/lint/ambiguous_regexp_literal.rb +2 -1
  30. data/lib/rubocop/cop/lint/constant_definition_in_block.rb +26 -2
  31. data/lib/rubocop/cop/lint/debugger.rb +17 -27
  32. data/lib/rubocop/cop/lint/duplicate_branch.rb +93 -0
  33. data/lib/rubocop/cop/lint/duplicate_case_condition.rb +2 -12
  34. data/lib/rubocop/cop/lint/else_layout.rb +29 -3
  35. data/lib/rubocop/cop/lint/empty_block.rb +38 -2
  36. data/lib/rubocop/cop/lint/empty_class.rb +93 -0
  37. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +22 -4
  38. data/lib/rubocop/cop/lint/loop.rb +4 -4
  39. data/lib/rubocop/cop/lint/missing_super.rb +7 -4
  40. data/lib/rubocop/cop/lint/nested_percent_literal.rb +14 -0
  41. data/lib/rubocop/cop/lint/no_return_in_begin_end_blocks.rb +58 -0
  42. data/lib/rubocop/cop/lint/redundant_cop_enable_directive.rb +19 -16
  43. data/lib/rubocop/cop/lint/shadowed_exception.rb +4 -5
  44. data/lib/rubocop/cop/lint/to_enum_arguments.rb +6 -15
  45. data/lib/rubocop/cop/lint/unmodified_reduce_accumulator.rb +13 -4
  46. data/lib/rubocop/cop/lint/useless_method_definition.rb +2 -4
  47. data/lib/rubocop/cop/lint/useless_setter_call.rb +6 -1
  48. data/lib/rubocop/cop/metrics/method_length.rb +1 -1
  49. data/lib/rubocop/cop/mixin/check_line_breakable.rb +1 -1
  50. data/lib/rubocop/cop/mixin/configurable_numbering.rb +3 -3
  51. data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +1 -1
  52. data/lib/rubocop/cop/mixin/statement_modifier.rb +9 -4
  53. data/lib/rubocop/cop/mixin/visibility_help.rb +1 -3
  54. data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb +11 -1
  55. data/lib/rubocop/cop/naming/heredoc_delimiter_case.rb +11 -5
  56. data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +67 -18
  57. data/lib/rubocop/cop/naming/variable_number.rb +98 -8
  58. data/lib/rubocop/cop/style/and_or.rb +1 -3
  59. data/lib/rubocop/cop/style/bisected_attr_accessor.rb +0 -4
  60. data/lib/rubocop/cop/style/case_like_if.rb +0 -4
  61. data/lib/rubocop/cop/style/collection_compact.rb +91 -0
  62. data/lib/rubocop/cop/style/document_dynamic_eval_definition.rb +107 -5
  63. data/lib/rubocop/cop/style/documentation.rb +12 -1
  64. data/lib/rubocop/cop/style/double_negation.rb +6 -1
  65. data/lib/rubocop/cop/style/hash_syntax.rb +3 -3
  66. data/lib/rubocop/cop/style/identical_conditional_branches.rb +7 -2
  67. data/lib/rubocop/cop/style/if_inside_else.rb +37 -1
  68. data/lib/rubocop/cop/style/if_unless_modifier.rb +7 -3
  69. data/lib/rubocop/cop/style/infinite_loop.rb +4 -0
  70. data/lib/rubocop/cop/style/keyword_parameters_order.rb +12 -0
  71. data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +2 -2
  72. data/lib/rubocop/cop/style/mixin_grouping.rb +0 -4
  73. data/lib/rubocop/cop/style/multiple_comparison.rb +3 -2
  74. data/lib/rubocop/cop/style/negated_if_else_condition.rb +106 -0
  75. data/lib/rubocop/cop/style/nil_lambda.rb +52 -0
  76. data/lib/rubocop/cop/style/raise_args.rb +21 -6
  77. data/lib/rubocop/cop/style/redundant_argument.rb +73 -0
  78. data/lib/rubocop/cop/style/redundant_regexp_escape.rb +1 -1
  79. data/lib/rubocop/cop/style/static_class.rb +97 -0
  80. data/lib/rubocop/cop/style/while_until_modifier.rb +9 -0
  81. data/lib/rubocop/cop/util.rb +5 -1
  82. data/lib/rubocop/cop/variable_force/branch.rb +1 -1
  83. data/lib/rubocop/cop/variable_force/scope.rb +1 -1
  84. data/lib/rubocop/ext/regexp_node.rb +10 -5
  85. data/lib/rubocop/ext/regexp_parser.rb +9 -2
  86. data/lib/rubocop/formatter/disabled_config_formatter.rb +21 -6
  87. data/lib/rubocop/formatter/formatter_set.rb +1 -0
  88. data/lib/rubocop/formatter/git_hub_actions_formatter.rb +47 -0
  89. data/lib/rubocop/options.rb +7 -0
  90. data/lib/rubocop/rake_task.rb +2 -2
  91. data/lib/rubocop/runner.rb +1 -1
  92. data/lib/rubocop/target_finder.rb +1 -1
  93. data/lib/rubocop/target_ruby.rb +65 -1
  94. data/lib/rubocop/version.rb +1 -1
  95. metadata +14 -8
  96. data/bin/console +0 -10
  97. data/bin/rubocop-profile +0 -32
  98. data/bin/setup +0 -7
@@ -0,0 +1,93 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Cop
5
+ module Lint
6
+ # This cop checks that there are no repeated bodies
7
+ # within `if/unless`, `case-when` and `rescue` constructs.
8
+ #
9
+ # @example
10
+ # # bad
11
+ # if foo
12
+ # do_foo
13
+ # do_something_else
14
+ # elsif bar
15
+ # do_foo
16
+ # do_something_else
17
+ # end
18
+ #
19
+ # # good
20
+ # if foo || bar
21
+ # do_foo
22
+ # do_something_else
23
+ # end
24
+ #
25
+ # # bad
26
+ # case x
27
+ # when foo
28
+ # do_foo
29
+ # when bar
30
+ # do_foo
31
+ # else
32
+ # do_something_else
33
+ # end
34
+ #
35
+ # # good
36
+ # case x
37
+ # when foo, bar
38
+ # do_foo
39
+ # else
40
+ # do_something_else
41
+ # end
42
+ #
43
+ # # bad
44
+ # begin
45
+ # do_something
46
+ # rescue FooError
47
+ # handle_error
48
+ # rescue BarError
49
+ # handle_error
50
+ # end
51
+ #
52
+ # # good
53
+ # begin
54
+ # do_something
55
+ # rescue FooError, BarError
56
+ # handle_error
57
+ # end
58
+ #
59
+ class DuplicateBranch < Base
60
+ include RescueNode
61
+
62
+ MSG = 'Duplicate branch body detected.'
63
+
64
+ def on_branching_statement(node)
65
+ branches = node.branches.compact
66
+ branches.each_with_object(Set.new) do |branch, previous|
67
+ add_offense(offense_range(branch)) unless previous.add?(branch)
68
+ end
69
+ end
70
+ alias on_if on_branching_statement
71
+ alias on_case on_branching_statement
72
+ alias on_rescue on_branching_statement
73
+
74
+ private
75
+
76
+ def offense_range(duplicate_branch)
77
+ parent = duplicate_branch.parent
78
+
79
+ if parent.respond_to?(:else_branch) &&
80
+ parent.else_branch.equal?(duplicate_branch)
81
+ if parent.if_type? && parent.ternary?
82
+ duplicate_branch.source_range
83
+ else
84
+ parent.loc.else
85
+ end
86
+ else
87
+ parent.source_range
88
+ end
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end
@@ -31,22 +31,12 @@ module RuboCop
31
31
  MSG = 'Duplicate `when` condition detected.'
32
32
 
33
33
  def on_case(case_node)
34
- case_node.when_branches.each_with_object([]) do |when_node, previous|
34
+ case_node.when_branches.each_with_object(Set.new) do |when_node, previous|
35
35
  when_node.each_condition do |condition|
36
- next unless repeated_condition?(previous, condition)
37
-
38
- add_offense(condition)
36
+ add_offense(condition) unless previous.add?(condition)
39
37
  end
40
-
41
- previous.push(when_node.conditions)
42
38
  end
43
39
  end
44
-
45
- private
46
-
47
- def repeated_condition?(previous, condition)
48
- previous.any? { |c| c.include?(condition) }
49
- end
50
40
  end
51
41
  end
52
42
  end
@@ -3,10 +3,14 @@
3
3
  module RuboCop
4
4
  module Cop
5
5
  module Lint
6
- # This cop checks for odd else block layout - like
7
- # having an expression on the same line as the else keyword,
6
+ # This cop checks for odd `else` block layout - like
7
+ # having an expression on the same line as the `else` keyword,
8
8
  # which is usually a mistake.
9
9
  #
10
+ # Its auto-correction tweaks layout to keep the syntax. So, this auto-correction
11
+ # is compatible correction for bad case syntax, but if your code makes a mistake
12
+ # with `elsif` and `else`, you will have to correct it manually.
13
+ #
10
14
  # @example
11
15
  #
12
16
  # # bad
@@ -21,13 +25,25 @@ module RuboCop
21
25
  #
22
26
  # # good
23
27
  #
28
+ # # This code is compatible with the bad case. It will be auto-corrected like this.
24
29
  # if something
25
30
  # # ...
26
31
  # else
27
32
  # do_this
28
33
  # do_that
29
34
  # end
35
+ #
36
+ # # This code is incompatible with the bad case.
37
+ # # If `do_this` is a condition, `elsif` should be used instead of `else`.
38
+ # if something
39
+ # # ...
40
+ # elsif do_this
41
+ # do_that
42
+ # end
30
43
  class ElseLayout < Base
44
+ include RangeHelp
45
+ extend AutoCorrector
46
+
31
47
  MSG = 'Odd `else` layout detected. Did you mean to use `elsif`?'
32
48
 
33
49
  def on_if(node)
@@ -58,7 +74,17 @@ module RuboCop
58
74
  return unless first_else
59
75
  return unless first_else.source_range.line == node.loc.else.line
60
76
 
61
- add_offense(first_else)
77
+ add_offense(first_else) do |corrector|
78
+ autocorrect(corrector, node, first_else)
79
+ end
80
+ end
81
+
82
+ def autocorrect(corrector, node, first_else)
83
+ corrector.insert_after(node.loc.else, "\n")
84
+
85
+ blank_range = range_between(node.loc.else.end_pos, first_else.loc.expression.begin_pos)
86
+ indentation = indent(node.else_branch.children[1])
87
+ corrector.replace(blank_range, indentation)
62
88
  end
63
89
  end
64
90
  end
@@ -7,6 +7,8 @@ module RuboCop
7
7
  # Such empty blocks are typically an oversight or we should provide a comment
8
8
  # be clearer what we're aiming for.
9
9
  #
10
+ # Empty lambdas are ignored by default.
11
+ #
10
12
  # @example
11
13
  # # bad
12
14
  # items.each { |item| }
@@ -30,16 +32,50 @@ module RuboCop
30
32
  #
31
33
  # items.each { |item| } # TODO: implement later (inline comment)
32
34
  #
35
+ # @example AllowEmptyLambdas: true (default)
36
+ # # good
37
+ # allow(subject).to receive(:callable).and_return(-> {})
38
+ #
39
+ # placeholder = lambda do
40
+ # end
41
+ # (callable || placeholder).call
42
+ #
43
+ # @example AllowEmptyLambdas: false
44
+ # # bad
45
+ # allow(subject).to receive(:callable).and_return(-> {})
46
+ #
47
+ # placeholder = lambda do
48
+ # end
49
+ # (callable || placeholder).call
50
+ #
33
51
  class EmptyBlock < Base
34
52
  MSG = 'Empty block detected.'
35
53
 
36
54
  def on_block(node)
37
55
  return if node.body
38
- return if cop_config['AllowComments'] &&
39
- processed_source.contains_comment?(node.source_range)
56
+ return if allow_empty_lambdas? && node.lambda?
57
+ return if cop_config['AllowComments'] && allow_comment?(node)
40
58
 
41
59
  add_offense(node)
42
60
  end
61
+
62
+ private
63
+
64
+ def allow_comment?(node)
65
+ return false unless processed_source.contains_comment?(node.source_range)
66
+
67
+ line_comment = processed_source.comment_at_line(node.source_range.line)
68
+ !line_comment || !comment_disables_cop?(line_comment.loc.expression.source)
69
+ end
70
+
71
+ def allow_empty_lambdas?
72
+ cop_config['AllowEmptyLambdas']
73
+ end
74
+
75
+ def comment_disables_cop?(comment)
76
+ regexp_pattern = "# rubocop : (disable|todo) ([^,],)* (all|#{cop_name})"
77
+ Regexp.new(regexp_pattern.gsub(' ', '\s*')).match?(comment)
78
+ end
43
79
  end
44
80
  end
45
81
  end
@@ -0,0 +1,93 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Cop
5
+ module Lint
6
+ # This cop checks for classes and metaclasses without a body.
7
+ # Such empty classes and metaclasses are typically an oversight or we should provide a comment
8
+ # to be clearer what we're aiming for.
9
+ #
10
+ # @example
11
+ # # bad
12
+ # class Foo
13
+ # end
14
+ #
15
+ # class Bar
16
+ # class << self
17
+ # end
18
+ # end
19
+ #
20
+ # class << obj
21
+ # end
22
+ #
23
+ # # good
24
+ # class Foo
25
+ # def do_something
26
+ # # ... code
27
+ # end
28
+ # end
29
+ #
30
+ # class Bar
31
+ # class << self
32
+ # attr_reader :bar
33
+ # end
34
+ # end
35
+ #
36
+ # class << obj
37
+ # attr_reader :bar
38
+ # end
39
+ #
40
+ # @example AllowComments: false (default)
41
+ # # bad
42
+ # class Foo
43
+ # # TODO: implement later
44
+ # end
45
+ #
46
+ # class Bar
47
+ # class << self
48
+ # # TODO: implement later
49
+ # end
50
+ # end
51
+ #
52
+ # class << obj
53
+ # # TODO: implement later
54
+ # end
55
+ #
56
+ # @example AllowComments: true
57
+ # # good
58
+ # class Foo
59
+ # # TODO: implement later
60
+ # end
61
+ #
62
+ # class Bar
63
+ # class << self
64
+ # # TODO: implement later
65
+ # end
66
+ # end
67
+ #
68
+ # class << obj
69
+ # # TODO: implement later
70
+ # end
71
+ #
72
+ class EmptyClass < Base
73
+ CLASS_MSG = 'Empty class detected.'
74
+ METACLASS_MSG = 'Empty metaclass detected.'
75
+
76
+ def on_class(node)
77
+ add_offense(node, message: CLASS_MSG) unless body_or_allowed_comment_lines?(node) ||
78
+ node.parent_class
79
+ end
80
+
81
+ def on_sclass(node)
82
+ add_offense(node, message: METACLASS_MSG) unless body_or_allowed_comment_lines?(node)
83
+ end
84
+
85
+ private
86
+
87
+ def body_or_allowed_comment_lines?(node)
88
+ node.body || (cop_config['AllowComments'] && comment_lines?(node))
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end
@@ -27,9 +27,7 @@ module RuboCop
27
27
 
28
28
  def on_interpolation(begin_node)
29
29
  final_node = begin_node.children.last
30
- return unless final_node
31
- return if special_keyword?(final_node)
32
- return unless prints_as_self?(final_node)
30
+ return unless offending?(final_node)
33
31
 
34
32
  # %W and %I split the content into words before expansion
35
33
  # treating each interpolation as a word component, so
@@ -48,6 +46,14 @@ module RuboCop
48
46
 
49
47
  private
50
48
 
49
+ def offending?(node)
50
+ node &&
51
+ !special_keyword?(node) &&
52
+ prints_as_self?(node) &&
53
+ # Special case for Layout/TrailingWhitespace
54
+ !(space_literal?(node) && ends_heredoc_line?(node))
55
+ end
56
+
51
57
  def special_keyword?(node)
52
58
  # handle strings like __FILE__
53
59
  (node.str_type? && !node.loc.respond_to?(:begin)) ||
@@ -89,7 +95,7 @@ module RuboCop
89
95
  def autocorrected_value_for_array(node)
90
96
  return node.source.gsub('"', '\"') unless node.percent_literal?
91
97
 
92
- contents_range(node).source.split(' ').to_s.gsub('"', '\"')
98
+ contents_range(node).source.split.to_s.gsub('"', '\"')
93
99
  end
94
100
 
95
101
  # Does node print its own source when converted to a string?
@@ -99,6 +105,18 @@ module RuboCop
99
105
  node.children.all? { |child| prints_as_self?(child) })
100
106
  end
101
107
 
108
+ def space_literal?(node)
109
+ node.str_type? && node.value.blank?
110
+ end
111
+
112
+ def ends_heredoc_line?(node)
113
+ grandparent = node.parent.parent
114
+ return false unless grandparent&.dstr_type? && grandparent&.heredoc?
115
+
116
+ line = processed_source.lines[node.last_line - 1]
117
+ line.size == node.loc.last_column + 1
118
+ end
119
+
102
120
  def in_array_percent_literal?(node)
103
121
  parent = node.parent
104
122
  return false unless parent.dstr_type? || parent.dsym_type?
@@ -5,6 +5,10 @@ module RuboCop
5
5
  module Lint
6
6
  # This cop checks for uses of `begin...end while/until something`.
7
7
  #
8
+ # The cop is marked as unsafe because behaviour can change in some cases, including
9
+ # if a local variable inside the loop body is accessed outside of it, or if the
10
+ # loop body raises a `StopIteration` exception (which `Kernel#loop` rescues).
11
+ #
8
12
  # @example
9
13
  #
10
14
  # # bad
@@ -76,10 +80,6 @@ module RuboCop
76
80
  conditional_keyword = node.while_post_type? ? 'unless' : 'if'
77
81
  "break #{conditional_keyword} #{node.condition.source}\n#{indent(node)}"
78
82
  end
79
-
80
- def indent(node)
81
- ' ' * node.loc.column
82
- end
83
83
  end
84
84
  end
85
85
  end
@@ -6,6 +6,11 @@ module RuboCop
6
6
  # This cop checks for the presence of constructors and lifecycle callbacks
7
7
  # without calls to `super`.
8
8
  #
9
+ # This cop does not consider `method_missing` (and `respond_to_missing?`)
10
+ # because in some cases it makes sense to overtake what is considered a
11
+ # missing method. In other cases, the theoretical ideal handling could be
12
+ # challenging or verbose for no actual gain.
13
+ #
9
14
  # @example
10
15
  # # bad
11
16
  # class Employee < Person
@@ -43,15 +48,13 @@ module RuboCop
43
48
 
44
49
  STATELESS_CLASSES = %w[BasicObject Object].freeze
45
50
 
46
- OBJECT_LIFECYCLE_CALLBACKS = %i[method_missing respond_to_missing?].freeze
47
51
  CLASS_LIFECYCLE_CALLBACKS = %i[inherited].freeze
48
52
  METHOD_LIFECYCLE_CALLBACKS = %i[method_added method_removed method_undefined
49
53
  singleton_method_added singleton_method_removed
50
54
  singleton_method_undefined].freeze
51
55
 
52
- CALLBACKS = (OBJECT_LIFECYCLE_CALLBACKS +
53
- CLASS_LIFECYCLE_CALLBACKS +
54
- METHOD_LIFECYCLE_CALLBACKS).to_set.freeze
56
+ CALLBACKS = (CLASS_LIFECYCLE_CALLBACKS +
57
+ METHOD_LIFECYCLE_CALLBACKS).to_set.freeze
55
58
 
56
59
  def on_def(node)
57
60
  return unless offender?(node)
@@ -15,6 +15,20 @@ module RuboCop
15
15
  # valid_attributes: %i[name content],
16
16
  # nested_attributes: %i[name content %i[incorrectly nested]]
17
17
  # }
18
+ #
19
+ # # good
20
+ #
21
+ # # Neither is incompatible with the bad case, but probably the intended code.
22
+ # attributes = {
23
+ # valid_attributes: %i[name content],
24
+ # nested_attributes: [:name, :content, %i[incorrectly nested]]
25
+ # }
26
+ #
27
+ # attributes = {
28
+ # valid_attributes: %i[name content],
29
+ # nested_attributes: [:name, :content, [:incorrectly, :nested]]
30
+ # }
31
+ #
18
32
  class NestedPercentLiteral < Base
19
33
  include PercentLiteral
20
34