barley 0.4.0 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faa7d627d11906ae112f0a8fd640f0a2d90acacc114c63297a26e227d5120c3d
-  data.tar.gz: c36d22bee59469e7e98f481086a5a32a75ac96d9bab984330a4d945c97efa5f6
+  metadata.gz: 4808cb10061c5a86be6edbf532a6fb041519e4b7b4a08b770e0d63854a5f61e1
+  data.tar.gz: 5ccb1ed50e9d440a0bb3e9c006280e970b70b5ecc64afb7b8660c0d326f58239
 SHA512:
-  metadata.gz: 3adb8da65be384daf38feaf056541f6b3e2c2f7f400917ed2da43a9f382e3bbc28afdad2437fe7489bdcd1ccd3980a587697525f0b493e1ec7b5374acfb61bb8
-  data.tar.gz: a359ed1a3c15f8efdd62ec86112163edc8d423f9d0d8c8790e781c651ac208dfa722a42bb4c93f822b5bbfc2a072626bbf1c9ad088c24354828745476247fc58
+  metadata.gz: 4562ae18d898be75d1abf2d2872bd5f79333f38e6a3e111548624ba6e4b19f4f7316087e36ff35f9103cac56a6b96e9d2f1fb32d1cfb1596430e1b81a1f68c2a
+  data.tar.gz: 13c86fbcb1d2678165bd128ea0e57ca80e1e4d63e3a3ccee09f9ac85838bab7cd0894d75cc832c7a513ac29fd697573039b8ee5a1621be1152e2a22c6525b5ce

data/README.md

@@ -1,8 +1,12 @@
 ![Barley loqo](https://i.imgur.com/am0emi4.png)
 
-Barley is a dead simple, fast, and efficient ActiveModel JSON serializer.
+![Test suite badge](https://github.com/MoskitoHero/barley/actions/workflows/ruby.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/barley.svg)](https://badge.fury.io/rb/barley)
+![Static Badge](https://img.shields.io/badge/Cereal%20-%20100%25%20-%20darklime)
 
-Cerealize your ActiveModel objects into flat hashes with a dead simple, yet versatile DSL, and caching baked in. Our daily bread is to make your API faster. 
+Barley is a dead simple, 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. 
 
 You don't believe us? Check out the [benchmarks](#benchmarks). 😎
 
@@ -24,24 +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 # multiple attributes, optional type checking with dry-types
-  attribute :email # single attribute
-  attribute :value, type: Types::Coercible::Integer # optional type checking with dry-types
-
-  many :posts # relations
-  one :group, serializer: CustomGroupSerializer # custom serializer
-  many :related_users, key: :friends, cache: true # custom key, and caching
-  one :profile, cache: { expires_in: 1.day } do # cache definition, and block (on associations) for nested, on-the-fly serializer
+  
+  attributes id: Types::Strict::Integer, :name
+  
+  attribute :email
+  attribute :value, type: Types::Coercible::Integer
+
+  many :posts
+  
+  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) # use object in a block to return custom code
+      object.badges.map(&:display_name)
     end
   end
     
 end
 ```
 
-The just use the `as_json` method on your model.
+Then just use the `as_json` method on your model.
 
 ```ruby
 user = User.find(1)
@@ -190,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:
 
@@ -386,6 +415,15 @@ ams               :    1299674 allocated - 28.20x more
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+## Contributing
+You can contribute in several ways: reporting bugs, suggesting features, or contributing code. See [our contributing guidelines](CONTRIBUTING.md)
+
+Make sure you adhere to [our code of conduct](CODE_OF_CONDUCT.md). We aim to keep this project open and inclusive.
+
+## 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/).
 

data/Rakefile

@@ -1,3 +1,12 @@
 require "bundler/setup"
 
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << "test"
+end
+desc "Run tests"
+
+task default: :test

data/lib/barley/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Barley
+  class Error < StandardError
+  end
+end

data/lib/barley/serializable.rb

@@ -30,28 +30,45 @@ module Barley
       # @param klass [Class] the serializer class
       # @param cache [Boolean, Hash<Symbol, ActiveSupport::Duration>] whether to cache the result, or a hash with options for the cache
       def serializer(klass, cache: false)
-        define_method(:serializer) do
-          klass.new(self, cache: cache)
+        # We need to silence the warnings because we are defining a method with the same name as the parameter
+        # This avoids :
+        # - warning: method redefined; discarding old serializer
+        # - warning: previous definition of serializer was here
+        Kernel.silence_warnings do
+          define_method(:serializer) do
+            klass.new(self, cache: cache)
+          end
         end
       end
     end
 
     included do
-      serializer "#{self}Serializer".constantize
+      begin
+        serializer "#{self}Serializer".constantize
+      rescue NameError
+        raise Barley::Error, "Could not find serializer for #{self}. Please define a #{self}Serializer class."
+      end
 
       # Serializes the model
       #
       # @note this method does not provide default rails options like `only` or `except`.
       #   This is because the Barley serializer should be the only place where the attributes are defined.
       #
-      # @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 root [Boolean] whether to include the root key in the hash
+      # @option options [Class] :serializer the serializer to use
+      # @option options [Boolean, Hash<Symbol, ActiveSupport::Duration>] :cache whether to cache the result, or a hash with options for the cache
+      # @option options [Boolean] :root whether to include the root key
       #
       # @return [Hash] the serialized attributes
-      def as_json(serializer: nil, cache: false, root: false)
-        serializer ||= self.serializer.class
-        serializer.new(self, cache: cache, root: root).serializable_hash
+      def as_json(options = nil)
+        options ||= {}
+        serializer = options[:serializer] || self.serializer.class
+        cache = options[:cache] || false
+        root = options[:root] || false
+        begin
+          serializer.new(self, cache: cache, root: root).serializable_hash
+        rescue NameError
+          raise Barley::Error, "Could not find serializer for #{self}. Please define a #{serializer} class."
+        end
       end
     end
   end

data/lib/barley/serializer.rb

@@ -3,8 +3,11 @@
 module Barley
   class Serializer
     attr_accessor :object
+    attr_accessor :context
 
     class << self
+      attr_accessor :defined_attributes
+
       # Defines attributes for the serializer
       #
       # Accepts either a list of symbols or a hash of symbols and Dry::Types, or a mix of both
@@ -72,16 +75,12 @@ module Barley
       # @param block [Proc] a block to use to compute the value
       def attribute(key, key_name: nil, type: nil, &block)
         key_name ||= key
-        if block
-          define_method(key_name) do
-            type.nil? ? instance_eval(&block) : type[instance_eval(&block)]
-          end
-        else
-          define_method(key_name) do
-            type.nil? ? object.send(key) : type[object.send(key)]
-          end
+        define_method(key_name) do
+          value = block ? instance_eval(&block) : object.send(key)
+          type.nil? ? value : type[value]
         end
-        set_class_iv(:@defined_attributes, key_name)
+
+        self.defined_attributes = (defined_attributes || []) << key_name
       end
 
       # Defines a single association for the serializer
@@ -131,7 +130,7 @@ module Barley
           el_serializer = serializer || element.serializer.class
           el_serializer.new(element, cache: cache).serializable_hash
         end
-        set_class_iv(:@defined_attributes, key_name)
+        self.defined_attributes = (defined_attributes || []) << key_name
       end
 
       # Defines a collection association for the serializer
@@ -181,17 +180,7 @@ module Barley
           el_serializer = serializer || elements.first.serializer.class
           elements.map { |element| el_serializer.new(element, cache: cache).serializable_hash }.reject(&:blank?)
         end
-        set_class_iv(:@defined_attributes, key_name)
-      end
-
-      # Either sets or appends a key to an instance variable
-      #
-      # @api private
-      #
-      # @param iv [Symbol] the instance variable to set
-      # @param key [Symbol] the key to add to the instance variable
-      def set_class_iv(iv, key)
-        instance_variable_defined?(iv) ? instance_variable_get(iv) << key : instance_variable_set(iv, [key])
+        self.defined_attributes = (defined_attributes || []) << key_name
       end
     end
 
@@ -236,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
@@ -253,21 +261,21 @@ module Barley
     #
     # @return [Array<Symbol>] the defined attributes
     def defined_attributes
-      self.class.instance_variable_get(:@defined_attributes)
+      self.class.defined_attributes
     end
 
     # 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.0"
+  VERSION = "0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barley
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: '0.5'
 platform: ruby
 authors:
 - Cedric Delalande
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2024-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,8 +38,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.7.1
-description: Cerealize your ActiveModel objects into flat JSON objects with a dead
-  simple DSL. Our daily bread is to make your API faster.
+description: 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.
 email:
 - weengs@moskitohero.com
 executables: []
@@ -52,6 +53,7 @@ files:
 - lib/barley.rb
 - lib/barley/cache.rb
 - lib/barley/configuration.rb
+- lib/barley/error.rb
 - lib/barley/railtie.rb
 - lib/barley/serializable.rb
 - lib/barley/serializer.rb
@@ -74,7 +76,8 @@ metadata:
   homepage_uri: https://github.com/moskitohero/barley
   source_code_uri: https://github.com/moskitohero/barley
   changelog_uri: https://github.com/moskitohero/barley/CHANGELOG.md
-post_install_message:
+  documentation_uri: https://rubydoc.info/github/MoskitoHero/barley/main
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -89,8 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
-summary: Barley is a dead simple, fast, and efficient ActiveModel JSON serializer.
+summary: Barley is a dead simple, fast, and efficient ActiveModel serializer.
 test_files: []