juso 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 912622622f8b9a6866a505f8ba27a1cc21a3073a59ac364942ce6d997baeb875
-  data.tar.gz: 125f56e1649fad476b076457272349a221ec69f38600bc17f62bf0255902a777
+  metadata.gz: a51c9bb514c29a43c32b28bfe8bc8b7e1be09c7cbfaa7f6e06e21c8f75bcc059
+  data.tar.gz: 243229044555a5d619327549801d2a6fdcd4b5272ddbb32beadd521e745035b5
 SHA512:
-  metadata.gz: cc04ee74481f9fa92988d4e4457eb40929e670a91c95b07171af2358c5f85a77dbd2af2ba846a0bc1c90da13aca85363fba5060b75255e91373fcf964ee5893c
-  data.tar.gz: 7d51bbec1f134665d4f058c666d64616762e8b86b2981fd94eb03af40a638e71d952e42bdaf1a8216342a4ee644da6f57f7ccba8730b0f4dc6f6672e1ae6e0b9
+  metadata.gz: 5d9f185580a6f4537aa41e7c18d4db70a69f2f8c11e4b47af1127df01322c0c1f1612278312910bb06076e6b679efc85906cfcf224a99683a9dfefd81eef9f2d
+  data.tar.gz: acf60f8aee9a93f15f2ed461a40b427e10bedf4b10ec273bc7884d7f5f5dd2ab2bb987d3bb550d19d70d4ea5d9bceb1af2619d71f43d29b096e790f3dbd7ef09

data/.github/workflows/main.yml

@@ -31,3 +31,22 @@ jobs:
         run: |
           bundle exec rails db:setup
           bundle exec rake test
+
+  benchmark:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.2
+          bundler-cache: true
+
+      - name: Run benchmark (collection)
+        run: ruby benchmark/collection.rb
+
+      - name: Run benchmark (single)
+        run: ruby benchmark/single_resource.rb

data/README.md

@@ -89,8 +89,10 @@ juso メソッドは以下のインスタンスしか返してはいけません
 - False Class
 - Hash Class
 - Array Class
+  - - ActiveRecord::Relation
 - Juso::Serializable を include したクラス
-- Date / DateTime / ActiveSupport::TimeWithZone
+- Date / DateTime
+  - - ActiveSupport::TimeWithZone
 
 再帰的に juso の処理が適用されるため、Array の要素や Hash の value も同様のルールが適用されます
 
@@ -111,8 +113,12 @@ class UserSerializer
   def juso(context)
     {
       id: @user.id,
-      posts: Juso.wrap(@user.posts, PostSerializer), # use PostSerializer#juso method. Each post passes into PostSerializer object.
-      team: @user.team, # use Team#juso method
+
+      # use PostSerializer#juso method. Each post passes into PostSerializer object.
+      posts: Juso.wrap(@user.posts, PostSerializer),
+
+      # use Team#juso method
+      team: @user.team,
     }
   end
 end

data/benchmark/collection.rb

@@ -0,0 +1,472 @@
+# original: https://github.com/okuramasafumi/alba/blob/main/benchmark/collection.rb
+
+# Benchmark script to run varieties of JSON serializers
+# Fetch juso 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"
+  gem "juso", 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
+
+# --- Juso serializers ---
+
+require "juso"
+
+class Comment
+  include ::Juso::Serializable
+
+  def juso(context)
+    {id: id, body: body}
+  end
+end
+
+class Post
+  include ::Juso::Serializable
+
+  def juso(context)
+    {id: id, body: body, commenter_names: commenter_names, comments: comments}
+  end
+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
+
+juso = Proc.new do
+  Juso.generate(posts)
+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,
+  juso: juso,
+  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(:juso, &juso)
+  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(:juso, &juso)
+  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/single_resource.rb

@@ -1,7 +1,7 @@
 # original from https://github.com/okuramasafumi/alba/blob/main/benchmark/single_resource.rb
 
 # Benchmark script to run varieties of JSON serializers
-# Fetch Alba from local, otherwise fetch latest from RubyGems
+# Fetch juso from local, otherwise fetch latest from RubyGems
 
 # --- Bundle dependencies ---
 
@@ -22,10 +22,10 @@ gemfile(true) do
   gem "jserializer"
   gem "jsonapi-serializer" # successor of fast_jsonapi
   gem "multi_json"
-  # gem "panko_serializer"
-  # gem "pg"
+  gem "panko_serializer"
+  gem "pg"
   gem "primalize"
-  # gem "oj"
+  gem "oj"
   gem "representable"
   gem "simple_ams"
   gem "sqlite3"
@@ -33,14 +33,14 @@ end
 
 # --- Test data model setup ---
 
-# require "pg"
+require "pg"
 require "active_record"
-# require "active_record/connection_adapters/postgresql_adapter"
+require "active_record/connection_adapters/postgresql_adapter"
 require "active_record/connection_adapters/sqlite3_adapter"
 require "logger"
-# require "oj"
+require "oj"
 require "sqlite3"
-# Oj.optimize_rails
+Oj.optimize_rails
 
 ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
 # ActiveRecord::Base.logger = Logger.new($stdout)
@@ -264,22 +264,22 @@ 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
+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 ---
 #
@@ -361,8 +361,6 @@ post.reload
 
 juso = Proc.new do
   Juso.generate(post)
-rescue
-  binding.irb
 end
 
 alba = Proc.new { AlbaPostResource.new(post).serialize }
@@ -383,8 +381,8 @@ 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) }
-panko = proc { 'nop' }
+panko = proc { PankoPostSerializer.new.serialize_to_json(post) }
+# panko = proc { 'nop' }
 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 }

data/lib/juso/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Juso
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/juso.rb

@@ -27,11 +27,11 @@ module Juso
   end
 
   # Juso.generate generates json string
-  def self.generate(object, context: Context.new)
+  def self.generate(object, context = Context.new)
     JSON.fast_generate(_g(object, context))
   end
 
-  # generate returns hash (as json)
+  # generate returns object (as json)
   def self._g(object, context)
     case object
     when nil, Numeric, String, true, false
@@ -46,7 +46,7 @@ module Juso
     when *collection_classes
       return object.to_a.map { |o| _g(o, context) }
     when *date_classes
-      return object.iso8601
+      return object.iso8601(context.options[:juso_time_n_digits] || 0)
     else
       # TODO: fallback to respond_to?(:juso) and warn?
 
@@ -87,5 +87,5 @@ module Juso
     end
   end
 
-  private_class_method :default_collection_classes, :default_date_classes, :_g
+  private_class_method :default_collection_classes, :default_date_classes
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: juso
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - ykpythemind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-27 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -40,6 +40,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark/collection.rb
 - benchmark/single_resource.rb
 - bin/console
 - bin/setup