sorbet-rails 0.7.31 → 0.7.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c8486bf0c5537443c859e1f51c4aebd3e62bd16370f78526a4f2e879b148c81
-  data.tar.gz: ffd9da9622e74e186ae94eb9547da174df0e86e294373b06bbdf4caf4d71736f
+  metadata.gz: d6ae993b835bd73f18fd64cacdf0fb9f3ba8e44d8ad42cb59fa103d1f2d8a481
+  data.tar.gz: d47b11ca70a73985bd8e811f56fee3394960c063b8e1850470f5ff1c1202bc63
 SHA512:
-  metadata.gz: e9b9d08940d9c0c82984326439fd8c310955e6c3c59a1b6ed01c46c5ab05ca71680e9627f0bef456942ad2c08430d216ad969a0506c2478c0fec5863a3bb3d32
-  data.tar.gz: 82f9e89b908de82b1a63f02f60cef7aea5ded0108c2717b3e3aa1ee0ac2ee534476327fb5483a155d98d95f9f35640534ce133a2b017daf31797844725a91138
+  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/.github/workflows/publish-gem.yml

@@ -1,27 +1,17 @@
 name: publish-gem
 
 on:
-  # pull_request: # test with pull request
-  push:
-    branches: # Trigger only on the main branch to avoid duplicate runs on PR branches
-      - master
+  workflow_dispatch:
 
 jobs:
   build:
     runs-on: ubuntu-latest
-
-    env:
-      RAILS_VERSION: 6.0
-
     steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-        # bundler-cache: true -- this messes up some dynamic constants
-    - run: "./spec/bin/run_spec.sh"
-    - run: bundle exec srb tc
-    - name: Release Gem
-      uses: dawidd6/action-publish-gem@v1
-      with:
-        api_key: ${{secrets.RUBYGEMS_API_KEY}}
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Release Gem
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{secrets.RUBYGEMS_API_KEY}}

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

@@ -9,8 +9,6 @@ This gem adds a few Rake tasks to generate Ruby Interface (RBI) files for dynami
 
 `sorbet-rails` supports Rails 5+ or later.
 
-**Notice**: we automatically creates a new release on Rubygems with every merges to the master branch
-
 **Notice**: we no longer support Rails 4.2. [Version 0.5.6](https://github.com/chanzuckerberg/sorbet-rails/releases/tag/v0.5.6) is the last version supporting Rails 4.2.
 
 ## Initial Setup
@@ -72,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)
@@ -287,6 +285,7 @@ specific environment group (eg. `development` only).
 
 - Model: The gem provides some helper method to a model to make type-checking easier:
   - `find_n`, `first_n`, `last_n`
+  - `where_missing`
   - `pluck_to_tstruct`
   - `typed_enum`
 
@@ -455,6 +454,18 @@ If you run into the following issue when running rspec, it's likely because you'
        if you're really stuck.
 ```
 
+### `where.missing` does not exist on `ActiveRecord::Relation`  ###
+
+The [`where` method](https://apidock.com/rails/ActiveRecord/QueryMethods/where) in Rails has two modes: it can be passed no arguments where it will return an `ActiveRecord::QueryMethods::WhereChain` object, or when given arguments, returns an `ActiveRecord::Relation` object. By default we've opted to support `where` with arguments and have provided a `where_missing` method to avoid conflicts during static typing.
+
+```
+Wizard.where.missing(:wand) # sorbet error, use `where_missing` instead
+
+Wizard.where_missing(:wand) # valid, returns a relation
+```
+
+**Note:** `where.missing` / `where_missing` are only available in Rails 6.1 or above
+
 ## Extending RBI Generation logic
 
 ### Extending Model Generation Task with Custom Plugins

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

@@ -40,7 +40,7 @@ class SorbetRails::ActiveRecordRbiFormatter
       class_rbi.create_include("Enumerable")
       # class_rbi.create_constant(
       #   "Elem",
-      #   value: "type_member(fixed: T.untyped)",
+      #   value: "type_member {{fixed: T.untyped}}",
       # )
 
       create_elem_specific_query_methods(class_rbi, type: 'Elem', class_method: false)
@@ -75,7 +75,7 @@ class SorbetRails::ActiveRecordRbiFormatter
     parlour.root.create_class("ActiveRecord::AssociationRelation", superclass: "ActiveRecord::Relation") do |class_rbi|
       class_rbi.create_constant(
         "Elem",
-        value: "type_member(fixed: T.untyped)",
+        value: "type_member {{fixed: T.untyped}}",
       )
 
       # Ideally we shouldn't need to define these since this class inherits from
@@ -110,7 +110,7 @@ class SorbetRails::ActiveRecordRbiFormatter
     parlour.root.create_class("ActiveRecord::Associations::CollectionProxy", superclass: "ActiveRecord::Relation") do |class_rbi|
       class_rbi.create_constant(
         "Elem",
-        value: "type_member(fixed: T.untyped)",
+        value: "type_member {{fixed: T.untyped}}",
       )
 
       # This _should_ work which would let us remove it from the enumerable_collections
@@ -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,
@@ -64,6 +65,32 @@ class SorbetRails::ModelPlugins::ActiveRecordQuerying < SorbetRails::ModelPlugin
       )
     end
 
+    # https://api.rubyonrails.org/v6.1.4/classes/ActiveRecord/QueryMethods/WhereChain.html#method-i-missing
+    # where.missing is only available in Rails 6.1 and above
+    if Rails.version >= "6.1"
+      add_relation_query_method(
+        root,
+        "where_missing", # where_missing is injected by sorbet-rails
+        parameters: [
+          Parameter.new("*args", type: "Symbol"),
+        ],
+        builtin_query_method: true,
+      )
+    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/model_rbi_formatter.rb

@@ -80,7 +80,7 @@ class SorbetRails::ModelRbiFormatter
     model_relation_rbi.create_include(self.model_query_methods_returning_relation_module_name)
     model_relation_rbi.create_constant(
       "Elem",
-      value: "type_member(fixed: #{model_class_name})",
+      value: "type_member {{fixed: #{model_class_name}}}",
     )
 
     model_assoc_relation_rbi = root.create_class(
@@ -90,7 +90,7 @@ class SorbetRails::ModelRbiFormatter
     model_assoc_relation_rbi.create_include(self.model_query_methods_returning_assoc_relation_module_name)
     model_assoc_relation_rbi.create_constant(
       "Elem",
-      value: "type_member(fixed: #{model_class_name})",
+      value: "type_member {{fixed: #{model_class_name}}}",
     )
 
     collection_proxy_rbi = root.create_class(
@@ -100,7 +100,7 @@ class SorbetRails::ModelRbiFormatter
     collection_proxy_rbi.create_include(self.model_query_methods_returning_assoc_relation_module_name)
     collection_proxy_rbi.create_constant(
       "Elem",
-      value: "type_member(fixed: #{self.model_class_name})",
+      value: "type_member {{fixed: #{self.model_class_name}}}",
     )
 
     model_rbi = root.create_class(

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/rails_mixins/custom_finder_methods.rb

@@ -26,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/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.#{ENV['GITHUB_RUN_NUMBER'] || 100}".strip
+  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"]
@@ -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'

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/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

@@ -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',