cache_for 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGM5ZTkxOTE1MDExMjIzMDU5Y2MwZWZjYzhhMDYzYmExN2U5ZTNiZQ==
+  data.tar.gz: !binary |-
+    YmExZjMyOTEwY2I2OWI0ZDFjYjMzMDhkMGFhYTdiMTg1NGQ2YTIxMQ==
+SHA512:
+  metadata.gz: !binary |-
+    YzkzODRlY2IwNzIwMjZkNGM1OWI4MmExZWNhNzM2MTFhNGE2N2ZhOWE5YzM1
+    MmNlZmFhOWQxZDQ1NTJlZDgyYjFhMTQ5ODJlNjc3M2MyODU0MTQ3ZWMzOGIw
+    NGQwMjA3YjY5ZmJhNTYxNDYxOTUxNzk2MzljYWFhYzJjYWQ1ODI=
+  data.tar.gz: !binary |-
+    NTgyMDI2MmZiNDM3NjhjMzBiMGU5OGZhM2I4YzVmMmViNDA5ZGM1NmNlZjMy
+    OTI3MmQ5NzM1Y2JhNTVhMzE1ZDJjOWQzMGY1NmMxNTJjNDVjOWRhNTg2Yjgw
+    MTljYjc0YzFhNDUwN2ExZGZjNjVmM2I4OTFhZjNkZTVmNjU4Mjg=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+- 2.2.0
+- 2.2.1
+- 2.2.2
+before_script: sudo redis-server /etc/redis/redis.conf
+before_install:
+- gem install bundler
+script: bundle exec rspec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: MWXk12XXWJ/Zz44uS/zrPVYM3wTyel9DYciInGFea5ZetJqnjn10CcNXAhKONvmgjT1EGz6yQnx1JicN9IeQ/OeRZsTArIpAeoYBVDQg4tlrHHVQAOEqr9MVrskIYcMdRttrpmHnzoRuNdWZkCG/pvE6KM3V0sOaXA+2FUfgMOU=
+  gem: cache_for
+  on:
+    tags: true
+    repo: westfieldlabs/cache_for

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cache_for.gemspec
+gemspec
+
+group :test do
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    cache_for (1.1.0)
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    chronic_duration (0.10.2)
+      numerizer (~> 0.1.1)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.0)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.2.4)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.0.4)
+      guard (>= 2.1.1)
+      rspec (~> 2.14)
+    listen (2.2.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    multi_json (1.8.2)
+    numerizer (0.1.1)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    redis (3.0.6)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    spec (5.0.19)
+      chronic_duration (~> 0.10.2)
+    thor (0.18.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  cache_for!
+  guard
+  guard-rspec
+  rake
+  simplecov
+  spec

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, all_on_start: true, all_after_pass: true, :cli => "--colour --format nested" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Mell
+
+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,26 @@
+# CacheFor
+
+A simple wrapper around a redis store to implement keys with a timestamp.
+
+The "For" in CacheFor refers to 1) the content labeled by the key name, and 2) the cache duration.
+
+## Installation
+Ruby ~>2.0.0 required.
+
+Add this gem to your application's Gemfile:
+
+    gem 'cache_for'
+
+## Usage
+In your app, wherever you need some caching sweetness
+
+    CacheForApp = CacheFor::Base.new()
+    values = CacheForApp.fetch('Product-options') { Product.all.collect {|product| [product.name, product.id]} }
+
+Optionally, set a redis endpoint
+
+    CacheFor::Base.new( 'redis://localhost:6379' )
+
+Optionally, set a default TTL
+
+    CacheFor::Base.new( default_secs: 600 )

data/Rakefile

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

data/cache_for.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_for/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache_for"
+  spec.version       = CacheFor::VERSION
+  spec.authors       = ["Michael Mell"]
+  spec.email         = ["mike.mell@nthwave.net"]
+  spec.description   = %q{Provide a simple interface to redis with self-expiring keys.}
+  spec.summary       = %q{Provide a simple interface to redis with self-expiring keys.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "spec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
+  spec.add_dependency 'redis'
+end

data/lib/cache_for.rb

@@ -0,0 +1,5 @@
+require "cache_for/version"
+require "cache_for/base"
+
+module CacheFor
+end

data/lib/cache_for/base.rb

@@ -0,0 +1,74 @@
+require 'cache_for'
+require 'time'
+require 'redis'
+require 'uri'
+
+module CacheFor
+
+  class Base
+    attr_accessor :for_seconds
+    attr_accessor :redis_store
+
+    DefaultSeconds = 600 # 10 minutes
+    CacheMiss = nil
+
+    # When redis_uri == nil, Redis gem will use its own
+    # default url, typically redis://locahost:6379.
+    def initialize(redis_uri = nil, default_seconds: Base::DefaultSeconds)
+      @for_seconds = default_seconds
+      @redis_store = Redis.new url: redis_uri
+    end
+
+    def get(name, seconds = nil)
+      begin
+        if found = @redis_store.get(key_for(name, seconds))
+          puts "cache hit #{key_for(name, seconds)}"
+          found
+        end
+      rescue
+        puts "cache miss #{key_for(name, seconds)}"
+        self.class::CacheMiss
+      end
+    end
+    alias_method :read, :get
+
+    def set(name, value, seconds = nil)
+      begin
+        @redis_store.set(key_for(name, seconds), value)
+      rescue
+      end
+    end
+    alias_method :write, :set
+
+    def expire(name, seconds = nil)
+      begin
+        @redis_store.expire(key_for(name, seconds))
+      rescue
+      end
+    end
+
+    def cache_time(seconds = nil)
+      seconds ||= for_seconds
+      # a time integer that remains unchanging for <seconds> seconds
+      #   rounds down to nearest multiple of seconds
+      (seconds * (Time.now.to_i / seconds).to_i)
+    end
+
+    def key_for(name, seconds = nil)
+      "#{name}#{cache_time(seconds)}"
+    end
+
+    def fetch(name, seconds = nil)
+      if (cached = get(name, seconds)) != self.class::CacheMiss
+        cached
+      else
+        new_value = yield
+        set(name, new_value, seconds)
+        expire(name, seconds)
+        new_value
+      end
+    end
+
+  end
+
+end

data/lib/cache_for/version.rb

@@ -0,0 +1,3 @@
+module CacheFor
+  VERSION = "1.1.0"
+end

data/spec/lib/cache_for/base_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+require 'cache_for'
+
+describe CacheFor::Base do
+
+  describe "can read" do
+    subject { CacheFor::Base.new } # the test environment must have a redis instance running on the default localhost:6379
+    let(:now) { Time.now.to_s }
+    let(:key) {__FILE__}
+
+    it "what it wrote" do
+      subject.write(key, now)
+      subject.read(key).should == now
+    end
+
+    it "will not read what in did not write" do
+      subject.read('aoue').should == subject.class::CacheMiss
+    end
+
+  end
+end

data/spec/lib/cache_for_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+require 'cache_for/base'
+
+shared_examples "cache_time is" do |secs, cache_time|
+  before {
+    static_time.now.stub(:to_i) { secs }
+  }
+
+  it "#{cache_time} when time is #{secs}" do
+    CacheFor::Base.new('redis://redis.example.com', default_seconds: duration).cache_time.should == cache_time
+  end
+end
+
+describe 'CacheFor' do
+  describe "#new" do
+    context "with nil url" do
+      subject { CacheFor::Base.new.redis_store.client }
+      its(:scheme) { should eq 'redis' }
+      its(:host) { should eq '127.0.0.1' }
+      its(:port) { should eq 6379 }
+      its(:db) { should eq 0 }
+    end
+
+    context "with url" do
+      let(:url) { 'redis://dummy.com:6666/6' }
+      subject { CacheFor::Base.new(url).redis_store.client }
+      its(:scheme) { should eq 'redis' }
+      its(:host) { should eq 'dummy.com' }
+      its(:port) { should eq 6666 }
+      its(:db) { should eq 6 }
+    end
+  end
+end
+
+describe 'CacheFor#cache_time' do
+
+  describe "cache_time" do
+    let(:static_time) { double("StaticTime") }
+
+    before {
+      stub_const("Time", static_time)
+      static_time.stub(:now) { static_time }
+    }
+
+    it "Time.now.to_i should be stubbable" do
+      static_time.now.stub(:to_i) { 1000 }
+      Time.now.to_i.should == 1000
+    end
+
+    context "when duration is 10" do
+      let(:duration) { 10 }
+
+      it_behaves_like "cache_time is", 1011, 1010
+      it_behaves_like "cache_time is", 1001, 1000
+      it_behaves_like "cache_time is", 1000, 1000
+      it_behaves_like "cache_time is", 999, 990
+      it_behaves_like "cache_time is", 550, 550
+    end
+
+    context "when duration is 100" do
+      let(:duration) { 100 }
+
+      it_behaves_like "cache_time is", 1101, 1100
+      it_behaves_like "cache_time is", 1001, 1000
+      it_behaves_like "cache_time is", 1000, 1000
+      it_behaves_like "cache_time is", 999, 900
+      it_behaves_like "cache_time is", 550, 500
+    end
+
+    context "when duration is 600" do
+      let(:duration) { 600 }
+
+      it_behaves_like "cache_time is", 1601, 1200
+      it_behaves_like "cache_time is", 1001, 600
+      it_behaves_like "cache_time is", 1000, 600
+      it_behaves_like "cache_time is", 999, 600
+      it_behaves_like "cache_time is", 550, 0
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'simplecov'
+SimpleCov.start
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'default'
+end

data/spec/support/rack_application.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rack'
+require 'cache_for/rack'
+
+class HelloCacheFor
+
+  def new(redis_uri)
+    @cache_for = CacheFor::Base.new(redis_uri)
+  end
+
+  def call(env)
+
+    [200, {"Content-Type" => "text/html"}, "Hello Rack!"]
+  end
+end
+
+Rack::Handler::Mongrel.run HelloCacheFor.new, :Port => 9292

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: cache_for
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Michael Mell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide a simple interface to redis with self-expiring keys.
+email:
+- mike.mell@nthwave.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache_for.gemspec
+- lib/cache_for.rb
+- lib/cache_for/base.rb
+- lib/cache_for/version.rb
+- spec/lib/cache_for/base_spec.rb
+- spec/lib/cache_for_spec.rb
+- spec/spec_helper.rb
+- spec/support/rack_application.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Provide a simple interface to redis with self-expiring keys.
+test_files:
+- spec/lib/cache_for/base_spec.rb
+- spec/lib/cache_for_spec.rb
+- spec/spec_helper.rb
+- spec/support/rack_application.rb