Class: RuboCop::Cop::Style::EndlessMethod
| Relationships & Source Files | |
| Super Chains via Extension / Inclusion / Inheritance | |
|
Class Chain:
self,
::RuboCop::Cop::AutoCorrector,
::RuboCop::Cop::TargetRubyVersion,
::RuboCop::Cop::Base,
::RuboCop::ExcludeLimit,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
|
Instance Chain:
self,
::RuboCop::Cop::EndlessMethodBodyHelp,
::RuboCop::Cop::EndlessMethodRewriter,
::RuboCop::Cop::LineLengthHelp,
::RuboCop::Cop::Alignment,
::RuboCop::Cop::ConfigurableEnforcedStyle,
::RuboCop::Cop::Base,
::RuboCop::Cop::AutocorrectLogic,
::RuboCop::Cop::IgnoredNode,
::RuboCop::Util,
RuboCop::AST::Sexp
|
|
| Inherits: |
RuboCop::Cop::Base
|
| Defined in: | lib/rubocop/cop/style/endless_method.rb |
Overview
Checks for endless methods.
It can enforce endless method definitions whenever possible or with single line methods. It can also disallow multiline endless method definitions or all endless definitions.
require_single_line style enforces endless method definitions for single line methods.
require_always style enforces endless method definitions for single statement methods.
Other method definition types are not considered by this cop.
The supported styles are:
-
allow_single_line (default) - only single line endless method definitions are allowed.
-
allow_always - all endless method definitions are allowed.
-
disallow - all endless method definitions are disallowed.
-
require_single_line - endless method definitions are required for single line methods.
-
require_always - all endless method definitions are required.
|
Note
|
Incorrect endless method definitions will always be corrected to a multi-line definition. |
Constant Summary
-
CORRECTION_STYLES =
# File 'lib/rubocop/cop/style/endless_method.rb', line 142%w[multiline single_line].freeze
-
MSG =
# File 'lib/rubocop/cop/style/endless_method.rb', line 143'Avoid endless method definitions.' -
MSG_MULTI_LINE =
# File 'lib/rubocop/cop/style/endless_method.rb', line 144'Avoid endless method definitions with multiple lines.' -
MSG_REQUIRE_ALWAYS =
# File 'lib/rubocop/cop/style/endless_method.rb', line 146'Use endless method definitions.' -
MSG_REQUIRE_SINGLE =
# File 'lib/rubocop/cop/style/endless_method.rb', line 145'Use endless method definitions for single line methods.'
::RuboCop::Cop::Base - Inherited
DEPARTMENT_SEVERITIES, EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::ConfigurableEnforcedStyle - Included
::RuboCop::Cop::Alignment - Included
::RuboCop::Cop::EndlessMethodBodyHelp - Included
Class Attribute Summary
::RuboCop::Cop::AutoCorrector - Extended
::RuboCop::Cop::Base - Inherited
| .gem_requirements, .lint?, | |
| .support_autocorrect? | Returns if class supports autocorrect. |
| .support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to |
Class Method Summary
-
.autocorrect_incompatible_with
Style/MethodDefParenthesesadds the same parentheses a parameter list needs in an endless definition, so letting both correct in the same pass would double them.
::RuboCop::Cop::TargetRubyVersion - Extended
| maximum_target_ruby_version, minimum_target_ruby_version, required_maximum_ruby_version, required_minimum_ruby_version, support_target_ruby_version? |
::RuboCop::Cop::Base - Inherited
| .autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
| .badge | Naming. |
| .callbacks_needed, .cop_name, .department, | |
| .documentation_url | Returns a url to view this cops documentation online. |
| .exclude_from_registry | Call for abstract Cop classes. |
| .inherited, | |
| .joining_forces | Override and return the Force class(es) you need to join. |
| .match? | Returns true if the cop name or the cop namespace matches any of the given names. |
| .new, | |
| .requires_gem | Register a version requirement for the given gem name. |
| .restrict_on_send | Reserved for Commissioner. |
::RuboCop::ExcludeLimit - Extended
| exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
| transform | |
Instance Attribute Summary
- #space_inside_parens? ⇒ Boolean readonly private
::RuboCop::Cop::LineLengthHelp - Included
::RuboCop::Cop::Alignment - Included
::RuboCop::Cop::ConfigurableEnforcedStyle - Included
::RuboCop::Cop::Base - Inherited
| #active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #disabled_autocorrect?, | |
| #preview? | Whether the user opted in to unstable behavior, with |
| #processed_source, #project_index, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements? | |
::RuboCop::Cop::AutocorrectLogic - Included
| #autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?, | |
| #skipped_unsafe_correction_with_disable_uncorrectable? | Whether a correction exists but is skipped because it is unsafe in a safe autocorrect run, while |
| #contextual_autocorrect_held_back? | When LSP is enabled or the |
Instance Method Summary
- #on_def(node) (also: #on_defs)
-
#on_defs(node)
Alias for #on_def.
- #ambiguous_enclosing_operation?(operation) ⇒ Boolean private
- #ambiguous_operation(node) private
- #ambiguous_when_made_endless?(node) ⇒ Boolean private
- #arguments(node, missing = '') private
- #body_to_end_range(node) private
- #can_be_made_endless?(node) ⇒ Boolean private
- #comment_in_discarded_range?(node) ⇒ Boolean private
- #convertible_to_endless?(node) ⇒ Boolean private
- #correct_to_endless(corrector, node) private
- #corrected_to_multiline?(node) ⇒ Boolean private
- #endless_replacement(node) private
- #handle_allow_style(node) private
- #handle_disallow_style(node) private
- #handle_require_always_style(node) private
- #handle_require_single_line_style(node) private
- #line_when_made_endless(node) private
- #name_to_arguments_range(node) private
- #nested_in_multiline_correction?(node) ⇒ Boolean private
- #parenthesized_arguments(node) private
- #signature_to_body_range(node) private
- #single_line_when_made_endless?(node) ⇒ Boolean private
- #too_long_when_made_endless?(node) ⇒ Boolean private
- #unparenthesized_arguments?(node) ⇒ Boolean private
- #use_heredoc?(node) ⇒ Boolean private
::RuboCop::Cop::EndlessMethodBodyHelp - Included
| #argument_receiving_call, #assigned_value, #body_disallowed_outside_statement?, #command_body_outside_statement?, | |
| #command_call? |
|
| #command_disallowed_in_endless_body?, #command_position?, #do_end_block_body_in_command_argument?, #endless_method_body?, #endless_method_with_command_body?, #ends_with_anonymous_argument?, #ends_with_omitted_hash_value?, | |
| #low_precedence_body? |
|
| #multiple_values? |
|
| #negated_command_call?, #setter_call?, #statement_body? | |
::RuboCop::Cop::EndlessMethodRewriter - Included
::RuboCop::Cop::LineLengthHelp - Included
::RuboCop::Cop::Alignment - Included
| #check_alignment, #configured_indentation_width, #display_column, #each_bad_alignment, #end_of_line_comment, #indentation, #offset, #register_offense, #within? |
::RuboCop::Cop::ConfigurableEnforcedStyle - Included
::RuboCop::Cop::Base - Inherited
| #add_global_offense | Adds an offense that has no particular location. |
| #add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
| #begin_investigation | Called before any investigation. |
| #callbacks_needed | — grouped under the Commissioner heading above. |
| #cop_config | Configuration Helpers. |
| #cop_name, #excluded_file?, | |
| #external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
| #inspect, | |
| #message | Gets called if no message is specified when calling |
| #name | Alias for Base#cop_name. |
| #offenses, | |
| #on_investigation_end | Called after all on_… |
| #on_new_investigation | Called before all on_… |
| #on_other_file | Called instead of all on_… |
| #parse | There should be very limited reasons for a Cop to do it’s own parsing The source is parsed the way the file under investigation was. |
| #parser_engine, | |
| #ready | Called between investigations. |
| #relevant_file?, | |
| #target_gem_version | Returns the version of a gem in the target, by default its locked version (i.e. from Gemfile.lock or gems.locked). |
| #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
| #callback_argument | Reserved for Cop::Cop. |
| #complete_investigation | Called to complete an investigation. |
| #correct, #covering_disabled_range, #current_corrector, | |
| #current_offense_locations | Reserved for Commissioner: |
| #current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, | |
| #enabled_lines? | A multi-line offense is suppressed by a directive on any line of its range, not only its first line, matching the intuition that the directive is attached to the offending code. |
| #file_name_matches_any?, #find_message, #find_severity, #matches_absolute_include_pattern?, #new_offense, #range_for_original, #range_from_node_or_range, | |
| #reset_investigation | Actually private methods. |
| #suppression_reason | The |
| #use_corrector | |
::RuboCop::Cop::AutocorrectLogic - Included
::RuboCop::Cop::IgnoredNode - Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Class Method Details
.autocorrect_incompatible_with
Style/MethodDefParentheses adds the same parentheses a parameter list needs in
an endless definition, so letting both correct in the same pass would double them.
Style/GuardClause and Style/IdenticalConditionalBranches turn a body that is
a single conditional into several statements, which an endless definition cannot hold.
Style/RaiseArgs would drop the parentheses of a raise that becomes
the body in the same pass, which a method passed as an argument needs.
Style/IfUnlessModifier and Style/WhileUntilModifier would turn the body into
a modifier form, which then applies to the whole endless definition.
Lint/LiteralAsCondition and Lint/UselessTimes replace the body with
the statements inside it, which an endless definition may not hold.
# File 'lib/rubocop/cop/style/endless_method.rb', line 158
def self.autocorrect_incompatible_with [ Lint::LiteralAsCondition, Lint::UselessTimes, Style::GuardClause, Style::IdenticalConditionalBranches, Style::IfUnlessModifier, Style::MethodCallWithArgsParentheses, Style::MethodDefParentheses, Style::RaiseArgs, Style::WhileUntilModifier ] end
Instance Attribute Details
#space_inside_parens? ⇒ Boolean (readonly, private)
[ GitHub ]
Instance Method Details
#ambiguous_enclosing_operation?(operation) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 344
def ambiguous_enclosing_operation?(operation) operation.operator_keyword? || operation.modifier_form? end
#ambiguous_operation(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 336
def_node_matcher :ambiguous_operation, <<~PATTERN ^${ (if _ <any_def _>) ({and or} any_def _) ({while until} _ any_def) } PATTERN
#ambiguous_when_made_endless?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 331
def ambiguous_when_made_endless?(node) (operation = ambiguous_operation(node)) && ambiguous_enclosing_operation?(operation) end
#arguments(node, missing = '') (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 301
def arguments(node, missing = '') return missing unless node.arguments.any? return parenthesized_arguments(node) if unparenthesized_arguments?(node) node.arguments.source end
#body_to_end_range(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 291
def body_to_end_range(node) node.body.source_range.end.join(node.loc.end.end) end
#can_be_made_endless?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 320
def can_be_made_endless?(node) return false unless node.body return false if comment_in_discarded_range?(node) endless_method_body?(node.body) end
#comment_in_discarded_range?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 354
def comment_in_discarded_range?(node) discarded_ranges = [signature_to_body_range(node), body_to_end_range(node)] processed_source.each_comment_in_lines(node.first_line..node.last_line).any? do |comment| discarded_ranges.any? { |range| range.contains?(comment.source_range) } end end
#convertible_to_endless?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 225
def convertible_to_endless?(node) !node.endless? && can_be_made_endless?(node) && !too_long_when_made_endless?(node) && !ambiguous_when_made_endless?(node) end
#correct_to_endless(corrector, node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 266
def correct_to_endless(corrector, node) if unparenthesized_arguments?(node) corrector.replace(name_to_arguments_range(node), '(') corrector.replace(signature_to_body_range(node), ') = ') else corrector.replace(signature_to_body_range(node), ' = ') end corrector.remove(body_to_end_range(node)) end
#corrected_to_multiline?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 246
def corrected_to_multiline?(node) return false if !node.endless? || use_heredoc?(node) case style when :disallow true when :allow_single_line, :require_single_line node.multiline? else false end end
#endless_replacement(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 295
def endless_replacement(node) <<~RUBY.strip def #{receiver(node)}#{node.method_name}#{arguments(node)} = #{node.body.source} RUBY end
#handle_allow_style(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 190
def handle_allow_style(node) return unless node.endless? return if node.single_line? || style == :allow_always add_offense(node, message: MSG_MULTI_LINE) do |corrector| next if nested_in_multiline_correction?(node) correct_to_multiline(corrector, node) end end
#handle_disallow_style(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 230
def handle_disallow_style(node) return unless node.endless? add_offense(node) do |corrector| next if nested_in_multiline_correction?(node) correct_to_multiline(corrector, node) end end
#handle_require_always_style(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 217
def handle_require_always_style(node) return unless convertible_to_endless?(node) add_offense(node, message: MSG_REQUIRE_ALWAYS) do |corrector| correct_to_endless(corrector, node) end end
#handle_require_single_line_style(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 201
def handle_require_single_line_style(node) if node.endless? && node.multiline? add_offense(node, message: MSG_MULTI_LINE) do |corrector| next if nested_in_multiline_correction?(node) correct_to_multiline(corrector, node) end elsif convertible_to_endless?(node) && single_line_when_made_endless?(node) add_offense(node, message: MSG_REQUIRE_SINGLE) do |corrector| next if nested_in_multiline_correction?(node) correct_to_endless(corrector, node) end end end
#line_when_made_endless(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 362
def line_when_made_endless(node) keyword_element = node.loc.keyword code_before = keyword_element.source_line[0...keyword_element.column] end_element = node.loc.end code_after = end_element.source_line[end_element.last_column..] "#{code_before}#{endless_replacement(node)}#{code_after}" end
#name_to_arguments_range(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 281
def name_to_arguments_range(node) node.loc.name.end.join(node.arguments.source_range.begin) end
#nested_in_multiline_correction?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 240
def nested_in_multiline_correction?(node) node.each_ancestor(:any_def).any? do |ancestor| corrected_to_multiline?(ancestor) end end
#on_def(node) Also known as: #on_defs
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 172
def on_def(node) return if node.assignment_method? || use_heredoc?(node) case style when :allow_single_line, :allow_always handle_allow_style(node) when :disallow handle_disallow_style(node) when :require_single_line handle_require_single_line_style(node) when :require_always handle_require_always_style(node) end end
#on_defs(node)
Alias for #on_def.
# File 'lib/rubocop/cop/style/endless_method.rb', line 186
alias on_defs on_def
#parenthesized_arguments(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/endless_method.rb', line 308
def parenthesized_arguments(node) padding = space_inside_parens? ? ' ' : '' "(#{padding}#{node.arguments.source}#{padding})" end
#signature_to_body_range(node) (private)
[ GitHub ]
#single_line_when_made_endless?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 327
def single_line_when_made_endless?(node) !endless_replacement(node).include?("\n") end
#too_long_when_made_endless?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 348
def too_long_when_made_endless?(node) return false unless config.cop_enabled?('Layout/LineLength') line_length(line_when_made_endless(node)) > max_line_length end
#unparenthesized_arguments?(node) ⇒ Boolean (private)
#use_heredoc?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/endless_method.rb', line 259
def use_heredoc?(node) return false unless (body = node.body) return true if body.any_str_type? && body.heredoc? body.each_descendant(:any_str).any?(&:heredoc?) end