diff --git a/lib/action_controller/serialization.rb b/lib/action_controller/serialization.rb index 6fcb5df7..415167ef 100644 --- a/lib/action_controller/serialization.rb +++ b/lib/action_controller/serialization.rb @@ -6,7 +6,7 @@ module ActionController include ActionController::Renderers - ADAPTER_OPTION_KEYS = [:include, :fields, :root, :adapter] + ADAPTER_OPTION_KEYS = [:include, :fields, :adapter] included do class_attribute :_serialization_scope diff --git a/lib/active_model/serializer.rb b/lib/active_model/serializer.rb index 18a44da0..1e59cc23 100644 --- a/lib/active_model/serializer.rb +++ b/lib/active_model/serializer.rb @@ -145,14 +145,6 @@ module ActiveModel adapter_class end - def self._root - @@root ||= false - end - - def self._root=(root) - @@root = root - end - def self.root_name name.demodulize.underscore.sub(/_serializer$/, '') if name end @@ -162,7 +154,7 @@ module ActiveModel def initialize(object, options = {}) @object = object @options = options - @root = options[:root] || (self.class._root ? self.class.root_name : false) + @root = options[:root] @meta = options[:meta] @meta_key = options[:meta_key] @scope = options[:scope] @@ -176,11 +168,7 @@ module ActiveModel end def json_key - if root == true || root.nil? - self.class.root_name - else - root - end + self.class.root_name end def id diff --git a/lib/active_model/serializer/adapter.rb b/lib/active_model/serializer/adapter.rb index bc658ba2..0cbab9d3 100644 --- a/lib/active_model/serializer/adapter.rb +++ b/lib/active_model/serializer/adapter.rb @@ -5,6 +5,7 @@ module ActiveModel class Adapter extend ActiveSupport::Autoload autoload :Json + autoload :FlattenJson autoload :Null autoload :JsonApi @@ -21,7 +22,8 @@ module ActiveModel def as_json(options = {}) hash = serializable_hash(options) - include_meta(hash) + include_meta(hash) unless self.class == FlattenJson + hash end def self.create(resource, options = {}) @@ -48,7 +50,7 @@ module ActiveModel yield end elsif is_fragment_cached? - FragmentCache.new(self, @cached_serializer, @options, @root).fetch + FragmentCache.new(self, @cached_serializer, @options).fetch else yield end @@ -82,11 +84,11 @@ module ActiveModel end def root - @options.fetch(:root) { serializer.json_key } + serializer.json_key.to_sym if serializer.json_key end def include_meta(json) - json[meta_key] = meta if meta && root + json[meta_key] = meta if meta json end end diff --git a/lib/active_model/serializer/adapter/flatten_json.rb b/lib/active_model/serializer/adapter/flatten_json.rb new file mode 100644 index 00000000..87b3ea8c --- /dev/null +++ b/lib/active_model/serializer/adapter/flatten_json.rb @@ -0,0 +1,12 @@ +module ActiveModel + class Serializer + class Adapter + class FlattenJson < Json + def serializable_hash(options = {}) + super + @result + end + end + end + end +end diff --git a/lib/active_model/serializer/adapter/fragment_cache.rb b/lib/active_model/serializer/adapter/fragment_cache.rb index 2b7596a4..231ddaed 100644 --- a/lib/active_model/serializer/adapter/fragment_cache.rb +++ b/lib/active_model/serializer/adapter/fragment_cache.rb @@ -5,8 +5,7 @@ module ActiveModel attr_reader :serializer - def initialize(adapter, serializer, options, root) - @root = root + def initialize(adapter, serializer, options) @options = options @adapter = adapter @serializer = serializer diff --git a/lib/active_model/serializer/adapter/json.rb b/lib/active_model/serializer/adapter/json.rb index 88c49d6c..e6dff0dd 100644 --- a/lib/active_model/serializer/adapter/json.rb +++ b/lib/active_model/serializer/adapter/json.rb @@ -6,7 +6,7 @@ module ActiveModel class Json < Adapter def serializable_hash(options = {}) if serializer.respond_to?(:each) - @result = serializer.map{|s| self.class.new(s).serializable_hash } + @result = serializer.map{|s| FlattenJson.new(s).serializable_hash } else @hash = {} @@ -37,16 +37,13 @@ module ActiveModel @result = @core.merge @hash end - if root - @result = { root => @result } - else - @result - end + { root => @result } + end + + def fragment_cache(cached_hash, non_cached_hash) + Json::FragmentCache.new().fragment_cache(cached_hash, non_cached_hash) end - end - def fragment_cache(cached_hash, non_cached_hash) - Json::FragmentCache.new().fragment_cache(cached_hash, non_cached_hash) end end end diff --git a/lib/active_model/serializer/adapter/json_api.rb b/lib/active_model/serializer/adapter/json_api.rb index 8028a075..39e6815c 100644 --- a/lib/active_model/serializer/adapter/json_api.rb +++ b/lib/active_model/serializer/adapter/json_api.rb @@ -6,7 +6,6 @@ module ActiveModel class JsonApi < Adapter def initialize(serializer, options = {}) super - serializer.root = true @hash = { data: [] } if fields = options.delete(:fields) diff --git a/lib/active_model/serializer/array_serializer.rb b/lib/active_model/serializer/array_serializer.rb index a5f7b6a1..174e16fc 100644 --- a/lib/active_model/serializer/array_serializer.rb +++ b/lib/active_model/serializer/array_serializer.rb @@ -7,9 +7,8 @@ module ActiveModel attr_reader :meta, :meta_key def initialize(objects, options = {}) - options.merge!(root: nil) - - @objects = objects.map do |object| + @resource = objects + @objects = objects.map do |object| serializer_class = options.fetch( :serializer, ActiveModel::Serializer.serializer_for(object) @@ -21,7 +20,11 @@ module ActiveModel end def json_key - @objects.first.json_key if @objects.first + if @objects.first + @objects.first.json_key.pluralize + else + @resource.name.downcase.pluralize if @resource.try(:name) + end end def root=(root) diff --git a/lib/active_model/serializer/configuration.rb b/lib/active_model/serializer/configuration.rb index ef57262c..86df706e 100644 --- a/lib/active_model/serializer/configuration.rb +++ b/lib/active_model/serializer/configuration.rb @@ -6,7 +6,7 @@ module ActiveModel included do |base| base.config.array_serializer = ActiveModel::Serializer::ArraySerializer - base.config.adapter = :json + base.config.adapter = :flatten_json end end end diff --git a/lib/active_model/serializer/fieldset.rb b/lib/active_model/serializer/fieldset.rb index a09fad18..3ff42bed 100644 --- a/lib/active_model/serializer/fieldset.rb +++ b/lib/active_model/serializer/fieldset.rb @@ -12,8 +12,8 @@ module ActiveModel end def fields_for(serializer) - key = serializer.json_key || serializer.class.root_name - fields[key.to_sym] + key = serializer.json_key + fields[key.to_sym] || fields[key.pluralize.to_sym] end private diff --git a/test/action_controller/explicit_serializer_test.rb b/test/action_controller/explicit_serializer_test.rb index d4cbdb4d..126db5c7 100644 --- a/test/action_controller/explicit_serializer_test.rb +++ b/test/action_controller/explicit_serializer_test.rb @@ -77,12 +77,10 @@ module ActionController get :render_array_using_explicit_serializer assert_equal 'application/json', @response.content_type - expected = { - 'paginated' => [ - { 'name' => 'Name 1' }, - { 'name' => 'Name 2' } - ] - } + expected = [ + { 'name' => 'Name 1' }, + { 'name' => 'Name 2' } + ] assert_equal expected.to_json, @response.body end diff --git a/test/action_controller/serialization_test.rb b/test/action_controller/serialization_test.rb index ff646a97..12a75f2d 100644 --- a/test/action_controller/serialization_test.rb +++ b/test/action_controller/serialization_test.rb @@ -10,13 +10,17 @@ module ActionController end def render_using_custom_root - @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }) - render json: @profile, root: "custom_root" + with_adapter ActiveModel::Serializer::Adapter::Json do + @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }) + render json: @profile, root: "custom_root" + end end def render_using_custom_root_and_meta - @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }) - render json: @profile, root: "custom_root", meta: { total: 10 } + with_adapter ActiveModel::Serializer::Adapter::Json do + @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }) + render json: @profile, root: "custom_root", meta: { total: 10 } + end end def render_using_default_adapter_root @@ -34,11 +38,13 @@ module ActionController end def render_array_using_custom_root_and_meta - array = [ - Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }), - Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' }) - ] - render json: array, root: "custom_root", meta: { total: 10 } + with_adapter ActiveModel::Serializer::Adapter::Json do + array = [ + Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }), + Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' }) + ] + render json: array, root: "custom_root", meta: { total: 10 } + end end def render_array_using_implicit_serializer @@ -167,20 +173,6 @@ module ActionController assert_equal expected.to_json, @response.body end - def test_render_using_custom_root - get :render_using_custom_root - - assert_equal 'application/json', @response.content_type - assert_equal '{"custom_root":{"name":"Name 1","description":"Description 1"}}', @response.body - end - - def test_render_using_custom_root_and_meta - get :render_using_custom_root_and_meta - - assert_equal 'application/json', @response.content_type - assert_equal '{"custom_root":{"name":"Name 1","description":"Description 1"},"meta":{"total":10}}', @response.body - end - def test_render_using_default_root get :render_using_default_adapter_root @@ -217,25 +209,6 @@ module ActionController assert_equal expected.to_json, @response.body end - def test_render_array_using_custom_root_and_meta - get :render_array_using_custom_root_and_meta - assert_equal 'application/json', @response.content_type - - expected = { custom_root: [ - { - name: 'Name 1', - description: 'Description 1', - }, - { - name: 'Name 2', - description: 'Description 2', - }], - meta: { total: 10 } - } - - assert_equal expected.to_json, @response.body - end - def test_render_array_using_implicit_serializer get :render_array_using_implicit_serializer assert_equal 'application/json', @response.content_type diff --git a/test/adapter/fragment_cache_test.rb b/test/adapter/fragment_cache_test.rb index 69303557..d249637a 100644 --- a/test/adapter/fragment_cache_test.rb +++ b/test/adapter/fragment_cache_test.rb @@ -8,7 +8,7 @@ module ActiveModel @role = Role.new(name: 'Great Author', description:nil) @role.author = [@author] @role_serializer = RoleSerializer.new(@role) - @role_hash = FragmentCache.new(RoleSerializer.adapter.new(@role_serializer), @role_serializer, {}, nil) + @role_hash = FragmentCache.new(RoleSerializer.adapter.new(@role_serializer), @role_serializer, {}) end def test_fragment_fetch_with_virtual_attributes diff --git a/test/adapter/json/belongs_to_test.rb b/test/adapter/json/belongs_to_test.rb index 1252fe38..1d20d1c9 100644 --- a/test/adapter/json/belongs_to_test.rb +++ b/test/adapter/json/belongs_to_test.rb @@ -25,21 +25,21 @@ module ActiveModel end def test_includes_post - assert_equal({id: 42, title: 'New Post', body: 'Body'}, @adapter.serializable_hash[:post]) + assert_equal({id: 42, title: 'New Post', body: 'Body'}, @adapter.serializable_hash[:comment][:post]) end def test_include_nil_author serializer = PostSerializer.new(@anonymous_post) adapter = ActiveModel::Serializer::Adapter::Json.new(serializer) - assert_equal({title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], blog: {id: 999, name: "Custom blog"}, author: nil}, adapter.serializable_hash) + assert_equal({post: {title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], blog: {id: 999, name: "Custom blog"}, author: nil}}, adapter.serializable_hash) end def test_include_nil_author_with_specified_serializer serializer = PostPreviewSerializer.new(@anonymous_post) adapter = ActiveModel::Serializer::Adapter::Json.new(serializer) - assert_equal({title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], author: nil}, adapter.serializable_hash) + assert_equal({posts: {title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], author: nil}}, adapter.serializable_hash) end end end diff --git a/test/adapter/json/collection_test.rb b/test/adapter/json/collection_test.rb index d91fb2b6..54bc5431 100644 --- a/test/adapter/json/collection_test.rb +++ b/test/adapter/json/collection_test.rb @@ -28,16 +28,16 @@ module ActiveModel @serializer = ArraySerializer.new([@blog], serializer: CustomBlogSerializer) @adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer) - expected = [{ + expected = {custom_blogs:[{ id: 1, special_attribute: "Special", articles: [{id: 1,title: "Hello!!", body: "Hello, world!!"}, {id: 2, title: "New Post", body: "Body"}] - }] + }]} assert_equal expected, @adapter.serializable_hash end def test_include_multiple_posts - expected = [{ + expected = { posts: [{ title: "Hello!!", body: "Hello, world!!", id: 1, @@ -63,7 +63,7 @@ module ActiveModel id: 999, name: "Custom blog" } - }] + }]} assert_equal expected, @adapter.serializable_hash end end diff --git a/test/adapter/json/has_many_test.rb b/test/adapter/json/has_many_test.rb index b73af9f5..19fe16cd 100644 --- a/test/adapter/json/has_many_test.rb +++ b/test/adapter/json/has_many_test.rb @@ -26,7 +26,7 @@ module ActiveModel assert_equal([ {id: 1, body: 'ZOMG A COMMENT'}, {id: 2, body: 'ZOMG ANOTHER COMMENT'} - ], @adapter.serializable_hash[:comments]) + ], @adapter.serializable_hash[:post][:comments]) end end end diff --git a/test/adapter/json_api/collection_test.rb b/test/adapter/json_api/collection_test.rb index f17285fa..f0d4eff1 100644 --- a/test/adapter/json_api/collection_test.rb +++ b/test/adapter/json_api/collection_test.rb @@ -86,7 +86,6 @@ module ActiveModel } } ] - assert_equal(expected, @adapter.serializable_hash[:data]) end diff --git a/test/adapter/json_test.rb b/test/adapter/json_test.rb index 52c9d8fb..efc4c834 100644 --- a/test/adapter/json_test.rb +++ b/test/adapter/json_test.rb @@ -25,7 +25,7 @@ module ActiveModel assert_equal([ {id: 1, body: 'ZOMG A COMMENT'}, {id: 2, body: 'ZOMG ANOTHER COMMENT'} - ], @adapter.serializable_hash[:comments]) + ], @adapter.serializable_hash[:post][:comments]) end end end diff --git a/test/adapter_test.rb b/test/adapter_test.rb index d76559d5..7268c386 100644 --- a/test/adapter_test.rb +++ b/test/adapter_test.rb @@ -31,7 +31,7 @@ module ActiveModel def test_create_adapter adapter = ActiveModel::Serializer::Adapter.create(@serializer) - assert_equal ActiveModel::Serializer::Adapter::Json, adapter.class + assert_equal ActiveModel::Serializer::Adapter::FlattenJson, adapter.class end def test_create_adapter_with_override diff --git a/test/serializers/adapter_for_test.rb b/test/serializers/adapter_for_test.rb index 60641080..507b6bf1 100644 --- a/test/serializers/adapter_for_test.rb +++ b/test/serializers/adapter_for_test.rb @@ -11,7 +11,7 @@ module ActiveModel def test_returns_default_adapter adapter = ActiveModel::Serializer.adapter - assert_equal ActiveModel::Serializer::Adapter::Json, adapter + assert_equal ActiveModel::Serializer::Adapter::FlattenJson, adapter end def test_overwrite_adapter_with_symbol diff --git a/test/serializers/attribute_test.rb b/test/serializers/attribute_test.rb index b75df48c..1b52216a 100644 --- a/test/serializers/attribute_test.rb +++ b/test/serializers/attribute_test.rb @@ -15,13 +15,13 @@ module ActiveModel def test_json_serializable_hash adapter = ActiveModel::Serializer::Adapter::Json.new(@blog_serializer) - assert_equal({:id=>1, :title=>"AMS Hints"}, adapter.serializable_hash) + assert_equal({alternate_blog: { id:1, title:"AMS Hints"}}, adapter.serializable_hash) end def test_attribute_inheritance_with_key inherited_klass = Class.new(AlternateBlogSerializer) blog_serializer = inherited_klass.new(@blog) - adapter = ActiveModel::Serializer::Adapter::Json.new(blog_serializer) + adapter = ActiveModel::Serializer::Adapter::FlattenJson.new(blog_serializer) assert_equal({:id=>1, :title=>"AMS Hints"}, adapter.serializable_hash) end diff --git a/test/serializers/configuration_test.rb b/test/serializers/configuration_test.rb index 9c6c5fea..e623cde9 100644 --- a/test/serializers/configuration_test.rb +++ b/test/serializers/configuration_test.rb @@ -8,7 +8,7 @@ module ActiveModel end def test_default_adapter - assert_equal :json, ActiveModel::Serializer.config.adapter + assert_equal :flatten_json, ActiveModel::Serializer.config.adapter end end end diff --git a/test/serializers/meta_test.rb b/test/serializers/meta_test.rb index 2ec90611..802049eb 100644 --- a/test/serializers/meta_test.rb +++ b/test/serializers/meta_test.rb @@ -12,9 +12,10 @@ module ActiveModel end def test_meta_is_present_with_root - adapter = load_adapter(root: "blog", meta: {total: 10}) + serializer = AlternateBlogSerializer.new(@blog, meta: {total: 10}) + adapter = ActiveModel::Serializer::Adapter::Json.new(serializer, root: 'blog') expected = { - "blog" => { + alternate_blog: { id: 1, title: "AMS Hints" }, @@ -35,9 +36,10 @@ module ActiveModel end def test_meta_key_is_used - adapter = load_adapter(root: "blog", meta: {total: 10}, meta_key: "haha_meta") + serializer = AlternateBlogSerializer.new(@blog, root: 'blog', meta: {total: 10}, meta_key: "haha_meta") + adapter = ActiveModel::Serializer::Adapter::Json.new(serializer, root: 'blog') expected = { - "blog" => { + alternate_blog: { id: 1, title: "AMS Hints" }, @@ -50,7 +52,7 @@ module ActiveModel def test_meta_is_not_present_on_arrays_without_root serializer = ArraySerializer.new([@blog], meta: {total: 10}) - adapter = ActiveModel::Serializer::Adapter::Json.new(serializer) + adapter = ActiveModel::Serializer::Adapter::FlattenJson.new(serializer) expected = [{ id: 1, name: "AMS Hints", @@ -71,7 +73,7 @@ module ActiveModel serializer = ArraySerializer.new([@blog], meta: {total: 10}, meta_key: "haha_meta") adapter = ActiveModel::Serializer::Adapter::Json.new(serializer, root: 'blog') expected = { - 'blog' => [{ + blogs: [{ id: 1, name: "AMS Hints", writer: { @@ -98,7 +100,7 @@ module ActiveModel options.partition { |k, _| ActionController::Serialization::ADAPTER_OPTION_KEYS.include? k }.map { |h| Hash[h] } serializer = AlternateBlogSerializer.new(@blog, serializer_opts) - ActiveModel::Serializer::Adapter::Json.new(serializer, adapter_opts) + ActiveModel::Serializer::Adapter::FlattenJson.new(serializer, adapter_opts) end end end