123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::InternalAffairs::StyleDetectedApiUse

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/style_detected_api_use.rb

Overview

Checks for correct use of the style_detected API provided by ::RuboCop::Cop::ConfigurableEnforcedStyle. If correct_style_detected is used then opposite_style_detected, unexpected_style_detected, ambiguous_style_detected, conflicting_styles_detected, unrecognized_style_detected or no_acceptable_style! should be used too, and vice versa. The xxx_style_detected methods should not be used as predicates either.

Examples:

# bad
def on_send(node)
  return add_offense(node) if opposite_style_detected

  correct_style_detected
end

def on_send(node)
  if offense?
    add_offense(node)
  else
    correct_style_detected
  end
end

def on_send(node)
  return unless offense?

  add_offense(node)
  opposite_style_detected
end

# good
def on_send(node)
  if offense?
    add_offense(node)
    opposite_style_detected
  else
    correct_style_detected
  end
end

def on_send(node)
  add_offense(node) if offense?
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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 #on_new_investigation and #on_investigation_end, the result of processed_source will remain constant.

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

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #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?

Instance Method Summary

::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 add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#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

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Attribute Details

#correct_style_detected_called (readonly, private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 119



attr_reader :correct_style_detected_called,
            :negative_style_detected_methods_called,
            :style_detected_called


  








  

    #negative_style_detected_methods_called   (readonly, private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 119



attr_reader :correct_style_detected_called,
            :negative_style_detected_methods_called,
            :style_detected_called


  








  

    #negative_without_positive?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 127



def negative_without_positive?
  negative_style_detected_methods_called && !correct_style_detected_called
end


  








  

    #positive_without_negative?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 123



def positive_without_negative?
  correct_style_detected_called && !negative_style_detected_methods_called
end


  








  

    #style_detected_called   (readonly, private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 119



attr_reader :correct_style_detected_called,
            :negative_style_detected_methods_called,
            :style_detected_called


  







Instance Method Details



  

    #correct_style_detected_check(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 68



def_node_matcher :correct_style_detected_check, <<~PATTERN
  (send nil? :correct_style_detected)
PATTERN


  








  

    #negative_style_detected_method_check(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 73



def_node_matcher :negative_style_detected_method_check, <<~PATTERN
  (send nil? /(?:opposite|unexpected|ambiguous|unrecognized)_style_detected|conflicting_styles_detected/ ...)
PATTERN


  








  

    #no_acceptable_style_check(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 78



def_node_matcher :no_acceptable_style_check, <<~PATTERN
  (send nil? :no_acceptable_style!)
PATTERN


  








  

    #on_if(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 111



def on_if(node)
  traverse_condition(node.condition) do |cond|
    add_offense(cond, message: MSG_FOR_CONDITIONAL_USE) if style_detected_api_used?(cond)
  end
end


  








  

    #on_investigation_end  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 93



def on_investigation_end
  return if style_detected_called
  return unless correct_style_detected_called ^ negative_style_detected_methods_called

  add_global_offense(MSG_FOR_POSITIVE_WITHOUT_NEGATIVE) if positive_without_negative?
  add_global_offense(MSG_FOR_NEGATIVE_WITHOUT_POSITIVE) if negative_without_positive?
end


  








  

    #on_new_investigation  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 87



def on_new_investigation
  @correct_style_detected_called = false
  @negative_style_detected_methods_called = false
  @style_detected_called = false
end


  








  

    #on_send(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 101



def on_send(node)
  if correct_style_detected_check(node)
    @correct_style_detected_called = true
  elsif negative_style_detected_method_check(node) || no_acceptable_style_check(node)
    @negative_style_detected_methods_called = true
  elsif style_detected_check(node)
    @style_detected_called = true
  end
end


  








  

    #style_detected_api_used?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 131



def style_detected_api_used?(node)
  correct_style_detected_check(node) ||
    negative_style_detected_method_check(node) ||
    no_acceptable_style_check(node) ||
    style_detected_check(node)
end


  








  

    #style_detected_check(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 83



def_node_matcher :style_detected_check, <<~PATTERN
  (send nil? :style_detected ...)
PATTERN


  








  

    #traverse_condition(condition) {|condition| ... }  (private)
  



  

    
  





  
Yields:


    
  
  • 
    (condition)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/style_detected_api_use.rb', line 138



def traverse_condition(condition, &block)
  yield condition if condition.send_type?

  condition.each_child_node { |child| traverse_condition(child, &block) }
end