sorbet-rails 0.5.1 → 0.5.2

data/lib/sorbet-rails/routes_rbi_formatter.rb

@@ -4,62 +4,76 @@ class SorbetRails::RoutesRbiFormatter
 
   sig { void }
   def initialize
-    @buffer = T.let([], T::Array[T.any(String, T::Array[String])])
+    @parlour = T.let(Parlour::RbiGenerator.new, Parlour::RbiGenerator)
   end
 
   sig { params(title: String).void }
   def section_title(title)
-    @buffer << "\n# Section #{title}"
+    nil
   end
 
   sig { params(routes: T::Array[T::Hash[Symbol, String]]).void }
   def section(routes)
-    @buffer << draw_section(routes)
+    draw_section(routes)
   end
 
-  sig { params(routes: T.untyped).returns(NilClass) }
+  sig { params(routes: T.untyped).void }
   def header(routes)
+    @parlour.root.add_comments([
+      'This is an autogenerated file for Rails routes.',
+      'Please run rake rails_rbi:routes to regenerate.'
+    ])
+
+    @parlour.root.create_class('ActionController::Base') do |klass|
+      klass.create_include('GeneratedUrlHelpers')
+    end
+
+    @parlour.root.create_module('ActionView::Helpers') do |mod|
+      mod.create_include('GeneratedUrlHelpers')
+    end
   end
 
   sig { params(routes: T.untyped, filter: T.untyped).void }
-  def no_routes(routes=nil, filter=nil)
-    @buffer <<
-      <<~MESSAGE
-        # You do not have any routes defined!
-        # Please add some routes in config/routes.rb.
-        # For more information about routes, see the Rails guide: https://guides.rubyonrails.org/routing.html.
-      MESSAGE
+  def no_routes(routes = nil, filter = nil)
+    @parlour.root.add_comments([
+      'You do not have any routes defined!',
+      'Please add some routes in config/routes.rb.',
+      'For more information about routes, see the Rails guide: https://guides.rubyonrails.org/routing.html.'
+    ])
   end
 
   sig { returns(String) }
   def result
-    <<~MESSAGE
-      # This is an autogenerated file for routes helper methods
-
-      # typed: strong
-      class ActionController::Base
-        extend T::Sig
-
-      #{@buffer.join("\n").indent(2)}
-      end
-    MESSAGE
+    # by default parlour doesn't add a \n at the end of file
+    @parlour.rbi + "\n"
   end
 
   private
-  sig { params(routes: T::Array[T::Hash[Symbol, String]]).returns(T::Array[String]) }
+
+  sig { params(routes: T::Array[T::Hash[Symbol, String]]).void }
   def draw_section(routes)
-    routes.map do |r|
-      if r[:name].present?
-        <<~MESSAGE
-          # Sigs for route #{r[:path]}
-          sig { params(args: T.untyped, kwargs: T.untyped).returns(String) }
-          def #{r[:name]}_path(*args, **kwargs); end
-          sig { params(args: T.untyped, kwargs: T.untyped).returns(String) }
-          def #{r[:name]}_url(*args, **kwargs); end
-        MESSAGE
-      else
-        nil
+    @parlour.root.create_module('GeneratedUrlHelpers') do |klass|
+      routes.each do |r|
+        next unless r[:name].present?
+
+        klass.add_comment_to_next_child("Sigs for route #{r[:path]}")
+        klass.create_method(
+          "#{r[:name]}_path",
+          parameters: [
+            Parlour::RbiGenerator::Parameter.new("*args", type: "T.untyped"),
+            Parlour::RbiGenerator::Parameter.new("**kwargs", type: "T.untyped")
+          ],
+          return_type: "String"
+        )
+        klass.create_method(
+          "#{r[:name]}_url",
+          parameters: [
+            Parlour::RbiGenerator::Parameter.new("*args", type: "T.untyped"),
+            Parlour::RbiGenerator::Parameter.new("**kwargs", type: "T.untyped")
+          ],
+          return_type: "String"
+        )
       end
-    end.compact
+    end
   end
 end

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.5.1"
+  s.version       = "0.5.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/bin/run_all_specs.sh

@@ -8,7 +8,5 @@ RAILS_VERSION=5.0 bash $wd/run_spec.sh
 RAILS_VERSION=5.1 bash $wd/run_spec.sh
 RAILS_VERSION=6.0 bash $wd/run_spec.sh
 
-TEST_SRB_INIT=1 bash $wd/run_spec.sh
-
 # Always end with the default version, which is Rails 5.2
 sh $wd/run_spec.sh

data/spec/bin/run_spec.sh

@@ -6,11 +6,7 @@ wd="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 current_dir=$(pwd)
 
 if [[ -z $RAILS_VERSION ]]; then
-  if [[ -z $TEST_SRB_INIT ]]; then
-    rails_dir="$wd/../support/v5.2"
-  else
-    rails_dir="$wd/../support/v5.2-no-sorbet"
-  fi
+  rails_dir="$wd/../support/v5.2"
 else
   rails_dir="$wd/../support/v$RAILS_VERSION"
 fi

data/spec/generators/rails-template.rb

@@ -67,16 +67,10 @@ def create_helpers
 end
 
 def create_models
-  if ENV['RAILS_VERSION'] != '4.2'
-    inject_into_file "app/models/application_record.rb", after: "self.abstract_class = true\n" do
-      # Need to include indentation manually
-      "  scope :recent, -> { where('created_at > ?', 1.month.ago) }\n"
-    end
-  else
+  if ENV['RAILS_VERSION'] == '4.2'
     file "app/models/application_record.rb", <<~RUBY
       class ApplicationRecord < ActiveRecord::Base
         self.abstract_class = true
-        scope :recent, -> { where('created_at > ?', 1.month.ago) }
       end
     RUBY
   end
@@ -85,6 +79,12 @@ def create_models
     class SpellBook < ApplicationRecord
       validates :name, length: { minimum: 5 }, presence: true
       belongs_to :wizard
+
+      enum book_type: {
+        unclassified: 0,
+        biology: 1,
+        dark_art: 999,
+      }
     end
   RUBY
 
@@ -98,16 +98,16 @@ def create_models
   file "app/models/wand.rb", <<~RUBY
     class Wand < ApplicationRecord
       include Mythical
-    
+
       enum core_type: {
         phoenix_feather: 0,
         dragon_heartstring: 1,
         unicorn_tail_hair: 2,
         basilisk_horn: 3,
       }
-    
+
       belongs_to :wizard
-    
+
       def wood_type
         'Type ' + super
       end
@@ -127,6 +127,8 @@ def create_models
 
       has_one :wand
       has_many :spell_books
+
+      scope :recent, -> { where('created_at > ?', 1.month.ago) }
     end
   RUBY
 
@@ -159,7 +161,7 @@ def create_migrations
           t.integer :house
           t.string :parent_email
           t.text :notes
-    
+
           t.timestamps
         end
       end
@@ -173,7 +175,7 @@ def create_migrations
           t.references :wizard, unique: true, null: false
           t.string :wood_type
           t.integer :core_type
-    
+
           t.timestamps
         end
       end
@@ -186,6 +188,7 @@ def create_migrations
         create_table :spell_books do |t|
           t.string :name
           t.references :wizard
+          t.integer :book_type, null: false, default: 0
         end
       end
     end
@@ -228,7 +231,7 @@ end
 source_paths
 
 if ['4.2', '5.0'].include?(ENV["RAILS_VERSION"])
-  File.open('Gemfile', 'r+') do |f|   
+  File.open('Gemfile', 'r+') do |f|
     out = ""
     f.each do |line|
       # We remove sdoc and web-console because they misbehave.
@@ -252,16 +255,20 @@ after_bundle do
   create_models
   create_migrations
   add_sorbet_test_files
-  
+
+  bundle_version = ENV["RAILS_VERSION"] == "4.2" ? "_1.17.3_" : ""
+
   Bundler.with_clean_env do
     # Rails 4.2 doesn't have the rails_command method, so just use run.
-    run "bundle exec rake db:migrate"
+    run "bundle #{bundle_version} exec rake db:migrate"
   end
 
   if ENV["RUN_WITH_SORBET"] != 'false'
     Bundler.with_clean_env do
-      run "SRB_YES=true bundle exec srb init"
-      run "bundle exec rake rails_rbi:all"
+      run "SRB_YES=true bundle #{bundle_version} exec srb init"
+      run "bundle #{bundle_version} exec rake rails_rbi:all"
+      run "bundle #{bundle_version} exec srbi rbi hidden-definitions"
+      run "bundle #{bundle_version} exec srb rbi todo"
     end
   end
   say "Done!"

data/spec/generators/sorbet_test_cases.rb

@@ -11,37 +11,30 @@ T.assert_type!(wizard.name, T.nilable(String))
 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
+# need the exact type to works! they aren't subclass of each other
+# T.assert_type!(wizard.spell_books, SpellBook::ActiveRecord_Relation)
+# T.assert_type!(wizard.spell_books, SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(wizard.spell_books, SpellBook::ActiveRecord_Associations_CollectionProxy)
 
 # -- model relation
 # default
-T.assert_type!(Wizard.all, ActiveRecord::Relation)
-T.reveal_type(Wizard.all) # Wizard::ActiveRecord_Relation
+T.assert_type!(Wizard.all, Wizard::ActiveRecord_Relation)
 
 # custom scope
-T.assert_type!(Wizard.recent, ActiveRecord::Relation)
-T.reveal_type(Wizard.recent)
+T.assert_type!(Wizard.recent, Wizard::ActiveRecord_Relation)
 
 # 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)
+T.assert_type!(Wizard.Gryffindor, Wizard::ActiveRecord_Relation)
 
 # 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
+T.assert_type!(Wizard.Gryffindor.recent, Wizard::ActiveRecord_Relation)
+T.assert_type!(Wizard.Gryffindor.recent.unscoped, Wizard::ActiveRecord_Relation)
+T.assert_type!(Wizard.where(id: 1), Wizard::ActiveRecord_Relation)
+T.assert_type!(Wizard.where(id: 1).recent, Wizard::ActiveRecord_Relation)
+T.assert_type!(Wizard.where.not(id: 1), Wizard::ActiveRecord_Relation)
+T.assert_type!(Wizard.preload(:spell_books), Wizard::ActiveRecord_Relation)
+T.assert_type!(Wizard.eager_load(:spell_books), Wizard::ActiveRecord_Relation)
+T.assert_type!(Wizard.order(:id), Wizard::ActiveRecord_Relation)
 
 # Finder methods -- Model
 T.assert_type!(Wizard.exists?(name: 'Test'), T::Boolean)
@@ -73,51 +66,96 @@ 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
+spell_books = wizard.spell_books
+T.assert_type!(spell_books.exists?(name: 'Fantastic Beasts'), T::Boolean)
+T.assert_type!(spell_books.find(spell_book.id), SpellBook)
+T.assert_type!(spell_books.first!, SpellBook)
+# T.assert_type!(spell_books.first, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+T.assert_type!(spell_books.last!, SpellBook)
+# T.assert_type!(spell_books.last, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+T.assert_type!(spell_books.first_n(5), T::Array[SpellBook])
+T.assert_type!(spell_books.last_n(5), T::Array[SpellBook])
+T.assert_type!(spell_books.find_by(name: 'Fantastic Beasts'), T.nilable(SpellBook))
+T.assert_type!(spell_books.find_by!(name: 'Fantastic Beasts'), SpellBook)
+T.assert_type!(spell_books.find_by_id(spell_book.id), T.nilable(SpellBook))
+T.assert_type!(spell_books.find_by_id!(spell_book.id), SpellBook)
+# CollectionProxy query also typed correctly!
+T.assert_type!(spell_books.where(id: 1), SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(spell_books.preload(:wizard), SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(spell_books.eager_load(:wizard), SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(spell_books.order(:id), SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(spell_books.where.not(id: 1), SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(spell_books.biology, SpellBook::ActiveRecord_AssociationRelation)
+
+# finder methods -- AssociationRelation
+spell_books_query = spell_books.where(id: 1)
+T.assert_type!(spell_books_query.exists?(name: 'Fantastic Beasts'), T::Boolean)
+T.assert_type!(spell_books_query.find(spell_book.id), SpellBook)
+T.assert_type!(spell_books_query.first!, SpellBook)
+# T.assert_type!(spell_books_query.first, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+T.assert_type!(spell_books_query.last!, SpellBook)
+# T.assert_type!(spell_books_query.last, T.nilable(SpellBook)) # TODO fix sig for 4.2 and 5.0
+T.assert_type!(spell_books_query.first_n(5), T::Array[SpellBook])
+T.assert_type!(spell_books_query.last_n(5), T::Array[SpellBook])
+T.assert_type!(spell_books_query.find_by(name: 'Fantastic Beasts'), T.nilable(SpellBook))
+T.assert_type!(spell_books_query.find_by!(name: 'Fantastic Beasts'), SpellBook)
+T.assert_type!(spell_books_query.find_by_id(spell_book.id), T.nilable(SpellBook))
+T.assert_type!(spell_books_query.find_by_id!(spell_book.id), SpellBook)
+# Query chaining
+T.assert_type!(spell_books_query.preload(:wizard), SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(spell_books_query.eager_load(:wizard), SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(spell_books_query.order(:id), SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(spell_books_query.where.not(id: 1), SpellBook::ActiveRecord_AssociationRelation)
+T.assert_type!(spell_books_query.biology, SpellBook::ActiveRecord_AssociationRelation)
+
+# Enumerable on activerecord relation
 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
+  T.assert_type!(w, Wizard)
 end
 Wizard.all.to_a.map do |w|
   T.assert_type!(w, Wizard)
 end
 
+# enum on association collection proxy
 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
+  T.assert_type!(sp, SpellBook)
 end
 wizard.spell_books.to_a.map do |sp|
-  T.assert_type!(sp, SpellBook) # This works on Rails 4.2
+  T.assert_type!(sp, SpellBook)
+end
+
+# enum on association relation
+T.assert_type!(wizard.spell_books.where(id: 1).to_a, T::Array[SpellBook])
+wizard.spell_books.where(id: 1).each do |sp|
+  T.assert_type!(sp, SpellBook)
+end
+wizard.spell_books.where(id: 1).map do |sp|
+  T.assert_type!(sp, SpellBook)
+end
+wizard.spell_books.where(id: 1).to_a.map do |sp|
+  T.assert_type!(sp, SpellBook)
 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, T.nilable(String))
 
 # Model enum
 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!(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])

data/spec/rails_helper.rb

@@ -22,7 +22,7 @@ rails_folder =
   when "6.0"
     "v6.0"
   else
-    ENV["TEST_SRB_INIT"] ? "v5.2-no-sorbet" : "v5.2"
+    "v5.2"
   end
 
 TEST_DATA_FOLDER = "spec/test_data/#{rails_folder}"

data/spec/sorbet_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe 'sorbet' do
     SpellBook.create!(
       name: 'Fantastic Beasts',
       wizard: harry,
+      book_type: :biology,
     )
   end
   let!(:wand) do
@@ -23,13 +24,11 @@ RSpec.describe 'sorbet' do
   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,
-      )
-    end
+    # 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,
+    )
 
     # run sorbet-rails rake tasks
     Rake::Task['rails_rbi:all'].invoke
@@ -41,8 +40,15 @@ RSpec.describe 'sorbet' do
       '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
+    puts '--- srb rbi hidden-definitions ---'
+    puts stdout, stderr, status
+
+    stdout, stderr, status = Open3.capture3(
+      'bundle', 'exec', 'srb', 'rbi', 'todo',
+      chdir: Rails.root.to_path,
+    )
+    puts '--- srb rbi todo ---'
+    puts stdout, stderr, status
   end
 
   it 'returns expected sorbet tc result' do
@@ -50,13 +56,9 @@ RSpec.describe 'sorbet' do
       'bundle', 'exec', 'srb', 'tc', '--typed-override=typed-override.yaml',
       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)
+    expect(stdout).to eql('')
   end
 
   it 'passes sorbet dynamic checks' do