CacheStoreRedis

Welcome to CacheStore!

This is the redis implementation for cache_store.

Installation

Add this line to your application's Gemfile:

gem 'cache_store_redis'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cache_store_redis

Testing

To run the tests locally, we use Docker to provide a Ruby container.

Setup Images:

This builds the Ruby docker image.

./script/setup.sh

Run Tests:

This executes the test suite

./script/test.sh

Cleanup

This is used to clean down docker images created in the setup script.

./script/cleanup.sh

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb and when release tag is created, Github Action pipeline will publish the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sage/cache_store_redis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

Cache Store is available as open source under the terms of the MIT licence.

Copyright (c) 2018 Sage Group Plc. All rights reserved.