Class: RuboCop::Cop::FormulaAudit::ClassName Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
Library/Homebrew/rubocops/class.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

This cop makes sure that Formula is used as superclass.

Constant Summary collapse

DEPRECATED_CLASSES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

%w[
  GithubGistFormula
  ScriptFileFormula
  AmazonWebServicesFormula
].freeze

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

Methods inherited from RuboCop::Cop::FormulaCop

#audit_comments, #audit_urls, #block_size, #caveats_strings, #check_precedence, #class_name, #component_precedes?, #depends_on?, #depends_on_name_type?, #end_column, #expression_negated?, #find_all_blocks, #find_block, #find_blocks, #find_const, #find_every_func_call_by_name, #find_every_method_call_by_name, #find_instance_call, #find_instance_method_call, #find_method_calls_by_name, #find_method_def, #find_method_with_args, #find_node_method_by_name, #find_strings, #format_component, #formula_tap, #get_checksum_node, #method_called?, #method_called_ever?, #method_called_in_block?, #method_name, #node_equals?, #offending_node, #on_class, #parameters, #parameters_passed?, #size, #versioned_formula?

Methods included from HelperFunctions

#line_number, #line_start_column, #problem, #regex_match_group, #source_buffer, #start_column, #string_content

Instance Method Details

#audit_formula(_node, _class_node, parent_class_node, _body_node) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


19
20
21
22
23
24
# File 'Library/Homebrew/rubocops/class.rb', line 19

def audit_formula(_node, _class_node, parent_class_node, _body_node)
  parent_class = class_name(parent_class_node)
  return unless DEPRECATED_CLASSES.include?(parent_class)

  problem "#{parent_class} is deprecated, use Formula instead"
end

#autocorrect(node) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


26
27
28
29
30
# File 'Library/Homebrew/rubocops/class.rb', line 26

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(node.source_range, "Formula")
  end
end