tapioca 0.17.9 → 0.18.0

data/lib/tapioca/dsl/compilers/active_record_relations.rb

@@ -151,7 +151,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::ActiveRecord::Base)]
       class ActiveRecordRelations < Compiler
-        extend T::Sig
         include Helpers::ActiveRecordConstantsHelper
         include SorbetHelper
 
@@ -181,10 +180,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             ActiveRecord::Base.descendants.reject(&:abstract_class?)
           end
@@ -224,7 +221,7 @@ module Tapioca
           batch_size: ["Integer", "1000"],
           of: ["Integer", "1000"],
           error_on_ignore: ["T.untyped", "nil"],
-          order: ["Symbol", ":asc"],
+          order: ["T.any(Symbol, T::Array[Symbol])", ":asc"],
           cursor: ["T.untyped", "primary_key"],
           use_ranges: ["T.untyped", "nil"],
         } #: Hash[Symbol, [String, String]]
@@ -541,6 +538,7 @@ module Tapioca
         #: -> void
         def create_relation_methods
           create_relation_method("all")
+          create_unscoped_relation_method
 
           QUERY_METHODS.each do |method_name|
             case method_name
@@ -604,47 +602,9 @@ module Tapioca
 
         #: -> void
         def create_association_relation_methods
-          returning_type = "T.nilable(T.any(T::Array[Symbol], FalseClass))"
-          unique_by_type = "T.nilable(T.any(T::Array[Symbol], Symbol))"
-
-          ASSOCIATION_METHODS.each do |method_name|
-            case method_name
-            when :insert_all, :insert_all!, :upsert_all
-              parameters = [
-                create_param("attributes", type: "T::Array[Hash]"),
-                create_kw_opt_param("returning", type: returning_type, default: "nil"),
-              ]
-
-              # Bang methods don't have the `unique_by` parameter
-              unless bang_method?(method_name)
-                parameters << create_kw_opt_param("unique_by", type: unique_by_type, default: "nil")
-              end
-
-              association_relation_methods_module.create_method(
-                method_name.to_s,
-                parameters: parameters,
-                return_type: "ActiveRecord::Result",
-              )
-            when :insert, :insert!, :upsert
-              parameters = [
-                create_param("attributes", type: "Hash"),
-                create_kw_opt_param("returning", type: returning_type, default: "nil"),
-              ]
-
-              # Bang methods don't have the `unique_by` parameter
-              unless bang_method?(method_name)
-                parameters << create_kw_opt_param("unique_by", type: unique_by_type, default: "nil")
-              end
-
-              association_relation_methods_module.create_method(
-                method_name.to_s,
-                parameters: parameters,
-                return_type: "ActiveRecord::Result",
-              )
-            when :proxy_association
-              # skip - private method
-            end
-          end
+          # skips insert/upsert methods - these methods' signatures aren't model-specific and don't need to be generated dynamically
+          # also skips proxy_association method - it's a private method
+          # but there could be other association methods that we need to generate
         end
 
         #: -> void
@@ -953,44 +913,8 @@ module Tapioca
                   sig.return_type = constant_name
                 end
               end
-            when :insert_all, :insert_all!, :upsert_all # insert all methods
-              returning_type = "T.nilable(T.any(T::Array[Symbol], FalseClass))"
-              unique_by_type = "T.nilable(T.any(T::Array[Symbol], Symbol))"
-
-              parameters = [
-                create_param("attributes", type: "T::Array[Hash]"),
-                create_kw_opt_param("returning", type: returning_type, default: "nil"),
-              ]
-
-              # Bang methods don't have the `unique_by` parameter
-              unless bang_method?(method_name)
-                parameters << create_kw_opt_param("unique_by", type: unique_by_type, default: "nil")
-              end
-
-              common_relation_methods_module.create_method(
-                method_name.to_s,
-                parameters: parameters,
-                return_type: "ActiveRecord::Result",
-              )
-            when :insert, :insert!, :upsert # insert methods
-              returning_type = "T.nilable(T.any(T::Array[Symbol], FalseClass))"
-              unique_by_type = "T.nilable(T.any(T::Array[Symbol], Symbol))"
-
-              parameters = [
-                create_param("attributes", type: "Hash"),
-                create_kw_opt_param("returning", type: returning_type, default: "nil"),
-              ]
-
-              # Bang methods don't have the `unique_by` parameter
-              unless bang_method?(method_name)
-                parameters << create_kw_opt_param("unique_by", type: unique_by_type, default: "nil")
-              end
-
-              common_relation_methods_module.create_method(
-                method_name.to_s,
-                parameters: parameters,
-                return_type: "ActiveRecord::Result",
-              )
+            when :insert_all, :insert_all!, :upsert_all, :insert, :insert!, :upsert # insert methods
+              # skip - these methods' signatures aren't model-specific and don't need to be generated dynamically
             when :delete, :destroy
               # For these cases, it is valid to pass the above kind of things, but also:
               # - a model identifier, which can be:
@@ -1021,7 +945,7 @@ module Tapioca
               common_relation_methods_module.create_method(
                 method_name.to_s,
                 parameters: [
-                  create_param("args", type: "T.untyped"),
+                  create_rest_param("args", type: "T.untyped"),
                 ],
                 return_type: method_name == :delete_by ? "Integer" : "T::Array[#{constant_name}]",
               )
@@ -1050,7 +974,7 @@ module Tapioca
           when :find_each
             [constant_name, "T::Enumerator[#{constant_name}]"]
           when :find_in_batches
-            ["T::Array[#{constant_name}]", "T::Enumerator[T::Enumerator[#{constant_name}]]"]
+            ["T::Array[#{constant_name}]", "T::Enumerator[T::Array[#{constant_name}]]"]
           when :in_batches
             [RelationClassName, "::ActiveRecord::Batches::BatchEnumerator"]
           else
@@ -1107,7 +1031,12 @@ module Tapioca
           end
         end
 
-        #: ((Symbol | String) name, ?parameters: Array[RBI::TypedParam], ?relation_return_type: String, ?association_return_type: String) -> void
+        #: (
+        #|   (Symbol | String) name,
+        #|   ?parameters: Array[RBI::TypedParam],
+        #|   ?relation_return_type: String,
+        #|   ?association_return_type: String
+        #| ) -> void
         def create_relation_method(
           name,
           parameters: [],
@@ -1125,6 +1054,35 @@ module Tapioca
             return_type: association_return_type,
           )
         end
+
+        #: -> void
+        def create_unscoped_relation_method
+          relation_methods_module.create_method("unscoped") do |method|
+            method.add_block_param("block")
+
+            method.add_sig do |sig|
+              sig.return_type = RelationClassName
+            end
+
+            method.add_sig(type_params: ["U"]) do |sig|
+              sig.add_param("block", "T.proc.returns(T.type_parameter(:U))")
+              sig.return_type = "T.type_parameter(:U)"
+            end
+          end
+
+          association_relation_methods_module.create_method("unscoped") do |method|
+            method.add_block_param("block")
+
+            method.add_sig do |sig|
+              sig.return_type = AssociationRelationClassName
+            end
+
+            method.add_sig(type_params: ["U"]) do |sig|
+              sig.add_param("block", "T.proc.returns(T.type_parameter(:U))")
+              sig.return_type = "T.type_parameter(:U)"
+            end
+          end
+        end
       end
     end
   end

data/lib/tapioca/dsl/compilers/active_record_scope.rb

@@ -40,7 +40,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::ActiveRecord::Base)]
       class ActiveRecordScope < Compiler
-        extend T::Sig
         include Helpers::ActiveRecordConstantsHelper
 
         # @override
@@ -78,7 +77,7 @@ module Tapioca
 
         class << self
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             descendants_of(::ActiveRecord::Base).reject(&:abstract_class?)
           end

data/lib/tapioca/dsl/compilers/active_record_secure_token.rb

@@ -34,7 +34,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = (singleton(ActiveRecord::Base) & Extensions::ActiveRecord)]
       class ActiveRecordSecureToken < Compiler
-        extend T::Sig
         include Helpers::ActiveRecordConstantsHelper
 
         # @override
@@ -57,10 +56,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             descendants_of(::ActiveRecord::Base).reject(&:abstract_class?)
           end

data/lib/tapioca/dsl/compilers/active_record_store.rb

@@ -80,7 +80,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = (singleton(ActiveRecord::Base) & Extensions::ActiveRecord)]
       class ActiveRecordStore < Compiler
-        extend T::Sig
         include Helpers::ActiveRecordConstantsHelper
 
         # @override
@@ -132,10 +131,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             descendants_of(::ActiveRecord::Base).reject(&:abstract_class?)
           end

data/lib/tapioca/dsl/compilers/active_record_typed_store.rb

@@ -83,8 +83,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::ActiveRecord::Base)]
       class ActiveRecordTypedStore < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -108,10 +106,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             descendants_of(::ActiveRecord::Base).select do |klass|
               klass.include?(ActiveRecord::TypedStore::Behavior)

data/lib/tapioca/dsl/compilers/active_resource.rb

@@ -56,8 +56,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::ActiveResource::Base)]
       class ActiveResource < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -71,10 +69,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             descendants_of(::ActiveResource::Base)
           end

data/lib/tapioca/dsl/compilers/active_storage.rb

@@ -38,10 +38,8 @@ module Tapioca
       #   def photo=(attachable); end
       # end
       # ~~~
-      #: [ConstantType = (Module & ::ActiveStorage::Reflection::ActiveRecordExtensions::ClassMethods)]
+      #: [ConstantType = (T::Module[top] & ::ActiveStorage::Reflection::ActiveRecordExtensions::ClassMethods)]
       class ActiveStorage < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -65,10 +63,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             descendants_of(::ActiveRecord::Base)
               .reject(&:abstract_class?)

data/lib/tapioca/dsl/compilers/active_support_concern.rb

@@ -37,10 +37,8 @@ module Tapioca
       #   mixes_in_class_methods(::Foo::ClassMethods)
       # end
       # ~~~
-      #: [ConstantType = Module]
+      #: [ConstantType = T::Module[top]]
       class ActiveSupportConcern < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -62,10 +60,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             all_modules.select do |mod|
               name_of(mod) && # i.e. not anonymous
@@ -76,10 +72,10 @@ module Tapioca
           end
 
           # Returns true when `mod` includes other concerns
-          #: (Module mod) -> bool
+          #: (T::Module[top] mod) -> bool
           def has_dependencies?(mod) = dependencies_of(mod).any?
 
-          #: (Module concern) -> Array[Module]
+          #: (T::Module[top] concern) -> Array[T::Module[top]]
           def dependencies_of(concern)
             concern.instance_variable_get(:@_dependencies) || []
           end
@@ -87,12 +83,12 @@ module Tapioca
 
         private
 
-        #: (Module concern) -> Array[Module]
+        #: (T::Module[top] concern) -> Array[T::Module[top]]
         def dependencies_of(concern)
           self.class.dependencies_of(concern)
         end
 
-        #: (?Module concern) -> Array[Module]
+        #: (?T::Module[top] concern) -> Array[T::Module[top]]
         def linearized_dependencies(concern = constant)
           # Grab all the dependencies of the concern
           dependencies = dependencies_of(concern)

data/lib/tapioca/dsl/compilers/active_support_current_attributes.rb

@@ -61,8 +61,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::ActiveSupport::CurrentAttributes)]
       class ActiveSupportCurrentAttributes < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -74,11 +72,11 @@ module Tapioca
             current_attributes_methods_name = "GeneratedAttributeMethods"
             current_attributes.create_module(current_attributes_methods_name) do |generated_attribute_methods|
               dynamic_methods.each do |method|
-                method = method.to_s
+                method = constant.instance_method(method)
                 # We want to generate each method both on the class
-                generate_method(current_attributes, method, class_method: true)
+                create_method_from_def(current_attributes, method, class_method: true)
                 # and on the instance
-                generate_method(generated_attribute_methods, method, class_method: false)
+                create_method_from_def(generated_attribute_methods, method, class_method: false)
               end
 
               instance_methods.each do |method|
@@ -94,10 +92,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             descendants_of(::ActiveSupport::CurrentAttributes)
           end
@@ -114,17 +110,6 @@ module Tapioca
         def instance_methods_of_constant
           constant.instance_methods(false)
         end
-
-        #: (RBI::Scope klass, String method, class_method: bool) -> void
-        def generate_method(klass, method, class_method:)
-          method_def = if class_method
-            constant.method(method)
-          else
-            constant.instance_method(method)
-          end
-
-          create_method_from_def(klass, method_def, class_method: class_method)
-        end
       end
     end
   end

data/lib/tapioca/dsl/compilers/active_support_environment_inquirer.rb

@@ -0,0 +1,60 @@
+# typed: strict
+# frozen_string_literal: true
+
+return unless defined?(ActiveSupport::EnvironmentInquirer)
+
+module Tapioca
+  module Dsl
+    module Compilers
+      # `Tapioca::Dsl::Compilers::ActiveSupportEnvironmentInquirer` decorates an RBI file for non-default environment
+      # files in the `config/environments` directory.
+      #
+      # For example, in a Rails application with the following files:
+      #
+      # - config/environments/development.rb
+      # - config/environments/demo.rb
+      # - config/environments/production.rb
+      # - config/environments/staging.rb
+      # - config/environments/test.rb
+      #
+      # this compiler will produce an RBI file with the following content:
+      # ~~~rbi
+      # # typed: true
+      #
+      # class ActiveSupport::EnvironmentInquirer
+      #   sig { returns(T::Boolean) }
+      #   def demo?; end
+      #
+      #   sig { returns(T::Boolean) }
+      #   def staging?; end
+      # end
+      # ~~~
+      #: [ConstantType = singleton(::ActiveSupport::EnvironmentInquirer)]
+      class ActiveSupportEnvironmentInquirer < Compiler
+        # @override
+        #: -> void
+        def decorate
+          envs = Rails.root.glob("config/environments/*.rb").map { |f| f.basename(".rb").to_s }.sort
+          envs -= ::ActiveSupport::EnvironmentInquirer::DEFAULT_ENVIRONMENTS
+          return if envs.none?
+
+          root.create_path(::ActiveSupport::EnvironmentInquirer) do |mod|
+            envs.each do |env|
+              mod.create_method("#{env}?", return_type: "T::Boolean")
+            end
+          end
+        end
+
+        class << self
+          # @override
+          #: -> T::Enumerable[T::Module[top]]
+          def gather_constants
+            return [] unless defined?(Rails.application) && Rails.application
+
+            [::ActiveSupport::EnvironmentInquirer]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tapioca/dsl/compilers/active_support_time_ext.rb

@@ -36,8 +36,6 @@ module Tapioca
       # ```
       #: [ConstantType = singleton(::Time)]
       class ActiveSupportTimeExt < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -55,10 +53,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             [::Time]
           end

data/lib/tapioca/dsl/compilers/config.rb

@@ -40,10 +40,8 @@ module Tapioca
       #   def github=(value); end
       # end
       # ```
-      #: [ConstantType = Module]
+      #: [ConstantType = T::Module[top]]
       class Config < Compiler
-        extend T::Sig
-
         CONFIG_OPTIONS_SUFFIX = "ConfigOptions"
 
         # @override
@@ -93,10 +91,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             name = ::Config.const_name
             return [] unless Object.const_defined?(name)

data/lib/tapioca/dsl/compilers/frozen_record.rb

@@ -60,8 +60,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = (singleton(::FrozenRecord::Base) & Extensions::FrozenRecord)]
       class FrozenRecord < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -85,10 +83,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             descendants_of(::FrozenRecord::Base).reject(&:abstract_class?)
           end

data/lib/tapioca/dsl/compilers/graphql_input_object.rb

@@ -36,8 +36,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(GraphQL::Schema::InputObject)]
       class GraphqlInputObject < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -74,10 +72,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             all_classes.select { |c| GraphQL::Schema::InputObject > c }
           end

data/lib/tapioca/dsl/compilers/graphql_mutation.rb

@@ -37,8 +37,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(GraphQL::Schema::Mutation)]
       class GraphqlMutation < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -71,10 +69,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             all_classes.select { |c| GraphQL::Schema::Mutation > c && GraphQL::Schema::RelayClassicMutation != c }
           end

data/lib/tapioca/dsl/compilers/identity_cache.rb

@@ -57,9 +57,7 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::ActiveRecord::Base)]
       class IdentityCache < Compiler
-        extend T::Sig
-
-        COLLECTION_TYPE = ->(type) { "T::Array[::#{type}]" } #: ^((Module | String) type) -> String
+        COLLECTION_TYPE = ->(type) { "T::Array[::#{type}]" } #: ^((T::Module[top] | String) type) -> String
 
         # @override
         #: -> void
@@ -92,10 +90,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             descendants_of(::ActiveRecord::Base).select do |klass|
               ::IdentityCache::WithoutPrimaryIndex > klass

data/lib/tapioca/dsl/compilers/json_api_client_resource.rb

@@ -81,8 +81,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::JsonApiClient::Resource)]
       class JsonApiClientResource < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -106,10 +104,8 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
-          #: -> T::Enumerable[Module]
+          #: -> Enumerable[T::Module[top]]
           def gather_constants
             all_modules.select do |c|
               name_of(c) && ::JsonApiClient::Resource > c
@@ -142,17 +138,7 @@ module Tapioca
           type = ::JsonApiClient::Schema::TypeFactory.type_for(property.type)
           return "T.untyped" if type.nil?
 
-          sorbet_type = if type.respond_to?(:sorbet_type)
-            line, file = type.method(:sorbet_type).source_location
-
-            $stderr.puts <<~MESSAGE
-              WARNING: `#sorbet_type` is deprecated. Please rename your method to `#__tapioca_type`."
-
-              Defined on line #{line} of #{file}
-            MESSAGE
-
-            type.sorbet_type
-          elsif type.respond_to?(:__tapioca_type)
+          tapioca_type = if type.respond_to?(:__tapioca_type)
             type.__tapioca_type
           elsif type == ::JsonApiClient::Schema::Types::Integer
             "::Integer"
@@ -171,9 +157,9 @@ module Tapioca
           end
 
           if property.default.nil?
-            as_nilable_type(sorbet_type)
+            as_nilable_type(tapioca_type)
           else
-            sorbet_type
+            tapioca_type
           end
         end