Supa

Ruby object → JSON serialization.

Introduction

Installation

Add this line to your application's Gemfile

gem 'supa'

And then execute

bundle install

Or install it yourself as

gem install supa

Usage

Example

class Article
  attr_accessor :id, :title, :text, :author, :comments
end

class Author
  attr_accessor :id, :first_name, :last_name
end

class Comment
  attr_accessor :id, :text
end

class ArticleRepresenter
  include Supa::Representable

  define do
    namespace :jsonapi do
      attribute :version, getter: proc { 1.1 }
    end

    namespace :data do
      attribute :id
      attribute :type, getter: proc { 'articles' }

      namespace :attributes do
        attribute :title
        attribute :text
      end

      namespace :relationships do
        object :author do
          namespace :data do
            attribute :id
            attribute :type, getter: proc { 'authors' }
          end
        end

        namespace :comments do
          collection :data, getter: proc { self.comments } do
            attribute :id
            attribute :type, getter: proc { 'comments' }
          end
        end
      end
    end

    polymorphic :included, getter: proc { [self.author] } do
      attribute :id
      attribute :type, getter: proc { 'authors' }

      namespace :attributes do
        attribute :first_name
        attribute :last_name
      end
    end

    polymorphic :included, getter: proc { self.comments } do
      attribute :id
      attribute :type, getter: proc { 'comments' }

      namespace :attributes do
        attribute :text
      end
    end
  end
end

ArticleRepresenter.new(Article.new).to_json

{
  "jsonapi": {
    "version": 1.1
  },
  "data": {
    "id": "7aa15512-1f9d-4a86-98ad-4bb0aae487a2",
    "type": "articles",
    "attributes": {
      "title": "Pilot wave theory",
      "text": "In theoretical physics, the pilot wave theory was the first known example of a hidden variable theory, presented by Louis de Broglie in 1927. Its more modern version, the de Broglie–Bohm theory, remains a non-mainstream attempt to interpret quantum mechanics as a deterministic theory, avoiding troublesome notions such as wave–particle duality, instantaneous wave function collapse and the paradox of Schrödinger's cat."
    },
    "relationships": {
      "author": {
        "data": {
          "id": "52139b0b-bd22-4fc7-adc8-593f16ae034f",
          "type": "authors"
        }
      },
      "comments": {
        "data": [
          {
            "id": "35a88ca5-80ec-4e49-9357-d8a16b8873f8",
            "type": "comments"
          },
          {
            "id": "0e02b198-299a-4e6b-99a0-8f2c33c15b1d",
            "type": "comments"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "52139b0b-bd22-4fc7-adc8-593f16ae034f",
      "type": "authors",
      "attributes": {
        "first_name": "Louis",
        "last_name": "de Broglie"
      }
    },
    {
      "id": "35a88ca5-80ec-4e49-9357-d8a16b8873f8",
      "type": "comments",
      "attributes": {
        "text": "There can exist empty waves, represented by wave functions propagating in space and time but not carrying energy or momentum, and not associated with a particle."
      }
    },
    {
      "id": "0e02b198-299a-4e6b-99a0-8f2c33c15b1d",
      "type": "comments",
      "attributes": {
        "text": "Let's call the concept ghost waves."
      }
    }
  ]
}

`attribute`

`namespace`

`object`

`collection`

`polymorphic`

Development

To install dependencies

bin/setup

To run tests

bundle exec rake test

To run benchmarks

bundle exec rake bench

To spin up an interactive prompt that will allow you to experiment

bin/console

Contributing

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

License

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

enezhadian / supa