Class: RuboCop::Cop::Style::RedundantSelfAssignment
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::AutoCorrector ,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
self,
::RuboCop::Cop::RangeHelp ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/redundant_self_assignment.rb |
Overview
Checks for places where redundant assignments are made for in place modification methods.
Constant Summary
-
ASSIGNMENT_TYPE_TO_RECEIVER_TYPE =
# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 45{ lvasgn: :lvar, ivasgn: :ivar, cvasgn: :cvar, gvasgn: :gvar }.freeze
-
METHODS_RETURNING_SELF =
# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 38%i[ append clear collect! compare_by_identity concat delete_if fill initialize_copy insert keep_if map! merge! prepend push rehash replace reverse! rotate! shuffle! sort! sort_by! transform_keys! transform_values! unshift update ].to_set.freeze
-
MSG =
# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 35'Redundant self assignment detected. ' \ 'Method `%<method_name>s` modifies its receiver in place.'
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::RangeHelp
- Included
Class Attribute Summary
::RuboCop::Cop::AutoCorrector
- Extended
::RuboCop::Cop::Base
- Inherited
.gem_requirements, .lint?, | |
.support_autocorrect? | Returns if class supports autocorrect. |
.support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to |
Class Method Summary
::RuboCop::Cop::Base
- Inherited
.autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
.badge | Naming. |
.callbacks_needed, .cop_name, .department, | |
.documentation_url | Returns a url to view this cops documentation online. |
.exclude_from_registry | Call for abstract Cop classes. |
.inherited, | |
.joining_forces | Override and return the Force class(es) you need to join. |
.match? | Returns true if the cop name or the cop namespace matches any of the given names. |
.new, | |
.requires_gem | Register a version requirement for the given gem name. |
.restrict_on_send |
::RuboCop::ExcludeLimit
- Extended
exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
transform |
Instance Attribute Summary
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
-
#on_cvasgn(node)
Alias for #on_lvasgn.
-
#on_gvasgn(node)
Alias for #on_lvasgn.
-
#on_ivasgn(node)
Alias for #on_lvasgn.
- #on_lvasgn(node) (also: #on_ivasgn, #on_cvasgn, #on_gvasgn)
- #on_send(node)
- #correction_range(node) private
- #method_returning_self?(method_name) ⇒ Boolean private
- #redundant_assignment?(node) ⇒ Boolean private
- #redundant_nonself_assignment?(node, receiver, method_name) private
- #redundant_self_assignment?(node, method_name) private
::RuboCop::Cop::RangeHelp
- Included
#add_range, #column_offset_between, | |
#contents_range | A range containing only the contents of a literal with delimiters (e.g. |
#directions, | |
#effective_column | Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value. |
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range |
::RuboCop::Cop::Base
- Inherited
#add_global_offense | Adds an offense that has no particular location. |
#add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
#begin_investigation | Called before any investigation. |
#callbacks_needed, | |
#cop_config | Configuration Helpers. |
#cop_name, #excluded_file?, | |
#external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
#inspect, | |
#message | Gets called if no message is specified when calling |
#name | Alias for Base#cop_name. |
#offenses, | |
#on_investigation_end | Called after all on_… |
#on_new_investigation | Called before all on_… |
#on_other_file | Called instead of all on_… |
#parse | There should be very limited reasons for a Cop to do it’s own parsing. |
#parser_engine, | |
#ready | Called between investigations. |
#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
#callback_argument | Reserved for Cop::Cop. |
#complete_investigation | Called to complete an investigation. |
#correct, #current_corrector, | |
#current_offense_locations | Reserved for Commissioner: |
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, | |
#reset_investigation | Actually private methods. |
#use_corrector |
::RuboCop::Cop::AutocorrectLogic
- Included
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #max_line_length, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #string_continuation?, #surrounding_heredoc, #surrounding_percent_array |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#correction_range(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 114
def correction_range(node) range_between(node.source_range.begin_pos, node.first_argument.source_range.begin_pos) end
#method_returning_self?(method_name) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 83
def method_returning_self?(method_name) METHODS_RETURNING_SELF.include?(method_name) end
#on_cvasgn(node)
Alias for #on_lvasgn.
# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 68
alias on_cvasgn on_lvasgn
#on_gvasgn(node)
Alias for #on_lvasgn.
# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 69
alias on_gvasgn on_lvasgn
#on_ivasgn(node)
Alias for #on_lvasgn.
# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 67
alias on_ivasgn on_lvasgn
#on_lvasgn(node) Also known as: #on_ivasgn, #on_cvasgn, #on_gvasgn
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 53
def on_lvasgn(node) return unless (rhs = node.rhs) return unless rhs.send_type? && method_returning_self?(rhs.method_name) return unless (receiver = rhs.receiver) receiver_type = ASSIGNMENT_TYPE_TO_RECEIVER_TYPE[node.type] return unless receiver.type == receiver_type && receiver.children.first == node.lhs = format(MSG, method_name: rhs.method_name) add_offense(node.loc.operator, message: ) do |corrector| corrector.replace(node, rhs.source) end end
#on_send(node)
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 71
def on_send(node) return unless node.assignment_method? return unless redundant_assignment?(node) = format(MSG, method_name: node.first_argument.method_name) add_offense(node.loc.operator, message: ) do |corrector| corrector.remove(correction_range(node)) end end
#redundant_assignment?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 107
def redundant_assignment?(node) receiver_name = node.method_name.to_s[0...-1].to_sym redundant_self_assignment?(node, receiver_name) || redundant_nonself_assignment?(node, node.receiver, receiver_name) end
#redundant_nonself_assignment?(node, receiver, method_name) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 98
def_node_matcher :redundant_nonself_assignment?, <<~PATTERN (send %1 _ (send (send %1 %2) #method_returning_self? ...)) PATTERN
#redundant_self_assignment?(node, method_name) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_self_assignment.rb', line 88
def_node_matcher :redundant_self_assignment?, <<~PATTERN (send (self) _ (send (send {(self) nil?} %1) #method_returning_self? ...)) PATTERN