sorbet-rails 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2400ac696f93d779e930dac9f4d6e5781f1ce976e1ee98599a222a78c658588
-  data.tar.gz: 25d8ef2f00b2eb87afe05144323927df66f328ffe2bcff00c578396824d5053e
+  metadata.gz: a7e0b556a5c7db33a8fa24c494fa70265802a360eb842545b6124d54ade20e47
+  data.tar.gz: 5f26a6773d2769e1dfc523f4202b179ded8deaebb65e05ade61291f03153f164
 SHA512:
-  metadata.gz: 8bb839d0eb25c882678e7099796b30ad4215d722a809038593b589c3c6b1bb2b37c42813539e0e314977425052f24b11f85f193f03c84aceb0145d32f0e361bb
-  data.tar.gz: ce4d93314cbeb06d881177429ba7df4b02d5c7783e9cae839dbfa46fb746b611d13dcc49fd996baf839319af47d848d44860e4561474db104d79fd8f797220f4
+  metadata.gz: cc61969e6954e727113e9e74ba48925c15ee07b940fbe5d3a711d62270f90ba06ce9c36373420a3cf02c9a52bda3256ef63d9bea6bf2bcd580dfa592faba068c
+  data.tar.gz: 8c0bb6e747de6ac12c77b326b01d941f3f24fdd6444fca05d573ff26c20a2d0d679bbcd713adb37f66919781446137d3f0fdd21bb39b36241c6e1d6a98ac1de6

data/README.md

@@ -34,6 +34,7 @@ Add `sorbet-rails` to the [`:default` group](https://bundler.io/v2.0/guides/grou
 ❯ bundle exec rake rails_rbi:models
 ❯ bundle exec rake rails_rbi:helpers
 ❯ bundle exec rake rails_rbi:mailers
+❯ bundle exec rake rails_rbi:jobs
 ❯ bundle exec rake rails_rbi:custom
 
 # or run them all at once
@@ -163,7 +164,7 @@ Generates only typed enum setter & getter:
 #### `RelationType` alias
 
 There are several kinds of relations of a model: `User::ActiveRecord_Relation`, `User::ActiveRecord_AssociationRelation` and `User::ActiveRecord_Associations_CollectionProxy`. Usually the code may need just any relation type. We add a `Model::RelationType` type alias for every model to use it.
- 
+
 ```ruby
 class User
   RelationType = T.type_alias do
@@ -235,11 +236,21 @@ This Rake task generates RBI files for all mailer classes in the Rails applicati
 ❯ bundle exec rake rails_rbi:mailers
 ```
 
-Since mailing action methods is based on instance methods defined in a mailer class, the signature of a mailing action method will be dependent on the signature the instance method has
+Since mailing action methods are based on instance methods defined in a mailer class, the signature of a mailing action method will be dependent on the signature the instance method has
 - If there is a (sorbet) sig written for the instance method, it generates a matching sig for the mailing action method
 - If not, all the params in the mailing action method will be T.untyped.
 - For return type though, the mailing action method will return `ActionMailer::MessageDelivery` instead of the return type of the instance method.
 
+### Jobs
+
+This Rake task generates RBI files for all jobs classes in the Rails application (all descendants of `ActiveJob::Base`).
+```sh
+❯ bundle exec rake rails_rbi:jobs
+```
+
+It will generate `perform_later` and `perform_now` methods for
+the job classes matching the signature of the `perform` method of the job. If there is a (sorbet) sig written for `perform`, it will use the same sig for `perform_*` methods.
+
 ## Runtime Features
 
 In addition to features provided by the static generator, `sorbet-rails` can
@@ -252,8 +263,8 @@ specific environment group (eg. `development` only).
   - `find_n`, `first_n`, `last_n`
   - `pluck_to_tstruct`
   - `typed_enum`
-  
-- Model Relation: 
+
+- Model Relation:
   - Make relation classes public. By default, relation classes like `User::ActiveRecord_Relation`, `User::ActiveRecord_AssociationRelation` are private
   - Add type alias, eg `Model::RelationType`, to represents any type of relation of a model.
 

data/lib/sorbet-rails/dependent_gem_rbis/README.md

@@ -0,0 +1 @@
+This folder contains RBI files used for type-checking sorbet-rails source code itself.

data/lib/sorbet-rails/dependent_gem_rbis/activejob.rbi

@@ -0,0 +1,3 @@
+# typed: strong
+class ActiveJob::Base
+end

data/lib/sorbet-rails/job_rbi_formatter.rb

@@ -0,0 +1,75 @@
+# typed: strict
+require('parlour')
+require('sorbet-rails/sorbet_utils.rb')
+
+class SorbetRails::JobRbiFormatter
+  extend T::Sig
+
+  Parameter = ::Parlour::RbiGenerator::Parameter
+
+  sig { params(job_class: T.class_of(ActiveJob::Base)).void }
+  def initialize(job_class)
+    @job_class = T.let(job_class, T.class_of(ActiveJob::Base))
+    @parlour = T.let(Parlour::RbiGenerator.new, Parlour::RbiGenerator)
+  end
+
+  sig {returns(String)}
+  def generate_rbi
+    puts "-- Generate sigs for mailer #{@job_class.name} --"
+
+    @parlour.root.add_comments([
+      'This is an autogenerated file for Rails\' jobs.',
+      'Please rerun bundle exec rake rails_rbi:jobs to regenerate.'
+    ])
+
+    @parlour.root.create_class(@job_class.name) do |job_rbi|
+      method_def = @job_class.instance_method(:perform)
+      parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+      job_rbi.create_method(
+        "perform_later",
+        parameters: parameters,
+        class_method: true,
+      )
+      job_rbi.create_method(
+        "perform_now",
+        parameters: parameters,
+        class_method: true,
+      )
+      # Override the signature for "set" so that we can support it
+      # At run-time, this method returns a `ActiveJob::ConfiguredJob` but
+      # we fake the signature to return "T.self_class" so that
+      # sorbet can type-check when `perform_later` is called on it
+      # See: https://guides.rubyonrails.org/active_job_basics.html#enqueue-the-job
+      job_rbi.create_method(
+        "set",
+        # Documentation: https://api.rubyonrails.org/classes/ActiveJob/Core/ClassMethods.html
+        parameters: [
+          Parameter.new(
+            "wait:",
+            type: "T.nilable(ActiveSupport::Duration)",
+            default: "nil",
+          ),
+          Parameter.new(
+            "wait_until:",
+            type: "T.nilable(T.any(ActiveSupport::TimeWithZone, Date, Time))",
+            default: "nil",
+          ),
+          Parameter.new(
+            "queue:",
+            type: "T.nilable(T.any(String, Symbol))",
+            default: "nil",
+          ),
+          Parameter.new(
+            "priority:",
+            type: "T.nilable(Integer)",
+            default: "nil",
+          ),
+        ],
+        return_type: "T.self_type",
+        class_method: true,
+      )
+    end
+
+    @parlour.rbi
+  end
+end

data/lib/sorbet-rails/mailer_rbi_formatter.rb

@@ -16,7 +16,7 @@ class SorbetRails::MailerRbiFormatter
     puts "-- Generate sigs for mailer #{@mailer_class.name} --"
 
     @parlour.root.add_comments([
-      'This is an autogenerated file for Rails helpers.',
+      "This is an autogenerated file for Rails' mailers.",
       'Please rerun bundle exec rake rails_rbi:mailers to regenerate.'
     ])
 

data/lib/sorbet-rails/model_plugins/active_record_finder_methods.rb

@@ -98,7 +98,7 @@ class SorbetRails::ModelPlugins::ActiveRecordFinderMethods < SorbetRails::ModelP
       class_method: class_method,
     )
 
-    ["any?", "many?", "none?", "one?"].each do |method_name|
+    ["any?", "many?", "none?", "one?", "empty?"].each do |method_name|
       class_rbi.create_method(
         method_name,
         parameters: [ Parameter.new("*args", type: "T.untyped") ],

data/lib/sorbet-rails/tasks/rails_rbi.rake

@@ -2,6 +2,7 @@ require("sorbet-rails/model_rbi_formatter")
 require("sorbet-rails/routes_rbi_formatter")
 require("sorbet-rails/helper_rbi_formatter")
 require("sorbet-rails/mailer_rbi_formatter")
+require("sorbet-rails/job_rbi_formatter")
 require("sorbet-rails/utils")
 
 RAILS_RBI_RAKE_DIR  = File.dirname(__FILE__)
@@ -18,6 +19,7 @@ namespace :rails_rbi do
     Rake::Task['rails_rbi:models'].invoke
     Rake::Task['rails_rbi:helpers'].invoke
     Rake::Task['rails_rbi:mailers'].invoke
+    Rake::Task['rails_rbi:jobs'].invoke
     Rake::Task['rails_rbi:custom'].invoke
   end
 
@@ -110,6 +112,24 @@ namespace :rails_rbi do
     end
   end
 
+  desc "Generate rbis for rails mailers"
+  task :jobs, [:root_dir] => :environment do |t, args|
+    SorbetRails::Utils.rails_eager_load_all!
+    all_jobs = ActiveJob::Base.descendants
+
+    all_jobs.each do |job_class|
+      file_path = Rails.root.join(
+        "sorbet",
+        "rails-rbi",
+        "jobs",
+        "#{job_class.name.underscore}.rbi",
+      )
+      formatter = SorbetRails::JobRbiFormatter.new(job_class)
+      FileUtils.mkdir_p(File.dirname(file_path))
+      File.write(file_path, formatter.generate_rbi)
+    end
+  end
+
   def generate_rbis_for_models(model_classes, available_classes)
     available_class_names = Set.new(available_classes.map { |c| c.name })
     formatted = model_classes.map do |model_class|

data/lib/sorbet-rails/type_assert/type_assert.rb

@@ -3,6 +3,11 @@ require 'sorbet-runtime'
 require 'sorbet-rails/type_assert/type_assert_interface'
 require 'sorbet-rails/type_assert/type_assert_impl'
 
+# Make this type visible even when the concrete
+# implementation cannot be loaded.
+module TypeAssertImpl
+end
+
 class TA
   extend T::Sig
   extend T::Generic

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.6.1"
+  s.version       = "0.6.2"
   s.date          = %q{2019-04-18}
   s.summary       = %q{Set of tools to make Sorbet work with Rails seamlessly.}
   s.authors       = ["Chan Zuckerberg Initiative"]

data/spec/generators/rails-template.rb

@@ -374,6 +374,22 @@ def create_mailers
   RUBY
 end
 
+def create_jobs
+  file "app/jobs/award_house_point_hourglasses.rb", <<~RUBY
+    # N.B. You imagine the wizards update the point magically somehow?
+    # Nope, there is a "goblin" that takes their "give points" request and do it
+    # behind the scene.
+    class AwardHousePointHourglasses < ApplicationJob
+      extend T::Sig
+
+      sig { params(student: Wizard, point: Integer).void }
+      def perform(student:, point:)
+        # TODO: award point to student's house
+      end
+    end
+  RUBY
+end
+
 def add_sorbet_test_files
   file "typed-override.yaml", <<~YAML
     true:
@@ -417,6 +433,7 @@ after_bundle do
   create_models
   create_migrations
   create_mailers
+  create_jobs
   add_sorbet_test_files
 
   Bundler.with_clean_env do

data/spec/generators/sorbet_test_cases.rb

@@ -181,8 +181,20 @@ T.assert_type!(Wizard::House::Slytherin, Wizard::House)
 # Mythical plugin
 T.assert_type!(Wand.mythicals, T::Array[Wand])
 
+# Mailers
 T.assert_type!(HogwartsAcceptanceMailer.notify(wizard), ActionMailer::MessageDelivery)
 
+# Jobs
+AwardHousePointHourglasses.perform_later(student: wizard, point: 10)
+AwardHousePointHourglasses.perform_now(student: wizard, point: 10)
+AwardHousePointHourglasses.
+  set(queue: :daily, wait: 5.minutes).
+  perform_later(student: wizard, point: 10)
+AwardHousePointHourglasses.
+  set(priority: 10, wait_until: Time.now.tomorrow).
+  perform_later(student: wizard, point: 10)
+
+
 T.assert_type!(wizard.broom_nimbus?, T::Boolean)
 T.assert_type!(wizard.color_brown_eyes?, T::Boolean)
 T.assert_type!(wizard.quidditch_keeper?, T::Boolean)

data/spec/job_rbi_formatter_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'sorbet-rails/mailer_rbi_formatter'
+
+RSpec.describe SorbetRails::MailerRbiFormatter do
+
+  it 'returns the expected rbi for a given array of helpers' do
+    formatter = SorbetRails::JobRbiFormatter.new(AwardHousePointHourglasses)
+    expect_match_file(
+      formatter.generate_rbi,
+      'expected_award_house_point_hourglasses.rbi'
+    )
+  end
+end

data/spec/rake_rails_rbi_jobs_spec.rb

@@ -0,0 +1,20 @@
+require 'rails_helper'
+
+RSpec.describe 'rake rails_rbi:jobs', type: :task do
+  let!(:generated_dir_path) { Rails.root.join("sorbet", "rails-rbi", "jobs") }
+
+  it "preloads the Rails environment" do
+    expect(task.prerequisites).to include("environment")
+  end
+
+  it "generates jobs rbi correctly" do
+    task.invoke
+    expect_files(
+      base_dir: generated_dir_path,
+      files: [
+        "application_job.rbi",
+        "award_house_point_hourglasses.rbi",
+      ],
+    )
+  end
+end

data/spec/support/v5.0/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.6.1)
+    sorbet-rails (0.6.2)
       method_source (>= 0.9.2)
       parlour (~> 2.0)
       parser (>= 2.7)
@@ -69,19 +69,19 @@ GEM
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    method_source (0.9.2)
+    method_source (1.0.0)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.0)
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    parlour (2.0.0)
+    parlour (2.1.0)
       commander (~> 4.5)
       parser
       rainbow (~> 3.0)
       sorbet-runtime (>= 0.5)
-    parser (2.7.0.4)
+    parser (2.7.0.5)
       ast (~> 2.4.0)
     polyfill (1.8.0)
     puma (3.12.4)
@@ -114,15 +114,15 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     safe_type (1.1.1)
-    sorbet (0.5.5420)
-      sorbet-static (= 0.5.5420)
+    sorbet (0.5.5472)
+      sorbet-static (= 0.5.5472)
     sorbet-coerce (0.2.4)
       polyfill (~> 1.8)
       safe_type (~> 1.1, >= 1.1.1)
       sorbet (>= 0.4.4704)
       sorbet-runtime (>= 0.4.4704)
-    sorbet-runtime (0.5.5420)
-    sorbet-static (0.5.5420-universal-darwin-14)
+    sorbet-runtime (0.5.5472)
+    sorbet-static (0.5.5472-universal-darwin-14)
     sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)

data/spec/support/v5.0/app/jobs/award_house_point_hourglasses.rb

@@ -0,0 +1,12 @@
+# typed: strong
+# N.B. You imagine the wizards update the point magically somehow?
+# Nope, there is a "goblin" that takes their "give points" request and do it
+# behind the scene.
+class AwardHousePointHourglasses < ApplicationJob
+  extend T::Sig
+
+  sig { params(student: Wizard, point: Integer).void }
+  def perform(student:, point:)
+    # TODO: award point to student's house
+  end
+end

data/spec/support/v5.0/sorbet_test_cases.rb

@@ -181,8 +181,20 @@ T.assert_type!(Wizard::House::Slytherin, Wizard::House)
 # Mythical plugin
 T.assert_type!(Wand.mythicals, T::Array[Wand])
 
+# Mailers
 T.assert_type!(HogwartsAcceptanceMailer.notify(wizard), ActionMailer::MessageDelivery)
 
+# Jobs
+AwardHousePointHourglasses.perform_later(student: wizard, point: 10)
+AwardHousePointHourglasses.perform_now(student: wizard, point: 10)
+AwardHousePointHourglasses.
+  set(queue: :daily, wait: 5.minutes).
+  perform_later(student: wizard, point: 10)
+AwardHousePointHourglasses.
+  set(priority: 10, wait_until: Time.now.tomorrow).
+  perform_later(student: wizard, point: 10)
+
+
 T.assert_type!(wizard.broom_nimbus?, T::Boolean)
 T.assert_type!(wizard.color_brown_eyes?, T::Boolean)
 T.assert_type!(wizard.quidditch_keeper?, T::Boolean)

data/spec/support/v5.1/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.6.1)
+    sorbet-rails (0.6.2)
       method_source (>= 0.9.2)
       parlour (~> 2.0)
       parser (>= 2.7)
@@ -70,19 +70,19 @@ GEM
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    method_source (0.9.2)
+    method_source (1.0.0)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.0)
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    parlour (2.0.0)
+    parlour (2.1.0)
       commander (~> 4.5)
       parser
       rainbow (~> 3.0)
       sorbet-runtime (>= 0.5)
-    parser (2.7.0.4)
+    parser (2.7.0.5)
       ast (~> 2.4.0)
     polyfill (1.8.0)
     puma (3.12.4)
@@ -115,15 +115,15 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     safe_type (1.1.1)
-    sorbet (0.5.5420)
-      sorbet-static (= 0.5.5420)
+    sorbet (0.5.5472)
+      sorbet-static (= 0.5.5472)
     sorbet-coerce (0.2.4)
       polyfill (~> 1.8)
       safe_type (~> 1.1, >= 1.1.1)
       sorbet (>= 0.4.4704)
       sorbet-runtime (>= 0.4.4704)
-    sorbet-runtime (0.5.5420)
-    sorbet-static (0.5.5420-universal-darwin-14)
+    sorbet-runtime (0.5.5472)
+    sorbet-static (0.5.5472-universal-darwin-14)
     sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)