sorbet-rails 0.7.3 → 0.7.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04e15a0b91862375e9b3f853928e0f46a3c44e6176cb10ecb813a337ac50a45a
-  data.tar.gz: e6a5b10b3ac40664e0dce8a51c80795d8fd2e0c7ef4cc665c6ad169d6cd3f0dc
+  metadata.gz: 46916b2838ddb2a8dbbbc8e7ddbaa6a01daa7c7d6be081cb26661ac23f314ffc
+  data.tar.gz: 9dbc6e5beedbf770274f2a0ef21a422579f80d1c27d14dea882109167e05acc7
 SHA512:
-  metadata.gz: 3b3bddd29abcb7d6496ece148526fc204c9a7e2bd51f54a264d526e3c10bcacafe6118a49e9ad9c36f6edb9927fe80cd31de28ce4ddda035811f5d15520e2599
-  data.tar.gz: '05249019b6251b14ab95a71599c666710478c8468702546c0619ff9111021447d246ea47bc9f62bb038e04616e6b306647b4c669315ff59672b93a1682e6eb39'
+  metadata.gz: 44e3a47dd6a57252cb1df2db05fd7c7717e9409e8739f9e8e9040092a3f1400390ed9de1cfd142f7efa79272718c1726ea73948787d458e8b3b7daf581d6de5c
+  data.tar.gz: ef8f746a76f3cda2bf5e83a0e94c6927487ce45d8ca3e8adc2cba42c0811d06ffeef44f6a6c09806ca659381c4c4b4f0adcde01c42f4375a45700331a1dde66e

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,28 @@
+name: ci-master
+
+on:
+  push:
+    branches: # Trigger only on the main branch to avoid duplicate runs on PR branches
+      - master
+
+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 }}
+      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/publish-gem.yml

@@ -0,0 +1,18 @@
+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
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - 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.
@@ -9,6 +9,8 @@ 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
@@ -43,8 +45,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 +208,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
@@ -311,7 +313,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:
 
@@ -522,6 +524,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 +539,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)
@@ -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::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