Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dannyben/lightly
Ruby file cache for performing heavy tasks, lightly.
https://github.com/dannyben/lightly
cache cache-control gem ruby
Last synced: 20 days ago
JSON representation
Ruby file cache for performing heavy tasks, lightly.
- Host: GitHub
- URL: https://github.com/dannyben/lightly
- Owner: DannyBen
- License: mit
- Created: 2016-05-25T17:08:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T05:39:40.000Z (11 months ago)
- Last Synced: 2024-10-19T15:53:20.682Z (about 1 month ago)
- Topics: cache, cache-control, gem, ruby
- Language: Ruby
- Homepage:
- Size: 53.7 KB
- Stars: 39
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lightly - Ruby File Cache
[](https://badge.fury.io/rb/lightly)
[](https://github.com/DannyBen/lightly/actions?query=workflow%3ATest)
[](https://codeclimate.com/github/DannyBen/lightly/maintainability)
---
Lightly is a file cache for performing heavy tasks, lightly.
---
## Install
```shell
$ gem install lightly
```
Or with bundler:
```ruby
gem 'lightly'
```
## Usage
Lightly can be used both as an instance, and as a static class.
```ruby
require 'lightly'
# Instance
lightly = Lightly.new life: '3h'
response = lightly.get 'key' do
# Heavy operation here
end
# Static
Lightly.life = '3h'
response = Lightly.get 'key' do
# Heavy operation here
end
```
The design intention is to provide both a globally available singleton
`Lightly` object, as well as multiple caching instances, with different
settings - depending on the use case.
Note that the examples in this document are all using the instance syntax,
but all methods are also available statically.
This is the basic usage pattern:
```ruby
require 'lightly'
lightly = Lightly.new
content = lightly.get 'key' do
# Heavy operation here
entire_internet.download
end
```
This will look for a cached object with the given key and return it
if it exists and not older than 1 hour. Otherwise, it will perform the
operation inside the block, and save it to the cache object.
By default, the cached objects are stored in the `./cache` directory, and
expire after 60 minutes. The cache directory will be created as needed.
In addition, the provided key is hashed to its MD5 representation, and the file
permissions are optionally set.
You can change these settings on initialization:
```ruby
lightly = Lightly.new dir: 'tmp/my_cache', life: 7200,
hash: false, permissions: 0o640
```
Or later:
```ruby
lightly = Lightly.new
lightly.dir = 'tmp/my_cache'
lightly.life = '1d'
lightly.hash = false
lightly.permissions = 0o640
```
The `life` property accepts any of these formats:
```ruby
lightly.life = 10 # 10 seconds
lightly.life = '20s' # 20 seconds
lightly.life = '10m' # 10 minutes
lightly.life = '10h' # 10 hours
lightly.life = '10d' # 10 days
```
To check if a key is cached, use the `cached?` method:
```ruby
lightly = Lightly.new
lightly.cached? 'example'
# => false
content = lightly.get 'example' do
open('http://example.com').read
end
lightly.cached? 'example'
# => true
```
You can enable/disable the cache at any time:
```ruby
lightly = Lightly.new
lightly.disable
lightly.enabled?
# => false
content = lightly.get 'example' do
open('http://example.com').read
end
lightly.cached? 'example'
# => false
lightly.enable
content = lightly.get 'example' do
open('http://example.com').read
end
lightly.cached? 'example'
# => true
```
To flush the cache, call:
```ruby
lightly = Lightly.new
lightly.flush
```
To clear the cache for a given key, call:
```ruby
lightly = Lightly.new
lightly.clear 'example'
```
To clear all expired keys, call:
```ruby
lightly = Lightly.new
lightly.prune
```
If your block returns `false` or `nil`, the data will not be cached:
```ruby
result = lightly.get 'test' do
false
end
puts lightly.cached? 'test'
# => false
```
## Related Projects
For a similar gem that provides caching specifically for HTTP downloads,
see the [WebCache gem][webcache].
## Contributing / Support
If you experience any issue, have a question or a suggestion, or if you wish
to contribute, feel free to [open an issue][issues].
---
[webcache]: https://github.com/DannyBen/webcache
[issues]: https://github.com/DannyBen/lightly/issues