stockpile-redis¶ ↑
- code
- bugs
- continuous integration
Description¶ ↑
stockpile-redis is a connection manager for Redis to be used with Stockpile.
Features¶ ↑
stockpile-redis supports both normal Redis connections (Redis.new
), and Redis::Namespace connections (Redis::Namespace.new('namespace', redis: Redis.new)
).
stockpile-redis provides special-case handling for connections for Resque when the name of the client is :resque
.
Release 2.0 fixes an issue with initialization using OpenStruct for options. Ruby 1.9 is no longer supported.
Synopsis¶ ↑
require 'stockpile/redis' wide = Stockpile.new(manager: Stockpile::Redis) # A Stockpile to Redis. wide.connection.set('hello', 'world') # => 'OK' wide.connection.get('hello') # => 'world' # Connections are independent from one another. wide.connection_for(:other) != wide.connection # => true # A 'narrow' Stockpile to Redis. narrow = Stockpile.new(manager: Stockpile::Redis, narrow: true) # Or set ENV['STOCKPILE_CONNECTION_WIDTH'] = 'narrow' and call Stockpile.new # normally. narrow.connection_for(:other) == narrow.connection # => true # Special Redis::Namespace handling for Resque clients. narrow.connection_for(:resque) != narrow.connection # => true narrow.connection_for(:resque).redis == narrow.connection # => true # Standard namespace handling. narrow.connection_for(:other, namespace: 'other') != narrow.connection # => true narrow.connection_for(:other, namespace: 'other').redis != narrow.connection # => true # Show a Stockpile with no adapter capabilities, but name the method # stockpile, not cache. This will still usefully manage connections. # The use of inject_redis! makes Stockpile::Redis the default connection # manager for the Cacher module Stockpile. module Cacher Stockpile.inject_redis!(self, method: :stockpile, adaptable: false) end Cacher.respond_to?(:stockpile) # => true Cacher.respond_to?(:stockpile_adapter) # => false Cacher.stockpile.connection.set('hello', 'world') # => 'OK' Cacher.stockpile.connection.get('hello') # => 'world' # Now a Stockpile with adapter capabilities. module Jobber module LastRunTime def last_run_time(key, value = nil) if value connection.hset(__method__, key, value.utc.iso8601) else value = connection.hget(__method__, key) Time.parse(value) if value end end end Stockpile.inject_redis!(self) end Jobber.respond_to?(:cache) # => true Jobber.respond_to?(:cache_adapter) # => true # Four ways: # 1. Adapt Jobber.cache to recognize #last_run_time. Jobber.cache_adapter(Jobber::LastRunTime) Jobber.cache.last_run_time('hello', t = Time.now) # => true Jobber.cache.last_run_time('hello') # => approximately t # 2. Adapt Jobber.cache and another module to recognize #last_run_time. module Foo; end Jobber.cache_adapter(Jobber::LastRunTime, Foo) Foo.last_run_time('hello', t = Time.now) # => true Foo.last_run_time('hello') # => approximately t # 3. Adapt Jobber.cache and Jobber to recognize #last_run_time. Jobber.cache_adapter(Jobber::LastRunTime, Jobber) Jobber.last_run_time('hello', t = Time.now) # => true Jobber.last_run_time('hello') # => approximately t # 4. Adapt Jobber.cache and Jobber::LastRunTime to recognize #last_run_time. Jobber.cache_adapter!(Jobber::LastRunTime) # or Jobber.cache_adapter(Jobber::LastRunTime, Jobber::LastRunTime) Jobber::LastRunTime.last_run_time('hello', t = Time.now) # => true Jobber::LastRunTime.last_run_time('hello') # => approximately t
Install¶ ↑
Put stockpile-redis in your Gemfile:
gem 'stockpile-redis', '~> 2.0'
Or manually install:
% gem install stockpile-redis
and require Stockpile
in your code:
require 'stockpile/redis'
stockpile-redis Semantic Versioning¶ ↑
stockpile-redis uses a Semantic Versioning scheme with one change:
-
When PATCH is zero (
0
), it will be omitted from version references.
Contributing¶ ↑
I value any contribution to stockpile-redis you can provide: a bug report, a feature request, or code contributions.
As stockpile-redis is a complex codebase, there are a few guidelines:
-
Changes will not be accepted without tests. The test suite is written with Minitest.
-
Match my coding style.
-
Use a thoughtfully-named topic branch that contains your change. Rebase your commits into logical chunks as necessary.
-
Do not change the version number; when your patch is accepted and a release is made, the version will be updated at that point.
-
Submit a GitHub pull request with your changes.
-
New behaviours require new or updated documentation.
Test Dependencies¶ ↑
stockpile-redis uses Ryan Davis’s Hoe to manage the release process, and it adds a number of rake tasks. You will mostly be interested in:
$ rake
which runs the tests the same way that:
$ rake test $ rake travis
will do.
To assist with the installation of the development dependencies for stockpile-redis, I have provided the simplest possible Gemfile pointing to the (generated) stockpile-redis.gemspec
file. This will permit you to do:
$ bundle install
to get the development dependencies. If you aleady have hoe
installed, you can accomplish the same thing with:
$ rake newb
This task will install any missing dependencies, run the tests/specs, and generate the RDoc.
Workflow¶ ↑
Here's the most direct way to get your work merged into the project:
-
Fork the project.
-
Clone down your fork (
git clone git://github.com/halostatue/stockpile-redis.git
). -
Create a topic branch to contain your change (
git checkout -b my_awesome_feature
). -
Hack away, add tests. Not necessarily in that order.
-
Make sure everything still passes by running
rake
. -
If necessary, rebase your commits into logical chunks, without errors.
-
Push the branch up (
git push origin my_awesome_feature
). -
Create a pull request against halostatue/stockpile-redis and describe what your change does and the why you think it should be merged.
Contributors¶ ↑
-
Austin Ziegler created stockpile-redis.
Licence¶ ↑
This software is available under an MIT-style licence.
-
Copyright 2015–2016 Austin Ziegler
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
The names of its contributors may not be used to endorse or promote products derived from this software without specific prior written permission.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.