juso 0.1.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d887123b941a26f478f70d16785ff8dbb715ddd2bd6ac4454f5ab94091cae491
-  data.tar.gz: 799410137cc3491745f6907b5d3481bc33e905d56277a5fc49e6c431f698b544
+  metadata.gz: be611b823c4dbebdbd7882f6d9d71c1bf05fbd38c72a6e57a515560fb5efc6b3
+  data.tar.gz: da19722184dea68868395b0db2f7bbbafe093abf2f55d6c64abc3fd2faf5c339
 SHA512:
-  metadata.gz: f7cf662800ae228c3b7c9971352c64dd4f1b67d8aad1c2eb83a98ea80b758d99660e875bd063c843ac172dcb10f583a36fb3738ddf229eeed151df1dc6857940
-  data.tar.gz: ae70c822282eceaac1d3cca0190cf35b8104575363978ac0860551b1cb2b92ef4b7ea9b871bb364adc23a8517353a391a16f7471cc40dc80b2905e13043b39e6
+  metadata.gz: 6937d6359d6ee9589a7d88e605d873d743769f9161a66277027b962d1a96342334f653d0ab8c0dcd234ec9617570723f8826e53753bf9e2acace75cd90110171
+  data.tar.gz: b431598fde992ec3da065898c6a42a8e4c874c2f9d01efd5a0c76dff8767636b27f411acf0051504cbc407109ecd26228ec70d9f3870e22374edc86449e7314d

data/.github/workflows/main.yml

@@ -8,8 +8,10 @@ jobs:
     timeout-minutes: 10
 
     strategy:
+      fail-fast: false
       matrix:
-        ruby-version: [3.1.0-preview1, 3.0.2, 2.7.4, 2.6.8]
+        # ruby-version: [3.1.0-preview1, 3.0.2, 2.7.4, 2.6.8]
+        ruby-version: [3.0.2, 2.7.4, 2.6.8]
 
     steps:
       - uses: actions/checkout@v2
@@ -22,3 +24,29 @@ jobs:
 
       - name: Run test
         run: bundle exec rake test
+
+      - name: Run test (rails)
+        env:
+          RAILS_TEST: true
+        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/.gitignore

@@ -6,3 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+test/dummy/log/*.log
+test/dummy/db/development.sqlite3
+test/dummy/db/test.sqlite3

data/Gemfile

@@ -10,3 +10,6 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.7"
+
+gem 'sqlite3'
+gem 'json_expressions'

data/Gemfile.lock

@@ -1,16 +1,131 @@
 PATH
   remote: .
   specs:
-    juso (0.1.0)
+    juso (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    json_expressions (0.9.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
+    nio4r (2.5.8)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    nokogiri (1.12.5-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.1.1)
@@ -27,7 +142,22 @@ GEM
     rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   arm64-darwin-20
@@ -35,10 +165,13 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  json_expressions
   juso!
   minitest (~> 5.0)
+  rails (~> 6.1.4)
   rake (~> 13.0)
   rubocop (~> 1.7)
+  sqlite3
 
 BUNDLED WITH
    2.2.22

data/README.md

@@ -7,6 +7,16 @@
 Juso is simple, fast and explicit JSON Serializer.  
 Juso means 13 (thirteen) in Japanese.
 
+## Motivation
+
+#### Japanese
+
+Juso は juso というメソッドを定義することで JSON 化が可能になります。Ruby の Hash や Array を用いて定義すれば良いので、覚えることが非常に少ないことが特徴です。また、暗黙的な挙動で非公開にすべき属性が公開されることを防ぎます。
+
+Ruby on Rails においては Model のクラスにそのまま定義することができるため、初期の導入としてはシンプルでわかりやすいです。[^1]
+
+[^1]: as_json メソッドで頑張ることもできますが、より宣言的で分かりやすいはずです
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,7 +36,7 @@ Or install it yourself as:
 ## Usage
 
 1. Include `Juso::Serializable` to your class.
-2. Define as_juso_json(context) method.
+2. Define juso(context) method.
 3. Use Juso.generate(object) method to generate json.
 
 ```ruby
@@ -35,7 +45,7 @@ class User < ApplicationRecord
 
   # ...
 
-  def as_juso_json(context)
+  def juso(context)
     {
       id: id,
       nickname: nickname,
@@ -50,7 +60,7 @@ class Team < ApplicationRecord
 
   # ...
 
-  def as_juso_json(context)
+  def juso(context)
     {
       id: id,
       name: name,
@@ -70,17 +80,66 @@ Juso.generate(team)
 
 #### Japanese
 
-as_juso_json メソッドは以下のインスタンスしか返してはいけません
+juso メソッドは以下のインスタンスしか返してはいけません
 
 - Numeric Class
 - String Class
-- Null Class
+- Nil Class
+- True Class
+- False Class
 - Hash Class
 - Array Class
-- Juso::Serializable をinclude したクラス
-- Date / DateTime / ActiveSupport::TimeWithZone
+  - - ActiveRecord::Relation
+- Juso::Serializable を include したクラス
+- Date / DateTime
+  - - ActiveSupport::TimeWithZone
+
+再帰的に juso の処理が適用されるため、Array の要素や Hash の value も同様のルールが適用されます
+
+### Juso::Context
+
+#### Japanese
+
+juso メソッドには Context オブジェクトが渡されます。これによって、Juso.generate から各 juso メソッドにシリアライズのオプションを伝播させることができます
+
+### Juso.wrap
+
+```ruby
+class UserSerializer
+  include Juso::Serializable
+
+  # ...
+
+  def juso(context)
+    {
+      id: @user.id,
+
+      # 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
+
+class PostSerializer
+  include Juso::Serializable
+
+  def initialize(post)
+    @post = post
+  end
+
+  def juso(context)
+    # do something with @post...
+  end
+end
+```
+
+#### Japanese
 
-再帰的にjusoの処理が適用されるため、Arrayの要素やHashのvalueも同様のルールが適用されます
+Juso.wrap(object, serializable_class) ユーティリティを使うことで、特定のクラスに処理を委譲できます。
+コード例だと、 @user.posts は Post の ActiveRecord::Relation を返しますが、通常であれば Post インスタンスの juso メソッドが使われるのに対して、各 Post インスタンスを PostSerializer でラップします。PostSerializer#juso メソッドが呼ばれることになります。
 
 ## Development
 

data/Rakefile

@@ -6,11 +6,17 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
 
-require "rubocop/rake_task"
+  files = FileList["test/juso_test.rb"]
+
+  if ENV['RAILS_TEST']
+    files << 'test/rails_test.rb'
+  end
+
+  t.test_files = files
+end
 
-RuboCop::RakeTask.new
+# require "rubocop/rake_task"
+# RuboCop::RakeTask.new
 
-task default: %i[test rubocop]
+task default: %i[test]

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)
@@ -90,13 +90,11 @@ end
 # --- Juso serializers ---
 
 require "juso"
-require 'active_record' # hack for CollectionProxy
-Juso.reset_collection_classes
 
 class Comment
   include ::Juso::Serializable
 
-  def as_juso_json(context)
+  def juso(context)
     {id: id, body: body}
   end
 end
@@ -104,7 +102,7 @@ end
 class Post
   include ::Juso::Serializable
 
-  def as_juso_json(context)
+  def juso(context)
     {id: id, body: body, commenter_names: commenter_names, comments: comments}
   end
 end
@@ -266,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 ---
 #
@@ -363,8 +361,6 @@ post.reload
 
 juso = Proc.new do
   Juso.generate(post)
-rescue
-  binding.irb
 end
 
 alba = Proc.new { AlbaPostResource.new(post).serialize }
@@ -385,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/juso.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "juso is simple json serializer for web application"
   spec.homepage      = "https://github.com/ykpythemind/juso"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.6.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
 
@@ -34,4 +34,6 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_development_dependency "rails", "~> 6.1.4"
 end

data/lib/juso/version.rb

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

data/lib/juso.rb

@@ -9,63 +9,77 @@ module Juso
   class Error < StandardError; end
 
   module Serializable
-    def as_juso_json(_)
+    def juso(_)
       nil
     end
   end
 
-  # Juso Context is serializer context
-  # xxxxx
+  # Juso::Context is serializer context
   class Context
-    def initialize(serializer_type: :default)
-      @serializer_type = serializer_type.to_sym
+    DEFAULT_OPTS = {}.freeze
+
+    def initialize(serializer: :default, options: DEFAULT_OPTS)
+      @serializer = serializer
+      @options = options
     end
 
-    attr_reader :serializer_type
+    attr_reader :serializer, :options
   end
 
-  def self.generate(object, context: Context.new)
-    JSON.fast_generate(_generate(object, context))
+  # Juso.generate generates json string
+  def self.generate(object, context = Context.new)
+    JSON.fast_generate(_g(object, context))
   end
 
-  # generate returns hash (as json)
-  def self._generate(object, context)
+  # generate returns object (as json)
+  def self._g(object, context)
     case object
-    when nil, Numeric, String
+    when nil, Numeric, String, true, false
       return object
     when Hash
       return object.each_with_object({}) do |(k, v), acc|
-        acc[k] = _generate(v, context)
+        acc[k] = _g(v, context)
       end
     when Serializable
-      # respond_to?(:as_juso_json) のほうが良い可能性ある？
-      return _generate(object.as_juso_json(context), context)
+      # respond_to?(:juso) のほうが良い可能性ある？
+      return _g(object.juso(context), context)
     when *collection_classes
-      return object.to_a.map { |o| _generate(o, context) }
+      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?(:as_juso_json) and warn?
+      # TODO: fallback to respond_to?(:juso) and warn?
 
       raise Error.new("cannot serialize object: #{object}. you must include Juso::Serializable")
     end
   end
 
+  # Juso.wrap is utility for wrapping object with Juso::Serializable class
+  def self.wrap(object, klass)
+    if collection_classes.any? { |arrayish| object.is_a?(arrayish) }
+      object.to_a.map { |o| klass.new(o) }
+    else
+      klass.new(object)
+    end
+  end
+
   def self.collection_classes
-    @collection_classes
+    @collection_classes ||= default_collection_classes
   end
 
-  def self.reset_collection_classes
-    @collection_classes =
-      if defined?(ActiveRecord)
-        [Array, ActiveRecord::Relation, ActiveRecord::Associations::CollectionProxy]
-      else
-        [Array]
-      end
+  def self.default_collection_classes
+    if defined?(ActiveRecord)
+      [Array, ActiveRecord::Relation]
+    else
+      [Array]
+    end
   end
 
   def self.date_classes
-    # TODO: FIX / memorize
+    @date_classes ||= default_date_classes
+  end
+
+  def self.default_date_classes
     if defined?(ActiveSupport::TimeWithZone)
       [Date, DateTime, ActiveSupport::TimeWithZone]
     else
@@ -73,5 +87,5 @@ module Juso
     end
   end
 
-  reset_collection_classes
+  private_class_method :default_collection_classes, :default_date_classes
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: juso
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.2
 platform: ruby
 authors:
 - ykpythemind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
-dependencies: []
+date: 2021-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
 description: juso is simple json serializer for web application
 email:
 - yukibukiyou@gmail.com
@@ -26,6 +40,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark/collection.rb
 - benchmark/single_resource.rb
 - bin/console
 - bin/setup
@@ -48,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="