transmutation 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfdba62ded204b2a1007b3f4194ada3d25cfdb1851d21a23d3d0d8baa4b69c78
-  data.tar.gz: 97c1a41fb6a6550adce185f402a9d9db738cdc912bbd15a7ab13f133fa1a83e8
+  metadata.gz: c0c0f36f54d912c5198176956044bf36157135f0ca1a5230c09b892663e1fcb0
+  data.tar.gz: da166b70d0c35dc701d83f7016364d8c52cbb2aef9102045e8d6260235383485
 SHA512:
-  metadata.gz: db4415229791b74647ffd4441d4b930f3ab98a2a7c9e1fb84de94537f6eec1a370116745860fe1bf2a98bb3b8dc6541d7c6ac5933779a022e97e96bbe0113ebc
-  data.tar.gz: ea012d8cc51843103d938a1953619f33bc603a0a51b70787cbaebcc653bae9e83eded5a3807407ad143ffd50300f063ae4b15d254c03c079674a64701a9781fd
+  metadata.gz: 8357eb90811b77c0069a97393b091b81d6b95c80cf75b6d9d9d1bf7d5437f14ff9aaa8a35aadf32c4767238ec6da9a08d5e326d66a6e49fe4536c382dd3b0549
+  data.tar.gz: ecad287a5c638eb67c249723ef0aa36e4cc5cac5f9aa59a7428746e9a9f9bcc5edf12d271eb53b7aa6d2108f24e0d7f557e82c6d0261292a02f53d11e9aece09

data/lib/transmutation/serialization/lookup.rb

@@ -18,13 +18,13 @@ module Transmutation
       #   namespace: Api::V1::Admin::Detailed
       #   serializer: Chat::User
       #
-      #   This method will attempt to find a serializer defined in the following order:
+      #   # This method will attempt to find a serializer defined in the following order:
       #
-      #   - Api::V1::Admin::Detailed::Chat::UserSerializer
-      #   - Api::V1::Admin::Chat::UserSerializer
-      #   - Api::V1::Chat::UserSerializer
-      #   - Api::Chat::UserSerializer
-      #   - Chat::UserSerializer
+      #   # - Api::V1::Admin::Detailed::Chat::UserSerializer
+      #   # - Api::V1::Admin::Chat::UserSerializer
+      #   # - Api::V1::Chat::UserSerializer
+      #   # - Api::Chat::UserSerializer
+      #   # - Chat::UserSerializer
       def serializer_for(object, serializer: nil)
         serializer_name = serializer_name_for(object, serializer:)
 
@@ -65,14 +65,10 @@ module Transmutation
       end
 
       def serializer_namespace
-        return caller_namespace if @namespace.nil?
-        return @namespace       if @namespace.start_with?("::")
+        return @caller.namespace if @namespace.nil?
+        return @namespace        if @namespace.start_with?("::")
 
-        "#{caller_namespace}::#{@namespace}"
-      end
-
-      def caller_namespace
-        @caller_namespace ||= @caller.class.name.split("::")[...-1].join("::")
+        "#{@caller.namespace}::#{@namespace}"
       end
 
       def constantize_serializer!(namespace, name, object:)

data/lib/transmutation/serialization/rendering.rb

@@ -3,6 +3,7 @@
 module Transmutation
   module Serialization
     module Rendering
+      # Serializes the value of the `json` parameter before calling the existing render method.
       def render(json: nil, serialize: true, namespace: nil, serializer: nil, max_depth: 1, **args)
         return super(**args) unless json
         return super(**args, json:) unless serialize

data/lib/transmutation/serialization.rb

@@ -10,21 +10,20 @@ module Transmutation
     # @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, depth: 0, max_depth: 1)
+    def serialize(object, namespace: nil, serializer: nil, depth: 0, max_depth: Transmutation.max_depth)
       if object.respond_to?(:map) && !object.respond_to?(:to_hash)
-        return object.map do |item|
-          serialize(item, namespace:, serializer:, depth:, max_depth:)
-        end
+        return object.map { |item| serialize(item, namespace:, serializer:, depth:, max_depth:) }
       end
 
-      lookup_serializer(object, namespace:, serializer:)
-        .new(object, depth:, max_depth:)
+      lookup_serializer(object, namespace:, serializer:).new(object, depth:, max_depth:)
     end
 
     # Lookup the serializer for the given object.
     #
     # This calls {Transmutation::Serialization::Lookup#serializer_for} to find the serializer for the given object.
     #
+    # This also caches the result for future lookups.
+    #
     # @param object [Object] The object to lookup the serializer for.
     # @param namespace [String, Symbol, Module] The namespace to lookup the serializer in.
     # @param serializer [String, Symbol, Class] The serializer to use.
@@ -32,7 +31,23 @@ module Transmutation
     # @return [Class<Transmutation::Serializer>] The serializer for the given object.
     #
     def lookup_serializer(object, namespace: nil, serializer: nil)
-      Lookup.new(self, namespace:).serializer_for(object, serializer:)
+      Serialization.cache[[self.namespace, object.class, namespace, serializer]] ||=
+        Lookup.new(self, namespace:).serializer_for(object, serializer:)
+    end
+
+    # @api private
+    def self.cache
+      @cache ||= {}
+    end
+
+    # Returns the namespace of this class.
+    #
+    # @example
+    #   Api::V1::UsersController.namespace #=> "Api::V1"
+    #
+    # @return [String] The namespace of this class.
+    def namespace
+      @namespace ||= self.class.name.to_s[0, self.class.name.rindex("::") || 0]
     end
 
     private_class_method def self.included(base)

data/lib/transmutation/serializer.rb

@@ -88,10 +88,6 @@ module Transmutation
         attributes_config[association_name] = { 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
@@ -100,9 +96,9 @@ module Transmutation
       #   class UserSerializer < Transmutation::Serializer
       #     attributes :first_name, :last_name
       #   end
-      def attributes(*attribute_names)
+      def attributes(*attribute_names, **, &)
         attribute_names.each do |attribute_name|
-          attribute(attribute_name)
+          attribute(attribute_name, **, &)
         end
       end
 
@@ -114,11 +110,15 @@ module Transmutation
       #   class UserSerializer < Transmutation::Serializer
       #     associations :posts, :comments
       #   end
-      def associations(*association_names)
+      def associations(*association_names, **, &)
         association_names.each do |association_name|
-          association(association_name)
+          association(association_name, **, &)
         end
       end
+
+      alias belongs_to associations
+      alias has_one associations
+      alias has_many associations
     end
 
     private

data/lib/transmutation/version.rb

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

data/lib/transmutation.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "transmutation/class_attributes"
+
 # A performant and expressive solution for serializing Ruby objects into JSON, with a touch of opinionated "magic" ✨.
 #
 # @example Basic usage
@@ -38,12 +40,16 @@
 #     end
 #   end
 module Transmutation
+  extend ClassAttributes
+
+  class_attribute :max_depth, default: 1
+
   class Error < StandardError; end
 end
 
 require "zeitwerk"
-loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
-loader.ignore("#{__dir__}/transmutation/core_ext")
+
+loader = Zeitwerk::Loader.for_gem
 loader.setup
 
 require "active_support"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transmutation
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - nitemaeric
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-11 00:00:00.000000000 Z
+date: 2025-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -47,16 +47,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".ruby-version"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
 - lib/transmutation.rb
 - lib/transmutation/class_attributes.rb
 - lib/transmutation/object_serializer.rb
@@ -66,7 +56,6 @@ files:
 - lib/transmutation/serialization/rendering.rb
 - lib/transmutation/serializer.rb
 - lib/transmutation/version.rb
-- sig/transmutation.rbs
 homepage: https://github.com/spellbook-technology/transmutation
 licenses:
 - MIT

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,26 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-AllCops:
-  TargetRubyVersion: 3.2.5
-  NewCops: disable
-  SuggestExtensions: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
-
-Metrics/AbcSize:
-  Max: 18
-
-Metrics/ParameterLists:
-  Enabled: true
-  CountKeywordArgs: false
-
-require: rubocop-rspec

data/.rubocop_todo.yml

@@ -1,16 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2024-06-05 00:21:36 UTC using RuboCop version 1.63.4.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 2
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/transmutation/serialization.rb'
-    - 'lib/transmutation/serialization/rendering.rb'

data/.ruby-version

@@ -1 +0,0 @@
-3.2.5

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2024-04-30
-
-- Initial release

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at borrabeer@outlook.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in transmutation.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
-gem "rubocop-rspec", require: false
-
-gem "simplecov"
-gem "simplecov-lcov"
-gem "undercover"
-
-gem "pry"
-
-gem "gem-release", require: false

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Spellbook Technology
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/README.md

@@ -1,245 +0,0 @@
-# Transmutation
-
-Transmutation is a Ruby gem that provides a simple way to serialize Ruby objects into JSON.
-
-It also adds an opinionated way to automatically find and use serializer classes based on the object's class name and the caller's namespace - it takes inspiration from the [Active Model Serializers](https://github.com/rails-api/active_model_serializers) gem, but strips away adapters.
-
-It aims to be a performant and elegant solution for serializing Ruby objects into JSON, with a touch of opinionated "magic" :sparkles:.
-
-## Installation
-
-Install the gem and add to your application's Gemfile by executing:
-
-```bash
-bundle add transmutation
-```
-
-or manually add the following to your Gemfile:
-
-```ruby
-gem "transmutation"
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install transmutation
-```
-
-## Usage
-
-### Basic Usage
-
-- Define a serializer class that inherits from `Transmutation::Serializer` and define the attributes to be serialized.
-
-  ```ruby
-  class UserSerializer < Transmutation::Serializer
-    attributes :id, :name, :email
-  end
-  ```
-
-- Serialize an object using the serializer class.
-
-  ```ruby
-  class User
-    attr_reader :id, :name, :email
-
-    def initialize(id:, name:, email:)
-      @id = id
-      @name = name
-      @email = email
-    end
-  end
-
-  user = User.new(id: 1, name: "John Doe", email: "john@example.com")
-
-  UserSerializer.new(user).to_json # => "{\"id\":1,\"name\":\"John Doe\",\"email\":\"john@example.com\"}"
-  ```
-
-  As long as your object responds to the attributes defined in the serializer, it can be serialized.
-
-  <details>
-    <summary>Struct</summary>
-
-    ```ruby
-    User = Struct.new(:id, :name, :email)
-    ```
-  </details>
-
-  <details>
-    <summary>Class</summary>
-
-    ```ruby
-    class User
-      attr_reader :id, :name, :email
-
-      def initialize(id:, name:, email:)
-        @id = id
-        @name = name
-        @email = email
-      end
-    end
-    ```
-  </details>
-
-  <details>
-    <summary>ActiveRecord</summary>
-
-    ```ruby
-    # == Schema Information
-    #
-    # Table name: users
-    #
-    #  id    :bigint
-    #  name  :string
-    #  email :string
-    class User < ApplicationRecord
-    end
-    ```
-  </details>
-
-### The `#serialize` method
-
-When you include the `Transmutation::Serialization` module in your class, you can use the `#serialize` method to serialize an object.
-
-It will attempt to find a serializer class based on the object's class name along with the caller's namespace.
-
-```ruby
-include Transmutation::Serialization
-
-serialize(User.new) # => UserSerializer.new(User.new)
-```
-
-If no serializer class is found, it will return the object as is.
-
-### With Ruby on Rails
-
-When then `Transmutation::Serialization` module is included in a Rails controller, it also extends your `render` calls.
-
-```ruby
-class Api::V1::UsersController < ApplicationController
-  include Transmutation::Serialization
-
-  def show
-    user = User.find(params[:id])
-
-    render json: user
-  end
-end
-```
-
-This will attempt to bubble up the controller namespaces to find a defined serializer class:
-
-- `Api::V1::UserSerializer`
-- `Api::UserSerializer`
-- `UserSerializer`
-
-This calls the `#serialize` method under the hood.
-
-If no serializer class is found, it will fall back to the default behavior of rendering the object as JSON.
-
-You can disable this behaviour by passing `serialize: false` to the `render` method.
-
-```ruby
-render json: user, serialize: false # => user.to_json
-```
-
-## Configuration
-
-You can override the serialization lookup by passing the following options:
-
-- `namespace`: The namespace to use when looking up the serializer class.
-
-  ```ruby
-  render json: user, namespace: "V1" # => Api::V1::V1::UserSerializer
-  ```
-
-  To prevent caller namespaces from being appended to the provided namespace, prefix the namespace with `::`.
-
-  ```ruby
-  render json: user, namespace: "::V1" # => V1::UserSerializer
-  ```
-
-  The `namespace` key is forwarded to the `#serialize` method.
-
-  ```ruby
-  render json: user, namespace: "V1" # => serialize(user, namespace: "V1")
-  ```
-
-- `serializer`: The serializer class to use.
-
-  ```ruby
-  render json: user, serializer: "SuperUserSerializer" # => Api::V1::SuperUserSerializer
-  ```
-
-  To prevent all namespaces from being appended to the serializer class, prefix the serializer class with `::`.
-
-  ```ruby
-  render json: user, serializer: "::SuperUserSerializer" # => SuperUserSerializer
-  ```
-
-  The `serializer` key is forwarded to the `#serialize` method.
-
-  ```ruby
-  render json: user, serializer: "SuperUserSerializer" # => serialize(user, serializer: "SuperUserSerializer")
-  ```
-
-## Opinionated Architecture
-
-If you follow the pattern outlined below, you can take full advantage of the automatic serializer lookup.
-
-### File Structure
-
-```
-.
-└── app/
-    ├── controllers/
-    │   └── api/
-    │       ├── v1/
-    │       │   └── users_controller.rb
-    │       └── v2
-    │           └── users_controller.rb
-    ├── models/
-    │   └── user.rb
-    └── serializers/
-        └── api/
-            ├── v1/
-            │   └── user_serializer.rb
-            ├── v2/
-            │   └── user_serializer.rb
-            └── user_serializer.rb
-```
-
-### Serializers
-
-```ruby
-class Api::UserSerializer < Transmutation::Serializer
-  attributes :id, :name, :email
-end
-
-class Api::V1::UserSerializer < Api::UserSerializer
-  attributes :phone # Added in V1
-end
-
-class Api::V2::UserSerializer < Api::UserSerializer
-  attributes :avatar # Added in V2
-end
-```
-
-To remove attributes, it is recommended to redefine all attributes and start anew. This acts as a reset and makes serializer inheritance much easier to follow.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/spellbook-technology/transmutation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/spellbook-technology/transmutation/blob/main/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Transmutation project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/spellbook-technology/transmutation/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new do |task|
-  task.requires << "rubocop-rspec"
-end
-
-task default: %i[spec rubocop]

data/sig/transmutation.rbs

@@ -1,4 +0,0 @@
-module Transmutation
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end