barley 0.4.1 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d882b89bf1bf77259eda96813c4732ef1b286142ecb29fcb945837b743e089c9
-  data.tar.gz: 87dc3b213a614957a668c08865b87eb44f805cf76b79a60c710025a7d18257d8
+  metadata.gz: 4808cb10061c5a86be6edbf532a6fb041519e4b7b4a08b770e0d63854a5f61e1
+  data.tar.gz: 5ccb1ed50e9d440a0bb3e9c006280e970b70b5ecc64afb7b8660c0d326f58239
 SHA512:
-  metadata.gz: a7eb159a6e40374364504f5c828d7e1f82e7a581bd89fe374182916b0dbc6863caaea779acf409e58c8fe60ff3614acdfa944bb3f74dbd808957925db146dded
-  data.tar.gz: d84b0157c80e83cfa28dbafda0fd300f2774c4362b5e1e47f9fc0381fb0cd8713dce2f1b27f4cfb9896af2c11d354d92b8df0dcfaee6a94bb69e6aca738e45b2
+  metadata.gz: 4562ae18d898be75d1abf2d2872bd5f79333f38e6a3e111548624ba6e4b19f4f7316087e36ff35f9103cac56a6b96e9d2f1fb32d1cfb1596430e1b81a1f68c2a
+  data.tar.gz: 13c86fbcb1d2678165bd128ea0e57ca80e1e4d63e3a3ccee09f9ac85838bab7cd0894d75cc832c7a513ac29fd697573039b8ee5a1621be1152e2a22c6525b5ce

data/README.md

@@ -200,6 +200,25 @@ Feel like using a block to define your associations? You can do that too.
   end
 ```
 
+## Context
+You can pass a context to the serializer with the `with_context` method.
+
+```ruby
+serializer = PostSerializer.new(Post.last).with_context(current_user: current_user)
+```
+
+This context will be available in the serializer with the `context` method.
+
+```ruby
+class PostSerializer < Barley::Serializer
+  attributes :id, :title, :body
+
+  attribute :is_owner do
+    object.user == context.current_user
+  end
+end
+```
+
 ## Generators
 You have two generators available. One to generate the serializer class:
 

data/lib/barley/serializer.rb

@@ -3,6 +3,7 @@
 module Barley
   class Serializer
     attr_accessor :object
+    attr_accessor :context
 
     class << self
       attr_accessor :defined_attributes
@@ -224,6 +225,25 @@ module Barley
       Barley::Cache.delete(key)
     end
 
+    # Sets the context object for the serializer
+    #
+    # The context object is a Struct built from the given arguments.
+    # It can be used to pass additional data to the serializer. The context object is accessible in the serializer with the `context` attribute.
+    # @example
+    #   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>>
+    #   # In the serializer:
+    #   attribute :name do
+    #     "#{object.name[context.locale]}" # Will use the locale from the context
+    #   end
+    # @param args [Hash] the context object attributes
+    # @return [Barley::Serializer] the serializer
+    def with_context(**args)
+      @context = Struct.new(*args.keys).new(*args.values)
+
+      self
+    end
+
     private
 
     # @api private
@@ -247,15 +267,15 @@ module Barley
     # Serializes the object
     #
     # @api private
+    # @raise [Barley::Error] if no attribute or relation is defined in the serializer
     #
     # @return [Hash] the serializable hash
     def _serializable_hash
-      hash = {}
+      raise Barley::Error, "No attribute or relation defined in #{self.class}" if defined_attributes.blank?
 
-      defined_attributes.each do |key|
-        hash[key] = send(key)
+      hash = defined_attributes.each_with_object({}) do |key, result|
+        result[key] = send(key)
       end
-
       @root ? {root_key => hash} : hash
     end
 

data/lib/barley/version.rb

@@ -1,3 +1,3 @@
 module Barley
-  VERSION = "0.4.1"
+  VERSION = "0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barley
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: '0.5'
 platform: ruby
 authors:
 - Cedric Delalande
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2024-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails