Update Active Record find sig to allow a block

With a block it behaves like Enumerable#find
Shopify · Apr 4, 2024 · a225ce0 · brendo · Apr 15, 2024 · brendo
1 parent cdd80d1
commit a225ce0
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/lib/tapioca/dsl/compilers/active_record_relations.rb b/lib/tapioca/dsl/compilers/active_record_relations.rb
@@ -674,11 +674,18 @@ def create_common_methods
                   parameters: { args: array_type },
                   return_type: "T::Enumerable[#{constant_name}]",
                 ),
+                common_relation_methods_module.create_sig(
+                  parameters: {
+                    args: "NilClass",
+                    block: "T.proc.params(object: #{constant_name}).void)",
+                  },
+                  return_type: as_nilable_type(constant_name),
+                ),
               ]
               common_relation_methods_module.create_method_with_sigs(
                 "find",
                 sigs: sigs,
-                parameters: [RBI::ReqParam.new("args")],
+                parameters: [RBI::OptParam.new("args", "nil"), RBI::BlockParam.new("block")],
               )
             when :find_by
               create_common_method(

diff --git a/spec/tapioca/dsl/compilers/active_record_relations_spec.rb b/spec/tapioca/dsl/compilers/active_record_relations_spec.rb
@@ -107,7 +107,8 @@ def fifth!; end
 
                     sig { params(args: T.any(String, Symbol, ::ActiveSupport::Multibyte::Chars, T::Boolean, BigDecimal, Numeric, ::ActiveRecord::Type::Binary::Data, ::ActiveRecord::Type::Time::Value, Date, Time, ::ActiveSupport::Duration, T::Class[T.anything])).returns(::Post) }
                     sig { params(args: T::Array[T.any(String, Symbol, ::ActiveSupport::Multibyte::Chars, T::Boolean, BigDecimal, Numeric, ::ActiveRecord::Type::Binary::Data, ::ActiveRecord::Type::Time::Value, Date, Time, ::ActiveSupport::Duration, T::Class[T.anything])]).returns(T::Enumerable[::Post]) }
-                    def find(args); end
+                    sig { params(args: NilClass, block: T.proc.params(object: ::Post).void)).returns(T.nilable(::Post)) }
+                    def find(args = nil, &block); end
 
                     sig { params(args: T.untyped).returns(T.nilable(::Post)) }
                     def find_by(*args); end
@@ -801,7 +802,8 @@ def fifth!; end
                 <% else %>
                     sig { params(args: T::Array[T.any(String, Symbol, ::ActiveSupport::Multibyte::Chars, T::Boolean, BigDecimal, Numeric, ::ActiveRecord::Type::Binary::Data, ::ActiveRecord::Type::Time::Value, Date, Time, ::ActiveSupport::Duration, T::Class[T.anything])]).returns(T::Enumerable[::Post]) }
                 <% end %>
-                    def find(args); end
+                    sig { params(args: NilClass, block: T.proc.params(object: ::Post).void)).returns(T.nilable(::Post)) }
+                    def find(args = nil, &block); end
 
                     sig { params(args: T.untyped).returns(T.nilable(::Post)) }
                     def find_by(*args); end