Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Active Record find sig to allow a block #1844

Merged
merged 2 commits into from
Apr 8, 2024
Merged

Update Active Record find sig to allow a block #1844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdd80d1
create_sig takes hash instead of TypedParams
bdewater Apr 2, 2024
a225ce0
Update Active Record find sig to allow a block
bdewater Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 41 additions & 54 deletions lib/tapioca/dsl/compilers/active_record_relations.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,18 +667,25 @@ def create_common_methods
end
sigs = [
common_relation_methods_module.create_sig(
parameters: [create_param("args", type: id_types)],
parameters: { args: id_types },
return_type: constant_name,
),
common_relation_methods_module.create_sig(
parameters: [create_param("args", type: array_type)],
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(
Expand Down Expand Up @@ -714,11 +721,11 @@ def create_common_methods
when :first, :last, :take
sigs = [
common_relation_methods_module.create_sig(
parameters: [create_opt_param("limit", type: "NilClass", default: "nil")],
parameters: { limit: "NilClass" },
return_type: as_nilable_type(constant_name),
),
common_relation_methods_module.create_sig(
parameters: [create_param("limit", type: "Integer")],
parameters: { limit: "Integer" },
return_type: "T::Array[#{constant_name}]",
),
]
Expand Down Expand Up @@ -819,26 +826,20 @@ def create_common_methods
case method_name
when :find_each
order = ActiveRecord::Batches.instance_method(:find_each).parameters.include?([:key, :order])
parameters = {
start: "T.untyped",
finish: "T.untyped",
batch_size: "Integer",
error_on_ignore: "T.untyped",
order: ("Symbol" if order),
}.compact
sigs = [
common_relation_methods_module.create_sig(
parameters: [
create_kw_opt_param("start", type: "T.untyped", default: "nil"),
create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
create_kw_opt_param("batch_size", type: "Integer", default: "1000"),
create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
*(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
create_block_param("block", type: "T.proc.params(object: #{constant_name}).void"),
],
parameters: parameters.merge(block: "T.proc.params(object: #{constant_name}).void"),
return_type: "void",
),
common_relation_methods_module.create_sig(
parameters: [
create_kw_opt_param("start", type: "T.untyped", default: "nil"),
create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
create_kw_opt_param("batch_size", type: "Integer", default: "1000"),
create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
*(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
],
parameters: parameters,
return_type: "T::Enumerator[#{constant_name}]",
),
]
Expand All @@ -856,26 +857,20 @@ def create_common_methods
)
when :find_in_batches
order = ActiveRecord::Batches.instance_method(:find_in_batches).parameters.include?([:key, :order])
parameters = {
start: "T.untyped",
finish: "T.untyped",
batch_size: "Integer",
error_on_ignore: "T.untyped",
order: ("Symbol" if order),
}.compact
sigs = [
common_relation_methods_module.create_sig(
parameters: [
create_kw_opt_param("start", type: "T.untyped", default: "nil"),
create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
create_kw_opt_param("batch_size", type: "Integer", default: "1000"),
create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
*(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
create_block_param("block", type: "T.proc.params(object: T::Array[#{constant_name}]).void"),
],
parameters: parameters.merge(block: "T.proc.params(object: T::Array[#{constant_name}]).void"),
return_type: "void",
),
common_relation_methods_module.create_sig(
parameters: [
create_kw_opt_param("start", type: "T.untyped", default: "nil"),
create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
create_kw_opt_param("batch_size", type: "Integer", default: "1000"),
create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
*(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
],
parameters: parameters,
return_type: "T::Enumerator[T::Enumerator[#{constant_name}]]",
),
]
Expand All @@ -894,30 +889,22 @@ def create_common_methods
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])
parameters = {
of: "Integer",
start: "T.untyped",
finish: "T.untyped",
load: "T.untyped",
error_on_ignore: "T.untyped",
order: ("Symbol" if order),
use_ranges: ("T.untyped" if use_ranges),
}.compact
sigs = [
common_relation_methods_module.create_sig(
parameters: [
create_kw_opt_param("of", type: "Integer", default: "1000"),
create_kw_opt_param("start", type: "T.untyped", default: "nil"),
create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
create_kw_opt_param("load", type: "T.untyped", default: "false"),
create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
*(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
*(create_kw_opt_param("use_ranges", type: "T.untyped", default: "nil") if use_ranges),
create_block_param("block", type: "T.proc.params(object: #{RelationClassName}).void"),
],
parameters: parameters.merge(block: "T.proc.params(object: #{RelationClassName}).void"),
return_type: "void",
),
common_relation_methods_module.create_sig(
parameters: [
create_kw_opt_param("of", type: "Integer", default: "1000"),
create_kw_opt_param("start", type: "T.untyped", default: "nil"),
create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
create_kw_opt_param("load", type: "T.untyped", default: "false"),
create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
*(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
*(create_kw_opt_param("use_ranges", type: "T.untyped", default: "nil") if use_ranges),
],
parameters: parameters,
return_type: "::ActiveRecord::Batches::BatchEnumerator",
),
]
Expand Down
11 changes: 6 additions & 5 deletions lib/tapioca/rbi_ext/model.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ def create_type_variable(name, type:, variance: :invariant, fixed: nil, upper: n
end
def create_method(name, parameters: [], return_type: "T.untyped", class_method: false, visibility: RBI::Public.new,
comments: [])
sig = create_sig(parameters: parameters, return_type: return_type)
sig_params = parameters.to_h { |param| [param.param.name, param.type] }
sig = create_sig(parameters: sig_params, return_type: return_type)
create_method_with_sigs(
name,
sigs: [sig],
Expand Down Expand Up @@ -126,13 +127,13 @@ def create_method_with_sigs(name, sigs:, parameters: [], class_method: false, vi

sig do
params(
parameters: T::Array[RBI::TypedParam],
parameters: T::Hash[T.any(String, Symbol), String],
return_type: String,
).returns(RBI::Sig)
end
def create_sig(parameters: [], return_type: "T.untyped")
params = parameters.map do |param|
RBI::SigParam.new(param.param.name, param.type)
def create_sig(parameters:, return_type: "T.untyped")
params = parameters.map do |name, type|
RBI::SigParam.new(name.to_s, type)
end
RBI::Sig.new(params: params, return_type: return_type)
end
Expand Down
6 changes: 4 additions & 2 deletions spec/tapioca/dsl/compilers/active_record_relations_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading