Class: RuboCop::Cop::Style::MultilineWhenThen

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/multiline_when_then.rb

Overview

This cop checks uses of the ‘then` keyword in multi-line when statements.

Examples:

# bad
case foo
when bar then
end

# good
case foo
when bar
end

# good
case foo
when bar then do_something
end

Constant Summary collapse

MSG = 
'Do not use `then` for multiline `when` statement.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #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?, #safe_autocorrect?, #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

#accept_node_type?(node) ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/rubocop/cop/style/multiline_when_then.rb', line 53

def accept_node_type?(node)
  node&.begin_type? || node&.array_type? || node&.hash_type?
end

#autocorrect(node) ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/style/multiline_when_then.rb', line 43

def autocorrect(node)
  lambda do |corrector|
    corrector.remove(
      range_with_surrounding_space(
        range: node.loc.begin, side: :left, newlines: false
      )
    )
  end
end

#on_when(node) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/rubocop/cop/style/multiline_when_then.rb', line 30

def on_when(node)
  # Without `then`, there's no offense
  return unless node.then?

  # Single line usage of `then` is not an offense
  return if !node.children.last.nil? && !node.multiline? && node.then?

  # With more than one statements after then, there's not offense
  return if accept_node_type?(node.body)

  add_offense(node, location: :begin)
end