Merge pull request #773 from sweatypitts/master

Make json api adapter 'include' option accept an array

README.md

@@ -189,6 +189,8 @@ resources in the `"linked"` member when the resource names are included in the
 `include` option.
 
 ```ruby
+  render @posts, include: ['authors', 'comments']
+  # or
   render @posts, include: 'authors,comments'
 ```
 

lib/active_model/serializer/adapter/json_api.rb

@@ -121,7 +121,9 @@ module ActiveModel
         end
 
         def check_assoc(assoc)
-          @options[:include].split(',').any? do |s|
+          include_opt = @options[:include]
+          include_opt = include_opt.split(',') if include_opt.is_a?(String)
+          include_opt.any? do |s|
             s.match(/^#{assoc.gsub('.', '\.')}/)
           end
         end

test/action_controller/json_api_linked_test.rb

@@ -52,7 +52,7 @@ module ActionController
 
         def render_resource_with_nested_has_many_include
           setup_post
-          render json: @post, include: 'author,author.roles', adapter: :json_api
+          render json: @post, include: ['author', 'author.roles'], adapter: :json_api
         end
 
         def render_resource_with_missing_nested_has_many_include
@@ -74,7 +74,7 @@ module ActionController
 
         def render_collection_with_include
           setup_post
-          render json: [@post], include: 'author,comments', adapter: :json_api
+          render json: [@post], include: ['author', 'comments'], adapter: :json_api
         end
       end
 

test/adapter/json_api/belongs_to_test.rb

@@ -89,7 +89,7 @@ module ActiveModel
 
           def test_include_linked_resources_with_type_name
             serializer = BlogSerializer.new(@blog)
-            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer, include: "writer,articles")
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer, include: ['writer', 'articles'])
             linked = adapter.serializable_hash[:linked]
             expected = {
               authors: [{

test/adapter/json_api/has_many_explicit_serializer_test.rb

@@ -24,7 +24,7 @@ module ActiveModel
             @serializer = PostPreviewSerializer.new(@post)
             @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
               @serializer,
-              include: 'comments,author'
+              include: ['comments', 'author']
             )
           end
 

test/adapter/json_api/linked_test.rb

@@ -14,14 +14,21 @@ module ActiveModel
             @second_post = Post.new(id: 20, title: 'New Post', body: 'Body')
             @third_post = Post.new(id: 30, title: 'Yet Another Post', body: 'Body')
             @blog = Blog.new({ name: 'AMS Blog' })
+            @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+            @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
             @first_post.blog = @blog
             @second_post.blog = @blog
             @third_post.blog = nil
-            @first_post.comments = []
+            @first_post.comments = [@first_comment, @second_comment]
             @second_post.comments = []
+            @third_post.comments = []
             @first_post.author = @author1
             @second_post.author = @author2
             @third_post.author = @author1
+            @first_comment.post = @first_post
+            @first_comment.author = nil
+            @second_comment.post = @first_post
+            @second_comment.author = nil
             @author1.posts = [@first_post, @third_post]
             @author1.bio = @bio1
             @author1.roles = []
@@ -33,43 +40,41 @@ module ActiveModel
           end
 
           def test_include_multiple_posts_and_linked
-            @serializer = ArraySerializer.new([@first_post, @second_post])
+            serializer = ArraySerializer.new([@first_post, @second_post])
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'author,author.bio,comments')
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
-
+              serializer,
-            @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+              include: ['author', 'author.bio', 'comments']
-            @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+            )
-            @first_post.comments = [@first_comment, @second_comment]
+            alt_adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
-            @first_comment.post = @first_post
+              serializer,
-            @first_comment.author = nil
+              include: 'author,author.bio,comments'
-            @second_comment.post = @first_post
+            )
-            @second_comment.author = nil
-            assert_equal([
-                           { title: "Hello!!", body: "Hello, world!!", id: "10", links: { comments: ['1', '2'], blog: "999", author: "1" } },
-                           { title: "New Post", body: "Body", id: "20", links: { comments: [], blog: "999", author: "2" } }
-                         ], @adapter.serializable_hash[:posts])
-
 
             expected = {
-              comments: [{
+              linked: {
+                comments: [
+                  {
                     id: "1",
                     body: "ZOMG A COMMENT",
                     links: {
-                  post: "10",
+                      post: "1",
                       author: nil
                     }
                   }, {
                     id: "2",
                     body: "ZOMG ANOTHER COMMENT",
                     links: {
-                  post: "10",
+                      post: "1",
                       author: nil
                     }
-              }],
+                  }
-              authors: [{
+                ],
+                authors: [
+                  {
                     id: "1",
                     name: "Steve K.",
                     links: {
-                  posts: ["10", "30"],
+                      posts: ["1", "3"],
                       roles: [],
                       bio: "1"
                     }
@@ -77,12 +82,14 @@ module ActiveModel
                     id: "2",
                     name: "Tenderlove",
                     links: {
-                  posts: ["20"],
+                      posts: ["2"],
                       roles: [],
                       bio: "2"
                     }
-              }],
+                  }
-              bios: [{
+                ],
+                bios: [
+                  {
                     id: "1",
                     content: "AMS Contributor",
                     links: {
@@ -94,26 +101,50 @@ module ActiveModel
                     links: {
                       author: "2"
                     }
-              }]
                   }
-            assert_equal expected, @adapter.serializable_hash[:linked]
+                ]
+              },
+              posts: [
+                {
+                  id: "10",
+                  title: "Hello!!",
+                  body: "Hello, world!!",
+                  links: {
+                    comments: ['1', '2'],
+                    blog: "999",
+                    author: "1"
+                  }
+                },
+                {
+                  id: "2",
+                  title: "New Post",
+                  body: "Body",
+                  links: {
+                    comments: [],
+                    blog: "999",
+                    author: "2"
+                  }
+                }
+              ]
+            }
+            assert_equal expected, adapter.serializable_hash
+            assert_equal expected, alt_adapter.serializable_hash
           end
 
-          def test_include_bio_and_linked
+          def test_include_multiple_posts_and_linked
-            @serializer = BioSerializer.new(@bio1)
+            serializer = BioSerializer.new @bio1
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'author,author.posts')
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
-
+              serializer,
-            @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+              include: ['author', 'author.posts']
-            @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+            )
-            @first_post.comments = [@first_comment, @second_comment]
+            alt_adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
-            @third_post.comments = []
+              serializer,
-            @first_comment.post = @first_post
+              include: 'author,author.posts'
-            @first_comment.author = nil
+            )
-            @second_comment.post = @first_post
-            @second_comment.author = nil
 
             expected = {
-              authors: [{
+              authors: [
+                {
                   id: "1",
                   name: "Steve K.",
                   links: {
@@ -121,28 +152,32 @@ module ActiveModel
                     roles: [],
                     bio: "1"
                   }
-              }],
+                }
-              posts: [{
+              ],
+              posts: [
+                {
+                  id: "10",
                   title: "Hello!!",
                   body: "Hello, world!!",
-                id: "10",
                   links: {
                     comments: ["1", "2"],
                     blog: "999",
                     author: "1"
                   }
                 }, {
+                  id: "30",
                   title: "Yet Another Post",
                   body: "Body",
-                id: "30",
                   links: {
                     comments: [],
                     blog: nil,
                     author: "1"
                   }
-              }]
                 }
-            assert_equal expected, @adapter.serializable_hash[:linked]
+              ]
+            }
+            assert_equal expected, adapter.serializable_hash[:linked]
+            assert_equal expected, alt_adapter.serializable_hash[:linked]
           end
 
           def test_ignore_model_namespace_for_linked_resource_type