sorbet-rails 0.5.3 → 0.5.4

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

@@ -1,6 +1,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/utils")
 
 namespace :rails_rbi do
@@ -9,6 +10,7 @@ namespace :rails_rbi do
     Rake::Task['rails_rbi:routes'].invoke
     Rake::Task['rails_rbi:models'].invoke
     Rake::Task['rails_rbi:helpers'].invoke
+    Rake::Task['rails_rbi:mailers'].invoke
   end
 
   desc "Generate rbis for rails routes"
@@ -64,6 +66,24 @@ namespace :rails_rbi do
     end
   end
 
+  desc "Generate rbis for rails mailers"
+  task :mailers, [:root_dir] => :environment do |t, args|
+    SorbetRails::Utils.rails_eager_load_all!
+    all_mailers = ActionMailer::Base.descendants
+
+    all_mailers.each do |mailer_class|
+      file_path = Rails.root.join(
+        "sorbet",
+        "rails-rbi",
+        "mailers",
+        "#{mailer_class.name.underscore}.rbi",
+      )
+      formatter = SorbetRails::MailerRbiFormatter.new(mailer_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/utils.rb

@@ -12,4 +12,9 @@ module SorbetRails::Utils
     # But this is not applied to Rails.application.eager_load! method
     Zeitwerk::Loader.eager_load_all if defined?(Zeitwerk)
   end
+
+  sig { params(method_name: String).returns(T::Boolean) }
+  def self.valid_method_name?(method_name)
+    !!method_name.match(/^[A-z][A-z0-9_]*[!?=]?$/)
+  end
 end

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.5.3"
+  s.version       = "0.5.4"
   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

@@ -114,23 +114,95 @@ def create_models
     end
   RUBY
 
-  file "app/models/wizard.rb", <<~RUBY
-    class Wizard < ApplicationRecord
-      validates :name, length: { minimum: 5 }, presence: true
-
-      enum house: {
-        Gryffindor: 0,
-        Hufflepuff: 1,
-        Ravenclaw: 2,
-        Slytherin: 3,
-      }
-
-      has_one :wand
-      has_many :spell_books
+  # A nasty hack to add has_one_attached and has_many_attached to the models/wizard.rb file.
+  attachments = nil
+  if ['5.2', '6.0'].include?(ENV["RAILS_VERSION"])
+    attachments = "has_one_attached :school_photo\n  has_many_attached :hats"
+  end
 
-      scope :recent, -> { where('created_at > ?', 1.month.ago) }
-    end
-  RUBY
+  if ENV["RAILS_VERSION"] == "4.2"
+    file "app/models/wizard.rb", <<~RUBY
+      class Wizard < ApplicationRecord
+        validates :name, length: { minimum: 5 }, presence: true
+
+        enum house: {
+          Gryffindor: 0,
+          Hufflepuff: 1,
+          Ravenclaw: 2,
+          Slytherin: 3,
+        }
+
+        enum professor: {
+          "Severus Snape": 0,
+          "Minerva McGonagall": 1,
+          "Pomona Sprout": 2,
+          "Filius Flitwick": 3,
+          "Hagrid": 4,
+        }
+
+        enum broom: {
+          nimbus: 'nimbus',
+          firebolt: 'firebolt',
+        }
+
+        has_one :wand
+        has_many :spell_books
+
+        scope :recent, -> { where('created_at > ?', 1.month.ago) }
+      end
+    RUBY
+  else
+    file "app/models/wizard.rb", <<~RUBY
+      class Wizard < ApplicationRecord
+        validates :name, length: { minimum: 5 }, presence: true
+
+        enum house: {
+          Gryffindor: 0,
+          Hufflepuff: 1,
+          Ravenclaw: 2,
+          Slytherin: 3,
+        }
+
+        enum professor: {
+          "Severus Snape": 0,
+          "Minerva McGonagall": 1,
+          "Pomona Sprout": 2,
+          "Filius Flitwick": 3,
+          "Hagrid": 4,
+        }
+
+        enum broom: {
+          nimbus: 'nimbus',
+          firebolt: 'firebolt',
+        }, _prefix: true
+
+        enum quidditch_position: {
+          keeper: 0,
+          seeker: 1,
+          beater: 2,
+          chaser: 3,
+        }, _prefix: :quidditch
+
+        enum hair_color: {
+          brown: 0,
+          black: 1,
+          blonde: 2,
+        }, _suffix: :hair
+
+        enum eye_color: {
+          brown: 0,
+          green: 1,
+          blue: 2,
+        }, _prefix: :color, _suffix: :eyes
+
+        has_one :wand
+        has_many :spell_books
+
+        scope :recent, -> { where('created_at > ?', 1.month.ago) }
+        #{attachments}
+      end
+    RUBY
+  end
 
   file "app/models/concerns/mythical.rb", <<~RUBY
     require 'active_support/concern'
@@ -211,6 +283,62 @@ def create_migrations
       end
     end
   RUBY
+
+  file "db/migrate/20190620000005_add_broom_to_wizard.rb", <<~RUBY
+    class AddBroomToWizard < #{migration_superclass}
+      def change
+        add_column :wizards, :broom, :string
+      end
+    end
+  RUBY
+
+  if ENV["RAILS_VERSION"] != "4.2"
+    file "db/migrate/20190620000006_add_more_enums_to_wizard.rb", <<~RUBY
+      class AddMoreEnumsToWizard < #{migration_superclass}
+        def change
+          add_column :wizards, :quidditch_position, :integer
+          add_column :wizards, :hair_color, :integer
+          add_column :wizards, :eye_color, :integer
+          add_column :wizards, :hair_length, :integer
+        end
+      end
+    RUBY
+  end
+end
+
+def create_mailers
+  if ENV['RAILS_VERSION'] == '4.2'
+    file "app/mailers/application_mailer.rb", <<~RUBY
+      class ApplicationMailer < ActionMailer::Base
+      end
+    RUBY
+  end
+
+  file "app/mailers/hogwarts_acceptance_mailer.rb", <<~RUBY
+    class HogwartsAcceptanceMailer < ApplicationMailer
+      extend T::Sig
+
+      sig { params(student: Wizard).void }
+      def notify(student)
+        # TODO: mail acceptance letter to student
+      end
+
+      def notify_retry(student)
+        # TODO: send more owls!!
+      end
+    end
+  RUBY
+
+  file "app/mailers/daily_prophet_mailer.rb", <<~RUBY
+    class DailyProphetMailer < ApplicationMailer
+      extend T::Sig
+
+      sig { params(wizards: T::Array[Wizard], hotnews_only: T::Boolean).void }
+      def notify_subscribers(wizards:, hotnews_only:)
+        # TODO: mail the latest news to wizards!
+      end
+    end
+  RUBY
 end
 
 def add_sorbet_test_files
@@ -254,6 +382,7 @@ after_bundle do
   create_helpers
   create_models
   create_migrations
+  create_mailers
   add_sorbet_test_files
 
   bundle_version = ENV["RAILS_VERSION"] == "4.2" ? "_1.17.3_" : ""

data/spec/generators/sorbet_test_cases.rb

@@ -153,9 +153,20 @@ T.assert_type!(wizard.notes, T.nilable(String))
 T.assert_type!(wizard.Gryffindor?, T::Boolean)
 T.assert_type!(wizard.house, T.nilable(String))
 T.assert_type!(Wizard.houses, T::Hash[T.any(String, Symbol), Integer])
+T.assert_type!(Wizard.brooms, T::Hash[T.any(String, Symbol), String])
 T.assert_type!(spell_book.biology?, T::Boolean)
 T.assert_type!(spell_book.book_type, String)
 T.assert_type!(SpellBook.book_types, T::Hash[T.any(String, Symbol), Integer])
 
 # Mythical plugin
 T.assert_type!(Wand.mythicals, T::Array[Wand])
+
+T.assert_type!(HogwartsAcceptanceMailer.notify(wizard), ActionMailer::MessageDelivery)
+
+if ENV["RAILS_VERSION"] != "4.2"
+  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)
+  T.assert_type!(wizard.brown_hair?, T::Boolean)
+end
+

data/spec/helper_rbi_formatter_spec.rb

@@ -2,6 +2,12 @@ require 'rails_helper'
 require 'sorbet-rails/helper_rbi_formatter'
 
 RSpec.describe SorbetRails::HelperRbiFormatter do
+  after(:each) do
+    # reset config after each test
+    SorbetRails.configure do |config|
+      config.extra_helper_includes = []
+    end
+  end
 
   it 'returns the expected rbi for a given array of helpers' do
     formatter = SorbetRails::HelperRbiFormatter.new([ApplicationHelper, BarHelper, BazHelper, FooHelper])
@@ -10,4 +16,17 @@ RSpec.describe SorbetRails::HelperRbiFormatter do
       'expected_helpers.rbi'
     )
   end
+
+  it 'returns the expected rbi for a given array of helpers, with additional includes added where appropriate' do
+    SorbetRails.configure do |config|
+      config.extra_helper_includes = ['ApplicationHelper', 'DeviseHelper']
+    end
+
+    # ApplicationHelper won't get included in itself, but will in others. DeviseHelper will be included in all helpers.
+    formatter = SorbetRails::HelperRbiFormatter.new([ApplicationHelper, BarHelper, BazHelper, FooHelper])
+    expect_match_file(
+      formatter.generate_rbi,
+      'expected_helpers_with_application_and_devise_helpers.rbi'
+    )
+  end
 end

data/spec/mailer_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::MailerRbiFormatter.new(HogwartsAcceptanceMailer)
+    expect_match_file(
+      formatter.generate_rbi,
+      'expected_hogwarts_acceptance_mailer.rbi'
+    )
+  end
+end

data/spec/model_rbi_formatter_spec.rb

@@ -12,7 +12,12 @@ RSpec.describe SorbetRails::ModelRbiFormatter do
   end
 
   it 'generates correct rbi file for Wizard' do
-    formatter = SorbetRails::ModelRbiFormatter.new(Wizard, Set.new(['Wizard', 'Wand', 'SpellBook']))
+    class_set = Set.new(['Wizard', 'Wand', 'SpellBook'])
+    if ['5.2', '6.0'].include?(ENV['RAILS_VERSION'])
+      class_set << 'ActiveStorage::Attachment'
+      class_set << 'ActiveStorage::Blob'
+    end
+    formatter = SorbetRails::ModelRbiFormatter.new(Wizard, class_set)
     expect_match_file(
       formatter.generate_rbi,
       'expected_wizard.rbi',
@@ -29,7 +34,12 @@ RSpec.describe SorbetRails::ModelRbiFormatter do
 
   context 'there is a hidden model' do
     it 'fallbacks to use ActiveRecord::Relation' do
-      formatter = SorbetRails::ModelRbiFormatter.new(Wizard, Set.new(['Wizard', 'Wand']))
+      class_set = Set.new(['Wizard', 'Wand'])
+      if ['5.2', '6.0'].include?(ENV['RAILS_VERSION'])
+        class_set << 'ActiveStorage::Attachment'
+        class_set << 'ActiveStorage::Blob'
+      end
+      formatter = SorbetRails::ModelRbiFormatter.new(Wizard, class_set)
       expect_match_file(
         formatter.generate_rbi,
         'expected_wizard_wo_spellbook.rbi',

data/spec/rails_helper.rb

@@ -68,3 +68,23 @@ def expect_match_file(content, file_path)
   expected_value = File.read(relative_path)
   expect(content).to eql(expected_value)
 end
+
+def expect_files(base_dir:, files:)
+  rbi_files = Dir[File.join(base_dir, "*.rbi")]
+
+  # smoke test
+  expect(rbi_files.size).to eql(files.size)
+
+  # check we generate correct content
+  generated_files = rbi_files.map do |file_path|
+    pathname = Pathname.new(file_path)
+    generated = File.read(file_path)
+    # expect there is the same file in test_data folder
+    path_from_dir = pathname.relative_path_from(base_dir).to_path
+    expect_match_file(generated, "expected_#{path_from_dir}")
+    path_from_dir
+  end
+
+  # double check we generate correct files
+  expect(generated_files.sort).to eql(files)
+end

data/spec/rake_rails_rbi_mailers_spec.rb

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

data/spec/rake_rails_rbi_models_spec.rb

@@ -49,7 +49,7 @@ RSpec.describe 'rake rails_rbi:models', type: :task do
   end
 
   it 'generates more than 1 selected models correctly' do
-    task.invoke("Wizard","SpellBook")
+    task.invoke("Wizard", "SpellBook")
     expect_files(
       base_dir: generated_dir_path,
       files: [
@@ -58,24 +58,4 @@ RSpec.describe 'rake rails_rbi:models', type: :task do
       ]
     )
   end
-
-  def expect_files(base_dir:, files:)
-    rbi_files = Dir[File.join(base_dir, "*.rbi")]
-
-    # smoke test
-    expect(rbi_files.size).to eql(files.size)
-
-    # check we generate correct content
-    generated_files = rbi_files.map do |file_path|
-      pathname = Pathname.new(file_path)
-      generated = File.read(file_path)
-      # expect there is the same file in test_data folder
-      path_from_dir = pathname.relative_path_from(base_dir).to_path
-      expect_match_file(generated, "expected_#{path_from_dir}")
-      path_from_dir
-    end
-
-    # double check we generate correct files
-    expect(generated_files.sort).to eql(files)
-  end
 end

data/spec/sorbet_spec.rb

@@ -30,6 +30,19 @@ RSpec.describe 'sorbet' do
       chdir: Rails.root.to_path,
     )
 
+    stdout, stderr, status = Open3.capture3(
+      'bundle', 'exec', 'srb', 'tc',
+      chdir: Rails.root.to_path,
+    )
+
+    if status != 0
+      puts "================================="
+      puts "stdout #{stdout}"
+      puts "stderr #{stderr}"
+      puts "srb-init doesn't produce clean build: #{status}. This will affect sorbet tests."
+      puts "================================="
+    end
+
     # run sorbet-rails rake tasks
     Rake::Task['rails_rbi:all'].invoke
 

data/spec/sorbet_utils_spec.rb

@@ -0,0 +1,126 @@
+require 'rails_helper'
+require 'sorbet-runtime'
+require 'sorbet-rails/sorbet_utils'
+
+module SorbetUtilsExampleModule
+end
+
+class SorbetUtilsExampleClass
+  extend T::Sig
+
+  sig { void }
+  def no_param_method; end
+
+  sig { params(p1: String, p2: T.class_of(String)).void }
+  def method_req_args(p1, p2); end
+
+  sig { params(p1: T.any(String, Integer), p2: T.nilable(String)).void }
+  def method_req_kwarg(p1:, p2:); end
+
+  sig { params(p1: SorbetUtilsExampleModule, p2: T.nilable(T.any(String, Integer))).void }
+  def method_mixed(p1, p2:); end
+
+  sig { params(p1: T::Hash[String, T.untyped], p2: Integer).void }
+  def method_with_rest(p1, *p2); end
+
+  sig { params(p1: T::Array[String], p2: T::Set[Integer], p3: Integer).void }
+  def method_with_keyrest(p1, p2:, **p3); end
+
+  sig { params(p1: String, p2: T.proc.params(p3: T.class_of(String)).void).void }
+  def method_with_block(*p1, &p2); end
+
+  sig { params(p1: T.proc.params(p3: T.class_of(String)).returns(T.nilable(String))).void }
+  def method_with_block_return(&p1); end
+
+  def method_without_sig(p1, p2, *p3, p4:, **p5, &p6); end
+end
+
+RSpec.describe SorbetRails::SorbetUtils do
+  Parameter = ::Parlour::RbiGenerator::Parameter
+
+  it 'works with no_param_method' do
+    method_def = SorbetUtilsExampleClass.instance_method(:no_param_method)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([])
+  end
+
+  it 'works with method_req_args' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_req_args)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([
+      Parameter.new('p1', type: 'String'),
+      Parameter.new('p2', type: 'T.class_of(String)'),
+    ])
+  end
+
+  it 'works with method_req_kwarg' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_req_kwarg)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([
+      Parameter.new('p1', type: 'T.any(Integer, String)'), # sorbet re-order the types
+      Parameter.new('p2', type: 'T.nilable(String)'),
+    ])
+  end
+
+  it 'works with method_mixed' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_mixed)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([
+      Parameter.new('p1', type: 'SorbetUtilsExampleModule'),
+      Parameter.new('p2', type: 'T.nilable(T.any(Integer, String))'),
+    ])
+  end
+
+  it 'works with method_with_rest' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_with_rest)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([
+      Parameter.new('p1', type: 'T::Hash[String, T.untyped]'),
+      Parameter.new('*p2', type: 'Integer'),
+    ])
+  end
+
+  it 'works with method_with_keyrest' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_with_keyrest)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([
+      Parameter.new('p1', type: 'T::Array[String]'),
+      Parameter.new('p2', type: 'T::Set[Integer]'),
+      Parameter.new('**p3', type: 'Integer'),
+    ])
+  end
+
+  it 'works with method_with_block' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_with_block)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([
+      Parameter.new('*p1', type: 'String'),
+      Parameter.new('&p2', type: 'T.proc.params(p3: T.class_of(String)).void'),
+    ])
+  end
+
+  it 'works with method_with_block_return' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_with_block_return)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    expect(parameters).to match_array([
+      Parameter.new(
+        '&p1',
+        type: 'T.proc.params(p3: T.class_of(String)).returns(T.nilable(String))',
+      ),
+    ])
+  end
+
+  it 'works with method_without_sig' do
+    method_def = SorbetUtilsExampleClass.instance_method(:method_without_sig)
+    parameters = SorbetRails::SorbetUtils.parameters_from_method_def(method_def)
+    # method_without_sig(p1, p2, *p3, p4:, **p5, &p6); end
+    expect(parameters).to match_array([
+      Parameter.new('p1', type: 'T.untyped'),
+      Parameter.new('p2', type: 'T.untyped'),
+      Parameter.new('*p3', type: 'T.untyped'),
+      Parameter.new('p4', type: 'T.untyped'),
+      Parameter.new('**p5', type: 'T.untyped'),
+      Parameter.new('&p6', type: 'T.untyped'),
+    ])
+  end
+end