Class: ActiveSupport::Cache::FileStore

### Home Classes Methods

### In Files

- lib/active_support/cache/file_store.rb

### Parent

Store

### Methods

- ::new
- #cleanup
- #clear
- #decrement
- #delete_entry
- #delete_matched
- #increment
- #read_entry
- #write_entry

### Class/Module Index

Quicksearch

- ActiveSupport
- ActiveSupport::Autoload
- ActiveSupport::BacktraceCleaner
- ActiveSupport::Base64
- ActiveSupport::BasicObject
- ActiveSupport::Benchmarkable
- ActiveSupport::BufferedLogger
- ActiveSupport::BufferedLogger::Severity
- ActiveSupport::Cache
- ActiveSupport::Cache::CompressedMemCacheStore
- ActiveSupport::Cache::Entry
- ActiveSupport::Cache::FileStore
- ActiveSupport::Cache::MemCacheStore
- ActiveSupport::Cache::MemoryStore
- ActiveSupport::Cache::Store
- ActiveSupport::Cache::Strategy
- ActiveSupport::Cache::Strategy::LocalCache
- ActiveSupport::Cache::Strategy::LocalCache::LocalStore
- ActiveSupport::Cache::SynchronizedMemoryStore
- ActiveSupport::Callbacks
- ActiveSupport::Callbacks::Callback
- ActiveSupport::Callbacks::CallbackChain
- ActiveSupport::Callbacks::ClassMethods
- ActiveSupport::Concern
- ActiveSupport::Configurable
- ActiveSupport::Configurable::ClassMethods
- ActiveSupport::Dependencies
- ActiveSupport::Dependencies::Reference
- ActiveSupport::Dependencies::WatchStack
- ActiveSupport::Deprecation
- ActiveSupport::DescendantsTracker
- ActiveSupport::Duration
- ActiveSupport::FileUpdateChecker
- ActiveSupport::Gzip
- ActiveSupport::Gzip::Stream
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::Inflector
- ActiveSupport::Inflector::Inflections
- ActiveSupport::InheritableOptions
- ActiveSupport::JSON
- ActiveSupport::JSON::Backends
- ActiveSupport::JSON::Backends::JSONGem
- ActiveSupport::JSON::Backends::Yajl
- ActiveSupport::JSON::Backends::Yaml
- ActiveSupport::JSON::Encoding
- ActiveSupport::JSON::Encoding::CircularReferenceError
- ActiveSupport::JSON::Encoding::Encoder
- ActiveSupport::JSON::Variable
- ActiveSupport::LogSubscriber
- ActiveSupport::LogSubscriber::TestHelper
- ActiveSupport::LogSubscriber::TestHelper::MockLogger
- ActiveSupport::Memoizable
- ActiveSupport::Memoizable::InstanceMethods
- ActiveSupport::MessageEncryptor
- ActiveSupport::MessageEncryptor::InvalidMessage
- ActiveSupport::MessageVerifier
- ActiveSupport::MessageVerifier::InvalidSignature
- ActiveSupport::Multibyte
- ActiveSupport::Multibyte::Chars
- ActiveSupport::Multibyte::EncodingError
- ActiveSupport::Multibyte::Unicode
- ActiveSupport::Multibyte::Unicode::Codepoint
- ActiveSupport::Multibyte::Unicode::UnicodeDatabase
- ActiveSupport::Notifications
- ActiveSupport::Notifications::Event
- ActiveSupport::Notifications::Fanout
- ActiveSupport::Notifications::Instrumenter
- ActiveSupport::OrderedOptions
- ActiveSupport::Railtie
- ActiveSupport::Rescuable
- ActiveSupport::Rescuable::ClassMethods
- ActiveSupport::SafeBuffer
- ActiveSupport::SecureRandom
- ActiveSupport::StringInquirer
- ActiveSupport::TestCase
- ActiveSupport::Testing
- ActiveSupport::Testing::Assertions
- ActiveSupport::Testing::Declarative
- ActiveSupport::Testing::Isolation
- ActiveSupport::Testing::Isolation::Forking
- ActiveSupport::Testing::Isolation::MiniTest
- ActiveSupport::Testing::Isolation::Subprocess
- ActiveSupport::Testing::Isolation::TestUnit
- ActiveSupport::Testing::Pending
- ActiveSupport::Testing::Performance
- ActiveSupport::Testing::Performance::Benchmarker
- ActiveSupport::Testing::Performance::Metrics
- ActiveSupport::Testing::Performance::Metrics::Base
- ActiveSupport::Testing::Performance::Metrics::CpuTime
- ActiveSupport::Testing::Performance::Metrics::GcRuns
- ActiveSupport::Testing::Performance::Metrics::GcTime
- ActiveSupport::Testing::Performance::Metrics::Memory
- ActiveSupport::Testing::Performance::Metrics::Objects
- ActiveSupport::Testing::Performance::Metrics::ProcessTime
- ActiveSupport::Testing::Performance::Metrics::Time
- ActiveSupport::Testing::Performance::Metrics::WallTime
- ActiveSupport::Testing::Performance::Performer
- ActiveSupport::Testing::Performance::Profiler
- ActiveSupport::Testing::ProxyTestResult
- ActiveSupport::Testing::RemoteError
- ActiveSupport::Testing::SetupAndTeardown
- ActiveSupport::Testing::SetupAndTeardown::ClassMethods
- ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
- ActiveSupport::Testing::SetupAndTeardown::ForMiniTest
- ActiveSupport::TimeWithZone
- ActiveSupport::TimeZone
- ActiveSupport::XmlMini
- ActiveSupport::XmlMini_LibXMLSAX
- ActiveSupport::XmlMini_LibXMLSAX::HashBuilder
- ActiveSupport::XmlMini_NokogiriSAX
- ActiveSupport::XmlMini_NokogiriSAX::HashBuilder
- Test
- Test::Unit
- Test::Unit::Collector
- Test::Unit::Collector::ObjectSpace
- Object
- Object::HashWithIndifferentAccess
- Object::MissingSourceFile
- ERB
- ERB::Util
- I18n
- I18n::Railtie
- LoadError
- LoadError
- Logger
- Logger::SimpleFormatter
- Array
- Benchmark
- BigDecimal
- Class
- Date
- DateTime
- Enumerable
- FalseClass
- File
- Fixnum
- Float
- Hash
- Integer
- Kernel
- Module
- NameError
- NilClass
- Numeric
- Process
- Range
- Regexp
- String
- Symbol
- Time
- TrueClass

No matching classes.

# ActiveSupport::Cache::FileStore

A cache store implementation which stores everything on the filesystem.

FileStore implements the Strategy::LocalCache strategy which implements an in memory cache inside of a block.

### Constants

DIR_FORMATTER

### Attributes

cache_path[R]

### Public Class Methods

new(cache_path, options = nil) click to toggle source

    # File lib/active_support/cache/file_store.rb, line 16
    def initialize(cache_path, options = nil)
      super(options)
      @cache_path = cache_path
      extend Strategy::LocalCache
    end

### Public Instance Methods

cleanup(options = nil) click to toggle source

    # File lib/active_support/cache/file_store.rb, line 27
    def cleanup(options = nil)
      options = merged_options(options)
      each_key(options) do |key|
        entry = read_entry(key, options)
        delete_entry(key, options) if entry && entry.expired?
      end
    end

clear(options = nil) click to toggle source

    # File lib/active_support/cache/file_store.rb, line 22
    def clear(options = nil)
      root_dirs = Dir.entries(cache_path).reject{|f| ['.', '..'].include?(f)}
      FileUtils.rm_r(root_dirs.collect{|f| File.join(cache_path, f)})
    end

decrement(name, amount = 1, options = nil) click to toggle source

    # File lib/active_support/cache/file_store.rb, line 49
    def decrement(name, amount = 1, options = nil)
      file_name = key_file_path(namespaced_key(name, options))
      lock_file(file_name) do
        options = merged_options(options)
        if num = read(name, options)
          num = num.to_i - amount
          write(name, num, options)
          num
        else
          nil
        end
      end
    end

delete_matched(matcher, options = nil) click to toggle source

    # File lib/active_support/cache/file_store.rb, line 63
    def delete_matched(matcher, options = nil)
      options = merged_options(options)
      instrument(:delete_matched, matcher.inspect) do
        matcher = key_matcher(matcher, options)
        search_dir(cache_path) do |path|
          key = file_path_key(path)
          delete_entry(key, options) if key.match(matcher)
        end
      end
    end

increment(name, amount = 1, options = nil) click to toggle source

    # File lib/active_support/cache/file_store.rb, line 35
    def increment(name, amount = 1, options = nil)
      file_name = key_file_path(namespaced_key(name, options))
      lock_file(file_name) do
        options = merged_options(options)
        if num = read(name, options)
          num = num.to_i + amount
          write(name, num, options)
          num
        else
          nil
        end
      end
    end

### Protected Instance Methods

delete_entry(key, options) click to toggle source

    # File lib/active_support/cache/file_store.rb, line 104
    def delete_entry(key, options)
      file_name = key_file_path(key)
      if File.exist?(file_name)
        begin
          File.delete(file_name)
          delete_empty_directories(File.dirname(file_name))
          true
        rescue => e
          # Just in case the error was caused by another process deleting the file first.
          raise e if File.exist?(file_name)
          false
        end
      end
    end

read_entry(key, options) click to toggle source

    # File lib/active_support/cache/file_store.rb, line 76
    def read_entry(key, options)
      file_name = key_file_path(key)
      if File.exist?(file_name)
        entry = File.open(file_name) { |f| Marshal.load(f) }
        if entry && !entry.expired? && !entry.expires_in && !self.options[:expires_in]
          # Check for deprecated use of +:expires_in+ option from versions < 3.0
          deprecated_expires_in = options[:expires_in]
          if deprecated_expires_in
            ActiveSupport::Deprecation.warn('Setting :expires_in on read has been deprecated in favor of setting it on write.', caller)
            if entry.created_at + deprecated_expires_in.to_f <= Time.now.to_f
              delete_entry(key, options)
              entry = nil
            end
          end
        end
        entry
      end
    rescue
      nil
    end

write_entry(key, entry, options) click to toggle source

    # File lib/active_support/cache/file_store.rb, line 97
    def write_entry(key, entry, options)
      file_name = key_file_path(key)
      ensure_cache_path(File.dirname(file_name))
      File.atomic_write(file_name, cache_path) {|f| Marshal.dump(entry, f)}
      true
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.