alba 1.3.0 → 1.6.0

data/benchmark/collection.rb

@@ -15,9 +15,14 @@ gemfile(true) do
   gem "benchmark-ips"
   gem "benchmark-memory"
   gem "blueprinter"
+  gem "fast_serializer_ruby"
   gem "jbuilder"
+  gem 'turbostreamer'
+  gem "jserializer"
   gem "jsonapi-serializer" # successor of fast_jsonapi
   gem "multi_json"
+  gem "panko_serializer"
+  gem "pg"
   gem "primalize"
   gem "oj"
   gem "representable"
@@ -27,7 +32,9 @@ end
 
 # --- Test data model setup ---
 
+require "pg"
 require "active_record"
+require "active_record/connection_adapters/postgresql_adapter"
 require "logger"
 require "oj"
 require "sqlite3"
@@ -133,6 +140,27 @@ class PostBlueprint < Blueprinter::Base
   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
+
 # --- JBuilder serializers ---
 
 require "jbuilder"
@@ -157,6 +185,22 @@ class Comment
   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
+
 # --- JSONAPI:Serializer serializers / (successor of fast_jsonapi) ---
 
 class JsonApiStandardCommentSerializer
@@ -218,6 +262,26 @@ class JsonApiSameFormatPostSerializer < JsonApiSameFormatSerializer
   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
@@ -291,6 +355,31 @@ class SimpleAMSPostSerializer
   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|
@@ -303,7 +392,7 @@ end
   end
 end
 
-posts = Post.all.to_a
+posts = Post.all.includes(:comments, :commenters)
 
 # --- Store the serializers in procs ---
 
@@ -319,8 +408,9 @@ alba_inline = Proc.new do
     end
   end
 end
-ams = Proc.new { ActiveModelSerializers::SerializableResource.new(posts, {}).as_json }
+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 }
 jbuilder = Proc.new do
   Jbuilder.new do |json|
     json.array!(posts) do |post|
@@ -328,30 +418,37 @@ jbuilder = Proc.new do
     end
   end.target!
 end
+jserializer = Proc.new { JserializerPostSerializer.new(posts, is_collection: true).to_json }
 jsonapi = proc { JsonApiStandardPostSerializer.new(posts).to_json }
 jsonapi_same_format = proc { JsonApiSameFormatPostSerializer.new(posts).to_json }
+panko = proc { Panko::ArraySerializer.new(posts, each_serializer: PankoPostSerializer).to_json }
 primalize = proc { PrimalizePostsResource.new(posts: posts).to_json }
 rails = Proc.new do
   ActiveSupport::JSON.encode(posts.map{ |post| post.serializable_hash(include: :comments) })
 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 "Serializer outputs ----------------------------------"
 {
   alba: alba,
   alba_inline: alba_inline,
   ams: ams,
   blueprinter: blueprinter,
+  fast_serializer: fast_serializer,
   jbuilder: jbuilder, # different order
+  jserializer: jserializer,
   jsonapi: jsonapi, # nested JSON:API format
   jsonapi_same_format: jsonapi_same_format,
+  panko: panko,
   primalize: primalize,
   rails: rails,
   representable: representable,
   simple_ams: simple_ams,
+  turbostreamer: turbostreamer
 }.each { |name, serializer| puts "#{name.to_s.ljust(24, ' ')} #{serializer.call}" }
 
 # --- Run the benchmarks ---
@@ -362,13 +459,17 @@ Benchmark.ips do |x|
   x.report(:alba_inline, &alba_inline)
   x.report(:ams, &ams)
   x.report(:blueprinter, &blueprinter)
+  x.report(:fast_serializer, &fast_serializer)
   x.report(:jbuilder, &jbuilder)
+  x.report(:jserializer, &jserializer)
   x.report(:jsonapi, &jsonapi)
   x.report(:jsonapi_same_format, &jsonapi_same_format)
+  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
@@ -380,13 +481,17 @@ Benchmark.memory do |x|
   x.report(:alba_inline, &alba_inline)
   x.report(:ams, &ams)
   x.report(:blueprinter, &blueprinter)
+  x.report(:fast_serializer, &fast_serializer)
   x.report(:jbuilder, &jbuilder)
+  x.report(:jserializer, &jserializer)
   x.report(:jsonapi, &jsonapi)
   x.report(:jsonapi_same_format, &jsonapi_same_format)
+  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/benchmark/single_resource.rb

@@ -13,10 +13,15 @@ gemfile(true) do
   gem "activerecord", "6.1.3"
   gem "alba", path: '../'
   gem "benchmark-ips"
+  gem "benchmark-memory"
   gem "blueprinter"
   gem "jbuilder"
+  gem 'turbostreamer'
+  gem "jserializer"
   gem "jsonapi-serializer" # successor of fast_jsonapi
   gem "multi_json"
+  gem "panko_serializer"
+  gem "pg"
   gem "primalize"
   gem "oj"
   gem "representable"
@@ -26,7 +31,9 @@ end
 
 # --- Test data model setup ---
 
+require "pg"
 require "active_record"
+require "active_record/connection_adapters/postgresql_adapter"
 require "logger"
 require "oj"
 require "sqlite3"
@@ -154,6 +161,23 @@ class Comment
   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
+
+
 # --- JSONAPI:Serializer serializers / (successor of fast_jsonapi) ---
 
 class JsonApiStandardCommentSerializer
@@ -215,6 +239,25 @@ class JsonApiSameFormatPostSerializer < JsonApiSameFormatSerializer
   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
@@ -282,6 +325,29 @@ class SimpleAMSPostSerializer
   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')
@@ -305,15 +371,19 @@ alba_inline = Proc.new do
     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 }
 jsonapi = proc { JsonApiStandardPostSerializer.new(post).to_json }
 jsonapi_same_format = proc { JsonApiSameFormatPostSerializer.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 ---
 
@@ -324,13 +394,18 @@ puts "Serializer outputs ----------------------------------"
   ams: ams,
   blueprinter: blueprinter,
   jbuilder: jbuilder, # different order
+  jserializer: jserializer,
   jsonapi: jsonapi, # nested JSON:API format
   jsonapi_same_format: jsonapi_same_format,
+  panko: panko,
   primalize: primalize,
   rails: rails,
   representable: representable,
   simple_ams: simple_ams,
-}.each { |name, serializer| puts "#{name.to_s.ljust(24, ' ')} #{serializer.call}" }
+  turbostreamer: turbostreamer
+}.each do |name, serializer|
+  puts "#{name.to_s.ljust(24, ' ')} #{serializer.call}"
+end
 
 # --- Run the benchmarks ---
 
@@ -341,12 +416,15 @@ Benchmark.ips do |x|
   x.report(:ams, &ams)
   x.report(:blueprinter, &blueprinter)
   x.report(:jbuilder, &jbuilder)
+  x.report(:jserializer, &jserializer)
   x.report(:jsonapi, &jsonapi)
   x.report(:jsonapi_same_format, &jsonapi_same_format)
+  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
@@ -359,12 +437,15 @@ Benchmark.memory do |x|
   x.report(:ams, &ams)
   x.report(:blueprinter, &blueprinter)
   x.report(:jbuilder, &jbuilder)
+  x.report(:jserializer, &jserializer)
   x.report(:jsonapi, &jsonapi)
   x.report(:jsonapi_same_format, &jsonapi_same_format)
+  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