active_model_serializers 0.10.0.rc1 → 0.10.0.rc2

data/test/adapter/json_api/has_one_test.rb

@@ -30,9 +30,9 @@ module ActiveModel
           end
 
           def test_includes_bio_id
-            expected = { linkage: { type: "bios", id: "43" } }
+            expected = { data: { type: "bios", id: "43" } }
 
-            assert_equal(expected, @adapter.serializable_hash[:data][:links][:bio])
+            assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:bio])
           end
 
           def test_includes_linked_bio
@@ -41,11 +41,13 @@ module ActiveModel
             expected = [
               {
                 id: "43",
-                rating: nil,
                 type: "bios",
-                content:"AMS Contributor",
-                links: {
-                  author: { linkage: { type: "authors", id: "1" } }
+                attributes: {
+                  content:"AMS Contributor",
+                  rating: nil
+                },
+                relationships: {
+                  author: { data: { type: "authors", id: "1" } }
                 }
               }
             ]

data/test/adapter/json_api/linked_test.rb

@@ -54,77 +54,93 @@ module ActiveModel
               data: [
                 {
                   id: "10",
-                  title: "Hello!!",
-                  body: "Hello, world!!",
                   type: "posts",
-                  links: {
-                    comments: { linkage: [ { type: "comments", id: '1' }, { type: "comments", id: '2' } ] },
-                    blog: { linkage: { type: "blogs", id: "999" } },
-                    author: { linkage: { type: "authors", id: "1" } }
+                  attributes: {
+                    title: "Hello!!",
+                    body: "Hello, world!!"
+                  },
+                  relationships: {
+                    comments: { data: [ { type: "comments", id: '1' }, { type: "comments", id: '2' } ] },
+                    blog: { data: { type: "blogs", id: "999" } },
+                    author: { data: { type: "authors", id: "1" } }
                   }
                 },
                 {
                   id: "20",
-                  title: "New Post",
-                  body: "Body",
                   type: "posts",
-                  links: {
-                    comments: { linkage: [] },
-                    blog: { linkage: { type: "blogs", id: "999" } },
-                    author: { linkage: { type: "authors", id: "2" } }
+                  attributes: {
+                    title: "New Post",
+                    body: "Body"
+                  },
+                  relationships: {
+                    comments: { data: [] },
+                    blog: { data: { type: "blogs", id: "999" } },
+                    author: { data: { type: "authors", id: "2" } }
                   }
                 }
               ],
               included: [
                 {
                   id: "1",
-                  body: "ZOMG A COMMENT",
                   type: "comments",
-                  links: {
-                    post: { linkage: { type: "posts", id: "10" } },
-                    author: { linkage: nil }
+                  attributes: {
+                    body: "ZOMG A COMMENT"
+                  },
+                  relationships: {
+                    post: { data: { type: "posts", id: "10" } },
+                    author: { data: nil }
                   }
                 }, {
                   id: "2",
-                  body: "ZOMG ANOTHER COMMENT",
                   type: "comments",
-                  links: {
-                    post: { linkage: { type: "posts", id: "10" } },
-                    author: { linkage: nil }
+                  attributes: {
+                    body: "ZOMG ANOTHER COMMENT",
+                  },
+                  relationships: {
+                    post: { data: { type: "posts", id: "10" } },
+                    author: { data: nil }
                   }
                 }, {
                   id: "1",
-                  name: "Steve K.",
                   type: "authors",
-                  links: {
-                    posts: { linkage: [ { type: "posts", id: "10" }, { type: "posts", id: "30" } ] },
-                    roles: { linkage: [] },
-                    bio: { linkage: { type: "bios", id: "1" } }
+                  attributes: {
+                    name: "Steve K."
+                  },
+                  relationships: {
+                    posts: { data: [ { type: "posts", id: "10" }, { type: "posts", id: "30" } ] },
+                    roles: { data: [] },
+                    bio: { data: { type: "bios", id: "1" } }
                   }
                 }, {
                   id: "1",
-                  rating: nil,
                   type: "bios",
-                  content: "AMS Contributor",
-                  links: {
-                    author: { linkage: { type: "authors", id: "1" } }
+                  attributes: {
+                    content: "AMS Contributor",
+                    rating: nil
+                  },
+                  relationships: {
+                    author: { data: { type: "authors", id: "1" } }
                   }
                 }, {
                   id: "2",
-                  name: "Tenderlove",
                   type: "authors",
-                  links: {
-                    posts: { linkage: [ { type: "posts", id:"20" } ] },
-                    roles: { linkage: [] },
-                    bio: { linkage: { type: "bios", id: "2" } }
+                  attributes: {
+                    name: "Tenderlove"
+                  },
+                  relationships: {
+                    posts: { data: [ { type: "posts", id:"20" } ] },
+                    roles: { data: [] },
+                    bio: { data: { type: "bios", id: "2" } }
                   }
                 }, {
                   id: "2",
-                  rating: nil,
                   type: "bios",
-                  content: "Rails Contributor",
-                  links: {
-                    author: { linkage: { type: "authors", id: "2" } }
+                  attributes: {
+                    rating: nil,
+                    content: "Rails Contributor",
+                  },
+                  relationships: {
+                    author: { data: { type: "authors", id: "2" } }
                   }
                 }
               ]
@@ -148,31 +164,37 @@ module ActiveModel
               {
                 id: "1",
                 type: "authors",
-                name: "Steve K.",
-                links: {
-                  posts: { linkage: [ { type: "posts", id: "10"}, { type: "posts", id: "30" }] },
-                  roles: { linkage: [] },
-                  bio: { linkage: { type: "bios", id: "1" }}
+                attributes: {
+                  name: "Steve K."
+                },
+                relationships: {
+                  posts: { data: [ { type: "posts", id: "10"}, { type: "posts", id: "30" }] },
+                  roles: { data: [] },
+                  bio: { data: { type: "bios", id: "1" }}
                 }
               }, {
                 id: "10",
                 type: "posts",
-                title: "Hello!!",
-                body: "Hello, world!!",
-                links: {
-                  comments: { linkage: [ { type: "comments", id: "1"}, { type: "comments", id: "2" }] },
-                  blog: { linkage: { type: "blogs", id: "999" } },
-                  author: { linkage: { type: "authors", id: "1" } }
+                attributes: {
+                  title: "Hello!!",
+                  body: "Hello, world!!"
+                },
+                relationships: {
+                  comments: { data: [ { type: "comments", id: "1"}, { type: "comments", id: "2" }] },
+                  blog: { data: { type: "blogs", id: "999" } },
+                  author: { data: { type: "authors", id: "1" } }
                 }
               }, {
                 id: "30",
                 type: "posts",
-                title: "Yet Another Post",
-                body: "Body",
-                links: {
-                  comments: { linkage: [] },
-                  blog: { linkage: { type: "blogs", id: "999" } },
-                  author: { linkage: { type: "authors", id: "1" } }
+                attributes: {
+                  title: "Yet Another Post",
+                  body: "Body"
+                },
+                relationships: {
+                  comments: { data: [] },
+                  blog: { data: { type: "blogs", id: "999" } },
+                  author: { data: { type: "authors", id: "1" } }
                 }
               }
             ]
@@ -181,21 +203,21 @@ module ActiveModel
             assert_equal expected, alt_adapter.serializable_hash[:included]
           end
 
-          def test_ignore_model_namespace_for_linked_resource_type
+          def test_underscore_model_namespace_for_linked_resource_type
             spammy_post = Post.new(id: 123)
             spammy_post.related = [Spam::UnrelatedLink.new(id: 456)]
             serializer = SpammyPostSerializer.new(spammy_post)
             adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
-            links = adapter.serializable_hash[:data][:links]
+            relationships = adapter.serializable_hash[:data][:relationships]
             expected = {
               related: {
-                linkage: [{
-                  type: 'unrelated_links',
+                data: [{
+                  type: 'spam_unrelated_links',
                   id: '456'
                 }]
               }
             }
-            assert_equal expected, links
+            assert_equal expected, relationships
           end
 
           def test_multiple_references_to_same_resource
@@ -208,18 +230,20 @@ module ActiveModel
             expected = [
               {
                 id: "10",
-                title: "Hello!!",
-                body: "Hello, world!!",
                 type: "posts",
-                links: {
+                attributes: {
+                  title: "Hello!!",
+                  body: "Hello, world!!"
+                },
+                relationships: {
                   comments: {
-                    linkage: [{type: "comments", id: "1"}, {type: "comments", id: "2"}]
+                    data: [{type: "comments", id: "1"}, {type: "comments", id: "2"}]
                   },
                   blog: {
-                    linkage: {type: "blogs", id: "999"}
+                    data: {type: "blogs", id: "999"}
                   },
                   author: {
-                    linkage: {type: "authors", id: "1"}
+                    data: {type: "authors", id: "1"}
                   }
                 }
               }
@@ -239,12 +263,14 @@ module ActiveModel
             expected = {
               data: {
                 id: "10",
-                title: "Hello!!",
-                body: "Hello, world!!",
                 type: "posts",
-                links: {
-                  comments: { linkage: [ { type: "comments", id: '1' }, { type: "comments", id: '2' } ] },
-                  author: { linkage: nil }
+                attributes: {
+                  title: "Hello!!",
+                  body: "Hello, world!!"
+                },
+                relationships: {
+                  comments: { data: [ { type: "comments", id: '1' }, { type: "comments", id: '2' } ] },
+                  author: { data: nil }
                 }
               }
             }

data/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

data/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

data/test/array_serializer_test.rb

@@ -24,6 +24,20 @@ module ActiveModel
 
         assert_equal serializers.last.custom_options[:some], :options
       end
+
+      def test_serializer_option_not_passed_to_each_serializer
+        serializers = ArraySerializer.new([@post], {serializer: PostSerializer}).to_a
+
+        refute serializers.first.custom_options.key?(:serializer)
+      end
+
+      def test_meta_and_meta_key_attr_readers
+        meta_content = {meta: "the meta", meta_key: "the meta key"}
+        @serializer = ArraySerializer.new([@comment, @post], meta_content)
+
+        assert_equal @serializer.meta, "the meta"
+        assert_equal @serializer.meta_key, "the meta key"
+      end
     end
   end
 end

data/test/fixtures/poro.rb

@@ -1,4 +1,10 @@
 class Model
+  FILE_DIGEST = Digest::MD5.hexdigest(File.open(__FILE__).read)
+
+  def self.model_name
+    @_model_name ||= ActiveModel::Name.new(self)
+  end
+
   def initialize(hash={})
     @attributes = hash
   end
@@ -7,6 +13,10 @@ class Model
     "#{self.class.name.downcase}/#{self.id}-#{self.updated_at}"
   end
 
+  def cache_key_with_digest
+    "#{cache_key}/#{FILE_DIGEST}"
+  end
+
   def updated_at
     @attributes[:updated_at] ||= DateTime.now.to_time.to_i
   end
@@ -64,7 +74,7 @@ Author   = Class.new(Model)
 Bio      = Class.new(Model)
 Blog     = Class.new(Model)
 Role     = Class.new(Model)
-User = Class.new(Model)
+User     = Class.new(Model)
 Location = Class.new(Model)
 Place    = Class.new(Model)
 
@@ -72,7 +82,7 @@ module Spam; end
 Spam::UnrelatedLink = Class.new(Model)
 
 PostSerializer = Class.new(ActiveModel::Serializer) do
-  cache key:'post', expires_in: 0.1
+  cache key:'post', expires_in: 0.1, skip_digest: true
   attributes :id, :title, :body
 
   has_many :comments
@@ -99,7 +109,7 @@ SpammyPostSerializer = Class.new(ActiveModel::Serializer) do
 end
 
 CommentSerializer = Class.new(ActiveModel::Serializer) do
-  cache expires_in: 1.day
+  cache expires_in: 1.day, skip_digest: true
   attributes :id, :body
 
   belongs_to :post
@@ -111,7 +121,7 @@ CommentSerializer = Class.new(ActiveModel::Serializer) do
 end
 
 AuthorSerializer = Class.new(ActiveModel::Serializer) do
-  cache key:'writer'
+  cache key:'writer', skip_digest: true
   attributes :id, :name
 
   has_many :posts, embed: :ids
@@ -120,7 +130,7 @@ AuthorSerializer = Class.new(ActiveModel::Serializer) do
 end
 
 RoleSerializer = Class.new(ActiveModel::Serializer) do
-  cache only: [:name]
+  cache only: [:name], skip_digest: true
   attributes :id, :name, :description, :slug
 
   def slug
@@ -137,7 +147,7 @@ LikeSerializer = Class.new(ActiveModel::Serializer) do
 end
 
 LocationSerializer = Class.new(ActiveModel::Serializer) do
-  cache only: [:place]
+  cache only: [:place], skip_digest: true
   attributes :id, :lat, :lng
 
   belongs_to :place
@@ -154,13 +164,14 @@ PlaceSerializer = Class.new(ActiveModel::Serializer) do
 end
 
 BioSerializer = Class.new(ActiveModel::Serializer) do
-  cache except: [:content]
+  cache except: [:content], skip_digest: true
   attributes :id, :content, :rating
 
   belongs_to :author
 end
 
 BlogSerializer = Class.new(ActiveModel::Serializer) do
+  cache key: 'blog'
   attributes :id, :name
 
   belongs_to :writer
@@ -178,6 +189,13 @@ AlternateBlogSerializer = Class.new(ActiveModel::Serializer) do
   attribute :name, key: :title
 end
 
+CustomBlogSerializer = Class.new(ActiveModel::Serializer) do
+  attribute :id
+  attribute :special_attribute
+
+  has_many :articles
+end
+
 CommentPreviewSerializer = Class.new(ActiveModel::Serializer) do
   attributes :id
 
@@ -204,3 +222,9 @@ end
 Spam::UnrelatedLinkSerializer = Class.new(ActiveModel::Serializer) do
   attributes :id
 end
+
+RaiseErrorSerializer = Class.new(ActiveModel::Serializer) do
+  def json_key
+    raise StandardError, 'Intentional error for rescue_from test'
+  end
+end

data/test/generators/scaffold_controller_generator_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+# require 'active_model/serializer/railtie'
+
+class ResourceGeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path('../../../tmp/generators', __FILE__)
+  setup :prepare_destination, :copy_routes
+
+  tests Rails::Generators::ResourceGenerator
+  arguments %w(account)
+
+  def test_serializer_file_is_generated
+    run_generator
+
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ActiveModel::Serializer/
+  end
+
+  private
+
+  def copy_routes
+    config_dir = File.join(destination_root, 'config')
+    FileUtils.mkdir_p(config_dir)
+    File.write(File.join(config_dir, 'routes.rb'), 'Rails.application.routes.draw { }')
+  end
+end