sorbet-rails 0.7.27 → 0.7.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e80eb4263d607a23eec096f9751339d944226b2feb2c1bc52ece8d2b7531128
-  data.tar.gz: df11889efd6ebcddc194293ba868e80d9a2b1e88d4783d10aeb954a99a1e1422
+  metadata.gz: c85a4b2dec82b9ff5e78fd20ca40964639474ae84d03641f4d7a2f2ee7afe1ae
+  data.tar.gz: 62fd90904255f58f2c494a51c170077e347b0746b426717829514aa38df79b48
 SHA512:
-  metadata.gz: 04f2af9fb19e21bf584686158e874a33553551226e5c926d497f8c981199226a63d80f46e8b6badba42e6198508bb593a89d8a619849c4d71319c858dfea01ed
-  data.tar.gz: 0e14167c972be954efa22d1955dbb36938a73199f094c698a69759727eb95961b0a46e31a1a2b6d3bd3d9bb07cc60f3f16a755ae4c08e80f25f08fa2f4d713b8
+  metadata.gz: 1d57f6492a27063b71f6f02d5731a6b4b05f97395f6ec61cfccf0af782544bd1bd0c9c8205338535dc4563c2be15f51745d03a52d51cd02e53d937c99fbba0b3
+  data.tar.gz: 8141acaf0b835f523b75f255a647e615017015aab6e40e2d50bd3ff5a523b74589583964553e1fbe6d959f3234722434757cb7aa9a68cc68381a1a5761b5a493

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

@@ -4,6 +4,8 @@ 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:

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/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
@@ -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`
 
@@ -365,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
 
@@ -454,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/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

data/lib/sorbet-rails/gem_plugins/aasm_plugin.rb

@@ -38,13 +38,18 @@ class AasmPlugin < SorbetRails::ModelPlugins::Base
       )
     end
 
-    # - If you have a state like :baz, you get these methods:
-    # - `baz?`
+    # - If you have a state like :baz, you get:
+    # - a method `baz?`
+    # - a constant `STATE_BAZ`
     aasm_states.each do |state|
       model_rbi.create_method(
         "#{state}?",
         return_type: 'T::Boolean'
       )
+
+      root.create_module(
+        "#{model_class_name}::STATE_#{state.to_s.upcase}"
+      )
     end
   end
 end

data/lib/sorbet-rails/model_column_utils.rb

@@ -17,7 +17,7 @@ module SorbetRails::ModelColumnUtils
       type = base_type.to_s
       # A nullable array column should be T.nilable(T::Array[column_type]) not T::Array[T.nilable(column_type)]
       type = "T::Array[#{type}]" if array_type
-      type = "T.nilable(#{type})" if nilable
+      type = "T.nilable(#{type})" if nilable && type != "T.untyped"
       type
     end
   end

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

@@ -34,7 +34,7 @@ class SorbetRails::ModelPlugins::ActiveRecordAssoc < SorbetRails::ModelPlugins::
   def populate_single_assoc_getter_setter(assoc_module_rbi, assoc_name, reflection)
     # TODO allow people to specify the possible values of polymorphic associations
     assoc_class = assoc_should_be_untyped?(reflection) ? "T.untyped" : "::#{reflection.klass.name}"
-    assoc_type = (belongs_to_and_required?(reflection) || has_one_and_required?(reflection)) ? assoc_class : "T.nilable(#{assoc_class})"
+    assoc_type = (belongs_to_and_required?(reflection) || has_one_and_required?(reflection) || assoc_class == "T.untyped") ? assoc_class : "T.nilable(#{assoc_class})"
 
     params = [
       Parameter.new("*args", type: "T.untyped"),

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

@@ -64,6 +64,19 @@ 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
+
     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/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/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.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'

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

data/spec/support/v5.2/Gemfile.lock

@@ -1,53 +1,53 @@
 PATH
   remote: ../../..
   specs:
-    sorbet-rails (0.7.100)
+    sorbet-rails (0.7.32)
       method_source (>= 0.9.2)
       parlour (>= 4.0.1)
       parser (>= 2.7)
       sorbet-coerce (>= 0.2.6)
-      sorbet-runtime (>= 0.5)
+      sorbet-runtime (>= 0.5.9892)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.6)
-      actionpack (= 5.2.6)
+    actioncable (5.2.7)
+      actionpack (= 5.2.7)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.6)
-      actionpack (= 5.2.6)
-      actionview (= 5.2.6)
-      activejob (= 5.2.6)
+    actionmailer (5.2.7)
+      actionpack (= 5.2.7)
+      actionview (= 5.2.7)
+      activejob (= 5.2.7)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.6)
-      actionview (= 5.2.6)
-      activesupport (= 5.2.6)
+    actionpack (5.2.7)
+      actionview (= 5.2.7)
+      activesupport (= 5.2.7)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.6)
-      activesupport (= 5.2.6)
+    actionview (5.2.7)
+      activesupport (= 5.2.7)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.6)
-      activesupport (= 5.2.6)
+    activejob (5.2.7)
+      activesupport (= 5.2.7)
       globalid (>= 0.3.6)
-    activemodel (5.2.6)
-      activesupport (= 5.2.6)
-    activerecord (5.2.6)
-      activemodel (= 5.2.6)
-      activesupport (= 5.2.6)
+    activemodel (5.2.7)
+      activesupport (= 5.2.7)
+    activerecord (5.2.7)
+      activemodel (= 5.2.7)
+      activesupport (= 5.2.7)
       arel (>= 9.0)
-    activestorage (5.2.6)
-      actionpack (= 5.2.6)
-      activerecord (= 5.2.6)
+    activestorage (5.2.7)
+      actionpack (= 5.2.7)
+      activerecord (= 5.2.7)
       marcel (~> 1.0.0)
-    activesupport (5.2.6)
+    activesupport (5.2.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -59,89 +59,98 @@ GEM
     byebug (11.1.3)
     commander (4.6.0)
       highline (~> 2.0.0)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
     highline (2.0.3)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jbuilder (2.11.2)
+    jbuilder (2.11.5)
+      actionview (>= 5.0.0)
       activesupport (>= 5.0.0)
-    loofah (2.10.0)
+    loofah (2.16.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.1)
+    marcel (1.0.2)
     method_source (1.0.0)
-    mini_mime (1.1.0)
-    mini_portile2 (2.5.3)
-    minitest (5.14.4)
-    nio4r (2.5.7)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.4)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.11.7-x86_64-darwin)
+    nokogiri (1.13.4-x86_64-darwin)
       racc (~> 1.4)
-    parlour (6.0.1)
+    parlour (7.0.0)
       commander (~> 4.5)
       parser
       rainbow (~> 3.0)
       sorbet-runtime (>= 0.5)
-    parser (3.0.2.0)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     polyfill (1.9.0)
     puma (3.12.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.6)
-      actioncable (= 5.2.6)
-      actionmailer (= 5.2.6)
-      actionpack (= 5.2.6)
-      actionview (= 5.2.6)
-      activejob (= 5.2.6)
-      activemodel (= 5.2.6)
-      activerecord (= 5.2.6)
-      activestorage (= 5.2.6)
-      activesupport (= 5.2.6)
+    rails (5.2.7)
+      actioncable (= 5.2.7)
+      actionmailer (= 5.2.7)
+      actionpack (= 5.2.7)
+      actionview (= 5.2.7)
+      activejob (= 5.2.7)
+      activemodel (= 5.2.7)
+      activerecord (= 5.2.7)
+      activestorage (= 5.2.7)
+      activesupport (= 5.2.7)
       bundler (>= 1.3.0)
-      railties (= 5.2.6)
+      railties (= 5.2.7)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (5.2.6)
-      actionpack (= 5.2.6)
-      activesupport (= 5.2.6)
+    railties (5.2.7)
+      actionpack (= 5.2.7)
+      activesupport (= 5.2.7)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
     safe_type (1.1.1)
-    sorbet (0.5.6519)
-      sorbet-static (= 0.5.6519)
+    sorbet (0.5.9892)
+      sorbet-static (= 0.5.9892)
     sorbet-coerce (0.5.0)
       polyfill (~> 1.8)
       safe_type (~> 1.1, >= 1.1.1)
       sorbet-runtime (>= 0.4.4704)
-    sorbet-runtime (0.5.6519)
-    sorbet-static (0.5.6519-universal-darwin-20)
-    sprockets (4.0.2)
+    sorbet-runtime (0.5.9892)
+    sorbet-static (0.5.9892-universal-darwin-14)
+    sorbet-static (0.5.9892-universal-darwin-15)
+    sorbet-static (0.5.9892-universal-darwin-16)
+    sorbet-static (0.5.9892-universal-darwin-17)
+    sorbet-static (0.5.9892-universal-darwin-18)
+    sorbet-static (0.5.9892-universal-darwin-19)
+    sorbet-static (0.5.9892-universal-darwin-20)
+    sorbet-static (0.5.9892-universal-darwin-21)
+    sorbet-static (0.5.9892-x86_64-linux)
+    sprockets (4.0.3)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
-    thor (1.1.0)
+    thor (1.2.1)
     thread_safe (0.3.6)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
@@ -171,4 +180,4 @@ DEPENDENCIES
   web-console (>= 3.3.0)
 
 BUNDLED WITH
-   2.2.24
+   2.2.32