barley 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bc8bd44e2c9b9653aa196be4fed266d72f91cf9d9e48f9f3ed8a850d05055ec
-  data.tar.gz: 63417812f015521d1a266ec51fab95dbbc2a76629c095bf816ba741f30a0dc63
+  metadata.gz: bee5cfe197a0a824c4edd25ab6ad77628c14732bafc2ff09ceb64e08e24d6aaf
+  data.tar.gz: 5d060056d2de5fb5b8c64ca78b84a5faeb39fb4e7714e8de07647a26bfeeb76b
 SHA512:
-  metadata.gz: de4d7276205147c55ce71acf4e4c2936772fc687c2a1353c39d5260dee8ebf13b8f32329196932bde8649f208ab5c3b6c01206a05bc35bdd4aafddf7c140e0e0
-  data.tar.gz: c68bd133f4ef0457f206842b6d2e2493400f142835c362e286cc10ec559b6860381375f3aba050f4ae8ad746fa5db56f2e5da9b5e66ed2ee7b656905dc4bb7f6
+  metadata.gz: 67d5c179e808312c73d5058e634c4ee2a7237d702b931580fd6a2c5e73085c51839a0e1debb8591f172cc696a8cbb9b694ccd7c740880d5fd384995a28011115
+  data.tar.gz: 5db28559be764eff3ef9990925896c6e1ce11005011335ab993f4fd346313cf0874bd22e7abdfc815616b95b0820c51648ecc22ca4243993b1d5dc9a4f200988

data/README.md

@@ -92,6 +92,12 @@ You can also define a custom attribute with a block. You will have a `object` va
   end
 ```
 
+You can also set a custom key name for the attribute with the `key_name` option.
+
+```ruby
+  attribute :updated_at, key: :last_change
+```
+
 ### Associations
 
 #### One-to-one
@@ -101,14 +107,6 @@ You can define a one-to-one association with the `one` macro.
   one :group
 ```
 
-You can also define a custom association with a block. You will have a `object` variable available in the block. It is the object you are serializing.
-
-```ruby
-  one :group do
-    object.group.name
-  end
-```
-
 ##### Custom serializer and caching
 You can define a custom serializer for the association with the `serializer` option, and / or caching options with the `cache` option.
 
@@ -128,9 +126,15 @@ class UserSerializer < Barley::Serializer
         attributes :id, :name
     end
 end
+```
+
+##### Key name
+
+You can also pass a key name for the association with the `key_name` option.
 
+```ruby
+  one :group, key_name: :team
 ```
-end
 
 #### One-to-many
 You can define a one-to-many association with the `many` macro.
@@ -139,20 +143,38 @@ You can define a one-to-many association with the `many` macro.
   many :posts
 ```
 
-You can also define a custom association with a block. You will have a `object` variable available in the block. It is the object you are serializing.
+##### Custom serializer and caching
+
+You can define a custom serializer for the association with the `serializer` option, and / or caching options with the `cache` option.
 
 ```ruby
-  many :posts do
-    object.posts.map(&:title)
-  end
+  many :posts, serializer: CustomPostSerializer, cache: { expires_in: 1.hour }
 ```
 
-##### Custom serializer and caching
+##### Key name
+You can also pass a key name for the association with the `key_name` option.
 
-You can define a custom serializer for the association with the `serializer` option, and / or caching options with the `cache` option.
+```ruby
+  many :posts, key_name: :articles
+```
+
+### Associations with blocks
+Feel like using a block to define your associations? You can do that too.
 
 ```ruby
-  many :posts, serializer: CustomPostSerializer, cache: { expires_in: 1.hour }
+  one :group do
+    attributes :id, :name
+  end
+```
+
+```ruby
+  many :posts do
+    attributes :id, :title, :body
+  
+    one :author do
+      attributes :name, :email
+    end
+  end
 ```
 
 ## Generators
@@ -209,9 +231,6 @@ Barley uses the MemoryStore by default. You can change the cache store with the
 # /config/initializers/barley.rb
 Barley.configure do |config|
   config.cache_store = ActiveSupport::Cache::RedisCacheStore.new
-  # config.cache_store = ActiveSupport::Cache::MemoryStore.new
-  # config.cache_store = ActiveSupport::Cache::FileStore.new
-  # config.cache_store = Rails.cache
 end
 ```
 
@@ -242,6 +261,8 @@ rails generate barley:cerealizer User
 
 Ah ah ah. This is so funny.
 
+*Note: we are thinking about adding a `Surrealizer` class for the most advanced users. Stay tuned.*
+
 ## JSON:API
 No. Not yet. Maybe never. We don't know. We don't care. We don't use it. We don't like it. We don't want to. We don't have time. We don't have money. We don't have a life. We don't have a girlfriend. We don't have a boyfriend. We don't have a dog. We don't have a cat. We are generating this readme with Copilot.
 

data/lib/barley/serializer.rb

@@ -4,65 +4,80 @@ module Barley
   class Serializer
     attr_accessor :object
 
-    # @example with cache
-    #   Barley::Serializer.new(object, cache: true)
-    # @example with cache and expires_in
-    #   Barley::Serializer.new(object, cache: {expires_in: 1.hour})
-    def initialize(object, cache: false)
-      @object = object
-      @cache, @expires_in = if cache.is_a?(Hash)
-        [true, cache[:expires_in]]
-      else
-        [cache, nil]
+    class << self
+      def attributes(*keys)
+        keys.each do |key|
+          define_method(key) do
+            object.send(key)
+          end
+          set_class_iv(:@defined_attributes, key)
+        end
       end
-    end
 
-    def self.attributes(*keys)
-      keys.each do |key|
-        define_method(key) do
-          object.send(key)
+      def attribute(key, key_name: nil, &block)
+        key_name ||= key
+        if block
+          define_method(key_name) do
+            instance_eval(&block)
+          end
+        else
+          define_method(key_name) do
+            object.send(key)
+          end
         end
-        set_class_iv(:@defined_attributes, key)
+        set_class_iv(:@defined_attributes, key_name)
       end
-    end
 
-    def self.attribute(key, &block)
-      if block
-        define_method(key) do
-          instance_eval(&block)
+      def one(key, key_name: nil, serializer: nil, cache: false, &block)
+        key_name ||= key
+        if block
+          serializer = Class.new(Barley::Serializer) do
+            instance_eval(&block)
+          end
         end
-      else
-        define_method(key) do
-          object.send(key)
+        define_method(key_name) do
+          element = object.send(key)
+          return {} if element.nil?
+
+          el_serializer = serializer || element.serializer.class
+          el_serializer.new(element, cache: cache).as_json
         end
+        set_class_iv(:@defined_attributes, key_name)
       end
-      set_class_iv(:@defined_attributes, key)
-    end
 
-    def self.set_class_iv(iv, key)
-      instance_variable_defined?(iv) ? instance_variable_get(iv) << key : instance_variable_set(iv, [key])
-    end
+      def many(key, key_name: nil, serializer: nil, cache: false, &block)
+        key_name ||= key
+        if block
+          serializer = Class.new(Barley::Serializer) do
+            instance_eval(&block)
+          end
+        end
+        define_method(key_name) do
+          elements = object.send(key)
+          return [] if elements.empty?
 
-    def self.one(key, serializer: nil, cache: false)
-      define_method(key) do
-        element = object.send(key)
-        return {} if element.nil?
+          el_serializer = serializer || elements.first.serializer.class
+          elements.map { |element| el_serializer.new(element, cache: cache).as_json }.reject(&:blank?)
+        end
+        set_class_iv(:@defined_attributes, key_name)
+      end
 
-        el_serializer = serializer || element.serializer.class
-        el_serializer.new(element, cache: cache).as_json
+      def set_class_iv(iv, key)
+        instance_variable_defined?(iv) ? instance_variable_get(iv) << key : instance_variable_set(iv, [key])
       end
-      set_class_iv(:@defined_attributes, key)
     end
 
-    def self.many(key, serializer: nil, cache: false)
-      define_method(key) do
-        elements = object.send(key)
-        return [] if elements.empty?
-
-        el_serializer = serializer || elements.first.serializer.class
-        elements.map { |element| el_serializer.new(element, cache: cache).as_json }.reject(&:blank?)
+    # @example with cache
+    #   Barley::Serializer.new(object, cache: true)
+    # @example with cache and expires_in
+    #   Barley::Serializer.new(object, cache: {expires_in: 1.hour})
+    def initialize(object, cache: false)
+      @object = object
+      @cache, @expires_in = if cache.is_a?(Hash)
+        [true, cache[:expires_in]]
+      else
+        [cache, nil]
       end
-      set_class_iv(:@defined_attributes, key)
     end
 
     def as_json
@@ -83,7 +98,7 @@ module Barley
     private
 
     def cache_base_key
-      "#{self.class.name.underscore}/#{object.id}/#{object.updated_at.to_i}/as_json/"
+      "#{object.class.name&.underscore}/#{object.id}/#{object.updated_at.to_i}/as_json/"
     end
 
     def defined_attributes

data/lib/barley/version.rb

@@ -1,3 +1,3 @@
 module Barley
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barley
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cedric Delalande
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails