Class: RuboCop::Cop::Lint::BooleanSymbol

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/lint/boolean_symbol.rb

Overview

Checks for ‘:true` and `:false` symbols. In most cases it would be a typo.

Examples:


# bad
:true

# good
true

# bad
:false

# good
false

Constant Summary collapse

MSG = 
'Symbol with a boolean name - you probably meant to use `%<boolean>s`.'

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 AutoCorrector

support_autocorrect?

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_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

#boolean_symbol?(node) ⇒ Object 



33
 
# File 'lib/rubocop/cop/lint/boolean_symbol.rb', line 33

def_node_matcher :boolean_symbol?, '(sym {:true :false})'

#on_sym(node) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/rubocop/cop/lint/boolean_symbol.rb', line 35

def on_sym(node)
  return unless boolean_symbol?(node)

  parent = node.parent
  return if parent&.array_type? && parent.percent_literal?(:symbol)

  add_offense(node, message: format(MSG, boolean: node.value)) do |corrector|
    autocorrect(corrector, node)
  end
end