dev-cmd: add brew-sponsors.rb

Library/Homebrew/dev-cmd/sponsors.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "cli/parser"
+require "utils/github"
+
+module Homebrew
+  module_function
+
+  def sponsors_args
+    Homebrew::CLI::Parser.new do
+      usage_banner <<~EOS
+        `sponsors`
+
+        Print a Markdown summary of Homebrew's GitHub Sponsors, suitable for pasting into a README.
+      EOS
+    end
+  end
+
+  def sponsors
+    sponsors_args.parse
+
+    sponsors = {
+      "named" => [],
+      "users" => 0,
+      "orgs"  => 0,
+    }
+
+    GitHub.sponsors_by_tier("Homebrew").each do |tier|
+      sponsors["named"] += tier["sponsors"] if tier["tier"] >= 100
+      sponsors["users"] += tier["count"]
+      sponsors["orgs"] += tier["sponsors"].count { |s| s["type"] == "organization" }
+    end
+
+    items = []
+    items += sponsors["named"].map { |s| "[#{s["name"]}](https://github.com/#{s["login"]})" }
+
+    anon_users = sponsors["users"] - sponsors["named"].length - sponsors["orgs"]
+
+    items << if items.length > 1
+      "#{anon_users} other users"
+    else
+      "#{anon_users} users"
+    end
+
+    if sponsors["orgs"] == 1
+      items << "#{sponsors["orgs"]} organization"
+    elsif sponsors["orgs"] > 1
+      items << "#{sponsors["orgs"]} organizations"
+    end
+
+    sponsor_text = if items.length > 2
+      items[0..-2].join(", ") + " and #{items.last}"
+    else
+      items.join(" and ")
+    end
+
+    puts "Homebrew is generously supported by #{sponsor_text} via [GitHub Sponsors](https://github.com/sponsors/Homebrew)."
+  end
+end

Library/Homebrew/test/dev-cmd/sponsors_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "cmd/shared_examples/args_parse"
+
+describe "Homebrew.sponsors_args" do
+  it_behaves_like "parseable arguments"
+end

Library/Homebrew/test/utils/github_spec.rb

@@ -49,6 +49,14 @@ describe GitHub do
     end
   end
 
+  describe "::sponsors_by_tier", :needs_network do
+    it "errors on an unauthenticated token" do
+      expect {
+        subject.sponsors_by_tier("Homebrew")
+      }.to raise_error(/INSUFFICIENT_SCOPES|FORBIDDEN/)
+    end
+  end
+
   describe "::get_artifact_url", :needs_network do
     it "fails to find a nonexistant workflow" do
       expect {

completions/internal_commands_list.txt

@@ -71,6 +71,7 @@ ruby
 search
 sh
 shellenv
+sponsors
 style
 switch
 tap

docs/Manpage.md

@@ -967,6 +967,11 @@ build systems would not find otherwise.
 * `--env`:
   Use the standard `PATH` instead of superenv's when `std` is passed.
 
+### `sponsors`
+
+Print a Markdown summary of Homebrew's GitHub Sponsors, suitable for pasting
+into a README.
+
 ### `style` [*`options`*] [*`file`*|*`tap`*|*`formula`*]
 
 Check formulae or files for conformance to Homebrew style guidelines.

manpages/brew.1

@@ -1254,6 +1254,9 @@ Start a Homebrew build environment shell\. Uses our years\-battle\-hardened Home
 \fB\-\-env\fR
 Use the standard \fBPATH\fR instead of superenv\'s when \fBstd\fR is passed\.
 .
+.SS "\fBsponsors\fR"
+Print a Markdown summary of Homebrew\'s GitHub Sponsors, suitable for pasting into a README\.
+.
 .SS "\fBstyle\fR [\fIoptions\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR]"
 Check formulae or files for conformance to Homebrew style guidelines\.
 .