Merge pull request #711 from Homebrew/wip-srb

Basic Sorbet `typed: true`

.github/workflows/tests.yml

@@ -107,3 +107,15 @@ jobs:
       run: |
         rm -rf "$(brew --repo homebrew/services)"
         ln -s "$PWD" "$(brew --repo homebrew/services)"
+
+  sorbet:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Set up Homebrew
+      id: set-up-homebrew
+      uses: Homebrew/actions/setup-homebrew@master
+
+    - run: brew typecheck homebrew/services

Gemfile

@@ -8,4 +8,5 @@ group :test do
   gem "activesupport"
   gem "rspec"
   gem "simplecov"
+  gem "sorbet-runtime"
 end

Gemfile.lock

@@ -32,6 +32,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    sorbet-runtime (0.5.11528)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     zeitwerk (2.6.17)
@@ -43,6 +44,7 @@ DEPENDENCIES
   activesupport
   rspec
   simplecov
+  sorbet-runtime
 
 RUBY VERSION
    ruby 3.3.4p94

cmd/services.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 homebrew_version = if HOMEBREW_VERSION.present?

cmd/services.rbi

@@ -0,0 +1,26 @@
+# typed: strict
+
+class Homebrew::Cmd::Services
+  sig { returns(Homebrew::Cmd::Services::Args) }
+  def args; end
+end
+
+class Homebrew::Cmd::Services::Args < Homebrew::CLI::Args
+  sig { returns(T::Boolean) }
+  def all?; end
+
+  sig { returns(T.nilable(String)) }
+  def file; end
+
+  sig { returns(T::Boolean) }
+  def json?; end
+
+  sig { returns(T::Boolean) }
+  def non_bundler_gems?; end
+
+  sig { returns(T::Boolean) }
+  def no_wait?; end
+
+  sig { returns(T.nilable(String)) }
+  def sudo_service_user; end
+end

lib/service.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))

lib/service.rbi

@@ -0,0 +1,6 @@
+# typed: strict
+
+module Service
+  include Kernel
+  include FileUtils
+end

lib/service/commands/cleanup.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service

lib/service/commands/info.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service

lib/service/commands/kill.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service

lib/service/commands/list.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require "service/formulae"

lib/service/commands/restart.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service

lib/service/commands/run.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service

lib/service/commands/start.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service

lib/service/commands/stop.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service

lib/service/formula_wrapper.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 # Wrapper for a formula to handle service-related stuff like parsing and
@@ -12,7 +13,7 @@ def self.from(path_or_label)
       return unless path_or_label =~ path_or_label_regex
 
       begin
-        new(Formulary.factory(Regexp.last_match(1)))
+        new(Formulary.factory(T.must(Regexp.last_match(1))))
       rescue
         nil
       end

lib/service/formulae.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service

lib/service/services_cli.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service
@@ -87,6 +88,8 @@ def self.run(targets, verbose: false)
 
     # Start a service.
     def self.start(targets, service_file = nil, verbose: false)
+      file = T.let(nil, T.nilable(Pathname))
+
       if service_file.present?
         file = Pathname.new service_file
         raise UsageError, "Provided service file does not exist" unless file.exist?
@@ -202,7 +205,7 @@ def self.take_root_ownership(service)
       return unless System.root?
       return if sudo_service_user
 
-      root_paths = []
+      root_paths = T.let([], T::Array[Pathname])
 
       if System.systemctl?
         group = "root"
@@ -320,7 +323,7 @@ def self.install_service_file(service, file)
 
       rm service.dest if service.dest.exist?
       service.dest_dir.mkpath unless service.dest_dir.directory?
-      cp temp.path, service.dest
+      cp T.must(temp.path), service.dest
 
       # Clear tempfile.
       temp.close

lib/service/system.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Service

spec/spec_helper.rb

@@ -16,6 +16,8 @@
 
 SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter]
 
+require "sorbet-runtime"
+
 require "bundler"
 require "rspec/support/object_formatter"
 require "stub/exceptions"
@@ -35,11 +37,11 @@
 end
 
 module Formatter
-  def self.success(string)
+  def self.success(string, label: nil)
     string
   end
 
-  def self.error(string)
+  def self.error(string, label: nil)
     string
   end
 end