encore 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58e8c5a2cb80f79ec4fdf6afec91a6d67dd1108c
-  data.tar.gz: f45565ef1a3ae7732237728783146b8a008d4f8e
+  metadata.gz: 663990f322867daf2d604b90b17d6f041c5efc38
+  data.tar.gz: ea1a8ac943113bad1c8f1d8134221277ce869b77
 SHA512:
-  metadata.gz: cd79df1408e83a0792e7723c47fd0d7466140492ca7f10ce36e95902c3e42b992472aa96e27021e07ed9724290ab828983055e9119f79cf7b8caf4be49e2ef79
-  data.tar.gz: 44b77c571699964d6b3c0b5b6593d660a9e62eac44bc2d9de8e3be72315a57a7fb264a39fd83fc94151171493e53d06be94271241254049c8a5cc68e85441a7a
+  metadata.gz: 3ec3e4388cc983e2de0d9c418998d9840db145c4bd89103a087272a2d4429a7661087849d2d1ded571b7c1d8b43a817f6b7fa830070b9abbb03fc74d6f454ac2
+  data.tar.gz: 69b5beb8f26e43a18fead232548f9681a292e49887eb36882a0a2d018b716d8ce59126fb9155313c152f80c01c2af91484b1ee0e6538ee8db2708d4f08da985c

data/.gitignore

@@ -1 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
 Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/README.md

@@ -3,13 +3,16 @@
     <img src="http://i.imgur.com/erXBozp.png" alt="Encore" />
   </a>
   <br />
-  Encore provides serializers and persisters to build <a href="http://jsonapi.org">JSON API</a>-compliant Web services with Ruby on Rails.
+  Encore provides serializers and persisters to build <a href="http://jsonapi.org">JSON API</a>-compliant<br /> Web services with Ruby on Rails.
   <br /><br />
+  <a href="https://rubygems.org/gems/encore"><img src="http://img.shields.io/gem/v/encore.svg" /></a>
+  <a href="https://travis-ci.org/mirego/encore"><img src="http://img.shields.io/travis/mirego/encore.svg" /></a>
+  <a href="https://codeclimate.com/github/mirego/encore"><img src="http://img.shields.io/codeclimate/github/mirego/encore.svg" /></a>
 </p>
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application’s Gemfile:
 
 ```ruby
 gem 'encore'
@@ -29,21 +32,21 @@ $ gem install encore
 
 ## Disclaimer
 
-Encore is under heavy development at the moment, do not use this gem in production unless you know exactly what you're doing. **Breaking changes** are still being committed.
+As Encore is under heavy development at the moment, we advise against using this gem in production unless you know exactly what you’re doing. *Breaking changes* are still being committed.
 
 ## Basic serializer usage
 
 ### Configure your serializer
 
 ```ruby
-class CommentSerializer < Encore::Serializer::Base
+class PostSerializer < Encore::Serializer::Base
   attributes :id, :body, :links
 
   # By default, root_key will be the pluralized model
   # name. If you want to set a custom root_key, you can
   # do that:
   def self.root_key
-    :user_comments
+    :blog_posts
   end
 end
 ```
@@ -53,17 +56,17 @@ The `links` attribute is generated by Encore and will return the included associ
 ### Returning serialized model
 
 ```ruby
-class CommentsController < ApplicationController
-  before_action :fetch_comments, only: %i(index)
+class PostsController < ApplicationController
+  before_action :fetch_posts, only: %i(index)
 
   def index
-    render json: Encore::Serializer::Instance.new(@comments)
+    render json: Encore::Serializer::Instance.new(@posts)
   end
 
 protected
 
-  def fetch_comments
-    @comments = Comment.all
+  def fetch_posts
+    @posts = Post.all
   end
 end
 ```
@@ -72,17 +75,26 @@ Will result in the following JSON output:
 
 ```json
 {
-  "comments": [
+  "posts": [
     {
       "id": "1",
-      "body": "First!",
-      "links": {}
+      "body": "I enjoy having breakfast in bed. I like waking up to the smell of bacon.",
+      "links": {
+        "author": {
+          "href": "/authors/1",
+          "id": "1",
+          "type": "authors"
+        },
+        "comments": {
+          "href": "/comments?post_id=1",
+          "type": "comments"
+        }
+      }
     }
   ],
-  "links": {},
   "linked": {},
   "meta": {
-    "comments": {
+    "posts": {
       "page": 1,
       "count": 1,
       "page_count": 1,
@@ -94,48 +106,47 @@ Will result in the following JSON output:
 
 ### Inclusion
 
-Encore can handle model associations. For example, let's include the `author` in the code sample above.
+Encore can handle model associations. For example, let’s include the `comments` in the code sample above.
 
 ```ruby
-Encore::Serializer::Instance.new(@comments, include: 'author')
+Encore::Serializer::Instance.new(@posts, include: 'comments')
 ```
 
-Since we don't want all associations to be exposed, we also need to allow the serializer to include the association. To do so, we need to update the `CommentSerializer`.
+Since we don’t want all associations to be exposed, we also need to allow the serializer to include the association. To do so, we need to update the `CommentSerializer`.
 
 ```ruby
-class CommentSerializer < Encore::Serializer::Base
+class PostSerializer < Encore::Serializer::Base
   # ...
 
   def self.can_include
-    [:author]
+    [:author, :comments]
   end
 end
 ```
 
-This will result in the following JSON output:
+Requesting `GET /posts?include=comments` will result in the following JSON output:
 
 ```json
 {
-  "comments": [
+  "posts": [
     {
       "id": "1",
       "body": "First!",
       "links": {
-        "author": "1"
+        "comments": ["1"],
+        "author": {
+          "href": "/authors/1",
+          "id": 1,
+          "type": "authors"
+        }
       }
     }
   ],
-  "links": {
-    "comments.author": {
-      "href": "/authors?ids={author.id}",
-      "type": "user"
-    }
-  },
   "linked": {
-    "authors": [
+    "comments": [
       {
         "id": "1",
-        "name": "John Doe"
+        "title": "FIRST!"
       }
     ]
   },
@@ -150,22 +161,18 @@ This will result in the following JSON output:
   }
 ```
 
-If you want the `author` the **always** be included when you request a `comment`, update the `CommentSerializer` this way:
+If you want the `comments` to **always** be included when you request a `post`, update the `PostSerializer` this way:
 
 ```ruby
-class CommentSerializer < Encore::Serializer::Base
-  attributes :id, :body, :links
+class PostSerializer < Encore::Serializer::Base
+  # ...
 
   def self.always_include
-    [:author]
+    [:comments]
   end
 end
 ```
 
-### Pagination
-
-Lot more work to do here :)
-
 ## License
 
 `Encore` is © 2013-2014 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/encore/blob/master/LICENSE.md) file.
@@ -174,6 +181,6 @@ The hazelnut logo is based on [this lovely icon](http://thenounproject.com/term/
 
 ## About Mirego
 
-[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
+[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
 
 We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.

data/lib/encore/serializer/base.rb

@@ -3,6 +3,8 @@ require 'encore/serializer/links_reflection_includer'
 module Encore
   module Serializer
     class Base < ::ActiveModel::Serializer
+      attributes :links
+
       def id
         object.id.to_s
       end

data/lib/encore/serializer/instance.rb

@@ -25,7 +25,7 @@ module Encore
 
         # Build final output
         output = MainResourceManager.add(@collection, serializer)
-        output.merge! linked: LinkedResourceManager.add(linked_ids)
+        output.merge! linked: LinkedResourceManager.add(linked_ids, @collection)
         output.merge! meta: MetaManager.add(@collection, serializer, @options)
 
         output

data/lib/encore/serializer/linked_resource_manager.rb

@@ -5,12 +5,22 @@ module Encore
     module LinkedResourceManager
       extend ActiveSupport::Concern
 
-      def self.add(linked_ids)
+      def self.add(linked_ids, object)
+        included_models = linked_ids.keys.map { |key| key.downcase }
+        included_models << object.klass.name.downcase
+        included_models << object.klass.name.downcase.pluralize
+
         linked_ids.reduce({}) do |memo, (model, ids)|
           klass = model.constantize
           serializer = Utils.fetch_serializer(klass)
 
           collection = klass.where(id: ids.to_a)
+          available_includes = klass.reflections.map do |key, _|
+            next unless included_models.include?(key.to_s)
+            key
+          end.compact
+
+          collection = collection.includes(available_includes) unless available_includes.empty?
           memo.merge! MainResourceManager.add(collection, serializer)
         end
       end

data/lib/encore/version.rb

@@ -1,3 +1,3 @@
 module Encore
-  VERSION = '0.1'
+  VERSION = '0.2'
 end

data/spec/encore/serializer/linked/always_include_resources_spec.rb

@@ -64,7 +64,7 @@ describe Encore::Serializer do
       end
     end
 
-    it { expect(serialized[:linked][:projects]).to eq([{ name: project1.name }, { name: project2.name }]) }
+    it { expect(serialized[:linked][:projects]).to eq([{ name: project1.name, links: {} }, { name: project2.name, links: {} }]) }
   end
 
   context 'with and no include' do
@@ -80,6 +80,6 @@ describe Encore::Serializer do
       end
     end
 
-    it { expect(serialized[:linked][:projects]).to eq([{ name: project1.name }, { name: project2.name }]) }
+    it { expect(serialized[:linked][:projects]).to eq([{ name: project1.name, links: {} }, { name: project2.name, links: {} }]) }
   end
 end

data/spec/encore/serializer/linked/can_include_resources_spec.rb

@@ -64,6 +64,6 @@ describe Encore::Serializer do
       end
     end
 
-    it { expect(serialized[:linked][:projects]).to eq([{ name: project1.name }, { name: project2.name }]) }
+    it { expect(serialized[:linked][:projects]).to eq([{ name: project1.name, links: {} }, { name: project2.name, links: {} }]) }
   end
 end

data/spec/encore/serializer/linked/linked_resources_spec.rb

@@ -62,7 +62,7 @@ describe Encore::Serializer do
 
     let(:include) { 'project' }
 
-    it { expect(serialized[:linked][:projects]).to eq([{ name: project1.name }, { name: project2.name }]) }
+    it { expect(serialized[:linked][:projects]).to eq([{ name: project1.name, links: {} }, { name: project2.name, links: {} }]) }
   end
 
   context 'has_many include' do
@@ -81,7 +81,7 @@ describe Encore::Serializer do
 
     let(:include) { 'users' }
 
-    it { expect(serialized[:linked][:users]).to eq([{ name: 'Allan' }, { name: 'Doe' }, { name: 'Ding' }, { name: 'Bob' }]) }
+    it { expect(serialized[:linked][:users]).to eq([{ name: 'Allan', links: {} }, { name: 'Doe', links: {} }, { name: 'Ding', links: {} }, { name: 'Bob', links: {} }]) }
   end
 
   context 'has_one include' do
@@ -98,6 +98,6 @@ describe Encore::Serializer do
 
     let(:include) { 'user' }
 
-    it { expect(serialized[:linked][:users]).to eq([{ name: 'Allan' }, { name: 'Doe' }]) }
+    it { expect(serialized[:linked][:users]).to eq([{ name: 'Allan', links: {} }, { name: 'Doe', links: {} }]) }
   end
 end

data/spec/encore/serializer/linked/links_includes/links_includes_has_many_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Encore::Serializer do
+  let(:serializer) { Encore::Serializer::Instance }
+  let(:serialized) { serializer.new(objects, page: page, include: include).as_json }
+
+  let(:page) { 1 }
+
+  before do
+    run_migrations!
+    spawn_objects!
+    spawn_serializer!
+    create_records!
+  end
+
+  let(:run_migrations!) do
+    run_migration do
+      create_table(:organizations, force: true) do |t|
+        t.string :name
+      end
+      create_table(:users, force: true) do |t|
+        t.string :name
+        t.integer :project_id
+      end
+      create_table(:projects, force: true) do |t|
+        t.string :name
+        t.integer :organization_id
+      end
+    end
+  end
+
+  let(:spawn_serializer!) do
+    spawn_serializer('ProjectSerializer') do
+      attributes :name
+
+      def can_include
+        %i(organization user users)
+      end
+    end
+    spawn_serializer('UserSerializer') do
+      attributes :name
+
+      def can_include
+        %i(project)
+      end
+    end
+    spawn_serializer('OrganizationSerializer') do
+      attributes :name
+
+      def can_include
+        %i(projects)
+      end
+    end
+  end
+
+  let(:include) { 'project' }
+
+  let(:objects) { User.all }
+  let(:spawn_objects!) do
+    spawn_model('User') { belongs_to :project }
+    spawn_model('Project') do
+      belongs_to :organization
+      has_many :users
+    end
+    spawn_model('Organization') { has_many :projects }
+  end
+
+  let(:org1) { Organization.create name: 'Awesome org' }
+  let(:org2) { Organization.create name: 'Medium awesome org' }
+  let(:project1) { Project.create name: 'Awesome project', organization: org1 }
+  let(:project2) { Project.create name: 'Medium awesome project', organization: org2 }
+  let(:user1) { User.create name: 'Alice', project: project1 }
+  let(:user2) { User.create name: 'Bob', project: project2 }
+  let(:create_records!) do
+    user1
+    user2
+  end
+
+  context 'already included resource' do
+    it { expect(serialized[:linked][:projects][0][:links][:users]).to eq([user1.id.to_s]) }
+    it { expect(serialized[:linked][:projects][1][:links][:users]).to eq([user2.id.to_s]) }
+  end
+
+  context 'not included resource' do
+    it { expect(serialized[:linked][:projects][0][:links][:organization][:id]).to eq(org1.id.to_s) }
+    it { expect(serialized[:linked][:projects][1][:links][:organization][:id]).to eq(org2.id.to_s) }
+  end
+end

data/spec/encore/serializer/linked/links_includes/links_includes_has_one_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Encore::Serializer do
+  let(:serializer) { Encore::Serializer::Instance }
+  let(:serialized) { serializer.new(objects, page: page, include: include).as_json }
+
+  let(:page) { 1 }
+
+  before do
+    run_migrations!
+    spawn_objects!
+    spawn_serializer!
+    create_records!
+  end
+
+  let(:run_migrations!) do
+    run_migration do
+      create_table(:organizations, force: true) do |t|
+        t.string :name
+      end
+      create_table(:users, force: true) do |t|
+        t.string :name
+        t.integer :project_id
+      end
+      create_table(:projects, force: true) do |t|
+        t.string :name
+        t.integer :organization_id
+      end
+    end
+  end
+
+  let(:spawn_serializer!) do
+    spawn_serializer('ProjectSerializer') do
+      attributes :name
+
+      def can_include
+        %i(organization user users)
+      end
+    end
+    spawn_serializer('UserSerializer') do
+      attributes :name
+
+      def can_include
+        %i(project)
+      end
+    end
+    spawn_serializer('OrganizationSerializer') do
+      attributes :name
+
+      def can_include
+        %i(projects)
+      end
+    end
+  end
+
+  let(:include) { 'project' }
+
+  let(:objects) { User.all }
+  let(:spawn_objects!) do
+    spawn_model('User') { belongs_to :project }
+    spawn_model('Project') do
+      belongs_to :organization
+      has_one :user
+    end
+    spawn_model('Organization') { has_many :projects }
+  end
+
+  let(:org1) { Organization.create name: 'Awesome org' }
+  let(:org2) { Organization.create name: 'Medium awesome org' }
+  let(:project1) { Project.create name: 'Awesome project', organization: org1 }
+  let(:project2) { Project.create name: 'Medium awesome project', organization: org2 }
+  let(:user1) { User.create name: 'Alice', project: project1 }
+  let(:user2) { User.create name: 'Bob', project: project2 }
+  let(:create_records!) do
+    user1
+    user2
+  end
+
+  context 'already included resource' do
+    it { expect(serialized[:linked][:projects][0][:links][:user]).to eq(user1.id.to_s) }
+    it { expect(serialized[:linked][:projects][1][:links][:user]).to eq(user2.id.to_s) }
+  end
+
+  context 'not included resource' do
+    it { expect(serialized[:linked][:projects][0][:links][:organization][:id]).to eq(org1.id.to_s) }
+    it { expect(serialized[:linked][:projects][1][:links][:organization][:id]).to eq(org2.id.to_s) }
+  end
+end

data/spec/encore/serializer/main_resource_spec.rb

@@ -33,5 +33,5 @@ describe Encore::Serializer do
   end
 
   it { expect(serialized[:users].count).to eq(2) }
-  it { expect(serialized[:users]).to eq([{ name: 'Allan' }, { name: 'Doe' }]) }
+  it { expect(serialized[:users]).to eq([{ name: 'Allan', links: {} }, { name: 'Doe', links: {} }]) }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: encore
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Simon Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -207,6 +207,8 @@ files:
 - spec/encore/serializer/linked/always_include_resources_spec.rb
 - spec/encore/serializer/linked/can_include_resources_spec.rb
 - spec/encore/serializer/linked/linked_resources_spec.rb
+- spec/encore/serializer/linked/links_includes/links_includes_has_many_spec.rb
+- spec/encore/serializer/linked/links_includes/links_includes_has_one_spec.rb
 - spec/encore/serializer/links_resource_spec.rb
 - spec/encore/serializer/main_meta_spec.rb
 - spec/encore/serializer/main_resource_spec.rb