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

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

Overview

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, #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 


11
12
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
 
# File 'Library/Homebrew/rubocops/homepage.rb', line 11

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  homepage_node = find_node_method_by_name(body_node, :homepage)
  homepage = if homepage_node
    string_content(parameters(homepage_node).first)
  else
    ""
  end

  problem "Formula should have a homepage." if homepage_node.nil? || homepage.empty?

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

  case homepage
  # Check for http:// GitHub homepage URLs, https:// is preferred.
  # Note: only check homepages that are repo pages, not *.github.com hosts
  when %r{^http://github.com/}
    problem "Please use https:// for #{homepage}"

  # Savannah has full SSL/TLS support but no auto-redirect.
  # Doesn't apply to the download URLs, only the homepage.
  when %r{^http://savannah.nongnu.org/}
    problem "Please use https:// for #{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 "#{homepage} should be styled `https://wiki.freedesktop.org/www/Software/project_name`"
    else
      problem "#{homepage} 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 "#{homepage} should end with a slash"

  # 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.

  when %r{^http://[^/]*\.github\.io/},
       %r{^http://[^/]*\.sourceforge\.io/}
    problem "Please use https:// for #{homepage}"

  when %r{^http://([^/]*)\.(sf|sourceforge)\.net(/|$)}
    problem "#{homepage} should be `https://#{Regexp.last_match(1)}.sourceforge.io/`"

  when /readthedocs\.org/
    offending_node(parameters(homepage_node).first)
    problem "#{homepage} should be `#{homepage.sub("readthedocs.org", "readthedocs.io")}`"

  when %r{^https://github.com.*\.git}
    offending_node(parameters(homepage_node).first)
    problem "GitHub homepages (`#{homepage}`) should not end with .git"

  # 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.
  when %r{^http://((?:build|cloud|developer|download|extensions|git|
                      glade|help|library|live|nagios|news|people|
                      projects|rt|static|wiki|www)\.)?gnome\.org}x
    problem "Please use https:// for #{homepage}"

  # Compact the above into this list as we're able to remove detailed notations, etc over time.
  when %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}"
  end
end

#autocorrect(node) ⇒ Object 


93
94
95
96
97
98
99
100
101
102
 
# File 'Library/Homebrew/rubocops/homepage.rb', line 93

def autocorrect(node)
  lambda do |corrector|
    return if node.nil?

    homepage = string_content(node)
    homepage.sub!("readthedocs.org", "readthedocs.io")
    homepage.delete_suffix!(".git") if homepage.start_with?("https://github.com")
    corrector.replace(node.source_range, "\"#{homepage}\"")
  end
end