Class: RuboCop::Cop::FormulaAudit::ClassInheritance Private

Inherits:

RuboCop::Cop::FormulaCop

Object
Base
RuboCop::Cop::FormulaCop
RuboCop::Cop::FormulaAudit::ClassInheritance

Defined in:: rubocops/lines.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/class_inheritance.rbi

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

This cop makes sure that a space is used for class inheritance.

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

#audit_formula(formula_nodes) ⇒ void private

Methods inherited from RuboCop::Cop::FormulaCop

#audit_comments, #audit_urls, #caveats_strings, #dependency_name_hash_match?, #dependency_type_hash_match?, #depends_on?, #depends_on_name_type?, #formula_tap, #get_checksum_node, #on_class, #required_dependency?, #required_dependency_name?, #style_exceptions_dir, #tap_style_exception?, #versioned_formula?

Methods included from HelperFunctions

#block_method_called_in_block?, #check_precedence, #class_name, #component_precedes?, #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, #line_number, #line_start_column, #method_called?, #method_called_ever?, #method_name, #node_equals?, #offending_node, #parameters, #parameters_passed?, #problem, #regex_match_group, #source_buffer, #start_column, #string_content

Instance Method Details

#audit_formula(formula_nodes) ⇒ `void`

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

formula_nodes (FormulaNodes)

# File 'rubocops/lines.rb', line 36

def audit_formula(formula_nodes)
  parent_class_node = formula_nodes.parent_class_node
  begin_pos = start_column(parent_class_node)
  end_pos = end_column(formula_nodes.class_node)
  return if begin_pos-end_pos == 3

  raise "unexpected nil value for @formula_name" unless @formula_name

  problem "Use a space in class inheritance: " \
          "class #{@formula_name.capitalize} < #{class_name(parent_class_node)}"
end

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/RuboCop/Cop/FormulaAudit/ClassInheritance.html