Add Sorbet to linter (#760)

* initial sorbet testing Signed-off-by: Jeff Brimager <[email protected]> * Update definitions * Update tapioca * Fix up with tapioca * tapioca todo --------- Signed-off-by: Jeff Brimager <[email protected]> Co-authored-by: Ben Sheldon [he/him] <[email protected]>
bensheldon · Jul 9, 2023 · 06150f9 · 06150f9
1 parent 9cea412
commit 06150f9
Show file tree

Hide file tree

Showing 244 changed files with 458,242 additions and 7 deletions.
diff --git a/Gemfile b/Gemfile
@@ -2,9 +2,6 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby_version = ENV.fetch('GEMFILE_RUBY_VERSION', nil)
-ruby ruby_version if ruby_version
-
 # Declare your gem's dependencies in good_job.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.
@@ -22,6 +19,10 @@ gem 'nokogiri'
 gem 'pg', platforms: [:mri, :mingw, :x64_mingw]
 gem 'rack', '~> 2.0'
 gem 'rails'
+gem "sorbet", group: :development
+gem "sorbet-runtime"
+gem "spoom", require: false, group: :development
+gem "tapioca", require: false, group: :development
 
 platforms :ruby do
   gem "activerecord-explain-analyze", require: false

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -249,6 +249,7 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
+    netrc (0.11.0)
     nio4r (2.5.9)
     nio4r (2.5.9-java)
     nokogiri (1.15.2)
@@ -271,6 +272,7 @@ GEM
       ast (~> 2.4.1)
       racc
     pg (1.5.3)
+    prettier_print (1.2.1)
     protocol-hpack (1.4.2)
     protocol-http (0.24.3)
     protocol-http1 (0.15.0)
@@ -336,6 +338,11 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
+    rbi (0.0.16)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
     rbtrace (0.4.14)
       ffi (>= 1.0.6)
       msgpack (>= 0.4.3)
@@ -398,9 +405,43 @@ GEM
       rubyzip (>= 1.2.2, < 3.0)
       websocket (~> 1.0)
     smart_properties (1.17.0)
+    sorbet (0.5.10908)
+      sorbet-static (= 0.5.10908)
+    sorbet-runtime (0.5.10908)
+    sorbet-static (0.5.10908-java)
+    sorbet-static (0.5.10908-universal-darwin-14)
+    sorbet-static (0.5.10908-universal-darwin-15)
+    sorbet-static (0.5.10908-universal-darwin-16)
+    sorbet-static (0.5.10908-universal-darwin-17)
+    sorbet-static (0.5.10908-universal-darwin-18)
+    sorbet-static (0.5.10908-universal-darwin-19)
+    sorbet-static (0.5.10908-universal-darwin-20)
+    sorbet-static (0.5.10908-universal-darwin-21)
+    sorbet-static (0.5.10908-universal-darwin-22)
+    sorbet-static (0.5.10908-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10908)
+      sorbet (= 0.5.10908)
+      sorbet-runtime (= 0.5.10908)
+    spoom (1.2.2)
+      erubi (>= 1.10.0)
+      sorbet (>= 0.5.10187)
+      sorbet-runtime (>= 0.5.9204)
+      syntax_tree (>= 6.1.1)
+      thor (>= 0.19.2)
     spoon (0.0.6)
       ffi
     stackprof (0.2.25)
+    syntax_tree (6.1.1)
+      prettier_print (>= 1.2.0)
+    tapioca (0.11.7)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.0.0, >= 0.0.16)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      spoom (~> 1.2.0, >= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.2)
@@ -414,6 +455,9 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    unparser (0.6.8)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
     webrick (1.8.1)
     websocket (1.2.9)
     websocket-driver (0.7.5)
@@ -426,6 +470,9 @@ GEM
     yard (0.9.34)
     yard-activesupport-concern (0.0.1)
       yard (>= 0.8)
+    yard-sorbet (0.8.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
     zeitwerk (2.6.8)
 
 PLATFORMS
@@ -473,7 +520,11 @@ DEPENDENCIES
   rubocop-rails
   rubocop-rspec
   selenium-webdriver
+  sorbet
+  sorbet-runtime
+  spoom
   stackprof
+  tapioca
   yard
   yard-activesupport-concern
 

diff --git a/app/models/good_job/base_record.rb b/app/models/good_job/base_record.rb
@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 module GoodJob
+  ACTIVE_RECORD_PARENT_CLASS = Object.const_get(GoodJob.active_record_parent_class)
+
   # Base ActiveRecord class that all GoodJob models inherit from.
   # Parent class can be configured with +GoodJob.active_record_parent_class+.
   # @!parse
   #   class BaseRecord < ActiveRecord::Base; end
-  class BaseRecord < Object.const_get(GoodJob.active_record_parent_class)
+  class BaseRecord < ACTIVE_RECORD_PARENT_CLASS
     self.abstract_class = true
 
     def self.migration_pending_warning!

diff --git a/bin/lint b/bin/lint
@@ -16,6 +16,10 @@ def system!(*args)
 end
 
 FileUtils.chdir GEM_ROOT do
+  puts "\n== Sorbet =="
+
+  system! "bundle exec srb tc"
+
   puts "\n== Rubocop =="
 
   flags = []

diff --git a/bin/tapioca b/bin/tapioca
@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")
diff --git a/lib/good_job/scheduler.rb b/lib/good_job/scheduler.rb
@@ -334,7 +334,7 @@ def remaining_cache_count
 
     # Custom sub-class of +Concurrent::ThreadPoolExecutor+ to add additional worker status.
     # @private
-    class ThreadPoolExecutor < Concurrent::ThreadPoolExecutor
+    class ThreadPoolExecutor < ::Concurrent::ThreadPoolExecutor
       # Number of inactive threads available to execute tasks.
       # https://github.com/ruby-concurrency/concurrent-ruby/issues/684#issuecomment-427594437
       # @return [Integer]
@@ -353,7 +353,7 @@ def ready_worker_count
 
     # Custom sub-class of +Concurrent::TimerSet+ for additional behavior.
     # @private
-    class TimerSet < Concurrent::TimerSet
+    class TimerSet < ::Concurrent::TimerSet
       # Number of scheduled jobs in the queue
       # @return [Integer]
       def length

diff --git a/sorbet/config b/sorbet/config
@@ -0,0 +1,3 @@
+--dir
+.
+--ignore=vendor/
diff --git a/sorbet/rbi/annotations/actionmailer.rbi b/sorbet/rbi/annotations/actionmailer.rbi