sorbet-rails 0.7.33 → 0.7.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c85a4b2dec82b9ff5e78fd20ca40964639474ae84d03641f4d7a2f2ee7afe1ae
-  data.tar.gz: 62fd90904255f58f2c494a51c170077e347b0746b426717829514aa38df79b48
+  metadata.gz: d6ae993b835bd73f18fd64cacdf0fb9f3ba8e44d8ad42cb59fa103d1f2d8a481
+  data.tar.gz: d47b11ca70a73985bd8e811f56fee3394960c063b8e1850470f5ff1c1202bc63
 SHA512:
-  metadata.gz: 1d57f6492a27063b71f6f02d5731a6b4b05f97395f6ec61cfccf0af782544bd1bd0c9c8205338535dc4563c2be15f51745d03a52d51cd02e53d937c99fbba0b3
-  data.tar.gz: 8141acaf0b835f523b75f255a647e615017015aab6e40e2d50bd3ff5a523b74589583964553e1fbe6d959f3234722434757cb7aa9a68cc68381a1a5761b5a493
+  metadata.gz: 372bb4773d316e81a5318e3749a215fec0c3c7c72dd1f363bb3c342775a93be4d82b634943d29e31552a912833ed1b3c4a4291f48acc982a9710cc28f59939b5
+  data.tar.gz: feaf6bcf6955f9eb9941f8f52e572c80a90a5bde285d9ccb3ec3741fad54ad51dec140dc591de041f676d26728a5c2da6b26470ed0da30b21d07b0dbe1fb2d03

data/.github/workflows/ci-master.yml

@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: [2.5, 2.6, 2.7]
-        rails: [5.2, 6.0, 6.1]
+        rails: [5.2, 6.0, 6.1, 7.0]
 
     env:
       RAILS_VERSION: ${{ matrix.rails }}

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: [2.5, 2.6, 2.7]
-        rails: [5.2, 6.0, 6.1]
+        rails: [5.2, 6.0, 6.1, 7.0]
 
     env:
       RAILS_VERSION: ${{ matrix.rails }}

data/CONTRIBUTING.md

@@ -90,6 +90,7 @@ You can also switch to a version of Rails with `RAILS_VERSION`:
 ❯ RAILS_VERSION=5.2 ./spec/bin/run_spec.sh
 ❯ RAILS_VERSION=6.0 ./spec/bin/run_spec.sh
 ❯ RAILS_VERSION=6.1 ./spec/bin/run_spec.sh
+❯ RAILS_VERSION=7.0 ./spec/bin/run_spec.sh
 ```
 
 #### Debugging

data/Gemfile

@@ -25,6 +25,10 @@ when "6.1"
   gem "rails", "~> 6.1.0"
   gem "bundler", ">= 2.0"
   gem "sqlite3", "~> 1.4.1"
+when "7.0"
+  gem "rails", "~> 7.0.0"
+  gem "bundler", ">= 2.0"
+  gem "sqlite3", "~> 1.4.1"
 else
   gem "rails", "~> 6.0.0"
   gem "bundler", ">= 2.0"

data/README.md

@@ -70,7 +70,7 @@ The generation task currently creates the following signatures:
 
 It is possible to add custom RBI generation logic for your custom module or gems via the plugin system. Check out the [plugins section](#extending-model-generation-task-with-custom-plugins) below if you are interested.
 
-We also add following methods to make type-checking more easily:
+We also add following methods to make type-checking easier:
 - [`find_n`, `first_n`, `last_n`](https://github.com/chanzuckerberg/sorbet-rails#find-first-and-last)
 - [`pluck_to_tstruct`](#pluck_to_tstruct-instead-of-pluck)
 - [`typed_enum`](#typed_enum-instead-of-enum)

data/Rakefile

@@ -10,11 +10,37 @@ namespace :update_spec do
 
   desc "Generate Rails apps for all versions."
   task :all do |t, args|
+    Rake::Task['update_spec:v7_0'].invoke
     Rake::Task['update_spec:v6_1'].invoke
     Rake::Task['update_spec:v6_0'].invoke
     Rake::Task['update_spec:v5_2'].invoke
   end
 
+  desc "Delete the Rails 7.0 spec directory and regenerate it."
+  task :v7_0 do |t, args|
+    Bundler.with_clean_env do
+      FileUtils.rm_rf 'spec/support/v7.0' if File.directory?('spec/support/v7.0')
+      system("gem install rails -v 7.0.3")
+      system("rails _7.0.3_ -v")
+      command = [
+        "RAILS_VERSION='7.0'",
+        "rails _7.0.3_ new",
+        "--template spec/generators/rails-template.rb",
+        "spec/support/v7.0",
+        "--skip-action-cable",
+        "--skip-action-text",
+        "--skip-asset-pipeline",
+        "--skip-bootsnap",
+        "--skip-hotwire",
+        "--skip-javascript",
+        "--skip-listen",
+        "--skip-spring",
+        "--skip-test"
+      ].join(" ")
+      system(command)
+    end
+  end
+
   desc "Delete the Rails 6.1 spec directory and regenerate it."
   task :v6_1 do |t, args|
     Bundler.with_clean_env do
@@ -47,7 +73,7 @@ namespace :update_spec do
 
   desc "Update sorbet_test_cases.rb in all the Rails apps in spec/support."
   task :sorbet_test_cases do |t, args|
-    ['v6.1', 'v6.0', 'v5.2'].each do |version|
+    ['v7.0', 'v6.1', 'v6.0', 'v5.2'].each do |version|
       FileUtils.cp("spec/generators/sorbet_test_cases.rb", "spec/support/#{version}/sorbet_test_cases.rb")
     end
   end

data/lib/sorbet-rails/active_record_rbi_formatter.rb

@@ -220,7 +220,7 @@ class SorbetRails::ActiveRecordRbiFormatter
       )
     end
 
-    item_methods = %w(first first! second second! third third! third_to_last third_to_last! second_to_last second_to_last! last last!)
+    item_methods = %w(first first! second second! third third! third_to_last third_to_last! second_to_last second_to_last! last last! take take!)
     item_methods.each do |item_method|
       class_rbi.create_method(
         item_method,

data/lib/sorbet-rails/model_plugins/active_record_querying.rb

@@ -30,6 +30,7 @@ class SorbetRails::ModelPlugins::ActiveRecordQuerying < SorbetRails::ModelPlugin
       :where, :rewhere, :preload, :extract_associated, :eager_load, :includes, :from, :lock, :readonly, :or,
       :having, :create_with, :distinct, :references, :none, :unscope, :optimizer_hints, :merge, :except, :only,
     ]
+
     model_query_relation_methods.each do |method_name|
       add_relation_query_method(
         root,
@@ -77,6 +78,19 @@ class SorbetRails::ModelPlugins::ActiveRecordQuerying < SorbetRails::ModelPlugin
       )
     end
 
+    # https://api.rubyonrails.org/v7.0.0/classes/ActiveRecord/QueryMethods.html#method-i-in_order_of
+    if Rails.version >= "7.0"
+      add_relation_query_method(
+        root,
+        "in_order_of",
+        parameters: [
+          Parameter.new("column", type: "Symbol"),
+          Parameter.new("values", type: "T::Array[T.untyped]")
+        ],
+        builtin_query_method: true,
+      )
+    end
+
     add_relation_query_method(
       root,
       "extending",

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

@@ -55,7 +55,7 @@ module ::ActiveRecord::Enum
   sig { params(definitions: T::Hash[Symbol, T.untyped]).void }
   def _define_enum(definitions)
     ActiveRecordOverrides.instance.store_enum_call(self, definitions)
-    old_enum(definitions)
+    old_enum(**definitions)
   end
 
   sig { params(definitions: T::Hash[Symbol, T.untyped]).void }

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

@@ -26,6 +26,9 @@ namespace :rails_rbi do
 
   desc "Generate rbis for rails routes"
   task :routes, [:root_dir] => :environment do |t, args|
+    # Skip ActionDispatch if not included
+    next unless defined?(ActionDispatch)
+
     all_routes = Rails.application.routes.routes
     require "action_dispatch/routing/inspector"
     inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
@@ -61,6 +64,9 @@ namespace :rails_rbi do
 
   desc "Generate rbis for rails models. Pass models name to regenerate rbi for only the given models."
   task models: :environment do |t, args|
+    # Skip ActiveRecord if not included
+    next unless defined?(ActiveRecord)
+
     SorbetRails::Utils.rails_eager_load_all!
 
     all_models = Set.new(ActiveRecord::Base.descendants + whitelisted_models - blacklisted_models)
@@ -95,6 +101,9 @@ namespace :rails_rbi do
 
   desc "Generate rbis for rails helpers."
   task helpers: :environment do |t, args|
+    # Skip ActionController if not included
+    next unless defined?(ActionController)
+
     SorbetRails::Utils.rails_eager_load_all!
 
     # API controller does not include ActionController::Helpers
@@ -120,6 +129,9 @@ namespace :rails_rbi do
 
   desc "Generate rbis for rails mailers"
   task :mailers, [:root_dir] => :environment do |t, args|
+    # Skip ActiveRecord if not included
+    next unless defined?(ActionMailer)
+
     SorbetRails::Utils.rails_eager_load_all!
     all_mailers = ActionMailer::Base.descendants
 
@@ -138,6 +150,9 @@ namespace :rails_rbi do
 
   desc "Generate rbis for rails mailers"
   task :jobs, [:root_dir] => :environment do |t, args|
+    # Skip ActiveJob if not included
+    next unless defined?(ActiveJob)
+
     SorbetRails::Utils.rails_eager_load_all!
     all_jobs = ActiveJob::Base.descendants
 

data/sorbet-rails.gemspec

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

@@ -5,6 +5,7 @@ wd="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 RAILS_VERSION=5.2 bash $wd/run_spec.sh
 RAILS_VERSION=6.1 bash $wd/run_spec.sh
+RAILS_VERSION=7.0 bash $wd/run_spec.sh
 
 # Always end with the default version, which is Rails 6.0
 bash $wd/run_spec.sh

data/spec/generators/rails-template.rb

@@ -125,12 +125,6 @@ def create_models
     end
   RUBY
 
-  # 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', '6.1'].include?(ENV["RAILS_VERSION"])
-    attachments = "has_one_attached :school_photo\n  has_many_attached :hats"
-  end
-
   file "app/models/wizard.rb", <<~RUBY
     class Wizard < ApplicationRecord
       validates :name, length: { minimum: 5 }, presence: true
@@ -194,7 +188,8 @@ def create_models
       belongs_to :school, optional: true
 
       scope :recent, -> { where('created_at > ?', 1.month.ago) }
-      #{attachments}
+      has_one_attached :school_photo
+      has_many_attached :hats
     end
   RUBY
 

data/spec/rails_helper.rb

@@ -19,6 +19,8 @@ rails_folder =
     "v6.0"
   when "6.1"
     "v6.1"
+  when "7.0"
+    "v7.0"
   else
     "v6.0"
   end

data/spec/rake_rails_rbi_models_spec.rb

@@ -33,7 +33,7 @@ RSpec.describe 'rake rails_rbi:models', type: :task do
         'attachment.rbi',
         'blob.rbi',
       ]
-      if ENV["RAILS_VERSION"] == '6.1'
+      if Rails.gem_version >= Gem::Version.new('6.1.0')
         files += [
           'record.rbi',
           'variant_record.rbi',

data/spec/support/v5.2/sorbet_test_cases.rb

@@ -32,6 +32,8 @@ T.assert_type!(wizard.spell_book_ids, T::Array[Integer])
 # Finder methods -- Model
 T.assert_type!(Wizard.exists?(name: 'Test'), T::Boolean)
 T.assert_type!(Wizard.find(wizard.id), Wizard)
+T.assert_type!(Wizard.take, T.nilable(Wizard))
+T.assert_type!(Wizard.take!, Wizard)
 T.assert_type!(Wizard.first!, Wizard)
 T.assert_type!(Wizard.first, T.nilable(Wizard))
 T.assert_type!(Wizard.second!, Wizard)
@@ -90,6 +92,8 @@ 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)
 T.assert_type!(Wizard.all.find(wizard.id), Wizard)
+T.assert_type!(Wizard.all.take, T.nilable(Wizard))
+T.assert_type!(Wizard.all.take!, Wizard)
 T.assert_type!(Wizard.all.first!, Wizard)
 T.assert_type!(Wizard.all.first, T.nilable(Wizard))
 T.assert_type!(Wizard.all.second!, Wizard)
@@ -161,6 +165,8 @@ spell_book = wizard.spell_books.first!
 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.take, T.nilable(SpellBook))
+T.assert_type!(spell_books.take!, SpellBook)
 T.assert_type!(spell_books.first!, SpellBook)
 T.assert_type!(spell_books.first, T.nilable(SpellBook))
 T.assert_type!(spell_books.second!, SpellBook)
@@ -240,6 +246,8 @@ T.assert_type!(spell_books.push([spell_book]), SpellBook::ActiveRecord_Associati
 spell_books_query = spell_books.where(wizard_id: wizard.id)
 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.take, T.nilable(SpellBook))
+T.assert_type!(spell_books_query.take!, SpellBook)
 T.assert_type!(spell_books_query.first!, SpellBook)
 T.assert_type!(spell_books_query.first, T.nilable(SpellBook))
 T.assert_type!(spell_books_query.second!, SpellBook)

data/spec/support/v6.0/sorbet_test_cases.rb

@@ -32,6 +32,8 @@ T.assert_type!(wizard.spell_book_ids, T::Array[Integer])
 # Finder methods -- Model
 T.assert_type!(Wizard.exists?(name: 'Test'), T::Boolean)
 T.assert_type!(Wizard.find(wizard.id), Wizard)
+T.assert_type!(Wizard.take, T.nilable(Wizard))
+T.assert_type!(Wizard.take!, Wizard)
 T.assert_type!(Wizard.first!, Wizard)
 T.assert_type!(Wizard.first, T.nilable(Wizard))
 T.assert_type!(Wizard.second!, Wizard)
@@ -90,6 +92,8 @@ 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)
 T.assert_type!(Wizard.all.find(wizard.id), Wizard)
+T.assert_type!(Wizard.all.take, T.nilable(Wizard))
+T.assert_type!(Wizard.all.take!, Wizard)
 T.assert_type!(Wizard.all.first!, Wizard)
 T.assert_type!(Wizard.all.first, T.nilable(Wizard))
 T.assert_type!(Wizard.all.second!, Wizard)
@@ -161,6 +165,8 @@ spell_book = wizard.spell_books.first!
 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.take, T.nilable(SpellBook))
+T.assert_type!(spell_books.take!, SpellBook)
 T.assert_type!(spell_books.first!, SpellBook)
 T.assert_type!(spell_books.first, T.nilable(SpellBook))
 T.assert_type!(spell_books.second!, SpellBook)
@@ -240,6 +246,8 @@ T.assert_type!(spell_books.push([spell_book]), SpellBook::ActiveRecord_Associati
 spell_books_query = spell_books.where(wizard_id: wizard.id)
 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.take, T.nilable(SpellBook))
+T.assert_type!(spell_books_query.take!, SpellBook)
 T.assert_type!(spell_books_query.first!, SpellBook)
 T.assert_type!(spell_books_query.first, T.nilable(SpellBook))
 T.assert_type!(spell_books_query.second!, SpellBook)

data/spec/support/v6.1/sorbet_test_cases.rb

@@ -32,6 +32,8 @@ T.assert_type!(wizard.spell_book_ids, T::Array[Integer])
 # Finder methods -- Model
 T.assert_type!(Wizard.exists?(name: 'Test'), T::Boolean)
 T.assert_type!(Wizard.find(wizard.id), Wizard)
+T.assert_type!(Wizard.take, T.nilable(Wizard))
+T.assert_type!(Wizard.take!, Wizard)
 T.assert_type!(Wizard.first!, Wizard)
 T.assert_type!(Wizard.first, T.nilable(Wizard))
 T.assert_type!(Wizard.second!, Wizard)
@@ -91,6 +93,8 @@ T.assert_type!(Wizard.where_missing(:wand), Wizard::ActiveRecord_Relation)
 # 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.take, T.nilable(Wizard))
+T.assert_type!(Wizard.all.take!, Wizard)
 T.assert_type!(Wizard.all.first!, Wizard)
 T.assert_type!(Wizard.all.first, T.nilable(Wizard))
 T.assert_type!(Wizard.all.second!, Wizard)
@@ -163,6 +167,8 @@ spell_book = wizard.spell_books.first!
 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.take, T.nilable(SpellBook))
+T.assert_type!(spell_books.take!, SpellBook)
 T.assert_type!(spell_books.first!, SpellBook)
 T.assert_type!(spell_books.first, T.nilable(SpellBook))
 T.assert_type!(spell_books.second!, SpellBook)
@@ -243,6 +249,8 @@ T.assert_type!(spell_books.push([spell_book]), SpellBook::ActiveRecord_Associati
 spell_books_query = spell_books.where(wizard_id: wizard.id)
 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.take, T.nilable(SpellBook))
+T.assert_type!(spell_books_query.take!, SpellBook)
 T.assert_type!(spell_books_query.first!, SpellBook)
 T.assert_type!(spell_books_query.first, T.nilable(SpellBook))
 T.assert_type!(spell_books_query.second!, SpellBook)

data/spec/support/v7.0/.gitattributes

@@ -0,0 +1,7 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored

data/spec/support/v7.0/.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+/public/assets
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/spec/support/v7.0/Gemfile

@@ -0,0 +1,48 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby "3.0.1"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.0.3"
+
+# Use sqlite3 as the database for Active Record
+gem "sqlite3", "~> 1.4"
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", "~> 5.0"
+
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem "jbuilder"
+
+# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
+# gem "kredis"
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri mingw x64_mingw ]
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+
+  # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
+  # gem "rack-mini-profiler"
+
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end
+
+gem "sorbet-rails", path: "../../../."
+gem "sorbet"
+gem "sorbet-runtime"