# typed: true # frozen_string_literal: true require "rubocops/extend/formula" module RuboCop module Cop module FormulaAudit # This cop audits the `homepage` URL in formulae. class Homepage < FormulaCop 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 # 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" 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" # 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 repo 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}" end end 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 end end end end