cache-store-api 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1,6 @@
+.idea
+.rvmrc
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+-cfs --tty

data/.runrc

@@ -0,0 +1,3 @@
+#!/bin/bash
+. /usr/local/rvm/scripts/rvm
+__rvm_project_rvmrc $(pwd)

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Rakefile

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

data/cache-store-api.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'cache-store-api/version'
+
+Gem::Specification.new do |s|
+  s.name        = "cache-store-api"
+  s.version     = CacheStoreApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brian Takita"]
+  s.email       = ["brian@honk.com"]
+  s.homepage    = "http://github.com/honkster/cache-store-api"
+  s.summary     = "Ruby cache methods built on top of Rails and Sinatra caching."
+  s.description = "Ruby cache methods built on top of Rails and Sinatra caching."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~>2.6.0"
+  s.add_development_dependency "rr",    "~>1.0.4"
+  s.add_development_dependency "rake"
+end

data/lib/cache-store-api.rb

@@ -1,39 +1,9 @@
-module CacheStoreApi
-  module CommonMethods
-    def lazy_cache(key, expiration=3600)
-      if block_given?
-        if cache.exist?(key)
-          cache.read(key)
-        else
-          output = yield
-          cache.write(key, output, :expires_in => expiration)
-          output
-        end
-      else
-        cache.read(key)
-      end
-    end
-
-    def expire(key)
-      cache.delete(key)
-    end
+require 'cache-store-api/class_methods'
 
-    def data
-      cache.instance_variable_get(:@data)
-    end
-  end
-  extend CommonMethods
-
-  extend(Module.new do
-    attr_reader :cache_lambda
-    def cache
-      cache_lambda.call
-    end
+module CacheStoreApi
+  extend ClassMethods
 
-    def set_cache(&block)
-      @cache_lambda = block
-    end
-  end)
+  autoload :TestCache, 'cache-store-api/test_cache'
 
   def cache
     CacheStoreApi.cache

data/lib/cache-store-api/class_methods.rb

@@ -0,0 +1,62 @@
+module CacheStoreApi
+  module ClassMethods
+    attr_reader :cache_lambda
+
+    def lazy_cache(key, expiration=3600)
+      return cache.read(key) unless block_given?
+
+      if caching?
+        return cache.read(key) if cache.exist?(key)
+
+        data = yield
+        cache.write(key, data, :expires_in => expiration)
+        data
+      else
+        yield
+      end
+    end
+
+    def expire(key)
+      cache.delete(key)
+    end
+
+    def data
+      cache.instance_variable_get(:@data)
+    end
+
+    def cache
+      cache_lambda.call
+    end
+
+    def set_cache(&block)
+      @cache_lambda = block
+    end
+
+    def caching?
+      !!perform_caching_lambda.call
+    end
+
+    def set_perform_caching(&block)
+      @perform_caching_lambda = block
+    end
+
+    def enable_cache!
+      set_perform_caching do
+        true
+      end
+    end
+
+    def disable_cache!
+      set_perform_caching do
+        false
+      end
+    end
+
+    protected
+    def perform_caching_lambda
+      @perform_caching_lambda || lambda do
+        true
+      end
+    end
+  end
+end

data/lib/cache-store-api/version.rb

@@ -1,3 +1,3 @@
 module CacheStoreApi
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/cache-store-api_spec.rb

@@ -0,0 +1,201 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe CacheStoreApi do
+  let(:cache) do
+    Object.new.tap do |cache|
+      stub(cache).exist?  { raise "You should mock me." }
+      stub(cache).read    { raise "You should mock me." }
+      stub(cache).write   { raise "You should mock me." }
+      stub(cache).delete  { raise "You should mock me." }
+    end
+  end
+
+  let(:cache_store_api) do
+    Module.new do
+      include CacheStoreApi
+      extend  CacheStoreApi::ClassMethods
+    end
+  end
+
+  before(:each) do
+    cache_store_api.set_cache { cache }
+  end
+
+  describe ".disable_cache!" do
+    it "should set the #caching? to false" do
+      cache_store_api.disable_cache!
+      cache_store_api.caching?.should == false
+    end
+  end
+
+  describe ".set_perform_caching" do
+    it "sets .caching? to true when truthy and false when falsy" do
+      cache_store_api.set_perform_caching {true}
+      cache_store_api.caching?.should == true
+
+      cache_store_api.set_perform_caching {false}
+      cache_store_api.caching?.should == false
+
+      cache_store_api.set_perform_caching {"hi"}
+      cache_store_api.caching?.should == true
+
+      cache_store_api.set_perform_caching {nil}
+      cache_store_api.caching?.should == false
+    end
+  end
+
+  describe ".enable_cache!" do
+    it "should set the #caching? to true" do
+      cache_store_api.enable_cache!
+      cache_store_api.caching?.should == true
+    end
+  end
+
+  describe ".caching?" do
+    it "should reflect the value of @caching_status" do
+      cache_store_api.caching?.should be_true
+
+      cache_store_api.disable_cache!
+
+      cache_store_api.caching?.should be_false
+
+      cache_store_api.enable_cache!
+
+      cache_store_api.caching?.should be_true
+    end
+  end
+
+  describe ".lazy_cache" do
+    context "when caching is disabled" do
+      context "when a block is given" do
+        before(:each) do
+          cache_store_api.disable_cache!
+
+          stub(cache).exist?("cached-key") { fail "Cache should not be read from, when disabled!" }
+        end
+
+        it "always yields to the given block" do
+          cache_store_api.lazy_cache("cached-key") { "some value" }.should == "some value"
+        end
+      end
+    end
+
+    context "when caching is enabled" do
+      context "when a block is given" do
+        context "when the key exists in the cache" do
+          it "returns the value of cache.read" do
+            mock(cache).exist?("the-key") {true}
+            mock(cache).read("the-key") {"the value"}
+
+            cache_store_api.lazy_cache("the-key") {"new value"}.should == "the value"
+          end
+
+        end
+
+        context "when the key does not exist in the cache" do
+          context "when an expiration is not given" do
+            it "returns the return value of the block and writes that value (expiring in one hour) into the cache" do
+              mock(cache).exist?("the-key") {false}
+              mock(cache).write("the-key", "new value", :expires_in => 3600)
+
+              cache_store_api.lazy_cache("the-key") {"new value"}.should == "new value"
+            end
+          end
+
+          context "when an expiration is given" do
+            it "returns the return value of the block and writes that value (expiring in the given time) into the cache" do
+              mock(cache).exist?("the-key") {false}
+              mock(cache).write("the-key", "new value", :expires_in => 7200)
+
+              cache_store_api.lazy_cache("the-key", 7200) {"new value"}.should == "new value"
+            end
+          end
+
+        end
+      end
+
+      context "when a block is not given" do
+        it "returns the value of cache.read" do
+          mock(cache).read("the-key") {"the value"}
+
+          cache_store_api.lazy_cache("the-key").should == "the value"
+        end
+      end
+    end
+  end
+
+  describe ".expire" do
+    it "deletes the key in the cache" do
+      mock(cache).delete("the-key")
+      cache_store_api.expire("the-key")
+    end
+  end
+
+  describe ".data" do
+    it "returns the @data variable of the cache" do
+      data = {}
+      cache.instance_variable_set(:@data, data)
+      cache_store_api.data.should == data
+    end
+  end
+
+  describe CacheStoreApi::TestCache do
+    let(:cache) { CacheStoreApi::TestCache.new }
+
+    describe ".lazy_cache" do
+      context "when a block is given" do
+        context "when the key exists in the cache" do
+          it "returns the value of cache.read" do
+            cache.write("the-key", "the value")
+            cache.exist?("the-key").should be_true
+
+            cache_store_api.lazy_cache("the-key") {"new value"}.should == "the value"
+          end
+
+        end
+
+        context "when the key does not exist in the cache" do
+          context "when an expiration is not given" do
+            it "returns the return value of the block and writes that value (expiring in one hour) into the cache" do
+              cache.exist?("the-key").should be_false
+
+              cache_store_api.lazy_cache("the-key") {"new value"}.should == "new value"
+            end
+          end
+
+          context "when an expiration is given" do
+            it "returns the return value of the block and writes that value (expiring in the given time) into the cache" do
+              cache.exist?("the-key").should be_false
+
+              cache_store_api.lazy_cache("the-key", 7200) {"new value"}.should == "new value"
+            end
+          end
+
+        end
+      end
+
+      context "when a block is not given" do
+        it "returns the value of cache.read" do
+          cache.write("the-key", "the value")
+
+          cache_store_api.lazy_cache("the-key").should == "the value"
+        end
+      end
+    end
+
+    describe ".expire" do
+      it "deletes the key in the cache" do
+        cache.write("the-key", "the value")
+        cache.exist?("the-key").should be_true
+        cache_store_api.expire("the-key")
+        cache.exist?("the-key").should be_false
+      end
+    end
+
+    describe ".data" do
+      it "returns the @data variable of the cache" do
+        cache_store_api.data.should == cache.data
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "bundler/setup"
+
+Bundler.require :default, :development
+require "rspec/autorun"
+
+require "cache-store-api"
+
+RSpec.configure do |configuration|
+  configuration.mock_with :rr
+end

data/spec/spec_suite.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/**/*_spec.rb"].each do |file|
+  require file
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: cache-store-api
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors: 
 - Brian Takita
@@ -14,22 +10,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-18 00:00:00 -08:00
+date: 2011-09-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
-  version_requirements: *id001
+  version_requirements: *id003
 description: Ruby cache methods built on top of Rails and Sinatra caching.
 email: 
 - brian@honk.com
@@ -40,11 +56,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/cache-store-api.rb
-- lib/cache-store-api/version.rb
-- lib/cache-store-api/test_cache.rb
+- .gitignore
+- .rspec
+- .runrc
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
+- cache-store-api.gemspec
+- lib/cache-store-api.rb
+- lib/cache-store-api/class_methods.rb
+- lib/cache-store-api/test_cache.rb
+- lib/cache-store-api/version.rb
+- spec/cache-store-api_spec.rb
+- spec/spec_helper.rb
+- spec/spec_suite.rb
 has_rdoc: true
 homepage: http://github.com/honkster/cache-store-api
 licenses: []
@@ -59,23 +86,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
-      version: 1.3.6
+      version: "0"
 requirements: []
 
-rubyforge_project: bundler
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Ruby cache methods built on top of Rails and Sinatra caching.