Class: RuboCop::Cop::Lint::EmptyWhen

Inherits:
Base
  • Object
show all
Includes:
CommentsHelp
Defined in:
lib/rubocop/cop/lint/empty_when.rb

Overview

Checks for the presence of ‘when` branches without a body.

Examples:


# bad
case foo
when bar
  do_something
when baz
end

# good
case condition
when foo
  do_something
when bar
  nil
end

AllowComments: true (default)


# good
case condition
when foo
  do_something
when bar
  # noop
end

AllowComments: false


# bad
case condition
when foo
  do_something
when bar
  # do nothing
end

Constant Summary collapse

MSG = 
'Avoid `when` branches without a body.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from CommentsHelp

#comments_contain_disables?, #comments_in_range, #contains_comments?, #source_range_with_comment

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, support_autocorrect?, support_multiple_source?, #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_case(node) ⇒ Object 



52
53
54
55
56
57
58
59
 
# File 'lib/rubocop/cop/lint/empty_when.rb', line 52

def on_case(node)
  node.each_when do |when_node|
    next if when_node.body
    next if cop_config['AllowComments'] && contains_comments?(when_node)

    add_offense(when_node)
  end
end