Translate dasherized include keys to underscored in JSON API adapter

Author: Chris Peters

lib/active_model/serializer/include_tree.rb

@@ -18,7 +18,7 @@ module Parsing
         # @return [Hash] a Hash representing the same tree structure
         def include_string_to_hash(included)
           # TODO: Needs comment walking through the process of what all this is doing.
-          included.delete(' ').split(',').reduce({}) do |hash, path|
+          included.gsub('-', '_').delete(' ').split(',').reduce({}) do |hash, path|
             include_tree = path.split('.').reverse_each.reduce({}) { |a, e| { e.to_sym => a } }
             hash.deep_merge!(include_tree)
           end
@@ -49,6 +49,7 @@ def include_args_to_hash(included)
             { included => {} }
           when Hash
             included.each_with_object({}) do |(key, value), hash|
+              key = key.is_a?(String) ? key.gsub('-', '_').to_sym : key
               hash[key] = include_args_to_hash(value)
             end
           when Array

test/include_tree/from_include_args_test.rb

@@ -11,12 +11,20 @@ def test_simple_array
           assert(actual.key?(:comments))
         end
 
+        def test_simple_array_with_dasherized_keys
+          input = [:comments, 'related-posts']
+          actual = ActiveModel::Serializer::IncludeTree.from_include_args(input)
+          assert(actual.key?(:comments))
+          assert(actual.key?(:related_posts))
+        end
+
         def test_nested_array
-          input = [:comments, posts: [:author, comments: [:author]]]
+          input = [:comments, posts: [:author, 'related-posts', comments: [:author]]]
           actual = ActiveModel::Serializer::IncludeTree.from_include_args(input)
           assert(actual.key?(:posts))
           assert(actual[:posts].key?(:author))
           assert(actual[:posts].key?(:comments))
+          assert(actual[:posts].key?(:related_posts))
           assert(actual[:posts][:comments].key?(:author))
           assert(actual.key?(:comments))
         end

test/include_tree/from_string_test.rb

@@ -10,13 +10,26 @@ def test_single_string
           assert(actual.key?(:author))
         end
 
+        def test_single_dasherized_string
+          input = 'related-posts'
+          actual = ActiveModel::Serializer::IncludeTree.from_string(input)
+          assert(actual.key?(:related_posts))
+        end
+
         def test_multiple_strings
           input = 'author,comments'
           actual = ActiveModel::Serializer::IncludeTree.from_string(input)
           assert(actual.key?(:author))
           assert(actual.key?(:comments))
         end
 
+        def test_multiple_dasherized_strings
+          input = 'related-posts,content-templates'
+          actual = ActiveModel::Serializer::IncludeTree.from_string(input)
+          assert(actual.key?(:related_posts))
+          assert(actual.key?(:content_templates))
+        end
+
         def test_multiple_strings_with_space
           input = 'author, comments'
           actual = ActiveModel::Serializer::IncludeTree.from_string(input)
@@ -31,6 +44,13 @@ def test_nested_string
           assert(actual[:posts].key?(:author))
         end
 
+        def test_nested_hyphenated_string
+          input = 'posts.related-posts'
+          actual = ActiveModel::Serializer::IncludeTree.from_string(input)
+          assert(actual.key?(:posts))
+          assert(actual[:posts].key?(:related_posts))
+        end
+
         def test_multiple_nested_string
           input = 'posts.author,posts.comments.author,comments'
           actual = ActiveModel::Serializer::IncludeTree.from_string(input)

test/include_tree/include_args_to_hash_test.rb

@@ -47,11 +47,13 @@ def test_include_args_to_hash_from_array_of_hashes
 
           def test_array_of_string
             expected = {
-              comments: { author: {}, attachment: {} }
+              comments: { author: {}, attachment: {} },
+              posts: { related_posts: {} }
             }
             input = [
               'comments.author',
-              'comments.attachment'
+              'comments.attachment',
+              'posts.related-posts'
             ]
             actual = Parsing.include_args_to_hash(input)