sorbet-rails 0.4.0 → 0.5.0

data/lib/sorbet-rails/model_utils.rb

@@ -0,0 +1,45 @@
+# typed: strict
+module SorbetRails::ModelUtils
+  extend T::Sig
+  extend T::Helpers
+
+  abstract!
+
+  sig { abstract.returns(T.class_of(ActiveRecord::Base)) }
+  def model_class; end
+
+  sig { returns(String) }
+  def model_class_name
+    "#{model_class.name}"
+  end
+
+  sig { returns(String) }
+  def model_relation_class_name
+    "#{model_class.name}::ActiveRecord_Relation"
+  end
+
+  sig { returns(String) }
+  def model_assoc_proxy_class_name
+    "#{model_class.name}::ActiveRecord_Associations_CollectionProxy"
+  end
+
+  sig { returns(String) }
+  def model_relation_shared_module_name
+    "#{model_class.name}::ModelRelationShared"
+  end
+
+  sig { params(module_name: String).returns(String) }
+  def model_module_name(module_name)
+    "#{model_class.name}::#{module_name}"
+  end
+
+  sig { params(method_name: T.any(String, Symbol)).returns(T::Boolean) }
+  def exists_instance_method?(method_name)
+    model_class.method_defined?(method_name)
+  end
+
+  sig { params(method_name: T.any(String, Symbol)).returns(T::Boolean) }
+  def exists_class_method?(method_name)
+    model_class.respond_to?(method_name)
+  end
+end

data/lib/sorbet-rails/railtie.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require "rails"
 require "sorbet-rails/custom_finder_methods"
 

data/lib/sorbet-rails/routes_rbi_formatter.rb

@@ -1,20 +1,27 @@
-# typed: true
-class RoutesRbiFormatter
+# typed: strict
+class SorbetRails::RoutesRbiFormatter
+  extend T::Sig
+
+  sig { void }
   def initialize
-    @buffer = []
+    @buffer = T.let([], T::Array[T.any(String, T::Array[String])])
   end
 
+  sig { params(title: String).void }
   def section_title(title)
     @buffer << "\n# Section #{title}"
   end
 
+  sig { params(routes: T::Array[T::Hash[Symbol, String]]).void }
   def section(routes)
     @buffer << draw_section(routes)
   end
 
+  sig { params(routes: T.untyped).returns(NilClass) }
   def header(routes)
   end
 
+  sig { params(routes: T.untyped, filter: T.untyped).void }
   def no_routes(routes=nil, filter=nil)
     @buffer <<
       <<~MESSAGE
@@ -24,6 +31,7 @@ class RoutesRbiFormatter
       MESSAGE
   end
 
+  sig { returns(String) }
   def result
     <<~MESSAGE
       # This is an autogenerated file for routes helper methods
@@ -38,6 +46,7 @@ class RoutesRbiFormatter
   end
 
   private
+  sig { params(routes: T::Array[T::Hash[Symbol, String]]).returns(T::Array[String]) }
   def draw_section(routes)
     routes.map do |r|
       if r[:name].present?

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

@@ -1,14 +1,17 @@
 require("sorbet-rails/model_rbi_formatter")
 require("sorbet-rails/routes_rbi_formatter")
+require("sorbet-rails/helper_rbi_formatter")
 require("sorbet-rails/utils")
 
-# this is ugly but it's a way to get the current directory of this script
-# maybe someone coming along will know a better way
-@@sorbet_rails_rake_dir = File.dirname(__FILE__)
-
 namespace :rails_rbi do
+  desc "Generate rbis for rails models, routes, and helpers."
+  task :all, :environment do |t, args|
+    Rake::Task['rails_rbi:routes'].invoke
+    Rake::Task['rails_rbi:models'].invoke
+    Rake::Task['rails_rbi:helpers'].invoke
+  end
 
-  desc "Generate rbi for rails routes"
+  desc "Generate rbis for rails routes"
   task :routes, [:root_dir] => :environment do |t, args|
     all_routes = Rails.application.routes.routes
     require "action_dispatch/routing/inspector"
@@ -16,15 +19,13 @@ namespace :rails_rbi do
     root_dir = args[:root_dir] || Rails.root
     file_path = Rails.root.join("sorbet", "rails-rbi", "routes.rbi")
     FileUtils.mkdir_p(File.dirname(file_path))
-    File.write(file_path, inspector.format(RoutesRbiFormatter.new))
+    File.write(file_path, inspector.format(SorbetRails::RoutesRbiFormatter.new))
   end
 
-  desc "Generate rbi for rails models. Pass models name to regenrate rbi for only the given models."
+  desc "Generate rbis for rails models. Pass models name to regenerate rbi for only the given models."
   task models: :environment do |t, args|
     SorbetRails::Utils.rails_eager_load_all!
 
-    copy_bundled_rbi
-
     all_models = Set.new(ActiveRecord::Base.descendants + whitelisted_models - blacklisted_models)
 
     models_to_generate = args.extras.size > 0 ?
@@ -39,18 +40,31 @@ namespace :rails_rbi do
     end
   end
 
-  def copy_bundled_rbi
-    bundled_rbi_path = File.join(@@sorbet_rails_rake_dir, "..", "rbi", ".")
-    copy_to_path = Rails.root.join("sorbet", "rails-rbi")
-    FileUtils.mkdir_p(File.dirname(copy_to_path))
-    FileUtils.cp_r(bundled_rbi_path, copy_to_path)
+  desc "Generate rbis for rails helpers."
+  task helpers: :environment do |t, args|
+    SorbetRails::Utils.rails_eager_load_all!
+
+    if ApplicationController.methods.include?(:modules_for_helpers)
+      helpers = ApplicationController.modules_for_helpers([:all])
+    end
+
+    # If ApplicationController doesn't work or doesn't return any helpers,
+    # use ActionController::Base.
+    if ActionController::Base.methods.include?(:modules_for_helpers) && (helpers.length == 0 || helpers.nil?)
+      helpers = ActionController::Base.modules_for_helpers([:all])
+    end
+
+    formatter = SorbetRails::HelperRbiFormatter.new(helpers)
+    file_path = Rails.root.join("sorbet", "rails-rbi", "helpers.rbi")
+    FileUtils.mkdir_p(File.dirname(file_path))
+    File.write(file_path, formatter.generate_rbi)
   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|
       begin
-        formatter = ModelRbiFormatter.new(model_class, available_class_names)
+        formatter = SorbetRails::ModelRbiFormatter.new(model_class, available_class_names)
         [model_class.name, formatter.generate_rbi]
       rescue StandardError => ex
         puts "---"
@@ -64,6 +78,13 @@ namespace :rails_rbi do
   def blacklisted_models
     blacklisted_models = []
     blacklisted_models << ApplicationRecord if defined?(ApplicationRecord)
+    if Object.const_defined?('ActiveRecord::SchemaMigration')
+      # In Rails 6.0, there are dynamically created SchemaMigration classes like primary::SchemaMigration, etc.
+      # We ignore them because Sorbet cannot typecheck those classes and it's unlikely anyone use
+      # them in code.
+      # https://github.com/rails/rails/blob/7cc27d749c3563e6b278ad01d233cb92ea3b7935/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L170
+      blacklisted_models.concat(ActiveRecord::SchemaMigration.descendants)
+    end
     blacklisted_models
   end
 

data/lib/sorbet-rails/utils.rb

@@ -1,5 +1,9 @@
+# typed: false
 
 module SorbetRails::Utils
+  extend T::Sig
+
+  sig { void }
   def self.rails_eager_load_all!
     # need to eager load to see all models
     Rails.configuration.eager_load_namespaces.each { |ns| ns.try(:eager_load!) }

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.4.0"
+  s.version       = "0.5.0"
   s.date          = %q{2019-04-18}
   s.summary       = %q{Set of tools to make Sorbet work with Rails seamlessly.}
   s.authors       = ["Chan Zuckerberg Initiative"]
@@ -9,12 +9,14 @@ Gem::Specification.new do |s|
   s.license       = 'MIT'
   s.require_paths = ["lib"]
   s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|lib/sorbet)/}) }
   end
   s.test_files    = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
+  s.add_dependency 'parlour', '~> 0.6.0'
+
   # Development
   s.add_development_dependency 'rspec', '~> 3.8', '>= 3.8'
   # Debugging

data/spec/helper_rbi_formatter_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'sorbet-rails/helper_rbi_formatter'
+
+RSpec.describe SorbetRails::HelperRbiFormatter do
+
+  it 'returns the expected rbi for a given array of helpers' do
+    formatter = SorbetRails::HelperRbiFormatter.new([BarHelper, BazHelper, FooHelper])
+    expect_match_file(
+      formatter.generate_rbi,
+      'expected_helpers.rbi'
+    )
+  end
+end

data/spec/model_plugins_spec.rb

@@ -0,0 +1,31 @@
+require 'rails_helper'
+require 'sorbet-rails/model_rbi_formatter'
+
+RSpec.describe SorbetRails::ModelPlugins do
+  it 'can get & set plugins' do
+    current = SorbetRails::ModelRbiFormatter.get_plugins
+    expect(current).to include(
+      SorbetRails::ModelPlugins::ActiveRecordEnum,
+      SorbetRails::ModelPlugins::ActiveRecordNamedScope,
+      SorbetRails::ModelPlugins::ActiveRecordQuerying,
+      SorbetRails::ModelPlugins::ActiveRecordAttribute,
+      SorbetRails::ModelPlugins::ActiveRecordAssoc,
+    )
+    expect(current).to include(MythicalRbiPlugin)
+
+    SorbetRails::ModelRbiFormatter.set_plugins([MythicalRbiPlugin])
+    new_plugins = SorbetRails::ModelRbiFormatter.get_plugins
+    expect(new_plugins).to eql([MythicalRbiPlugin])
+
+    SorbetRails::ModelRbiFormatter.set_plugins(current)
+  end
+
+  it 'does not add 1 plugin twice' do
+    current = SorbetRails::ModelRbiFormatter.get_plugins
+    expect(current).to include(MythicalRbiPlugin)
+
+    SorbetRails::ModelRbiFormatter.register_plugin(MythicalRbiPlugin)
+    new_plugins = SorbetRails::ModelRbiFormatter.get_plugins
+    expect(new_plugins).to eql(current)
+  end
+end

data/spec/model_rbi_formatter_spec.rb

@@ -1,10 +1,10 @@
 require 'rails_helper'
 require 'sorbet-rails/model_rbi_formatter'
 
-RSpec.describe ModelRbiFormatter do
+RSpec.describe SorbetRails::ModelRbiFormatter do
 
   it 'does not throw an error when given an abstract class' do
-    formatter = ModelRbiFormatter.new(Potion, ['Potion'])
+    formatter = SorbetRails::ModelRbiFormatter.new(Potion, Set.new(['Potion']))
     expect_match_file(
       formatter.generate_rbi,
       'expected_potion.rbi',
@@ -12,7 +12,7 @@ RSpec.describe ModelRbiFormatter do
   end
 
   it 'generates correct rbi file for Wizard' do
-    formatter = ModelRbiFormatter.new(Wizard, ['Wizard', 'Wand', 'SpellBook'])
+    formatter = SorbetRails::ModelRbiFormatter.new(Wizard, Set.new(['Wizard', 'Wand', 'SpellBook']))
     expect_match_file(
       formatter.generate_rbi,
       'expected_wizard.rbi',
@@ -20,7 +20,7 @@ RSpec.describe ModelRbiFormatter do
   end
 
   it 'generates strict belongs_to and generate overridden methods' do
-    formatter = ModelRbiFormatter.new(Wand, ['Wizard', 'Wand', 'SpellBook'])
+    formatter = SorbetRails::ModelRbiFormatter.new(Wand, Set.new(['Wizard', 'Wand', 'SpellBook']))
     expect_match_file(
       formatter.generate_rbi,
       'expected_wand.rbi',
@@ -29,7 +29,7 @@ RSpec.describe ModelRbiFormatter do
 
   context 'there is a hidden model' do
     it 'fallbacks to use ActiveRecord::Relation' do
-      formatter = ModelRbiFormatter.new(Wizard, ['Wizard', 'Wand'])
+      formatter = SorbetRails::ModelRbiFormatter.new(Wizard, Set.new(['Wizard', 'Wand']))
       expect_match_file(
         formatter.generate_rbi,
         'expected_wizard_wo_spellbook.rbi',

data/spec/rake_rails_rbi_helpers_spec.rb

@@ -0,0 +1,14 @@
+require 'rails_helper'
+
+RSpec.describe 'rake rails_rbi:helpers', type: :task do
+  it "preloads the Rails environment" do
+    expect(task.prerequisites).to include("environment")
+  end
+
+  it "generates helpers.rbi correctly" do
+    task.invoke
+    expected_path = Rails.root.join("sorbet", "rails-rbi", "helpers.rbi")
+    generated = File.read(expected_path)
+    expect_match_file(generated, 'expected_helpers.rbi')
+  end
+end

data/spec/routes_rbi_formatter_spec.rb

@@ -1,7 +1,7 @@
 require 'rails_helper'
 require 'sorbet-rails/routes_rbi_formatter'
 
-RSpec.describe RoutesRbiFormatter do
+RSpec.describe SorbetRails::RoutesRbiFormatter do
   it 'sets up Rails Application' do
     expect(Rails.application.routes).to_not be_empty
   end
@@ -10,7 +10,7 @@ RSpec.describe RoutesRbiFormatter do
     all_routes = Rails.application.routes.routes
     require "action_dispatch/routing/inspector"
     inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
-    formatted = inspector.format(RoutesRbiFormatter.new)
+    formatted = inspector.format(SorbetRails::RoutesRbiFormatter.new)
     expect_match_file(formatted, 'expected_routes.rbi')
   end
 
@@ -21,7 +21,7 @@ RSpec.describe RoutesRbiFormatter do
     end
     require "action_dispatch/routing/inspector"
     inspector = ActionDispatch::Routing::RoutesInspector.new(empty_set.routes)
-    formatted = inspector.format(RoutesRbiFormatter.new)
+    formatted = inspector.format(SorbetRails::RoutesRbiFormatter.new)
     expect_match_file(formatted, 'expected_no_routes.rbi')
   end
 end

data/spec/sorbet_spec.rb

@@ -29,29 +29,25 @@ RSpec.describe 'sorbet' do
         {'SRB_YES' => '1'}, 'bundle', 'exec', 'srb', 'init',
         chdir: Rails.root.to_path,
       )
-      # copy test case over after initializing otherwise it'll override the `typed:` indicator
-      res = FileUtils.symlink(
-        Rails.root.join('..', 'rails_shared', 'sorbet_test_cases.rb'),
-        Rails.root.to_path,
-        force: true,
-      )
     end
-  end
 
-  after(:all) do
-    if ENV['TEST_SRB_INIT']
-      FileUtils.safe_unlink(Rails.root.join('sorbet_test_cases.rb'))
-    end
-  end
+    # run sorbet-rails rake tasks
+    Rake::Task['rails_rbi:all'].invoke
 
-  before(:each) do
-    Rake::Task['rails_rbi:routes'].invoke
-    Rake::Task['rails_rbi:models'].invoke
+    # Regenerate hidden-definitions because there might be conflicts between signature
+    # generated by sorbet-rails & by hidden-definitions
+    # They should be resolved when re-running this script
+    stdout, stderr, status = Open3.capture3(
+      'bundle', 'exec', 'srb', 'rbi', 'hidden-definitions',
+      chdir: Rails.root.to_path,
+    )
+    # TODO srb rbi hidden-definitions is not working with sorbet & Rails 6.0.0.rc2
+    puts stderr, status
   end
 
   it 'returns expected sorbet tc result' do
     stdout, stderr, status = Open3.capture3(
-      'bundle', 'exec', 'srb', 'tc',
+      'bundle', 'exec', 'srb', 'tc', '--typed-override=typed-override.yaml',
       chdir: Rails.root.to_path,
     )
     expect(stdout).to eql('')

data/spec/support/rails_shared/app/controllers/application_controller.rb

@@ -1,2 +1,2 @@
-class ApplicationController < ActionController::API
+class ApplicationController < ActionController::Base
 end

data/spec/support/rails_shared/app/helpers/bar_helper.rb

@@ -0,0 +1,2 @@
+module BarHelper
+end

data/spec/support/rails_shared/app/helpers/baz_helper.rb

@@ -0,0 +1,2 @@
+module BazHelper
+end

data/spec/support/rails_shared/app/helpers/foo_helper.rb

@@ -0,0 +1,2 @@
+module FooHelper
+end

data/spec/support/rails_shared/app/models/concerns/mythical.rb

@@ -0,0 +1,10 @@
+require 'active_support/concern'
+module Mythical
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def mythicals
+      all.to_a # yeah!
+    end
+  end
+end

data/spec/support/rails_shared/app/models/wand.rb

@@ -1,4 +1,5 @@
 class Wand < ApplicationRecord
+  include Mythical
 
   enum core_type: {
     phoenix_feather: 0,

data/spec/support/rails_shared/config/initializers/sorbet_rails.rb

@@ -0,0 +1,3 @@
+# typed: strict
+require(Rails.root.join('lib/mythical_rbi_plugin'))
+SorbetRails::ModelRbiFormatter.register_plugin(MythicalRbiPlugin)

data/spec/support/rails_shared/lib/mythical_rbi_plugin.rb

@@ -0,0 +1,16 @@
+# typed: true
+class MythicalRbiPlugin < SorbetRails::ModelPlugins::Base
+  def generate(root)
+    return unless @model_class.include?(Mythical)
+
+    model_class_rbi = root.create_class(self.model_class_name)
+
+    # ActiveSupport::Concern class method will be inserted to the class
+    # directly. We need to also put the sig in the model class rbi directly
+    model_class_rbi.create_method(
+      'mythicals',
+      class_method: true,
+      return_type: "T::Array[#{@model_class.name}]",
+    )
+  end
+end