A gem to serialize objects using a similar API to active_model_serializers. It technically doesn't require that you use Rails, but it does leverage some Active Support modules so it's geared towards rails apps.
Add this line to your application's Gemfile:
gem 'kix'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install kix
class UserSerializer < Kix::Serializer
attributes :name, :email, :phone, :skippable
def phone
_object.phone_number || "N/A"
end
def skippable
# throw skip if you want to omit this attribute entirely
throw(:skip)
end
end
class User
include Kix::Serializable
attr_reader :name, :email, :phone_number
def initialize(name, email, phone_number = nil)
@name = name
@email = email
@phone_number = phone_number
end
end
User.new("John", "john@example.com").as_json
#=> {"name"=>"John", "email"=>"john@example.com", "phone"=>"N/A"}
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kix.
The gem is available as open source under the terms of the MIT License.