juso 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc3dce11d5ba4c7a3ef2ff135c5cb75f88689c78f1b48c7db47beb51bfdb82b8
-  data.tar.gz: 011ba9b8a7aeed23122681264bfcc0cc02898bf0b56d28f59a344429d3bfbc34
+  metadata.gz: 912622622f8b9a6866a505f8ba27a1cc21a3073a59ac364942ce6d997baeb875
+  data.tar.gz: 125f56e1649fad476b076457272349a221ec69f38600bc17f62bf0255902a777
 SHA512:
-  metadata.gz: e478fc64b56739caf65a103f3f196e185a2a52d36b758641643715aa09f6f5c8fd88f8abd3c471178c06ec2df64f6ef64e87f10fee738d4034d8945c793b15d3
-  data.tar.gz: f4f1da552903c37ec9fdfc3e92ae34a1d08f463396307c8abea80420464992807f4f94e691023bd5ea5a6312e61a38fbedc2c56cd26ec7a9f7d6fbda69b29927
+  metadata.gz: cc04ee74481f9fa92988d4e4457eb40929e670a91c95b07171af2358c5f85a77dbd2af2ba846a0bc1c90da13aca85363fba5060b75255e91373fcf964ee5893c
+  data.tar.gz: 7d51bbec1f134665d4f058c666d64616762e8b86b2981fd94eb03af40a638e71d952e42bdaf1a8216342a4ee644da6f57f7ccba8730b0f4dc6f6672e1ae6e0b9

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,10 @@ 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

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,60 @@ 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 したクラス
+- Juso::Serializable を include したクラス
 - Date / DateTime / ActiveSupport::TimeWithZone
 
-再帰的にjusoの処理が適用されるため、Arrayの要素やHashのvalueも同様のルールが適用されます
+再帰的に 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,
+      posts: Juso.wrap(@user.posts, PostSerializer), # use PostSerializer#juso method. Each post passes into PostSerializer object.
+      team: @user.team, # use Team#juso method
+    }
+  end
+end
+
+class PostSerializer
+  include Juso::Serializable
+
+  def initialize(post)
+    @post = post
+  end
+
+  def juso(context)
+    # do something with @post...
+  end
+end
+```
+
+#### Japanese
+
+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/single_resource.rb

@@ -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

data/juso.gemspec

@@ -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.2.0"
+  VERSION = "1.0.0"
 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
 
+  # Juso.generate generates json string
   def self.generate(object, context: Context.new)
-    JSON.fast_generate(_generate(object, context))
+    JSON.fast_generate(_g(object, context))
   end
 
   # generate returns hash (as json)
-  def self._generate(object, context)
+  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
     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, :_g
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: juso
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ykpythemind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
-dependencies: []
+date: 2021-11-27 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