active_model_serializers 0.8.3 → 0.9.2

data/test/unit/active_model/serializer/has_one_test.rb

@@ -0,0 +1,207 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class HasOneTest < Minitest::Test
+      def setup
+        @association = UserSerializer._associations[:profile]
+        @old_association = @association.dup
+
+        @user = User.new({ name: 'Name 1', email: 'mail@server.com', gender: 'M' })
+        @user_serializer = UserSerializer.new(@user)
+      end
+
+      def teardown
+        UserSerializer._associations[:profile] = @old_association
+      end
+
+      def test_associations_definition
+        assert_equal 1, UserSerializer._associations.length
+        assert_kind_of Association::HasOne, @association
+        assert_equal 'profile', @association.name
+      end
+
+      def test_associations_embedding_ids_serialization_using_serializable_hash
+        @association.embed = :ids
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_ids_serialization_using_as_json
+        @association.embed = :ids
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_serialization_using_serializable_hash_and_key_from_options
+        @association.embed = :ids
+        @association.key = 'key'
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', 'key' => @user.profile.object_id
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_objects_serialization_using_serializable_hash
+        @association.embed = :objects
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', profile: { name: 'N1', description: 'D1' }
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_objects_serialization_using_as_json
+        @association.embed = :objects
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', profile: { name: 'N1', description: 'D1' } }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_nil_ids_serialization_using_as_json
+        @association.embed = :ids
+        @user.instance_eval do
+          def profile
+            nil
+          end
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => nil }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_nil_objects_serialization_using_as_json
+        @association.embed = :objects
+        @user.instance_eval do
+          def profile
+            nil
+          end
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', profile: nil }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_objects_serialization_using_serializable_hash_and_root_from_options
+        @association.embed = :objects
+        @association.embedded_key = 'root'
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', 'root' => { name: 'N1', description: 'D1' }
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_ids_including_objects_serialization_using_serializable_hash
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_nil_ids_including_objects_serialization_using_as_json
+        @association.embed = :ids
+        @association.embed_in_root = true
+        @user.instance_eval do
+          def profile
+            nil
+          end
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => nil },
+          'profiles' => []
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_including_objects_serialization_using_as_json
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id },
+          'profiles' => [{ name: 'N1', description: 'D1' }]
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_using_a_given_serializer
+        @association.embed = :ids
+        @association.embed_in_root = true
+        @association.serializer_from_options = Class.new(Serializer) do
+          def name
+            'fake'
+          end
+
+          attributes :name
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id },
+          'profiles' => [{ name: 'fake' }]
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_objects_using_a_given_serializer
+        @association.serializer_from_options = Class.new(Serializer) do
+          def name
+            'fake'
+          end
+
+          attributes :name
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', profile: { name: 'fake' } }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_using_embed_namespace
+        @association.embed_namespace = :links
+        @association.embed = :ids
+        @association.key = :profile
+        assert_equal({
+          'user' => {
+            name: 'Name 1', email: 'mail@server.com',
+            links: {
+              profile: @user.profile.object_id
+            }
+          }
+        }, @user_serializer.as_json)
+      end
+
+      def test_asociations_embedding_objects_using_embed_namespace
+        @association.embed_namespace = :links
+        @association.embed = :objects
+        assert_equal({
+          'user' => {
+            name: 'Name 1', email: 'mail@server.com',
+            links: {
+              profile: { name: 'N1', description: 'D1' }
+            }
+          }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_using_embed_namespace_and_embed_in_root_key
+        @association.embed_in_root = true
+        @association.embed_in_root_key = :linked
+        @association.embed = :ids
+        assert_equal({
+          'user' => {
+            name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id
+          },
+          linked: {
+            'profiles' => [ { name: 'N1', description: 'D1' } ]
+          }
+        }, @user_serializer.as_json)
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/key_format_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class KeyFormatTest < Minitest::Test
+      def test_lower_camel_format_option
+        object     = WebLog.new({ name: 'Name 1', display_name: 'Display Name 1'})
+        serializer = WebLogSerializer.new(object, key_format: :lower_camel)
+
+        expected = { name: 'Name 1', displayName: 'Display Name 1' }
+
+        assert_equal expected, serializer.serializable_object
+      end
+
+      def test_lower_camel_format_serializer
+        object     = WebLog.new({ name: 'Name 1', display_name: 'Display Name 1'})
+        serializer = WebLogLowerCamelSerializer.new(object)
+
+        expected = { name: 'Name 1', displayName: 'Display Name 1' }
+
+        assert_equal expected, serializer.serializable_object
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/meta_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class MetaTest < Minitest::Test
+      def setup
+        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+      end
+
+      def test_meta
+        profile_serializer = ProfileSerializer.new(@profile, root: 'profile', meta: { total: 10 })
+
+        assert_equal({
+          'profile' => {
+            name: 'Name 1',
+            description: 'Description 1'
+          },
+          meta: {
+            total: 10
+          }
+        }, profile_serializer.as_json)
+      end
+
+      def test_meta_using_meta_key
+        profile_serializer = ProfileSerializer.new(@profile, root: 'profile', meta_key: :my_meta, my_meta: { total: 10 })
+
+        assert_equal({
+          'profile' => {
+            name: 'Name 1',
+            description: 'Description 1'
+          },
+          my_meta: {
+            total: 10
+          }
+        }, profile_serializer.as_json)
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/options_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class OptionsTest < Minitest::Test
+      def setup
+        @serializer = ProfileSerializer.new(nil, context: {foo: :bar})
+      end
+
+      def test_custom_options_are_accessible_from_serializer
+        assert_equal({foo: :bar}, @serializer.context)
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/root_test.rb

@@ -0,0 +1,117 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class RootAsOptionTest < Minitest::Test
+      def setup
+        @old_root = ProfileSerializer._root
+        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        @serializer = ProfileSerializer.new(@profile, root: :initialize)
+        ProfileSerializer._root = true
+      end
+
+      def teardown
+        ProfileSerializer._root = @old_root
+      end
+
+      def test_root_is_not_displayed_using_serializable_hash
+        assert_equal({
+          name: 'Name 1', description: 'Description 1'
+        }, @serializer.serializable_hash)
+      end
+
+      def test_root_using_as_json
+        assert_equal({
+          initialize: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @serializer.as_json)
+      end
+
+      def test_root_from_serializer_name
+        @serializer = ProfileSerializer.new(@profile)
+
+        assert_equal({
+          'profile' => {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @serializer.as_json)
+      end
+
+      def test_root_as_argument_takes_precedence
+        assert_equal({
+          argument: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @serializer.as_json(root: :argument))
+      end
+
+      def test_using_false_root_in_initializer_takes_precedence
+        ProfileSerializer._root = 'root'
+        @serializer = ProfileSerializer.new(@profile, root: false)
+
+        assert_equal({
+          name: 'Name 1', description: 'Description 1'
+        }, @serializer.as_json)
+      end
+
+      def test_root_inheritance
+        ProfileSerializer._root = 'profile'
+
+        inherited_serializer_klass = Class.new(ProfileSerializer)
+        inherited_serializer_klass._root = 'inherited_profile'
+
+        another_inherited_serializer_klass = Class.new(ProfileSerializer)
+
+        assert_equal('inherited_profile',
+                     inherited_serializer_klass._root)
+        assert_equal('profile',
+                     another_inherited_serializer_klass._root)
+      end
+    end
+
+    class RootInSerializerTest < Minitest::Test
+      def setup
+        @old_root = ProfileSerializer._root
+        ProfileSerializer._root = :in_serializer
+        profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        @serializer = ProfileSerializer.new(profile)
+        @rooted_serializer = ProfileSerializer.new(profile, root: :initialize)
+      end
+
+      def teardown
+        ProfileSerializer._root = @old_root
+      end
+
+      def test_root_is_not_displayed_using_serializable_hash
+        assert_equal({
+          name: 'Name 1', description: 'Description 1'
+        }, @serializer.serializable_hash)
+      end
+
+      def test_root_using_as_json
+        assert_equal({
+          in_serializer: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @serializer.as_json)
+      end
+
+      def test_root_in_initializer_takes_precedence
+        assert_equal({
+          initialize: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @rooted_serializer.as_json)
+      end
+
+      def test_root_as_argument_takes_precedence
+        assert_equal({
+          argument: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @rooted_serializer.as_json(root: :argument))
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/scope_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class ScopeTest < Minitest::Test
+      def setup
+        @serializer = ProfileSerializer.new(nil, scope: current_user)
+      end
+
+      def test_scope
+        assert_equal('user', @serializer.scope)
+      end
+
+      private
+
+      def current_user
+        'user'
+      end
+    end
+
+    class NestedScopeTest < Minitest::Test
+      def setup
+        @association = UserSerializer._associations[:profile]
+        @old_association = @association.dup
+        @user = User.new({ name: 'Name 1', email: 'mail@server.com', gender: 'M' })
+        @user_serializer = UserSerializer.new(@user, scope: 'user')
+      end
+
+      def teardown
+        UserSerializer._associations[:profile] = @old_association
+      end
+
+      def test_scope_passed_through
+        @association.serializer_from_options = Class.new(Serializer) do
+          def name
+            scope
+          end
+
+          attributes :name
+        end
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', profile: { name: 'user' }
+        }, @user_serializer.serializable_hash)
+      end
+    end
+
+  end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.2
 platform: ruby
 authors:
 - José Valim
 - Yehuda Katz
+- Santiago Pastorino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -17,100 +18,94 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 description: Making it easy to serialize models for client-side use
 email:
 - jose.valim@gmail.com
 - wycats@gmail.com
+- santiago@wyeworks.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - DESIGN.textile
-- Gemfile
-- Gemfile.edge
-- MIT-LICENSE.txt
+- MIT-LICENSE
 - README.md
-- Rakefile
-- active_model_serializers.gemspec
-- bench/perf.rb
-- cruft.md
 - lib/action_controller/serialization.rb
+- lib/action_controller/serialization_test_case.rb
 - lib/active_model/array_serializer.rb
+- lib/active_model/default_serializer.rb
+- lib/active_model/serializable.rb
 - lib/active_model/serializer.rb
 - lib/active_model/serializer/associations.rb
-- lib/active_model/serializers/version.rb
+- lib/active_model/serializer/config.rb
+- lib/active_model/serializer/generators/resource_override.rb
+- lib/active_model/serializer/generators/serializer/USAGE
+- lib/active_model/serializer/generators/serializer/scaffold_controller_generator.rb
+- lib/active_model/serializer/generators/serializer/serializer_generator.rb
+- lib/active_model/serializer/generators/serializer/templates/controller.rb
+- lib/active_model/serializer/generators/serializer/templates/serializer.rb
+- lib/active_model/serializer/railtie.rb
+- lib/active_model/serializer/version.rb
+- lib/active_model/serializer_support.rb
 - lib/active_model_serializers.rb
-- lib/active_record/serializer_override.rb
-- lib/generators/resource_override.rb
-- lib/generators/serializer/USAGE
-- lib/generators/serializer/serializer_generator.rb
-- lib/generators/serializer/templates/serializer.rb
-- test/array_serializer_test.rb
-- test/association_test.rb
-- test/caching_test.rb
-- test/generators_test.rb
-- test/no_serialization_scope_test.rb
-- test/serialization_scope_name_test.rb
-- test/serialization_test.rb
-- test/serializer_support_test.rb
-- test/serializer_test.rb
-- test/test_fakes.rb
+- test/fixtures/active_record.rb
+- test/fixtures/poro.rb
+- test/integration/action_controller/serialization_test.rb
+- test/integration/action_controller/serialization_test_case_test.rb
+- test/integration/active_record/active_record_test.rb
+- test/integration/generators/resource_generator_test.rb
+- test/integration/generators/scaffold_controller_generator_test.rb
+- test/integration/generators/serializer_generator_test.rb
+- test/test_app.rb
 - test/test_helper.rb
+- test/tmp/app/serializers/account_serializer.rb
+- test/unit/active_model/array_serializer/except_test.rb
+- test/unit/active_model/array_serializer/key_format_test.rb
+- test/unit/active_model/array_serializer/meta_test.rb
+- test/unit/active_model/array_serializer/only_test.rb
+- test/unit/active_model/array_serializer/root_test.rb
+- test/unit/active_model/array_serializer/scope_test.rb
+- test/unit/active_model/array_serializer/serialization_test.rb
+- test/unit/active_model/default_serializer_test.rb
+- test/unit/active_model/serializer/associations/build_serializer_test.rb
+- test/unit/active_model/serializer/associations_test.rb
+- test/unit/active_model/serializer/attributes_test.rb
+- test/unit/active_model/serializer/config_test.rb
+- test/unit/active_model/serializer/filter_test.rb
+- test/unit/active_model/serializer/has_many_test.rb
+- test/unit/active_model/serializer/has_one_test.rb
+- test/unit/active_model/serializer/key_format_test.rb
+- test/unit/active_model/serializer/meta_test.rb
+- test/unit/active_model/serializer/options_test.rb
+- test/unit/active_model/serializer/root_test.rb
+- test/unit/active_model/serializer/scope_test.rb
 homepage: https://github.com/rails-api/active_model_serializers
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -120,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -133,4 +128,35 @@ signing_key:
 specification_version: 4
 summary: Bringing consistency and object orientation to model serialization. Works
   great for client-side MVC frameworks!
-test_files: []
+test_files:
+- test/test_app.rb
+- test/tmp/app/serializers/account_serializer.rb
+- test/integration/active_record/active_record_test.rb
+- test/integration/action_controller/serialization_test.rb
+- test/integration/action_controller/serialization_test_case_test.rb
+- test/integration/generators/resource_generator_test.rb
+- test/integration/generators/serializer_generator_test.rb
+- test/integration/generators/scaffold_controller_generator_test.rb
+- test/test_helper.rb
+- test/unit/active_model/array_serializer/except_test.rb
+- test/unit/active_model/array_serializer/scope_test.rb
+- test/unit/active_model/array_serializer/only_test.rb
+- test/unit/active_model/array_serializer/serialization_test.rb
+- test/unit/active_model/array_serializer/meta_test.rb
+- test/unit/active_model/array_serializer/root_test.rb
+- test/unit/active_model/array_serializer/key_format_test.rb
+- test/unit/active_model/serializer/config_test.rb
+- test/unit/active_model/serializer/has_one_test.rb
+- test/unit/active_model/serializer/has_many_test.rb
+- test/unit/active_model/serializer/filter_test.rb
+- test/unit/active_model/serializer/scope_test.rb
+- test/unit/active_model/serializer/meta_test.rb
+- test/unit/active_model/serializer/root_test.rb
+- test/unit/active_model/serializer/associations/build_serializer_test.rb
+- test/unit/active_model/serializer/attributes_test.rb
+- test/unit/active_model/serializer/options_test.rb
+- test/unit/active_model/serializer/key_format_test.rb
+- test/unit/active_model/serializer/associations_test.rb
+- test/unit/active_model/default_serializer_test.rb
+- test/fixtures/poro.rb
+- test/fixtures/active_record.rb

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.swp