Class: RuboCop::Cop::Lint::UselessDefaultValueArgument
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::AllowedReceivers ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/lint/useless_default_value_argument.rb |
Overview
Checks for usage of method fetch
or Array.new
with default value argument
and block. In such cases, block will always be used as default value.
This cop emulates Ruby warning "block supersedes default value argument" which
applies to Array.new
, Array#fetch
, Hash#fetch
, ENV.fetch
and
Thread#fetch
.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/lint/useless_default_value_argument.rb', line 51'Block supersedes default value argument.'
-
RESTRICT_ON_SEND =
# File 'lib/rubocop/cop/lint/useless_default_value_argument.rb', line 53%i[fetch new].freeze
::RuboCop::Cop::Base
- Inherited
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
- #default_value_argument_and_block(node)
-
#on_csend(node)
Alias for #on_send.
- #on_send(node) (also: #on_csend)
- #hash_without_braces?(node) ⇒ Boolean private
::RuboCop::Cop::AllowedReceivers
- Included
::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_gem_version | Returns a gems locked versions (i.e. |
#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
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#default_value_argument_and_block(node)
[ GitHub ]# File 'lib/rubocop/cop/lint/useless_default_value_argument.rb', line 56
def_node_matcher :default_value_argument_and_block, <<~PATTERN (any_block { (call _receiver :fetch $_key $_default_value) (send (const _ :Array) :new $_size $_default_value) } _args _block_body) PATTERN
#hash_without_braces?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/lint/useless_default_value_argument.rb', line 81
def hash_without_braces?(node) node.hash_type? && !node.braces? end
#on_csend(node)
Alias for #on_send.
# File 'lib/rubocop/cop/lint/useless_default_value_argument.rb', line 77
alias on_csend on_send
#on_send(node) Also known as: #on_csend
[ GitHub ]# File 'lib/rubocop/cop/lint/useless_default_value_argument.rb', line 66
def on_send(node) unless (prev_arg_node, default_value_node = default_value_argument_and_block(node.parent)) return end return if allowed_receiver?(node.receiver) return if hash_without_braces?(default_value_node) add_offense(default_value_node) do |corrector| corrector.remove(prev_arg_node.source_range.end.join(default_value_node.source_range)) end end