active_model_serializers/lib/active_model_serializers/adapter/base.rb

require 'case_transform'

module ActiveModelSerializers
  module Adapter
    class Base
      # Automatically register adapters when subclassing
      def self.inherited(subclass)
        ActiveModelSerializers::Adapter.register(subclass)
      end

      # Sets the default transform for the adapter.
      #
      # @return [Symbol] the default transform for the adapter
      def self.default_key_transform
        :unaltered
      end

      # Determines the transform to use in order of precedence:
      #   adapter option, global config, adapter default.
      #
      # @param options [Object]
      # @return [Symbol] the transform to use
      def self.transform(options)
        return options[:key_transform] if options && options[:key_transform]
        ActiveModelSerializers.config.key_transform || default_key_transform
      end

      # Transforms the casing of the supplied value.
      #
      # @param value [Object] the value to be transformed
      # @param options [Object] serializable resource options
      # @return [Symbol] the default transform for the adapter
      def self.transform_key_casing!(value, options)
        CaseTransform.send(transform(options), value)
      end

      def self.cache_key
        @cache_key ||= ActiveModelSerializers::Adapter.registered_name(self)
      end

      def self.fragment_cache(cached_hash, non_cached_hash)
        non_cached_hash.merge cached_hash
      end

      attr_reader :serializer, :instance_options

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

      # Subclasses that implement this method must first call
      #   options = serialization_options(options)
      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)
        serializable_hash(options)
      end

      def cache_key
        self.class.cache_key
      end

      def fragment_cache(cached_hash, non_cached_hash)
        self.class.fragment_cache(cached_hash, non_cached_hash)
      end

      private

      # see https://github.com/rails-api/active_model_serializers/pull/965
      # When <tt>options</tt> is +nil+, sets it to +{}+
      def serialization_options(options)
        options ||= {} # rubocop:disable Lint/UselessAssignment
      end

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