Class: RuboCop::Cop::Style::ItAssignment

Inherits:

Base

• Object
• Base
• RuboCop::Cop::Style::ItAssignment

Defined in:

lib/rubocop/cop/style/it_assignment.rb

Overview

Checks for local variables and method parameters named ‘it`, where `it` can refer to the first anonymous parameter as of Ruby 3.4. Use a meaningful variable name instead.

NOTE: Although Ruby allows reassigning ‘it` in these cases, it could cause confusion if `it` is used as a block parameter elsewhere.

Examples:

# bad
it = 5

# good
var = 5

# bad
def foo(it)
end

# good
def foo(arg)
end

# bad
def foo(it = 5)
end

# good
def foo(arg = 5)
end

# bad
def foo(*it)
end

# good
def foo(*args)
end

# bad
def foo(it:)
end

# good
def foo(arg:)
end

# bad
def foo(it: 5)
end

# good
def foo(arg: 5)
end

# bad
def foo(**it)
end

# good
def foo(**kwargs)
end

# bad
def foo(&it)
end

# good
def foo(&block)
end

Constant Summary

MSG =

'`it` is the default block parameter; consider another name.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary

• #on_lvasgn(node) ⇒ Object (also: #on_arg, #on_optarg, #on_restarg, #on_blockarg, #on_kwarg, #on_kwoptarg, #on_kwrestarg)

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_lvasgn(node) ⇒ Object Also known as: on_arg, on_optarg, on_restarg, on_blockarg, on_kwarg, on_kwoptarg, on_kwrestarg

# File 'lib/rubocop/cop/style/it_assignment.rb', line 78

def on_lvasgn(node)
  return unless node.name == :it

  add_offense(node.loc.name)
end