active_model_serializers 0.8.3 → 0.10.0.rc5

data/lib/active_model/serializer/caching.rb

@@ -0,0 +1,151 @@
+module ActiveModel
+  class Serializer
+    module Caching
+      extend ActiveSupport::Concern
+
+      included do
+        with_options instance_writer: false, instance_reader: false do |serializer|
+          serializer.class_attribute :_cache         # @api private : the cache store
+          serializer.class_attribute :_fragmented    # @api private : @see ::fragmented
+          serializer.class_attribute :_cache_key     # @api private : when present, is first item in cache_key.  Ignored if the serializable object defines #cache_key.
+          serializer.class_attribute :_cache_only    # @api private : when fragment caching, whitelists cached_attributes. Cannot combine with except
+          serializer.class_attribute :_cache_except  # @api private : when fragment caching, blacklists cached_attributes. Cannot combine with only
+          serializer.class_attribute :_cache_options # @api private : used by CachedSerializer, passed to _cache.fetch
+          #  _cache_options include:
+          #    expires_in
+          #    compress
+          #    force
+          #    race_condition_ttl
+          #  Passed to ::_cache as
+          #    serializer._cache.fetch(cache_key, @klass._cache_options)
+          serializer.class_attribute :_cache_digest # @api private : Generated
+        end
+      end
+
+      # Matches
+      #  "c:/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb:1:in `<top (required)>'"
+      #  AND
+      #  "/c/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb:1:in `<top (required)>'"
+      #  AS
+      #  c/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb
+      CALLER_FILE = /
+        \A       # start of string
+        .+       # file path (one or more characters)
+        (?=      # stop previous match when
+          :\d+     # a colon is followed by one or more digits
+          :in      # followed by a colon followed by in
+        )
+      /x
+
+      module ClassMethods
+        def inherited(base)
+          super
+          caller_line = caller[1]
+          base._cache_digest = digest_caller_file(caller_line)
+        end
+
+        # Hashes contents of file for +_cache_digest+
+        def digest_caller_file(caller_line)
+          serializer_file_path = caller_line[CALLER_FILE]
+          serializer_file_contents = IO.read(serializer_file_path)
+          Digest::MD5.hexdigest(serializer_file_contents)
+        rescue TypeError, Errno::ENOENT
+          warn <<-EOF.strip_heredoc
+            Cannot digest non-existent file: '#{caller_line}'.
+            Please set `::_cache_digest` of the serializer
+            if you'd like to cache it.
+            EOF
+          ''.freeze
+        end
+
+        def _skip_digest?
+          _cache_options && _cache_options[:skip_digest]
+        end
+
+        # @api private
+        # Used by FragmentCache on the CachedSerializer
+        #  to call attribute methods on the fragmented cached serializer.
+        def fragmented(serializer)
+          self._fragmented = serializer
+        end
+
+        # Enables a serializer to be automatically cached
+        #
+        # Sets +::_cache+ object to <tt>ActionController::Base.cache_store</tt>
+        #   when Rails.configuration.action_controller.perform_caching
+        #
+        # @param options [Hash] with valid keys:
+        #   cache_store    : @see ::_cache
+        #   key            : @see ::_cache_key
+        #   only           : @see ::_cache_only
+        #   except         : @see ::_cache_except
+        #   skip_digest    : does not include digest in cache_key
+        #   all else       : @see ::_cache_options
+        #
+        # @example
+        #   class PostSerializer < ActiveModel::Serializer
+        #     cache key: 'post', expires_in: 3.hours
+        #     attributes :title, :body
+        #
+        #     has_many :comments
+        #   end
+        #
+        # @todo require less code comments. See
+        # https://github.com/rails-api/active_model_serializers/pull/1249#issuecomment-146567837
+        def cache(options = {})
+          self._cache =
+            options.delete(:cache_store) ||
+            ActiveModelSerializers.config.cache_store ||
+            ActiveSupport::Cache.lookup_store(:null_store)
+          self._cache_key = options.delete(:key)
+          self._cache_only = options.delete(:only)
+          self._cache_except = options.delete(:except)
+          self._cache_options = options.empty? ? nil : options
+        end
+
+        # Value is from ActiveModelSerializers.config.perform_caching. Is used to
+        # globally enable or disable all serializer caching, just like
+        # Rails.configuration.action_controller.perform_caching, which is its
+        # default value in a Rails application.
+        # @return [true, false]
+        # Memoizes value of config first time it is called with a non-nil value.
+        # rubocop:disable Style/ClassVars
+        def perform_caching
+          return @@perform_caching if defined?(@@perform_caching) && !@@perform_caching.nil?
+          @@perform_caching = ActiveModelSerializers.config.perform_caching
+        end
+        alias perform_caching? perform_caching
+        # rubocop:enable Style/ClassVars
+
+        # The canonical method for getting the cache store for the serializer.
+        #
+        # @return [nil] when _cache is not set (i.e. when `cache` has not been called)
+        # @return [._cache] when _cache is not the NullStore
+        # @return [ActiveModelSerializers.config.cache_store] when _cache is the NullStore.
+        #   This is so we can use `cache` being called to mean the serializer should be cached
+        #   even if ActiveModelSerializers.config.cache_store has not yet been set.
+        #   That means that when _cache is the NullStore and ActiveModelSerializers.config.cache_store
+        #   is configured, `cache_store` becomes `ActiveModelSerializers.config.cache_store`.
+        # @return [nil] when _cache is the NullStore and ActiveModelSerializers.config.cache_store is nil.
+        def cache_store
+          return nil if _cache.nil?
+          return _cache if _cache.class != ActiveSupport::Cache::NullStore
+          if ActiveModelSerializers.config.cache_store
+            self._cache = ActiveModelSerializers.config.cache_store
+          else
+            nil
+          end
+        end
+
+        def cache_enabled?
+          perform_caching? && cache_store && !_cache_only && !_cache_except
+        end
+
+        def fragment_cache_enabled?
+          perform_caching? && cache_store &&
+            (_cache_only && !_cache_except || !_cache_only && _cache_except)
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer/collection_reflection.rb

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

data/lib/active_model/serializer/collection_serializer.rb

@@ -0,0 +1,64 @@
+module ActiveModel
+  class Serializer
+    class CollectionSerializer
+      NoSerializerError = Class.new(StandardError)
+      include Enumerable
+      delegate :each, to: :@serializers
+
+      attr_reader :object, :root
+
+      def initialize(resources, options = {})
+        @object                  = resources
+        @options                 = options
+        @root                    = options[:root]
+        serializer_context_class = options.fetch(:serializer_context_class, ActiveModel::Serializer)
+        @serializers = resources.map do |resource|
+          serializer_class = options.fetch(:serializer) { serializer_context_class.serializer_for(resource) }
+
+          if serializer_class.nil? # rubocop:disable Style/GuardClause
+            fail NoSerializerError, "No serializer found for resource: #{resource.inspect}"
+          else
+            serializer_class.new(resource, options.except(:serializer))
+          end
+        end
+      end
+
+      def success?
+        true
+      end
+
+      # TODO: unify naming of root, json_key, and _type.  Right now, a serializer's
+      # json_key comes from the root option or the object's model name, by default.
+      # But, if a dev defines a custom `json_key` method with an explicit value,
+      # we have no simple way to know that it is safe to call that instance method.
+      # (which is really a class property at this point, anyhow).
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # Disabling cop since it's good to highlight the complexity of this method by
+      # including all the logic right here.
+      def json_key
+        return root if root
+        # 1. get from options[:serializer] for empty resource collection
+        key = object.empty? &&
+          (explicit_serializer_class = options[:serializer]) &&
+          explicit_serializer_class._type
+        # 2. get from first serializer instance in collection
+        key ||= (serializer = serializers.first) && serializer.json_key
+        # 3. get from collection name, if a named collection
+        key ||= object.respond_to?(:name) ? object.name && object.name.underscore : nil
+        # 4. key may be nil for empty collection and no serializer option
+        key && key.pluralize
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def paginated?
+        object.respond_to?(:current_page) &&
+          object.respond_to?(:total_pages) &&
+          object.respond_to?(:size)
+      end
+
+      protected
+
+      attr_reader :serializers, :options
+    end
+  end
+end

data/lib/active_model/serializer/configuration.rb

@@ -0,0 +1,35 @@
+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.adapter = :attributes
+        config.jsonapi_resource_type = :plural
+        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.key_transform = nil
+
+        config.schema_path = 'test/support/schemas'
+      end
+    end
+  end
+end

data/lib/active_model/serializer/error_serializer.rb

@@ -0,0 +1,10 @@
+class ActiveModel::Serializer::ErrorSerializer < ActiveModel::Serializer
+  # @return [Hash<field_name,Array<error_message>>]
+  def as_json
+    object.errors.messages
+  end
+
+  def success?
+    false
+  end
+end

data/lib/active_model/serializer/errors_serializer.rb

@@ -0,0 +1,27 @@
+require 'active_model/serializer/error_serializer'
+class ActiveModel::Serializer::ErrorsSerializer
+  include Enumerable
+  delegate :each, to: :@serializers
+  attr_reader :object, :root
+
+  def initialize(resources, options = {})
+    @root = options[:root]
+    @object = resources
+    @serializers = resources.map do |resource|
+      serializer_class = options.fetch(:serializer) { ActiveModel::Serializer::ErrorSerializer }
+      serializer_class.new(resource, options.except(:serializer))
+    end
+  end
+
+  def success?
+    false
+  end
+
+  def json_key
+    nil
+  end
+
+  protected
+
+  attr_reader :serializers
+end

data/lib/active_model/serializer/field.rb

@@ -0,0 +1,56 @@
+module ActiveModel
+  class Serializer
+    # Holds all the meta-data about a field (i.e. attribute or association) as it was
+    # specified in the ActiveModel::Serializer class.
+    # Notice that the field block is evaluated in the context of the serializer.
+    Field = Struct.new(:name, :options, :block) do
+      # Compute the actual value of a field for a given serializer instance.
+      # @param [Serializer] The serializer instance for which the value is computed.
+      # @return [Object] value
+      #
+      # @api private
+      #
+      def value(serializer)
+        if block
+          serializer.instance_eval(&block)
+        else
+          serializer.read_attribute_for_serialization(name)
+        end
+      end
+
+      # Decide whether the field should be serialized by the given serializer instance.
+      # @param [Serializer] The serializer instance
+      # @return [Bool]
+      #
+      # @api private
+      #
+      def excluded?(serializer)
+        case condition_type
+        when :if
+          !serializer.public_send(condition)
+        when :unless
+          serializer.public_send(condition)
+        else
+          false
+        end
+      end
+
+      private
+
+      def condition_type
+        @condition_type ||=
+          if options.key?(:if)
+            :if
+          elsif options.key?(:unless)
+            :unless
+          else
+            :none
+          end
+      end
+
+      def condition
+        options[condition_type]
+      end
+    end
+  end
+end

data/lib/active_model/serializer/fieldset.rb

@@ -0,0 +1,31 @@
+module ActiveModel
+  class Serializer
+    class Fieldset
+      def initialize(fields)
+        @raw_fields = fields || {}
+      end
+
+      def fields
+        @fields ||= parsed_fields
+      end
+
+      def fields_for(type)
+        fields[type.singularize.to_sym] || fields[type.pluralize.to_sym]
+      end
+
+      protected
+
+      attr_reader :raw_fields
+
+      private
+
+      def parsed_fields
+        if raw_fields.is_a?(Hash)
+          raw_fields.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.map(&:to_sym) }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer/has_many_reflection.rb

@@ -0,0 +1,10 @@
+module ActiveModel
+  class Serializer
+    # @api private
+    class HasManyReflection < CollectionReflection
+      def macro
+        :has_many
+      end
+    end
+  end
+end

data/lib/active_model/serializer/has_one_reflection.rb

@@ -0,0 +1,10 @@
+module ActiveModel
+  class Serializer
+    # @api private
+    class HasOneReflection < SingularReflection
+      def macro
+        :has_one
+      end
+    end
+  end
+end

data/lib/active_model/serializer/include_tree.rb

@@ -0,0 +1,111 @@
+module ActiveModel
+  class Serializer
+    # TODO: description of this class, and overview of how it's used
+    class IncludeTree
+      module Parsing
+        module_function
+
+        # Translates a comma separated list of dot separated paths (JSON API format) into a Hash.
+        #
+        # @example
+        #   `'posts.author, posts.comments.upvotes, posts.comments.author'`
+        #
+        #   would become
+        #
+        #   `{ posts: { author: {}, comments: { author: {}, upvotes: {} } } }`.
+        #
+        # @param [String] included
+        # @return [Hash] a Hash representing the same tree structure
+        def include_string_to_hash(included)
+          # TODO: Needs comment walking through the process of what all this is doing.
+          included.delete(' ').split(',').reduce({}) do |hash, path|
+            include_tree = path.split('.').reverse_each.reduce({}) { |a, e| { e.to_sym => a } }
+            hash.deep_merge!(include_tree)
+          end
+        end
+
+        # Translates the arguments passed to the include option into a Hash. The format can be either
+        # a String (see #include_string_to_hash), an Array of Symbols and Hashes, or a mix of both.
+        #
+        # @example
+        #  `posts: [:author, comments: [:author, :upvotes]]`
+        #
+        #  would become
+        #
+        #   `{ posts: { author: {}, comments: { author: {}, upvotes: {} } } }`.
+        #
+        # @example
+        #  `[:author, :comments => [:author]]`
+        #
+        #   would become
+        #
+        #   `{:author => {}, :comments => { author: {} } }`
+        #
+        # @param [Symbol, Hash, Array, String] included
+        # @return [Hash] a Hash representing the same tree structure
+        def include_args_to_hash(included)
+          case included
+          when Symbol
+            { included => {} }
+          when Hash
+            included.each_with_object({}) do |(key, value), hash|
+              hash[key] = include_args_to_hash(value)
+            end
+          when Array
+            included.reduce({}) { |a, e| a.deep_merge!(include_args_to_hash(e)) }
+          when String
+            include_string_to_hash(included)
+          else
+            {}
+          end
+        end
+      end
+
+      # Builds an IncludeTree from a comma separated list of dot separated paths (JSON API format).
+      # @example `'posts.author, posts.comments.upvotes, posts.comments.author'`
+      #
+      # @param [String] included
+      # @return [IncludeTree]
+      #
+      def self.from_string(included)
+        new(Parsing.include_string_to_hash(included))
+      end
+
+      # Translates the arguments passed to the include option into an IncludeTree.
+      # The format can be either a String (see #from_string), an Array of Symbols and Hashes, or a mix of both.
+      # @example `posts: [:author, comments: [:author, :upvotes]]`
+      #
+      # @param [Symbol, Hash, Array, String] included
+      # @return [IncludeTree]
+      #
+      def self.from_include_args(included)
+        return included if included.is_a?(IncludeTree)
+
+        new(Parsing.include_args_to_hash(included))
+      end
+
+      # @param [Hash] hash
+      def initialize(hash = {})
+        @hash = hash
+      end
+
+      def key?(key)
+        @hash.key?(key) || @hash.key?(:*) || @hash.key?(:**)
+      end
+
+      def [](key)
+        # TODO(beauby): Adopt a lazy caching strategy for generating subtrees.
+        case
+        when @hash.key?(key)
+          self.class.new(@hash[key])
+        when @hash.key?(:*)
+          self.class.new(@hash[:*])
+        when @hash.key?(:**)
+          self.class.new(:** => {})
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer/links.rb

@@ -0,0 +1,35 @@
+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