readthis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 076d20cf4f8bffa4b9a6b6ced603f65020bea46c
+  data.tar.gz: bcb7899c7aa4f98d206ae7fea3e6fc388c7036b4
+SHA512:
+  metadata.gz: be88ade839408848ba227ece979dc2d4bb5b4621cdca98eb1f6a3b61fae3d00468940cb9c32eb02b3ca6438e882c680019035583f65c54ed58bd69e33f2c5e3d
+  data.tar.gz: dcb48683aaa8ef72cf0e6770f0334245db4f6198fa244486115123a497ee9bc897568687727ef582ec40b220f81f6b1c1c1221b9c1527a80df714f090a1c4fa5

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+TODO

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0 2014-11-22
+
+- Initial release! Working as a drop in replacement for `redis_store`.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in readthis.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Parker Selbert
+
+MIT License
+
+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 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.

data/README.md

@@ -0,0 +1,34 @@
+# Readthis
+
+An ActiveSupport::Cache compatible redis based cache focused on speed,
+simplicity, and forced pooling.
+
+The only dependencies are `redis` and `connection_pool`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'readthis'
+```
+
+## Usage
+
+Use it the same way as any other [ActiveSupport::Cache::Store][store]. Readthis
+supports all of the standard cache methods except for the following (with
+reasons):
+
+* `cleanup` - redis does this with ttl for us already
+* `delete_matched` - you really don't want to do perform key matching operations
+  in redis. They are linear time and only support basic globbing.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/readthis/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
+
+[store]: http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/active_support/cache/readthis_store.rb

@@ -0,0 +1,7 @@
+require 'readthis'
+
+module ActiveSupport
+  module Cache
+    ReadthisStore ||= Readthis::Cache
+  end
+end

data/lib/readthis/cache.rb

@@ -0,0 +1,140 @@
+require 'redis'
+require 'connection_pool'
+
+module Readthis
+  class Cache
+    attr_reader :expires_in, :namespace, :pool
+
+    # Creates a new Readthis::Cache object with the given redis URL. The URL
+    # is parsed by the redis client directly.
+    def initialize(url, options = {})
+      @expires_in = options.fetch(:expires_in, nil)
+      @namespace  = options.fetch(:namespace, nil)
+
+      @pool = ConnectionPool.new(pool_options(options)) do
+        Redis.new(url: url)
+      end
+    end
+
+    def read(key, options = {})
+      with do |store|
+        store.get(namespaced_key(key, merged_options(options)))
+      end
+    end
+
+    def write(key, value, options = {})
+      options    = merged_options(options)
+      namespaced = namespaced_key(key, options)
+
+      with do |store|
+        if expiration = options[:expires_in]
+          store.setex(namespaced, expiration, value)
+        else
+          store.set(namespaced, value)
+        end
+      end
+    end
+
+    def delete(key, options = {})
+      with do |store|
+        store.del(namespaced_key(key, merged_options(options)))
+      end
+    end
+
+    def fetch(key, options = {})
+      value = read(key, options) unless options[:force]
+
+      if value.nil? && block_given?
+        value = yield(key)
+        write(key, value, options)
+      end
+
+      value
+    end
+
+    def increment(key, options = {})
+      with do |store|
+        store.incr(namespaced_key(key, merged_options(options)))
+      end
+    end
+
+    def decrement(key, options = {})
+      with do |store|
+        store.decr(namespaced_key(key, merged_options(options)))
+      end
+    end
+
+    def read_multi(*keys)
+      options = merged_options(extract_options!(keys))
+      results = []
+
+      with do |store|
+        results = store.pipelined do
+          keys.each { |key| store.get(namespaced_key(key, options)) }
+        end
+      end
+
+      keys.zip(results).to_h
+    end
+
+    # This must be done in two separate blocks. Redis pipelines return
+    # futures, which can not be resolved until the pipeline has exited.
+    def fetch_multi(*keys)
+      results = read_multi(*keys)
+      options = merged_options(extract_options!(keys))
+
+      with do |store|
+        store.pipelined do
+          results.each do |key, value|
+            if value.nil?
+              value = yield key
+              write(key, value, options)
+              results[key] = value
+            end
+          end
+        end
+      end
+
+      results
+    end
+
+    def exist?(key, options = {})
+      with do |store|
+        store.exists(namespaced_key(key, merged_options(options)))
+      end
+    end
+
+    def clear
+      with do |store|
+        store.flushdb
+      end
+    end
+
+    private
+
+    def with(&block)
+      pool.with(&block)
+    end
+
+    def extract_options!(array)
+      array.last.is_a?(Hash) ? array.pop : {}
+    end
+
+    def merged_options(options)
+      options[:namespace]  ||= namespace
+      options[:expires_in] ||= expires_in
+      options
+    end
+
+    def pool_options(options)
+      { size:    options.fetch(:pool_size, 5),
+        timeout: options.fetch(:pool_timeout, 5) }
+    end
+
+    def namespaced_key(key, options)
+      namespace = options[:namespace]
+
+      [namespace, key].compact.join(':')
+    end
+  end
+end

data/lib/readthis/version.rb

@@ -0,0 +1,3 @@
+module Readthis
+  VERSION = '0.1.0'
+end

data/lib/readthis.rb

@@ -0,0 +1,5 @@
+require 'readthis/cache'
+require 'readthis/version'
+
+module Readthis
+end

data/readthis.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'readthis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'readthis'
+  spec.version       = Readthis::VERSION
+  spec.authors       = ['Parker Selbert']
+  spec.email         = ['parker@sorentwo.com']
+  spec.summary       = 'Pooled active support compliant caching with redis'
+  spec.description   = 'Pooled active support compliant caching with redis'
+  spec.homepage      = 'https://github.com/sorentwo/readthis'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'redis',           '~> 3.0'
+  spec.add_dependency 'connection_pool', '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.1'
+end

data/spec/readthis/cache_spec.rb

@@ -0,0 +1,153 @@
+require 'readthis/cache'
+
+RSpec.describe Readthis::Cache do
+  let(:url)   { 'redis://localhost:6379/11' }
+  let(:cache) { Readthis::Cache.new(url) }
+
+  after do
+    cache.clear
+  end
+
+  describe '#initialize' do
+    it 'accepts and persists a namespace' do
+      cache = Readthis::Cache.new(url, namespace: 'kash')
+
+      expect(cache.namespace).to eq('kash')
+    end
+
+    it 'accepts and persists an expiration' do
+      cache = Readthis::Cache.new(url, expires_in: 10)
+
+      expect(cache.expires_in).to eq(10)
+    end
+  end
+
+  describe '#write' do
+    it 'stores strings in the cache' do
+      cache.write('some-key', 'some-value')
+
+      expect(cache.read('some-key')).to eq('some-value')
+    end
+
+    it 'stores values within a namespace' do
+      cache.write('some-key', 'some-value', namespace: 'cache')
+
+      expect(cache.read('some-key')).to be_nil
+      expect(cache.read('some-key', namespace: 'cache')).to eq('some-value')
+    end
+
+    it 'uses a custom expiration' do
+      cache.write('some-key', 'some-value', expires_in: 1)
+
+      expect(cache.read('some-key')).not_to be_nil
+      sleep 1.01
+      expect(cache.read('some-key')).to be_nil
+    end
+  end
+
+  describe '#fetch' do
+    it 'gets an existing value' do
+      cache.write('great-key', 'great')
+      expect(cache.fetch('great-key')).to eq('great')
+    end
+
+    it 'sets the value from the provided block' do
+      value = 'value for you'
+      cache.fetch('missing-key') { value }
+      expect(cache.read('missing-key')).to eq(value)
+    end
+
+    it 'does not set for a missing key without a block' do
+      expect(cache.fetch('missing-key')).to be_nil
+    end
+
+    it 'forces a cache miss when `force` is passed' do
+      cache.write('short-key', 'stuff')
+      cache.fetch('short-key', force: true) { 'other stuff' }
+
+      expect(cache.read('short-key')).to eq('other stuff')
+    end
+  end
+
+  describe '#read_multi' do
+    it 'maps multiple values to keys' do
+      cache.write('a', 1)
+      cache.write('b', 2)
+      cache.write('c', 3)
+
+      expect(cache.read_multi('a', 'b', 'c')).to eq(
+        'a' => '1',
+        'b' => '2',
+        'c' => '3',
+      )
+    end
+
+    it 'respects namespacing' do
+      cache.write('d', 1, namespace: 'cache')
+      cache.write('e', 2, namespace: 'cache')
+
+      expect(cache.read_multi('d', 'e', namespace: 'cache')).to eq(
+        'd' => '1',
+        'e' => '2',
+      )
+    end
+  end
+
+  describe '#fetch_multi' do
+    it 'reads multiple values, filling in missing keys from a block' do
+      cache.write('a', 1)
+      cache.write('c', 3)
+
+      results = cache.fetch_multi('a', 'b', 'c') { |key| key + key }
+
+      expect(results).to eq(
+        'a' => '1',
+        'b' => 'bb',
+        'c' => '3',
+      )
+    end
+  end
+
+  describe '#exist?' do
+    it 'is true when the key has been set' do
+      cache.write('existing-key', 'stuff')
+      expect(cache.exist?('existing-key')).to be_truthy
+    end
+
+    it 'is false when the key has not been set' do
+      expect(cache.exist?('random-key')).to be_falsey
+    end
+  end
+
+  describe '#delete' do
+    it 'deletes an existing key' do
+      cache.write('not-long', 'for this world')
+      cache.delete('not-long')
+
+      expect(cache.read('not-long')).to be_nil
+    end
+  end
+
+  describe '#increment' do
+    it 'atomically increases the stored integer' do
+      cache.write('counter', 10)
+      expect(cache.increment('counter')).to eq(11)
+      expect(cache.read('counter')).to eq('11')
+    end
+
+    it 'defaults a missing key to 1' do
+      expect(cache.increment('unknown')).to eq(1)
+    end
+  end
+
+  describe '#decrement' do
+    it 'decrements a stored integer' do
+      cache.write('counter', 20)
+      expect(cache.decrement('counter')).to eq(19)
+    end
+
+    it 'defaults a missing key to -1' do
+      expect(cache.decrement('unknown')).to eq(-1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: readthis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Parker Selbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Pooled active support compliant caching with redis
+email:
+- parker@sorentwo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rspec
+- lib/active_support/cache/readthis_store.rb
+- lib/readthis.rb
+- lib/readthis/cache.rb
+- lib/readthis/version.rb
+- readthis.gemspec
+- spec/readthis/cache_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sorentwo/readthis
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Pooled active support compliant caching with redis
+test_files:
+- spec/readthis/cache_spec.rb
+- spec/spec_helper.rb