active_model_serializers 0.10.3 → 0.10.12

data/docs/rfcs/0000-namespace.md

@@ -1,106 +0,0 @@
-- Start Date: (2015-10-29)
-- RFC PR: https://github.com/rails-api/active_model_serializers/pull/1310
-- ActiveModelSerializers Issue: https://github.com/rails-api/active_model_serializers/issues/1298
-
-# Summary
-
-Provide a consistent API for the user of the AMS.
-
-# Motivation
-
-The actual public API is defined under `ActiveModelSerializers`,
-`ActiveModel::Serializer` and `ActiveModel`.
-
-At the `ActiveModel::Serializer` we have:
-
-- `ActiveModel::Serializer.config`
-- `ActiveModel::Serializer`
-
-At the `ActiveModelSerializers` we have:
-
-- `ActiveModelSerializers::Model`
-- `ActiveModelSerializers.logger`
-
-At `ActiveModel` we have:
-
-- `ActiveModel::SerializableResource`
-
-The idea here is to provide a single namespace `ActiveModelSerializers` to the user.
-Following the same idea we have on other gems like
-[Devise](https://github.com/plataformatec/devise/blob/e9c82472ffe7c43a448945f77e034a0e47dde0bb/lib/devise.rb),
-[Refile](https://github.com/refile/refile/blob/6b24c293d044862dafbf1bfa4606672a64903aa2/lib/refile.rb) and
-[Active Job](https://github.com/rails/rails/blob/30bacc26f8f258b39e12f63fe52389a968d9c1ea/activejob/lib/active_job.rb)
-for example.
-
-This way we are clarifing the boundaries of
-[ActiveModelSerializers and Rails](https://github.com/rails-api/active_model_serializers/blob/master/CHANGELOG.md#prehistory)
-and make clear that the `ActiveModel::Serializer` class is no longer the primary
-behavior of the ActiveModelSerializers.
-
-# Detailed design
-
-## New classes and modules organization
-
-Since this will be a big change we can do this on baby steps, read small pull requests. A
-possible approach is:
-
-- All new code will be in `lib/active_model_serializers/` using
-  the module namespace `ActiveModelSerializers`.
-- Move all content under `ActiveModel::Serializer` to be under
-  `ActiveModelSerializers`, the adapter is on this steps;
-- Move all content under `ActiveModel` to be under `ActiveModelSerializers`,
-  the `SerializableResource` is on this step;
-- Change all public API that doesn't make sense, keeping in mind only to keep
-  this in the same namespace
-- Update the README;
-- Update the docs;
-
-The following table represents the current and the desired classes and modules
-at the first moment.
-
-| Current                                                | Desired                                          | Notes              |
-|--------------------------------------------------------|--------------------------------------------------|--------------------|
-| `ActiveModelSerializers` and `ActiveModel::Serializer` | `ActiveModelSerializers`                         | The main namespace |
-| `ActiveModelSerializers.logger`                        | `ActiveModelSerializers.logger`                  ||
-| `ActiveModelSerializers::Model`                        | `ActiveModelSerializers::Model`                  ||
-| `ActiveModel::SerializableResource`                    | `ActiveModelSerializers::SerializableResource`   ||
-| `ActiveModel::Serializer`                              | `ActiveModelSerializers::Serializer`             | The name can be discussed in a future pull request. For example, we can rename this to `Resource` [following this idea](https://github.com/rails-api/active_model_serializers/pull/1301/files#r42963185) more info about naming in the next section|
-| `ActiveModel::Serializer.config`                       | `ActiveModelSerializers.config`                ||
-
-## Renaming of class and modules
-
-When moving some content to the new namespace we can find some names that does
-not make much sense like `ActiveModel::Serializer::Adapter::JsonApi`.
-Discussion of renaming existing classes / modules and JsonApi objects will
-happen in separate pull requests, and issues, and in the google doc
-https://docs.google.com/document/d/1rcrJr0sVcazY2Opd_6Kmv1iIwuHbI84s1P_NzFn-05c/edit?usp=sharing
-
-Some of names already have a definition.
-
-- Adapters get their own namespace under ActiveModelSerializers. E.g
-  `ActiveModelSerializers::Adapter`
-- Serializers get their own namespace under ActiveModelSerializers. E.g
-  `ActiveModelSerializers::Serializer`
-
-## Keeping compatibility
-
-All moved classes or modules be aliased to their old name and location with
-deprecation warnings, such as
-[was done for CollectionSerializer](https://github.com/rails-api/active_model_serializers/pull/1251).
-
-# Drawbacks
-
-This will be a breaking change, so all users serializers will be broken after a
-major bump.
-All pull requests will need to rebase since the architeture will change a lot.
-
-# Alternatives
-
-We can keep the way it is, and keep in mind to not add another namespace as a
-public API.
-
-# Unresolved questions
-
-What is the better class name to be used to the class that will be inherited at
-the creation of a serializer. This can be discussed in other RFC or directly via
-pull request.

data/docs/rfcs/template.md

@@ -1,15 +0,0 @@
-- Start Date: (YYYY-MM-DD)
-- RFC PR: https://github.com/rails-api/active_model_serializers/pull/dddd
-- ActiveModelSerializers Issue: https://github.com/rails-api/active_model_serializers/issues/dddd
-
-# Summary
-
-# Motivation
-
-# Detailed design
-
-# Drawbacks
-
-# Alternatives
-
-# Unresolved questions

data/lib/active_model/serializer/collection_reflection.rb

@@ -1,7 +0,0 @@
-module ActiveModel
-  class Serializer
-    # @api private
-    class CollectionReflection < Reflection
-    end
-  end
-end

data/lib/active_model/serializer/concerns/associations.rb

@@ -1,102 +0,0 @@
-module ActiveModel
-  class Serializer
-    # 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.
-    #
-    module Associations
-      extend ActiveSupport::Concern
-
-      included do
-        with_options instance_writer: false, instance_reader: true do |serializer|
-          serializer.class_attribute :_reflections
-          self._reflections ||= {}
-        end
-
-        extend ActiveSupport::Autoload
-        autoload :Association
-        autoload :Reflection
-        autoload :SingularReflection
-        autoload :CollectionReflection
-        autoload :BelongsToReflection
-        autoload :HasOneReflection
-        autoload :HasManyReflection
-      end
-
-      module ClassMethods
-        def inherited(base)
-          super
-          base._reflections = _reflections.dup
-        end
-
-        # @param [Symbol] name of the association
-        # @param [Hash<Symbol => any>] options for the reflection
-        # @return [void]
-        #
-        # @example
-        #  has_many :comments, serializer: CommentSummarySerializer
-        #
-        def has_many(name, options = {}, &block) # rubocop:disable Style/PredicateName
-          associate(HasManyReflection.new(name, options, block))
-        end
-
-        # @param [Symbol] name of the association
-        # @param [Hash<Symbol => any>] options for the reflection
-        # @return [void]
-        #
-        # @example
-        #  belongs_to :author, serializer: AuthorSerializer
-        #
-        def belongs_to(name, options = {}, &block)
-          associate(BelongsToReflection.new(name, options, block))
-        end
-
-        # @param [Symbol] name of the association
-        # @param [Hash<Symbol => any>] options for the reflection
-        # @return [void]
-        #
-        # @example
-        #  has_one :author, serializer: AuthorSerializer
-        #
-        def has_one(name, options = {}, &block) # rubocop:disable Style/PredicateName
-          associate(HasOneReflection.new(name, options, block))
-        end
-
-        private
-
-        # Add reflection and define {name} accessor.
-        # @param [ActiveModel::Serializer::Reflection] reflection
-        # @return [void]
-        #
-        # @api private
-        #
-        def associate(reflection)
-          key = reflection.options[:key] || reflection.name
-          self._reflections[key] = reflection
-        end
-      end
-
-      # @param [JSONAPI::IncludeDirective] include_directive (defaults to the
-      #   +default_include_directive+ config value when not provided)
-      # @return [Enumerator<Association>]
-      #
-      def associations(include_directive = ActiveModelSerializers.default_include_directive, include_slice = nil)
-        include_slice ||= include_directive
-        return unless object
-
-        Enumerator.new do |y|
-          self.class._reflections.values.each do |reflection|
-            next if reflection.excluded?(self)
-            key = reflection.options.fetch(:key, reflection.name)
-            next unless include_directive.key?(key)
-
-            y.yield reflection.build_association(self, instance_options, include_slice)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/active_model/serializer/concerns/attributes.rb

@@ -1,82 +0,0 @@
-module ActiveModel
-  class Serializer
-    module Attributes
-      extend ActiveSupport::Concern
-
-      included do
-        with_options instance_writer: false, instance_reader: false do |serializer|
-          serializer.class_attribute :_attributes_data # @api private
-          self._attributes_data ||= {}
-        end
-
-        extend ActiveSupport::Autoload
-        autoload :Attribute
-
-        # Return the +attributes+ of +object+ as presented
-        # by the serializer.
-        def attributes(requested_attrs = nil, reload = false)
-          @attributes = nil if reload
-          @attributes ||= self.class._attributes_data.each_with_object({}) do |(key, attr), hash|
-            next if attr.excluded?(self)
-            next unless requested_attrs.nil? || requested_attrs.include?(key)
-            hash[key] = attr.value(self)
-          end
-        end
-      end
-
-      module ClassMethods
-        def inherited(base)
-          super
-          base._attributes_data = _attributes_data.dup
-        end
-
-        # @example
-        #   class AdminAuthorSerializer < ActiveModel::Serializer
-        #     attributes :id, :name, :recent_edits
-        def attributes(*attrs)
-          attrs = attrs.first if attrs.first.class == Array
-
-          attrs.each do |attr|
-            attribute(attr)
-          end
-        end
-
-        # @example
-        #   class AdminAuthorSerializer < ActiveModel::Serializer
-        #     attributes :id, :recent_edits
-        #     attribute :name, key: :title
-        #
-        #     attribute :full_name do
-        #       "#{object.first_name} #{object.last_name}"
-        #     end
-        #
-        #     def recent_edits
-        #       object.edits.last(5)
-        #     end
-        def attribute(attr, options = {}, &block)
-          key = options.fetch(:key, attr)
-          _attributes_data[key] = Attribute.new(attr, options, block)
-        end
-
-        # @api private
-        # keys of attributes
-        # @see Serializer::attribute
-        def _attributes
-          _attributes_data.keys
-        end
-
-        # @api private
-        # maps attribute value to explict key name
-        # @see Serializer::attribute
-        # @see FragmentCache#fragment_serializer
-        def _attributes_keys
-          _attributes_data
-            .each_with_object({}) do |(key, attr), hash|
-              next if key == attr.name
-              hash[attr.name] = { key: key }
-            end
-        end
-      end
-    end
-  end
-end

data/lib/active_model/serializer/concerns/configuration.rb

@@ -1,59 +0,0 @@
-module ActiveModel
-  class Serializer
-    module Configuration
-      include ActiveSupport::Configurable
-      extend ActiveSupport::Concern
-
-      # Configuration options may also be set in
-      # Serializers and Adapters
-      included do |base|
-        config = base.config
-        config.collection_serializer = ActiveModel::Serializer::CollectionSerializer
-        config.serializer_lookup_enabled = true
-
-        def config.array_serializer=(collection_serializer)
-          self.collection_serializer = collection_serializer
-        end
-
-        def config.array_serializer
-          collection_serializer
-        end
-
-        config.default_includes = '*'
-        config.adapter = :attributes
-        config.key_transform = nil
-        config.jsonapi_pagination_links_enabled = true
-        config.jsonapi_resource_type = :plural
-        config.jsonapi_namespace_separator = '-'.freeze
-        config.jsonapi_version = '1.0'
-        config.jsonapi_toplevel_meta = {}
-        # Make JSON API top-level jsonapi member opt-in
-        # ref: http://jsonapi.org/format/#document-top-level
-        config.jsonapi_include_toplevel_object = false
-        config.include_data_default = true
-
-        # For configuring how serializers are found.
-        # This should be an array of procs.
-        #
-        # The priority of the output is that the first item
-        # in the evaluated result array will take precedence
-        # over other possible serializer paths.
-        #
-        # i.e.: First match wins.
-        #
-        # @example output
-        # => [
-        #   "CustomNamespace::ResourceSerializer",
-        #   "ParentSerializer::ResourceSerializer",
-        #   "ResourceNamespace::ResourceSerializer" ,
-        #   "ResourceSerializer"]
-        #
-        # If CustomNamespace::ResourceSerializer exists, it will be used
-        # for serialization
-        config.serializer_lookup_chain = ActiveModelSerializers::LookupChain::DEFAULT.dup
-
-        config.schema_path = 'test/support/schemas'
-      end
-    end
-  end
-end

data/lib/active_model/serializer/concerns/links.rb

@@ -1,35 +0,0 @@
-module ActiveModel
-  class Serializer
-    module Links
-      extend ActiveSupport::Concern
-
-      included do
-        with_options instance_writer: false, instance_reader: true do |serializer|
-          serializer.class_attribute :_links # @api private
-          self._links ||= {}
-        end
-
-        extend ActiveSupport::Autoload
-      end
-
-      module ClassMethods
-        def inherited(base)
-          super
-          base._links = _links.dup
-        end
-
-        # Define a link on a serializer.
-        # @example
-        #   link(:self) { resource_url(object) }
-        # @example
-        #   link(:self) { "http://example.com/resource/#{object.id}" }
-        # @example
-        #   link :resource, "http://example.com/resource"
-        #
-        def link(name, value = nil, &block)
-          _links[name] = block || value
-        end
-      end
-    end
-  end
-end

data/lib/active_model/serializer/concerns/meta.rb

@@ -1,29 +0,0 @@
-module ActiveModel
-  class Serializer
-    module Meta
-      extend ActiveSupport::Concern
-
-      included do
-        with_options instance_writer: false, instance_reader: true do |serializer|
-          serializer.class_attribute :_meta # @api private
-        end
-
-        extend ActiveSupport::Autoload
-      end
-
-      module ClassMethods
-        # Set the JSON API meta attribute of a serializer.
-        # @example
-        #   class AdminAuthorSerializer < ActiveModel::Serializer
-        #     meta { stuff: 'value' }
-        # @example
-        #     meta do
-        #       { comment_count: object.comments.count }
-        #     end
-        def meta(value = nil, &block)
-          self._meta = block || value
-        end
-      end
-    end
-  end
-end