roar-jsonapi 0.0.1

data/test/jsonapi/fieldsets_options_test.rb

@@ -0,0 +1,161 @@
+require 'test_helper'
+require 'roar/json/json_api'
+
+class FieldsetsOptionsTest < Minitest::Spec
+  Include = Roar::JSON::JSONAPI::Options::Include
+
+  describe 'with non-empty :include and non-empty :fields option' do
+    it 'rewrites :include and parses :fields' do
+      [{ include: [:articles],
+         fields:  { articles: [:title, :body],  people: [] } },
+       { include: ['articles'],
+         fields:  { articles: ['title,body'],   people: [] } },
+       { include: 'articles',
+         fields:  { 'articles' => 'title,body', 'people' => '' } }].each do |options|
+        options = Include.(options, relationships: { 'articles' => 'articles' })
+        options.must_equal(include:  [:id, :attributes, :relationships, :included],
+                           included: {
+                             include:  [:articles],
+                             articles: {
+                               include:          [:id, :attributes, :relationships],
+                               attributes:       { include: [:title, :body] },
+                               relationships:    { include: [:title, :body] },
+                               _json_api_parsed: true
+                             },
+                             people:   {
+                               attributes:       { include: [] },
+                               relationships:    { include: [] },
+                               _json_api_parsed: true
+                             }
+                           })
+      end
+    end
+  end
+
+  describe 'with empty :include option' do
+    it 'rewrites :include' do
+      [{ include: [] },
+       { include: [''] },
+       { include: '' }].each do |options|
+        options = Include.(options, {})
+        options.must_equal(include:  [:id, :attributes, :relationships, :included],
+                           included: { include: [] })
+      end
+    end
+  end
+
+  describe 'with empty :include option and non-empty :fields option' do
+    it 'parses :fields (_self), but does not include other resources' do
+      [{ include: [],   fields:  { articles: [:title, :body], people: [] } },
+       { include: [''], fields:  { articles: ['title,body'],  people: [] } },
+       { include: '',   fields:  { 'articles' => 'title,body', 'people' => '' } }].each do |options|
+        options = Include.(options, relationships: { '_self' => 'articles' })
+        options.must_equal(include:       [:id, :attributes, :relationships, :included],
+                           included:      {
+                             include: [],
+                             people:  {
+                               attributes:       { include: [] },
+                               relationships:    { include: [] },
+                               _json_api_parsed: true
+                             }
+                           },
+                           attributes:    { include: [:title, :body] },
+                           relationships: { include: [:title, :body] })
+      end
+    end
+
+    it 'parses :fields, but does not include other resources' do
+      [{ include: [],   fields:  { articles: [:title, :body], people: [:email] } },
+       { include: [''], fields:  { articles: ['title,body'],  people: ['email'] } },
+       { include: '',   fields:  { 'articles' => 'title,body', 'people' => 'email' } }].each do |options|
+        options = Include.(options, relationships: { 'author' => 'people', 'articles' => 'articles' })
+        options.must_equal(include:  [:id, :attributes, :relationships, :included],
+                           included: {
+                             include:  [],
+                             articles: {
+                               attributes:       { include: [:title, :body] },
+                               relationships:    { include: [:title, :body] },
+                               _json_api_parsed: true
+                             },
+                             author:   {
+                               attributes:       { include: [:email] },
+                               relationships:    { include: [:email] },
+                               _json_api_parsed: true
+                             }
+                           })
+      end
+    end
+  end
+
+  describe 'with non-empty :include option' do
+    it 'rewrites :include given a relationship name' do
+      [{ include: [:comments] },
+       { include: ['comments'] },
+       { include: 'comments' }].each do |options|
+        options = Include.(options, {})
+        options.must_equal(include:  [:id, :attributes, :relationships, :included],
+                           included: {
+                             include:  [:comments],
+                             comments: {
+                               include:          [:id, :attributes, :relationships],
+                               _json_api_parsed: true
+                             }
+                           })
+      end
+    end
+
+    it 'rewrites :include given a dot-separated path of relationship names' do
+      [{ include: [:"comments.author.employer"] },
+       { include: ['comments.author.employer'] },
+       { include: 'comments.author.employer' }].each do |options|
+        options = Include.(options, {})
+        options.must_equal(include:  [:id, :attributes, :relationships, :included],
+                           included: {
+                             include:  [:comments],
+                             comments: {
+                               include:          [:id, :attributes, :relationships, :included],
+                               included:         {
+                                 author: {
+                                   include:          [:id, :attributes, :relationships, :included],
+                                   included:         {
+                                     employer: {
+                                       include:          [:id, :attributes, :relationships],
+                                       _json_api_parsed: true
+                                     }
+                                   },
+                                   _json_api_parsed: true
+                                 }
+                               },
+                               _json_api_parsed: true
+                             }
+                           })
+      end
+    end
+
+    it 'does not rewrite :include if _json_api_parsed: true' do
+      options = Include.({ include:          [:id, :attributes],
+                           _json_api_parsed: true }, {})
+      options.must_equal(include:          [:id, :attributes],
+                         _json_api_parsed: true)
+    end
+  end
+
+  describe 'with falsey :include options' do
+    it 'does not rewrite include: false' do
+      options = Include.({ include: false }, {})
+      options.must_equal(include: false)
+    end
+
+    it 'does not rewrite include: nil' do
+      options = Include.({ include: nil }, {})
+      options.must_equal(include: nil)
+    end
+  end
+
+  describe 'with falsey :fields options' do
+    it 'does not parse fields: nil' do
+      options = Include.({ fields: nil }, {})
+      options.must_equal(fields: nil)
+    end
+  end
+end

data/test/jsonapi/fieldsets_test.rb

@@ -0,0 +1,293 @@
+require 'test_helper'
+require 'roar/json/json_api'
+require 'json'
+
+class JSONAPIFieldsetsTest < Minitest::Spec
+  Article = Struct.new(:id, :title, :summary, :comments, :author)
+  Comment = Struct.new(:id, :body, :good, :comment_author)
+  Author = Struct.new(:id, :name, :email)
+
+  describe 'Single Resource Object With Options' do
+    class DocumentSingleResourceObjectDecorator < Roar::Decorator
+      include Roar::JSON::JSONAPI.resource :articles
+
+      attributes do
+        property :title
+        property :summary
+      end
+
+      has_many :comments do
+        attributes do
+          property :body
+          property :good
+        end
+
+        has_one :comment_author, class: Comment do
+          type :authors
+
+          attributes do
+            property :name
+            property :email
+          end
+        end
+      end
+
+      has_one :author do
+        type :authors
+
+        attributes do
+          property :name
+          property :email
+        end
+      end
+    end
+
+    let(:comments) {
+      [
+        Comment.new('c:1', 'Cool!', true,
+                    Author.new('a:2', 'Tim', 'troll@trollblazer.io')),
+        Comment.new('c:2', 'Nah', false)
+      ]
+    }
+
+    let(:article) {
+      Article.new(1, 'My Article', 'An interesting read.', comments,
+                  Author.new('a:1', 'Celso', 'celsito@trb.to'))
+    }
+
+    it 'includes scalars' do
+      DocumentSingleResourceObjectDecorator.new(article)
+                                           .to_json(
+                                             fields: { articles: 'title' }
+                                           )
+                                           .must_equal_json(%(
+          {
+            "data": {
+              "id": "1",
+              "attributes": {
+                "title": "My Article"
+              },
+              "type": "articles"
+            }
+          }
+        ))
+    end
+
+    it 'includes compound objects' do
+      DocumentSingleResourceObjectDecorator.new(article)
+                                           .to_json(
+                                             fields:  { articles: 'title' },
+                                             include: :comments
+                                           )
+                                           .must_equal_json(%(
+          {
+            "data": {
+              "id": "1",
+              "attributes": {
+                "title": "My Article"
+              },
+              "type": "articles"
+            },
+            "included": [
+              {
+                "type": "comments",
+                "id": "c:1",
+                "attributes": {
+                  "body": "Cool!",
+                  "good": true
+                },
+                "relationships": {
+                  "comment-author": {
+                    "data": {
+                      "type": "authors",
+                      "id": "a:2"
+                    }
+                  }
+                }
+              },
+              {
+                "type": "comments",
+                "id": "c:2",
+                "attributes": {
+                  "body": "Nah",
+                  "good": false
+                },
+                "relationships": {
+                  "comment-author": {
+                    "data": null
+                  }
+                }
+              }
+            ]
+          }
+        ))
+    end
+
+    it 'includes nested compound objects' do
+      DocumentSingleResourceObjectDecorator.new(article)
+                                           .to_json(
+                                             fields:  { articles: 'title' },
+                                             include: 'comments.author'
+                                           )
+                                           .must_equal_json(%(
+          {
+            "data": {
+              "id": "1",
+              "attributes": {
+                "title": "My Article"
+              },
+              "type": "articles"
+            },
+            "included": [
+              {
+                "type": "comments",
+                "id": "c:1",
+                "attributes": {
+                  "body": "Cool!",
+                  "good": true
+                },
+                "relationships": {
+                  "comment-author": {
+                    "data": {
+                      "type": "authors",
+                      "id": "a:2"
+                    }
+                  }
+                },
+                "included": [
+                  {
+                    "type": "authors",
+                    "id": "a:2",
+                    "attributes": {
+                      "email": "troll@trollblazer.io",
+                      "name": "Tim"
+                    }
+                  }
+                ]
+              },
+              {
+                "type": "comments",
+                "id": "c:2",
+                "attributes": {
+                  "body": "Nah",
+                  "good": false
+                },
+                "relationships": {
+                  "comment-author": {
+                    "data": null
+                  }
+                }
+              }
+            ]
+          }
+        ))
+    end
+
+    it 'includes other compound objects' do
+      DocumentSingleResourceObjectDecorator.new(article)
+                                           .to_json(
+                                             fields:  { articles: 'title' },
+                                             include: :author
+                                           )
+                                           .must_equal_json(%(
+          {
+            "data": {
+              "id": "1",
+              "attributes": {
+                "title": "My Article"
+              },
+              "type": "articles"
+            },
+            "included": [
+              {
+                "type": "authors",
+                "id": "a:1",
+                "attributes": {
+                  "email": "celsito@trb.to",
+                  "name": "Celso"
+                }
+              }
+            ]
+          }
+        ))
+    end
+
+    describe 'collection' do
+      it 'supports :includes' do
+        DocumentSingleResourceObjectDecorator.for_collection.new([article])
+                                             .to_hash(
+                                               fields:  { articles: 'title' },
+                                               include: :author
+                                             )
+                                             .must_equal Hash[{
+                                               'data'     => [
+                                                 { 'type'       => 'articles',
+                                                   'id'         => '1',
+                                                   'attributes' => { 'title'=>'My Article' } }
+                                               ],
+                                               'included' =>
+                                                             [{ 'type' => 'authors', 'id' => 'a:1', 'attributes' => { 'name' => 'Celso', 'email' => 'celsito@trb.to' } }]
+                                             }]
+      end
+
+      # include: ROAR API
+      it 'blaaaaaaa' do
+        DocumentSingleResourceObjectDecorator.for_collection.new([article])
+                                             .to_hash(
+                                               fields:  { articles: 'title', authors: [:email] },
+                                               include: :author
+                                             )
+                                             .must_equal Hash[{
+                                               'data'     => [
+                                                 { 'type'       => 'articles',
+                                                   'id'         => '1',
+                                                   'attributes' => { 'title'=>'My Article' } }
+                                               ],
+                                               'included' =>
+                                                             [{ 'type' => 'authors', 'id' => 'a:1', 'attributes' => { 'email'=>'celsito@trb.to' } }]
+                                             }]
+      end
+    end
+  end
+
+  describe 'Collection Resources With Options' do
+    class CollectionResourceObjectDecorator < Roar::Decorator
+      include Roar::JSON::JSONAPI.resource :articles
+
+      attributes do
+        property :title
+        property :summary
+      end
+    end
+
+    let(:document) {
+      %({
+        "data": [
+          {
+            "id": "1",
+            "attributes": {
+              "title": "My Article"
+            },
+            "type": "articles"
+          },
+          {
+            "id": "2",
+            "attributes": {
+              "title": "My Other Article"
+            },
+            "type": "articles"
+          }
+        ]
+      })
+    }
+
+    it do
+      CollectionResourceObjectDecorator.for_collection.new([
+                                                             Article.new(1, 'My Article', 'An interesting read.'),
+                                                             Article.new(2, 'My Other Article', 'An interesting read.')
+                                                           ]).to_json(
+                                                             fields: { articles: :title }
+                                                           ).must_equal_json document
+    end
+  end
+end