Class: RuboCop::Cop::Style::MultilineIfThen

Inherits:
Cop
  • Object
show all
Includes:
IfNode, OnNormalIfUnless
Defined in:
lib/rubocop/cop/style/multiline_if_then.rb

Overview

Checks for uses of the ‘then` keyword in multi-line if statements.

Examples:

This is considered bad practice:


if cond then
end

If statements can contain ‘then` on the same line:


if cond then a
elsif cond then b
end

Constant Summary

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from OnNormalIfUnless

#case_else_clause, #if_else_clause, #invoke_hook_for_normal_if_unless, #on_if

Methods included from IfNode

#elsif?, #if_else?, #if_node_parts, #modifier_if?, #ternary?

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/rubocop/cop/style/multiline_if_then.rb', line 33

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

#message(node) ⇒ Object 



29
30
31
 
# File 'lib/rubocop/cop/style/multiline_if_then.rb', line 29

def message(node)
  "Do not use `then` for multi-line `#{node.loc.keyword.source}`."
end

#on_normal_if_unless(node) ⇒ Object 



23
24
25
26
27
 
# File 'lib/rubocop/cop/style/multiline_if_then.rb', line 23

def on_normal_if_unless(node)
  return unless node.loc.begin
  return unless node.loc.begin.source_line =~ /then\s*(#.*)?$/
  add_offense(node, :begin)
end