123456789_123456789_123456789_123456789_123456789_

Module: RuboCop::CLI::Command::CopNames Private

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Explain, ShowCops, ShowDocsUrl
Defined in: lib/rubocop/cli/command/cop_names.rb

Overview

Shared handling for commands that take a list of cop names.

Validation happens here rather than during option parsing because the registry is not complete until the configuration has been loaded, which is also why --only and --except are validated from the runner.

Instance Method Summary

Instance Method Details

#cop_class_for(name) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cli/command/cop_names.rb', line 29



def cop_class_for(name)
  @cop_class_for ||= {}
  unless @cop_class_for.key?(name)
    @cop_class_for[name] = Cop::Registry.global.find_by_cop_name(name)
  end
  @cop_class_for[name]
end


  








  

    #department?(name)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cli/command/cop_names.rb', line 47



def department?(name)
  Cop::Registry.global.departments.any? { |department| department.to_s == name }
end


  








  

    #department_message(name)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cli/command/cop_names.rb', line 51



def department_message(name)
  example = Cop::Registry.global.names.find { |cop| cop.start_with?("#{name}/") }

  "#{name} is a department, not a cop. Name one of its cops, such as #{example}."
end


  








  

    #known_cop_classes(names)   (private)
  



  

    


The cops among names that exist, so a command can report on what it
understood before #validate_cop_names! objects to the rest.



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cli/command/cop_names.rb', line 17



def known_cop_classes(names)
  names.filter_map { |name| cop_class_for(name) }
end


  








  

    #unknown_cop_message(name)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cli/command/cop_names.rb', line 37



def unknown_cop_message(name)
  return department_message(name) if department?(name)

  message = "Unrecognized cop: #{name}."
  similar = NameSimilarity.find_similar_names(name, Cop::Registry.global.names)
  return message if similar.empty?

  "#{message}\nDid you mean? #{similar.join(', ')}"
end


  








  

    #validate_cop_names!(names)   (private)
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/rubocop/cli/command/cop_names.rb', line 22



def validate_cop_names!(names)
  unknown = names.reject { |name| cop_class_for(name) }
  return if unknown.empty?

  raise IncorrectCopNameError, unknown.map { |name| unknown_cop_message(name) }.join("\n")
end