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

Support for heterogenous lists? #335

Open
felixwatts opened this issue Jul 31, 2023 · 4 comments · May be fixed by #396
Open

Support for heterogenous lists? #335

felixwatts opened this issue Jul 31, 2023 · 4 comments · May be fixed by #396
Labels
enhancement New feature or request

Comments

@felixwatts
Copy link

Is your feature request related to a problem? Please describe.

I need to implement an API that returns a single JSON list containing items of multiple types.

If heterogenous lists are already supported I can't find any documentation on how to use that feature.

Describe the solution you'd like

foos = FooResource.new([foo1, foo2])
bars = BarResource.new([bar1, bar2])
foos_and_bars = foos + bars
json = Alba.serialize(foos_and_bars)

Describe alternatives you've considered

  1. Use one Resource type for multiple actual types using some logic in the resource class
  2. Manually construct a JSON list from two Alba generated lists of single typed items
  3. Try to negotiate a change to the API definition
  4. Don't use Alba

Additional context
@felixwatts felixwatts added the enhancement New feature or request label Jul 31, 2023
@okuramasafumi
Copy link
Owner

Alba currently does not support this kind of feature. You can use to_h to generate a Hash and manually combine them.

I've come up with the new API below:

class FooResource
# Resource for Foo
end

class BarResource
# Resource for Bar
end

Alba.serialize([foo, bar], each_resource: true) # => Use FooResource and BarResource

The new each_resource option makes Alba.serialize infers resource class for each object. This would be a slow API but might be good fit for your use case. What do you think?

@felixwatts
Copy link
Author

Yea that seems to make sense. I've personally got a workaround working using a single resource type for both actual types, but this would definitely be cleaner.

@okuramasafumi
Copy link
Owner

@felixwatts I'm interested in how you workaround this problem, could you share the code?

@okuramasafumi
Copy link
Owner

I'm closing this issue since there's some workaround. I feel I can implement it when finding a high demand of this feature, so feel free to add some comments if you want this feature.

@okuramasafumi okuramasafumi reopened this Nov 29, 2024
@okuramasafumi okuramasafumi linked a pull request Nov 29, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Alba serialize collection heterogeneous okuramasafumi/alba
2 participants
@felixwatts @okuramasafumi