sorbet-rails 0.7.3 → 0.7.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04e15a0b91862375e9b3f853928e0f46a3c44e6176cb10ecb813a337ac50a45a
-  data.tar.gz: e6a5b10b3ac40664e0dce8a51c80795d8fd2e0c7ef4cc665c6ad169d6cd3f0dc
+  metadata.gz: c85a4b2dec82b9ff5e78fd20ca40964639474ae84d03641f4d7a2f2ee7afe1ae
+  data.tar.gz: 62fd90904255f58f2c494a51c170077e347b0746b426717829514aa38df79b48
 SHA512:
-  metadata.gz: 3b3bddd29abcb7d6496ece148526fc204c9a7e2bd51f54a264d526e3c10bcacafe6118a49e9ad9c36f6edb9927fe80cd31de28ce4ddda035811f5d15520e2599
-  data.tar.gz: '05249019b6251b14ab95a71599c666710478c8468702546c0619ff9111021447d246ea47bc9f62bb038e04616e6b306647b4c669315ff59672b93a1682e6eb39'
+  metadata.gz: 1d57f6492a27063b71f6f02d5731a6b4b05f97395f6ec61cfccf0af782544bd1bd0c9c8205338535dc4563c2be15f51745d03a52d51cd02e53d937c99fbba0b3
+  data.tar.gz: 8141acaf0b835f523b75f255a647e615017015aab6e40e2d50bd3ff5a523b74589583964553e1fbe6d959f3234722434757cb7aa9a68cc68381a1a5761b5a493

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    # Files stored in repository root
+    directory: "/"
+    schedule:
+      interval: "daily"

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

@@ -0,0 +1,30 @@
+name: ci-master
+
+on:
+  push:
+    branches: # Trigger only on the main branch to avoid duplicate runs on PR branches
+      - master
+  schedule: # trigger once a week to ensure that CI works even after dependent gem updates
+    - cron: 0 0 * * 1
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+        rails: [5.2, 6.0, 6.1]
+
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+      CI: true
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        # bundler-cache: true -- this messes up some dynamic constants
+    - run: "./spec/bin/run_spec.sh"

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: ci
+
+on:
+  pull_request: # Trigger All PRs
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+        rails: [5.2, 6.0, 6.1]
+
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        # bundler-cache: true -- this messes up some dynamic constants
+    - run: "./spec/bin/run_spec.sh"
+    - run: bundle exec srb tc

data/.github/workflows/publish-gem.yml

@@ -0,0 +1,17 @@
+name: publish-gem
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - 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

@@ -87,10 +87,9 @@ To run the tests against all supported Rails branches, use:
 You can also switch to a version of Rails with `RAILS_VERSION`:
 
 ```sh
-❯ RAILS_VERSION=5.0 ./spec/bin/run_spec.sh
-❯ RAILS_VERSION=5.1 ./spec/bin/run_spec.sh
 ❯ 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
 ```
 
 #### Debugging

data/Gemfile

@@ -13,14 +13,6 @@ case rails_version
 when "master"
   gem "rails", {github: "rails/rails"}
   gem "bundler", ">= 1.3.0"
-when "5.0"
-  gem "rails", "~> 5.0.7"
-  gem "bundler", ">= 2.0"
-  gem "sqlite3", "~> 1.3.6"
-when "5.1"
-  gem "rails", "~> 5.1.7"
-  gem "bundler", ">= 2.0"
-  gem "sqlite3", "~> 1.4.1"
 when "5.2"
   gem "rails", "~> 5.2.3"
   gem "bundler", ">= 2.0"
@@ -29,8 +21,12 @@ when "6.0"
   gem "rails", "~> 6.0.0"
   gem "bundler", ">= 2.0"
   gem "sqlite3", "~> 1.4.1"
+when "6.1"
+  gem "rails", "~> 6.1.0"
+  gem "bundler", ">= 2.0"
+  gem "sqlite3", "~> 1.4.1"
 else
-  gem "rails", "~> 5.2.3"
+  gem "rails", "~> 6.0.0"
   gem "bundler", ">= 2.0"
   gem "sqlite3", "~> 1.4.1"
 end

data/README.md

@@ -1,6 +1,6 @@
 # sorbet-rails
 [![Gem Version](https://badge.fury.io/rb/sorbet-rails.svg)](https://badge.fury.io/rb/sorbet-rails)
-[![Build Status](https://travis-ci.com/chanzuckerberg/sorbet-rails.svg?branch=master)](https://travis-ci.com/chanzuckerberg/sorbet-rails)
+[![Build Status](https://github.com/chanzuckerberg/sorbet-rails/actions/workflows/ci-master.yml/badge.svg)](https://github.com/chanzuckerberg/sorbet-rails)
 [![codecov](https://codecov.io/gh/chanzuckerberg/sorbet-rails/branch/master/graph/badge.svg)](https://codecov.io/gh/chanzuckerberg/sorbet-rails)
 
 A set of tools to make the [Sorbet](https://sorbet.org) typechecker work with Ruby on Rails seamlessly.
@@ -43,8 +43,8 @@ Add `sorbet-rails` to the [`:default` group](https://bundler.io/v2.0/guides/grou
 
 4. Update hidden-definition files and automatically upgrade each file's typecheck level:
 ```sh
-❯ srb rbi hidden-definitions
-❯ srb rbi suggest-typed
+❯ bundle exec srb rbi hidden-definitions
+❯ bundle exec srb rbi suggest-typed
 ```
 Because we've generated RBI files for routes, models, and helpers, a lot more files should be typecheckable now. Many methods in `hidden.rbi` may be removed because they are now typed.
 
@@ -206,7 +206,7 @@ end
 ❯ bundle exec  rake rails_rbi:custom
 ```
 
-`sorbet-rails` adds `TypedParams` to extact typed controller parameters.
+`sorbet-rails` adds `TypedParams` to extract typed controller parameters.
 
 TypedParams takes a parameter definition, which is a subclass of `T::Struct` and coerces the `params` object into an instance of that subclass using [sorbet-coerce](https://github.com/chanzuckerberg/sorbet-coerce):
 ```ruby
@@ -285,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`
 
@@ -311,7 +312,7 @@ It is worth going through the list of files that is ignored and resolve them (an
 
 ### Overriding generated signatures if needed
 
-`sorbet-rails` relies on Rails reflection to generate signatures. There are features this gem doesn't support yet such as [serialize](https://github.com/chanzuckerberg/sorbet-rails/issues/49) and [attribute custom types](https://github.com/chanzuckerberg/sorbet-rails/issues/16). The gem also doesn't know the signature of any methods you have overridden. However, it is possible to override the signatures that `sorbet-rails` generates.
+`sorbet-rails` relies on Rails reflection to generate signatures. There are features this gem doesn't support yet such as [attribute custom types](https://github.com/chanzuckerberg/sorbet-rails/issues/16). The gem also doesn't know the signature of any methods you have overridden. However, it is possible to override the signatures that `sorbet-rails` generates.
 
 For example, here is how to override the signature for a method in a model:
 
@@ -363,6 +364,7 @@ Following are the list of attribute dynamic methods and their static counterpart
 - `<attribute>_was` -> `attribute_was(<attribute>)`
 - `saved_change_to_<attribute>?` -> `saved_change_to_attribute?(<attribute>)`
 - `<attribute>_before_type_cast` -> `read_attribute_before_type_cast(<attribute>)`
+- `will_save_change_to_<attribute>?` -> `will_save_change_to_attribute?(<attribute>)`
 
 ### `after_commit` and other callbacks
 
@@ -409,8 +411,16 @@ Model.unscoped.scoping do … end
 
 ### `select` with a block
 
-The [`select` method](https://apidock.com/rails/v4.0.2/ActiveRecord/QueryMethods/select) in Rails has two modes: it can be given a list of symbols, in which case rails will only return the given columns from the database, or it can be given a block, in which case it acts like [`Enumerable.select`](https://ruby-doc.org/core-2.6.4/Enumerable.html) and returns an array. We have chosen to support the first use case. If you want to pass a block to `select`, you can simply call `to_a` before you do. Note that this would be done within the `select` call anyway, so the performance penalty will be minimal.
+The [`select` method](https://apidock.com/rails/v4.0.2/ActiveRecord/QueryMethods/select) in Rails has two modes: it can be given a list of symbols, in which case rails will only return the given columns from the database, or it can be given a block, in which case it acts like [`Enumerable.select`](https://ruby-doc.org/core-2.6.4/Enumerable.html) and returns an array.
 
+We have chosen to support `select` with a block as the primary use case, since it is a more prevalent use of this method. We provide `select_columns` as an alternative if you want to select a list of columns.
+
+```
+Model.select { |record| record.id > 1} # valid, returns an array
+Model.select_columns(:id, :name) # valid, returns an association
+
+Model.select(:id, :name) # sorbet error, use `select_column` instead
+```
 ### `flatten` an array of relation
 
 When you call `flatten` on an array of ActiveRecord::Relation, sorbet [doesn't recognize](https://github.com/sorbet/sorbet/issues/2767) that it will flatten the relation and return an array of model. The work around is to call `to_a` on the relation first.
@@ -423,6 +433,14 @@ arr = [Model.recent, Model.old].flatten # T::Array[Model::ActiveRecord_Relation]
 arr = [Model.recent, Model.old].map(&:to_a).flatten # T::Array[Model]
 ```
 
+`flat_map` has a similar issue.
+
+```ruby
+foo.bars.flat_map { |b| b.scope } # T::Array[T.untyped]
+
+foo.bars.flat_map { |b| b.scope.to_a } # T::Array[Scope]
+```
+
 ### Avoid `and_call_original` in rspecs
 
 If you run into the following issue when running rspec, it's likely because you're using `expect(:method_name).and_call_original` to mock a method in RSpec. We've found the double mock doesn't interact well with Sorbet's sig wrapper and caused flaky spec. The spec should be rewritten to expect the outcome of the method instead. (It still works with `expect(:method_name)` and `expect(:method_name).and_return(...)`
@@ -436,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
@@ -522,6 +552,10 @@ These are the currently-supported gems and their symbolized names:
 | [Shrine]     | `:shrine`      |
 | [active_flag]| `:active_flag` |
 | [Paperclip]  | `:paperclip` |
+| [AttrJson]  | `:attr_json` |
+| [FlagShihTzu]  | `:flag_shih_tzu` |
+| [AASM]  | `:aasm` |
+| [Money-Rails]  | `:money_rails` |
 
 You can also configure the core model plugins if needed. The default plugins are defined in the [config](https://github.com/chanzuckerberg/sorbet-rails/blob/master/lib/sorbet-rails/config.rb). For the full list of plugin symbols, check out [here](https://github.com/chanzuckerberg/sorbet-rails/blob/master/lib/sorbet-rails/model_plugins/plugins.rb).
 
@@ -533,6 +567,10 @@ You can also configure the core model plugins if needed. The default plugins are
 [Shrine]: https://github.com/shrinerb/shrine
 [active_flag]: https://github.com/kenn/active_flag
 [Paperclip]: https://github.com/thoughtbot/paperclip
+[AttrJson]: https://github.com/jrochkind/attr_json
+[FlagShihTzu]: https://github.com/pboling/flag_shih_tzu
+[AASM]: https://github.com/aasm/aasm
+[Money-Rails]: https://github.com/RubyMoney/money-rails
 
 ### Customize Generation Class
 

data/Rakefile

@@ -10,13 +10,22 @@ namespace :update_spec do
 
   desc "Generate Rails apps for all versions."
   task :all do |t, args|
+    Rake::Task['update_spec:v6_1'].invoke
     Rake::Task['update_spec:v6_0'].invoke
     Rake::Task['update_spec:v5_2'].invoke
-    Rake::Task['update_spec:v5_1'].invoke
-    Rake::Task['update_spec:v5_0'].invoke
   end
 
-  desc "Delete the Rails 6 spec directory and regenerate it."
+  desc "Delete the Rails 6.1 spec directory and regenerate it."
+  task :v6_1 do |t, args|
+    Bundler.with_clean_env do
+      FileUtils.rm_rf 'spec/support/v6.1' if File.directory?('spec/support/v6.1')
+      system("gem install rails -v 6.1.4")
+      system("rails _6.1.4_ -v")
+      system("RAILS_VERSION='6.1' rails _6.1.4_ new --template spec/generators/rails-template.rb spec/support/v6.0 --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-bootsnap --skip-listen")
+    end
+  end
+
+  desc "Delete the Rails 6.0 spec directory and regenerate it."
   task :v6_0 do |t, args|
     Bundler.with_clean_env do
       FileUtils.rm_rf 'spec/support/v6.0' if File.directory?('spec/support/v6.0')
@@ -36,29 +45,9 @@ namespace :update_spec do
     end
   end
 
-  desc "Delete the Rails 5.1 spec directory and regenerate it."
-  task :v5_1 do |t, args|
-    Bundler.with_clean_env do
-      FileUtils.rm_rf 'spec/support/v5.1' if File.directory?('spec/support/v5.1')
-      system("gem install rails -v 5.1.7")
-      system("rails _5.1.7_ -v")
-      system("RAILS_VERSION='5.1' rails _5.1.7_ new --template spec/generators/rails-template.rb spec/support/v5.1 --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-listen")
-    end
-  end
-
-  desc "Delete the Rails 5.0 spec directory and regenerate it."
-  task :v5_0 do |t, args|
-    Bundler.with_clean_env do
-      FileUtils.rm_rf 'spec/support/v5.0' if File.directory?('spec/support/v5.0')
-      system("gem install rails -v 5.0.7")
-      system("rails _5.0.7_ -v")
-      system("RAILS_VERSION='5.0' rails _5.0.7_ new --template spec/generators/rails-template.rb spec/support/v5.0 --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-listen")
-    end
-  end
-
   desc "Update sorbet_test_cases.rb in all the Rails apps in spec/support."
   task :sorbet_test_cases do |t, args|
-    ['v6.0', 'v5.2', 'v5.1', 'v5.0'].each do |version|
+    ['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

@@ -38,10 +38,10 @@ class SorbetRails::ActiveRecordRbiFormatter
 
     parlour.root.create_class('ActiveRecord::Relation') do |class_rbi|
       class_rbi.create_include("Enumerable")
-      class_rbi.create_constant(
-        "Elem",
-        value: "type_member(fixed: T.untyped)",
-      )
+      # class_rbi.create_constant(
+      #   "Elem",
+      #   value: "type_member {{fixed: T.untyped}}",
+      # )
 
       create_elem_specific_query_methods(class_rbi, type: 'Elem', class_method: false)
       create_general_query_methods(class_rbi, 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
@@ -273,6 +273,18 @@ class SorbetRails::ActiveRecordRbiFormatter
         class_method: class_method,
       )
     end
+
+    boolean_methods = %w(any? many? none? one?)
+    boolean_methods.each do |boolean_method|
+      class_rbi.create_method(
+        boolean_method,
+        parameters: [
+          Parameter.new("&block", type: "T.nilable(T.proc.params(e: #{type}).returns(T.nilable(T::Boolean)))"),
+        ],
+        return_type: "T::Boolean",
+        class_method: class_method,
+      )
+    end
   end
 
   sig {
@@ -288,14 +300,5 @@ class SorbetRails::ActiveRecordRbiFormatter
       return_type: "T::Boolean",
       class_method: class_method,
     )
-
-    boolean_methods = %w(any? many? none? one?)
-    boolean_methods.each do |boolean_method|
-      class_rbi.create_method(
-        boolean_method,
-        return_type: "T::Boolean",
-        class_method: class_method,
-      )
-    end
   end
 end

data/lib/sorbet-rails/dependent_gem_rbis/activerecord.rbi

@@ -42,3 +42,7 @@ module ActiveModel::Validations
     def validators_on(*attributes); end
   end
 end
+
+class ActiveRecord::Type::Serialized
+  def coder; end
+end