Skip to content

Update attributes method signatures to use optional keyword arguments… #8

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

Merged
Syati merged 1 commit into from
Sep 9, 2025
Merged

Update attributes method signatures to use optional keyword arguments… #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 3 additions & 6 deletions lib/structured_params/params.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,8 @@ def errors
end

# Convert structured objects to Hash and get attributes
#: (symbolize: true, compact: false) -> Hash[Symbol, untyped]
#: (symbolize: false, compact: false) -> Hash[String, untyped]
#: (symbolize: true, compact: true) -> Hash[Symbol, untyped]
#: (symbolize: false, compact: true) -> Hash[String, untyped]
#: (?symbolize: false, ?compact: bool) -> Hash[String, untyped]
#: (?symbolize: true, ?compact: bool) -> Hash[Symbol, untyped]
def attributes(symbolize: false, compact: false)
attrs = super()

Expand Down Expand Up @@ -154,8 +152,7 @@ def format_error_path(attr_name, index = nil)
end

# Serialize structured values
#: (bool, compact: false) -> untyped
#: (bool, compact: true) -> untyped
#: (bool, ?compact: bool) -> untyped
def serialize_structured_value(value, compact: false)
case value
when Array
Expand Down
18 changes: 6 additions & 12 deletions sig/structured_params/params.rbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,10 @@ module StructuredParams
def errors: () -> ::StructuredParams::Errors

# Convert structured objects to Hash and get attributes
# : (symbolize: true, compact: false) -> Hash[Symbol, untyped]
# : (symbolize: false, compact: false) -> Hash[String, untyped]
# : (symbolize: true, compact: true) -> Hash[Symbol, untyped]
# : (symbolize: false, compact: true) -> Hash[String, untyped]
def attributes: (symbolize: true, compact: false) -> Hash[Symbol, untyped]
| (symbolize: false, compact: false) -> Hash[String, untyped]
| (symbolize: true, compact: true) -> Hash[Symbol, untyped]
| (symbolize: false, compact: true) -> Hash[String, untyped]
# : (?symbolize: false, ?compact: bool) -> Hash[String, untyped]
# : (?symbolize: true, ?compact: bool) -> Hash[Symbol, untyped]
def attributes: (?symbolize: false, ?compact: bool) -> Hash[String, untyped]
| (?symbolize: true, ?compact: bool) -> Hash[Symbol, untyped]

private

Expand Down Expand Up @@ -74,10 +70,8 @@ module StructuredParams
def format_error_path: (Symbol, Integer?) -> String

# Serialize structured values
# : (bool, compact: false) -> untyped
# : (bool, compact: true) -> untyped
def serialize_structured_value: (bool, compact: false) -> untyped
| (bool, compact: true) -> untyped
# : (bool, ?compact: bool) -> untyped
def serialize_structured_value: (bool, ?compact: bool) -> untyped

# Integrate structured parameter errors into parent errors
# : (untyped, String) -> void
Expand Down