From a40df8fd3d22d3dcdde7dc454c59e9c2b85720d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Moura?= Date: Wed, 27 May 2015 18:33:12 -0300 Subject: [PATCH] reverting PR #909 and adding json api usage advise on readme --- README.md | 8 ++++---- lib/active_model/serializer/configuration.rb | 2 +- test/action_controller/adapter_selector_test.rb | 4 ++-- test/fixtures/poro.rb | 4 +--- 4 files changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5d4cd6c43..8e6226da4 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ AMS does this through two components: **serializers** and **adapters**. Serializers describe _which_ attributes and relationships should be serialized. Adapters describe _how_ attributes and relationships should be serialized. -By default AMS will use the JsonApi Adapter that follows RC4 of the format specified in [jsonapi.org/format](http://jsonapi.org/format). +By default AMS will use the **Json Adapter**. But we strongly advise you to use JsonApi Adapter that follows RC4 of the format specified in [jsonapi.org/format](http://jsonapi.org/format). Check how to change the adapter in the sections bellow. # RELEASE CANDIDATE, PLEASE READ @@ -50,17 +50,17 @@ end ``` Generally speaking, you as a user of AMS will write (or generate) these -serializer classes. If you want to use a different adapter, such as a normal Json adapter without the JsonApi conventions, you can +serializer classes. If you want to use a different adapter, such as a JsonApi, you can change this in an initializer: ```ruby -ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::Json +ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::JsonApi ``` or ```ruby -ActiveModel::Serializer.config.adapter = :json +ActiveModel::Serializer.config.adapter = :json_api ``` You won't need to implement an adapter unless you wish to use a new format or diff --git a/lib/active_model/serializer/configuration.rb b/lib/active_model/serializer/configuration.rb index b46cf8a54..ef57262c4 100644 --- a/lib/active_model/serializer/configuration.rb +++ b/lib/active_model/serializer/configuration.rb @@ -6,7 +6,7 @@ module Configuration included do |base| base.config.array_serializer = ActiveModel::Serializer::ArraySerializer - base.config.adapter = :json_api + base.config.adapter = :json end end end diff --git a/test/action_controller/adapter_selector_test.rb b/test/action_controller/adapter_selector_test.rb index 1ff03cf24..ce90daf83 100644 --- a/test/action_controller/adapter_selector_test.rb +++ b/test/action_controller/adapter_selector_test.rb @@ -4,7 +4,7 @@ module ActionController module Serialization class AdapterSelectorTest < ActionController::TestCase class MyController < ActionController::Base - def render_using_the_initializer_defined_adapter + def render_using_default_adapter @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }) render json: @profile end @@ -23,7 +23,7 @@ def render_skipping_adapter tests MyController def test_render_using_default_adapter - get :render_using_the_initializer_defined_adapter + get :render_using_default_adapter assert_equal '{"name":"Name 1","description":"Description 1"}', response.body end diff --git a/test/fixtures/poro.rb b/test/fixtures/poro.rb index c21d8344a..8fca91d69 100644 --- a/test/fixtures/poro.rb +++ b/test/fixtures/poro.rb @@ -1,5 +1,3 @@ -ActiveModel::Serializer.config.adapter = :json - class Model def initialize(hash={}) @attributes = hash @@ -66,7 +64,7 @@ class ProfilePreviewSerializer < ActiveModel::Serializer 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)