active_model_serializers 0.10.0.rc2 → 0.10.0.rc3

data/test/fixtures/poro.rb

@@ -1,3 +1,5 @@
+verbose = $VERBOSE
+$VERBOSE = nil
 class Model
   FILE_DIGEST = Digest::MD5.hexdigest(File.open(__FILE__).read)
 
@@ -5,20 +7,16 @@ class Model
     @_model_name ||= ActiveModel::Name.new(self)
   end
 
-  def initialize(hash={})
+  def initialize(hash = {})
     @attributes = hash
   end
 
   def cache_key
-    "#{self.class.name.downcase}/#{self.id}-#{self.updated_at}"
+    "#{self.class.name.downcase}/#{self.id}-#{self.updated_at.strftime("%Y%m%d%H%M%S%9N")}"
   end
 
-  def cache_key_with_digest
-    "#{cache_key}/#{FILE_DIGEST}"
-  end
-
-  def updated_at
-    @attributes[:updated_at] ||= DateTime.now.to_time.to_i
+  def serializable_hash(options = nil)
+    @attributes
   end
 
   def read_attribute_for_serialization(name)
@@ -33,10 +31,9 @@ class Model
     @attributes[:id] || @attributes['id'] || object_id
   end
 
-  def to_param
-    id
-  end
-
+  ### Helper methods, not required to be serializable
+  #
+  # Convenience for adding @attributes readers and writers
   def method_missing(meth, *args)
     if meth.to_s =~ /^(.*)=$/
       @attributes[$1.to_sym] = args[0]
@@ -46,6 +43,14 @@ class Model
       super
     end
   end
+
+  def cache_key_with_digest
+    "#{cache_key}/#{FILE_DIGEST}"
+  end
+
+  def updated_at
+    @attributes[:updated_at] ||= DateTime.now.to_time
+  end
 end
 
 class Profile < Model
@@ -54,8 +59,6 @@ end
 class ProfileSerializer < ActiveModel::Serializer
   attributes :name, :description
 
-  urls :posts, :comments
-
   def arguments_passed_in?
     options[:my_options] == :accessible
   end
@@ -63,13 +66,10 @@ end
 
 class ProfilePreviewSerializer < ActiveModel::Serializer
   attributes :name
-
-  urls :posts, :comments
 end
 
 Post     = Class.new(Model)
 Like     = Class.new(Model)
-Comment  = Class.new(Model)
 Author   = Class.new(Model)
 Bio      = Class.new(Model)
 Blog     = Class.new(Model)
@@ -77,21 +77,28 @@ Role     = Class.new(Model)
 User     = Class.new(Model)
 Location = Class.new(Model)
 Place    = Class.new(Model)
+Tag      = Class.new(Model)
+VirtualValue = Class.new(Model)
+Comment = Class.new(Model) do
+  # Uses a custom non-time-based cache key
+  def cache_key
+    "#{self.class.name.downcase}/#{self.id}"
+  end
+end
 
 module Spam; end
 Spam::UnrelatedLink = Class.new(Model)
 
 PostSerializer = Class.new(ActiveModel::Serializer) do
-  cache key:'post', expires_in: 0.1, skip_digest: true
+  cache key: 'post', expires_in: 0.1, skip_digest: true
   attributes :id, :title, :body
 
   has_many :comments
   belongs_to :blog
   belongs_to :author
-  url :comments
 
   def blog
-    Blog.new(id: 999, name: "Custom blog")
+    Blog.new(id: 999, name: 'Custom blog')
   end
 
   def custom_options
@@ -121,11 +128,12 @@ CommentSerializer = Class.new(ActiveModel::Serializer) do
 end
 
 AuthorSerializer = Class.new(ActiveModel::Serializer) do
-  cache key:'writer', skip_digest: true
-  attributes :id, :name
+  cache key: 'writer', skip_digest: true
+  attribute :id
+  attribute :name
 
-  has_many :posts, embed: :ids
-  has_many :roles, embed: :ids
+  has_many :posts
+  has_many :roles
   has_one :bio
 end
 
@@ -143,7 +151,7 @@ end
 LikeSerializer = Class.new(ActiveModel::Serializer) do
   attributes :id, :time
 
-  belongs_to :post
+  belongs_to :likeable
 end
 
 LocationSerializer = Class.new(ActiveModel::Serializer) do
@@ -219,12 +227,35 @@ PostPreviewSerializer = Class.new(ActiveModel::Serializer) do
   belongs_to :author, serializer: AuthorPreviewSerializer
 end
 
-Spam::UnrelatedLinkSerializer = Class.new(ActiveModel::Serializer) do
+PostWithTagsSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id
+
+  has_many :tags
+end
+
+PostWithCustomKeysSerializer = Class.new(ActiveModel::Serializer) do
   attributes :id
+
+  has_many :comments, key: :reviews
+  belongs_to :author, key: :writer
+  has_one :blog, key: :site
 end
 
-RaiseErrorSerializer = Class.new(ActiveModel::Serializer) do
-  def json_key
-    raise StandardError, 'Intentional error for rescue_from test'
+VirtualValueSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id
+
+  has_many :reviews, virtual_value: [{ id: 1 }, { id: 2 }]
+  has_one :maker, virtual_value: { id: 1 }
+
+  def reviews
+  end
+
+  def maker
   end
 end
+
+Spam::UnrelatedLinkSerializer = Class.new(ActiveModel::Serializer) do
+  cache only: [:id]
+  attributes :id
+end
+$VERBOSE = verbose

data/test/generators/scaffold_controller_generator_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-# require 'active_model/serializer/railtie'
 
 class ResourceGeneratorTest < Rails::Generators::TestCase
   destination File.expand_path('../../../tmp/generators', __FILE__)
@@ -19,6 +18,6 @@ class ResourceGeneratorTest < Rails::Generators::TestCase
   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 { }')
+    File.write(File.join(config_dir, 'routes.rb'), 'Rails.application.routes.draw {}')
   end
 end

data/test/generators/serializer_generator_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 require 'generators/serializer/serializer_generator'
 
 class SerializerGeneratorTest < Rails::Generators::TestCase
-  destination File.expand_path("../../../tmp/generators", __FILE__)
+  destination File.expand_path('../../../tmp/generators', __FILE__)
   setup :prepare_destination
 
   tests Rails::Generators::SerializerGenerator
@@ -10,42 +10,47 @@ class SerializerGeneratorTest < Rails::Generators::TestCase
 
   def test_generates_a_serializer
     run_generator
-    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ActiveModel::Serializer/
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ActiveModel::Serializer/
   end
 
   def test_generates_a_namespaced_serializer
-    run_generator ["admin/account"]
-    assert_file "app/serializers/admin/account_serializer.rb", /class Admin::AccountSerializer < ActiveModel::Serializer/
+    run_generator ['admin/account']
+    assert_file 'app/serializers/admin/account_serializer.rb', /class Admin::AccountSerializer < ActiveModel::Serializer/
   end
 
   def test_uses_application_serializer_if_one_exists
     Object.const_set(:ApplicationSerializer, Class.new)
     run_generator
-    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ApplicationSerializer/
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ApplicationSerializer/
   ensure
     Object.send :remove_const, :ApplicationSerializer
   end
 
   def test_uses_given_parent
     Object.const_set(:ApplicationSerializer, Class.new)
-    run_generator ["Account", "--parent=MySerializer"]
-    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < MySerializer/
+    run_generator ['Account', '--parent=MySerializer']
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < MySerializer/
   ensure
     Object.send :remove_const, :ApplicationSerializer
   end
 
   def test_generates_attributes_and_associations
     run_generator
-    assert_file "app/serializers/account_serializer.rb" do |serializer|
+    assert_file 'app/serializers/account_serializer.rb' do |serializer|
       assert_match(/^  attributes :id, :name, :description$/, serializer)
-      assert_match(/^  attribute :business$/, serializer)
+      assert_match(/^  has_one :business$/, serializer)
+      assert_match(/^end\n*\z/, serializer)
     end
   end
 
   def test_with_no_attributes_does_not_add_extra_space
-    run_generator ["account"]
-    assert_file "app/serializers/account_serializer.rb" do |content|
-      assert_no_match /\n\nend/, content
+    run_generator ['account']
+    assert_file 'app/serializers/account_serializer.rb' do |content|
+      if RUBY_PLATFORM =~ /mingw/
+        assert_no_match(/\r\n\r\nend/, content)
+      else
+        assert_no_match(/\n\nend/, content)
+      end
     end
   end
 end

data/test/lint_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class LintTest < Minitest::Test
+      include ActiveModel::Serializer::Lint::Tests
+
+      class CompliantResource
+        def serializable_hash(options = nil)
+        end
+
+        def read_attribute_for_serialization(name)
+        end
+
+        def as_json(options = nil)
+        end
+
+        def to_json(options = nil)
+        end
+
+        def cache_key
+        end
+
+        def id
+        end
+
+        def self.model_name
+          @_model_name ||= ActiveModel::Name.new(self)
+        end
+      end
+
+      def setup
+        @resource = CompliantResource.new
+      end
+    end
+  end
+end

data/test/logger_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class ActiveModelSerializers::LoggerTest < Minitest::Test
+  def test_logger_is_set_to_action_controller_logger_when_initializer_runs
+    assert_equal ActiveModelSerializers.logger, ActionController::Base.logger
+  end
+
+  def test_logger_can_be_set
+    original_logger = ActiveModelSerializers.logger
+    logger = Logger.new(STDOUT)
+
+    ActiveModelSerializers.logger = logger
+
+    assert_equal ActiveModelSerializers.logger, logger
+  ensure
+    ActiveModelSerializers.logger = original_logger
+  end
+end

data/test/poro_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class PoroTest < Minitest::Test
+  include ActiveModel::Serializer::Lint::Tests
+
+  def setup
+    @resource = Model.new
+  end
+end

data/test/serializable_resource_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+module ActiveModel
+  class SerializableResourceTest < Minitest::Test
+    def setup
+      @resource = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+      @serializer = ProfileSerializer.new(@resource)
+      @adapter = ActiveModel::Serializer::Adapter.create(@serializer)
+      @serializable_resource = ActiveModel::SerializableResource.new(@resource)
+    end
+
+    def test_serializable_resource_delegates_serializable_hash_to_the_adapter
+      options = nil
+      assert_equal @adapter.serializable_hash(options), @serializable_resource.serializable_hash(options)
+    end
+
+    def test_serializable_resource_delegates_to_json_to_the_adapter
+      options = nil
+      assert_equal @adapter.to_json(options), @serializable_resource.to_json(options)
+    end
+
+    def test_serializable_resource_delegates_as_json_to_the_adapter
+      options = nil
+      assert_equal @adapter.as_json(options), @serializable_resource.as_json(options)
+    end
+  end
+end

data/test/serializers/adapter_for_test.rb

@@ -1,8 +1,15 @@
 module ActiveModel
   class Serializer
     class AdapterForTest < Minitest::Test
+      UnknownAdapterError = ::ActiveModel::Serializer::Adapter::UnknownAdapterError
+
       def setup
         @previous_adapter = ActiveModel::Serializer.config.adapter
+        # Eager load adapters
+        ActiveModel::Serializer::Adapter.eager_load!
+        [:json_api, :flatten_json, :null, :json].each do |adapter_name|
+          ActiveModel::Serializer::Adapter.lookup(adapter_name)
+        end
       end
 
       def teardown
@@ -20,7 +27,7 @@ module ActiveModel
         adapter = ActiveModel::Serializer.adapter
         assert_equal ActiveModel::Serializer::Adapter::Null, adapter
       ensure
-
+        ActiveModel::Serializer.config.adapter = @previous_adapter
       end
 
       def test_overwrite_adapter_with_class
@@ -33,7 +40,7 @@ module ActiveModel
       def test_raises_exception_if_invalid_symbol_given
         ActiveModel::Serializer.config.adapter = :unknown
 
-        assert_raises ArgumentError do
+        assert_raises UnknownAdapterError do
           ActiveModel::Serializer.adapter
         end
       end
@@ -41,10 +48,123 @@ module ActiveModel
       def test_raises_exception_if_it_does_not_know_hot_to_infer_adapter
         ActiveModel::Serializer.config.adapter = 42
 
-        assert_raises ArgumentError do
+        assert_raises UnknownAdapterError do
           ActiveModel::Serializer.adapter
         end
       end
+
+      def test_adapter_class_for_known_adapter
+        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_api)
+        assert_equal ActiveModel::Serializer::Adapter::JsonApi, klass
+      end
+
+      def test_adapter_class_for_unknown_adapter
+        assert_raises UnknownAdapterError do
+          ActiveModel::Serializer::Adapter.adapter_class(:json_simple)
+        end
+      end
+
+      def test_adapter_map
+        expected_adapter_map = {
+          'json'.freeze              => ActiveModel::Serializer::Adapter::Json,
+          'json_api'.freeze          => ActiveModel::Serializer::Adapter::JsonApi,
+          'flatten_json'.freeze      => ActiveModel::Serializer::Adapter::FlattenJson,
+          'null'.freeze              => ActiveModel::Serializer::Adapter::Null
+        }
+        assert_equal ActiveModel::Serializer::Adapter.adapter_map, expected_adapter_map
+      end
+
+      def test_adapters
+        assert_equal ActiveModel::Serializer::Adapter.adapters.sort, [
+          'flatten_json'.freeze,
+          'json'.freeze,
+          'json_api'.freeze,
+          'null'.freeze
+        ]
+      end
+
+      def test_lookup_adapter_by_string_name
+        assert_equal ActiveModel::Serializer::Adapter.lookup('json'.freeze), ActiveModel::Serializer::Adapter::Json
+      end
+
+      def test_lookup_adapter_by_symbol_name
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:json), ActiveModel::Serializer::Adapter::Json
+      end
+
+      def test_lookup_adapter_by_class
+        klass = ActiveModel::Serializer::Adapter::Json
+        assert_equal ActiveModel::Serializer::Adapter.lookup(klass), klass
+      end
+
+      def test_lookup_adapter_from_environment_registers_adapter
+        ActiveModel::Serializer::Adapter.const_set(:AdapterFromEnvironment, Class.new)
+        klass = ::ActiveModel::Serializer::Adapter::AdapterFromEnvironment
+        name = 'adapter_from_environment'.freeze
+        assert_equal ActiveModel::Serializer::Adapter.lookup(name), klass
+        assert ActiveModel::Serializer::Adapter.adapters.include?(name)
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete(name)
+        ActiveModel::Serializer::Adapter.send(:remove_const, :AdapterFromEnvironment)
+      end
+
+      def test_lookup_adapter_for_unknown_name
+        assert_raises UnknownAdapterError do
+          ActiveModel::Serializer::Adapter.lookup(:json_simple)
+        end
+      end
+
+      def test_adapter
+        assert_equal ActiveModel::Serializer.config.adapter, :flatten_json
+        assert_equal ActiveModel::Serializer.adapter, ActiveModel::Serializer::Adapter::FlattenJson
+      end
+
+      def test_register_adapter
+        new_adapter_name  = :foo
+        new_adapter_klass = Class.new
+        ActiveModel::Serializer::Adapter.register(new_adapter_name, new_adapter_klass)
+        assert ActiveModel::Serializer::Adapter.adapters.include?('foo'.freeze)
+        assert ActiveModel::Serializer::Adapter.lookup(:foo), new_adapter_klass
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete(new_adapter_name.to_s)
+      end
+
+      def test_inherited_adapter_hooks_register_adapter
+        Object.const_set(:MyAdapter, Class.new)
+        my_adapter = MyAdapter
+        ActiveModel::Serializer::Adapter.inherited(my_adapter)
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
+        Object.send(:remove_const, :MyAdapter)
+      end
+
+      def test_inherited_adapter_hooks_register_demodulized_adapter
+        Object.const_set(:MyNamespace, Module.new)
+        MyNamespace.const_set(:MyAdapter, Class.new)
+        my_adapter = MyNamespace::MyAdapter
+        ActiveModel::Serializer::Adapter.inherited(my_adapter)
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
+        MyNamespace.send(:remove_const, :MyAdapter)
+        Object.send(:remove_const, :MyNamespace)
+      end
+
+      def test_inherited_adapter_hooks_register_subclass_of_registered_adapter
+        Object.const_set(:MyAdapter, Class.new)
+        my_adapter = MyAdapter
+        Object.const_set(:MySubclassedAdapter, Class.new(MyAdapter))
+        my_subclassed_adapter = MySubclassedAdapter
+        ActiveModel::Serializer::Adapter.inherited(my_adapter)
+        ActiveModel::Serializer::Adapter.inherited(my_subclassed_adapter)
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
+        assert_equal ActiveModel::Serializer::Adapter.lookup(:my_subclassed_adapter), my_subclassed_adapter
+      ensure
+        ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
+        ActiveModel::Serializer::Adapter.adapter_map.delete('my_subclassed_adapter'.freeze)
+        Object.send(:remove_const, :MyAdapter)
+        Object.send(:remove_const, :MySubclassedAdapter)
+      end
     end
   end
 end