Rename Builder to SerializableResource per discussion

Author: bf4

lib/action_controller/serialization.rb

@@ -7,7 +7,7 @@ module Serialization
     include ActionController::Renderers
 
     # Deprecated
-    ADAPTER_OPTION_KEYS = ActiveModel::Serializer::Builder::ADAPTER_OPTION_KEYS
+    ADAPTER_OPTION_KEYS = ActiveModel::SerializableResource::ADAPTER_OPTION_KEYS
 
     included do
       class_attribute :_serialization_scope
@@ -22,15 +22,15 @@ def serialization_scope
     def get_serializer(resource, options = {})
       if ! use_adapter?
         warn "ActionController::Serialization#use_adapter? has been removed. "\
-          "Please pass 'adapter: false' or see ActiveSupport::Serializer.build"
+          "Please pass 'adapter: false' or see ActiveSupport::SerializableResource#serialize"
         options[:adapter] = false
       end
-      serializable_resource = ActiveModel::Serializer::build(resource, options) do |builder|
-        if builder.serializer?
-          builder.serialization_scope ||= serialization_scope
-          builder.serialization_scope_name = _serialization_scope
+      ActiveModel::SerializableResource.serialize(resource, options) do |serializable_resource|
+        if serializable_resource.serializer?
+          serializable_resource.serialization_scope ||= serialization_scope
+          serializable_resource.serialization_scope_name = _serialization_scope
           begin
-            builder.adapter
+            serializable_resource.adapter
           rescue ActiveModel::Serializer::ArraySerializer::NoSerializerError
             resource
           end

lib/active_model/serializable_resource.rb

@@ -0,0 +1,80 @@
+require "set"
+module ActiveModel
+  class SerializableResource
+
+    ADAPTER_OPTION_KEYS = Set.new([:include, :fields, :adapter])
+
+    def initialize(resource, options = {})
+      @resource = resource
+      @adapter_opts, @serializer_opts =
+        options.partition { |k, _| ADAPTER_OPTION_KEYS.include? k }.map { |h| Hash[h] }
+    end
+
+    delegate :serializable_hash, :as_json, :to_json, to: :adapter
+
+    # Primary interface to building a serializer (with adapter)
+    # If no block is given, returns the builder, ready for #as_json/#to_json/#serializable_hash
+    # Otherwise, yields the builder and returns the contents of the block
+    def self.serialize(resource, options = {})
+      serializable_resource = SerializableResource.new(resource, options)
+      if block_given?
+        yield serializable_resource
+      else
+        serializable_resource
+      end
+    end
+
+    def serialization_scope=(scope)
+      serializer_opts[:scope] = scope
+    end
+
+    def serialization_scope
+      serializer_opts[:scope]
+    end
+
+    def serialization_scope_name=(scope_name)
+      serializer_opts[:scope_name] = scope_name
+    end
+
+    def adapter
+      @adapter ||= ActiveModel::Serializer::Adapter.create(serializer_instance, adapter_opts)
+    end
+    alias_method :adapter_instance, :adapter
+
+    def serializer_instance
+      @serializer_instance ||= serializer.new(resource, serializer_opts)
+    end
+
+    # Get serializer either explicitly :serializer or implicitly from resource
+    # Remove :serializer key from serializer_opts
+    # Replace :serializer key with :each_serializer if present
+    def serializer
+      @serializer ||=
+        begin
+          @serializer = serializer_opts.delete(:serializer)
+          @serializer ||= ActiveModel::Serializer.serializer_for(resource)
+
+          if serializer_opts.key?(:each_serializer)
+            serializer_opts[:serializer] = serializer_opts.delete(:each_serializer)
+          end
+          @serializer
+        end
+    end
+    alias_method :serializer_class, :serializer
+
+    # True when no explicit adapter given, or explicit appear is truthy (non-nil)
+    # False when explicit adapter is falsy (nil or false)
+    def use_adapter?
+      !(adapter_opts.key?(:adapter) && !adapter_opts[:adapter])
+    end
+
+    def serializer?
+      use_adapter? && !!(serializer)
+    end
+
+    private
+
+    attr_reader :resource, :adapter_opts, :serializer_opts
+
+  end
+end

lib/active_model/serializer.rb

@@ -6,7 +6,6 @@ class Serializer
     autoload :Configuration
     autoload :ArraySerializer
     autoload :Adapter
-    autoload :Builder
     include Configuration
 
     class << self
@@ -32,18 +31,6 @@ def self.inherited(base)
       base._cache_digest = Digest::MD5.hexdigest(serializer_file.read)
     end
 
-    # Primary interface to building a serializer (with adapter)
-    # If no block is given, returns the builder, ready for #as_json/#to_json/#serializable_hash
-    # Otherwise, yields the builder and returns the contents of the block
-    def self.build(resource, options = {})
-      builder = Builder.new(resource, options)
-      if block_given?
-        yield builder
-     else
-        builder
-      end
-    end
-
     def self.attributes(*attrs)
       attrs = attrs.first if attrs.first.class == Array
       @_attributes.concat attrs

lib/active_model/serializer/builder.rb

@@ -3,6 +3,7 @@
 require 'active_model/serializer'
 require 'active_model/serializer/fieldset'
 require 'active_model/serializer/railtie'
+require 'active_model/serializable_resource'
 
 begin
   require 'action_controller'

lib/active_model_serializers.rb

@@ -121,7 +121,7 @@ def render_fragment_changed_object_with_relationship
 
         private
         def generate_cached_serializer(obj)
-          ActiveModel::Serializer.build(obj).to_json
+          ActiveModel::SerializableResource.new(obj).to_json
         end
 
         def with_adapter(adapter)

test/action_controller/serialization_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

test/serializable_resource_test.rb

@@ -127,7 +127,7 @@ def _cache_digest_definition
 
       private
       def render_object_with_cache(obj)
-        ActiveModel::Serializer.build(obj).serializable_hash
+        ActiveModel::SerializableResource.new(obj).serializable_hash
       end
     end
   end

test/serializer_builder_test.rb

@@ -100,7 +100,7 @@ def test_meta_is_present_on_arrays_with_root
 
       def load_adapter(options)
         options = options.merge(adapter: :flatten_json, serializer: AlternateBlogSerializer)
-        ActiveModel::Serializer.build(@blog, options)
+        ActiveModel::SerializableResource.new(@blog, options)
       end
     end
   end