Class: RuboCop::Cop::FormulaAudit::Homepage Private

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
Defined in:
rubocops/homepage.rb

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 audits the homepage URL in formulae.

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

Methods included from Kernel

#disk_usage_readable, #ensure_executable!, #ensure_formula_installed!, #exec_browser, #exec_editor, #ignore_interrupts, #interactive_shell, #number_readable, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #paths, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled, #quiet_system, #redact_secrets, #redirect_stdout, #require?, #safe_system, #tap_and_name_comparison, #truncate_text_to_approximate_size, #which, #which_all, #which_editor, #with_custom_locale, #with_env, #with_homebrew_path

Instance Method Details

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

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. 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'rubocops/homepage.rb', line 13

def audit_formula(_node, class_node, _parent_class_node, body_node)
  homepage_node = find_node_method_by_name(body_node, :homepage)

  if homepage_node.nil?
    offending_node(class_node) if body_node.nil?
    problem "Formula should have a homepage."
    return
  end

  homepage_parameter_node = parameters(homepage_node).first
  offending_node(homepage_parameter_node)
  homepage = string_content(homepage_parameter_node)

  problem "Formula should have a homepage." if homepage.empty?

  problem "The homepage should start with http or https." unless homepage.match?(%r{^https?://})

  case homepage
  # Freedesktop is complicated to handle - It has SSL/TLS, but only on certain subdomains.
  # To enable https Freedesktop change the URL from http://project.freedesktop.org/wiki to
  # https://wiki.freedesktop.org/project_name.
  # "Software" is redirected to https://wiki.freedesktop.org/www/Software/project_name
  when %r{^http://((?:www|nice|libopenraw|liboil|telepathy|xorg)\.)?freedesktop\.org/(?:wiki/)?}
    if homepage.include?("Software")
      problem "Freedesktop homepages should be styled " \
              "`https://wiki.freedesktop.org/www/Software/project_name`"
    else
      problem "Freedesktop homepages should be styled `https://wiki.freedesktop.org/project_name`"
    end

  # Google Code homepages should end in a slash
  when %r{^https?://code\.google\.com/p/[^/]+[^/]$}
    problem "Google Code homepages should end with a slash" do |corrector|
      corrector.replace(homepage_parameter_node.source_range, "\"#{homepage}/\"")
    end

  when %r{^http://([^/]*)\.(sf|sourceforge)\.net(/|$)}
    fixed = "https://#{Regexp.last_match(1)}.sourceforge.io/"
    problem "Sourceforge homepages should be `#{fixed}`" do |corrector|
      corrector.replace(homepage_parameter_node.source_range, "\"#{fixed}\"")
    end

  when /readthedocs\.org/
    fixed = homepage.sub("readthedocs.org", "readthedocs.io")
    problem "Readthedocs homepages should be `#{fixed}`" do |corrector|
      corrector.replace(homepage_parameter_node.source_range, "\"#{fixed}\"")
    end

  when %r{^https://github.com.*\.git$}
    problem "GitHub homepages should not end with .git" do |corrector|
      corrector.replace(homepage_parameter_node.source_range, "\"#{homepage.delete_suffix(".git")}\"")
    end

  # People will run into mixed content sometimes, but we should enforce and then add
  # exemptions as they are discovered. Treat mixed content on homepages as a bug.
  # Justify each exemptions with a code comment so we can keep track here.
  #
  # Compact the above into this list as we're able to remove detailed notations, etc over time.
  when
       # Check for `http://` GitHub homepage URLs, `https://` is preferred.
       # NOTE: Only check homepages that are repository pages, not `*.github.com` hosts.
       %r{^http://github\.com/},
       %r{^http://[^/]*\.github\.io/},

       # Savannah has full SSL/TLS support but no auto-redirect.
       # Doesn't apply to the download URLs, only the homepage.
       %r{^http://savannah\.nongnu\.org/},

       %r{^http://[^/]*\.sourceforge\.io/},
       # There's an auto-redirect here, but this mistake is incredibly common too.
       # Only applies to the homepage and subdomains for now, not the FTP URLs.
       %r{^http://((?:build|cloud|developer|download|extensions|git|
                       glade|help|library|live|nagios|news|people|
                       projects|rt|static|wiki|www)\.)?gnome\.org}x,
       %r{^http://[^/]*\.apache\.org},
       %r{^http://packages\.debian\.org},
       %r{^http://wiki\.freedesktop\.org/},
       %r{^http://((?:www)\.)?gnupg\.org/},
       %r{^http://ietf\.org},
       %r{^http://[^/.]+\.ietf\.org},
       %r{^http://[^/.]+\.tools\.ietf\.org},
       %r{^http://www\.gnu\.org/},
       %r{^http://code\.google\.com/},
       %r{^http://bitbucket\.org/},
       %r{^http://(?:[^/]*\.)?archive\.org}
    problem "Please use https:// for #{homepage}" do |corrector|
      corrector.replace(homepage_parameter_node.source_range, "\"#{homepage.sub("http", "https")}\"")
    end
  end
end