alba 3.5.0 → 3.7.0

data/benchmark/collection.rb

@@ -1,297 +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"
-
-Alba.inflector = :active_support
-
-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
-
-class AlbaCommentWithTransformationResource < AlbaCommentResource
-  transform_keys :lower_camel
-end
-
-class AlbaPostWithTransformationResource < AlbaPostResource
-  many :comments, resource: AlbaCommentWithTransformationResource
-
-  transform_keys :lower_camel
-end
-
-# --- ActiveModelSerializer serializers ---
-
-require "active_model_serializers"
-
-ActiveModelSerializers.logger = Logger.new(nil)
-
-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
-
-# --- Fast Serializer Ruby
-
-require "fast_serializer"
-
-class FastSerializerCommentResource
-  include ::FastSerializer::Schema::Mixin
-  attributes :id, :body
-end
-
-class FastSerializerPostResource
-  include ::FastSerializer::Schema::Mixin
-
-  attributes :id, :body
-
-  attribute :commenter_names do
-    object.commenters.pluck(:name)
-  end
-
-  has_many :comments, serializer: FastSerializerCommentResource
-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
-
-# --- Representable serializers ---
-
-require "representable"
-
-class CommentRepresenter < Representable::Decorator
-  include Representable::JSON
-
-  property :id
-  property :body
-end
-
-class PostsRepresenter < Representable::Decorator
-  include Representable::JSON::Collection
-
-  items class: Post do
-    property :id
-    property :body
-    property :commenter_names
-    collection :comments, decorator: CommentRepresenter
-  end
-
-  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(posts)
-    @posts = posts
-  end
-
-  def to_json
-    TurboStreamer.encode do |json|
-      json.array! @posts do |post|
-        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
-end
-
-# --- Test data creation ---
-
-100.times do |i|
-  post = Post.create!(body: "post#{i}")
-  user1 = User.create!(name: "John#{i}")
-  user2 = User.create!(name: "Jane#{i}")
-  10.times do |n|
-    post.comments.create!(commenter: user1, body: "Comment1_#{i}_#{n}")
-    post.comments.create!(commenter: user2, body: "Comment2_#{i}_#{n}")
-  end
-end
-
-posts = Post.all.includes(:comments, :commenters)
-
-# --- Store the serializers in procs ---
-
-alba = Proc.new { AlbaPostResource.new(posts).serialize }
-alba_with_transformation = Proc.new { AlbaPostWithTransformationResource.new(posts).serialize }
-alba_inline = Proc.new do
-  Alba.serialize(posts) 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 { ActiveModelSerializers::SerializableResource.new(posts, {each_serializer: AMSPostSerializer}).to_json }
-blueprinter = Proc.new { PostBlueprint.render(posts) }
-fast_serializer = Proc.new { FastSerializerPostResource.new(posts).to_json }
-jserializer = Proc.new { JserializerPostSerializer.new(posts, is_collection: true).to_json }
-panko = proc { Panko::ArraySerializer.new(posts, each_serializer: PankoPostSerializer).to_json }
-rails = Proc.new do
-  posts.to_json(include: {comments: {only: [:id, :body]}}, methods: [:commenter_names])
-end
-representable = Proc.new { PostsRepresenter.new(posts).to_json }
-simple_ams = Proc.new { SimpleAMS::Renderer::Collection.new(posts, serializer: SimpleAMSPostSerializer).to_json }
-turbostreamer = Proc.new { TurbostreamerSerializer.new(posts).to_json }
-
-# --- Execute the serializers to check their output ---
-GC.disable
-puts "Checking outputs..."
-correct = alba.call
-parsed_correct = JSON.parse(correct)
-{
-  alba_inline: alba_inline,
-  ams: ams,
-  blueprinter: blueprinter,
-  fast_serializer: fast_serializer,
-  jserializer: jserializer,
-  panko: panko,
-  rails: rails,
-  representable: representable,
-  simple_ams: simple_ams,
-  turbostreamer: turbostreamer
-}.each do |name, serializer|
-  result = serializer.call
-  parsed_result = JSON.parse(result)
-  puts "#{name} yields wrong output: #{parsed_result}" unless parsed_result == parsed_correct
-end
-
-# --- Run the benchmarks ---
-
-benchmark_body = lambda do |x|
-  x.report(:alba, &alba)
-  x.report(:alba_with_transformation, &alba_with_transformation)
-  x.report(:alba_inline, &alba_inline)
-  x.report(:ams, &ams)
-  x.report(:blueprinter, &blueprinter)
-  x.report(:fast_serializer, &fast_serializer)
-  x.report(:jserializer, &jserializer)
-  x.report(:panko, &panko)
-  x.report(:rails, &rails)
-  x.report(:representable, &representable)
-  x.report(:simple_ams, &simple_ams)
-  x.report(:turbostreamer, &turbostreamer)
-
-  x.compare!
-end
-
-require 'benchmark/ips'
-Benchmark.ips(&benchmark_body)
-
-require 'benchmark/memory'
-Benchmark.memory(&benchmark_body)
-
-# --- Show gem versions ---
-
-puts "Gem versions:"
-gems = %w[alba active_model_serializers blueprinter fast_serializer jserializer panko_serializer representable simple_ams turbostreamer]
-Bundler.load.specs.each do |spec|
-  puts "#{spec.name}: #{spec.version}" if gems.include?(spec.name)
-end

data/benchmark/prep.rb

@@ -1,56 +0,0 @@
-# --- Test data model setup ---
-
-RubyVM::YJIT.enable if ENV["YJIT"]
-require "csv"
-require "pg"
-require "active_record"
-require "active_record/connection_adapters/postgresql_adapter"
-require "logger"
-require "oj"
-require "sqlite3"
-Oj.optimize_rails unless ENV['NO_OJ_OPTIMIZE_RAILS']
-
-ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
-# ActiveRecord::Base.logger = Logger.new($stdout)
-
-ActiveRecord::Schema.define do
-  create_table :posts, force: true do |t|
-    t.string :body
-  end
-
-  create_table :comments, force: true do |t|
-    t.integer :post_id
-    t.string :body
-    t.integer :commenter_id
-  end
-
-  create_table :users, force: true do |t|
-    t.string :name
-  end
-end
-
-class Post < ActiveRecord::Base
-  has_many :comments
-  has_many :commenters, through: :comments, class_name: 'User', source: :commenter
-
-  def attributes
-    {id: nil, body: nil, commenter_names: commenter_names}
-  end
-
-  def commenter_names
-    commenters.pluck(:name)
-  end
-end
-
-class Comment < ActiveRecord::Base
-  belongs_to :post
-  belongs_to :commenter, class_name: 'User'
-
-  def attributes
-    {id: nil, body: nil}
-  end
-end
-
-class User < ActiveRecord::Base
-  has_many :comments
-end

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%