Class: RuboCop::Cop::Layout::SpaceAroundEqualsInParameterDefault

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle, RangeHelp, SurroundingSpace
Defined in:
lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb

Overview

Checks that the equals signs in parameter default assignments have or don’t have surrounding space depending on configuration.

Examples:

EnforcedStyle: space (default)

# bad
def some_method(arg1=:default, arg2=nil, arg3=[])
  # do something...
end

# good
def some_method(arg1 = :default, arg2 = nil, arg3 = [])
  # do something...
end

EnforcedStyle: no_space

# bad
def some_method(arg1 = :default, arg2 = nil, arg3 = [])
  # do something...
end

# good
def some_method(arg1=:default, arg2=nil, arg3=[])
  # do something...
end

Constant Summary collapse

MSG = 
'Surrounding space %<type>s in default value assignment.'

Constants included from SurroundingSpace

SurroundingSpace::NO_SPACE_COMMAND, SurroundingSpace::SINGLE_SPACE_REGEXP, SurroundingSpace::SPACE_COMMAND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



43
44
45
46
47
48
 
# File 'lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb', line 43

def autocorrect(range)
  m = range.source.match(/=\s*(\S+)/)
  rest = m ? m.captures[0] : ''
  replacement = style == :space ? ' = ' : '='
  ->(corrector) { corrector.replace(range, replacement + rest) }
end

#on_optarg(node) ⇒ Object 



37
38
39
40
41
 
# File 'lib/rubocop/cop/layout/space_around_equals_in_parameter_default.rb', line 37

def on_optarg(node)
  index = index_of_first_token(node)
  arg, equals, value = processed_source.tokens[index, 3]
  check_optarg(arg, equals, value)
end