sorbet-rails 0.3.0 → 0.4.0

data/spec/sorbet_spec.rb

@@ -0,0 +1,80 @@
+require 'rails_helper'
+require 'open3'
+
+RSpec.describe 'sorbet' do
+  let!(:harry) do
+    Wizard.create!(
+      name: 'Harry Potter',
+      house: :Gryffindor,
+    )
+  end
+  let!(:book) do
+    SpellBook.create!(
+      name: 'Fantastic Beasts',
+      wizard: harry,
+    )
+  end
+  let!(:wand) do
+    Wand.create!(
+      wizard: harry,
+      core_type: :phoenix_feather,
+      wood_type: "holly",
+    )
+  end
+
+  before(:all) do
+    if ENV['TEST_SRB_INIT']
+      # only initialize sorbet once for all tests because it is slow
+      stdout, stderr, status = Open3.capture3(
+        {'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
+
+  before(:each) do
+    Rake::Task['rails_rbi:routes'].invoke
+    Rake::Task['rails_rbi:models'].invoke
+  end
+
+  it 'returns expected sorbet tc result' do
+    stdout, stderr, status = Open3.capture3(
+      'bundle', 'exec', 'srb', 'tc',
+      chdir: Rails.root.to_path,
+    )
+    expect(stdout).to eql('')
+    expect(status.exitstatus).to eql(1) # T.reveal_type is considered an error
+    expected_file_path = 'expected_srb_tc_output.txt'
+    # if ENV['SORBET_VERSION']
+    #   expected_file_path = File.join(ENV['SORBET_VERSION'], expected_file_path)
+    # end
+    expect_match_file(stderr, expected_file_path)
+  end
+
+  it 'passes sorbet dynamic checks' do
+    file_path = Rails.root.join('sorbet_test_cases.rb')
+    expect {
+      load(file_path)
+    }.to_not raise_error
+  end
+
+  it 'runs with srb tc --lsp' do
+    stdout, stderr, status = Open3.capture3(
+      'bundle', 'exec', 'srb', 'tc', '--lsp',
+      chdir: Rails.root.to_path,
+    )
+    expect(status.exitstatus).to eql(0)
+  end
+end

data/spec/support/rails_shared/config/routes.rb

@@ -1,3 +1,4 @@
+# typed: strict
 Rails.application.routes.draw do
   # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
 

data/spec/support/rails_shared/sorbet_test_cases.rb

@@ -0,0 +1,120 @@
+# typed: true
+require 'sorbet-runtime'
+
+wizard = Wizard.first!
+T.assert_type!(wizard, Wizard)
+
+# -- model columns
+T.assert_type!(wizard.name, T.nilable(String))
+
+# -- model associations
+T.assert_type!(wizard.wand, T.nilable(Wand))
+T.assert_type!(T.must(wizard.wand).wizard, Wizard)
+
+T.assert_type!(wizard.spell_books, ActiveRecord::Associations::CollectionProxy)
+T.reveal_type(wizard.spell_books) # SpellBook::CollectionProxy
+
+# -- model relation
+# default
+T.assert_type!(Wizard.all, ActiveRecord::Relation)
+T.reveal_type(Wizard.all) # Wizard::ActiveRecord_Relation
+
+# custom scope
+T.assert_type!(Wizard.recent, ActiveRecord::Relation)
+T.reveal_type(Wizard.recent)
+
+# enum scope
+T.assert_type!(Wizard.Gryffindor, ActiveRecord::Relation)
+T.reveal_type(Wizard.Gryffindor)
+
+# chained scopes
+T.assert_type!(Wizard.Gryffindor.recent, ActiveRecord::Relation)
+T.reveal_type(Wizard.Gryffindor.recent)
+T.assert_type!(Wizard.Gryffindor.recent.unscoped, ActiveRecord::Relation)
+T.reveal_type(Wizard.Gryffindor.recent.unscoped)
+
+# ActiveRecord Querying
+T.assert_type!(Wizard.where(id: 1), ActiveRecord::Relation)
+T.reveal_type(Wizard.where(id: 1)) # Wizard::Relation
+T.assert_type!(Wizard.preload(:spell_books), ActiveRecord::Relation)
+T.reveal_type(Wizard.preload(:spell_books)) # Wizard::Relation
+T.assert_type!(Wizard.eager_load(:spell_books), ActiveRecord::Relation)
+T.reveal_type(Wizard.eager_load(:spell_books)) # Wizard::Relation
+T.assert_type!(Wizard.order(:id), ActiveRecord::Relation)
+T.reveal_type(Wizard.order(:id)) # Wizard::Relation
+
+# Finder methods -- Model
+T.assert_type!(Wizard.exists?(name: 'Test'), T::Boolean)
+T.assert_type!(Wizard.find(wizard.id), Wizard)
+T.assert_type!(Wizard.first!, Wizard)
+T.assert_type!(Wizard.first, T.nilable(Wizard))
+T.assert_type!(Wizard.last!, Wizard)
+T.assert_type!(Wizard.last, T.nilable(Wizard))
+T.assert_type!(Wizard.first_n(5), T::Array[Wizard])
+T.assert_type!(Wizard.last_n(5), T::Array[Wizard])
+T.assert_type!(Wizard.find_by(name: 'Harry Potter'), T.nilable(Wizard))
+T.assert_type!(Wizard.find_by!(name: 'Harry Potter'), Wizard)
+T.assert_type!(Wizard.find_by_id(wizard.id), T.nilable(Wizard))
+T.assert_type!(Wizard.find_by_id!(wizard.id), Wizard)
+
+# Finder methods -- ActiveRecord::Relation
+T.assert_type!(Wizard.all.exists?(name: 'Harry Potter'), T::Boolean)
+T.assert_type!(Wizard.all.find(wizard.id), Wizard)
+T.assert_type!(Wizard.all.first!, Wizard)
+T.assert_type!(Wizard.all.first, T.nilable(Wizard))
+T.assert_type!(Wizard.all.last!, Wizard)
+T.assert_type!(Wizard.all.last, T.nilable(Wizard))
+T.assert_type!(Wizard.all.first_n(5), T::Array[Wizard])
+T.assert_type!(Wizard.all.last_n(5), T::Array[Wizard])
+T.assert_type!(Wizard.all.find_by(name: 'Harry Potter'), T.nilable(Wizard))
+T.assert_type!(Wizard.all.find_by!(name: 'Harry Potter'), Wizard)
+T.assert_type!(Wizard.all.find_by_id(wizard.id), T.nilable(Wizard))
+T.assert_type!(Wizard.all.find_by_id!(wizard.id), Wizard)
+
+# Finder methods -- CollectionProxy
+spell_book = wizard.spell_books.first!
+T.assert_type!(wizard.spell_books.exists?(name: 'Fantastic Beasts'), T::Boolean)
+T.assert_type!(wizard.spell_books.find(spell_book.id), SpellBook)
+T.assert_type!(wizard.spell_books.first!, SpellBook)
+# T.assert_type!(wizard.spell_books.first, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+T.assert_type!(wizard.spell_books.last!, SpellBook)
+# T.assert_type!(wizard.spell_books.last, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+T.assert_type!(wizard.spell_books.first_n(5), T::Array[SpellBook])
+T.assert_type!(wizard.spell_books.last_n(5), T::Array[SpellBook])
+T.assert_type!(wizard.spell_books.find_by(name: 'Fantastic Beasts'), T.nilable(SpellBook))
+T.assert_type!(wizard.spell_books.find_by!(name: 'Fantastic Beasts'), SpellBook)
+T.assert_type!(wizard.spell_books.find_by_id(spell_book.id), T.nilable(SpellBook))
+T.assert_type!(wizard.spell_books.find_by_id!(spell_book.id), SpellBook)
+
+# Enumerable
+T.assert_type!(Wizard.all.to_a, T::Array[Wizard])
+Wizard.all.each do |w|
+  T.assert_type!(w, Wizard)
+end
+Wizard.all.map do |w|
+  T.assert_type!(w, Wizard) # TODO this doesn't work on Rails 4.2 or 5.0
+end
+Wizard.all.to_a.map do |w|
+  T.assert_type!(w, Wizard)
+end
+
+T.assert_type!(wizard.spell_books.to_a, T::Array[SpellBook])
+wizard.spell_books.each do |sp|
+  T.assert_type!(sp, SpellBook)
+end
+wizard.spell_books.map do |sp|
+  T.assert_type!(sp, SpellBook) # TODO this doesn't work on Rails 4.2 or 5.0
+end
+wizard.spell_books.to_a.map do |sp|
+  T.assert_type!(sp, SpellBook) # This works on Rails 4.2
+end
+
+# Model columns
+T.assert_type!(wizard.id, Integer)
+T.assert_type!(wizard.id?, T::Boolean)
+T.assert_type!(wizard.notes, T.nilable(String))
+T.assert_type!(wizard.house, String)
+
+# Model enum
+T.assert_type!(wizard.Gryffindor?, T::Boolean)
+T.assert_type!(Wizard.houses, T::Hash[T.any(String, Symbol), Integer])

data/spec/support/rails_symlinks/sorbet_test_cases.rb

@@ -0,0 +1 @@
+spec/support/rails_symlinks/../rails_shared/sorbet_test_cases.rb

data/spec/support/v4.2/Gemfile

@@ -29,3 +29,16 @@ group :development do
   gem 'web-console', '~> 2.0'
 end
 
+gem 'sorbet-rails', path: '../../../.'
+
+sorbet_version = ENV["SORBET_VERSION"]
+if sorbet_version
+  # mostly used to test against a stable version of Sorbet in Travis.
+  gem 'sorbet', sorbet_version
+  gem 'sorbet-runtime', sorbet_version
+else
+  # prefer to test against latest version because sorbet is updated frequently
+  gem 'sorbet'
+  gem 'sorbet-runtime'
+end
+

data/spec/support/v4.2/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: ../../..
+  specs:
+    sorbet-rails (0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.11)
+      actionpack (= 4.2.11)
+      actionview (= 4.2.11)
+      activejob (= 4.2.11)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.11)
+      actionview (= 4.2.11)
+      activesupport (= 4.2.11)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.11)
+      activesupport (= 4.2.11)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (4.2.11)
+      activesupport (= 4.2.11)
+      globalid (>= 0.3.0)
+    activemodel (4.2.11)
+      activesupport (= 4.2.11)
+      builder (~> 3.1)
+    activerecord (4.2.11)
+      activemodel (= 4.2.11)
+      activesupport (= 4.2.11)
+      arel (~> 6.0)
+    activesupport (4.2.11)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.4)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.3)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    debug_inspector (0.0.3)
+    erubis (2.7.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jbuilder (2.9.1)
+      activesupport (>= 4.2.0)
+    json (1.8.6)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rack (1.6.11)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.11)
+      actionmailer (= 4.2.11)
+      actionpack (= 4.2.11)
+      actionview (= 4.2.11)
+      activejob (= 4.2.11)
+      activemodel (= 4.2.11)
+      activerecord (= 4.2.11)
+      activesupport (= 4.2.11)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.11)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.9)
+      activesupport (>= 4.2.0, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (4.2.11)
+      actionpack (= 4.2.11)
+      activesupport (= 4.2.11)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.3.2)
+    rdoc (4.3.0)
+    sdoc (0.4.2)
+      json (~> 1.7, >= 1.7.7)
+      rdoc (~> 4.0)
+    sorbet (0.4.4378)
+      sorbet-static (= 0.4.4378)
+    sorbet-runtime (0.4.4378)
+    sorbet-static (0.4.4378-universal-darwin-14)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    web-console (2.3.0)
+      activemodel (>= 4.0)
+      binding_of_caller (>= 0.7.2)
+      railties (>= 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  jbuilder (~> 2.0)
+  rails (= 4.2.11)
+  sdoc (~> 0.4.0)
+  sorbet
+  sorbet-rails!
+  sorbet-runtime
+  sqlite3 (~> 1.3.6)
+  web-console (~> 2.0)
+
+BUNDLED WITH
+   1.17.3

data/spec/support/v4.2/app/controllers/application_controller.rb

@@ -1,3 +1,4 @@
+# typed: strict
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.

data/spec/support/v4.2/app/helpers/application_helper.rb

@@ -1,2 +1,3 @@
+# typed: strong
 module ApplicationHelper
 end

data/spec/support/v4.2/config/application.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require File.expand_path('../boot', __FILE__)
 
 require "rails"

data/spec/support/v4.2/config/boot.rb

@@ -1,3 +1,4 @@
+# typed: strong
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 
 require 'bundler/setup' # Set up gems listed in the Gemfile.

data/spec/support/v4.2/config/environment.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # Load the Rails application.
 require File.expand_path('../application', __FILE__)
 

data/spec/support/v4.2/config/environments/development.rb

@@ -1,3 +1,4 @@
+# typed: strict
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 

data/spec/support/v4.2/config/environments/production.rb

@@ -1,3 +1,4 @@
+# typed: strict
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 

data/spec/support/v4.2/config/environments/test.rb

@@ -1,3 +1,4 @@
+# typed: strict
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 

data/spec/support/v4.2/config/initializers/backtrace_silencers.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # Be sure to restart your server when you modify this file.
 
 # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.

data/spec/support/v4.2/config/initializers/cookies_serializer.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # Be sure to restart your server when you modify this file.
 
 Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/support/v4.2/config/initializers/filter_parameter_logging.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # Be sure to restart your server when you modify this file.
 
 # Configure sensitive parameters which will be filtered from the log file.

data/spec/support/v4.2/config/initializers/inflections.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # Be sure to restart your server when you modify this file.
 
 # Add new inflection rules using the following format. Inflections

data/spec/support/v4.2/config/initializers/mime_types.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # Be sure to restart your server when you modify this file.
 
 # Add new mime types for use in respond_to blocks:

data/spec/support/v4.2/config/initializers/session_store.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # Be sure to restart your server when you modify this file.
 
 Rails.application.config.session_store :cookie_store, key: '_v4_2_session'

data/spec/support/v4.2/config/initializers/to_time_preserves_timezone.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # Be sure to restart your server when you modify this file.
 
 # Preserve the timezone of the receiver when calling to `to_time`.

data/spec/support/v4.2/config/initializers/wrap_parameters.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # Be sure to restart your server when you modify this file.
 
 # This file contains settings for ActionController::ParamsWrapper which

data/spec/support/v4.2/config/routes.rb

@@ -1,3 +1,4 @@
+# typed: strict
 Rails.application.routes.draw do
   # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
 

data/spec/support/v4.2/db/migrate/20190620001234_create_wizards.rb

@@ -1,3 +1,4 @@
+# typed: false
 class CreateWizards < ActiveRecord::Migration
   def change
     create_table :wizards do |t|

data/spec/support/v4.2/db/migrate/20190620003037_create_wands.rb

@@ -1,3 +1,4 @@
+# typed: false
 class CreateWands < ActiveRecord::Migration
   def change
     create_table :wands do |t|

data/spec/support/v4.2/db/migrate/20190620003739_create_spell_books.rb

@@ -1,3 +1,4 @@
+# typed: false
 class CreateSpellBooks < ActiveRecord::Migration
   def change
     create_table :spell_books do |t|

data/spec/support/v4.2/db/migrate/20190622000000_add_more_column_types_to_wands.rb

@@ -1,3 +1,4 @@
+# typed: false
 class AddMoreColumnTypesToWands < ActiveRecord::Migration
   def change
     add_column :wands, :flexibility,    :float,   null: false, default: 0.5

data/spec/support/v4.2/db/schema.rb

@@ -1,3 +1,4 @@
+# typed: false
 # encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to

data/spec/support/v4.2/db/seeds.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # This file should contain all the record creation needed to seed the database with its default values.
 # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
 #

data/spec/support/v4.2/sorbet/config

@@ -0,0 +1,2 @@
+--dir
+.