barley 0.6 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4143d89558b7c17c5c0ca1c0fc3fc20083b178a79ecdbc957e6cc3a0dc170189
-  data.tar.gz: 0d3c0c2c74ea618a5df4a4ed29155f625ee58836024112816aa5055c3c064531
+  metadata.gz: 802ad211955dc1b4f0579ff2f88ac1e88a56eb2425317ae46b1cda590cfc1f26
+  data.tar.gz: 5f5e309f03e3422f9b2bd7e7b7319994c5c63d3367043e6f6c19328784e73c01
 SHA512:
-  metadata.gz: 68d5f3bd3ba0a85e4d9365fa928fe425323bd469fc11e68e60ecbc8d3f52f078c2a449109446668c18750d18633b9de6ce3f4478d82db41c0847b1ec49289236
-  data.tar.gz: 7ab87897947545f171ce458042c63deecfb6e22555cfc97e508d2233215360ac78d804a32d8bf46bd73e9edac3104622e3831203263056cf70a1085401d908cb
+  metadata.gz: 3189c87d7fe0d3cdb96a6c503a56f0469a3f97cd965feeafb0337e351cdd8199990b63ac1d119381ef3058914ed07b41f81fc9b0d1789059ae3d944171731226
+  data.tar.gz: 000bdb7632ea4ab4c1d015fdae029220dc35cbae03ddd1999cf016f21e1c08f46699a7ad610fcc816abbb21e014408c2b838e37a3ef036cb3806b373981f15ab

data/README.md

@@ -6,7 +6,7 @@
 
 Barley is a fast and efficient ActiveModel serializer.
 
-Cerealize your ActiveModel objects into flat hashes with a dead simple, yet versatile DSL, and caching and type-checking baked in. Our daily bread is to make your API faster. 
+Cerealize your ActiveModel objects into flat hashes with a dead simple, yet versatile DSL, and caching and type-checking baked in. Our daily bread is to make your API faster.
 
 You don't believe us? Check out the [benchmarks](#benchmarks). 😎
 
@@ -28,30 +28,30 @@ Then define your attributes and associations in a serializer class.
 ```ruby
 # /app/serializers/user_serializer.rb
 class UserSerializer < Barley::Serializer
-  
+
   attributes id: Types::Strict::Integer, :name
-  
+
   attribute :email
   attribute :value, type: Types::Coercible::Integer
 
   many :posts
-  
+
   many :posts, key_name: :featured, scope: :featured
-  
+
   many :posts, key_name: :popular, scope: -> { where("views > 10_000").limit(3) }
-  
+
   one :group, serializer: CustomGroupSerializer
-  
+
   many :related_users, key: :friends, cache: true
-  
+
   one :profile, cache: { expires_in: 1.day } do
     attributes :avatar, :social_url
-    
+
     attribute :badges do
       object.badges.map(&:display_name)
     end
   end
-    
+
 end
 ```
 
@@ -89,7 +89,7 @@ You can also define the serializer class with the `serializer` macro.
 # /app/models/user.rb
 class User < ApplicationRecord
   include Barley::Serializable
-  
+
   serializer UserSerializer
 end
 ```
@@ -143,12 +143,12 @@ You can define a custom serializer for the association with the `serializer` opt
 
 You can of course define serializers with inner classes for simple needs.
 
-```ruby 
+```ruby
 class UserSerializer < Barley::Serializer
   attributes :id, :name, :email, :created_at, :updated_at
 
   one :group, serializer: LocalGroupSerializer
-  
+
     class LocalGroupSerializer < Barley::Serializer
         attributes :id, :name
     end
@@ -208,7 +208,7 @@ Feel like using a block to define your associations? You can do that too.
 ```ruby
   many :posts do
     attributes :id, :title, :body
-  
+
     one :author do
       attributes :name, :email
     end
@@ -240,7 +240,7 @@ class PostSerializer < Barley::Serializer
   attribute :is_owner do
     object.user == context.current_user
   end
-  
+
   many :comments do
     many :likes do
       attribute :is_owner do
@@ -264,7 +264,7 @@ serializer = PostSerializer.new(Post.last, context: my_context)
 You have two generators available. One to generate the serializer class:
 
 ```shell
-rails generate barley:serializer User 
+rails generate barley:serializer User
 # or
 rails generate barley:serializer User --name=CustomUserSerializer
 ```
@@ -318,7 +318,7 @@ end
 ```
 
 ## Type checking
-Barley can check the type of the object you are serializing with the [dry-types](https://dry-rb.org/gems/dry-types/main/) gem. 
+Barley can check the type of the object you are serializing with the [dry-types](https://dry-rb.org/gems/dry-types/main/) gem.
 
 It will raise an error if the object is not of the expected type, or coerce it to the correct type and perform constraints checks.
 
@@ -345,7 +345,7 @@ You will soon be able to replace all occurrences of `Serializer` with `Cerealize
 # /app/models/user.rb
 class User < ApplicationRecord
   include Barley::Cerealizable
-  
+
   cerealizer UserCerealizer
 end
 
@@ -464,8 +464,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/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
@@ -172,7 +179,7 @@ module Barley
       # @param key_name [Symbol] the key name in the hash
       # @param serializer [Class] the serializer to use
       # @param cache [Boolean, Hash<Symbol, ActiveSupport::Duration>] whether to cache the result, or a hash with options for the cache
-      # @param scope [Symbol] the scope to use to fetch the elements
+      # @param scope [Symbol, Proc] the scope to use to fetch the elements
       # @param block [Proc] a block to use to define the serializer inline
       def many(key, key_name: nil, serializer: nil, cache: false, scope: nil, &block)
         key_name ||= key
@@ -183,6 +190,11 @@ module Barley
         end
         define_method(key_name) do
           elements = object.send(key)
+          if scope.is_a?(Symbol)
+            elements = elements.send(scope)
+          elsif scope.is_a?(Proc)
+            elements = elements.instance_exec(&scope)
+          end
           return [] if elements.empty?
 
           el_serializer = serializer || elements.first.serializer.class

data/lib/barley/version.rb

@@ -1,3 +1,3 @@
 module Barley
-  VERSION = "0.6"
+  VERSION = "0.6.2"
 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'
+  version: 0.6.2
 platform: ruby
 authors:
 - Cedric Delalande
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails