Class: RuboCop::Cop::Style::StringChars

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/string_chars.rb

Overview

Checks for uses of String#split with empty string or regexp literal argument.

Examples:

# bad
string.split(//)
string.split('')

# good
string.chars

Cop Safety Information:

  • This cop is unsafe because it cannot be guaranteed that the receiver is actually a string. If another class has a split method with different behavior, it would be registered as a false positive.

Constant Summary collapse

MSG = 
'Use `chars` instead of `%<current>s`.'
RESTRICT_ON_SEND = 
%i[split].freeze
BAD_ARGUMENTS = 
%w[// '' ""].freeze

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, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #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, #ready, #relevant_file?, 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_send(node) ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'lib/rubocop/cop/style/string_chars.rb', line 29

def on_send(node)
  return unless node.arguments.one? && BAD_ARGUMENTS.include?(node.first_argument.source)

  range = range_between(node.loc.selector.begin_pos, node.source_range.end_pos)

  add_offense(range, message: format(MSG, current: range.source)) do |corrector|
    corrector.replace(range, 'chars')
  end
end