alba 1.1.0 → 1.5.0

data/benchmark/collection.rb

@@ -0,0 +1,441 @@
+# Benchmark script to run varieties of JSON serializers
+# Fetch Alba from local, otherwise fetch latest from RubyGems
+
+# --- Bundle dependencies ---
+
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem "active_model_serializers"
+  gem "activerecord", "6.1.3"
+  gem "alba", path: '../'
+  gem "benchmark-ips"
+  gem "benchmark-memory"
+  gem "blueprinter"
+  gem "jbuilder"
+  gem "jserializer"
+  gem "jsonapi-serializer" # successor of fast_jsonapi
+  gem "multi_json"
+  gem "panko_serializer"
+  gem "pg"
+  gem "primalize"
+  gem "oj"
+  gem "representable"
+  gem "simple_ams"
+  gem "sqlite3"
+end
+
+# --- Test data model setup ---
+
+require "pg"
+require "active_record"
+require "active_record/connection_adapters/postgresql_adapter"
+require "logger"
+require "oj"
+require "sqlite3"
+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
+
+# --- 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"
+
+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
+
+# --- 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
+
+# --- JSONAPI:Serializer serializers / (successor of fast_jsonapi) ---
+
+class JsonApiStandardCommentSerializer
+  include JSONAPI::Serializer
+
+  attribute :id
+  attribute :body
+end
+
+class JsonApiStandardPostSerializer
+  include JSONAPI::Serializer
+
+  # set_type :post  # optional
+  attribute :id
+  attribute :body
+  attribute :commenter_names
+
+  attribute :comments do |post|
+    post.comments.map { |comment| JsonApiSameFormatCommentSerializer.new(comment) }
+  end
+end
+
+# --- JSONAPI:Serializer serializers that format the code the same flat way as the other gems here ---
+
+# code to convert from JSON:API output to "flat" JSON, like the other serializers build
+class JsonApiSameFormatSerializer
+  include JSONAPI::Serializer
+
+  def as_json(*_options)
+    hash = serializable_hash
+
+    if hash[:data].is_a? Hash
+      hash[:data][:attributes]
+
+    elsif hash[:data].is_a? Array
+      hash[:data].pluck(:attributes)
+
+    elsif hash[:data].nil?
+      { }
+
+    else
+      raise "unexpected data type #{hash[:data].class}"
+    end
+  end
+end
+
+class JsonApiSameFormatCommentSerializer < JsonApiSameFormatSerializer
+  attribute :id
+  attribute :body
+end
+
+class JsonApiSameFormatPostSerializer < JsonApiSameFormatSerializer
+  attribute :id
+  attribute :body
+  attribute :commenter_names
+
+  attribute :comments do |post|
+    post.comments.map { |comment| JsonApiSameFormatCommentSerializer.new(comment) }
+  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.comments.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
+
+class PrimalizePostsResource < Primalize::Many
+  attributes posts: enumerable(PrimalizePostResource)
+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
+  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
+
+# --- 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.to_a
+
+# --- Store the serializers in procs ---
+
+alba = Proc.new { AlbaPostResource.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, {}).as_json }
+blueprinter = Proc.new { PostBlueprint.render(posts) }
+jbuilder = Proc.new do
+  Jbuilder.new do |json|
+    json.array!(posts) do |post|
+      json.post post.to_builder
+    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 }
+
+# --- 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,
+  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}" }
+
+# --- 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(: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.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(: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.compare!
+end

data/benchmark/{local.rb → single_resource.rb}

@@ -13,18 +13,26 @@ gemfile(true) do
   gem "activerecord", "6.1.3"
   gem "alba", path: '../'
   gem "benchmark-ips"
+  gem "benchmark-memory"
   gem "blueprinter"
   gem "jbuilder"
+  gem "jserializer"
   gem "jsonapi-serializer" # successor of fast_jsonapi
   gem "multi_json"
+  gem "panko_serializer"
+  gem "pg"
+  gem "primalize"
   gem "oj"
   gem "representable"
+  gem "simple_ams"
   gem "sqlite3"
 end
 
 # --- Test data model setup ---
 
+require "pg"
 require "active_record"
+require "active_record/connection_adapters/postgresql_adapter"
 require "logger"
 require "oj"
 require "sqlite3"
@@ -152,6 +160,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
@@ -213,6 +238,46 @@ 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.comments.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"
@@ -237,6 +302,28 @@ class PostRepresenter < Representable::Decorator
   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
+
 # --- Test data creation ---
 
 post = Post.create!(body: 'post')
@@ -263,10 +350,14 @@ 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 }
 
 # --- Execute the serializers to check their output ---
 
@@ -277,28 +368,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
+  representable: representable,
+  simple_ams: simple_ams,
 }.each { |name, serializer| puts "#{name.to_s.ljust(24, ' ')} #{serializer.call}" }
 
 # --- Run the benchmarks ---
 
-require 'benchmark'
-time = 1000
-Benchmark.bmbm do |x|
-  x.report(:alba) { time.times(&alba) }
-  x.report(:alba_inline) { time.times(&alba_inline) }
-  x.report(:ams) { time.times(&ams) }
-  x.report(:blueprinter) { time.times(&blueprinter) }
-  x.report(:jbuilder) { time.times(&jbuilder) }
-  x.report(:jsonapi) { time.times(&jsonapi) }
-  x.report(:jsonapi_same_format) { time.times(&jsonapi_same_format) }
-  x.report(:rails) { time.times(&rails) }
-  x.report(:representable) { time.times(&representable) }
-end
-
 require 'benchmark/ips'
 Benchmark.ips do |x|
   x.report(:alba, &alba)
@@ -306,10 +387,34 @@ 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.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(: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.compare!
 end

data/codecov.yml

@@ -3,3 +3,6 @@ coverage:
     project:
       default:
         informational: true
+    patch:
+      default:
+        target: 90%