kostyantyn/hydra_attribute

module HydraAttribute
  module Model
    module Cacheable
      extend ActiveSupport::Concern

      included do
        register_nested_cache :model
      end

      module ClassMethods
        # Finds all records and store them into the cache
        #
        # @return [Array<HydraAttribute::Cacheable>]
        def all
          return identity_map[:all] if identity_map.has_key?(:all)

          ids = nested_identity_map(:model).keys
          ids.present? ? where_not(id: ids) : where

          identity_map[:all] = []
          nested_identity_map(:model).each do |_, model|
            add_to_cache(model)
          end
          identity_map[:all]
        end

        # Find record by ID and store it into the cache
        #
        # @return [HydraAttribute::Cacheable]
        def find(id)
          model = get_from_nested_cache_or_load_all_models(:model, id.to_i)
          raise RecordNotFound, "Couldn't find #{name} with id=#{id}" unless model
          model
        end

        # Defines singleton method
        #
        # @example
        #   ClassName.define_cached_singleton_method :method_name, cache_key: :method_key, cache_value: :method_value, cache_key_cast: :to_i
        #   ClassName.method_method
        #
        # @param [Symbol] method_name
        # @param [Hash] options
        # @return [NilClass]
        def define_cached_singleton_method(method_name, options = {})
          register_nested_cache(method_name)

          cache_key       = options[:cache_key]            ? ".#{options[:cache_key]}"      : ''
          cache_value     = options[:cache_value] != :self ? ".#{options[:cache_value]}"    : ''
          cache_key_was   = options[:cache_key]            ? "#{cache_key}_was"             : ''
          cache_value_was = options[:cache_value] != :self ? "#{cache_value}_was"           : ''
          type_cast_key   = options[:cache_key_cast]       ? ".#{options[:cache_key_cast]}" : ''

          instance_eval <<-OES, __FILE__, __LINE__ + 1
            def #{method_name}(param)
              get_from_nested_cache_or_load_all_models(:#{method_name}, param#{type_cast_key}) || []
            end

            private
              def add_to_#{method_name}_cache(model)
                add_value_to_nested_cache(:#{method_name}, key: model#{cache_key}, value: model#{cache_value})
              end

              def update_#{method_name}_cache(model)
                delete_value_from_nested_cache(:#{method_name}, key: model#{cache_key_was}, value: model#{cache_value_was})
                add_to_#{method_name}_cache(model)
              end

              def delete_from_#{method_name}_cache(model)
                delete_value_from_nested_cache(:#{method_name}, key: model#{cache_key}, value: model#{cache_value})
              end
          OES
        end

        # Gets data from cache or load all models and repeats the operation
        #
        # @param [Symbol] nested_cache_key
        # @param [Object] identifier
        # @return [Object]
        def get_from_nested_cache_or_load_all_models(nested_cache_key, identifier)
          return nested_identity_map(nested_cache_key)[identifier] if nested_identity_map(nested_cache_key).has_key?(identifier)
          all # preload all models
          nested_identity_map(nested_cache_key)[identifier]
        end

        # Add model to all cache objects
        # This method should not be used outside the model
        #
        # @param [HydraAttribute::Model::Cacheable]
        # @return [NilClass]
        def add_to_cache(model)
          notify_cache_callbacks('add_to', model)
        end

        # Update model in all registered caches
        # This method should not be used outside the model
        #
        # @param [HydraAttribute::Model::Cacheable]
        # @return [NilClass]
        def update_cache(model)
          notify_cache_callbacks('update', model)
        end

        # Delete model from all cache objects
        # This method should not be used outside the model
        #
        # @param [HydraAttribute::Model::Cacheable]
        # @return [NilClass]
        def delete_from_cache(model)
          notify_cache_callbacks('delete_from', model)
        end

        private
          # helper method
          def notify_cache_callbacks(method_prefix, model)
            ([:all] + nested_cache_keys).each do |nested_cache_key|
              method = "#{method_prefix}_#{nested_cache_key}_cache"
              send(method, model) if respond_to?(method, true)
            end
          end

          # helper method
          def add_value_to_nested_cache(cache_key, options = {})
            return unless identity_map.has_key?(:all)
            nested_identity_map(cache_key)[options[:key]] ||= []
            nested_identity_map(cache_key)[options[:key]] << options[:value]
          end

          # helper method
          def delete_value_from_nested_cache(cache_key, options = {})
            return unless nested_identity_map(cache_key)[options[:key]]
            nested_identity_map(cache_key)[options[:key]].delete(options[:value])
          end

          # helper method
          def add_value_to_nested_hash_cache(cache_key, options = {})
            return unless identity_map.has_key?(:all)
            nested_identity_map(cache_key)[options[:key]] ||= {}
            nested_identity_map(cache_key)[options[:key]][options[:value]] = nil
          end

          # helper method
          def delete_value_from_nested_hash_cache(cache_key, options = {})
            return unless nested_identity_map(cache_key)[options[:key]]
            nested_identity_map(cache_key)[options[:key]].delete(options[:value])
          end

          # cache callback
          def add_to_all_cache(model)
            return unless identity_map[:all]
            identity_map[:all].push(model)
          end

          # cache callback
          def delete_from_all_cache(model)
            return unless identity_map[:all]
            identity_map[:all].delete(model)
          end

          # cache callback
          def add_to_model_cache(model)
            nested_identity_map(:model)[model.id] = model
          end

          # cache callback
          def delete_from_model_cache(model)
            nested_identity_map(:model).delete(model.id)
          end
      end

      # Initialize a model
      # Save it into the cache if it is persisted
      def initialize(attributes = {})
        super(attributes)
        self.class.add_to_cache(self) if persisted?
      end

      private
        # Create new model and store it into the cache
        #
        # @return [Fixnum]
        def create
          id = super
          self.class.add_to_cache(self)
          id
        end

        # Update the model and its cache
        #
        # @return [TrueClass, FalseClass]
        def update
          result = super
          self.class.update_cache(self)
          result
        end

        # Delete model and remove it from the cache
        #
        # @return [TrueClass]
        def delete
          result = super
          self.class.delete_from_cache(self)
          result
        end
    end
  end
end