simple_json_api 0.0.2

data/test/integration/render_nested_include_test.rb

@@ -0,0 +1,116 @@
+require 'test_helper'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  describe 'RenderNestedIncludeTest' do
+    it 'should match json hash for a project with nested includes specified' do
+      compare_json(actual_project, expected_project.to_json)
+      JSON.parse(actual_project).must_equal expected_project
+    end
+
+    let(:actual_project) do
+      SimpleJsonApi.render(
+        model: Project.first,
+        serializer: ProjectSerializer,
+        options: {
+          include: 'todolists'\
+                 ',todolists.todos'\
+                 ',todolists.todos.tags'\
+                 ',todolists.todos.tags.taggables',
+          fields: { projects: 'id', todolists: 'id', todos: 'id', tags: 'guid' }
+        }
+      )
+    end
+    let(:expected_project) do
+      {
+        'projects' => {
+          'id' => '100',
+          'href' => 'http://example.com/projects/100',
+          'links' => {
+            'todolist' => '200',
+            'tags' => ['10']
+          }
+        },
+        'linked' => {
+          'todolists' => [
+            {
+              'id' => '200',
+              'href' => 'http://example.com/todolists/200',
+              'links' => {
+                'todos' => ['300'],
+                'tags' => ['30']
+              }
+            }
+          ],
+          'todos' => [
+            {
+              'id' => '300',
+              'href' => 'http://example.com/todos/300',
+              'links' => {
+                'tags' => %w(10 20)
+              }
+            },
+            {
+              'id' => '330',
+              'href' => 'http://example.com/todos/330',
+              'links' => {
+                'tags' => ['10']
+              }
+            },
+            # FIXME: duplicate!!!!!
+            {
+              'id' => '300',
+              'href' => 'http://example.com/todos/300',
+              'links' => {
+                'tags' => %w(10 20)
+              }
+            }
+          ],
+          'tags' => [
+            {
+              'guid' => '10',
+              'links' => {
+                'taggables' => [
+                  %w(projects 100),
+                  %w(todos 300),
+                  %w(todos 330)
+                ]
+              }
+            },
+            {
+              'guid' => '20',
+              'links' => {
+                'taggables' => [
+                  %w(projects 110),
+                  %w(todos 300)
+                ]
+              }
+            }
+          ],
+          'projects' => [
+            {
+              'id' => '100',
+              'href' => 'http://example.com/projects/100',
+              'links' => {
+                'todolist' => '200',
+                'tags' => [
+                  '10'
+                ]
+              }
+            },
+            {
+              'id' => '110',
+              'href' => 'http://example.com/projects/110',
+              'links' => {
+                'todolist' => '210',
+                'tags' => [
+                  '20'
+                ]
+              }
+            }
+          ]
+        }
+      }
+    end
+  end
+end

data/test/integration/serializers_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  describe 'SerializersTest' do
+    it 'should have registered serializers' do
+      expected = [
+        {
+          serializer: TagSerializer,
+          resource: :tags,
+          primary_key: :guid,
+          model: Tag
+        },
+        {
+          serializer: TaggingSerializer,
+          resource: :taggings,
+          primary_key: :id
+        },
+        {
+          serializer: TodoSerializer,
+          resource: :todos,
+          primary_key: :id,
+          model: Todo
+        },
+        {
+          serializer: TodolistSerializer,
+          resource: :todolists,
+          primary_key: :id,
+          model: Todolist
+        },
+        {
+          serializer: ProjectSerializer,
+          resource: :projects,
+          model: Project,
+          primary_key: :id
+        }
+      ]
+      ResourceSerializer.registered_serializers.must_equal expected
+    end
+  end
+end

data/test/setup/data.rb

@@ -0,0 +1,24 @@
+tag1 = Tag.create(guid: 10, name: 'Urgent!')
+tag2 = Tag.create(guid: 20, name: 'On Hold')
+tag3 = Tag.create(guid: 30, name: 'Favorite')
+
+project1 = Project.create(id: 100,
+                          name: 'First Project',
+                          description: 'The first project')
+project1.tags << tag1
+project2 = Project.create(id: 110,
+                          name: 'Second Project',
+                          description: 'The second project')
+project2.tags << tag2
+
+list1 = project1.create_todolist(id: 200, description: 'Groceries')
+list1.tags << tag3
+todo1 = list1.todos.create(id: 300, action: 'Milk')
+todo1.tags << tag1
+todo1.tags << tag2
+
+list2 = project2.create_todolist(id: 210, description: 'Work')
+list2.todos.create(id: 310, action: 'Timesheet')
+list2.todos.create(id: 320, action: 'Meeting')
+todo2 = list2.todos.create(id: 330, action: 'Bread')
+todo2.tags << tag1

data/test/setup/models.rb

@@ -0,0 +1,49 @@
+# Project for testing
+class Project < ActiveRecord::Base
+  has_one :todolist
+  has_many :taggings, as: :taggable, class_name: 'Tagging'
+  has_many :tags, through: :taggings, source: :tag, class_name: 'Tag'
+end
+
+# Todolist for testing
+class Todolist < ActiveRecord::Base
+  belongs_to :project
+  has_many :todos
+  has_many :taggings, as: :taggable, class_name: 'Tagging'
+  has_many :tags, through: :taggings, source: :tag, class_name: 'Tag'
+end
+
+# To_do: misspelled so it won't be mistaken for the similarly named thing
+class Todo < ActiveRecord::Base
+  belongs_to :todolist
+  has_many :taggings, as: :taggable, class_name: 'Tagging'
+  has_many :tags, through: :taggings, source: :tag, class_name: 'Tag'
+end
+
+# Tagging for testing
+class Tagging < ActiveRecord::Base
+  belongs_to :tag
+  belongs_to :taggable, polymorphic: true
+end
+
+# Tag for testing
+class Tag < ActiveRecord::Base
+  self.primary_key = 'guid'
+  has_many :taggings
+  has_many :projects,
+           through: :taggings,
+           source: :taggable,
+           source_type: 'Project'
+  has_many :todolists,
+           through: :taggings,
+           source: :taggable,
+           source_type: 'Todolist'
+  has_many :todos,
+           through: :taggings,
+           source: :taggable,
+           source_type: 'Todo'
+
+  def taggables
+    projects + todolists + todos
+  end
+end

data/test/setup/schema.rb

@@ -0,0 +1,38 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :projects do |t|
+    t.string :name
+    t.string :description
+    t.integer :position
+    t.timestamps
+  end
+
+  create_table :todolists do |t|
+    t.string :name
+    t.string :description
+    t.references :project
+    t.timestamps
+  end
+
+  create_table :todos do |t|
+    t.string :action
+    t.string :location
+    t.text :notes
+    t.integer :duration_in_secs
+    t.integer :priority
+    t.references :todolist
+    t.timestamps
+  end
+
+  create_table :tags, id: false do |t|
+    t.primary_key :guid
+    t.string :name
+  end
+
+  create_table :taggings do |t|
+    t.references :tag
+    t.references :taggable, polymorphic: true
+    t.datetime :created_at
+  end
+end

data/test/setup/serializers.rb

@@ -0,0 +1,57 @@
+require 'simple_json_api'
+
+# TagSerializer for testing
+class TagSerializer < SimpleJsonApi::ResourceSerializer
+  serializes :tags, primary_key: :guid, model: Tag
+  attribute :guid
+  attribute :name
+
+  has_many :taggables, polymorphic: true
+end
+
+# TaggingSerializer for testing
+class TaggingSerializer < SimpleJsonApi::ResourceSerializer
+  serializes :taggings
+  attribute :id
+  belongs_to :tag
+  belongs_to :taggable, polymorphic: true
+end
+
+# TodoSerializer for testing
+class TodoSerializer < SimpleJsonApi::ResourceSerializer
+  serializes :todos, model: Todo
+  attribute :id
+  attribute :action
+  attribute :location
+  attribute :notes
+  has_many :tags
+  def href
+    "http://example.com/todos/#{_object.id}"
+  end
+end
+
+# TodolistSerializer for testing
+class TodolistSerializer < SimpleJsonApi::ResourceSerializer
+  serializes :todolists, model: Todolist
+  attribute :id
+  attribute :description
+  has_many :todos
+  has_many :tags
+  def href
+    "http://example.com/todolists/#{_object.id}"
+  end
+end
+
+# ProjectSerializer for testing
+class ProjectSerializer < SimpleJsonApi::ResourceSerializer
+  serializes :projects, model: Project
+  attribute :id
+  attribute :name, key: :project_name
+  attribute :description
+  attribute :position
+  has_one :todolist
+  has_many :tags
+  def href
+    "http://example.com/projects/#{_object.id}"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'bundler/setup'
+
+require 'simplecov'
+if ENV['COVERAGE']
+  SimpleCov.start do
+    add_filter '/test/'
+  end
+  SimpleCov.minimum_coverage 95
+end
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+Minitest::Reporters.use!(
+  # Minitest::Reporters::DefaultReporter.new(color: true)
+  Minitest::Reporters::SpecReporter.new
+)
+
+require 'ap'
+require 'simple_json_api'
+require 'test_setup'
+require 'diffy'
+
+# Helper to highlight diffs between two json strings
+#   compare_json(actual_projects, expected_projects.to_json)
+def compare_json(actual_json, expected_json)
+  actual_pretty = JSON.pretty_generate(JSON.parse(actual_json))
+  expected_pretty = JSON.pretty_generate(JSON.parse(expected_json))
+  diff =  Diffy::Diff.new(actual_pretty, expected_pretty)
+  puts "\n#{diff}\n" unless diff.to_s.empty?
+end

data/test/test_setup.rb

@@ -0,0 +1,19 @@
+require 'rails'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3', database: ':memory:'
+)
+load File.dirname(__FILE__) + '/setup/schema.rb'
+
+# dump the actual schema
+# require 'active_record/schema_dumper'
+# filename = File.join('test', 'tmp', 'schema.rb')
+# File.open(filename, 'w:utf-8') do |file|
+#   ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+# end
+
+require 'setup/models'
+require 'setup/serializers'
+
+load File.dirname(__FILE__) + '/setup/data.rb'

data/test/tmp/schema.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 0) do
+
+  create_table "projects", force: true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "taggings", force: true do |t|
+    t.integer  "tag_id"
+    t.integer  "taggable_id"
+    t.string   "taggable_type"
+    t.datetime "created_at"
+  end
+
+  create_table "tags", force: true do |t|
+    t.string "name"
+  end
+
+  create_table "todolists", force: true do |t|
+    t.string   "description"
+    t.integer  "project_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "todos", force: true do |t|
+    t.string   "action"
+    t.integer  "todolist_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/test/unit/association_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  describe 'AssociationTest' do
+    it 'should create an Association object' do
+      association = SimpleJsonApi::Association.new(
+        'project', :has_one, ProjectSerializer
+      )
+      association.name.must_equal 'project'
+      association.type.must_equal :has_one
+      association.serializer.must_equal ProjectSerializer
+      association.key.must_equal :project
+      refute association.polymorphic
+    end
+
+    it 'should create an Association for a polymorphic object' do
+      association = SimpleJsonApi::Association.new(
+        'project', :has_many, ProjectSerializer, true
+      )
+      association.name.must_equal 'project'
+      association.type.must_equal :has_many
+      association.serializer.must_equal ProjectSerializer
+      association.key.must_equal :projects
+      assert association.polymorphic
+    end
+  end
+end