Class: RuboCop::Cop::FormulaAudit::PyPiUrls Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
rubocops/urls.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/py_pi_urls.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 the correct format for PyPI URLs is used.

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, #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?, #block_size, #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, #size, #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:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'rubocops/urls.rb', line 47

def audit_formula(formula_nodes)
  return if (body_node = formula_nodes.body_node).nil?

  urls = find_every_func_call_by_name(body_node, :url)
  mirrors = find_every_func_call_by_name(body_node, :mirror)
  urls += mirrors

  # Check pypi URLs
  pypi_pattern = %r{^https?://pypi\.python\.org/}
  audit_urls(urls, pypi_pattern) do |_, url|
    problem "use the `Source` url found on PyPI downloads page (`#{get_pypi_url(url)}`)"
  end

  # Require long files.pythonhosted.org URLs
  pythonhosted_pattern = %r{^https?://files\.pythonhosted\.org/packages/source/}
  audit_urls(urls, pythonhosted_pattern) do |_, url|
    problem "use the `Source` url found on PyPI downloads page (`#{get_pypi_url(url)}`)"
  end
end

#get_pypi_url(url) ⇒ String

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.

Parameters:

Returns:



68
69
70
71
72
 
# File 'rubocops/urls.rb', line 68

def get_pypi_url(url)
  package_file = File.basename(url)
  package_name = T.must(package_file.match(/^(.+)-[a-z0-9.]+$/))[1]
  "https://pypi.org/project/#{package_name}/#files"
end