Class: RuboCop::Cop::InternalAffairs::RedundantAutocorrectIncompatibleWith
| Relationships & Source Files | |
| Super Chains via Extension / Inclusion / Inheritance | |
|
Class Chain:
self,
::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/internal_affairs/redundant_autocorrect_incompatible_with.rb |
Overview
Checks for cops that are declared as incompatible for autocorrection by both cops of the pair. One declaration is enough: when either cop has been applied, the corrections of the other are held back until the next pass.
The declaration that is reported is the one in the cop whose name comes second in alphabetical order.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/internal_affairs/redundant_autocorrect_incompatible_with.rb', line 39'`%<other>s` already declares that it is incompatible with this cop.'
::RuboCop::Cop::Base - Inherited
Class Attribute Summary
::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 | Reserved for Commissioner. |
::RuboCop::ExcludeLimit - Extended
| exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
| transform | |
Instance Attribute Summary
::RuboCop::Cop::Base - Inherited
| #active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #disabled_autocorrect?, | |
| #preview? | Whether the user opted in to unstable behavior, with |
| #processed_source, #project_index, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements? | |
::RuboCop::Cop::AutocorrectLogic - Included
| #autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?, | |
| #skipped_unsafe_correction_with_disable_uncorrectable? | Whether a correction exists but is skipped because it is unsafe in a safe autocorrect run, while |
| #contextual_autocorrect_held_back? | When LSP is enabled or the |
Instance Method Summary
- #on_defs(node)
- #declaration?(node) ⇒ Boolean private
- #declared_by?(other, cop_name) ⇒ Boolean private
- #defining_cop_name(node) ⇒ String? private
-
#qualified_name(const_name, cop_name)
private
A cop of the same department can be given without the department.
::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 | — grouped under the Commissioner heading above. |
| #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 The source is parsed the way the file under investigation was. |
| #parser_engine, | |
| #ready | Called between investigations. |
| #relevant_file?, | |
| #target_gem_version | Returns the version of a gem in the target, by default its locked version (i.e. from Gemfile.lock or gems.locked). |
| #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, #covering_disabled_range, #current_corrector, | |
| #current_offense_locations | Reserved for Commissioner: |
| #current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, | |
| #enabled_lines? | A multi-line offense is suppressed by a directive on any line of its range, not only its first line, matching the intuition that the directive is attached to the offending code. |
| #file_name_matches_any?, #find_message, #find_severity, #matches_absolute_include_pattern?, #new_offense, #range_for_original, #range_from_node_or_range, | |
| #reset_investigation | Actually private methods. |
| #suppression_reason | The |
| #use_corrector | |
::RuboCop::Cop::AutocorrectLogic - Included
::RuboCop::Cop::IgnoredNode - Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#declaration?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/internal_affairs/redundant_autocorrect_incompatible_with.rb', line 54
def declaration?(node) node.method?(:autocorrect_incompatible_with) && node.receiver.self_type? && node.body&.array_type? end
#declared_by?(other, cop_name) ⇒ Boolean (private)
#defining_cop_name(node) ⇒ String? (private)
# File 'lib/rubocop/cop/internal_affairs/redundant_autocorrect_incompatible_with.rb', line 60
def defining_cop_name(node) department, name = node.parent_module_name&.split('::')&.last(2) "#{department}/#{name}" if name end
#on_defs(node)
[ GitHub ]# File 'lib/rubocop/cop/internal_affairs/redundant_autocorrect_incompatible_with.rb', line 41
def on_defs(node) return unless declaration?(node) && (own = defining_cop_name(node)) node.body.each_child_node(:const) do |const| other = qualified_name(const.const_name, own) next unless own > other && declared_by?(other, own) add_offense(const, message: format(MSG, other: other)) end end
#qualified_name(const_name, cop_name) (private)
A cop of the same department can be given without the department.
# File 'lib/rubocop/cop/internal_affairs/redundant_autocorrect_incompatible_with.rb', line 67
def qualified_name(const_name, cop_name) department, name = const_name.split('::').last(2) return "#{department}/#{name}" if name "#{cop_name.split('/').first}/#{department}" end