Class: RuboCop::Cop::FormulaAuditStrict::DescLength

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

Overview

This cop audits `desc` in Formulae

  • Checks for existence of `desc`

  • Checks if size of `desc` > 80

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_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, #line_number, #line_start_column, #method_called?, #method_called_ever?, #method_called_in_block?, #method_name, #node_equals?, #offending_node, #on_class, #parameters, #parameters_passed?, #problem, #regex_match_group, #size, #source_buffer, #start_column, #string_content, #versioned_formula?

Instance Method Details

#audit_formula(_node, _class_node, _parent_class_node, body_node) ⇒ Object



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'Library/Homebrew/rubocops/formula_desc_cop.rb', line 12

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  desc_call = find_node_method_by_name(body_node, :desc)

  # Check if a formula's desc is present
  if desc_call.nil?
    problem "Formula should have a desc (Description)."
    return
  end

  # Check the formula's desc length. Should be >0 and <80 characters.
  desc = parameters(desc_call).first
  pure_desc_length = string_content(desc).length
  if pure_desc_length.zero?
    problem "The desc (description) should not be an empty string."
    return
  end

  desc_length = "#{@formula_name}: #{string_content(desc)}".length
  max_desc_length = 80
  return if desc_length <= max_desc_length
  problem "Description is too long. \"name: desc\" should be less than #{max_desc_length} characters. " \
          "Length is calculated as #{@formula_name} + desc. (currently #{desc_length})"
end