Merge pull request #237 from cerebris/includes

Rework includes logic to JSON API 1.0

Author: dgeb

lib/jsonapi/acts_as_resource_controller.rb

@@ -137,7 +137,6 @@ def create_response_document(operation_results)
         operation_results,
         {
           primary_resource_klass: resource_klass,
-          include: @request ? @request.include : nil,
           include_directives: @request ? @request.include_directives : nil,
           fields: @request ? @request.fields : nil,
           base_url: base_url,

lib/jsonapi/include_directives.rb

@@ -2,7 +2,7 @@ module JSONAPI
   class IncludeDirectives
 
     # Construct an IncludeDirectives Hash from an array of dot separated include strings.
-    # For example [:posts, 'posts.comments', 'posts.comments.tags']
+    # For example ['posts.comments.tags']
     # will transform into =>
     # {
     #   :posts=>{
@@ -55,13 +55,12 @@ def get_includes(directive)
 
     def parse_include(include)
       parts = include.split('.')
-        local_path = ''
-      parts.each_with_index do |part, index|
-        local_path += local_path.length > 0 ? ".#{part}" : part
+      local_path = ''
+
+      parts.each do |name|
+        local_path += local_path.length > 0 ? ".#{name}" : name
         related = get_related(local_path)
-        if index == parts.length - 1
-          related[:include] = true
-        end
+        related[:include] = true
       end
     end
   end

lib/jsonapi/request.rb

@@ -13,7 +13,6 @@ def initialize(params = nil, options = {})
       @errors = []
       @operations = []
       @fields = {}
-      @include = []
       @filters = {}
       @sort_criteria = [{field: 'id', direction: :asc}]
       @source_klass = nil
@@ -199,13 +198,13 @@ def parse_include_directives(include)
       included_resources = CSV.parse_line(include)
       return if included_resources.nil?
 
-      @include = []
+      include = []
       included_resources.each do |included_resource|
         check_include(@resource_klass, included_resource.partition('.'))
-        @include.push(unformat_key(included_resource).to_s)
+        include.push(unformat_key(included_resource).to_s)
       end
 
-      @include_directives = JSONAPI::IncludeDirectives.new(@include)
+      @include_directives = JSONAPI::IncludeDirectives.new(include)
     end
 
     def parse_filters(filters)

lib/jsonapi/response_document.rb

@@ -29,7 +29,6 @@ def status
     def serializer
       @serializer ||= JSONAPI::ResourceSerializer.new(
         @options.fetch(:primary_resource_klass),
-        include: @options.fetch(:include, []),
         include_directives: @options[:include_directives],
         fields: @options[:fields],
         base_url: @options.fetch(:base_url, ''),

test/controllers/controller_test.rb

@@ -1437,10 +1437,10 @@ def test_show_has_one_relationship_nil
 
 class TagsControllerTest < ActionController::TestCase
   def test_tags_index
-    get :index, {filter: {id: '6,7,8,9'}, include: 'posts,posts.tags,posts.author.posts'}
+    get :index, {filter: {id: '6,7,8,9'}, include: 'posts.tags,posts.author.posts'}
     assert_response :success
     assert_equal 4, json_response['data'].size
-    assert_equal 2, json_response['included'].size
+    assert_equal 3, json_response['included'].size
   end
 
   def test_tags_show_multiple
@@ -1450,7 +1450,7 @@ def test_tags_show_multiple
   end
 
   def test_tags_show_multiple_with_include
-    get :show, {id: '6,7,8,9', include: 'posts,posts.tags,posts.author.posts'}
+    get :show, {id: '6,7,8,9', include: 'posts.tags,posts.author.posts'}
     assert_response :bad_request
     assert_match /6,7,8,9 is not a valid value for id/, response.body
   end

test/unit/serializer/include_directives_test.rb

@@ -41,8 +41,8 @@ def test_one_level_multiple_includes
       directives)
   end
 
-  def test_two_levels_include_full
-    directives = JSONAPI::IncludeDirectives.new(['posts', 'posts.comments']).include_directives
+  def test_two_levels_include_full_path
+    directives = JSONAPI::IncludeDirectives.new(['posts.comments']).include_directives
 
     assert_hash_equals(
       {
@@ -61,14 +61,14 @@ def test_two_levels_include_full
       directives)
   end
 
-  def test_two_levels_include_lowest_only
-    directives = JSONAPI::IncludeDirectives.new(['posts.comments']).include_directives
+  def test_two_levels_include_full_path_redundant
+    directives = JSONAPI::IncludeDirectives.new(['posts','posts.comments']).include_directives
 
     assert_hash_equals(
       {
         include_related: {
           posts: {
-            include: false,
+            include: true,
             include_related:{
               comments: {
                 include: true,
@@ -82,7 +82,7 @@ def test_two_levels_include_lowest_only
   end
 
   def test_three_levels_include_full
-    directives = JSONAPI::IncludeDirectives.new(['posts', 'posts.comments', 'posts.comments.tags']).include_directives
+    directives = JSONAPI::IncludeDirectives.new(['posts.comments.tags']).include_directives
 
     assert_hash_equals(
       {
@@ -105,33 +105,4 @@ def test_three_levels_include_full
       },
       directives)
   end
-
-  def test_three_levels_skip_middle
-    directives = JSONAPI::IncludeDirectives.new(['posts', 'tags', 'posts.comments.tags']).include_directives
-
-    assert_hash_equals(
-      {
-        include_related: {
-          tags: {
-            include: true,
-            include_related:{}
-          },
-          posts: {
-            include: true,
-            include_related:{
-              comments: {
-                include: false,
-                include_related:{
-                  tags: {
-                    include: true,
-                    include_related:{}
-                  }
-                }
-              }
-            }
-          }
-        }
-      },
-      directives)
-  end
 end