barley 0.6.1 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80e724f1d510a0774072dab90c06262278a06fd49adff8a77314852c2aafbe7f
-  data.tar.gz: a13898b638153e90c95c25d0558c54e63b2514c6095be81c5755fb5d92dbb544
+  metadata.gz: f6246aafe191aa99a01d5bcda56530dda4be81aa4b83a4626a138074b857524b
+  data.tar.gz: 483efb36394fcb402461336e82ba348d7960d59911885e0239f5e28a9a255716
 SHA512:
-  metadata.gz: da037e1c4749228e9fa48db4dcc00a8b614ebac1acc5ba0646c61fce0b77a377e530581b7536bc08b3111747ed6303ce60d3a275ac4c8cef2231a1ef726d873b
-  data.tar.gz: 49b297c3db282da63110f28d9599157ac91f50c7fec42916e4a387c20ef0010ebfd3e4b4c53b03baa61985cdf17cdd7b79412eb388551d7c5a58d2c5f00b36b3
+  metadata.gz: 4b820717e738c2a0e4e5f19f01c16729d844ceaa5098d3a427ced289ef670da1827635f75ea7c55781e00c92e26d47437dccdfe298ee26658bb24688850415c2
+  data.tar.gz: 8b080b1d166123c465a21a3728cee601c677d15766728c46c24fe3f957fd47974317e49024d9da84db21c028ef29fad9b6ab8baa1365541f00b9fc0c451464da

data/README.md

@@ -40,6 +40,8 @@ class UserSerializer < Barley::Serializer
 
   many :posts, key_name: :popular, scope: -> { where("views > 10_000").limit(3) }
 
+  many :posts, key_name: :in_current_language, scope: -> (context) { where(language: context.language) }
+
   one :group, serializer: CustomGroupSerializer
 
   many :related_users, key: :friends, cache: true
@@ -59,7 +61,7 @@ Then just use the `as_json` method on your model.
 
 ```ruby
 user = User.find(1)
-user.as_json
+user.as_json(only: [:id, :name, posts: [:id, :title]])
 ```
 
 ## Installation
@@ -189,6 +191,12 @@ You can pass a scope to the association with the `scope` option. It can either b
   many :posts, scope: -> { where(published: true).limit(4) }
 ```
 
+You can also pass a context to the lambda. See the [context section](#context) for more details.
+
+```ruby
+  many :posts, scope: -> (context) { where(language: context.language) }
+```
+
 ##### Key name
 You can also pass a key name for the association with the `key_name` option.
 
@@ -251,6 +259,12 @@ class PostSerializer < Barley::Serializer
 end
 ```
 
+The context is also available in the scope of the lambda passed to the `scope` option of the `many` macro. See the [scope section](#scope) for more details.
+
+```ruby
+  many :posts, scope: -> (context) { where(language: context.language) }
+```
+
 ### Using a custom context object
 Barley generates a Struct from the context hash you pass to the with_context method. But you can also pass a custom context object directly in the initializer instead.
 
@@ -464,8 +478,3 @@ Make sure you adhere to [our code of conduct](CODE_OF_CONDUCT.md). We aim to kee
 ## Security
 
 Please refer to our [security guidelines](SECURITY.md)
-
-## Credits
-Barley is brought to you by the developer team from [StockPro](https://www.stock-pro.fr/).
-
-[![Barley is brought to you by StockPro](https://i.imgur.com/5a0veEG.png)](https://www.stock-pro.fr/)

data/lib/barley/error.rb

@@ -3,4 +3,7 @@
 module Barley
   class Error < StandardError
   end
+
+  class InvalidAttributeError < Error
+  end
 end

data/lib/barley/serializable.rb

@@ -65,7 +65,7 @@ module Barley
         cache = options[:cache] || false
         root = options[:root] || false
         begin
-          serializer.new(self, cache: cache, root: root).serializable_hash
+          serializer.new(self, cache: cache, root: root, only: options[:only], except: options[:except]).serializable_hash
         rescue NameError
           raise Barley::Error, "Could not find serializer for #{self}. Please define a #{serializer} class."
         end

data/lib/barley/serializer.rb

@@ -73,11 +73,18 @@ module Barley
       # @param key_name [Symbol] the key name in the hash
       # @param type [Dry::Types] the type to use, or coerce the value to
       # @param block [Proc] a block to use to compute the value
+      # @raise [Barley::InvalidAttributeError] if the value does not match the type - when a type is provided
       def attribute(key, key_name: nil, type: nil, &block)
         key_name ||= key
         define_method(key_name) do
           value = block ? instance_eval(&block) : object.send(key)
-          type.nil? ? value : type[value]
+          if type.nil?
+            value
+          else
+            raise Barley::InvalidAttributeError, "Invalid value type found for attribute #{key_name}::#{type.name}: #{value}::#{value.class}" unless type.valid?(value)
+
+            type[value]
+          end
         end
 
         self.defined_attributes = (defined_attributes || []) << key_name
@@ -128,7 +135,9 @@ module Barley
           return {} if element.nil?
 
           el_serializer = serializer || element.serializer.class
-          el_serializer.new(element, cache: cache, context: @context).serializable_hash
+          only = @only.find { |k| k.is_a?(Hash) && k.key?(key) }.slice(key).values.first if @only.present?
+          except = @except.find { |k| k.is_a?(Hash) && k.key?(key) }.slice(key).values.first if @except.present?
+          el_serializer.new(element, cache: cache, context: @context, only: only, except: except).serializable_hash
         end
         self.defined_attributes = (defined_attributes || []) << key_name
       end
@@ -186,12 +195,18 @@ module Barley
           if scope.is_a?(Symbol)
             elements = elements.send(scope)
           elsif scope.is_a?(Proc)
-            elements = elements.instance_exec(&scope)
+            elements = if scope.arity == 1
+              elements.instance_exec(@context, &scope)
+            else
+              elements.instance_exec(&scope)
+            end
           end
           return [] if elements.empty?
 
           el_serializer = serializer || elements.first.serializer.class
-          elements.map { |element| el_serializer.new(element, cache: cache, context: @context).serializable_hash }.reject(&:blank?)
+          only = @only.find { |k| k.is_a?(Hash) && k.key?(key) }.slice(key).values.first if @only.present?
+          except = @except.find { |k| k.is_a?(Hash) && k.key?(key) }.slice(key).values.first if @except.present?
+          elements.map { |element| el_serializer.new(element, cache: cache, context: @context, only: only, except: except).serializable_hash }.reject(&:blank?)
         end
         self.defined_attributes = (defined_attributes || []) << key_name
       end
@@ -207,10 +222,14 @@ module Barley
     # @param cache [Boolean, Hash<Symbol, ActiveSupport::Duration>] a boolean to cache the result, or a hash with options for the cache
     # @param root [Boolean] whether to include the root key in the hash
     # @param context [Object] an optional context object to pass additional data to the serializer
-    def initialize(object, cache: false, root: false, context: nil)
+    # @param only [Array<Symbol>] an array of attributes to include
+    # @param except [Array<Symbol>] an array of attributes to exclude
+    def initialize(object, cache: false, root: false, context: nil, only: nil, except: nil)
       @object = object
       @context = context
       @root = root
+      @only = only
+      @except = except
       @cache, @expires_in = if cache.is_a?(Hash)
         [true, cache[:expires_in]]
       else
@@ -222,13 +241,22 @@ module Barley
     #
     # @return [Hash] the serializable hash
     def serializable_hash
-      if @cache
+      hash = if @cache
         Barley::Cache.fetch(cache_base_key, expires_in: @expires_in) do
           _serializable_hash
         end
       else
         _serializable_hash
       end
+      if @only.present?
+        only = @only.map { |k| k.is_a?(Hash) ? k.keys.first : k }
+        hash.slice!(*only)
+      end
+      if @except.present?
+        except = @except.reject { |k| k.is_a?(Hash) }
+        hash.except!(*except)
+      end
+      hash
     end
 
     # Clears the cache for the object

data/lib/barley/version.rb

@@ -1,3 +1,3 @@
 module Barley
-  VERSION = "0.6.1"
+  VERSION = "0.7"
 end

data/lib/barley.rb

@@ -15,6 +15,7 @@ module Barley
 
   autoload :Cache, "barley/cache"
   autoload :Error, "barley/error"
+  autoload :InvalidAttributeError, "barley/error"
   autoload :Serializable, "barley/serializable"
   autoload :Serializer, "barley/serializer"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barley
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: '0.7'
 platform: ruby
 authors:
 - Cedric Delalande
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails