Add support for cursor: when using in_batches on an ActiveRecord PrivateRelation

[SamuelDev]

In 8.0 rails added support for a custom cursor when calling in_batches on a relation. RBI files generated by tapioca do not currently generate this field.

Rails version: 8.1.0
tapioca version: 0.16.3

[amomchilov]

Hi @SamuelDev, what's the expected type of this cursor?

Would you like to open a PR to modify one of the sigs here:

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

Lines 917 to 952 in 0a9f291

	when :in_batches
	order = ActiveRecord::Batches.instance_method(:in_batches).parameters.include?([:key, :order])
	use_ranges = ActiveRecord::Batches.instance_method(:in_batches).parameters.include?([:key, :use_ranges])
	common_relation_methods_module.create_method("in_batches") do |method|
	method.add_kw_opt_param("of", "1000")
	method.add_kw_opt_param("start", "nil")
	method.add_kw_opt_param("finish", "nil")
	method.add_kw_opt_param("load", "false")
	method.add_kw_opt_param("error_on_ignore", "nil")
	method.add_kw_opt_param("order", ":asc") if order
	method.add_kw_opt_param("use_ranges", "nil") if use_ranges
	method.add_block_param("block")
	method.add_sig do |sig|
	sig.add_param("of", "Integer")
	sig.add_param("start", "T.untyped")
	sig.add_param("finish", "T.untyped")
	sig.add_param("load", "T.untyped")
	sig.add_param("error_on_ignore", "T.untyped")
	sig.add_param("order", "Symbol") if order
	sig.add_param("use_ranges", "T.untyped") if use_ranges
	sig.add_param("block", "T.proc.params(object: #{RelationClassName}).void")
	sig.return_type = "void"
	end
	method.add_sig do |sig|
	sig.add_param("of", "Integer")
	sig.add_param("start", "T.untyped")
	sig.add_param("finish", "T.untyped")
	sig.add_param("load", "T.untyped")
	sig.add_param("error_on_ignore", "T.untyped")
	sig.add_param("order", "Symbol") if order
	sig.add_param("use_ranges", "T.untyped") if use_ranges
	sig.return_type = "::ActiveRecord::Batches::BatchEnumerator"
	end

[SamuelDev]

It is a column name or array of column names. Symbols, possibly strings, unsure of that specific technicality.

[amomchilov]

T.any(String, Symbol) might be a good first approximation. If other types are possible, we can widen the type in the future. It looks like it can be either a single value, or an array of values (it's passed into Array), so perhaps it should be:

T.any(String, Symbol, T::Array[T.any(String, Symbol)])

I won't be able to investigate this myself any time soon, but if you confirm that it works and open a PR, I'd be happy to review and merge