README.rdoc in fast_jsonapi-1.0.16 vs README.rdoc in fast_jsonapi-1.0.17
- old
+ new
@@ -1,18 +1,231 @@
-= fast_jsonapi
+# Fast JSON API
-Description goes here.
+[]()
-== Contributing to fast_jsonapi
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+A lightning fast [JSON:API](http://jsonapi.org/) serializer for Ruby Objects.
-== Copyright
+# Performance Comparision
-Copyright (c) 2017 Shishir Kakaraddi. See LICENSE.txt for
-further details.
+We compare serialization times with Active Model Serializer as part of RSpec performance tests included on this library. We want to ensure that with every change on this library, serialization time is at least `25 times` faster than Active Model Serializers on up to current benchmark of 1000 records.
+
+## Benchmark times for 250 records
+
+```bash
+ $ rspec
+ Active Model Serializer serialized 250 records in 138.71 ms
+ Fast JSON API serialized 250 records in 3.01 ms
+```
+
+# Table of Contents
+
+* [Features](#features)
+* [Installation](#installation)
+* [Usage](#usage)
+ * [Model Definition](#model-definition)
+ * [Serializer Definition](#serializer-definition)
+ * [Object Serialization](#object-serialization)
+ * [Compound Document](#compound-document)
+ * [Collection Serialization](#collection-serialization)
+ * [Caching](#caching)
+* [Contributing](#contributing)
+
+
+## Features
+
+* Declaration syntax similar to Active Model serializer
+* Support for belongs_to, has_many and has_one
+* Support for compound documents (included)
+* Optimized serialization of compound documents
+* Caching
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fast_jsonapi'
+```
+
+Execute:
+
+```ruby
+$ bundle install
+```
+
+## Usage
+
+### Model Definition
+
+```ruby
+class Movie
+ attr_accessor :id, :name, :year, :actor_ids, :owner_id
+end
+```
+
+### Serializer Definition
+
+```ruby
+class MovieSerializer
+ include FastJsonapi::ObjectSerializer
+ set_type :movie # optional
+ attributes :name, :year
+ has_many :actors
+ belongs_to :owner, record_type: :user
+ belongs_to :movie_type
+end
+```
+
+### Sample Object
+
+```ruby
+m = Movie.new
+m.id = 232
+m.name = 'test movie'
+m.actor_ids = [1, 2, 3]
+m.owner_id = 3
+m.movie_type_id = 1
+m
+```
+
+### Object Serialization
+
+#### Return a hash
+```ruby
+hash = MovieSerializer.new(movie).serializable_hash
+```
+
+#### Return Serialized JSON
+```ruby
+json_string = MovieSerializer.new(movie).serialized_json
+```
+
+#### Serialized Output
+
+```json
+{
+ "data": {
+ "id": "232",
+ "type": "movie",
+ "attributes": {
+ "name": "test movie",
+ "year": null
+ },
+ "relationships": {
+ "actors": {
+ "data": [
+ {
+ "id": "1",
+ "type": "actor"
+ },
+ {
+ "id": "2",
+ "type": "actor"
+ }
+ ]
+ },
+ "owner": {
+ "data": {
+ "id": "3",
+ "type": "user"
+ }
+ }
+ }
+ }
+}
+
+```
+### Compound Document
+
+Support for top-level included member through ` options[:include] `.
+
+```ruby
+options = {}
+options[:meta] = { total: 2 }
+options[:include] = [:actors]
+MovieSerializer.new([movie, movie], options).serialized_json
+```
+
+### Collection Serialization
+
+```ruby
+options[:meta] = { total: 2 }
+hash = MovieSerializer.new([movie, movie], options).serializable_hash
+json_string = MovieSerializer.new([movie, movie], options).serialized_json
+```
+
+### Caching
+
+```ruby
+class MovieSerializer
+ include FastJsonapi::ObjectSerializer
+ set_type :movie # optional
+ cache_options enabled: true cache_length: 12.hours
+ attributes :name, :year
+end
+```
+
+### Customizable Options
+
+Option | Purpose | Example
+------------ | ------------- | -------------
+set_type | Type name of Object | ```set_type :movie ```
+cache_options | Hash to enable caching and set cache length | ```cache_options enabled: true cache_length: 12.hours```
+id_method_name | Set custom method name to get ID of an object | ```has_many :locations, id_method_name: :place_ids ```
+object_method_name | Set custom method name to get related objects | ```has_many :locations, object_method_name: :places ```
+record_type | Set custom Object Type for a relationship | ```belongs_to :owner, record_type: :user```
+serializer | Set custom Serializer for a relationship | ```has_many :actors, serializer: :custom_actor```
+cache_options | Hash to enable caching and set cache length | ```cache_options enabled: true cache_length: 12.hours ```
+
+
+## Contributing
+
+This gem is built using a gem building gem called [juwelier](https://github.com/flajann2/juwelier).
+
+Beyond just editing source code, you’ll be interacting with the gem using rake a lot. To see all the tasks available with a brief description, you can run:
+
+```bash
+rake -T
+```
+
+### Updating Project information
+You can update the project information of the gem by updating the [Rakefile](Rakefile). Then you need to generate a new gemspec
+
+```bash
+rake gemspec
+```
+
+### Running Tests
+We use rspec for testing. We have unit tests, functional tests and performance tests. To run tests use the following rake task
+
+```bash
+rake spec
+```
+
+### Installation
+
+```bash
+$ rake install
+```
+
+The install rake task builds the gem installs it. You're all
+set if you're using [RVM](http://rvm.beginrescueend.com/), but you may
+need to run it with sudo if you have a system-installed ruby:
+
+### Bumping Version
+
+It feels good to release code. Do it, do it often. But before that, bump
+the version. Then release it. There's a few ways to update the version:
+
+```ruby
+# version:write like before
+$ rake version:write MAJOR=0 MINOR=3 PATCH=0
+
+# bump just major, ie 0.1.0 -> 1.0.0
+$ rake version:bump:major
+
+# bump just minor, ie 0.1.0 -> 0.2.0
+$ rake version:bump:minor
+
+# bump just patch, ie 0.1.0 -> 0.1.1
+$ rake version:bump:patch
+```