123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::IfWithSemicolon

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:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/if_with_semicolon.rb

Overview

Checks for uses of semicolon in if statements.

Examples:

# bad
result = if some_condition; something else another_thing end

# good
result = some_condition ? something : another_thing

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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

::RuboCop::ExcludeLimit - Extended

exclude_limit

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

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::OnNormalIfUnless - 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,
#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

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#autocorrect(node) (private)

[ GitHub ]

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

def autocorrect(node)
  return correct_elsif(node) if node.else_branch&.if_type?

  then_code = node.if_branch ? node.if_branch.source : 'nil'
  else_code = node.else_branch ? node.else_branch.source : 'nil'

  "#{node.condition.source} ? #{then_code} : #{else_code}"
end

#build_else_branch(second_condition) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 56

def build_else_branch(second_condition)
  result = <<~RUBY
    elsif #{second_condition.condition.source}
      #{second_condition.if_branch&.source}
  RUBY

  if second_condition.else_branch
    result += if second_condition.else_branch.if_type?
                build_else_branch(second_condition.else_branch)
              else
                <<~RUBY
                  else
                    #{second_condition.else_branch.source}
                RUBY
              end
  end

  result
end

#correct_elsif(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 47

def correct_elsif(node)
  <<~RUBY.chop
    if #{node.condition.source}
      #{node.if_branch&.source}
    #{build_else_branch(node.else_branch).chop}
    end
  RUBY
end

#on_normal_if_unless(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 23

def on_normal_if_unless(node)
  return if node.parent&.if_type?

  beginning = node.loc.begin
  return unless beginning&.is?(';')

  message = node.else_branch&.if_type? ? MSG_IF_ELSE : MSG_TERNARY

  add_offense(node, message: format(message, expr: node.condition.source)) do |corrector|
    corrector.replace(node, autocorrect(node))
  end
end