Class: RuboCop::Cop::Style::Strip

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

Overview

This cop identifies places where `lstrip.rstrip` can be replaced by `strip`.

Examples:

# bad
'abc'.lstrip.rstrip
'abc'.rstrip.lstrip

# good
'abc'.strip

Constant Summary collapse

MSG =
'Use `strip` instead of `%<methods>s`.'
RESTRICT_ON_SEND =
%i[lstrip rstrip].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

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #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, 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?, #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

#lstrip_rstrip(node) ⇒ Object


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

def_node_matcher :lstrip_rstrip, <<~PATTERN
  {(send $(send _ $:rstrip) $:lstrip)
   (send $(send _ $:lstrip) $:rstrip)}
PATTERN

#on_send(node) ⇒ Object


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

def on_send(node)
  lstrip_rstrip(node) do |first_send, method_one, method_two|
    range = range_between(first_send.loc.selector.begin_pos, node.source_range.end_pos)
    message = format(MSG, methods: "#{method_one}.#{method_two}")

    add_offense(range, message: message) do |corrector|
      corrector.replace(range, 'strip')
    end
  end
end