Project

zache

0.05
No release in over 3 years
Low commit activity in last 3 years
Zero-footprint in-memory thread-safe cache
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

= 5.11.3
= 12.3.1
= 4.3.0
= 0.62.0
= 0.3.0
 Project Readme

EO principles respected here DevOps By Rultor.com We recommend RubyMine

Build Status Build status Gem Version Maintainability Yard Docs

License Test Coverage Hits-of-Code

It's a simple Ruby gem for in-memory cache. Read this blog post to understand what Zache is for.

First, install it:

$ gem install zache

Then, use it like this

require 'zache'
zache = Zache.new
# Expires in 5 minutes
v = zache.get(:count, lifetime: 5 * 60) { expensive() }

By default Zache is thread-safe. It locks the entire cache on each get call. You turn that off by using sync argument:

zache = Zache.new(sync: false)
v = zache.get(:count) { expensive() }

You may use "dirty" mode, which will return you an expired value, while calculation is waiting. Say, you have something in the cache, but it's expired. Then, you call get with a long running block. The thread waits, while another one calls get again. That second thread won't wait, but will receive what's left in the cache. This is a very convenient mode for situations when you don't really care about data accuracy, but performance is an issue.

The entire API is documented here (there are many other convenient methods).

That's it.

How to contribute

Read these guidelines. Make sure you build is green before you contribute your pull request. You will need to have Ruby 2.3+ and Bundler installed. Then:

$ bundle update
$ bundle exec rake

If it's clean and you don't see any error messages, submit your pull request.