Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samueleaton/cache-hash
A simple key/value store where pairs can expire after a specified interval
https://github.com/samueleaton/cache-hash
Last synced: 3 months ago
JSON representation
A simple key/value store where pairs can expire after a specified interval
- Host: GitHub
- URL: https://github.com/samueleaton/cache-hash
- Owner: samueleaton
- License: mit
- Created: 2017-08-23T02:10:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-14T23:35:52.000Z (almost 5 years ago)
- Last Synced: 2024-11-02T13:34:08.681Z (3 months ago)
- Language: Crystal
- Homepage:
- Size: 13.7 KB
- Stars: 18
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - cache-hash - A key/value store where entries expire after a specified interval (Caching)
README
# Cache Hash
A simple key value store where pairs can expire after a set interval
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
cache_hash:
github: samueleaton/cache-hash
```
## Usage Example
```ruby
require "cache_hash"
cache_hash = CacheHash(String).new(2.seconds)
cache_hash.set "city1", "Seattle"
sleep 1 # one second elapsed
cache_hash.set "city2", "Hong Kong"
sleep 1 # two seconds elapsed
cache_hash.get "city1" #=> nil
cache_hash.get "city2" #=> "Hong Kong"
```
## API
### `CacheHash(V)`
Defines the type(s) for the values.
#### Example
```ruby
CacheHash(String).new(1.minute)
```
### `.new(cache_time_span : Time::Span)`
Creates a new instance of `CacheHash` and sets the cache interval.
### `.set(key : String, value : V)`
Adds a key/value pair to the hash, where `V` is the type(s) defined at `CacheHash(V)`, and saves the time of the action.
### `.get(key : String) : V | Nil`
Returns the value for the the associated key. If the pair is stale (expired) or does not exists, it returns `nil`. If it exists but is expired, it is deleted before returning `nil`.
### `.purge`
Removes all key/value pairs from the hash.
### `.purge_stale`
Removes all stale key/value pairs from the hash.
### `.keys() : Array(String)`
Runs `purge_stale` and returns an array of all the the non-stale keys.
### `.fresh?(key : String) : Bool`
Returns `true` if the key/value pair exists and is not stale. If the pair is stale (expired) or does not exists, it returns `false`. If it exists but is expired, it is deleted before returning `false`.
### `.time(key : String) : Time`
Returns the time the key/value pair was cached. If the pair is stale (expired) or does not exists, it returns `nil`. If it exists but is expired, it is deleted before returning `nil`.
### `.refresh(key : String) : V | Nil`
Refreshes the time for the key/value pair and returns the hash value if successful, otherwise returns `nil`.
## Contributing
1. Fork it ( https://github.com/samueleaton/cache_hash/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [Sam Eaton](https://github.com/samueleaton) - creator, maintainer