transmutation 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93679644e2df5418371d258fb0ede26d51bc9e29c4f835990ce5fa52f38dface
-  data.tar.gz: 64c956a59e385145d1870e949eadbe078db170e950ef711f1c4e46e735a8462c
+  metadata.gz: a1184809d63cb5abaad091e433a5e150579f5ca634a5522c57b7dd49c3465a3c
+  data.tar.gz: a0e2bddde883737a82369d14cd4bc75235ea1dee366c7a0234a262e29930a74c
 SHA512:
-  metadata.gz: 704c1832843d5d5d19a8ec26c672ed9d5f7cae9716f789f6622d0f3bf38aefb97d7ca9a7290ef954e7dc47824f1173e4c823b52272f4f3363b53e14c61f212c1
-  data.tar.gz: 3eaaf2c39d9c3e6f3ac448ce529932751b23edd43675e4eb04623e985e69ef53f20d95e5862d0e97d543919f690d3f8eff96ccc90d83e7ff43002c0ffe24c0ae
+  metadata.gz: ee23262517dba8436c182542b02bd3e1b15df0225b84eae7dedb106c4d155cf6dd78db791e9a98d44c57654dcf87d9aa8110e87cde6bface0943952199f8e2a5
+  data.tar.gz: 8b23bfbd305587fde6d6fef4a714840a73e4415d27902c3169dd06561f141b127944d64f13029a37f9aaf10d88bdab5b1059554ae132fc4584c899f6ecb3148e

data/.rubocop.yml

@@ -16,4 +16,8 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 
+Metrics/ParameterLists:
+  Enabled: true
+  CountKeywordArgs: false
+
 require: rubocop-rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    transmutation (0.2.3)
+    transmutation (0.3.0)
       zeitwerk (~> 2.6.15)
 
 GEM

data/lib/transmutation/serialization/lookup.rb

@@ -12,9 +12,9 @@ module Transmutation
       # Bubbles up the namespace until we find a matching serializer.
       #
       # @see Transmutation::Serialization#lookup_serializer
+      # @note This never bubbles up the object's namespace, only the caller's namespace.
       #
-      # Example:
-      #
+      # @example
       #   namespace: Api::V1::Admin::Detailed
       #   serializer: Chat::User
       #
@@ -25,11 +25,7 @@ module Transmutation
       #   - Api::V1::Chat::UserSerializer
       #   - Api::Chat::UserSerializer
       #   - Chat::UserSerializer
-      #
-      #   Note: This never bubbles up the object's namespace, only the caller's namespace.
       def serializer_for(object, serializer: nil)
-        return Transmutation::CollectionSerializer if object.respond_to?(:map)
-
         serializer_name = serializer_name_for(object, serializer: serializer)
 
         return constantize_serializer!(Object, serializer_name, object: object) if serializer_name.start_with?("::")
@@ -38,7 +34,7 @@ module Transmutation
           return potential_namespace.const_get(serializer_name) if potential_namespace.const_defined?(serializer_name)
         end
 
-        raise SerializerNotFound.new(@object, namespace: serializer_namespace, name: serializer_name)
+        raise SerializerNotFound.new(object, namespace: serializer_namespace, name: serializer_name)
       end
 
       # Returns the highest specificity serializer name for the given object.
@@ -47,8 +43,6 @@ module Transmutation
       #
       # @return [String] The serializer name.
       def serializer_name_for(object, serializer: nil)
-        return "::Transmutation::CollectionSerializer" if object.respond_to?(:map)
-
         "#{serializer&.delete_suffix("Serializer") || object.class.name}Serializer"
       end
 

data/lib/transmutation/serialization/rendering.rb

@@ -3,11 +3,11 @@
 module Transmutation
   module Serialization
     module Rendering
-      def render(json: nil, serialize: true, **args)
+      def render(json: nil, serialize: true, namespace: nil, serializer: nil, max_depth: 1, **args)
         return super(**args) unless json
-        return super(json: json, **args) unless serialize
+        return super(**args, json: json) unless serialize
 
-        super(**args, json: serialize(json))
+        super(**args, json: serialize(json, namespace: namespace, serializer: serializer, max_depth: max_depth))
       end
     end
   end

data/lib/transmutation/serialization.rb

@@ -8,10 +8,18 @@ module Transmutation
     # @param object [Object] The object to serialize.
     # @param namespace [String, Symbol, Module] The namespace to lookup the serializer in.
     # @param serializer [String, Symbol, Class] The serializer to use.
+    # @param max_depth [Integer] The maximum depth of nested associations to serialize.
     #
     # @return [Transmutation::Serializer] The serialized object. This will respond to `#as_json` and `#to_json`.
-    def serialize(object, namespace: nil, serializer: nil)
-      lookup_serializer(object, namespace: namespace, serializer: serializer).new(object)
+    def serialize(object, namespace: nil, serializer: nil, depth: 0, max_depth: 1)
+      if object.respond_to?(:map)
+        return object.map do |item|
+          serialize(item, namespace: namespace, serializer: serializer, depth: depth, max_depth: max_depth)
+        end
+      end
+
+      lookup_serializer(object, namespace: namespace, serializer: serializer)
+        .new(object, depth: depth, max_depth: max_depth)
     end
 
     # Lookup the serializer for the given object.
@@ -29,7 +37,7 @@ module Transmutation
     end
 
     private_class_method def self.included(base)
-      base.include(Rendering) if base.respond_to?(:render)
+      base.include(Rendering) if base.method_defined?(:render)
     end
   end
 end

data/lib/transmutation/serializer.rb

@@ -10,12 +10,20 @@ module Transmutation
   #     attribute :full_name do
   #       "#{object.first_name} #{object.last_name}".strip
   #     end
+  #
+  #     belongs_to :organization
+  #
+  #     has_many :posts
   #   end
   class Serializer
     extend ClassAttributes
 
-    def initialize(object)
+    include Transmutation::Serialization
+
+    def initialize(object, depth: 0, max_depth: 1)
       @object = object
+      @depth = depth
+      @max_depth = max_depth
     end
 
     def to_json(options = {})
@@ -24,39 +32,84 @@ module Transmutation
 
     def as_json(_options = {})
       attributes_config.each_with_object({}) do |(attr_name, attr_options), hash|
-        hash[attr_name.to_s] = attr_options[:block] ? instance_exec(&attr_options[:block]) : object.send(attr_name)
+        if attr_options[:association]
+          hash[attr_name.to_s] = instance_exec(&attr_options[:block]) if @depth + 1 <= @max_depth
+        else
+          hash[attr_name.to_s] = attr_options[:block] ? instance_exec(&attr_options[:block]) : object.send(attr_name)
+        end
       end
     end
 
-    # Define an attribute to be serialized
-    #
-    # @param attribute_name [Symbol] The name of the attribute to serialize
-    # @param block [Proc] The block to call to get the value of the attribute.
-    #   The block is called in the context of the serializer instance.
-    #
-    # @example
-    #   class UserSerializer < Transmutation::Serializer
-    #     attribute :first_name
-    #
-    #     attribute :full_name do
-    #       "#{object.first_name} #{object.last_name}".strip
-    #     end
-    #   end
-    def self.attribute(attribute_name, &block)
-      attributes_config[attribute_name] = { block: block }
-    end
+    class << self
+      # Define an attribute to be serialized
+      #
+      # @param attribute_name [Symbol] The name of the attribute to serialize
+      # @param block [Proc] The block to call to get the value of the attribute
+      #   - The block is called in the context of the serializer instance
+      #
+      # @example
+      #   class UserSerializer < Transmutation::Serializer
+      #     attribute :first_name
+      #
+      #     attribute :full_name do
+      #       "#{object.first_name} #{object.last_name}".strip
+      #     end
+      #   end
+      def attribute(attribute_name, &block)
+        attributes_config[attribute_name] = { block: block }
+      end
+
+      # Define an association to be serialized
+      #
+      # @note By default, the serializer for the association is looked up in the same namespace as the serializer
+      #
+      # @param association_name [Symbol] The name of the association to serialize
+      # @param namespace [String, Symbol, Module] The namespace to lookup the association's serializer in
+      # @param serializer [String, Symbol, Class] The serializer to use for the association's serialization
+      #
+      # @example
+      #   class UserSerializer < Transmutation::Serializer
+      #     association :posts
+      #     association :comments, namespace: "Nested", serializer: "User::CommentSerializer"
+      #   end
+      def association(association_name, namespace: nil, serializer: nil)
+        block = lambda do
+          serialize(object.send(association_name), namespace: namespace, serializer: serializer, depth: @depth + 1)
+        end
+
+        attributes_config[association_name] = { block: block, association: true }
+      end
+
+      alias belongs_to association
+      alias has_one association
+      alias has_many association
+
+      # Shorthand for defining multiple attributes
+      #
+      # @param attribute_names [Array<Symbol>] The names of the attributes to serialize
+      #
+      # @example
+      #   class UserSerializer < Transmutation::Serializer
+      #     attributes :first_name, :last_name
+      #   end
+      def attributes(*attribute_names)
+        attribute_names.each do |attribute_name|
+          attribute(attribute_name)
+        end
+      end
 
-    # Shorthand for defining multiple attributes
-    #
-    # @param attribute_names [Array<Symbol>] The names of the attributes to serialize
-    #
-    # @example
-    #   class UserSerializer < Transmutation::Serializer
-    #     attributes :first_name, :last_name
-    #   end
-    def self.attributes(*attribute_names)
-      attribute_names.each do |attr_name|
-        attribute(attr_name)
+      # Shorthand for defining multiple associations
+      #
+      # @param association_names [Array<Symbol>] The names of the associations to serialize
+      #
+      # @example
+      #   class UserSerializer < Transmutation::Serializer
+      #     associations :posts, :comments
+      #   end
+      def associations(*association_names)
+        association_names.each do |association_name|
+          association(association_name)
+        end
       end
     end
 

data/lib/transmutation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Transmutation
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transmutation
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - nitemaeric
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-05 00:00:00.000000000 Z
+date: 2024-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -46,7 +46,6 @@ files:
 - Rakefile
 - lib/transmutation.rb
 - lib/transmutation/class_attributes.rb
-- lib/transmutation/collection_serializer.rb
 - lib/transmutation/serialization.rb
 - lib/transmutation/serialization/lookup.rb
 - lib/transmutation/serialization/lookup/serializer_not_found.rb

data/lib/transmutation/collection_serializer.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Transmutation
-  # Out-of-the-box collection serializer.
-  #
-  # This serializer will be used to serialize all collections of objects.
-  #
-  # @example Basic usage
-  #   Transmutation::CollectionSerializer.new([object, object]).to_json
-  class CollectionSerializer
-    include Transmutation::Serialization
-
-    def initialize(objects, namespace: nil, serializer: nil)
-      @objects = objects
-      @namespace = namespace
-      @serializer = serializer
-    end
-
-    def as_json(options = {})
-      objects.map { |item| serialize(item, namespace: namespace, serializer: serializer).as_json(options) }
-    end
-
-    def to_json(options = {})
-      as_json(options).to_json
-    end
-
-    private
-
-    attr_reader :objects, :namespace, :serializer
-  end
-end