sorbet-rails 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b140547379c65a11d38f65b8f1947e8d14e904e17a45d3a47d00898414cfecc
-  data.tar.gz: 491a878f313376278994b35ae9a1fd2a62408be09572167f92d4ea822da54562
+  metadata.gz: dfa9a71f1119781cfb7095483dbbbab875f51f5562c475d77d38aabe1d97267f
+  data.tar.gz: 80d6b0e7cc740a65db4678213bd6f1e6d34a81852a516854afedd0ad407e5866
 SHA512:
-  metadata.gz: ffa8138e362bb2b8799826fc14b39cc2bd0e213e56e9aa2e783e476cd1d92b84561be6844bf2cca573339f432815fa9d95ba3aef3d88fbba78d226d3edf43f3a
-  data.tar.gz: 03c4a2fcc89ac330c883a098b44864bf3bff7170d0b929c84e4a38e3b806be322f988babaef8508f87c8dcf41ae4d1bb1859df05a2dfd4343ea24ea4395b2e8f
+  metadata.gz: fd11e9d0f44405b205b56a9af096c8bd7814d03b7c1d7123e9f8be8803d6be06452a155c2950386d9de059b4ede03e6d636841e139b01af8fab8c9112b6a3cb8
+  data.tar.gz: 69e086df0c72d95ffc54c87ee533b0b6833dcf66e70d434a8f0652a84f03c22a737c3cff180f2df06c620e4a3679740bde7774ddd0377575df93f5b6a4ed934c

data/.gitignore

@@ -78,16 +78,9 @@ build-iPhoneSimulator/
 /spec/support/**/config/secrets.yml
 /spec/support/**/config/credentials.yml.enc
 
-# Ignore sorbet-rails generated files
-/spec/support/**/sorbet/rails-rbi/*
-/spec/support/**/sorbet/rails-rbi/**/*
-# Ignore hidden-definition.rbi because we will rerun it
-/spec/support/**/sorbet/rbi/hidden-definitions/*
-/spec/support/**/sorbet/rbi/hidden-definitions/**/*
-
-# Ignore sorbet files in v5.2-no-sorbet
-/spec/support/v5.2-no-sorbet/sorbet/*
-/spec/support/v5.2-no-sorbet/sorbet/**/*
+# Ignore sorbet generated files
+/spec/support/**/sorbet/*
+/spec/support/**/sorbet/**/*
 
 # Ignore files in the public/ directories.
 /spec/support/**/public/*

data/.travis.yml

@@ -18,8 +18,6 @@ matrix:
   include:
   - rvm: 2.5
     env: RAILS_VERSION=5.2 SORBET_VERSION=0.4.4602
-  - rvm: 2.5
-    env: RAILS_VERSION=5.2 TEST_SRB_INIT=true
   exclude:
   - rvm: 2.3
     env: RAILS_VERSION=6.0

data/Gemfile

@@ -30,11 +30,11 @@ when "5.2"
   gem "bundler", ">= 2.0"
   gem "sqlite3", "~> 1.4.1"
 when "6.0"
-  gem "rails", "~> 6.0.0.rc1"
+  gem "rails", "~> 6.0.0"
   gem "bundler", ">= 2.0"
   gem "sqlite3", "~> 1.4.1"
 else
-  gem "rails", ">= 5.2.3"
+  gem "rails", "~> 5.2.3"
   gem "bundler", ">= 2.0"
   gem "sqlite3", "~> 1.4.1"
 end

data/README.md

@@ -69,7 +69,8 @@ The generation task currently creates the following signatures:
 - Associations getters & setters
 - Enum values, checkers & scopes
 - Named scopes
-- Model relation class
+- Model `Relation` class
+  - Scopes on `Relation`, but not [class methods](https://github.com/chanzuckerberg/sorbet-rails/issues/104#issuecomment-521763909)
 
 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.
 

data/Rakefile

@@ -13,7 +13,6 @@ namespace :update_spec do
   task :v5_plus do |t, args|
     Rake::Task['update_spec:v6_0'].invoke
     Rake::Task['update_spec:v5_2'].invoke
-    Rake::Task['update_spec:v5_2_no_sorbet'].invoke
     Rake::Task['update_spec:v5_1'].invoke
     Rake::Task['update_spec:v5_0'].invoke
   end
@@ -22,9 +21,9 @@ namespace :update_spec do
   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')
-      system("gem install rails -v 6.0.0.rc2")
-      system("rails _6.0.0.rc2_ -v")
-      system("RAILS_VERSION='6.0' rails _6.0.0.rc2_ 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")
+      system("gem install rails -v 6.0.0")
+      system("rails _6.0.0_ -v")
+      system("RAILS_VERSION='6.0' rails _6.0.0_ 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
 
@@ -38,16 +37,6 @@ namespace :update_spec do
     end
   end
 
-  desc "Delete the Rails 5.2-no-sorbet spec directory and regenerate it."
-  task :v5_2_no_sorbet do |t, args|
-    Bundler.with_clean_env do
-      FileUtils.rm_rf 'spec/support/v5.2-no-sorbet' if File.directory?('spec/support/v5.2-no-sorbet')
-      system("gem install rails -v 5.2.3")
-      system("rails _5.2.3_ -v")
-      system("RUN_WITH_SORBET='false' RAILS_VERSION='5.2' rails _5.2.3_ new --template spec/generators/rails-template.rb spec/support/v5.2-no-sorbet --skip-javascript --skip-action-cable --skip-test --skip-sprockets --skip-spring --skip-bootsnap --skip-listen")
-    end
-  end
-
   desc "Delete the Rails 5.1 spec directory and regenerate it."
   task :v5_1 do |t, args|
     Bundler.with_clean_env do
@@ -80,7 +69,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.0', 'v5.2', 'v5.2-no-sorbet', 'v5.1', 'v5.0', 'v4.2'].each do |version|
+    ['v6.0', 'v5.2', 'v5.1', 'v5.0', 'v4.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/gem_plugins/kaminari_plugin.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 class KaminariPlugin < SorbetRails::ModelPlugins::Base
   # Kaminari generates a dynamic `page` method on ActiveRecord relations.
   # https://github.com/kaminari/kaminari/blob/c5186f5d9b7f23299d115408e62047447fd3189d/kaminari-activerecord/lib/kaminari/activerecord/active_record_model_extension.rb#L15
@@ -9,13 +9,12 @@ class KaminariPlugin < SorbetRails::ModelPlugins::Base
     # Get the configured Kaminari page method name, or fall back to 'page' if necessary.
     page_method = T.unsafe(Kaminari).config.page_method_name || 'page'
 
-    ar_querying_rbi = root.create_module(model_relation_shared_module_name)
-    ar_querying_rbi.create_method(
+    add_relation_query_method(
+      root,
       page_method.to_s,
       parameters: [
         Parameter.new('num', type: 'T.nilable(Integer)', default: 'nil')
       ],
-      return_type: model_relation_class_name
     )
   end
 end

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

@@ -13,8 +13,6 @@ class SorbetRails::ModelPlugins::ActiveRecordEnum < SorbetRails::ModelPlugins::B
     model_class_rbi = root.create_class(self.model_class_name)
     model_class_rbi.create_include(enum_module_name)
 
-    model_relation_shared_rbi = root.create_module(self.model_relation_shared_module_name)
-
     # TODO: add any method for signature verification?
     model_class.defined_enums.sort.each do |enum_name, enum_hash|
       model_class_rbi.create_method(
@@ -31,12 +29,6 @@ class SorbetRails::ModelPlugins::ActiveRecordEnum < SorbetRails::ModelPlugins::B
           "#{enum_val}!",
           return_type: nil, # void
         )
-        # force generating these methods because sorbet's hidden-definitions generate & override them
-        model_class_rbi.create_method(
-          "#{enum_val}",
-          return_type: self.model_relation_class_name,
-          class_method: true,
-        )
       end
     end
   end

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

@@ -12,6 +12,9 @@ class SorbetRails::ModelPlugins::ActiveRecordFinderMethods < SorbetRails::ModelP
 
     model_assoc_proxy_class_rbi = root.create_class(self.model_assoc_proxy_class_name)
     create_finder_methods_for(model_assoc_proxy_class_rbi, class_method: false)
+
+    model_assoc_relation_rbi = root.create_class(self.model_assoc_relation_class_name)
+    create_finder_methods_for(model_assoc_relation_rbi, class_method: false)
   end
 
   sig { params(class_rbi: Parlour::RbiGenerator::ClassNamespace, class_method: T::Boolean).void }

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

@@ -4,7 +4,8 @@ class SorbetRails::ModelPlugins::ActiveRecordNamedScope < SorbetRails::ModelPlug
 
   sig { implementation.params(root: Parlour::RbiGenerator::Namespace).void }
   def generate(root)
-    ar_named_scope_rbi = root.create_module(self.model_relation_shared_module_name)
+    model_class_rbi = root.create_class(self.model_class_name)
+
     @model_class.methods.sort.each do |method_name|
       method_obj = @model_class.method(method_name)
       next unless method_obj.present? && method_obj.source_location.present?
@@ -16,12 +17,12 @@ class SorbetRails::ModelPlugins::ActiveRecordNamedScope < SorbetRails::ModelPlug
       source_file = method_obj.source_location[0]
       next unless source_file.include?("lib/active_record/scoping/named.rb")
 
-      ar_named_scope_rbi.create_method(
+      add_relation_query_method(
+        root,
         method_name.to_s,
         parameters: [
           Parameter.new("*args", type: "T.untyped"),
         ],
-        return_type: self.model_relation_class_name,
       )
     end
   end

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

@@ -6,17 +6,16 @@ class SorbetRails::ModelPlugins::ActiveRecordQuerying < SorbetRails::ModelPlugin
   def generate(root)
     # All is a named scope that most method from ActiveRecord::Querying delegate to
     # rails/activerecord/lib/active_record/querying.rb:21
-    ar_querying_rbi = root.create_module(self.model_relation_shared_module_name)
-    ar_querying_rbi.create_method(
+    add_relation_query_method(
+      root,
       "all",
-      return_type: self.model_relation_class_name,
     )
-    ar_querying_rbi.create_method(
+    add_relation_query_method(
+      root,
       "unscoped",
       parameters: [
         Parameter.new("&block", type: "T.nilable(T.proc.void)"),
       ],
-      return_type: self.model_relation_class_name,
     )
 
     # It's not possible to typedef all methods in ActiveRecord::Querying module to have the
@@ -29,13 +28,13 @@ class SorbetRails::ModelPlugins::ActiveRecordQuerying < SorbetRails::ModelPlugin
       :having, :create_with, :distinct, :references, :none, :unscope, :optimizer_hints, :merge, :except, :only,
     ]
     model_query_relation_methods.each do |method_name|
-      ar_querying_rbi.create_method(
+      add_relation_query_method(
+        root,
         method_name.to_s,
         parameters: [
           Parameter.new("*args", type: "T.untyped"),
           Parameter.new("&block", type: "T.nilable(T.proc.void)"),
         ],
-        return_type: self.model_relation_class_name,
       ) if exists_class_method?(method_name)
     end
   end

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

@@ -10,8 +10,8 @@ class SorbetRails::ModelPlugins::ActiveRelationWhereNot < SorbetRails::ModelPlug
     model_relation_class_rbi = root.create_class(self.model_relation_class_name)
     model_relation_class_rbi.create_include(where_not_module_name)
 
-    model_assoc_proxy_class_rbi = root.create_class(self.model_assoc_proxy_class_name)
-    model_assoc_proxy_class_rbi.create_include(where_not_module_name)
+    model_assoc_relation_rbi = root.create_class(self.model_assoc_relation_class_name)
+    model_assoc_relation_rbi.create_include(where_not_module_name)
 
     # TODO: where.not is a special case that we replace it with a `where_not` method
     # `where` when not given parameters will return a `ActiveRecord::QueryMethods::WhereChain`

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

@@ -7,11 +7,7 @@ class SorbetRails::ModelPlugins::CustomFinderMethods < SorbetRails::ModelPlugins
     model_class_rbi = root.create_class(self.model_class_name)
     model_relation_class_rbi = root.create_class(self.model_relation_class_name)
     model_assoc_proxy_class_rbi = root.create_class(self.model_assoc_proxy_class_name)
-
-    # include the actual module
-    model_class_rbi.create_extend("SorbetRails::CustomFinderMethods")
-    model_relation_class_rbi.create_include("SorbetRails::CustomFinderMethods")
-    model_assoc_proxy_class_rbi.create_include("SorbetRails::CustomFinderMethods")
+    model_assoc_relation_rbi = root.create_class(self.model_assoc_relation_class_name)
 
     custom_module_name = self.model_module_name("CustomFinderMethods")
     custom_module_rbi = root.create_module(custom_module_name)
@@ -20,6 +16,7 @@ class SorbetRails::ModelPlugins::CustomFinderMethods < SorbetRails::ModelPlugins
     model_class_rbi.create_extend(custom_module_name)
     model_relation_class_rbi.create_include(custom_module_name)
     model_assoc_proxy_class_rbi.create_include(custom_module_name)
+    model_assoc_relation_rbi.create_include(custom_module_name)
 
     custom_module_rbi.create_method(
       "first_n",

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

@@ -9,6 +9,9 @@ class SorbetRails::ModelPlugins::EnumerableCollections < SorbetRails::ModelPlugi
     model_relation_class_rbi = root.create_class(self.model_relation_class_name)
     create_enumerable_methods_for(model_relation_class_rbi)
 
+    model_assoc_relation_rbi = root.create_class(self.model_assoc_relation_class_name)
+    create_enumerable_methods_for(model_assoc_relation_rbi)
+
     model_assoc_proxy_class_rbi = root.create_class(self.model_assoc_proxy_class_name)
     create_enumerable_methods_for(model_assoc_proxy_class_rbi)
 
@@ -45,5 +48,17 @@ class SorbetRails::ModelPlugins::EnumerableCollections < SorbetRails::ModelPlugi
       "to_a",
       return_type: "T::Array[#{self.model_class_name}]",
     )
+    # TODO use type_parameters(:U) when parlour supports it
+    class_rbi.create_arbitrary(
+      code: <<~RUBY
+        sig do
+          type_parameters(:U).params(
+              blk: T.proc.params(arg0: Elem).returns(T.type_parameter(:U)),
+          )
+          .returns(T::Array[T.type_parameter(:U)])
+        end
+        def map(&blk); end
+      RUBY
+    )
   end
 end

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 require('sorbet-rails/model_plugins/base')
 require('sorbet-rails/model_plugins/active_record_enum')
 require('sorbet-rails/model_plugins/active_record_querying')

data/lib/sorbet-rails/model_rbi_formatter.rb

@@ -72,7 +72,6 @@ class SorbetRails::ModelRbiFormatter
       self.model_relation_class_name,
       superclass: "ActiveRecord::Relation",
     )
-    model_relation_rbi.create_include(self.model_relation_shared_module_name)
     model_relation_rbi.create_extend("T::Sig")
     model_relation_rbi.create_extend("T::Generic")
     model_relation_rbi.create_constant(
@@ -80,11 +79,21 @@ class SorbetRails::ModelRbiFormatter
       value: "type_member(fixed: #{model_class_name})",
     )
 
+    model_assoc_relation_rbi = root.create_class(
+      self.model_assoc_relation_class_name,
+      superclass: "ActiveRecord::AssociationRelation",
+    )
+    model_assoc_relation_rbi.create_extend("T::Sig")
+    model_assoc_relation_rbi.create_extend("T::Generic")
+    model_assoc_relation_rbi.create_constant(
+      "Elem",
+      value: "type_member(fixed: #{model_class_name})",
+    )
+
     collection_proxy_rbi = root.create_class(
       self.model_assoc_proxy_class_name,
       superclass: "ActiveRecord::Associations::CollectionProxy",
     )
-    collection_proxy_rbi.create_include(self.model_relation_shared_module_name)
     collection_proxy_rbi.create_extend("T::Sig")
     collection_proxy_rbi.create_extend("T::Generic")
     collection_proxy_rbi.create_constant(
@@ -98,17 +107,6 @@ class SorbetRails::ModelRbiFormatter
     )
     model_rbi.create_extend("T::Sig")
     model_rbi.create_extend("T::Generic")
-    model_rbi.create_extend(self.model_relation_shared_module_name)
-
-    # <Model>::MODEL_RELATION_SHARED_MODULE_SUFFIX is a fake module added so that
-    # when a method is defined in this module, it'll be added to both the Model class
-    # as a class method and to its relation as an instance method.
-    #
-    # We need to define the module after the other classes
-    # to work around Sorbet loading order bug
-    # https://sorbet-ruby.slack.com/archives/CHN2L03NH/p1556065791047300
-    model_relation_shared_rbi = root.create_module(self.model_relation_shared_module_name)
-    model_relation_shared_rbi.create_extend("T::Sig")
   end
 
   sig {

data/lib/sorbet-rails/model_utils.rb

@@ -24,8 +24,8 @@ module SorbetRails::ModelUtils
   end
 
   sig { returns(String) }
-  def model_relation_shared_module_name
-    "#{model_class.name}::ModelRelationShared"
+  def model_assoc_relation_class_name
+    "#{model_class.name}::ActiveRecord_AssociationRelation"
   end
 
   sig { params(module_name: String).returns(String) }
@@ -42,4 +42,51 @@ module SorbetRails::ModelUtils
   def exists_class_method?(method_name)
     model_class.respond_to?(method_name)
   end
+
+  sig {
+    params(
+      root: Parlour::RbiGenerator::Namespace,
+      method_name: String,
+      parameters: T.nilable(T::Array[::Parlour::RbiGenerator::Parameter]),
+    ).void
+  }
+  def add_relation_query_method(root, method_name, parameters: nil)
+    # a relation querying method will be available on
+    # - model (as a class method)
+    # - activerecord relation
+    # - asocciation collection proxy
+    # - association relation
+    # in case (1) and (2), it returns a Model::ActiveRecord_Relation
+    # in case (3) and (4), it returns a Model::ActiveRecord_AssociationRelation
+
+    # force generating these methods because sorbet's hidden-definitions generate & override them
+    model_class_rbi = root.create_class(self.model_class_name)
+    model_class_rbi.create_method(
+      method_name,
+      parameters: parameters,
+      return_type: self.model_relation_class_name,
+      class_method: true,
+    )
+
+    model_relation_rbi = root.create_class(self.model_relation_class_name)
+    model_relation_rbi.create_method(
+      method_name,
+      parameters: parameters,
+      return_type: self.model_relation_class_name,
+    )
+
+    model_assoc_relation_rbi = root.create_class(self.model_assoc_relation_class_name)
+    model_assoc_relation_rbi.create_method(
+      method_name,
+      parameters: parameters,
+      return_type: self.model_assoc_relation_class_name,
+    )
+
+    collection_proxy_rbi = root.create_class(self.model_assoc_proxy_class_name)
+    collection_proxy_rbi.create_method(
+      method_name,
+      parameters: parameters,
+      return_type: self.model_assoc_relation_class_name,
+    )
+  end
 end

data/lib/sorbet-rails/railtie.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 require "rails"
 require "sorbet-rails/custom_finder_methods"
 
@@ -14,6 +14,21 @@ class SorbetRails::Railtie < Rails::Railtie
     ActiveSupport.on_load(:active_record) do
       ActiveRecord::Base.extend SorbetRails::CustomFinderMethods
       ActiveRecord::Relation.include SorbetRails::CustomFinderMethods
+
+      class ::ActiveRecord::Base
+        # open ActiveRecord::Base to override inherited
+        class << self
+          alias_method :sbr_old_inherited, :inherited
+
+          def inherited(child)
+            sbr_old_inherited(child)
+            # make the relation classes public so that they can be used for sorbet runtime checks
+            child.send(:public_constant, :ActiveRecord_Relation)
+            child.send(:public_constant, :ActiveRecord_AssociationRelation)
+            child.send(:public_constant, :ActiveRecord_Associations_CollectionProxy)
+          end
+        end
+      end
     end
   end
 end