123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::MultilineIfModifier

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::RangeHelp, ::RuboCop::Cop::StatementModifier, ::RuboCop::Cop::AllowedPattern, ::RuboCop::Cop::LineLengthHelp, ::RuboCop::Cop::Alignment, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/multiline_if_modifier.rb

Overview

Checks for uses of if/unless modifiers with multiple-lines bodies.

Examples:

# bad
{
  result: 'this should not happen'
} unless cond

# good
{ result: 'ok' } if cond

Constant Summary

::RuboCop::Cop::Base - Inherited

DEPARTMENT_SEVERITIES, EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::Alignment - Included

SPACE

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::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 on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::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

::RuboCop::Cop::LineLengthHelp - Included

#allow_cop_directives?, #allow_qualified_name?, #allow_rbs_inline_annotation?, #allow_uri?

::RuboCop::Cop::Alignment - Included

#column_delta, #using_tabs?

::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 --preview or AllCops: Preview.
#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 --disable-uncorrectable asks for a todo comment on everything this run cannot correct.
#contextual_autocorrect_held_back?

When LSP is enabled or the --editor-mode option is on, it is considered as editing source code, and autocorrection with AutoCorrect: contextual will not be performed.

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range,
#arguments_range

A range containing the first to the last argument of a method call or method definition.
#column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos

rubocop:disable-next Metrics/ParameterLists.
#move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::StatementModifier - Included

#acceptable_line_length?

Whether an existing line is acceptable to Layout/LineLength, exemptions (the cop disabled at that line, an allowed pattern, an allowed cop directive, an allowed URI) included.
#allowed_by_uri?,
#allowed_patterns

`Layout/LineLength’s allowed patterns, so a modifier line that the user has configured that cop to accept is not flagged for length here.
#code_after, #comment_disables_cop?, #first_line_comment,
#if_body_source

rubocop:disable-next Metrics/AbcSize.
#line_in_modifier_form, #line_length_enabled_at_line?, #method_source,
#modifier_fits_on_single_line?

The rendered modifier form is compared against the bare maximum, not acceptable_line_length?: `Layout/LineLength’s exemptions describe long lines the user tolerates, not permission to manufacture new ones, so collapsing to modifier form must never push a line past the maximum.
#non_eligible_body?, #non_eligible_condition?, #non_eligible_node?, #parenthesize?, #single_line_as_modifier?, #ternary_branch_or_endless_method_body?, #to_modifier_form, #unparenthesized_call_with_omitted_value?, #wrapped_value

::RuboCop::Cop::AllowedPattern - Included

#allowed_line?, #allowed_pattern_regexps, #allowed_patterns, #cop_config_deprecated_methods_values, #cop_config_patterns_values, #ignored_line?, #matches_allowed_pattern?, #matches_ignored_pattern?

::RuboCop::Cop::LineLengthHelp - Included

#allowed_position?, #directive_on_source_line?, #extend_end_position, #find_excessive_range, #indentation_difference, #line_length, #line_length_without_directive, #match_qualified_names, #match_uris, #qualified_name_regexp, #rbs_inline_annotation_on_source_line?, #tab_indentation_width, #uri_regexp, #valid_uri?

::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::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 add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#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.
#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 -- reason on the directive that suppresses offenses on this range, or nil when the directive carries none.
#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#autocorrect(corrector, node) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/multiline_if_modifier.rb', line 38



def autocorrect(corrector, node)
  condition_heredoc, body_heredoc = [node.condition, node.body].map do |part|
    next unless (range = heredoc_after(part, node))

    corrector.remove(range)
    range.source.chomp
  end
  corrector.replace(node, to_normal_if(node, condition_heredoc, body_heredoc))
end


  








  

    #heredoc_after(part, node)   (private)
  



  

    


Heredocs opened on the modifier line have their bodies after it, so
they are moved along with the part of the if they belong to.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_if_modifier.rb', line 50



def heredoc_after(part, node)
  ranges = part.each_node(:any_str).select(&:heredoc?).map do |heredoc|
    heredoc.loc.heredoc_body.join(heredoc.loc.heredoc_end)
  end
  ranges.select! { |range| range.line > node.last_line }
  return if ranges.empty?

  range_by_whole_lines(ranges.reduce(:join), include_final_newline: true)
end


  








  

    #indented_body(body, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_if_modifier.rb', line 69



def indented_body(body, node)
  body_source = "#{offset(node)}#{body.source}"
  verbatim_lines = verbatim_lines_in(body)
  body_source.each_line.with_index(body.first_line).map do |line, line_number|
    if line == "\n" || verbatim_lines.include?(line_number)
      line
    else
      line.sub(/^\s{#{offset(node).length}}/, indentation(node))
    end
  end.join
end


  








  

    #on_if(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_if_modifier.rb', line 26



def on_if(node)
  return if part_of_ignored_node?(node)
  return unless node.modifier_form? && node.body.multiline?

  add_offense(node, message: format(MSG, keyword: node.keyword)) do |corrector|
    autocorrect(corrector, node)
  end
  ignore_node(node)
end


  








  

    #to_normal_if(node, condition_heredoc, body_heredoc)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_if_modifier.rb', line 60



def to_normal_if(node, condition_heredoc, body_heredoc)
  indented_body = indented_body(node.body, node)
  condition = "#{node.keyword} #{node.condition.source}"
  indented_end = "#{offset(node)}end"

  lines = [condition, condition_heredoc, indented_body, body_heredoc, indented_end]
  lines.compact.join("\n")
end


  








  

    #verbatim_line_range(str)   (private)
  



  

    


The indentation of a line that starts inside a string is part of the
string. Only squiggly heredocs strip it from their bodies, and a <<
terminator has to stay at the start of its line.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_if_modifier.rb', line 88



def verbatim_line_range(str)
  if str.heredoc?
    str.loc.heredoc_body.line..str.loc.heredoc_end.line unless str.source.start_with?('<<~')
  elsif str.loc?(:begin) && str.loc?(:end)
    (str.first_line + 1)..str.last_line
  end
end


  








  

    #verbatim_lines_in(body)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_if_modifier.rb', line 81



def verbatim_lines_in(body)
  body.each_node(:any_str).filter_map { |str| verbatim_line_range(str) }.flat_map(&:to_a)
end