Class: ActiveSupport::Cache::Entry

Inherits:
Object
  • Object
show all
Defined in:
lib/active_support/cache.rb

Overview

This class is used to represent cache entries. Cache entries have a value, an optional expiration time, and an optional version. The expiration time is used to support the :race_condition_ttl option on the cache. The version is used to support the :version option on the cache for rejecting mismatches.

Since cache entries in most instances will be serialized, the internals of this class are highly optimized using short instance variable names that are lazily defined.

Constant Summary collapse

DEFAULT_COMPRESS_LIMIT = 
1.kilobyte

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value, options = {}) ⇒ Entry

Creates a new cache entry for the specified value. Options supported are :compress, :compress_threshold, and :expires_in.



716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/active_support/cache.rb', line 716

def initialize(value, options = {})
  @value = value
  if should_compress?(options)
    compress!
  end

  @version    = options[:version]
  @created_at = Time.now.to_f
  @expires_in = options[:expires_in]
  @expires_in = @expires_in.to_f if @expires_in
end

Instance Attribute Details

#version ⇒ Object (readonly)

:nodoc:



710
711
712
 
# File 'lib/active_support/cache.rb', line 710

def version
  @version
end

Instance Method Details

#dup_value! ⇒ Object

Duplicates the value in a class. This is used by cache implementations that don’t natively serialize entries to protect against accidental cache modifications.



773
774
775
776
777
778
779
780
781
 
# File 'lib/active_support/cache.rb', line 773

def dup_value!
  if @value && !compressed? && !(@value.is_a?(Numeric) || @value == true || @value == false)
    if @value.is_a?(String)
      @value = @value.dup
    else
      @value = Marshal.load(Marshal.dump(@value))
    end
  end
end

#expired? ⇒ Boolean

Checks if the entry is expired. The expires_in parameter can override the value set when the entry was created.

Returns:

  • (Boolean) 


738
739
740
 
# File 'lib/active_support/cache.rb', line 738

def expired?
  @expires_in && @created_at + @expires_in <= Time.now.to_f
end

#expires_at ⇒ Object 



742
743
744
 
# File 'lib/active_support/cache.rb', line 742

def expires_at
  @expires_in ? @created_at + @expires_in : nil
end

#expires_at=(value) ⇒ Object 



746
747
748
749
750
751
752
 
# File 'lib/active_support/cache.rb', line 746

def expires_at=(value)
  if value
    @expires_in = value.to_f - @created_at
  else
    @expires_in = nil
  end
end

#mismatched?(version) ⇒ Boolean

Returns:

  • (Boolean) 


732
733
734
 
# File 'lib/active_support/cache.rb', line 732

def mismatched?(version)
  @version && version && @version != version
end

#size ⇒ Object

Returns the size of the cached value. This could be less than value.size if the data is compressed.



756
757
758
759
760
761
762
763
764
765
766
767
768
769
 
# File 'lib/active_support/cache.rb', line 756

def size
  if defined?(@s)
    @s
  else
    case value
    when NilClass
      0
    when String
      @value.bytesize
    else
      @s = Marshal.dump(@value).bytesize
    end
  end
end

#value ⇒ Object 



728
729
730
 
# File 'lib/active_support/cache.rb', line 728

def value
  compressed? ? uncompress(@value) : @value
end