rails/activesupport
Brian Durand ee51b51b60 ActiveSupport::Cache refactoring
All Caches

* Add default options to initializer that will be sent to all read, write, fetch, exist?, increment, and decrement
* Add support for the :expires_in option to fetch and write for all caches. Cache entries are stored with the create timestamp and a ttl so that expiration can be handled independently of the implementation.
* Add support for a :namespace option. This can be used to set a global prefix for cache entries.
* Deprecate expand_cache_key on ActiveSupport::Cache and move it to ActionController::Caching and ActionDispatch::Http::Cache since the logic in the method used some Rails specific environment variables and was only used by ActionPack classes. Not very DRY but there didn't seem to be a good shared spot and ActiveSupport really shouldn't be Rails specific.
* Add support for :race_condition_ttl to fetch. This setting can prevent race conditions on fetch calls where several processes try to regenerate a recently expired entry at once.
* Add support for :compress option to fetch and write which will compress any data over a configurable threshold.
* Nil values can now be stored in the cache and are distinct from cache misses for fetch.
* Easier API to create new implementations. Just need to implement the methods read_entry, write_entry, and delete_entry instead of overwriting existing methods.
* Since all cache implementations support storing objects, update the docs to state that ActiveCache::Cache::Store implementations should store objects. Keys, however, must be strings since some implementations require that.
* Increase test coverage.
* Document methods which are provided as convenience but which may not be universally available.

MemoryStore

* MemoryStore can now safely be used as the cache for single server sites.
* Make thread safe so that the default cache implementation used by Rails is thread safe. The overhead is minimal and it is still the fastest store available.
* Provide :size initialization option indicating the maximum size of the cache in memory (defaults to 32Mb).
* Add prune logic that removes the least recently used cache entries to keep the cache size from exceeding the max.
* Deprecated SynchronizedMemoryStore since it isn't needed anymore.

FileStore

* Escape key values so they will work as file names on all file systems, be consistent, and case sensitive
* Use a hash algorithm to segment the cache into sub directories so that a large cache doesn't exceed file system limits.
* FileStore can be slow so implement the LocalCache strategy to cache reads for the duration of a request.
* Add cleanup method to keep the disk from filling up with expired entries.
* Fix increment and decrement to use file system locks so they are consistent between processes.

MemCacheStore

* Support all keys. Previously keys with spaces in them would fail
* Deprecate CompressedMemCacheStore since it isn't needed anymore (use :compress => true)

[#4452 state:committed]

Signed-off-by: Jeremy Kemper <jeremy@bitsweat.net>
2010-04-27 11:13:37 -07:00
..
bin Simplify ActiveSupport::Multibyte and make it run on Ruby 1.9. 2008-09-21 17:21:30 +02:00
lib ActiveSupport::Cache refactoring 2010-04-27 11:13:37 -07:00
test ActiveSupport::Cache refactoring 2010-04-27 11:13:37 -07:00
activesupport.gemspec Neat and tidy, I say 2010-04-01 13:46:04 -07:00
CHANGELOG ActiveSupport::Cache refactoring 2010-04-27 11:13:37 -07:00
install.rb Fixed spelling errors (closes #9706) [tarmo/rmm5t] 2007-09-28 14:18:47 +00:00
MIT-LICENSE Updating copyright dates on all licenses 2010-02-01 10:10:53 +11:00
Rakefile Leverage VERSION constants from gemspecs to avoid tedious updates when releasing 2010-03-02 00:32:53 -05:00
README Fix READMEs (closes #2680) [coffee2code] 2005-11-07 09:51:47 +00:00

= Active Support -- Utility classes and standard library extensions from Rails

Active Support is a collection of various utility classes and standard library extensions that were found useful
for Rails. All these additions have hence been collected in this bundle as way to gather all that sugar that makes
Ruby sweeter.


== Download

The latest version of Active Support can be found at

* http://rubyforge.org/project/showfiles.php?group_id=182

Documentation can be found at 

* http://as.rubyonrails.com


== Installation

The preferred method of installing Active Support is through its GEM file. You'll need to have
RubyGems[http://rubygems.rubyforge.org/wiki/wiki.pl] installed for that, though. If you have it,
then use:

  % [sudo] gem install activesupport-1.0.0.gem


== License

Active Support is released under the MIT license.


== Support

The Active Support homepage is http://www.rubyonrails.com. You can find the Active Support
RubyForge page at http://rubyforge.org/projects/activesupport. And as Jim from Rake says:

   Feel free to submit commits or feature requests.  If you send a patch,
   remember to update the corresponding unit tests.  If fact, I prefer
   new feature to be submitted in the form of new unit tests.

For other information, feel free to ask on the ruby-talk mailing list
(which is mirrored to comp.lang.ruby) or contact mailto:david@loudthinking.com.