MoskitoHero / barley

Barley is a fast and efficient ActiveModel serializer

MIT License

80 stars 3 forks source link

Add with_context class method to the serializer #3

Closed MoskitoHero closed 5 months ago

MoskitoHero commented 5 months ago

Description

This PR adds a with_context method to the Barley::Serializer class.

This allows you to use context in your serializer:

attribute :name do
  "#{object.name[context.locale]}" # Will use the locale from the context
end

So that when you can do

serializer.with_context(current_user: current_user, locale: I18n.locale)
# => #<Barley::Serializer:0x00007f8f3b8b3e08 @object=#<Product id: 1, name: "Product 1">, @context=#<struct current_user=1, locale=:en>>

And you get access to current_user and locale with the context.* shorthands.

Type of change

Please delete options that are not relevant.

[~] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[~] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] This change requires a documentation update

How Has This Been Tested?

Added a test in SerializerTest

[x] Barley::SerializerTest

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing tests pass locally with my changes