Skip to content

Commit

Permalink
Introduce Adapter::Base
Browse files Browse the repository at this point in the history
  • Loading branch information
bf4 committed Sep 18, 2015
1 parent 7c82258 commit 32a1a16
Show file tree
Hide file tree
Showing 29 changed files with 109 additions and 99 deletions.
80 changes: 16 additions & 64 deletions lib/active_model/serializer/adapter.rb
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
module ActiveModel
class Serializer
class Adapter
module Adapter
UnknownAdapterError = Class.new(ArgumentError)
ADAPTER_MAP = {}
private_constant :ADAPTER_MAP if defined?(private_constant)
require 'active_model/serializer/adapter/fragment_cache'
require 'active_model/serializer/adapter/cached_serializer'

def self.create(resource, options = {})
override = options.delete(:adapter)
klass = override ? adapter_class(override) : ActiveModel::Serializer.adapter
klass.new(resource, options)
end
class << self # All methods are class functions
def new(*args)
fail ArgumentError, [args, caller[0]].inspect
end

# @see ActiveModel::Serializer::Adapter.lookup
def self.adapter_class(adapter)
ActiveModel::Serializer::Adapter.lookup(adapter)
end
def create(resource, options = {})
override = options.delete(:adapter)
klass = override ? adapter_class(override) : ActiveModel::Serializer.adapter
klass.new(resource, options)
end

# @see ActiveModel::Serializer::Adapter.lookup
def adapter_class(adapter)
ActiveModel::Serializer::Adapter.lookup(adapter)
end

# Only the Adapter class has these methods.
# None of the sublasses have them.
class << ActiveModel::Serializer::Adapter
# @return Hash<adapter_name, adapter_class>
def adapter_map
ADAPTER_MAP
Expand Down Expand Up @@ -76,58 +78,8 @@ def find_by_name(adapter_name)
private :find_by_name
end

# Automatically register adapters when subclassing
def self.inherited(subclass)
ActiveModel::Serializer::Adapter.register(subclass)
end

attr_reader :serializer, :instance_options

def initialize(serializer, options = {})
@serializer = serializer
@instance_options = options
end

def serializable_hash(options = nil)
raise NotImplementedError, 'This is an abstract method. Should be implemented at the concrete adapter.'
end

def as_json(options = nil)
hash = serializable_hash(options)
include_meta(hash)
hash
end

def fragment_cache(*args)
raise NotImplementedError, 'This is an abstract method. Should be implemented at the concrete adapter.'
end

def cache_check(serializer)
CachedSerializer.new(serializer).cache_check(self) do
yield
end
end

private

def meta
serializer.meta if serializer.respond_to?(:meta)
end

def meta_key
serializer.meta_key || 'meta'.freeze
end

def root
serializer.json_key.to_sym if serializer.json_key
end

def include_meta(json)
json[meta_key] = meta if meta
json
end

# Gotta be at the bottom to use the code above it :(
require 'active_model/serializer/adapter/base'
require 'active_model/serializer/adapter/null'
require 'active_model/serializer/adapter/attributes'
require 'active_model/serializer/adapter/json'
Expand Down
4 changes: 2 additions & 2 deletions lib/active_model/serializer/adapter/attributes.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module ActiveModel
class Serializer
class Adapter
class Attributes < Adapter
module Adapter
class Attributes < Base
def serializable_hash(options = nil)
options ||= {}
if serializer.respond_to?(:each)
Expand Down
58 changes: 58 additions & 0 deletions lib/active_model/serializer/adapter/base.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
module ActiveModel
class Serializer
module Adapter
class Base
# Automatically register adapters when subclassing
def self.inherited(subclass)
ActiveModel::Serializer::Adapter.register(subclass)
end

attr_reader :serializer, :instance_options

def initialize(serializer, options = {})
@serializer = serializer
@instance_options = options
end

def serializable_hash(_options = nil)
fail NotImplementedError, 'This is an abstract method. Should be implemented at the concrete adapter.'
end

def as_json(options = nil)
hash = serializable_hash(options)
include_meta(hash)
hash
end

def fragment_cache(*_args)
fail NotImplementedError, 'This is an abstract method. Should be implemented at the concrete adapter.'
end

def cache_check(serializer)
CachedSerializer.new(serializer).cache_check(self) do
yield
end
end

private

def meta
serializer.meta if serializer.respond_to?(:meta)
end

def meta_key
serializer.meta_key || 'meta'.freeze
end

def root
serializer.json_key.to_sym if serializer.json_key
end

def include_meta(json)
json[meta_key] = meta if meta
json
end
end
end
end
end
2 changes: 1 addition & 1 deletion lib/active_model/serializer/adapter/cached_serializer.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module ActiveModel
class Serializer
class Adapter
module Adapter
class CachedSerializer
def initialize(serializer)
@cached_serializer = serializer
Expand Down
2 changes: 1 addition & 1 deletion lib/active_model/serializer/adapter/fragment_cache.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module ActiveModel
class Serializer
class Adapter
module Adapter
class FragmentCache
attr_reader :serializer

Expand Down
4 changes: 2 additions & 2 deletions lib/active_model/serializer/adapter/json.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module ActiveModel
class Serializer
class Adapter
class Json < Adapter
module Adapter
class Json < Base
extend ActiveSupport::Autoload
autoload :FragmentCache

Expand Down
2 changes: 1 addition & 1 deletion lib/active_model/serializer/adapter/json/fragment_cache.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module ActiveModel
class Serializer
class Adapter
module Adapter
class Json
class FragmentCache
def fragment_cache(cached_hash, non_cached_hash)
Expand Down
4 changes: 2 additions & 2 deletions lib/active_model/serializer/adapter/json_api.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module ActiveModel
class Serializer
class Adapter
class JsonApi < Adapter
module Adapter
class JsonApi < Base
extend ActiveSupport::Autoload
autoload :PaginationLinks
autoload :FragmentCache
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class FragmentCache
def fragment_cache(root, cached_hash, non_cached_hash)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module ActiveModel
class Serializer
class Adapter
class JsonApi < Adapter
module Adapter
class JsonApi < Base
class PaginationLinks
FIRST_PAGE = 1

Expand Down
4 changes: 2 additions & 2 deletions lib/active_model/serializer/adapter/null.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module ActiveModel
class Serializer
class Adapter
class Null < Adapter
module Adapter
class Null < Base
def serializable_hash(options = nil)
{}
end
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/fragment_cache_test.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class FragmentCacheTest < Minitest::Test
def setup
@spam = Spam::UnrelatedLink.new(id: 'spam-id-1')
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json/belongs_to_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class Json
class BelongsToTest < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json/collection_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class Json
class Collection < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json/has_many_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class Json
class HasManyTestTest < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/belongs_to_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class BelongsToTest < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/collection_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class CollectionTest < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/has_many_embed_ids_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class HasManyEmbedIdsTest < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/has_many_explicit_serializer_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
# Test 'has_many :assocs, serializer: AssocXSerializer'
class HasManyExplicitSerializerTest < Minitest::Test
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/has_many_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class HasManyTest < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/has_one_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class HasOneTest < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/json_api_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApiTest < Minitest::Test
def setup
ActionController::Base.cache_store.clear
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/linked_test.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class LinkedTest < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/pagination_links_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class PaginationLinksTest < Minitest::Test
URI = 'http://example.com'
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_api/resource_type_config_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class ResourceTypeConfigTest < Minitest::Test
def setup
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/json_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonTest < Minitest::Test
def setup
ActionController::Base.cache_store.clear
Expand Down
2 changes: 1 addition & 1 deletion test/adapter/null_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActiveModel
class Serializer
class Adapter
module Adapter
class NullTest < Minitest::Test
def setup
profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
Expand Down
2 changes: 1 addition & 1 deletion test/adapter_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ class AdapterTest < Minitest::Test
def setup
profile = Profile.new
@serializer = ProfileSerializer.new(profile)
@adapter = ActiveModel::Serializer::Adapter.new(@serializer)
@adapter = ActiveModel::Serializer::Adapter::Base.new(@serializer)
end

def test_serializable_hash_is_abstract_method
Expand Down
Loading

0 comments on commit 32a1a16

Please sign in to comment.