alba 3.5.0 → 3.6.0

data/benchmark/single_resource.rb

@@ -1,300 +0,0 @@
-# Benchmark script to run varieties of JSON serializers
-# Fetch Alba from local, otherwise fetch latest from RubyGems
-
-require_relative 'prep'
-
-# --- Alba serializers ---
-
-require "alba"
-
-class AlbaCommentResource
-  include ::Alba::Resource
-  attributes :id, :body
-end
-
-class AlbaPostResource
-  include ::Alba::Resource
-  attributes :id, :body
-  attribute :commenter_names do |post|
-    post.commenters.pluck(:name)
-  end
-  many :comments, resource: AlbaCommentResource
-end
-
-# --- ActiveModelSerializer serializers ---
-
-require "active_model_serializers"
-
-class AMSCommentSerializer < ActiveModel::Serializer
-  attributes :id, :body
-end
-
-class AMSPostSerializer < ActiveModel::Serializer
-  attributes :id, :body
-  attribute :commenter_names
-  has_many :comments, serializer: AMSCommentSerializer
-
-  def commenter_names
-    object.commenters.pluck(:name)
-  end
-end
-
-# --- Blueprint serializers ---
-
-require "blueprinter"
-
-class CommentBlueprint < Blueprinter::Base
-  fields :id, :body
-end
-
-class PostBlueprint < Blueprinter::Base
-  fields :id, :body, :commenter_names
-  association :comments, blueprint: CommentBlueprint
-
-  def commenter_names
-    commenters.pluck(:name)
-  end
-end
-
-# --- JBuilder serializers ---
-
-require "jbuilder"
-
-class Post
-  def to_builder
-    Jbuilder.new do |post|
-      post.call(self, :id, :body, :commenter_names, :comments)
-    end
-  end
-
-  def commenter_names
-    commenters.pluck(:name)
-  end
-end
-
-class Comment
-  def to_builder
-    Jbuilder.new do |comment|
-      comment.call(self, :id, :body)
-    end
-  end
-end
-
-# --- Jserializer serializers ---
-
-require 'jserializer'
-
-class JserializerCommentSerializer < Jserializer::Base
-  attributes :id, :body
-end
-
-class JserializerPostSerializer < Jserializer::Base
-  attributes :id, :body, :commenter_names
-  has_many :comments, serializer: JserializerCommentSerializer
-  def commenter_names
-    object.commenters.pluck(:name)
-  end
-end
-
-# --- Panko serializers ---
-
-require "panko_serializer"
-
-class PankoCommentSerializer < Panko::Serializer
-  attributes :id, :body
-end
-
-
-class PankoPostSerializer < Panko::Serializer
-  attributes :id, :body, :commenter_names
-
-  has_many :comments, serializer: PankoCommentSerializer
-
-  def commenter_names
-    object.commenters.pluck(:name)
-  end
-end
-
-# --- Primalize serializers ---
-
-class PrimalizeCommentResource < Primalize::Single
-  attributes id: integer, body: string
-end
-
-class PrimalizePostResource < Primalize::Single
-  alias post object
-
-  attributes(
-    id: integer,
-    body: string,
-    comments: array(primalize(PrimalizeCommentResource)),
-    commenter_names: array(string),
-  )
-
-  def commenter_names
-    post.commenters.pluck(:name)
-  end
-end
-
-# --- Representable serializers ---
-
-require "representable"
-
-class CommentRepresenter < Representable::Decorator
-  include Representable::JSON
-
-  property :id
-  property :body
-end
-
-class PostRepresenter < Representable::Decorator
-  include Representable::JSON
-
-  property :id
-  property :body
-  property :commenter_names
-  collection :comments
-
-  def commenter_names
-    commenters.pluck(:name)
-  end
-end
-
-# --- SimpleAMS serializers ---
-
-require "simple_ams"
-
-class SimpleAMSCommentSerializer
-  include SimpleAMS::DSL
-
-  attributes :id, :body
-end
-
-class SimpleAMSPostSerializer
-  include SimpleAMS::DSL
-
-  attributes :id, :body
-  attribute :commenter_names
-  has_many :comments, serializer: SimpleAMSCommentSerializer
-
-  def commenter_names
-    object.commenters.pluck(:name)
-  end
-end
-
-require 'turbostreamer'
-TurboStreamer.set_default_encoder(:json, :oj)
-
-class TurbostreamerSerializer
-  def initialize(post)
-    @post = post
-  end
-
-  def to_json
-    TurboStreamer.encode do |json|
-      json.object! do
-        json.extract! @post, :id, :body, :commenter_names
-
-        json.comments @post.comments do |comment|
-          json.object! do
-            json.extract! comment, :id, :body
-          end
-        end
-      end
-    end
-  end
-end
-
-# --- Test data creation ---
-
-post = Post.create!(body: 'post')
-user1 = User.create!(name: 'John')
-user2 = User.create!(name: 'Jane')
-post.comments.create!(commenter: user1, body: 'Comment1')
-post.comments.create!(commenter: user2, body: 'Comment2')
-post.reload
-
-# --- Store the serializers in procs ---
-
-alba = Proc.new { AlbaPostResource.new(post).serialize }
-alba_inline = Proc.new do
-  Alba.serialize(post) do
-    attributes :id, :body
-    attribute :commenter_names do |post|
-      post.commenters.pluck(:name)
-    end
-    many :comments do
-      attributes :id, :body
-    end
-  end
-end
-
-ams = Proc.new { AMSPostSerializer.new(post, {}).to_json }
-blueprinter = Proc.new { PostBlueprint.render(post) }
-jbuilder = Proc.new { post.to_builder.target! }
-jserializer = Proc.new { JserializerPostSerializer.new(post).to_json }
-panko = proc { PankoPostSerializer.new.serialize_to_json(post) }
-primalize = proc { PrimalizePostResource.new(post).to_json }
-rails = Proc.new { ActiveSupport::JSON.encode(post.serializable_hash(include: :comments)) }
-representable = Proc.new { PostRepresenter.new(post).to_json }
-simple_ams = Proc.new { SimpleAMS::Renderer.new(post, serializer: SimpleAMSPostSerializer).to_json }
-turbostreamer = Proc.new { TurbostreamerSerializer.new(post).to_json }
-
-# --- Execute the serializers to check their output ---
-
-puts "Serializer outputs ----------------------------------"
-{
-  alba: alba,
-  alba_inline: alba_inline,
-  ams: ams,
-  blueprinter: blueprinter,
-  jbuilder: jbuilder, # different order
-  jserializer: jserializer,
-  panko: panko,
-  primalize: primalize,
-  rails: rails,
-  representable: representable,
-  simple_ams: simple_ams,
-  turbostreamer: turbostreamer
-}.each do |name, serializer|
-  puts "#{name.to_s.ljust(24, ' ')} #{serializer.call}"
-end
-
-# --- Run the benchmarks ---
-
-require 'benchmark/ips'
-Benchmark.ips do |x|
-  x.report(:alba, &alba)
-  x.report(:alba_inline, &alba_inline)
-  x.report(:ams, &ams)
-  x.report(:blueprinter, &blueprinter)
-  x.report(:jbuilder, &jbuilder)
-  x.report(:jserializer, &jserializer)
-  x.report(:panko, &panko)
-  x.report(:primalize, &primalize)
-  x.report(:rails, &rails)
-  x.report(:representable, &representable)
-  x.report(:simple_ams, &simple_ams)
-  x.report(:turbostreamer, &turbostreamer)
-
-  x.compare!
-end
-
-
-require 'benchmark/memory'
-Benchmark.memory do |x|
-  x.report(:alba, &alba)
-  x.report(:alba_inline, &alba_inline)
-  x.report(:ams, &ams)
-  x.report(:blueprinter, &blueprinter)
-  x.report(:jbuilder, &jbuilder)
-  x.report(:jserializer, &jserializer)
-  x.report(:panko, &panko)
-  x.report(:primalize, &primalize)
-  x.report(:rails, &rails)
-  x.report(:representable, &representable)
-  x.report(:simple_ams, &simple_ams)
-  x.report(:turbostreamer, &turbostreamer)
-
-  x.compare!
-end

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'alba'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/codecov.yml

@@ -1,8 +0,0 @@
-coverage:
-  status:
-    project:
-      default:
-        informational: true
-    patch:
-      default:
-        target: 90%

data/docs/migrate_from_active_model_serializers.md

@@ -1,359 +0,0 @@
----
-title: Upgrading from ActiveModelSerializers
----
-
-<!-- @format -->
-
-This guide is aimed at helping ActiveModelSerializers users transition to Alba, and it consists of three parts:
-
-1. Basic serialization
-2. Complex serialization
-3. Unsupported features
-
-## Example class
-
-Example class is inherited `ActiveRecord::Base`, because [serializing PORO with AMS is pretty hard](https://github.com/rails-api/active_model_serializers/blob/0-10-stable/docs/howto/serialize_poro.md).
-
-```rb
-class User < ActiveRecord::Base
-  # columns: id, created_at, updated_at
-  has_one :profile
-  has_many :articles
-end
-
-class Profile < ActiveRecord::Base
-  # columns: id, user_id, email, created_at, updated_at
-  belongs_to :user
-end
-
-class Article < ActiveRecord::Base
-  # columns: id, user_id, title, body, created_at, updated_at
-  belongs_to :user
-end
-```
-
-## 1. Basic serialization
-
-### #serializable_hash
-
-- or #as_json, #to_json
-
-#### ActiveModelSerializer
-
-```rb
-# Infer and use by "#{MODEL_NAME}Serializer" in app/serializers/user_serializer.rb
-class UserSerializer < ActiveModel::Serializer
-  type :user
-  attributes :id, :created_at, :updated_at
-end
-
-# serialze
-user = User.create!
-ActiveModelSerializers::SerializableResource.new(
-  user
-).serializable_hash
-# => {
-#   user: {
-#     id: id,
-#     created_at: created_at,
-#     updated_at: updated_at
-#   }
-# }
-```
-
-#### Alba
-
-```rb
-# Infer and use by "#{MODEL_NAME}Resource"
-# In app/resources/user_resource.rb
-class UserResource
-  include Alba::Resource
-  attributes :id, :created_at, :updated_at
-end
-
-# serialze
-user = User.create!
-UserResource.new(user).serializable_hash
-# => {
-#   id: id,
-#   created_at: created_at,
-#   updated_at: updated_at,
-# }
-
-# If want `user key`
-class UserResource
-  include Alba::Resource
-  root_key :user # Call root_key method like ActiveModel::Serializer#type
-  attributes :id, :created_at, :updated_at
-end
-
-# serialze
-user = User.create!
-JSON.parse UserResource.new(user).serialize # ！！！！serializable_hash does not support root key！！！ Must use JSON.parse and serialize
-# => {
-#   "user"=>{
-#     "id"=>id,
-#     "created_at"=>created_at,
-#     "updated_at"=>updated_at
-#   }
-# }
-# If want symbolize keys with #deep_symbolize_keys in Rails
-user = User.create!
-JSON.parse(UserResource.new(user).serialize).deep_symbolize_keys
-# => {
-#   user: {
-#     id: id,
-#     created_at: created_at,
-#     updated_at: updated_at
-#   }
-# }
-```
-
-## 2. Complex serialization
-
-### Serialize collections
-
-#### ActiveModelSerializer
-
-```rb
-class UserSerializer < ActiveModel::Serializer
-  type :user
-  attributes :id, :created_at, :updated_at
-end
-3.times { User.create! }
-users = User.limit 3
-ActiveModelSerializers::SerializableResource.new(
-  users,
-  adapter: :attributes # Comment out this line if you want users key
-  # Want to specified key to call with root: args
-).serializable_hash
-# => [{:id=>1, :created_at=>created_at, :updated_at=>updated_at},
-#    {:id=>2, :created_at=>created_at, :updated_at=>updated_at},
-#    {:id=>3, :created_at=>created_at, :updated_at=>updated_at}]
-```
-
-#### Alba
-
-```rb
-class UserResource
-  include Alba::Resource
-  attributes :id, :created_at, :updated_at
-end
-3.times { User.create! }
-users = User.limit 3
-UserResource.new(users).serializable_hash
-# =>[{:id=>1, :created_at=>created_at, :updated_at=>updated_at},
-#    {:id=>2, :created_at=>created_at, :updated_at=>updated_at},
-#    {:id=>3, :created_at=>created_at, :updated_at=>updated_at}]
-# or
-JSON.parse UserResource.new(users).serialize(root_key: :users)
-# => {"users"=>
-#   [{"id"=>1, "created_at"=>created_at, "updated_at"=>updated_at},
-#    {"id"=>2, "created_at"=>created_at, "updated_at"=>updated_at},
-#    {"id"=>3, "created_at"=>created_at, "updated_at"=>updated_at}]}
-```
-
-### Nested serialization
-
-#### ActiveModelSerializer
-
-```rb
-class ProfileSerializer < ActiveModel::Serializer
-  type :profile
-  attributes :email
-end
-
-class ArticleSerializer < ActiveModel::Serializer
-  type :article
-  attributes :title, :body
-end
-
-class UserSerializer < ActiveModel::Serializer
-  type :user
-  attributes :id, :created_at, :updated_at
-  has_one :profile, serializer: ProfileSerializer # For has_one relation
-  has_many :articles, serializer: ArticleSerializer # For has_many relation
-end
-user = User.create!
-user.create_profile! email: email
-user.articles.create! title: title, body: body
-ActiveModelSerializers::SerializableResource.new(
-  user
-).serializable_hash
-# => {
-#   :user=> {
-#     :id=>1,
-#     :created_at=>created_at,
-#     :updated_at=>updated_at,
-#     :profile=> {
-#       :email=>email
-#     },
-#     :articles => [
-#       {
-#         :title=>title,
-#         :body=>body
-#       }
-#     ]
-#   }
-# }
-```
-
-#### Alba
-
-```rb
-class ProfileResource
-  include Alba::Resource
-  root_key :profile
-  attributes :email
-end
-
-class ArticleResource
-  include Alba::Resource
-  root_key :article
-  attributes :title, :body
-end
-
-class UserResource
-  include Alba::Resource
-  root_key :user
-  attributes :id, :created_at, :updated_at
-  one :profile, resource: ProfileResource # For has_one relation
-  many :articles, resource: ArticleResource # For has_many relation
-end
-
-user = User.create!
-user.craete_profile! email: email
-user.articles.create! title: title, body: body
-UserResource.new(user).serializable_hash
-# => {
-#   :id=>1,
-#   :created_at=>created_at,
-#   :updated_at=>updated_at,
-#   :profile=> {
-#     :email=>email
-#   },
-#   :articles => [
-#     {
-#       :title=>title,
-#       :body=>body
-#     }
-#   ]
-# }
-```
-
-### Serialize with custom serializer
-
-#### ActiveModelSerializer
-
-```rb
-class CustomUserSerializer < ActiveModel::Serializer
-  type :user
-  attribute :email do
-    object.profile.email
-  end
-end
-
-# serialze
-user = User.create!
-user.craete_profile! email: email
-ActiveModelSerializers::SerializableResource.new(
-  user,
-  serializer: ::CustomUserSerializer # Call with serializer arg
-).serializable_hash
-# => {
-#   user: {
-#     email: email
-#   }
-# }
-```
-
-#### Alba
-
-```rb
-class CustomUserResource
-  include Alba::Resource
-  root_key :user
-  attribute :email do
-    object.profile.email
-  end
-end
-
-# serialze
-user = User.create!
-user.craete_profile! email: email
-CustomUserResource.new(user).serializable_hash
-# => {
-#   email: email
-# }
-```
-
-### Passing arbitrary options to a serializer
-
-#### ActiveModelSerializer
-
-```rb
-class UserSerializer < ApplicationSerializer
-  type :user
-  attributes :id, :created_at, :updated_at
-  attribute :custom_params do
-    pp instance_options
-    # => given_params: { a: :b }
-    instance_options # Access by instance_options method
-  end
-end
-
-# serialze
-user = User.create!
-ActiveModelSerializers::SerializableResource.new(
-  user,
-  given_params: { a: :b } # Give with your favorite keyword argument
-).serializable_hash
-# => {
-#   :id=>1,
-#   :created_at=>created_at,
-#   :updated_at=>updated_at,
-#   :custom_params=>{
-#     :given_params=>{
-#       :a=>:b
-#     }
-#   }
-# }
-```
-
-#### Alba
-
-```rb
-class UserResource
-  include Alba::Resource
-  root_key :user
-  attributes :id, :created_at, :updated_at
-  attribute :custom_params do
-    pp params
-    # => { :a=>:b }
-    params
-  end
-end
-
-# serialze
-user = User.create!
-UserResource.new(
-  user,
-  params: { a: :b } # Give with :params keyword argument
-).serializable_hash
-# => {
-#   :id=>1,
-#   :created_at=>created_at,
-#   :updated_at=>updated_at,
-#   :custom_params=>{
-#     :a=>:b
-#   }
-# }
-```
-
-## 3. Unsupported features
-
-- [RelationshipLinks](https://github.com/rails-api/active_model_serializers/blob/v0.10.6/docs/howto/add_relationship_links.md)
-- [PaginationLinks](https://github.com/rails-api/active_model_serializers/blob/v0.10.6/docs/howto/add_pagination_links.md)
-- [Logging](https://github.com/rails-api/active_model_serializers/blob/v0.10.6/docs/general/logging.md)
-- [Caching](https://github.com/rails-api/active_model_serializers/blob/v0.10.6/docs/general/caching.md)
-- [Rendering](https://github.com/rails-api/active_model_serializers/blob/v0.10.6/docs/general/rendering.md)