Class: RuboCop::Cop::Style::ObjectThen
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::TargetRubyVersion ,
::RuboCop::Cop::AutoCorrector ,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
self,
::RuboCop::Cop::ConfigurableEnforcedStyle ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/object_then.rb |
Overview
Enforces the use of consistent method names
Object#yield_self
or Object#then
.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/style/object_then.rb', line 32'Prefer `%<prefer>s` over `%<current>s`.'
-
RESTRICT_ON_SEND =
# File 'lib/rubocop/cop/style/object_then.rb', line 33%i[then yield_self].freeze
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::ConfigurableEnforcedStyle
- 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::TargetRubyVersion
- Extended
maximum_target_ruby_version, minimum_target_ruby_version, required_maximum_ruby_version, required_minimum_ruby_version, support_target_ruby_version? |
::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::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_block(node) (also: #on_numblock)
-
#on_numblock(node)
Alias for #on_block.
- #on_send(node)
- #check_method_node(node) private
- #message(node) private
- #preferred_method?(node) ⇒ Boolean private
::RuboCop::Cop::ConfigurableEnforcedStyle
- 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_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
#check_method_node(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/object_then.rb', line 49
def check_method_node(node) return unless preferred_method?(node) = (node) add_offense(node.loc.selector, message: ) do |corrector| prefer = style == :then && node.receiver.nil? ? 'self.then' : style corrector.replace(node.loc.selector, prefer) end end
#message(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/object_then.rb', line 71
def (node) format(MSG, prefer: style.to_s, current: node.method_name) end
#on_block(node) Also known as: #on_numblock
[ GitHub ]# File 'lib/rubocop/cop/style/object_then.rb', line 35
def on_block(node) check_method_node(node.send_node) end
#on_numblock(node)
Alias for #on_block.
# File 'lib/rubocop/cop/style/object_then.rb', line 39
alias on_numblock on_block
#on_send(node)
[ GitHub ]# File 'lib/rubocop/cop/style/object_then.rb', line 41
def on_send(node) return unless node.arguments.one? && node.first_argument.block_pass_type? check_method_node(node) end
#preferred_method?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/object_then.rb', line 60
def preferred_method?(node) case style when :then node.method?(:yield_self) when :yield_self node.method?(:then) else false end end