active_model_serializers 0.8.3 → 0.10.0.rc5

data/lib/active_model/serializer.rb

@@ -1,515 +1,190 @@
-require "active_support/core_ext/class/attribute"
-require "active_support/core_ext/module/anonymous"
-require 'active_support/dependencies'
-require 'active_support/descendants_tracker'
-
+require 'thread_safe'
+require 'active_model/serializer/collection_serializer'
+require 'active_model/serializer/array_serializer'
+require 'active_model/serializer/error_serializer'
+require 'active_model/serializer/errors_serializer'
+require 'active_model/serializer/include_tree'
+require 'active_model/serializer/associations'
+require 'active_model/serializer/attributes'
+require 'active_model/serializer/caching'
+require 'active_model/serializer/configuration'
+require 'active_model/serializer/fieldset'
+require 'active_model/serializer/lint'
+require 'active_model/serializer/links'
+require 'active_model/serializer/meta'
+require 'active_model/serializer/type'
+
+# ActiveModel::Serializer is an abstract class that is
+# reified when subclassed to decorate a resource.
 module ActiveModel
-  # Active Model Serializer
-  #
-  # Provides a basic serializer implementation that allows you to easily
-  # control how a given object is going to be serialized. On initialization,
-  # it expects two objects as arguments, a resource and options. For example,
-  # one may do in a controller:
-  #
-  #     PostSerializer.new(@post, :scope => current_user).to_json
-  #
-  # The object to be serialized is the +@post+ and the current user is passed
-  # in for authorization purposes.
-  #
-  # We use the scope to check if a given attribute should be serialized or not.
-  # For example, some attributes may only be returned if +current_user+ is the
-  # author of the post:
-  #
-  #     class PostSerializer < ActiveModel::Serializer
-  #       attributes :title, :body
-  #       has_many :comments
-  #
-  #       private
-  #
-  #       def attributes
-  #         hash = super
-  #         hash.merge!(:email => post.email) if author?
-  #         hash
-  #       end
-  #
-  #       def author?
-  #         post.author == scope
-  #       end
-  #     end
-  #
   class Serializer
-    extend ActiveSupport::DescendantsTracker
-
-    INCLUDE_METHODS = {}
-    INSTRUMENT = { :serialize => :"serialize.serializer", :associations => :"associations.serializer" }
-
-    class IncludeError < StandardError
-      attr_reader :source, :association
-
-      def initialize(source, association)
-        @source, @association = source, association
-      end
-
-      def to_s
-        "Cannot serialize #{association} when #{source} does not have a root!"
+    extend ActiveSupport::Autoload
+    autoload :Adapter
+    autoload :Null
+    include Configuration
+    include Associations
+    include Attributes
+    include Caching
+    include Links
+    include Meta
+    include Type
+
+    # @param resource [ActiveRecord::Base, ActiveModelSerializers::Model]
+    # @return [ActiveModel::Serializer]
+    #   Preferentially returns
+    #   1. resource.serializer
+    #   2. ArraySerializer when resource is a collection
+    #   3. options[:serializer]
+    #   4. lookup serializer when resource is a Class
+    def self.serializer_for(resource, options = {})
+      if resource.respond_to?(:serializer_class)
+        resource.serializer_class
+      elsif resource.respond_to?(:to_ary)
+        config.collection_serializer
+      else
+        options.fetch(:serializer) { get_serializer_for(resource.class) }
       end
     end
 
-    class_attribute :_attributes
-    self._attributes = {}
-
-    class_attribute :_associations
-    self._associations = {}
-
-    class_attribute :_root
-    class_attribute :_embed
-    self._embed = :objects
-    class_attribute :_root_embed
-
-    class_attribute :cache
-    class_attribute :perform_caching
-
-    class << self
-      # set perform caching like root
-      def cached(value = true)
-        self.perform_caching = value
-      end
-
-      # Define attributes to be used in the serialization.
-      def attributes(*attrs)
-
-        self._attributes = _attributes.dup
-
-        attrs.each do |attr|
-          if Hash === attr
-            attr.each {|attr_real, key| attribute attr_real, :key => key }
-          else
-            attribute attr
-          end
-        end
-      end
-
-      def attribute(attr, options={})
-        self._attributes = _attributes.merge(attr.is_a?(Hash) ? attr : {attr => options[:key] || attr.to_s.gsub(/\?$/, '').to_sym})
-
-        attr = attr.keys[0] if attr.is_a? Hash
-
-        unless method_defined?(attr)
-          define_method attr do
-            object.read_attribute_for_serialization(attr.to_sym)
-          end
-        end
-
-        define_include_method attr
-
-        # protect inheritance chains and open classes
-        # if a serializer inherits from another OR
-        #  attributes are added later in a classes lifecycle
-        # poison the cache
-        define_method :_fast_attributes do
-          raise NameError
-        end
-
-      end
-
-      def associate(klass, attrs) #:nodoc:
-        options = attrs.extract_options!
-        self._associations = _associations.dup
-
-        attrs.each do |attr|
-          unless method_defined?(attr)
-            define_method attr do
-              object.send attr
-            end
-          end
-
-          define_include_method attr
-
-          self._associations[attr] = klass.refine(attr, options)
-        end
-      end
-
-      def define_include_method(name)
-        method = "include_#{name}?".to_sym
-
-        INCLUDE_METHODS[name] = method
-
-        unless method_defined?(method)
-          define_method method do
-            true
-          end
-        end
-      end
-
-      # Defines an association in the object should be rendered.
-      #
-      # The serializer object should implement the association name
-      # as a method which should return an array when invoked. If a method
-      # with the association name does not exist, the association name is
-      # dispatched to the serialized object.
-      def has_many(*attrs)
-        associate(Associations::HasMany, attrs)
-      end
-
-      # Defines an association in the object should be rendered.
-      #
-      # The serializer object should implement the association name
-      # as a method which should return an object when invoked. If a method
-      # with the association name does not exist, the association name is
-      # dispatched to the serialized object.
-      def has_one(*attrs)
-        associate(Associations::HasOne, attrs)
-      end
-
-      # Return a schema hash for the current serializer. This information
-      # can be used to generate clients for the serialized output.
-      #
-      # The schema hash has two keys: +attributes+ and +associations+.
-      #
-      # The +attributes+ hash looks like this:
-      #
-      #     { :name => :string, :age => :integer }
-      #
-      # The +associations+ hash looks like this:
-      #     { :posts => { :has_many => :posts } }
-      #
-      # If :key is used:
-      #
-      #     class PostsSerializer < ActiveModel::Serializer
-      #       has_many :posts, :key => :my_posts
-      #     end
-      #
-      # the hash looks like this:
-      #
-      #     { :my_posts => { :has_many => :posts }
-      #
-      # This information is extracted from the serializer's model class,
-      # which is provided by +SerializerClass.model_class+.
-      #
-      # The schema method uses the +columns_hash+ and +reflect_on_association+
-      # methods, provided by default by ActiveRecord. You can implement these
-      # methods on your custom models if you want the serializer's schema method
-      # to work.
-      #
-      # TODO: This is currently coupled to Active Record. We need to
-      # figure out a way to decouple those two.
-      def schema
-        klass = model_class
-        columns = klass.columns_hash
-
-        attrs = {}
-        _attributes.each do |name, key|
-          if column = columns[name.to_s]
-            attrs[key] = column.type
-          else
-            # Computed attribute (method on serializer or model). We cannot
-            # infer the type, so we put nil, unless specified in the attribute declaration
-            if name != key
-              attrs[name] = key
-            else
-              attrs[key] = nil
-            end
-          end
-        end
-
-        associations = {}
-        _associations.each do |attr, association_class|
-          association = association_class.new(attr, self)
-
-          if model_association = klass.reflect_on_association(association.name)
-            # Real association.
-            associations[association.key] = { model_association.macro => model_association.name }
-          else
-            # Computed association. We could infer has_many vs. has_one from
-            # the association class, but that would make it different from
-            # real associations, which read has_one vs. belongs_to from the
-            # model.
-            associations[association.key] = nil
-          end
-        end
-
-        { :attributes => attrs, :associations => associations }
-      end
-
-      # The model class associated with this serializer.
-      def model_class
-        name.sub(/Serializer$/, '').constantize
-      end
-
-      # Define how associations should be embedded.
-      #
-      #   embed :objects               # Embed associations as full objects
-      #   embed :ids                   # Embed only the association ids
-      #   embed :ids, :include => true # Embed the association ids and include objects in the root
-      #
-      def embed(type, options={})
-        self._embed = type
-        self._root_embed = true if options[:include]
-      end
-
-      # Defines the root used on serialization. If false, disables the root.
-      def root(name)
-        self._root = name
-      end
-      alias_method :root=, :root
-
-      # Used internally to create a new serializer object based on controller
-      # settings and options for a given resource. These settings are typically
-      # set during the request lifecycle or by the controller class, and should
-      # not be manually defined for this method.
-      def build_json(controller, resource, options)
-        default_options = controller.send(:default_serializer_options) || {}
-        options = default_options.merge(options || {})
-
-        serializer = options.delete(:serializer) ||
-          (resource.respond_to?(:active_model_serializer) &&
-           resource.active_model_serializer)
-
-        return serializer unless serializer
-
-        if resource.respond_to?(:to_ary)
-          unless serializer <= ActiveModel::ArraySerializer
-            raise ArgumentError.new("#{serializer.name} is not an ArraySerializer. " +
-                                    "You may want to use the :each_serializer option instead.")
-          end
-
-          if options[:root] != false && serializer.root != false
-            # the serializer for an Array is ActiveModel::ArraySerializer
-            options[:root] ||= serializer.root || controller.controller_name
-          end
-        end
-
-        options[:scope] = controller.serialization_scope unless options.has_key?(:scope)
-        options[:scope_name] = controller._serialization_scope
-        options[:url_options] = controller.url_options
-
-        serializer.new(resource, options)
-      end
+    # @see ActiveModelSerializers::Adapter.lookup
+    # Deprecated
+    def self.adapter
+      ActiveModelSerializers::Adapter.lookup(config.adapter)
     end
-
-    attr_reader :object, :options
-
-    def initialize(object, options={})
-      @object, @options = object, options
-
-      scope_name = @options[:scope_name]
-      if scope_name && !respond_to?(scope_name)
-        self.class.class_eval do
-          define_method scope_name, lambda { scope }
-        end
-      end
+    class << self
+      extend ActiveModelSerializers::Deprecate
+      deprecate :adapter, 'ActiveModelSerializers::Adapter.configured_adapter'
     end
 
-    def root_name
-      return false if self._root == false
+    # @api private
+    def self.serializer_lookup_chain_for(klass)
+      chain = []
 
-      class_name = self.class.name.demodulize.underscore.sub(/_serializer$/, '').to_sym unless self.class.name.blank?
+      resource_class_name = klass.name.demodulize
+      resource_namespace = klass.name.deconstantize
+      serializer_class_name = "#{resource_class_name}Serializer"
 
-      if self._root == true
-        class_name
-      else
-        self._root || class_name
-      end
-    end
+      chain.push("#{name}::#{serializer_class_name}") if self != ActiveModel::Serializer
+      chain.push("#{resource_namespace}::#{serializer_class_name}")
 
-    def url_options
-      @options[:url_options] || {}
+      chain
     end
 
-    def meta_key
-      @options[:meta_key].try(:to_sym) || :meta
+    # Used to cache serializer name => serializer class
+    # when looked up by Serializer.get_serializer_for.
+    def self.serializers_cache
+      @serializers_cache ||= ThreadSafe::Cache.new
     end
 
-    def include_meta(hash)
-      hash[meta_key] = @options[:meta] if @options.has_key?(:meta)
-    end
+    # @api private
+    # Find a serializer from a class and caches the lookup.
+    # Preferentially returns:
+    #   1. class name appended with "Serializer"
+    #   2. try again with superclass, if present
+    #   3. nil
+    def self.get_serializer_for(klass)
+      return nil unless config.serializer_lookup_enabled
+      serializers_cache.fetch_or_store(klass) do
+        # NOTE(beauby): When we drop 1.9.3 support we can lazify the map for perfs.
+        serializer_class = serializer_lookup_chain_for(klass).map(&:safe_constantize).find { |x| x && x < ActiveModel::Serializer }
 
-    def to_json(*args)
-      if perform_caching?
-        cache.fetch expand_cache_key([self.class.to_s.underscore, cache_key, 'to-json']) do
-          super
+        if serializer_class
+          serializer_class
+        elsif klass.superclass
+          get_serializer_for(klass.superclass)
         end
-      else
-        super
       end
     end
 
-    # Returns a json representation of the serializable
-    # object including the root.
-    def as_json(options={})
-      options ||= {}
-      if root = options.fetch(:root, @options.fetch(:root, root_name))
-        @options[:hash] = hash = {}
-        @options[:unique_values] = {}
-
-        hash.merge!(root => serializable_hash)
-        include_meta hash
-        hash
-      else
-        serializable_hash
-      end
-    end
+    attr_accessor :object, :root, :scope
 
-    # Returns a hash representation of the serializable
-    # object without the root.
-    def serializable_hash
-      if perform_caching?
-        cache.fetch expand_cache_key([self.class.to_s.underscore, cache_key, 'serializable-hash']) do
-          _serializable_hash
-        end
-      else
-        _serializable_hash
-      end
-    end
+    # `scope_name` is set as :current_user by default in the controller.
+    # If the instance does not have a method named `scope_name`, it
+    # defines the method so that it calls the +scope+.
+    def initialize(object, options = {})
+      self.object = object
+      self.instance_options = options
+      self.root = instance_options[:root]
+      self.scope = instance_options[:scope]
 
-    def include_associations!
-      _associations.each_key do |name|
-        include!(name) if include?(name)
+      scope_name = instance_options[:scope_name]
+      if scope_name && !respond_to?(scope_name)
+        define_singleton_method scope_name, lambda { scope }
       end
     end
 
-    def include?(name)
-      return false if @options.key?(:only) && !Array(@options[:only]).include?(name)
-      return false if @options.key?(:except) && Array(@options[:except]).include?(name)
-      send INCLUDE_METHODS[name]
-    end
-
-    def include!(name, options={})
-      # Make sure that if a special options[:hash] was passed in, we generate
-      # a new unique values hash and don't clobber the original. If the hash
-      # passed in is the same as the current options hash, use the current
-      # unique values.
-      #
-      # TODO: Should passing in a Hash even be public API here?
-      unique_values =
-        if hash = options[:hash]
-          if @options[:hash] == hash
-            @options[:unique_values] ||= {}
-          else
-            {}
-          end
-        else
-          hash = @options[:hash]
-          @options[:unique_values] ||= {}
-        end
-
-      node = options[:node] ||= @node
-      value = options[:value]
-
-      if options[:include] == nil
-        if @options.key?(:include)
-          options[:include] = @options[:include].include?(name)
-        elsif @options.include?(:exclude)
-          options[:include] = !@options[:exclude].include?(name)
-        end
-      end
-
-      association_class =
-        if klass = _associations[name]
-          klass
-        elsif value.respond_to?(:to_ary)
-          Associations::HasMany
-        else
-          Associations::HasOne
-        end
-
-      association = association_class.new(name, self, options)
-
-      if association.embed_ids?
-        node[association.key] = association.serialize_ids
-
-        if association.embed_in_root? && hash.nil?
-          raise IncludeError.new(self.class, association.name)
-        elsif association.embed_in_root? && association.embeddable?
-          merge_association hash, association.root, association.serializables, unique_values
-        end
-      elsif association.embed_objects?
-        node[association.key] = association.serialize
-      end
+    def success?
+      true
     end
 
-    # In some cases, an Array of associations is built by merging the associated
-    # content for all of the children. For instance, if a Post has_many comments,
-    # which has_many tags, the top-level :tags key will contain the merged list
-    # of all tags for all comments of the post.
+    # @return [Hash] containing the attributes and first level
+    # associations, similar to how ActiveModel::Serializers::JSON is used
+    # in ActiveRecord::Base.
     #
-    # In order to make this efficient, we store a :unique_values hash containing
-    # a unique list of all of the objects that are already in the Array. This
-    # avoids the need to scan through the Array looking for entries every time
-    # we want to merge a new list of values.
-    def merge_association(hash, key, serializables, unique_values)
-      already_serialized = (unique_values[key] ||= {})
-      serializable_hashes = (hash[key] ||= [])
-
-      serializables.each do |serializable|
-        unless already_serialized.include? serializable.object
-          already_serialized[serializable.object] = true
-          serializable_hashes << serializable.serializable_hash
-        end
+    # TODO: Move to here the Attributes adapter logic for
+    # +serializable_hash_for_single_resource(options)+
+    # and include <tt>ActiveModel::Serializers::JSON</tt>.
+    # So that the below is true:
+    #   @param options [nil, Hash] The same valid options passed to `serializable_hash`
+    #      (:only, :except, :methods, and :include).
+    #
+    #     See
+    #     https://github.com/rails/rails/blob/v5.0.0.beta2/activemodel/lib/active_model/serializers/json.rb#L17-L101
+    #     https://github.com/rails/rails/blob/v5.0.0.beta2/activemodel/lib/active_model/serialization.rb#L85-L123
+    #     https://github.com/rails/rails/blob/v5.0.0.beta2/activerecord/lib/active_record/serialization.rb#L11-L17
+    #     https://github.com/rails/rails/blob/v5.0.0.beta2/activesupport/lib/active_support/core_ext/object/json.rb#L147-L162
+    #
+    #   @example
+    #     # The :only and :except options can be used to limit the attributes included, and work
+    #     # similar to the attributes method.
+    #     serializer.as_json(only: [:id, :name])
+    #     serializer.as_json(except: [:id, :created_at, :age])
+    #
+    #     # To include the result of some method calls on the model use :methods:
+    #     serializer.as_json(methods: :permalink)
+    #
+    #     # To include associations use :include:
+    #     serializer.as_json(include: :posts)
+    #     # Second level and higher order associations work as well:
+    #     serializer.as_json(include: { posts: { include: { comments: { only: :body } }, only: :title } })
+    def serializable_hash(adapter_opts = nil)
+      adapter_opts ||= {}
+      adapter_opts = { include: '*', adapter: :attributes }.merge!(adapter_opts)
+      adapter = ActiveModelSerializers::Adapter.create(self, adapter_opts)
+      adapter.serializable_hash(adapter_opts)
+    end
+    alias to_hash serializable_hash
+    alias to_h serializable_hash
+
+    # @see #serializable_hash
+    # TODO: When moving attributes adapter logic here, @see #serializable_hash
+    # So that the below is true:
+    #   @param options [nil, Hash] The same valid options passed to `as_json`
+    #      (:root, :only, :except, :methods, and :include).
+    #   The default for `root` is nil.
+    #   The default value for include_root is false. You can change it to true if the given
+    #   JSON string includes a single root node.
+    def as_json(adapter_opts = nil)
+      serializable_hash(adapter_opts)
+    end
+
+    # Used by adapter as resource root.
+    def json_key
+      root || _type || object.class.model_name.to_s.underscore
+    end
+
+    def read_attribute_for_serialization(attr)
+      if respond_to?(attr)
+        send(attr)
+      elsif self.class._fragmented
+        self.class._fragmented.read_attribute_for_serialization(attr)
+      else
+        object.read_attribute_for_serialization(attr)
       end
     end
 
-    # Returns a hash representation of the serializable
-    # object attributes.
-    def attributes
-      _fast_attributes
-      rescue NameError
-        method = "def _fast_attributes\n"
-
-        method << "  h = {}\n"
-
-        _attributes.each do |name,key|
-          method << "  h[:\"#{key}\"] = read_attribute_for_serialization(:\"#{name}\") if include?(:\"#{name}\")\n"
-        end
-        method << "  h\nend"
-
-        self.class.class_eval method
-        _fast_attributes
-    end
-
-    # Returns options[:scope]
-    def scope
-      @options[:scope]
-    end
-
-    alias :read_attribute_for_serialization :send
-
-    def _serializable_hash
-      return nil if @object.nil?
-      @node = attributes
-      include_associations! if _embed
-      @node
-    end
-
-    def perform_caching?
-      perform_caching && cache && respond_to?(:cache_key)
-    end
-
-    def expand_cache_key(*args)
-      ActiveSupport::Cache.expand_cache_key(args)
-    end
-
-    # Use ActiveSupport::Notifications to send events to external systems.
-    # The event name is: name.class_name.serializer
-    def instrument(name, payload = {}, &block)
-      event_name = INSTRUMENT[name]
-      ActiveSupport::Notifications.instrument(event_name, payload, &block)
-    end
-  end
+    protected
 
-  # DefaultSerializer
-  #
-  # Provides a constant interface for all items, particularly
-  # for ArraySerializer.
-  class DefaultSerializer
-    attr_reader :object, :options
-
-    def initialize(object, options={})
-      @object, @options = object, options
-    end
-
-    def serializable_hash
-      @object.as_json(@options)
-    end
+    attr_accessor :instance_options
   end
 end