rubocop 1.50.2 → 1.57.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (227) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -3
  3. data/config/default.yml +110 -14
  4. data/config/obsoletion.yml +5 -0
  5. data/lib/rubocop/cli/command/lsp.rb +19 -0
  6. data/lib/rubocop/cli.rb +4 -1
  7. data/lib/rubocop/config.rb +4 -0
  8. data/lib/rubocop/config_finder.rb +2 -2
  9. data/lib/rubocop/config_loader_resolver.rb +4 -3
  10. data/lib/rubocop/config_obsoletion/parameter_rule.rb +9 -1
  11. data/lib/rubocop/config_obsoletion.rb +2 -2
  12. data/lib/rubocop/cop/autocorrect_logic.rb +3 -1
  13. data/lib/rubocop/cop/base.rb +6 -2
  14. data/lib/rubocop/cop/bundler/duplicated_gem.rb +1 -0
  15. data/lib/rubocop/cop/bundler/duplicated_group.rb +127 -0
  16. data/lib/rubocop/cop/bundler/gem_comment.rb +1 -1
  17. data/lib/rubocop/cop/bundler/gem_version.rb +2 -2
  18. data/lib/rubocop/cop/bundler/ordered_gems.rb +9 -1
  19. data/lib/rubocop/cop/correctors/alignment_corrector.rb +1 -1
  20. data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb +7 -4
  21. data/lib/rubocop/cop/gemspec/dependency_version.rb +2 -2
  22. data/lib/rubocop/cop/gemspec/development_dependencies.rb +1 -1
  23. data/lib/rubocop/cop/gemspec/ordered_dependencies.rb +9 -1
  24. data/lib/rubocop/cop/generator/require_file_injector.rb +1 -1
  25. data/lib/rubocop/cop/internal_affairs/cop_description.rb +32 -8
  26. data/lib/rubocop/cop/internal_affairs/example_description.rb +42 -21
  27. data/lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb +3 -1
  28. data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb +5 -5
  29. data/lib/rubocop/cop/internal_affairs/redundant_method_dispatch_node.rb +11 -2
  30. data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb +2 -0
  31. data/lib/rubocop/cop/layout/class_structure.rb +7 -0
  32. data/lib/rubocop/cop/layout/closing_heredoc_indentation.rb +1 -2
  33. data/lib/rubocop/cop/layout/dot_position.rb +1 -5
  34. data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb +42 -9
  35. data/lib/rubocop/cop/layout/empty_line_between_defs.rb +27 -4
  36. data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb +2 -0
  37. data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +2 -2
  38. data/lib/rubocop/cop/layout/heredoc_indentation.rb +3 -0
  39. data/lib/rubocop/cop/layout/indentation_style.rb +1 -1
  40. data/lib/rubocop/cop/layout/indentation_width.rb +3 -3
  41. data/lib/rubocop/cop/layout/leading_comment_space.rb +1 -1
  42. data/lib/rubocop/cop/layout/line_continuation_leading_space.rb +17 -9
  43. data/lib/rubocop/cop/layout/line_continuation_spacing.rb +1 -1
  44. data/lib/rubocop/cop/layout/line_end_string_concatenation_indentation.rb +2 -0
  45. data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb +18 -3
  46. data/lib/rubocop/cop/layout/redundant_line_break.rb +14 -4
  47. data/lib/rubocop/cop/layout/space_after_comma.rb +9 -1
  48. data/lib/rubocop/cop/layout/space_after_not.rb +1 -1
  49. data/lib/rubocop/cop/layout/space_around_method_call_operator.rb +2 -2
  50. data/lib/rubocop/cop/layout/space_around_operators.rb +3 -1
  51. data/lib/rubocop/cop/layout/space_inside_block_braces.rb +2 -0
  52. data/lib/rubocop/cop/layout/space_inside_parens.rb +1 -1
  53. data/lib/rubocop/cop/layout/space_inside_range_literal.rb +1 -1
  54. data/lib/rubocop/cop/layout/trailing_empty_lines.rb +5 -0
  55. data/lib/rubocop/cop/lint/ambiguous_block_association.rb +13 -1
  56. data/lib/rubocop/cop/lint/debugger.rb +18 -5
  57. data/lib/rubocop/cop/lint/duplicate_hash_key.rb +2 -1
  58. data/lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb +46 -19
  59. data/lib/rubocop/cop/lint/empty_block.rb +1 -1
  60. data/lib/rubocop/cop/lint/erb_new_arguments.rb +3 -4
  61. data/lib/rubocop/cop/lint/heredoc_method_call_position.rb +1 -1
  62. data/lib/rubocop/cop/lint/identity_comparison.rb +0 -1
  63. data/lib/rubocop/cop/lint/incompatible_io_select_with_fiber_scheduler.rb +5 -3
  64. data/lib/rubocop/cop/lint/inherit_exception.rb +9 -0
  65. data/lib/rubocop/cop/lint/lambda_without_literal_block.rb +1 -1
  66. data/lib/rubocop/cop/lint/literal_in_interpolation.rb +1 -1
  67. data/lib/rubocop/cop/lint/missing_super.rb +34 -5
  68. data/lib/rubocop/cop/lint/mixed_case_range.rb +111 -0
  69. data/lib/rubocop/cop/lint/non_atomic_file_operation.rb +10 -7
  70. data/lib/rubocop/cop/lint/number_conversion.rb +5 -0
  71. data/lib/rubocop/cop/lint/numbered_parameter_assignment.rb +2 -2
  72. data/lib/rubocop/cop/lint/ordered_magic_comments.rb +0 -1
  73. data/lib/rubocop/cop/lint/out_of_range_regexp_ref.rb +2 -2
  74. data/lib/rubocop/cop/lint/redundant_regexp_quantifiers.rb +130 -0
  75. data/lib/rubocop/cop/lint/redundant_require_statement.rb +12 -3
  76. data/lib/rubocop/cop/lint/redundant_safe_navigation.rb +20 -4
  77. data/lib/rubocop/cop/lint/redundant_string_coercion.rb +1 -1
  78. data/lib/rubocop/cop/lint/safe_navigation_chain.rb +11 -4
  79. data/lib/rubocop/cop/lint/send_with_mixin_argument.rb +1 -2
  80. data/lib/rubocop/cop/lint/shadowed_exception.rb +5 -11
  81. data/lib/rubocop/cop/lint/shadowing_outer_local_variable.rb +7 -1
  82. data/lib/rubocop/cop/lint/struct_new_override.rb +12 -12
  83. data/lib/rubocop/cop/lint/suppressed_exception.rb +2 -2
  84. data/lib/rubocop/cop/lint/symbol_conversion.rb +1 -1
  85. data/lib/rubocop/cop/lint/to_enum_arguments.rb +5 -3
  86. data/lib/rubocop/cop/lint/top_level_return_with_argument.rb +23 -9
  87. data/lib/rubocop/cop/lint/useless_assignment.rb +94 -10
  88. data/lib/rubocop/cop/lint/void.rb +57 -7
  89. data/lib/rubocop/cop/metrics/block_length.rb +1 -1
  90. data/lib/rubocop/cop/metrics/class_length.rb +2 -2
  91. data/lib/rubocop/cop/metrics/method_length.rb +1 -1
  92. data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb +1 -2
  93. data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb +32 -4
  94. data/lib/rubocop/cop/migration/department_name.rb +2 -2
  95. data/lib/rubocop/cop/mixin/allowed_receivers.rb +34 -0
  96. data/lib/rubocop/cop/mixin/comments_help.rb +7 -3
  97. data/lib/rubocop/cop/mixin/def_node.rb +1 -1
  98. data/lib/rubocop/cop/mixin/end_keyword_alignment.rb +1 -1
  99. data/lib/rubocop/cop/mixin/heredoc.rb +6 -2
  100. data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb +3 -2
  101. data/lib/rubocop/cop/mixin/percent_literal.rb +1 -1
  102. data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +5 -7
  103. data/lib/rubocop/cop/mixin/space_after_punctuation.rb +1 -1
  104. data/lib/rubocop/cop/mixin/string_help.rb +4 -2
  105. data/lib/rubocop/cop/mixin/trailing_comma.rb +1 -1
  106. data/lib/rubocop/cop/naming/block_forwarding.rb +1 -1
  107. data/lib/rubocop/cop/naming/constant_name.rb +1 -1
  108. data/lib/rubocop/cop/naming/file_name.rb +1 -1
  109. data/lib/rubocop/cop/naming/heredoc_delimiter_naming.rb +3 -1
  110. data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb +25 -10
  111. data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb +11 -3
  112. data/lib/rubocop/cop/naming/variable_name.rb +6 -1
  113. data/lib/rubocop/cop/style/accessor_grouping.rb +5 -1
  114. data/lib/rubocop/cop/style/alias.rb +9 -8
  115. data/lib/rubocop/cop/style/arguments_forwarding.rb +280 -63
  116. data/lib/rubocop/cop/style/array_intersect.rb +13 -5
  117. data/lib/rubocop/cop/style/attr.rb +11 -1
  118. data/lib/rubocop/cop/style/begin_block.rb +1 -2
  119. data/lib/rubocop/cop/style/block_comments.rb +1 -1
  120. data/lib/rubocop/cop/style/block_delimiters.rb +5 -4
  121. data/lib/rubocop/cop/style/class_and_module_children.rb +1 -1
  122. data/lib/rubocop/cop/style/class_equality_comparison.rb +24 -39
  123. data/lib/rubocop/cop/style/collection_compact.rb +16 -6
  124. data/lib/rubocop/cop/style/collection_methods.rb +2 -0
  125. data/lib/rubocop/cop/style/colon_method_call.rb +2 -2
  126. data/lib/rubocop/cop/style/combinable_loops.rb +30 -8
  127. data/lib/rubocop/cop/style/concat_array_literals.rb +1 -1
  128. data/lib/rubocop/cop/style/conditional_assignment.rb +5 -3
  129. data/lib/rubocop/cop/style/copyright.rb +5 -2
  130. data/lib/rubocop/cop/style/dir.rb +1 -1
  131. data/lib/rubocop/cop/style/dir_empty.rb +8 -14
  132. data/lib/rubocop/cop/style/document_dynamic_eval_definition.rb +1 -1
  133. data/lib/rubocop/cop/style/documentation.rb +1 -1
  134. data/lib/rubocop/cop/style/empty_case_condition.rb +6 -1
  135. data/lib/rubocop/cop/style/eval_with_location.rb +5 -5
  136. data/lib/rubocop/cop/style/exact_regexp_match.rb +68 -0
  137. data/lib/rubocop/cop/style/file_read.rb +2 -2
  138. data/lib/rubocop/cop/style/for.rb +1 -1
  139. data/lib/rubocop/cop/style/format_string.rb +24 -3
  140. data/lib/rubocop/cop/style/frozen_string_literal_comment.rb +3 -1
  141. data/lib/rubocop/cop/style/guard_clause.rb +28 -0
  142. data/lib/rubocop/cop/style/hash_conversion.rb +10 -0
  143. data/lib/rubocop/cop/style/hash_each_methods.rb +1 -22
  144. data/lib/rubocop/cop/style/hash_except.rb +19 -8
  145. data/lib/rubocop/cop/style/hash_transform_keys.rb +2 -2
  146. data/lib/rubocop/cop/style/hash_transform_values.rb +2 -2
  147. data/lib/rubocop/cop/style/identical_conditional_branches.rb +23 -5
  148. data/lib/rubocop/cop/style/if_inside_else.rb +6 -0
  149. data/lib/rubocop/cop/style/if_unless_modifier.rb +3 -0
  150. data/lib/rubocop/cop/style/if_with_semicolon.rb +2 -2
  151. data/lib/rubocop/cop/style/invertible_unless_condition.rb +10 -6
  152. data/lib/rubocop/cop/style/lambda.rb +3 -3
  153. data/lib/rubocop/cop/style/lambda_call.rb +5 -0
  154. data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +11 -5
  155. data/lib/rubocop/cop/style/mixin_grouping.rb +1 -1
  156. data/lib/rubocop/cop/style/multiline_block_chain.rb +1 -1
  157. data/lib/rubocop/cop/style/multiline_ternary_operator.rb +1 -1
  158. data/lib/rubocop/cop/style/multiple_comparison.rb +14 -0
  159. data/lib/rubocop/cop/style/nested_ternary_operator.rb +3 -11
  160. data/lib/rubocop/cop/style/numeric_literals.rb +1 -1
  161. data/lib/rubocop/cop/style/open_struct_use.rb +1 -1
  162. data/lib/rubocop/cop/style/operator_method_call.rb +6 -0
  163. data/lib/rubocop/cop/style/percent_literal_delimiters.rb +1 -1
  164. data/lib/rubocop/cop/style/preferred_hash_methods.rb +1 -1
  165. data/lib/rubocop/cop/style/redundant_argument.rb +6 -1
  166. data/lib/rubocop/cop/style/redundant_array_constructor.rb +77 -0
  167. data/lib/rubocop/cop/style/redundant_begin.rb +10 -2
  168. data/lib/rubocop/cop/style/redundant_conditional.rb +2 -10
  169. data/lib/rubocop/cop/style/redundant_current_directory_in_path.rb +38 -0
  170. data/lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb +86 -5
  171. data/lib/rubocop/cop/style/redundant_exception.rb +32 -12
  172. data/lib/rubocop/cop/style/redundant_filter_chain.rb +117 -0
  173. data/lib/rubocop/cop/style/redundant_line_continuation.rb +7 -3
  174. data/lib/rubocop/cop/style/redundant_parentheses.rb +25 -7
  175. data/lib/rubocop/cop/style/redundant_regexp_argument.rb +100 -0
  176. data/lib/rubocop/cop/style/redundant_regexp_constructor.rb +46 -0
  177. data/lib/rubocop/cop/style/redundant_regexp_escape.rb +2 -1
  178. data/lib/rubocop/cop/style/redundant_return.rb +7 -2
  179. data/lib/rubocop/cop/style/redundant_self_assignment_branch.rb +8 -1
  180. data/lib/rubocop/cop/style/redundant_sort.rb +1 -1
  181. data/lib/rubocop/cop/style/redundant_string_escape.rb +2 -0
  182. data/lib/rubocop/cop/style/regexp_literal.rb +11 -2
  183. data/lib/rubocop/cop/style/require_order.rb +11 -5
  184. data/lib/rubocop/cop/style/rescue_modifier.rb +1 -3
  185. data/lib/rubocop/cop/style/return_nil.rb +6 -2
  186. data/lib/rubocop/cop/style/return_nil_in_predicate_method_definition.rb +95 -0
  187. data/lib/rubocop/cop/style/select_by_regexp.rb +15 -5
  188. data/lib/rubocop/cop/style/semicolon.rb +12 -4
  189. data/lib/rubocop/cop/style/signal_exception.rb +1 -1
  190. data/lib/rubocop/cop/style/single_line_do_end_block.rb +65 -0
  191. data/lib/rubocop/cop/style/single_line_methods.rb +1 -1
  192. data/lib/rubocop/cop/style/sole_nested_conditional.rb +6 -2
  193. data/lib/rubocop/cop/style/special_global_vars.rb +3 -4
  194. data/lib/rubocop/cop/style/string_literals_in_interpolation.rb +30 -5
  195. data/lib/rubocop/cop/style/symbol_array.rb +35 -15
  196. data/lib/rubocop/cop/style/yaml_file_read.rb +66 -0
  197. data/lib/rubocop/cop/style/yoda_condition.rb +4 -2
  198. data/lib/rubocop/cop/style/yoda_expression.rb +8 -7
  199. data/lib/rubocop/cop/team.rb +1 -1
  200. data/lib/rubocop/cop/util.rb +1 -1
  201. data/lib/rubocop/cop/utils/regexp_ranges.rb +113 -0
  202. data/lib/rubocop/cop/variable_force/assignment.rb +45 -4
  203. data/lib/rubocop/cop/variable_force/variable_table.rb +2 -2
  204. data/lib/rubocop/cop/variable_force.rb +1 -0
  205. data/lib/rubocop/cops_documentation_generator.rb +1 -1
  206. data/lib/rubocop/ext/regexp_parser.rb +4 -1
  207. data/lib/rubocop/file_finder.rb +4 -7
  208. data/lib/rubocop/formatter/junit_formatter.rb +1 -1
  209. data/lib/rubocop/lsp/logger.rb +22 -0
  210. data/lib/rubocop/lsp/routes.rb +246 -0
  211. data/lib/rubocop/lsp/runtime.rb +99 -0
  212. data/lib/rubocop/lsp/server.rb +68 -0
  213. data/lib/rubocop/lsp/severity.rb +27 -0
  214. data/lib/rubocop/magic_comment.rb +12 -10
  215. data/lib/rubocop/options.rb +11 -1
  216. data/lib/rubocop/result_cache.rb +5 -1
  217. data/lib/rubocop/rspec/cop_helper.rb +1 -1
  218. data/lib/rubocop/rspec/shared_contexts.rb +2 -3
  219. data/lib/rubocop/runner.rb +5 -3
  220. data/lib/rubocop/server/cache.rb +1 -0
  221. data/lib/rubocop/server/client_command/exec.rb +3 -2
  222. data/lib/rubocop/string_interpreter.rb +3 -3
  223. data/lib/rubocop/target_finder.rb +7 -3
  224. data/lib/rubocop/target_ruby.rb +12 -7
  225. data/lib/rubocop/version.rb +10 -6
  226. data/lib/rubocop.rb +15 -0
  227. metadata +63 -15
@@ -0,0 +1,68 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'language_server-protocol'
4
+ require_relative 'logger'
5
+ require_relative 'routes'
6
+ require_relative 'runtime'
7
+
8
+ #
9
+ # This code is based on https://github.com/standardrb/standard.
10
+ #
11
+ # Copyright (c) 2023 Test Double, Inc.
12
+ #
13
+ # The MIT License (MIT)
14
+ #
15
+ # https://github.com/standardrb/standard/blob/main/LICENSE.txt
16
+ #
17
+ module RuboCop
18
+ module Lsp
19
+ # Language Server Protocol of RuboCop.
20
+ # @api private
21
+ class Server
22
+ def initialize(config_store)
23
+ @reader = LanguageServer::Protocol::Transport::Io::Reader.new($stdin)
24
+ @writer = LanguageServer::Protocol::Transport::Io::Writer.new($stdout)
25
+ @runtime = RuboCop::Lsp::Runtime.new(config_store)
26
+ @routes = Routes.new(self)
27
+ end
28
+
29
+ def start
30
+ @reader.read do |request|
31
+ if !request.key?(:method)
32
+ @routes.handle_method_missing(request)
33
+ elsif (route = @routes.for(request[:method]))
34
+ route.call(request)
35
+ else
36
+ @routes.handle_unsupported_method(request)
37
+ end
38
+ rescue StandardError => e
39
+ Logger.log("Error #{e.class} #{e.message[0..100]}")
40
+ Logger.log(e.backtrace.inspect)
41
+ end
42
+ end
43
+
44
+ def write(response)
45
+ @writer.write(response)
46
+ end
47
+
48
+ def format(path, text, command:)
49
+ @runtime.format(path, text, command: command)
50
+ end
51
+
52
+ def offenses(path, text)
53
+ @runtime.offenses(path, text)
54
+ end
55
+
56
+ def configure(options)
57
+ @runtime.safe_autocorrect = options[:safe_autocorrect]
58
+ @runtime.lint_mode = options[:lint_mode]
59
+ @runtime.layout_mode = options[:layout_mode]
60
+ end
61
+
62
+ def stop(&block)
63
+ at_exit(&block) if block
64
+ exit
65
+ end
66
+ end
67
+ end
68
+ end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RuboCop
4
+ module Lsp
5
+ # Severity for Language Server Protocol of RuboCop.
6
+ # @api private
7
+ class Severity
8
+ SEVERITIES = {
9
+ fatal: LanguageServer::Protocol::Constant::DiagnosticSeverity::ERROR,
10
+ error: LanguageServer::Protocol::Constant::DiagnosticSeverity::ERROR,
11
+ warning: LanguageServer::Protocol::Constant::DiagnosticSeverity::WARNING,
12
+ convention: LanguageServer::Protocol::Constant::DiagnosticSeverity::INFORMATION,
13
+ refactor: LanguageServer::Protocol::Constant::DiagnosticSeverity::HINT,
14
+ info: LanguageServer::Protocol::Constant::DiagnosticSeverity::HINT
15
+ }.freeze
16
+
17
+ def self.find_by(rubocop_severity)
18
+ if (severity = SEVERITIES[rubocop_severity.to_sym])
19
+ return severity
20
+ end
21
+
22
+ Logger.log("Unknown severity: #{rubocop_severity}")
23
+ LanguageServer::Protocol::Constant::DiagnosticSeverity::HINT
24
+ end
25
+ end
26
+ end
27
+ end
@@ -7,7 +7,7 @@ module RuboCop
7
7
  class MagicComment
8
8
  # IRB's pattern for matching magic comment tokens.
9
9
  # @see https://github.com/ruby/ruby/blob/b4a55c1/lib/irb/magic-file.rb#L5
10
- TOKEN = /[[:alnum:]\-_]+/.freeze
10
+ TOKEN = '(?<token>[[:alnum:]\-_]+)'
11
11
  KEYWORDS = {
12
12
  encoding: '(?:en)?coding',
13
13
  frozen_string_literal: 'frozen[_-]string[_-]literal',
@@ -129,7 +129,7 @@ module RuboCop
129
129
  # @return [String] if pattern matched
130
130
  # @return [nil] otherwise
131
131
  def extract(pattern)
132
- @comment[pattern, 1]
132
+ @comment[pattern, :token]
133
133
  end
134
134
 
135
135
  # Parent to Vim and Emacs magic comment handling.
@@ -157,10 +157,10 @@ module RuboCop
157
157
  # @return [String] extracted value if it is found
158
158
  # @return [nil] otherwise
159
159
  def match(keyword)
160
- pattern = /\A#{keyword}\s*#{self.class::OPERATOR}\s*(#{TOKEN})\z/
160
+ pattern = /\A#{keyword}\s*#{self.class::OPERATOR}\s*#{TOKEN}\z/
161
161
 
162
162
  tokens.each do |token|
163
- next unless (value = token[pattern, 1])
163
+ next unless (value = token[pattern, :token])
164
164
 
165
165
  return value.downcase
166
166
  end
@@ -188,7 +188,7 @@ module RuboCop
188
188
  # @see https://www.gnu.org/software/emacs/manual/html_node/emacs/Specify-Coding.html
189
189
  # @see https://github.com/ruby/ruby/blob/3f306dc/parse.y#L6873-L6892 Emacs handling in parse.y
190
190
  class EmacsComment < EditorComment
191
- REGEXP = /-\*-(.+)-\*-/.freeze
191
+ REGEXP = /-\*-(?<token>.+)-\*-/.freeze
192
192
  FORMAT = '# -*- %s -*-'
193
193
  SEPARATOR = ';'
194
194
  OPERATOR = ':'
@@ -216,7 +216,7 @@ module RuboCop
216
216
  #
217
217
  # comment.encoding # => 'ascii-8bit'
218
218
  class VimComment < EditorComment
219
- REGEXP = /#\s*vim:\s*(.+)/.freeze
219
+ REGEXP = /#\s*vim:\s*(?<token>.+)/.freeze
220
220
  FORMAT = '# vim: %s'
221
221
  SEPARATOR = ', '
222
222
  OPERATOR = '='
@@ -259,9 +259,11 @@ module RuboCop
259
259
  # comment2.frozen_string_literal # => nil
260
260
  # comment2.encoding # => 'utf-8'
261
261
  class SimpleComment < MagicComment
262
+ FSTRING_LITERAL_COMMENT = 'frozen_string_literal:\s*(true|false)'
263
+
262
264
  # Match `encoding` or `coding`
263
265
  def encoding
264
- extract(/\A\s*\#.*\b#{KEYWORDS[:encoding]}: (#{TOKEN})/io)
266
+ extract(/\A\s*\#\s*(#{FSTRING_LITERAL_COMMENT})?\s*#{KEYWORDS[:encoding]}: (#{TOKEN})/io)
265
267
  end
266
268
 
267
269
  # Rewrite the comment without a given token type
@@ -283,15 +285,15 @@ module RuboCop
283
285
  # Case-insensitive and dashes/underscores are acceptable.
284
286
  # @see https://github.com/ruby/ruby/blob/78b95b4/parse.y#L7134-L7138
285
287
  def extract_frozen_string_literal
286
- extract(/\A\s*#\s*#{KEYWORDS[:frozen_string_literal]}:\s*(#{TOKEN})\s*\z/io)
288
+ extract(/\A\s*#\s*#{KEYWORDS[:frozen_string_literal]}:\s*#{TOKEN}\s*\z/io)
287
289
  end
288
290
 
289
291
  def extract_shareable_constant_value
290
- extract(/\A\s*#\s*#{KEYWORDS[:shareable_constant_value]}:\s*(#{TOKEN})\s*\z/io)
292
+ extract(/\A\s*#\s*#{KEYWORDS[:shareable_constant_value]}:\s*#{TOKEN}\s*\z/io)
291
293
  end
292
294
 
293
295
  def extract_typed
294
- extract(/\A\s*#\s*#{KEYWORDS[:typed]}:\s*(#{TOKEN})\s*\z/io)
296
+ extract(/\A\s*#\s*#{KEYWORDS[:typed]}:\s*#{TOKEN}\s*\z/io)
295
297
  end
296
298
  end
297
299
  end
@@ -16,7 +16,7 @@ module RuboCop
16
16
  'root of the project. RuboCop will use this path to determine which ' \
17
17
  'cops are enabled (via eg. Include/Exclude), and so that certain cops ' \
18
18
  'like Naming/FileName can be checked.'
19
- EXITING_OPTIONS = %i[version verbose_version show_cops show_docs_url].freeze
19
+ EXITING_OPTIONS = %i[version verbose_version show_cops show_docs_url lsp].freeze
20
20
  DEFAULT_MAXIMUM_EXCLUSION_ITEMS = 15
21
21
 
22
22
  def initialize
@@ -49,12 +49,14 @@ module RuboCop
49
49
 
50
50
  private
51
51
 
52
+ # rubocop:disable Metrics/AbcSize
52
53
  def define_options
53
54
  OptionParser.new do |opts|
54
55
  opts.banner = rainbow.wrap('Usage: rubocop [options] [file1, file2, ...]').bright
55
56
 
56
57
  add_check_options(opts)
57
58
  add_cache_options(opts)
59
+ add_lsp_option(opts)
58
60
  add_server_options(opts)
59
61
  add_output_options(opts)
60
62
  add_autocorrection_options(opts)
@@ -66,6 +68,7 @@ module RuboCop
66
68
  add_profile_options(opts) if RUBY_ENGINE == 'ruby' && !Platform.windows?
67
69
  end
68
70
  end
71
+ # rubocop:enable Metrics/AbcSize
69
72
 
70
73
  def add_check_options(opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
71
74
  section(opts, 'Basic Options') do # rubocop:disable Metrics/BlockLength
@@ -205,6 +208,12 @@ module RuboCop
205
208
  end
206
209
  end
207
210
 
211
+ def add_lsp_option(opts)
212
+ section(opts, 'LSP Option') do
213
+ option(opts, '--lsp')
214
+ end
215
+ end
216
+
208
217
  def add_server_options(opts)
209
218
  section(opts, 'Server Options') do
210
219
  option(opts, '--[no-]server')
@@ -620,6 +629,7 @@ module RuboCop
620
629
  stop_server: 'Stop server process.',
621
630
  server_status: 'Show server status.',
622
631
  no_detach: 'Run the server process in the foreground.',
632
+ lsp: 'Start a language server listening on STDIN.',
623
633
  raise_cop_error: ['Raise cop-related errors with cause and location.',
624
634
  'This is used to prevent cops from failing silently.',
625
635
  'Default is false.'],
@@ -83,7 +83,7 @@ module RuboCop
83
83
  config_store.for_pwd.for_all_cops['AllowSymlinksInCacheRootDirectory']
84
84
  end
85
85
 
86
- attr :path
86
+ attr_reader :path
87
87
 
88
88
  def initialize(file, team, options, config_store, cache_root = nil)
89
89
  cache_root ||= File.join(options[:cache_root], 'rubocop_cache') if options[:cache_root]
@@ -202,6 +202,10 @@ module RuboCop
202
202
  lib_root = File.join(File.dirname(__FILE__), '..')
203
203
  exe_root = File.join(lib_root, '..', 'exe')
204
204
 
205
+ # Make sure to use an absolute path to prevent errors on Windows
206
+ # when traversing the relative paths with symlinks.
207
+ exe_root = File.absolute_path(exe_root)
208
+
205
209
  # These are all the files we have `require`d plus everything in the
206
210
  # exe directory. A change to any of them could affect the cop output
207
211
  # so we include them in the cache hash.
@@ -6,7 +6,7 @@ require 'tempfile'
6
6
  module CopHelper
7
7
  extend RSpec::SharedContext
8
8
 
9
- let(:ruby_version) { 2.6 }
9
+ let(:ruby_version) { RuboCop::TargetRuby::DEFAULT_VERSION }
10
10
  let(:rails_version) { false }
11
11
 
12
12
  def inspect_source(source, file = nil)
@@ -11,6 +11,8 @@ RSpec.shared_context 'isolated environment' do # rubocop:disable Metrics/BlockLe
11
11
  # Make sure to expand all symlinks in the path first. Otherwise we may
12
12
  # get mismatched pathnames when loading config files later on.
13
13
  tmpdir = File.realpath(tmpdir)
14
+ # Make upwards search for .rubocop.yml files stop at this directory.
15
+ RuboCop::FileFinder.root_level = tmpdir
14
16
 
15
17
  virtual_home = File.expand_path(File.join(tmpdir, 'home'))
16
18
  Dir.mkdir(virtual_home)
@@ -21,9 +23,6 @@ RSpec.shared_context 'isolated environment' do # rubocop:disable Metrics/BlockLe
21
23
  root = example.metadata[:root]
22
24
  working_dir = root ? File.join(base_dir, 'work', root) : File.join(base_dir, 'work')
23
25
 
24
- # Make upwards search for .rubocop.yml files stop at this directory.
25
- RuboCop::FileFinder.root_level = working_dir
26
-
27
26
  begin
28
27
  FileUtils.mkdir_p(working_dir)
29
28
 
@@ -421,10 +421,10 @@ module RuboCop
421
421
  end
422
422
 
423
423
  def considered_failure?(offense)
424
- # For :autocorrect level, any offense - corrected or not - is a failure.
425
424
  return false if offense.disabled?
426
425
 
427
- return true if @options[:fail_level] == :autocorrect
426
+ # For :autocorrect level, any correctable offense is a failure, regardless of severity
427
+ return true if @options[:fail_level] == :autocorrect && offense.correctable?
428
428
 
429
429
  !offense.corrected? && offense.severity >= minimum_severity_to_fail
430
430
  end
@@ -461,7 +461,9 @@ module RuboCop
461
461
  @minimum_severity_to_fail ||= begin
462
462
  # Unless given explicitly as `fail_level`, `:info` severity offenses do not fail
463
463
  name = @options[:fail_level] || :refactor
464
- RuboCop::Cop::Severity.new(name)
464
+
465
+ # autocorrect is a fake level - use the default
466
+ RuboCop::Cop::Severity.new(name == :autocorrect ? :refactor : name)
465
467
  end
466
468
  end
467
469
 
@@ -1,5 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require 'fileutils'
3
4
  require 'pathname'
4
5
  require_relative '../cache_config'
5
6
  require_relative '../config_finder'
@@ -18,10 +18,11 @@ module RuboCop
18
18
  def run
19
19
  ensure_server!
20
20
  Cache.status_path.delete if Cache.status_path.file?
21
+ read_stdin = ARGV.include?('-s') || ARGV.include?('--stdin')
21
22
  send_request(
22
23
  command: 'exec',
23
24
  args: ARGV.dup,
24
- body: $stdin.tty? ? '' : $stdin.read
25
+ body: read_stdin ? $stdin.read : ''
25
26
  )
26
27
  warn stderr unless stderr.empty?
27
28
  status
@@ -31,7 +32,7 @@ module RuboCop
31
32
 
32
33
  def ensure_server!
33
34
  if incompatible_version?
34
- puts 'RuboCop version incompatibility found, RuboCop server restarting...'
35
+ warn 'RuboCop version incompatibility found, RuboCop server restarting...'
35
36
  ClientCommand::Stop.new.run
36
37
  elsif check_running_server
37
38
  return
@@ -32,9 +32,9 @@ module RuboCop
32
32
 
33
33
  def interpret_string_escape(escape)
34
34
  case escape[1]
35
- when 'u' then interpret_unicode(escape)
36
- when 'x' then interpret_hex(escape)
37
- when /\d/ then interpret_octal(escape)
35
+ when 'u' then interpret_unicode(escape)
36
+ when 'x' then interpret_hex(escape)
37
+ when /\d/ then interpret_octal(escape)
38
38
  else
39
39
  escape[1] # literal escaped char, like \\
40
40
  end
@@ -94,8 +94,12 @@ module RuboCop
94
94
  end
95
95
 
96
96
  def wanted_dir_patterns(base_dir, exclude_pattern, flags)
97
- base_dir = base_dir.gsub('/{}/', '/\{}/')
98
- dirs = Dir.glob(File.join(base_dir.gsub('/*/', '/\*/').gsub('/**/', '/\**/'), '*/'), flags)
97
+ # Escape glob characters in base_dir to avoid unwanted behavior.
98
+ base_dir = base_dir.gsub(/[\\\{\}\[\]\*\?]/) do |reserved_glob_character|
99
+ "\\#{reserved_glob_character}"
100
+ end
101
+
102
+ dirs = Dir.glob(File.join(base_dir, '*/'), flags)
99
103
  .reject do |dir|
100
104
  next true if dir.end_with?('/./', '/../')
101
105
  next true if File.fnmatch?(exclude_pattern, dir, flags)
@@ -114,7 +118,7 @@ module RuboCop
114
118
  end
115
119
 
116
120
  def combined_exclude_glob_patterns(base_dir)
117
- exclude = @config_store.for(base_dir).for_all_cops['Exclude']
121
+ exclude = @config_store.for(base_dir).for_all_cops['Exclude'] || []
118
122
  patterns = exclude.select { |pattern| pattern.is_a?(String) && pattern.end_with?('/**/*') }
119
123
  .map { |pattern| pattern.sub("#{base_dir}/", '') }
120
124
  "#{base_dir}/{#{patterns.join(',')}}"
@@ -5,7 +5,7 @@ module RuboCop
5
5
  # @api private
6
6
  class TargetRuby
7
7
  KNOWN_RUBIES = [2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2, 3.3].freeze
8
- DEFAULT_VERSION = 2.6
8
+ DEFAULT_VERSION = 2.7
9
9
 
10
10
  OBSOLETE_RUBIES = {
11
11
  1.9 => '0.41',
@@ -14,7 +14,8 @@ module RuboCop
14
14
  2.2 => '0.68',
15
15
  2.3 => '0.81',
16
16
  2.4 => '1.12',
17
- 2.5 => '1.28'
17
+ 2.5 => '1.28',
18
+ 2.6 => '1.50'
18
19
  }.freeze
19
20
  private_constant :KNOWN_RUBIES, :OBSOLETE_RUBIES
20
21
 
@@ -154,9 +155,11 @@ module RuboCop
154
155
  (send _ :required_ruby_version= $_)
155
156
  PATTERN
156
157
 
157
- # @!method gem_requirement?(node)
158
- def_node_matcher :gem_requirement?, <<~PATTERN
159
- (send (const(const _ :Gem):Requirement) :new $str)
158
+ # @!method gem_requirement_versions(node)
159
+ def_node_matcher :gem_requirement_versions, <<~PATTERN
160
+ (send (const(const _ :Gem):Requirement) :new
161
+ {$str+ | (send $str :freeze)+ | (array $str+) | (array (send $str :freeze)+)}
162
+ )
160
163
  PATTERN
161
164
 
162
165
  def name
@@ -193,10 +196,12 @@ module RuboCop
193
196
  end
194
197
 
195
198
  def version_from_right_hand_side(right_hand_side)
199
+ gem_requirement_versions = gem_requirement_versions(right_hand_side)
200
+
196
201
  if right_hand_side.array_type?
197
202
  version_from_array(right_hand_side)
198
- elsif gem_requirement?(right_hand_side)
199
- right_hand_side.children.last.value
203
+ elsif gem_requirement_versions
204
+ gem_requirement_versions.map(&:value)
200
205
  else
201
206
  right_hand_side.value
202
207
  end
@@ -3,15 +3,19 @@
3
3
  module RuboCop
4
4
  # This module holds the RuboCop version information.
5
5
  module Version
6
- STRING = '1.50.2'
6
+ STRING = '1.57.1'
7
7
 
8
8
  MSG = '%<version>s (using Parser %<parser_version>s, ' \
9
9
  'rubocop-ast %<rubocop_ast_version>s, ' \
10
10
  'running on %<ruby_engine>s %<ruby_version>s)%<server_mode>s [%<ruby_platform>s]'
11
11
 
12
- CANONICAL_FEATURE_NAMES = { 'Rspec' => 'RSpec', 'Graphql' => 'GraphQL', 'Md' => 'Markdown',
13
- 'Thread_safety' => 'ThreadSafety' }.freeze
14
- EXTENSION_PATH_NAMES = { 'rubocop-md' => 'markdown' }.freeze
12
+ CANONICAL_FEATURE_NAMES = {
13
+ 'Rspec' => 'RSpec', 'Graphql' => 'GraphQL', 'Md' => 'Markdown', 'Factory_bot' => 'FactoryBot',
14
+ 'Thread_safety' => 'ThreadSafety'
15
+ }.freeze
16
+ EXTENSION_PATH_NAMES = {
17
+ 'rubocop-md' => 'markdown', 'rubocop-factory_bot' => 'factory_bot'
18
+ }.freeze
15
19
 
16
20
  # @api private
17
21
  def self.version(debug: false, env: nil)
@@ -43,7 +47,7 @@ module RuboCop
43
47
  env.config_store.unvalidated.for_pwd.loaded_features.sort
44
48
  end
45
49
 
46
- features.map do |loaded_feature|
50
+ features.filter_map do |loaded_feature|
47
51
  next unless (match = loaded_feature.match(/rubocop-(?<feature>.*)/))
48
52
 
49
53
  # Get the expected name of the folder containing the extension code.
@@ -61,7 +65,7 @@ module RuboCop
61
65
  next unless (feature_version = feature_version(feature))
62
66
 
63
67
  " - #{loaded_feature} #{feature_version}"
64
- end.compact
68
+ end
65
69
  end
66
70
 
67
71
  # Returns feature version in one of two ways:
data/lib/rubocop.rb CHANGED
@@ -69,6 +69,7 @@ require_relative 'rubocop/cop/mixin/alignment'
69
69
  require_relative 'rubocop/cop/mixin/allowed_identifiers'
70
70
  require_relative 'rubocop/cop/mixin/allowed_methods'
71
71
  require_relative 'rubocop/cop/mixin/allowed_pattern'
72
+ require_relative 'rubocop/cop/mixin/allowed_receivers'
72
73
  require_relative 'rubocop/cop/mixin/auto_corrector' # rubocop:todo Naming/InclusiveLanguage
73
74
  require_relative 'rubocop/cop/mixin/check_assignment'
74
75
  require_relative 'rubocop/cop/mixin/check_line_breakable'
@@ -138,6 +139,7 @@ require_relative 'rubocop/cop/mixin/comments_help' # relies on visibility_help
138
139
  require_relative 'rubocop/cop/mixin/def_node' # relies on visibility_help
139
140
 
140
141
  require_relative 'rubocop/cop/utils/format_string'
142
+ require_relative 'rubocop/cop/utils/regexp_ranges'
141
143
 
142
144
  require_relative 'rubocop/cop/migration/department_name'
143
145
 
@@ -160,6 +162,7 @@ require_relative 'rubocop/cop/correctors/string_literal_corrector'
160
162
  require_relative 'rubocop/cop/correctors/unused_arg_corrector'
161
163
 
162
164
  require_relative 'rubocop/cop/bundler/duplicated_gem'
165
+ require_relative 'rubocop/cop/bundler/duplicated_group'
163
166
  require_relative 'rubocop/cop/bundler/gem_comment'
164
167
  require_relative 'rubocop/cop/bundler/gem_filename'
165
168
  require_relative 'rubocop/cop/bundler/gem_version'
@@ -335,6 +338,7 @@ require_relative 'rubocop/cop/lint/literal_in_interpolation'
335
338
  require_relative 'rubocop/cop/lint/loop'
336
339
  require_relative 'rubocop/cop/lint/missing_cop_enable_directive'
337
340
  require_relative 'rubocop/cop/lint/missing_super'
341
+ require_relative 'rubocop/cop/lint/mixed_case_range'
338
342
  require_relative 'rubocop/cop/lint/mixed_regexp_capture_types'
339
343
  require_relative 'rubocop/cop/lint/multiple_comparison'
340
344
  require_relative 'rubocop/cop/lint/nested_method_definition'
@@ -357,6 +361,7 @@ require_relative 'rubocop/cop/lint/rand_one'
357
361
  require_relative 'rubocop/cop/lint/redundant_cop_disable_directive'
358
362
  require_relative 'rubocop/cop/lint/redundant_cop_enable_directive'
359
363
  require_relative 'rubocop/cop/lint/redundant_dir_glob_sort'
364
+ require_relative 'rubocop/cop/lint/redundant_regexp_quantifiers'
360
365
  require_relative 'rubocop/cop/lint/redundant_require_statement'
361
366
  require_relative 'rubocop/cop/lint/redundant_safe_navigation'
362
367
  require_relative 'rubocop/cop/lint/redundant_splat_expansion'
@@ -507,6 +512,7 @@ require_relative 'rubocop/cop/style/end_block'
507
512
  require_relative 'rubocop/cop/style/env_home'
508
513
  require_relative 'rubocop/cop/style/eval_with_location'
509
514
  require_relative 'rubocop/cop/style/even_odd'
515
+ require_relative 'rubocop/cop/style/exact_regexp_match'
510
516
  require_relative 'rubocop/cop/style/expand_path_arguments'
511
517
  require_relative 'rubocop/cop/style/explicit_block_argument'
512
518
  require_relative 'rubocop/cop/style/exponential_notation'
@@ -557,18 +563,24 @@ require_relative 'rubocop/cop/style/multiline_in_pattern_then'
557
563
  require_relative 'rubocop/cop/style/numbered_parameters'
558
564
  require_relative 'rubocop/cop/style/open_struct_use'
559
565
  require_relative 'rubocop/cop/style/operator_method_call'
566
+ require_relative 'rubocop/cop/style/redundant_array_constructor'
560
567
  require_relative 'rubocop/cop/style/redundant_assignment'
561
568
  require_relative 'rubocop/cop/style/redundant_constant_base'
569
+ require_relative 'rubocop/cop/style/redundant_current_directory_in_path'
562
570
  require_relative 'rubocop/cop/style/redundant_double_splat_hash_braces'
563
571
  require_relative 'rubocop/cop/style/redundant_each'
564
572
  require_relative 'rubocop/cop/style/redundant_fetch_block'
565
573
  require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
574
+ require_relative 'rubocop/cop/style/redundant_filter_chain'
566
575
  require_relative 'rubocop/cop/style/redundant_heredoc_delimiter_quotes'
567
576
  require_relative 'rubocop/cop/style/redundant_initialize'
568
577
  require_relative 'rubocop/cop/style/redundant_line_continuation'
578
+ require_relative 'rubocop/cop/style/redundant_regexp_argument'
579
+ require_relative 'rubocop/cop/style/redundant_regexp_constructor'
569
580
  require_relative 'rubocop/cop/style/redundant_self_assignment'
570
581
  require_relative 'rubocop/cop/style/redundant_self_assignment_branch'
571
582
  require_relative 'rubocop/cop/style/require_order'
583
+ require_relative 'rubocop/cop/style/single_line_do_end_block'
572
584
  require_relative 'rubocop/cop/style/sole_nested_conditional'
573
585
  require_relative 'rubocop/cop/style/static_class'
574
586
  require_relative 'rubocop/cop/style/map_compact_with_conditional_block'
@@ -643,6 +655,7 @@ require_relative 'rubocop/cop/style/regexp_literal'
643
655
  require_relative 'rubocop/cop/style/rescue_modifier'
644
656
  require_relative 'rubocop/cop/style/rescue_standard_error'
645
657
  require_relative 'rubocop/cop/style/return_nil'
658
+ require_relative 'rubocop/cop/style/return_nil_in_predicate_method_definition'
646
659
  require_relative 'rubocop/cop/style/safe_navigation'
647
660
  require_relative 'rubocop/cop/style/sample'
648
661
  require_relative 'rubocop/cop/style/select_by_regexp'
@@ -689,6 +702,7 @@ require_relative 'rubocop/cop/style/when_then'
689
702
  require_relative 'rubocop/cop/style/while_until_do'
690
703
  require_relative 'rubocop/cop/style/while_until_modifier'
691
704
  require_relative 'rubocop/cop/style/word_array'
705
+ require_relative 'rubocop/cop/style/yaml_file_read'
692
706
  require_relative 'rubocop/cop/style/yoda_condition'
693
707
  require_relative 'rubocop/cop/style/yoda_expression'
694
708
  require_relative 'rubocop/cop/style/zero_length_predicate'
@@ -734,6 +748,7 @@ require_relative 'rubocop/cli/command/base'
734
748
  require_relative 'rubocop/cli/command/auto_generate_config'
735
749
  require_relative 'rubocop/cli/command/execute_runner'
736
750
  require_relative 'rubocop/cli/command/init_dotfile'
751
+ require_relative 'rubocop/cli/command/lsp'
737
752
  require_relative 'rubocop/cli/command/show_cops'
738
753
  require_relative 'rubocop/cli/command/show_docs_url'
739
754
  require_relative 'rubocop/cli/command/suggest_extensions'