tapioca 0.16.10 → 0.17.0

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

@@ -64,7 +64,8 @@ module Tapioca
 
         ConstantType = type_member { { fixed: T.class_of(::ActiveSupport::CurrentAttributes) } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           dynamic_methods = dynamic_methods_of_constant
           instance_methods = instance_methods_of_constant - dynamic_methods
@@ -96,7 +97,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             descendants_of(::ActiveSupport::CurrentAttributes)
           end
@@ -104,17 +106,17 @@ module Tapioca
 
         private
 
-        sig { returns(T::Array[Symbol]) }
+        #: -> Array[Symbol]
         def dynamic_methods_of_constant
           constant.instance_variable_get(:@generated_attribute_methods)&.instance_methods(false) || []
         end
 
-        sig { returns(T::Array[Symbol]) }
+        #: -> Array[Symbol]
         def instance_methods_of_constant
           constant.instance_methods(false)
         end
 
-        sig { params(klass: RBI::Scope, method: String, class_method: T::Boolean).void }
+        #: (RBI::Scope klass, String method, class_method: bool) -> void
         def generate_method(klass, method, class_method:)
           method_def = if class_method
             constant.method(method)

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

@@ -39,7 +39,8 @@ module Tapioca
 
         ConstantType = type_member { { fixed: T.class_of(::Time) } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           return unless constant.respond_to?(:zone)
 
@@ -57,7 +58,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             [::Time]
           end

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

@@ -47,7 +47,8 @@ module Tapioca
 
         ConstantType = type_member { { fixed: Module } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           # The constant we are given is the specialized config options type
           option_class_name = constant.name
@@ -95,7 +96,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             name = ::Config.const_name
             return [] unless Object.const_defined?(name)

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

@@ -63,7 +63,8 @@ module Tapioca
 
         ConstantType = type_member { { fixed: T.all(T.class_of(::FrozenRecord::Base), Extensions::FrozenRecord) } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           attributes = constant.attributes
           return if attributes.empty?
@@ -87,7 +88,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             descendants_of(::FrozenRecord::Base).reject(&:abstract_class?)
           end
@@ -95,7 +97,7 @@ module Tapioca
 
         private
 
-        sig { params(record: RBI::Scope).void }
+        #: (RBI::Scope record) -> void
         def decorate_scopes(record)
           scopes = constant.__tapioca_scope_names
           return if scopes.nil?
@@ -111,12 +113,7 @@ module Tapioca
           record.create_extend(module_name)
         end
 
-        sig do
-          params(
-            scope_method: String,
-            mod: RBI::Scope,
-          ).void
-        end
+        #: (String scope_method, RBI::Scope mod) -> void
         def generate_scope_method(scope_method, mod)
           mod.create_method(
             scope_method,

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

@@ -39,7 +39,8 @@ module Tapioca
 
         ConstantType = type_member { { fixed: T.class_of(GraphQL::Schema::InputObject) } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           # Skip methods explicitly defined in code
           arguments = constant.all_argument_definitions.select do |argument|
@@ -61,15 +62,13 @@ module Tapioca
 
         private
 
-        sig { returns(T.nilable(String)) }
+        #: -> String?
         def graphql_input_object_argument_source_file
-          @graphql_input_object_argument_source_file ||= T.let(
-            GraphQL::Schema::InputObject.method(:argument).source_location&.first,
-            T.nilable(String),
-          )
+          @graphql_input_object_argument_source_file ||=
+            GraphQL::Schema::InputObject.method(:argument).source_location&.first #: String?
         end
 
-        sig { params(method_name: String).returns(T::Boolean) }
+        #: (String method_name) -> bool
         def method_defined_by_graphql?(method_name)
           method_file = constant.instance_method(method_name).source_location&.first
           !!(method_file && graphql_input_object_argument_source_file == method_file)
@@ -78,7 +77,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             all_classes.select { |c| GraphQL::Schema::InputObject > c }
           end

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

@@ -40,7 +40,8 @@ module Tapioca
 
         ConstantType = type_member { { fixed: T.class_of(GraphQL::Schema::Mutation) } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           return unless constant.method_defined?(:resolve)
 
@@ -63,12 +64,7 @@ module Tapioca
           end
         end
 
-        sig do
-          params(
-            argument: T.nilable(GraphQL::Schema::Argument),
-            constant: T.class_of(GraphQL::Schema::Mutation),
-          ).returns(String)
-        end
+        #: (GraphQL::Schema::Argument? argument, singleton(GraphQL::Schema::Mutation) constant) -> String
         def argument_type(argument, constant)
           return "T.untyped" unless argument
 
@@ -78,7 +74,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             all_classes.select { |c| GraphQL::Schema::Mutation > c && GraphQL::Schema::RelayClassicMutation != c }
           end

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

@@ -58,14 +58,12 @@ module Tapioca
       class IdentityCache < Compiler
         extend T::Sig
 
-        COLLECTION_TYPE = T.let(
-          ->(type) { "T::Array[::#{type}]" },
-          T.proc.params(type: T.any(Module, String)).returns(String),
-        )
+        COLLECTION_TYPE = ->(type) { "T::Array[::#{type}]" } #: ^((Module | String) type) -> String
 
         ConstantType = type_member { { fixed: T.class_of(::ActiveRecord::Base) } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           caches = constant.send(:all_cached_associations)
           cache_indexes = constant.send(:cache_indexes)
@@ -97,7 +95,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             descendants_of(::ActiveRecord::Base).select do |klass|
               ::IdentityCache::WithoutPrimaryIndex > klass
@@ -107,12 +106,7 @@ module Tapioca
 
         private
 
-        sig do
-          params(
-            field: T.untyped,
-            returns_collection: T::Boolean,
-          ).returns(String)
-        end
+        #: (untyped field, returns_collection: bool) -> String
         def type_for_field(field, returns_collection:)
           cache_type = field.reflection.compute_class(field.reflection.class_name)
           if returns_collection
@@ -124,13 +118,7 @@ module Tapioca
           "T.untyped"
         end
 
-        sig do
-          params(
-            field: T.untyped,
-            klass: RBI::Scope,
-            returns_collection: T::Boolean,
-          ).void
-        end
+        #: (untyped field, RBI::Scope klass, returns_collection: bool) -> void
         def create_fetch_field_methods(field, klass, returns_collection:)
           name = field.cached_accessor_name.to_s
           type = type_for_field(field, returns_collection: returns_collection)
@@ -143,12 +131,7 @@ module Tapioca
           end
         end
 
-        sig do
-          params(
-            field: T.untyped,
-            klass: RBI::Scope,
-          ).void
-        end
+        #: (untyped field, RBI::Scope klass) -> void
         def create_fetch_by_methods(field, klass)
           is_cache_index = field.instance_variable_defined?(:@attribute_proc)
 
@@ -159,12 +142,7 @@ module Tapioca
           create_index_fetch_by_methods(field, klass) if is_cache_index
         end
 
-        sig do
-          params(
-            field: T.untyped,
-            klass: RBI::Scope,
-          ).void
-        end
+        #: (untyped field, RBI::Scope klass) -> void
         def create_index_fetch_by_methods(field, klass)
           fields_name = field.key_fields.join("_and_")
           name = "fetch_by_#{fields_name}"
@@ -209,12 +187,7 @@ module Tapioca
           )
         end
 
-        sig do
-          params(
-            field: T.untyped,
-            klass: RBI::Scope,
-          ).void
-        end
+        #: (untyped field, RBI::Scope klass) -> void
         def create_aliased_fetch_by_methods(field, klass)
           type, _ = Helpers::ActiveRecordColumnTypeHelper.new(
             constant,

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

@@ -84,7 +84,8 @@ module Tapioca
 
         ConstantType = type_member { { fixed: T.class_of(::JsonApiClient::Resource) } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           schema = resource_schema
           return if schema.nil? && constant.associations.empty?
@@ -108,7 +109,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             all_modules.select do |c|
               name_of(c) && ::JsonApiClient::Resource > c
@@ -118,7 +120,7 @@ module Tapioca
 
         private
 
-        sig { returns(T.nilable(::JsonApiClient::Schema)) }
+        #: -> ::JsonApiClient::Schema?
         def resource_schema
           schema = constant.schema
 
@@ -126,12 +128,7 @@ module Tapioca
           schema if schema.size > 0 # rubocop:disable Style/ZeroLengthPredicate
         end
 
-        sig do
-          params(
-            mod: RBI::Scope,
-            property: ::JsonApiClient::Schema::Property,
-          ).void
-        end
+        #: (RBI::Scope mod, ::JsonApiClient::Schema::Property property) -> void
         def generate_methods_for_property(mod, property)
           type = type_for(property)
 
@@ -141,7 +138,7 @@ module Tapioca
           mod.create_method("#{name}=", parameters: [create_param(name, type: type)], return_type: type)
         end
 
-        sig { params(property: ::JsonApiClient::Schema::Property).returns(String) }
+        #: (::JsonApiClient::Schema::Property property) -> String
         def type_for(property)
           type = ::JsonApiClient::Schema::TypeFactory.type_for(property.type)
           return "T.untyped" if type.nil?
@@ -181,12 +178,7 @@ module Tapioca
           end
         end
 
-        sig do
-          params(
-            mod: RBI::Scope,
-            association: JsonApiClient::Associations::BaseAssociation,
-          ).void
-        end
+        #: (RBI::Scope mod, JsonApiClient::Associations::BaseAssociation association) -> void
         def generate_methods_for_association(mod, association)
           # If the association is broken, it will raise a NameError when trying to access the association_class
           klass = association.association_class

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

@@ -70,7 +70,8 @@ module Tapioca
           { fixed: T.all(T::Class[::Kredis::Attributes], ::Kredis::Attributes::ClassMethods, Extensions::Kredis) }
         end
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           return if constant.__tapioca_kredis_types.nil?
 
@@ -89,7 +90,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             all_classes
               .grep(::Kredis::Attributes::ClassMethods)
@@ -99,7 +101,7 @@ module Tapioca
 
         private
 
-        sig { params(mod: RBI::Scope, method: String, data: T::Hash[Symbol, T.untyped]).void }
+        #: (RBI::Scope mod, String method, Hash[Symbol, untyped] data) -> void
         def generate_methods(mod, method, data)
           return_type = data.fetch(:type)
           case return_type
@@ -114,7 +116,7 @@ module Tapioca
           mod.create_method(method, return_type: return_type)
         end
 
-        sig { params(mod: RBI::Scope, klass_name: String, values: T::Array[T.untyped]).void }
+        #: (RBI::Scope mod, String klass_name, Array[untyped] values) -> void
         def create_enum_class(mod, klass_name, values)
           klass = mod.create_class(klass_name, superclass_name: "Kredis::Types::Enum")
           values.each do |value|

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

@@ -49,7 +49,8 @@ module Tapioca
 
         ConstantType = type_member { { fixed: Module } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           mixin_compiler = Runtime::DynamicMixinCompiler.new(constant)
           return if mixin_compiler.empty_attributes?
@@ -62,7 +63,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             # Select all non-anonymous modules that have overridden Module.included
             all_modules.select do |mod|

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

@@ -78,7 +78,8 @@ module Tapioca
 
         FIELD_RE = /^[a-z_][a-zA-Z0-9_]*$/
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           root.create_path(constant) do |klass|
             if constant == Google::Protobuf::RepeatedField
@@ -155,7 +156,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             marker = Google::Protobuf::MessageExts::ClassMethods
 
@@ -178,7 +180,7 @@ module Tapioca
 
         private
 
-        sig { params(desc: Google::Protobuf::FieldDescriptor).returns(T::Boolean) }
+        #: (Google::Protobuf::FieldDescriptor desc) -> bool
         def has_presence?(desc)
           if desc.respond_to?(:has_presence?)
             # This method is only defined in google-protobuf 3.26.0 and later
@@ -190,7 +192,7 @@ module Tapioca
           end
         end
 
-        sig { params(klass: RBI::Scope, names: String).void }
+        #: (RBI::Scope klass, *String names) -> void
         def create_type_members(klass, *names)
           klass.create_extend("T::Generic")
 
@@ -199,11 +201,7 @@ module Tapioca
           end
         end
 
-        sig do
-          params(
-            descriptor: Google::Protobuf::FieldDescriptor,
-          ).returns(String)
-        end
+        #: (Google::Protobuf::FieldDescriptor descriptor) -> String
         def type_of(descriptor)
           case descriptor.type
           when :enum
@@ -229,12 +227,12 @@ module Tapioca
           end
         end
 
-        sig { params(descriptor: Google::Protobuf::FieldDescriptor).returns(T::Boolean) }
+        #: (Google::Protobuf::FieldDescriptor descriptor) -> bool
         def nilable_descriptor?(descriptor)
           descriptor.label == :optional && descriptor.type == :message
         end
 
-        sig { params(descriptor: Google::Protobuf::FieldDescriptor).returns(T::Boolean) }
+        #: (Google::Protobuf::FieldDescriptor descriptor) -> bool
         def map_type?(descriptor)
           # Defensively make sure that we are dealing with a repeated field
           return false unless descriptor.label == :repeated
@@ -248,7 +246,7 @@ module Tapioca
           false
         end
 
-        sig { params(descriptor: Google::Protobuf::FieldDescriptor).returns(Field) }
+        #: (Google::Protobuf::FieldDescriptor descriptor) -> Field
         def field_of(descriptor)
           if descriptor.label == :repeated
             if map_type?(descriptor)
@@ -290,12 +288,7 @@ module Tapioca
           end
         end
 
-        sig do
-          params(
-            klass: RBI::Scope,
-            desc: Google::Protobuf::FieldDescriptor,
-          ).returns(Field)
-        end
+        #: (RBI::Scope klass, Google::Protobuf::FieldDescriptor desc) -> Field
         def create_descriptor_method(klass, desc)
           field = field_of(desc)
 
@@ -325,12 +318,7 @@ module Tapioca
           field
         end
 
-        sig do
-          params(
-            klass: RBI::Scope,
-            desc: Google::Protobuf::OneofDescriptor,
-          ).void
-        end
+        #: (RBI::Scope klass, Google::Protobuf::OneofDescriptor desc) -> void
         def create_oneof_method(klass, desc)
           klass.create_method(
             desc.name,

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

@@ -36,14 +36,12 @@ module Tapioca
       class RailsGenerators < Compiler
         extend T::Sig
 
-        BUILT_IN_MATCHER = T.let(
-          /::(ActionMailbox|ActionText|ActiveRecord|Rails)::Generators/,
-          Regexp,
-        )
+        BUILT_IN_MATCHER = /::(ActionMailbox|ActionText|ActiveRecord|Rails)::Generators/
 
         ConstantType = type_member { { fixed: T.class_of(::Rails::Generators::Base) } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           base_class = base_class_of_constant
           arguments = constant.arguments - base_class.arguments
@@ -62,7 +60,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             all_classes.select do |const|
               name = qualified_name_of(const)
@@ -76,7 +75,7 @@ module Tapioca
 
         private
 
-        sig { params(klass: RBI::Tree, argument: T.any(Thor::Argument, Thor::Option)).void }
+        #: (RBI::Tree klass, (Thor::Argument | Thor::Option) argument) -> void
         def generate_methods_for_argument(klass, argument)
           klass.create_method(
             argument.name,
@@ -85,7 +84,7 @@ module Tapioca
           )
         end
 
-        sig { returns(T.class_of(::Rails::Generators::Base)) }
+        #: -> singleton(::Rails::Generators::Base)
         def base_class_of_constant
           ancestor = inherited_ancestors_of(constant).find do |klass|
             qualified_name_of(klass)&.match?(BUILT_IN_MATCHER)
@@ -94,7 +93,7 @@ module Tapioca
           T.cast(ancestor, T.class_of(::Rails::Generators::Base))
         end
 
-        sig { params(arg: T.any(Thor::Argument, Thor::Option)).returns(String) }
+        #: ((Thor::Argument | Thor::Option) arg) -> String
         def type_for(arg)
           type =
             case arg.type

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

@@ -36,12 +36,18 @@ module Tapioca
       #   def self.perform_in(interval, customer_id); end
       # end
       # ~~~
+      #
+      # If your project uses `ActiveSupport` as well, then the compiler will automatically add its classes
+      # as accepted values for the `interval` parameter:
+      # * `self.perform_at` will also accept a `ActiveSupport::TimeWithZone` value
+      # * `self.perform_in` will also accept a `ActiveSupport::Duration` value
       class SidekiqWorker < Compiler
         extend T::Sig
 
         ConstantType = type_member { { fixed: T.class_of(::Sidekiq::Worker) } }
 
-        sig { override.void }
+        # @override
+        #: -> void
         def decorate
           return unless constant.instance_methods.include?(:perform)
 
@@ -53,12 +59,22 @@ module Tapioca
             # `perform_at` and is just an alias for `perform_in` so both methods technically
             # accept a datetime, time, or numeric but we're typing them differently so they
             # semantically make sense.
+            at_return_type = if defined?(ActiveSupport::TimeWithZone)
+              "T.any(DateTime, Time, ActiveSupport::TimeWithZone)"
+            else
+              "T.any(DateTime, Time)"
+            end
             at_params = [
-              create_param("interval", type: "T.any(DateTime, Time)"),
+              create_param("interval", type: at_return_type),
               *async_params,
             ]
+            in_return_type = if defined?(ActiveSupport::Duration)
+              "T.any(Numeric, ActiveSupport::Duration)"
+            else
+              "Numeric"
+            end
             in_params = [
-              create_param("interval", type: "Numeric"),
+              create_param("interval", type: in_return_type),
               *async_params,
             ]
 
@@ -71,7 +87,8 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          # @override
+          #: -> T::Enumerable[Module]
           def gather_constants
             all_classes.select { |c| Sidekiq::Worker > c }
           end
@@ -79,13 +96,7 @@ module Tapioca
 
         private
 
-        sig do
-          params(
-            worker: RBI::Scope,
-            method_name: String,
-            parameters: T::Array[RBI::TypedParam],
-          ).void
-        end
+        #: (RBI::Scope worker, String method_name, Array[RBI::TypedParam] parameters) -> void
         def generate_perform_method(worker, method_name, parameters)
           if constant.method(method_name.to_sym).owner == Sidekiq::Worker::ClassMethods
             worker.create_method(method_name, parameters: parameters, return_type: "String", class_method: true)