Class: RuboCop::Cop::Style::SendWithLiteralMethodName
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::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/send_with_literal_method_name.rb |
Overview
Detects the use of the public_send
method with a literal method name argument.
Since the send
method can be used to call private methods, by default,
only the public_send
method is detected.
Note
|
Writer methods with names ending in = are always permitted because their
behavior differs as follows:
|
def foo=(foo)
@foo = foo
42
end
self.foo = 1 # => 1
send(:foo=, 1) # => 42
Constant Summary
-
METHOD_NAME_PATTERN =
# File 'lib/rubocop/cop/style/send_with_literal_method_name.rb', line 60/\A[a-zA-Z_][a-zA-Z0-9_]*[!?]?\z/.freeze
-
MSG =
# File 'lib/rubocop/cop/style/send_with_literal_method_name.rb', line 57'Use `%<method_name>s` method call directly instead.'
-
RESERVED_WORDS =
# File 'lib/rubocop/cop/style/send_with_literal_method_name.rb', line 61%i[ BEGIN END alias and begin break case class def defined? do else elsif end ensure false for if in module next nil not or redo rescue retry return self super then true undef unless until when while yield ].freeze
-
RESTRICT_ON_SEND =
# File 'lib/rubocop/cop/style/send_with_literal_method_name.rb', line 58%i[public_send send __send__].freeze
-
STATIC_METHOD_NAME_NODE_TYPES =
# File 'lib/rubocop/cop/style/send_with_literal_method_name.rb', line 59%i[sym str].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 an 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
- #allow_send? ⇒ Boolean readonly private
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
-
#on_send(node)
Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity.
- #offense_range(node) private
- #removal_argument_range(first_argument, second_argument) private
::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, #surrounding_heredoc, #surrounding_percent_array |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Attribute Details
#allow_send? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/rubocop/cop/style/send_with_literal_method_name.rb', line 90
def allow_send? !!cop_config['AllowSend'] end
Instance Method Details
#offense_range(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/send_with_literal_method_name.rb', line 94
def offense_range(node) node.loc.selector.join(node.source_range.end) end
#on_send(node)
Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
# File 'lib/rubocop/cop/style/send_with_literal_method_name.rb', line 68
def on_send(node) return if allow_send? && !node.method?(:public_send) return unless (first_argument = node.first_argument) return unless STATIC_METHOD_NAME_NODE_TYPES.include?(first_argument.type) offense_range = offense_range(node) method_name = first_argument.value return if !METHOD_NAME_PATTERN.match?(method_name) || RESERVED_WORDS.include?(method_name) add_offense(offense_range, message: format(MSG, method_name: method_name)) do |corrector| if node.arguments.one? corrector.replace(offense_range, method_name) else corrector.replace(node.loc.selector, method_name) corrector.remove(removal_argument_range(first_argument, node.arguments[1])) end end end
#removal_argument_range(first_argument, second_argument) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/send_with_literal_method_name.rb', line 98
def removal_argument_range(first_argument, second_argument) first_argument.source_range.begin.join(second_argument.source_range.begin) end