From 860acad9af5f52167e25310b9ded578509a7279e Mon Sep 17 00:00:00 2001 From: Arthur Neves Date: Thu, 24 Oct 2013 14:11:58 -0400 Subject: [PATCH] s/side_load/embed_in_root --- lib/active_model/serializer.rb | 6 +++--- lib/active_model/serializer/associations.rb | 8 ++++---- test/integration/active_record/active_record_test.rb | 4 ++-- test/unit/active_model/serializer/config_test.rb | 4 ++-- test/unit/active_model/serializer/filter_test.rb | 2 +- test/unit/active_model/serializer/has_many_test.rb | 8 ++++---- test/unit/active_model/serializer/has_one_test.rb | 6 +++--- 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/lib/active_model/serializer.rb b/lib/active_model/serializer.rb index 0f9405ea..4a01c172 100644 --- a/lib/active_model/serializer.rb +++ b/lib/active_model/serializer.rb @@ -19,14 +19,14 @@ module ActiveModel def embed(type, options={}) CONFIG.embed = type - CONFIG.side_load = true if options[:side_load] || options[:include] + CONFIG.embed_in_root = true if options[:embed_in_root] || options[:include] ActiveSupport::Deprecation.warn <<-WARN ** Notice: embed is deprecated. ** The use of .embed method on a Serializer will be soon removed, as this should have a global scope and not a class scope. Please use the global .setup method instead: ActiveModel::Serializer.setup do |config| config.embed = :#{type} - config.side_load = #{CONFIG.side_load || false} + config.embed_in_root = #{CONFIG.embed_in_root || false} end WARN end @@ -147,7 +147,7 @@ end included_associations = filter(associations.keys) associations.each_with_object({}) do |(name, association), hash| if included_associations.include? name - if association.side_load? + if association.embed_in_root? hash[association.embedded_key] = serialize association end end diff --git a/lib/active_model/serializer/associations.rb b/lib/active_model/serializer/associations.rb index 5e41d8b1..813a6010 100644 --- a/lib/active_model/serializer/associations.rb +++ b/lib/active_model/serializer/associations.rb @@ -7,14 +7,14 @@ module ActiveModel def initialize(name, options={}) if options.has_key?(:include) ActiveSupport::Deprecation.warn <<-WARN -** Notice: include was renamed to side_load. ** +** Notice: include was renamed to embed_in_root. ** WARN end @name = name.to_s @options = options self.embed = options.fetch(:embed) { CONFIG.embed } - @side_load = options.fetch(:side_load) { options.fetch(:include) { CONFIG.side_load } } + @embed_in_root = options.fetch(:embed_in_root) { options.fetch(:include) { CONFIG.embed_in_root } } @embed_key = options[:embed_key] || :id @key = options[:key] @embedded_key = options[:root] || name @@ -23,10 +23,10 @@ module ActiveModel end attr_reader :name, :embed_ids, :embed_objects, :serializer_class - attr_accessor :side_load, :embed_key, :key, :embedded_key, :options + attr_accessor :embed_in_root, :embed_key, :key, :embedded_key, :options alias embed_ids? embed_ids alias embed_objects? embed_objects - alias side_load? side_load + alias embed_in_root? embed_in_root def serializer_class=(serializer) @serializer_class = serializer.is_a?(String) ? serializer.constantize : serializer diff --git a/test/integration/active_record/active_record_test.rb b/test/integration/active_record/active_record_test.rb index 3d0f8c9c..0bad4672 100644 --- a/test/integration/active_record/active_record_test.rb +++ b/test/integration/active_record/active_record_test.rb @@ -40,7 +40,7 @@ module ActiveModel def test_serialization_embedding_ids_including_in_root post_serializer = ARPostSerializer.new(@post) - embed(ARPostSerializer, embed: :ids, side_load: true) do + embed(ARPostSerializer, embed: :ids, embed_in_root: true) do assert_equal({ 'ar_post' => { title: 'New post', body: 'A body!!!', @@ -63,7 +63,7 @@ module ActiveModel ARPostSerializer._associations.each_value do |association| association.embed = options[:embed] - association.side_load = options[:side_load] + association.embed_in_root = options[:embed_in_root] end yield diff --git a/test/unit/active_model/serializer/config_test.rb b/test/unit/active_model/serializer/config_test.rb index 2d5f3b9e..2ade1fd0 100644 --- a/test/unit/active_model/serializer/config_test.rb +++ b/test/unit/active_model/serializer/config_test.rb @@ -66,7 +66,7 @@ module ActiveModel class ApplyConfigTest < ActiveModel::TestCase def test_apply_config_to_associations CONFIG.embed = :ids - CONFIG.side_load = true + CONFIG.embed_in_root = true association = PostSerializer._associations[:comments] old_association = association.dup @@ -75,7 +75,7 @@ module ActiveModel assert association.embed_ids? assert !association.embed_objects? - assert association.side_load + assert association.embed_in_root ensure PostSerializer._associations[:comments] = old_association CONFIG.clear diff --git a/test/unit/active_model/serializer/filter_test.rb b/test/unit/active_model/serializer/filter_test.rb index c3abb49c..bf33b5e7 100644 --- a/test/unit/active_model/serializer/filter_test.rb +++ b/test/unit/active_model/serializer/filter_test.rb @@ -25,7 +25,7 @@ module ActiveModel @association = PostSerializer._associations[:comments] @old_association = @association.dup @association.embed = :ids - @association.side_load = true + @association.embed_in_root = true @post = Post.new({ title: 'Title 1', body: 'Body 1', date: '1/1/2000' }) @post_serializer = PostSerializer.new(@post) @post_serializer.instance_eval do diff --git a/test/unit/active_model/serializer/has_many_test.rb b/test/unit/active_model/serializer/has_many_test.rb index 5df73c48..541df46b 100644 --- a/test/unit/active_model/serializer/has_many_test.rb +++ b/test/unit/active_model/serializer/has_many_test.rb @@ -86,7 +86,7 @@ module ActiveModel def test_associations_embedding_ids_including_objects_serialization_using_serializable_hash @association.embed = :ids - @association.side_load = true + @association.embed_in_root = true assert_equal({ title: 'Title 1', body: 'Body 1', 'comment_ids' => @post.comments.map { |c| c.object_id } @@ -95,7 +95,7 @@ module ActiveModel def test_associations_embedding_ids_including_objects_serialization_using_as_json @association.embed = :ids - @association.side_load = true + @association.embed_in_root = true assert_equal({ 'post' => { title: 'Title 1', body: 'Body 1', 'comment_ids' => @post.comments.map { |c| c.object_id } }, @@ -105,7 +105,7 @@ module ActiveModel def test_associations_embedding_nothing_including_objects_serialization_using_as_json @association.embed = nil - @association.side_load = true + @association.embed_in_root = true assert_equal({ 'post' => { title: 'Title 1', body: 'Body 1' }, @@ -115,7 +115,7 @@ module ActiveModel def test_associations_using_a_given_serializer @association.embed = :ids - @association.side_load = true + @association.embed_in_root = true @association.serializer_class = Class.new(ActiveModel::Serializer) do def content 'fake' diff --git a/test/unit/active_model/serializer/has_one_test.rb b/test/unit/active_model/serializer/has_one_test.rb index 53f0f99b..3dd72693 100644 --- a/test/unit/active_model/serializer/has_one_test.rb +++ b/test/unit/active_model/serializer/has_one_test.rb @@ -99,7 +99,7 @@ module ActiveModel def test_associations_embedding_ids_including_objects_serialization_using_serializable_hash @association.embed = :ids - @association.side_load = true + @association.embed_in_root = true assert_equal({ name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id @@ -108,7 +108,7 @@ module ActiveModel def test_associations_embedding_ids_including_objects_serialization_using_as_json @association.embed = :ids - @association.side_load = true + @association.embed_in_root = true assert_equal({ 'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id }, @@ -118,7 +118,7 @@ module ActiveModel def test_associations_using_a_given_serializer @association.embed = :ids - @association.side_load = true + @association.embed_in_root = true @association.serializer_class = Class.new(ActiveModel::Serializer) do def name 'fake'