123456789_123456789_123456789_123456789_123456789_

Module: RuboCop::Cop::AllowedMethods

Overview

This module encapsulates the ability to allow certain methods when parsing. Even if the code is in offense, if it contains methods that are allowed. This module is equivalent to the IgnoredMethods module, which will be deprecated in RuboCop 2.0.

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#ignored_method? ⇒ Boolean (readonly, private)

Deprecated.

Use allowed_method? instead

[ GitHub ] 

  


# File 'lib/rubocop/cop/mixin/allowed_methods.rb', line 18



def ignored_method?
  warn Rainbow(<<~WARNING).yellow, uplevel: 1
    `ignored_method?` is deprecated. Use `allowed_method?` instead.
  WARNING

  allowed_method?
end


  







Instance Method Details



  

    #allowed_method?(name)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/allowed_methods.rb', line 13



def allowed_method?(name)
  allowed_methods.include?(name.to_s)
end


  








  

    #allowed_methods   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/allowed_methods.rb', line 27



def allowed_methods
  if cop_config_deprecated_values.any?(Regexp)
    cop_config_allowed_methods
  else
    cop_config_allowed_methods + cop_config_deprecated_values
  end
end


  








  

    #cop_config_allowed_methods   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/allowed_methods.rb', line 35



def cop_config_allowed_methods
  @cop_config_allowed_methods ||= Array(cop_config.fetch('AllowedMethods', []))
end


  








  

    #cop_config_deprecated_values   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/allowed_methods.rb', line 39



def cop_config_deprecated_values
  @cop_config_deprecated_values ||=
    Array(cop_config.fetch('IgnoredMethods', [])) +
    Array(cop_config.fetch('ExcludedMethods', []))
end