ujihisa / juso

Juso

Juso is simple, fast and explicit JSON Serializer.
Juso means 13 (thirteen) in Japanese.

Motivation

Japanese

Juso は as_juso_json というメソッドを定義することでJSON化が可能になります。RubyのHashやArrayを用いて定義すれば良いので、覚えることが非常に少ないことが特徴です。また、暗黙的な挙動で非公開にすべき属性が公開されることを防ぎます。

Ruby on RailsにおいてはModelのクラスにそのまま定義することができるため、初期の導入としてはシンプルでわかりやすいです。¹

Installation

Add this line to your application's Gemfile:

gem 'juso'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install juso

Usage

1. Include Juso::Serializable to your class.
2. Define as_juso_json(context) method.
3. Use Juso.generate(object) method to generate json.

class User < ApplicationRecord
  include Juso::Serializable

  # ...

  def as_juso_json(context)
    {
      id: id,
      nickname: nickname,
    }
  end
end

class Team < ApplicationRecord
  include Juso::Serializable

  has_many :users

  # ...

  def as_juso_json(context)
    {
      id: id,
      name: name,
      users: users
    }
  end
end

team = Team.first!
Juso.generate(team)
=> {"id":1, name: "team name", users: [{id:1,nickname:"hoge"},{id:2,nickname:"piyo"}]}

Rule of juso

Japanese

as_juso_json メソッドは以下のインスタンスしか返してはいけません

• Numeric Class
• String Class
• Null Class
• Hash Class
• Array Class
• Juso::Serializable をinclude したクラス
• Date / DateTime / ActiveSupport::TimeWithZone

再帰的にjusoの処理が適用されるため、Arrayの要素やHashのvalueも同様のルールが適用されます

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/juso. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Juso project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Footnotes

1. as_jsonメソッドで頑張ることもできますが、より宣言的で分かりやすいはずです ↩