Module: Transmutation

Extended by:

ClassAttributes

Defined in:

lib/transmutation.rb,
lib/transmutation/field.rb,
lib/transmutation/version.rb,
lib/transmutation/attribute.rb,
lib/transmutation/serializer.rb,
lib/transmutation/association.rb,
lib/transmutation/serialization.rb,
lib/transmutation/class_attributes.rb,
lib/transmutation/object_serializer.rb,
lib/transmutation/serialization/lookup.rb,
lib/transmutation/serialization/rendering.rb,
lib/transmutation/serialization/lookup/serializer_not_found.rb

Overview

A performant and expressive solution for serializing Ruby objects into JSON, with a touch of opinionated "magic" ✨.

Examples:

Basic usage

# Define a data class.
class User
  attr_reader :name, :email

  def initialize(name:, email:)
    @name = name
    @email = email
  end
end

# Define a serializer.
class UserSerializer < Transmutation::Serializer
  attribute :name
end

# Create an instance of the data class.
user = User.new(name: "John", email: "john@example.com")

# Serialize the data class instance.
UserSerializer.new(user).to_json # => "{\"name\":\"John\"}"

Within a Rails controller

class UsersController < ApplicationController
  include Transmutation::Serialization

  def show
    user = User.find(params[:id])

    # Automatically lookup the UserSerializer
    # Serialize the data class instance using the UserSerializer
    # Render the result as JSON to the client
    render json: user # => "{\"name\":\"John\"}"
  end
end

Defined Under Namespace

Modules: ClassAttributes, Serialization Classes: Association, Attribute, Error, Field, ObjectSerializer, Serializer

Constant Summary

VERSION =

"0.7.0"

Method Summary

Methods included from ClassAttributes

class_attribute, class_attribute_reader, class_attribute_writer