Merge pull request #17758 from Homebrew/shell-command-stubs

Add `ShellCommand` module for shell command stubs

Library/Homebrew/abstract_command.rb

@@ -61,12 +61,5 @@ module Homebrew
 
     sig { abstract.void }
     def run; end
-
-    sig { void }
-    def raise_sh_command_error!
-      raise StandardError,
-            "This command is just here for completions generation. " \
-            "It's actually defined in `cmd/#{self.class.command_name}.sh` instead."
-    end
   end
 end

Library/Homebrew/cmd/--repository.rb

@@ -2,10 +2,13 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 module Homebrew
   module Cmd
     class Repository < AbstractCommand
+      include ShellCommand
+
       sig { override.returns(String) }
       def self.command_name = "--repository"
 
@@ -18,9 +21,6 @@ module Homebrew
 
         named_args :tap
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/cmd/--version.rb

@@ -2,10 +2,13 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 module Homebrew
   module Cmd
     class Version < AbstractCommand
+      include ShellCommand
+
       sig { override.returns(String) }
       def self.command_name = "--version"
 
@@ -15,9 +18,6 @@ module Homebrew
           Homebrew/homebrew-cask (if tapped) to standard output.
         EOS
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/cmd/casks.rb

@@ -2,18 +2,18 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 # This Ruby command exists to allow generation of completions for the Bash
 # version. It is not meant to be run.
 module Homebrew
   module Cmd
     class Casks < AbstractCommand
+      include ShellCommand
+
       cmd_args do
         description "List all locally installable casks including short names."
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/cmd/formulae.rb

@@ -2,16 +2,16 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 module Homebrew
   module Cmd
     class Formulae < AbstractCommand
+      include ShellCommand
+
       cmd_args do
         description "List all locally installable formulae including short names."
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/cmd/setup-ruby.rb

@@ -2,10 +2,13 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 module Homebrew
   module Cmd
     class SetupRuby < AbstractCommand
+      include ShellCommand
+
       cmd_args do
         description <<~EOS
           Installs and configures Homebrew's Ruby. If `command` is passed, it will only run Bundler if necessary for that command.
@@ -13,9 +16,6 @@ module Homebrew
 
         named_args :command
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/cmd/shellenv.rb

@@ -2,10 +2,13 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 module Homebrew
   module Cmd
     class Shellenv < AbstractCommand
+      include ShellCommand
+
       cmd_args do
         description <<~EOS
           Valid shells: bash|csh|fish|pwsh|sh|tcsh|zsh
@@ -21,9 +24,6 @@ module Homebrew
         EOS
         named_args :shell
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/cmd/update-reset.rb

@@ -2,10 +2,13 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 module Homebrew
   module Cmd
     class UpdateReset < AbstractCommand
+      include ShellCommand
+
       cmd_args do
         description <<~EOS
           Fetch and reset Homebrew and all tap repositories (or any specified <repository>) using `git`(1) to their latest `origin/HEAD`.
@@ -15,9 +18,6 @@ module Homebrew
 
         named_args :repository
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/cmd/update.rb

@@ -2,10 +2,13 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 module Homebrew
   module Cmd
     class Update < AbstractCommand
+      include ShellCommand
+
       cmd_args do
         description <<~EOS
           Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1) and perform any necessary migrations.
@@ -23,9 +26,6 @@ module Homebrew
         switch "-d", "--debug",
                description: "Display a trace of all shell commands as they are executed."
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/cmd/vendor-install.rb

@@ -2,10 +2,13 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 module Homebrew
   module Cmd
     class VendorInstall < AbstractCommand
+      include ShellCommand
+
       cmd_args do
         description <<~EOS
           Install Homebrew's portable Ruby.
@@ -15,9 +18,6 @@ module Homebrew
 
         hide_from_man_page!
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/dev-cmd/rubocop.rb

@@ -2,18 +2,18 @@
 # frozen_string_literal: true
 
 require "abstract_command"
+require "shell_command"
 
 module Homebrew
-  module Cmd
+  module DevCmd
     class Rubocop < AbstractCommand
+      include ShellCommand
+
       cmd_args do
         description <<~EOS
           Installs, configures and runs Homebrew's `rubocop`.
         EOS
       end
-
-      sig { override.void }
-      def run = raise_sh_command_error!
     end
   end
 end

Library/Homebrew/rubocops/all.rb

@@ -11,6 +11,7 @@ require_relative "negate_include"
 require_relative "presence"
 require_relative "present"
 require_relative "safe_navigation_with_blank"
+require_relative "shell_command_stub"
 require_relative "shell_commands"
 require_relative "install_bundler_gems"
 

Library/Homebrew/rubocops/shell_command_stub.rb

@@ -0,0 +1,24 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Homebrew
+      class ShellCommandStub < Base
+        MSG = "Shell command stubs must have a `.sh` counterpart."
+        RESTRICT_ON_SEND = [:include].freeze
+
+        sig { params(node: AST::SendNode).void }
+        def on_send(node)
+          return if node.first_argument&.const_name != "ShellCommand"
+
+          stub_path = Pathname.new(processed_source.file_path)
+          sh_cmd_path = Pathname.new("#{stub_path.dirname}/#{stub_path.basename(".rb")}.sh")
+          return if sh_cmd_path.exist?
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

Library/Homebrew/shell_command.rb

@@ -0,0 +1,20 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Homebrew
+  module ShellCommand
+    extend T::Helpers
+
+    requires_ancestor { AbstractCommand }
+
+    sig { void }
+    def run
+      T.bind(self, AbstractCommand)
+
+      sh_cmd_path = "#{self.class.dev_cmd? ? "dev-cmd" : "cmd"}/#{self.class.command_name}.sh"
+      raise StandardError,
+            "This command is just here for completions generation. " \
+            "It's actually defined in `#{sh_cmd_path}` instead."
+    end
+  end
+end