sorbet-rails 0.7.3 → 0.7.33

data/lib/sorbet-rails/model_utils.rb

@@ -90,9 +90,16 @@ module SorbetRails::ModelUtils
       # where, limit, etc and not something like a named scope. It should likely
       # only be set to `true` when called from the ActiveRecordQuerying plugin.
       builtin_query_method: T::Boolean,
+      custom_return_value: T.nilable(String),
     ).void
   }
-  def add_relation_query_method(root, method_name, parameters: nil, builtin_query_method: false)
+  def add_relation_query_method(
+    root,
+    method_name,
+    parameters: nil,
+    builtin_query_method: false,
+    custom_return_value: nil
+  )
     # a relation querying method will be available on
     # - model (as a class method)
     # - activerecord relation
@@ -114,14 +121,14 @@ module SorbetRails::ModelUtils
       relation_module_rbi.create_method(
         method_name,
         parameters: parameters,
-        return_type: self.model_relation_class_name,
+        return_type: custom_return_value || self.model_relation_class_name,
       )
 
       assoc_relation_module_rbi = root.create_module(self.model_query_methods_returning_assoc_relation_module_name)
       assoc_relation_module_rbi.create_method(
         method_name,
         parameters: parameters,
-        return_type: assoc_return_value,
+        return_type: custom_return_value || assoc_return_value,
       )
     else
       # force generating these methods because sorbet's hidden-definitions generate & override them
@@ -129,7 +136,7 @@ module SorbetRails::ModelUtils
       model_class_rbi.create_method(
         method_name,
         parameters: parameters,
-        return_type: self.model_relation_class_name,
+        return_type: custom_return_value || self.model_relation_class_name,
         class_method: true,
       )
 
@@ -137,21 +144,21 @@ module SorbetRails::ModelUtils
       model_relation_rbi.create_method(
         method_name,
         parameters: parameters,
-        return_type: self.model_relation_class_name,
+        return_type: custom_return_value || self.model_relation_class_name,
       )
 
       model_assoc_relation_rbi = root.create_class(self.model_assoc_relation_class_name)
       model_assoc_relation_rbi.create_method(
         method_name,
         parameters: parameters,
-        return_type: assoc_return_value,
+        return_type: custom_return_value || assoc_return_value,
       )
 
       collection_proxy_rbi = root.create_class(self.model_assoc_proxy_class_name)
       collection_proxy_rbi.create_method(
         method_name,
         parameters: parameters,
-        return_type: assoc_return_value,
+        return_type: custom_return_value || assoc_return_value,
       )
     end
   end

data/lib/sorbet-rails/rails_mixins/custom_finder_methods.rb

@@ -13,6 +13,10 @@ module SorbetRails
       last(n)
     end
 
+    def select_columns(*args)
+      select(*args)
+    end
+
     # Redeclare these dynamic methods here otherwise they will be generated by
     # `srb rbi hidden-definitions`
     def find_by_id(id)
@@ -22,5 +26,13 @@ module SorbetRails
     def find_by_id!(id)
       find_by!(id: id)
     end
+
+    # where.missing is only available in Rails 6.1 and above
+    if Rails.version >= "6.1"
+      # https://api.rubyonrails.org/v6.1.4/classes/ActiveRecord/QueryMethods/WhereChain.html#method-i-missing
+      def where_missing(*args)
+        where.missing(*args)
+      end
+    end
   end
 end

data/lib/sorbet-rails/railtie.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: false
 require "rails"
 require "sorbet-runtime"
 require "sorbet-rails/config"

data/lib/sorbet-rails/routes_rbi_formatter.rb

@@ -39,6 +39,14 @@ class SorbetRails::RoutesRbiFormatter
     @parlour.root.create_class('ActionMailer::Base') do |mod|
       mod.create_include('GeneratedUrlHelpers')
     end
+
+    @parlour.root.create_class('ActionDispatch::IntegrationTest') do |mod|
+      mod.create_include('GeneratedUrlHelpers')
+    end
+
+    @parlour.root.create_class('ActionDispatch::SystemTestCase') do |mod|
+      mod.create_include('GeneratedUrlHelpers')
+    end
   end
 
   sig { params(routes: T.untyped, filter: T.untyped).void }

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

@@ -16,12 +16,12 @@ namespace :rails_rbi do
     FileUtils.rm_rf(rails_rbi_root_path)
 
     # run all rake tasks
-    Rake::Task['rails_rbi:routes'].invoke
-    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
+    Rake::Task[rails_rbi_task_name(t, 'routes')].invoke
+    Rake::Task[rails_rbi_task_name(t, 'models')].invoke
+    Rake::Task[rails_rbi_task_name(t, 'helpers')].invoke
+    Rake::Task[rails_rbi_task_name(t, 'mailers')].invoke
+    Rake::Task[rails_rbi_task_name(t, 'jobs')].invoke
+    Rake::Task[rails_rbi_task_name(t, 'custom')].invoke
   end
 
   desc "Generate rbis for rails routes"
@@ -36,7 +36,7 @@ namespace :rails_rbi do
   end
 
   desc "Copy custom rbis for typed_params, pluck_to_struct, etc."
-  task custom: :environment do
+  task custom: :environment do |t, args|
     copy_bundled_rbi('type_assert.rbi')
     copy_bundled_rbi('pluck_to_tstruct.rbi')
     copy_bundled_rbi('typed_params.rbi')
@@ -44,7 +44,7 @@ namespace :rails_rbi do
 
     # These files were previously bundled_rbi but are now generated so this
     # is needed for backwards compatibility with anyone using `rails_rbi:custom`
-    Rake::Task['rails_rbi:active_record'].invoke
+    Rake::Task[rails_rbi_task_name(t, 'active_record')].invoke
   end
 
   desc "Generate rbis for rails active_record base"
@@ -182,4 +182,8 @@ namespace :rails_rbi do
     FileUtils.mkdir_p(File.dirname(copy_to_path))
     FileUtils.cp(bundled_rbi_file_path, copy_to_path)
   end
+
+  def rails_rbi_task_name(current_task, target_task_suffix)
+    current_task.to_s.sub(/\w+$/, target_task_suffix)
+  end
 end

data/sorbet-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = %q{sorbet-rails}
-  s.version       = "0.7.3"
+  s.version       = "0.7.33"
   s.date          = %q{2019-04-18}
   s.summary       = %q{Set of tools to make Sorbet work with Rails seamlessly.}
   s.authors       = ["Chan Zuckerberg Initiative"]
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   end
 
   s.add_dependency 'parlour', '>= 4.0.1'
-  s.add_dependency 'sorbet-runtime', '>= 0.5'
+  s.add_dependency 'sorbet-runtime', '>= 0.5.9892'
   s.add_dependency 'sorbet-coerce', '>= 0.2.6'
   s.add_dependency 'method_source', '>= 0.9.2'
   s.add_dependency 'parser', '>= 2.7'
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.8', '>= 3.8'
   # Debugging
   s.add_development_dependency 'awesome_print', '~>1.8.0', '>=1.8.0'
-  s.add_development_dependency 'byebug', '~>11.0.1', '>=11.0.1'
+  s.add_development_dependency 'byebug', '~>11.1.3', '>=11.1.3'
 
   # for testing a gem with a rails app (controller specs)
   s.add_development_dependency 'rspec-rails', '>=3.8.2'

data/spec/bin/run_all_specs.sh

@@ -3,9 +3,8 @@
 
 wd="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
-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
+RAILS_VERSION=5.2 bash $wd/run_spec.sh
+RAILS_VERSION=6.1 bash $wd/run_spec.sh
 
-# Always end with the default version, which is Rails 5.2
+# Always end with the default version, which is Rails 6.0
 bash $wd/run_spec.sh

data/spec/bin/run_spec.sh

@@ -6,7 +6,7 @@ wd="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 current_dir=$(pwd)
 
 if [[ -z $RAILS_VERSION ]]; then
-  rails_dir="$wd/../support/v5.2"
+  rails_dir="$wd/../support/v6.0"
 else
   rails_dir="$wd/../support/v$RAILS_VERSION"
 fi
@@ -15,7 +15,10 @@ fi
 rm $wd/../../Gemfile.lock 2>/dev/null # clean up Gemfile.lock first
 bundle install
 
+echo "===================================================================="
+echo "Run test for folder:"
 echo $rails_dir
+echo "===================================================================="
 
 # update gems in rails_dir
 cd $rails_dir

data/spec/custom_finder_methods_spec.rb

@@ -77,4 +77,27 @@ RSpec.describe SorbetRails::CustomFinderMethods do
       expect(wizards_3).to eq([harry, ron, hermione])
     end
   end
+
+  context 'test where_missing' do
+    # where.missing is only available in Rails 6.1 and above
+    if Rails.version < "6.1"
+      it 'raises an error' do
+        expect { Wizard.where_missing(:wand) }.to raise_error(NoMethodError)
+      end
+    else
+      it 'works with no arguments' do
+        missing_with_no_args = Wizard.where_missing
+        all_wizards = Wizard.all
+
+        expect(missing_with_no_args).to eq(all_wizards)
+      end
+
+      it 'retrieves wizards with missing wands' do
+        elder_wand = Wand.create!(wizard: harry, wood_type: :holly, core_type: :phoenix_feather)
+        wizards_without_wands = Wizard.where_missing(:wand).to_a
+
+        expect(wizards_without_wands).to eq(Wizard.all.to_a - [harry])
+      end
+    end
+  end
 end

data/spec/generators/rails-template.rb

@@ -127,7 +127,7 @@ def create_models
 
   # 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"])
+  if ['5.2', '6.0', '6.1'].include?(ENV["RAILS_VERSION"])
     attachments = "has_one_attached :school_photo\n  has_many_attached :hats"
   end
 
@@ -313,11 +313,8 @@ def create_migrations
         add_column :wands, :broken_at,      :datetime, null: true
         add_column :wands, :chosen_at_date, :date
         add_column :wands, :chosen_at_time, :time
-        # JSON column type is only supported on 5.2 or higher
-        unless ['5.0', '5.1'].include?(ENV['RAILS_VERSION'])
-          add_column :wands, :spell_history,  :json
-          add_column :wands, :maker_info,     :json,    null: false, default: '{}'
-        end
+        add_column :wands, :spell_history,  :json
+        add_column :wands, :maker_info,     :json,    null: false, default: '{}'
       end
     end
   RUBY
@@ -507,20 +504,6 @@ end
 # Main setup
 source_paths
 
-if ['5.0'].include?(ENV["RAILS_VERSION"])
-  File.open('Gemfile', 'r+') do |f|
-    out = ""
-    f.each do |line|
-      # We remove sdoc and web-console because they misbehave.
-      # sqlite needs to be limited to 1.3.x or it won't work.
-      out << line.gsub("gem 'sqlite3'", "gem 'sqlite3', '~> 1.3.6'") unless line =~ /gem \'(sdoc|web-console)\'.*/
-    end
-    f.pos = 0
-    f.print out
-    f.truncate(f.pos)
-  end
-end
-
 add_gems
 
 after_bundle do

data/spec/generators/sorbet_test_cases.rb

@@ -84,6 +84,8 @@ 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)
+T.assert_type!(Wizard.select { |r| r.id == 1 }, T::Array[Wizard])
+T.assert_type!(Wizard.select_columns(:id, :name), Wizard::ActiveRecord_Relation)
 
 # Finder methods -- ActiveRecord::Relation
 T.assert_type!(Wizard.all.exists?(name: 'Harry Potter'), T::Boolean)
@@ -121,12 +123,17 @@ T.assert_type!(Wizard.all.find_each, T::Enumerator[Wizard])
 Wizard.all.find_in_batches { |w| T.assert_type!(w, T::Array[Wizard]) }
 T.assert_type!(Wizard.all.find_in_batches, T::Enumerator[T::Array[Wizard]])
 Wizard.all.in_batches { |w| T.assert_type!(w, Wizard::ActiveRecord_Relation) }
-T.assert_type!(Wizard.all.in_batches, T::Enumerable[Wizard::ActiveRecord_Relation])
+T.assert_type!(Wizard.all.in_batches, ActiveRecord::Batches::BatchEnumerator)
 # T.assert_type!(Wizard.all.destroy_all, T::Array[Wizard]) # Ignored until we add support
 T.assert_type!(Wizard.all.any?, T::Boolean)
 T.assert_type!(Wizard.all.many?, T::Boolean)
 T.assert_type!(Wizard.all.none?, T::Boolean)
 T.assert_type!(Wizard.all.one?, T::Boolean)
+T.assert_type!(Wizard.all.any? { |r| r.id > 1 }, T::Boolean)
+T.assert_type!(Wizard.all.many? { |r| r.id > 1 }, T::Boolean)
+T.assert_type!(Wizard.all.none? { |r| r.id > 1 }, T::Boolean)
+T.assert_type!(Wizard.all.one? { |r| r.id > 1 }, T::Boolean)
+
 # T.assert_type!(Wizard.all.update_all(name: 'Harry Potter'), Integer) # Ignored until we add support
 # T.assert_type!(Wizard.all.delete_all, Integer) # Ignored until we add support
 # Query methods
@@ -141,6 +148,8 @@ T.assert_type!(Wizard.all.where.not(id: 1), Wizard::ActiveRecord_Relation)
 T.assert_type!(Wizard.all.preload(:spell_books), Wizard::ActiveRecord_Relation)
 T.assert_type!(Wizard.all.eager_load(:spell_books), Wizard::ActiveRecord_Relation)
 T.assert_type!(Wizard.all.order(:id), Wizard::ActiveRecord_Relation)
+T.assert_type!(Wizard.all.select { |r| r.id == 1 }, T::Array[Wizard])
+T.assert_type!(Wizard.all.select_columns(:id, :name), Wizard::ActiveRecord_Relation)
 # Enumerable methods
 Wizard.all.each { |w| T.assert_type!(w, Wizard) }
 Wizard.all.map { |w| T.assert_type!(w, Wizard) }
@@ -185,12 +194,16 @@ T.assert_type!(spell_books.find_each, T::Enumerator[SpellBook])
 spell_books.find_in_batches { |s| T.assert_type!(s, T::Array[SpellBook]) }
 T.assert_type!(spell_books.find_in_batches, T::Enumerator[T::Array[SpellBook]])
 spell_books.in_batches { |s| T.assert_type!(s, SpellBook::ActiveRecord_AssociationRelation) }
-T.assert_type!(spell_books.in_batches, T::Enumerable[SpellBook::ActiveRecord_AssociationRelation])
+T.assert_type!(spell_books.in_batches, ActiveRecord::Batches::BatchEnumerator)
 # T.assert_type!(spell_books.destroy_all, T::Array[SpellBook]) # Ignored until we add support
 T.assert_type!(spell_books.any?, T::Boolean)
 T.assert_type!(spell_books.many?, T::Boolean)
 T.assert_type!(spell_books.none?, T::Boolean)
 T.assert_type!(spell_books.one?, T::Boolean)
+T.assert_type!(spell_books.any? { |r| r.id > 1 }, T::Boolean)
+T.assert_type!(spell_books.many? { |r| r.id > 1 }, T::Boolean)
+T.assert_type!(spell_books.none? { |r| r.id > 1 }, T::Boolean)
+T.assert_type!(spell_books.one? { |r| r.id > 1 }, T::Boolean)
 # T.assert_type!(spell_books.update_all(name: 'Fantastic Beasts'), Integer) # Ignored until we add support
 # T.assert_type!(spell_books.delete_all, Integer) # Ignored until we add support
 # Query methods
@@ -205,6 +218,9 @@ T.assert_type!(spell_books.where.not(id: 1), SpellBook::ActiveRecord_Association
 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.select { |r| r.id == 1 }, T::Array[SpellBook])
+T.assert_type!(spell_books.select_columns(:id, :name), SpellBook::ActiveRecord_AssociationRelation)
+
 # Enumerable methods
 spell_books.each { |s| T.assert_type!(s, SpellBook) }
 spell_books.map { |s| T.assert_type!(s, SpellBook) }
@@ -257,12 +273,16 @@ T.assert_type!(spell_books_query.find_each, T::Enumerator[SpellBook])
 spell_books_query.find_in_batches { |s| T.assert_type!(s, T::Array[SpellBook]) }
 T.assert_type!(spell_books_query.find_in_batches, T::Enumerator[T::Array[SpellBook]])
 spell_books_query.in_batches { |s| T.assert_type!(s, SpellBook::ActiveRecord_AssociationRelation) }
-T.assert_type!(spell_books_query.in_batches, T::Enumerable[SpellBook::ActiveRecord_AssociationRelation])
+T.assert_type!(spell_books_query.in_batches, ActiveRecord::Batches::BatchEnumerator)
 # T.assert_type!(spell_books_query.destroy_all, T::Array[SpellBook]) # Ignored until we add support
 T.assert_type!(spell_books_query.any?, T::Boolean)
 T.assert_type!(spell_books_query.many?, T::Boolean)
 T.assert_type!(spell_books_query.none?, T::Boolean)
 T.assert_type!(spell_books_query.one?, T::Boolean)
+T.assert_type!(spell_books_query.any? { |r| r.id > 1 }, T::Boolean)
+T.assert_type!(spell_books_query.many? { |r| r.id > 1 }, T::Boolean)
+T.assert_type!(spell_books_query.none? { |r| r.id > 1 }, T::Boolean)
+T.assert_type!(spell_books_query.one? { |r| r.id > 1 }, T::Boolean)
 # T.assert_type!(spell_books_query.update_all(name: 'Fantastic Beasts'), Integer) # Ignored until we add support
 # T.assert_type!(spell_books_query.delete_all, Integer) # Ignored until we add support
 # Query methods
@@ -277,6 +297,8 @@ T.assert_type!(spell_books_query.where.not(id: 1), SpellBook::ActiveRecord_Assoc
 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.select { |r| r.id == 1 }, T::Array[SpellBook])
+T.assert_type!(spell_books.select_columns(:id, :name), SpellBook::ActiveRecord_AssociationRelation)
 # Enumerable methods
 spell_books_query.each { |s| T.assert_type!(s, SpellBook) }
 spell_books_query.map { |s| T.assert_type!(s, SpellBook) }
@@ -316,7 +338,7 @@ T.assert_type!(
 )
 T.assert_type!(
   wizard.patronus_characteristics,
-  T.nilable(T.any(T::Array[T.untyped], T::Boolean, Float, T::Hash[String, T.untyped], Integer, String))
+  T.nilable(ActiveRecord::Coders::JSON),
 )
 T.assert_type!(wizard.pets, T.nilable(T::Array[T.untyped]))
 

data/spec/rails_helper.rb

@@ -13,14 +13,14 @@ rails_version = ENV["RAILS_VERSION"] || "default"
 
 rails_folder =
   case rails_version
-  when "5.0"
-    "v5.0"
-  when "5.1"
-    "v5.1"
+  when "5.2"
+    "v5.2"
   when "6.0"
     "v6.0"
+  when "6.1"
+    "v6.1"
   else
-    "v5.2"
+    "v6.0"
   end
 
 TEST_DATA_FOLDER = "spec/test_data/#{rails_folder}"
@@ -36,7 +36,6 @@ RSpec.configure do |config|
     next if ENV["DISABLE_DATABASE_CLEANER"] == 'true'
     DatabaseCleaner.clean_with(:truncation, {
       pre_count: true,
-      reset_ids: false,
       except: %w(ar_internal_metadata),
     })
   end
@@ -46,10 +45,7 @@ RSpec.configure do |config|
       example.run
       next
     end
-    DatabaseCleaner.strategy = :truncation, {
-      pre_count: true,
-      reset_ids: false,
-    }
+    DatabaseCleaner.strategy = :truncation, { pre_count: true }
     DatabaseCleaner.start
     example.run
     DatabaseCleaner.clean

data/spec/rake_rails_rbi_models_spec.rb

@@ -29,12 +29,19 @@ RSpec.describe 'rake rails_rbi:models', type: :task do
       ]
     )
     if Object.const_defined?('ActiveStorage')
+      files = [
+        'attachment.rbi',
+        'blob.rbi',
+      ]
+      if ENV["RAILS_VERSION"] == '6.1'
+        files += [
+          'record.rbi',
+          'variant_record.rbi',
+        ]
+      end
       expect_files(
         base_dir: generated_dir_path.join('active_storage'),
-        files: [
-          'attachment.rbi',
-          'blob.rbi',
-        ],
+        files: files,
       )
     end
     if Object.const_defined?('ActiveRecord::InternalMetadata')

data/spec/sorbet_spec.rb

@@ -63,6 +63,9 @@ RSpec.describe 'sorbet' do
     # run sorbet-rails rake tasks
     Rake::Task['rails_rbi:all'].invoke
 
+    # ensure we remove sorbet-rails.rbi as there are conflicts which cause srb tc to fail
+    FileUtils.rm_f(Rails.root.join('sorbet/rbi/gems/sorbet-rails.rbi'))
+
     # 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
@@ -79,7 +82,8 @@ RSpec.describe 'sorbet' do
 
   it 'returns expected sorbet tc result' do
     stdout, stderr, status = Open3.capture3(
-      'bundle', 'exec', 'srb', 'tc',
+      # 'bundle', 'exec', 'srb', 'tc',
+      'srb', 'tc',
       chdir: Rails.root.to_path,
     )
     expected_file_path = 'expected_srb_tc_output.txt'

data/spec/support/v5.2/Gemfile

@@ -1,8 +1,6 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.5.5'
-
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 5.2.4', '>= 5.2.4.2'
 # Use sqlite3 as the database for Active Record
@@ -36,4 +34,4 @@ gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
 gem 'sorbet-rails', path: '../../../.'
 gem 'sorbet'
-gem 'sorbet-runtime'
+gem 'sorbet-runtime'