Adding specs for Include module

Author: guillaumebriday

test/dummy/app/models/contact.rb

@@ -4,6 +4,8 @@ class Contact < ApplicationRecord
   include Jsonapi::Filter
   include Jsonapi::Sort
 
+  has_many :users
+
   # Sorting
   sortable_fields :last_name
   default_sort last_name: :desc

test/dummy/app/models/post.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class Post < ApplicationRecord
+  belongs_to :user
+  has_one :contact, through: :user
+end

test/dummy/app/models/user.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class User < ApplicationRecord
+  include Jsonapi::Include
+
+  belongs_to :contact
+  has_many :posts
+
+  allowed_includes 'contact', 'posts.contact.users', 'posts', 'posts.user'
+end

test/dummy/db/migrate/20190916201953_create_users.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateUsers < ActiveRecord::Migration[5.2]
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.references :contact
+
+      t.timestamps
+    end
+  end
+end

test/dummy/db/schema.rb

@@ -12,12 +12,28 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20_190_511_203_334) do
+ActiveRecord::Schema.define(version: 20_190_916_202_107) do
   create_table 'contacts', force: :cascade do |t|
     t.string 'last_name'
     t.string 'first_name'
     t.integer 'age'
     t.datetime 'created_at', null: false
     t.datetime 'updated_at', null: false
   end
+
+  create_table 'posts', force: :cascade do |t|
+    t.string 'title'
+    t.integer 'user_id'
+    t.datetime 'created_at', null: false
+    t.datetime 'updated_at', null: false
+    t.index ['user_id'], name: 'index_posts_on_user_id'
+  end
+
+  create_table 'users', force: :cascade do |t|
+    t.string 'name'
+    t.integer 'contact_id'
+    t.datetime 'created_at', null: false
+    t.datetime 'updated_at', null: false
+    t.index ['contact_id'], name: 'index_users_on_contact_id'
+  end
 end

test/dummy/spec/factories/posts.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :post do
+    title { 'Anakin' }
+    user
+  end
+end

test/dummy/spec/factories/users.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    name { 'Anakin' }
+    contact
+  end
+end

test/dummy/spec/models/user_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe User, type: :model do
+  describe 'instances_method' do
+    it 'responds to apply_sort' do
+      expect(User).to respond_to(:apply_include)
+    end
+
+    it 'responds to allowed_includes' do
+      expect(User).to respond_to(:allowed_includes)
+    end
+  end
+
+  describe '#apply_include' do
+    let!(:contact) { create(:contact) }
+    let!(:user) { create(:user, contact: contact) }
+    let!(:posts) { create_list(:post, 3, user: user) }
+
+    context 'with valid params' do
+      let(:valid_params) do
+        {
+          include: 'contact,posts'
+        }
+      end
+
+      it 'includes relationships' do
+        users = User.apply_include(valid_params)
+        expect(users.first.association(:contact)).to be_loaded
+        expect(users.first.association(:posts)).to be_loaded
+      end
+
+      it 'includes sub relationships' do
+        valid_params = {
+          include: 'contact,posts.contact.users,posts.user'
+        }
+
+        users = User.apply_include(valid_params)
+        expect(users.first.association(:contact)).to be_loaded
+        expect(users.first.posts.first.association(:contact)).to be_loaded
+        expect(users.first.posts.first.association(:user)).to be_loaded
+        expect(users.first.posts.first.contact.association(:users)).to be_loaded
+      end
+    end
+
+    context 'with custom allowed attributes' do
+      let(:valid_params) do
+        {
+          include: 'posts.contact'
+        }
+      end
+
+      it 'raises an error' do
+        expect { User.apply_include(valid_params) }.to raise_exception(Jsonapi::InvalidAttributeError, 'posts.contact is not valid as include attribute.')
+      end
+
+      it 'includes sub relationships' do
+        users = User.apply_include(valid_params, allowed: 'posts.contact')
+        expect(users.first.posts.first.association(:contact)).to be_loaded
+      end
+    end
+
+    context 'with invalid params' do
+      let(:invalid_params) do
+        {
+          include: 'invalid'
+        }
+      end
+
+      it 'raises an exception' do
+        expect { User.apply_include(invalid_params) }.to raise_exception(Jsonapi::InvalidAttributeError, 'invalid is not valid as include attribute.')
+      end
+    end
+
+    context 'with empty params' do
+      let(:empty_params) do
+        {
+          include: ''
+        }
+      end
+
+      it 'returns same collection' do
+        expect(User.apply_include(empty_params).first).to eq(User.first)
+      end
+    end
+  end
+
+  describe '#convert_includes_as_hash' do
+    it 'returns the correct hash' do
+      expect(User.send(:convert_includes_as_hash, 'contact')).to eq(contact: {})
+      expect(User.send(:convert_includes_as_hash, 'contact,posts')).to eq(contact: {}, posts: {})
+      expect(User.send(:convert_includes_as_hash, 'contact,posts.user')).to eq(contact: {}, posts: { user: {} })
+      expect(User.send(:convert_includes_as_hash, 'contact,posts.user,posts.contact')).to eq(contact: {}, posts: { user: {}, contact: {} })
+      expect(User.send(:convert_includes_as_hash, 'contact,posts.user,posts.contact.users')).to eq(contact: {}, posts: { user: {}, contact: { users: {} } })
+      expect(User.send(:convert_includes_as_hash, 'contact,posts.user,posts.contact.users,contact.users')).to eq(contact: { users: {} }, posts: { user: {}, contact: { users: {} } })
+      expect(User.send(:convert_includes_as_hash, 'contact,posts.user,posts.contact,posts.user.contacts')).to eq(contact: {}, posts: { user: { contacts: {} }, contact: {} })
+      expect(User.send(:convert_includes_as_hash, '')).to eq({})
+    end
+  end
+end