123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::OneLineConditional

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::OnNormalIfUnless, ::RuboCop::Cop::ConfigurableEnforcedStyle, ::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/one_line_conditional.rb

Overview

Checks for uses of if/then/else/end constructs on a single line. AlwaysCorrectToMultiline config option can be set to true to auto-convert all offenses to multi-line constructs. When AlwaysCorrectToMultiline is false (default case) the autocorrect will first try converting them to ternary operators.

Examples:

# bad
if foo then bar else baz end

# bad
unless foo then baz else bar end

# good
foo ? bar : baz

# good
bar if foo

# good
if foo then bar end

# good
if foo
  bar
else
  baz
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::Alignment - Included

SPACE

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

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.
.builtin?

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

Cops (other than builtin) are encouraged to implement this.
.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

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

#detected_style, #detected_style=, #no_acceptable_style?, #style_configured?

::RuboCop::Cop::Alignment - Included

#column_delta

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

::RuboCop::Cop::OnNormalIfUnless - Included

#on_if

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

::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,
#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_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.
#complete_investigation

Called to complete an investigation.
#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, #reset_investigation, #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, #max_line_length,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #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 Attribute Details

#always_multiline? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 77



def always_multiline?
  @config.for_cop('Style/OneLineConditional')['AlwaysCorrectToMultiline']
end


  







Instance Method Details



  

    #autocorrect(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 59



def autocorrect(corrector, node)
  if always_multiline? || cannot_replace_to_ternary?(node)
    IfThenCorrector.new(node, indentation: configured_indentation_width).call(corrector)
  else
    corrector.replace(node, ternary_correction(node))
  end
end


  








  

    #cannot_replace_to_ternary?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


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



def cannot_replace_to_ternary?(node)
  node.elsif_conditional?
end


  








  

    #expr_replacement(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 93



def expr_replacement(node)
  return 'nil' if node.nil?

  requires_parentheses?(node) ? "(#{node.source})" : node.source
end


  








  

    #keyword_with_changed_precedence?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 114



def keyword_with_changed_precedence?(node)
  return false unless node.keyword?
  return true if node.respond_to?(:prefix_not?) && node.prefix_not?

  node.respond_to?(:arguments?) && node.arguments? && !node.parenthesized_call?
end


  








  

    #message(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 55



def message(node)
  format(MSG, keyword: node.keyword)
end


  








  

    #method_call_with_changed_precedence?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 107



def method_call_with_changed_precedence?(node)
  return false unless node.send_type? && node.arguments?
  return false if node.parenthesized_call?

  !node.operator_method?
end


  








  

    #on_normal_if_unless(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 42



def on_normal_if_unless(node)
  return unless node.single_line?
  return unless node.else_branch
  return if node.elsif?

  message = message(node)
  add_offense(node, message: message) do |corrector|
    autocorrect(corrector, node)
  end
end


  








  

    #requires_parentheses?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 99



def requires_parentheses?(node)
  return true if %i[and or if].include?(node.type)
  return true if node.assignment?
  return true if method_call_with_changed_precedence?(node)

  keyword_with_changed_precedence?(node)
end


  








  

    #ternary_correction(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 67



def ternary_correction(node)
  replaced_node = ternary_replacement(node)

  return replaced_node unless node.parent
  return "(#{replaced_node})" if node.parent.operator_keyword?
  return "(#{replaced_node})" if node.parent.send_type? && node.parent.operator_method?

  replaced_node
end


  








  

    #ternary_replacement(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/one_line_conditional.rb', line 85



def ternary_replacement(node)
  condition, if_branch, else_branch = *node

  "#{expr_replacement(condition)} ? " \
    "#{expr_replacement(if_branch)} : " \
    "#{expr_replacement(else_branch)}"
end