basiccache 0.0.27 → 0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a810da737dd6cc8cf4019fc39d17ba359073a447
-  data.tar.gz: 313e818b1a3afcc03d68715ffd40a1ae00df5462
+  metadata.gz: c88870ec2b5d57202f9851f3ff291dc1dcedf952
+  data.tar.gz: e3e84d6cb07215b2236f64f62b285b61a0d6b740
 SHA512:
-  metadata.gz: 8cda0382bb25719157c8d3fefff6015db5af7e3631a6fff6a940e2853ccf13aea75d7a5ae5498f0de6d3ebc6b99a2a97d2e6dbc3f65228110fa69fd642ccba57
-  data.tar.gz: 6d337ffe7e861b60b6375e6a9167154dde614a7a06d170b83ed84648f21f2f6bff740ef53031a3722b30ef1e5bc0f46de0fc2302525375f94aedd1a90d1edae4
+  metadata.gz: 69951405a0cc35f09fdfdfde6ec4b47bc90df9892be07e95fe8dace3a8c1d4a0421b7d7335ce2ab6fba0bb7a747415d93c164dede3a50d43e93262cebe022d90
+  data.tar.gz: 195d0ac05209ba4a9b59225584a1998cbf86980a8cc9a04444a0b304102dbf554de21919db1ef12e31e2a46f705372ab001f0d8216f6ca4d962110bc2b1bf59f

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*.gem
 coverage/
 .coveralls.yml
+.bundle

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 cache: bundler
 rvm:
-- ruby-head
+- 2.1.0
 - 2.0.0
 - 1.9.3
 notifications:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    basiccache (0.0.27)
+    basiccache (0.0.29)
 
 GEM
   remote: https://rubygems.org/
@@ -25,7 +25,7 @@ GEM
       ast (~> 1.1)
       slop (~> 3.4, >= 3.4.5)
     powerpack (0.0.9)
-    rainbow (1.1.4)
+    rainbow (1.99.1)
     rake (10.1.1)
     rest-client (1.6.7)
       mime-types (>= 1.16)
@@ -41,7 +41,7 @@ GEM
       parser (~> 2.1)
       powerpack (~> 0.0.6)
       rainbow (>= 1.1.4)
-    ruby-progressbar (1.3.2)
+    ruby-progressbar (1.4.0)
     simplecov (0.8.2)
       docile (~> 1.1.0)
       multi_json

data/Rakefile

@@ -18,7 +18,7 @@ end
 
 desc 'Run travis-lint on .travis.yml'
 task :travislint do
-  fail 'There is an issue with your .travis.yml' unless system('travis-lint')
+  print 'There may be an issue with your .travis.yml' unless system('travis-lint')
 end
 
 task default: [:spec, :travislint, :rubocop, :build, :install]

data/basiccache.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'basiccache'
-  s.version     = '0.0.27'
+  s.version     = '0.0.29'
   s.date        = Time.now.strftime("%Y-%m-%d")
   s.summary     = 'Provides a minimal key/value caching layer'
   s.description = "Allows an application to dynamically cache values and retrieve them later"

data/lib/basiccache.rb

@@ -26,6 +26,7 @@ module BasicCache
   end
 end
 
+require 'stores/store'
 require 'caches/cache'
 require 'caches/timecache'
 require 'methodcacher'

data/lib/caches/cache.rb

@@ -1,4 +1,12 @@
+##
+# Define the basic cache and default store objects
+
 module BasicCache
+  ##
+  # Set default Store type
+
+  DEFAULT_STORE = BasicCache::Store
+
   ##
   # Cache object, maintains a key/value store
 
@@ -8,15 +16,16 @@ module BasicCache
     ##
     # Generate an empty store
 
-    def initialize
-      @store = {}
+    def initialize(params = {})
+      params = { store: params } unless params.is_a? Hash
+      @store = params.fetch(:store) { BasicCache::DEFAULT_STORE.new }
     end
 
     ##
-    # Empty out either the given key or the full store
+    # Return the size of the cache
 
-    def clear!(key = nil)
-      key.nil? ? @store.clear : @store.delete(key.to_sym)
+    def size
+      @store.size
     end
 
     ##
@@ -28,13 +37,6 @@ module BasicCache
       @store[key.to_sym] ||= code.call
     end
 
-    ##
-    # Return the size of the cache
-
-    def size
-      @store.length
-    end
-
     ##
     # Check if a value is cached
     # (just a wrapper, designed to be redefined by subclasses)
@@ -52,5 +54,20 @@ module BasicCache
       fail KeyError, 'Key not cached' unless include? key.to_sym
       @store[key.to_sym]
     end
+
+    ##
+    # Empty out either the given key or the full store
+
+    def clear!(key = nil)
+      key = key.to_sym unless key.nil?
+      @store.clear! key
+    end
+
+    ##
+    # Prunes invalid/expired keys (a noop for the basic cache)
+
+    def prune
+      []
+    end
   end
 end

data/lib/caches/timecache.rb

@@ -1,4 +1,12 @@
+##
+# Extends BasicCache to add a time-based cache
+
 module BasicCache
+  ##
+  # Timecache item struct, timestamp and value
+
+  TimeCacheItem = Struct.new(:stamp, :value)
+
   ##
   # Time-based cache object
 
@@ -8,23 +16,27 @@ module BasicCache
     ##
     # Generate an empty store, with a default lifetime of 60 seconds
 
-    def initialize(lifetime = 60)
-      @lifetime = lifetime
-      @cache_item = Struct.new(:stamp, :value)
-      super()
+    def initialize(params = {})
+      params = { store: params } unless params.is_a? Hash
+      @lifetime = params.fetch :lifetime, 60
+      super
+    end
+
+    ##
+    # Return the size of the cache (don't include expired entries)
+
+    def size
+      @store.keys.count { |k| Time.now - @store[k].stamp < @lifetime }
     end
 
     ##
-    # If the key is cached but expired, clear it
+    # Return a value from the cache, or calculate it and store it
+    # Recalculate if the cached value has expired
 
     def cache(key = nil, &code)
       key ||= BasicCache.caller_name
       key = key.to_sym
-      # rubocop:disable AndOr
-      unless @store.include? key and Time.now - @store[key].stamp < @lifetime
-        @store[key] = @cache_item.new(Time.now, code.call)
-      end
-      # rubocop:enable AndOr
+      @store[key] = TimeCacheItem.new(Time.now, code.call) unless include? key
       @store[key].value
     end
 
@@ -34,23 +46,29 @@ module BasicCache
     def include?(key = nil)
       key ||= BasicCache.caller_name
       key = key.to_sym
-      # rubocop:disable AndOr
-      @store.include? key and Time.now - @store[key].stamp < @lifetime
-      # rubocop:enable AndOr
+      @store.include?(key) && Time.now - @store[key].stamp < @lifetime
     end
 
+    ##
+    # Retrieve a value
+
     def [](key = nil)
       super.value
     end
 
     ##
-    # Return the size of the cache (don't include expired entries)
-    # By default, purges expired entries while iterating
+    # Remove a value, or clear the cache
+
+    def clear!(key = nil)
+      resp = super
+      resp.class == TimeCacheItem ? resp.value : resp
+    end
+
+    ##
+    # Prune expired keys
 
-    def size(purge = true)
-      valid = @store.select { |k, v| Time.now - v.stamp < @lifetime }
-      @store = valid if purge
-      valid.size
+    def prune
+      @store.keys.reject { |k| include? k }.map { |k| clear!(k) && k }
     end
   end
 end

data/lib/stores/store.rb

@@ -0,0 +1,57 @@
+module BasicCache
+  ##
+  # Basic store object (uses a Hash)
+
+  class Store
+    attr_reader :raw
+
+    ##
+    # Generate an empty store
+
+    def initialize
+      @raw = {}
+    end
+
+    ##
+    # Clears a specified key or the whole store
+
+    def clear!(key = nil)
+      key.nil? ? @raw.clear : @raw.delete(key)
+    end
+
+    ##
+    # Retrieve a key
+
+    def [](key)
+      @raw[key]
+    end
+
+    ##
+    # Set a key
+
+    def []=(key, value)
+      @raw[key] = value
+    end
+
+    ##
+    # Return the size of the store
+
+    def size
+      @raw.size
+    end
+
+    ##
+    # Check for a key in the store
+
+    def include?(key)
+      @raw.include? key
+    end
+
+    ##
+    # Array of keys in the store
+
+    def keys
+      @raw.keys
+    end
+  end
+end

data/spec/basiccache_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
 describe BasicCache do
-  describe '.new' do
+  describe '#new' do
     it 'creates cache objects' do
       expect(BasicCache.new).to be_an_instance_of BasicCache::Cache
     end
   end
 
-  describe '.caller_name' do
+  describe '#caller_name' do
     it "returns the calling function's name" do
       expect(BasicCache.caller_name).to eql 'instance_eval'
     end

data/spec/caches/cache_spec.rb

@@ -13,8 +13,8 @@ describe BasicCache::Cache do
   it 'creates a cache' do
     expect(subject).to be_an_instance_of BasicCache::Cache
   end
-  it 'has a hash store' do
-    expect(subject.store).to eql Hash.new
+  it 'has a store' do
+    expect(subject.store).to be_an_instance_of BasicCache::Store
   end
   describe '#size' do
     it 'shows the size of the cache' do
@@ -34,6 +34,21 @@ describe BasicCache::Cache do
       expect(subject.include? :c). to be_true
     end
   end
+  describe '#include?' do
+    it 'checks for a value in the cache' do
+      expect(cache.include? 'a').to be_true
+      expect(cache.include? :b).to be_true
+      expect(cache.include? 'z').to be_false
+      expect(cache.include? names[2]).to be_true
+    end
+  end
+  describe '#[]' do
+    it 'returns values from the cache' do
+      expect(cache['a']).to eql 3
+      expect(cache[:b]).to eql 5
+      expect { cache[:c] }.to raise_error KeyError
+    end
+  end
   describe '#clear!' do
     describe 'when given no argument' do
       it 'clears the cache' do
@@ -56,19 +71,9 @@ describe BasicCache::Cache do
       end
     end
   end
-  describe '#include?' do
-    it 'checks for a value in the cache' do
-      expect(cache.include? 'a').to be_true
-      expect(cache.include? :b).to be_true
-      expect(cache.include? 'z').to be_false
-      expect(cache.include? names[2]).to be_true
-    end
-  end
-  describe '#[]' do
-    it 'returns values from the cache' do
-      expect(cache['a']).to eql 3
-      expect(cache[:b]).to eql 5
-      expect { cache[:c] }.to raise_error KeyError
+  describe '#prune' do
+    it 'prunes invalid keys (none for Cache)' do
+      expect(cache.prune).to eql Array.new
     end
   end
 end

data/spec/caches/timecache_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe BasicCache::TimeCache do
   let(:cache) do
-    cache = BasicCache::TimeCache.new(1)
+    cache = BasicCache::TimeCache.new(lifetime: 1)
     cache.cache('a') { 3 }
     cache.cache(:b) { 5 }
     cache.cache { 9 }
@@ -13,8 +13,8 @@ describe BasicCache::TimeCache do
   it 'creates a cache' do
     expect(cache).to be_an_instance_of BasicCache::TimeCache
   end
-  it 'has a hash store' do
-    expect(subject.store).to eql Hash.new
+  it 'has a store' do
+    expect(subject.store).to be_an_instance_of BasicCache::Store
   end
   it 'has a set lifetime' do
     expect(cache.lifetime).to eq 1
@@ -48,6 +48,26 @@ describe BasicCache::TimeCache do
       expect(cache.include? 'a').to be_false
     end
   end
+  describe '#include?' do
+    it 'checks for a value in the cache' do
+      expect(cache.include? 'a').to be_true
+      expect(cache.include? :b).to be_true
+      expect(cache.include? 'z').to be_false
+      expect(cache.include? names[2]).to be_true
+    end
+  end
+  describe '#[]' do
+    it 'returns values from the cache' do
+      expect(cache['a']).to eql 3
+      expect(cache[:b]).to eql 5
+      expect { cache[:c] }.to raise_error KeyError
+    end
+    it 'will not return an expired key' do
+      expect(cache['a']).to eql 3
+      sleep 2
+      expect { cache['a'] }.to raise_error KeyError
+    end
+  end
   describe '#clear!' do
     describe 'when given no argument' do
       it 'clears the cache' do
@@ -59,35 +79,24 @@ describe BasicCache::TimeCache do
     describe 'when given an argument' do
       it 'removes that entry from the cache' do
         expect(cache.size).to eql 3
-        cache.clear! 'c'
+        expect(cache.clear! 'c').to be_nil
         expect(cache.size).to eql 3
-        expect(cache.clear!('a')[1]).to eql 3
+        expect(cache.clear! 'a').to eql 3
         expect(cache.size).to eql 2
-        expect(cache.clear!(:b)[1]).to eql 5
+        expect(cache.clear! :b).to eql 5
         expect(cache.size).to eql 1
-        expect(cache.clear!(names[2])[1]).to eql 9
+        expect(cache.clear! names[2]).to eql 9
         expect(cache.size).to eql 0
       end
     end
   end
-  describe '#include?' do
-    it 'checks for a value in the cache' do
-      expect(cache.include? 'a').to be_true
-      expect(cache.include? :b).to be_true
-      expect(cache.include? 'z').to be_false
-      expect(cache.include? names[2]).to be_true
-    end
-  end
-  describe '#[]' do
-    it 'returns values from the cache' do
-      expect(cache['a']).to eql 3
-      expect(cache[:b]).to eql 5
-      expect { cache[:c] }.to raise_error KeyError
-    end
-    it 'will not return an expired key' do
-      expect(cache['a']).to eql 3
+  describe '#prune' do
+    it 'prunes invalid cache entries' do
+      expect(cache.store.size).to eql 3
       sleep 2
-      expect { cache['a'] }.to raise_error KeyError
+      expect(cache.store.size).to eql 3
+      expect(cache.prune).to eql [:a, :b, names[2]]
+      expect(cache.store.size).to eql 0
     end
   end
 end

data/spec/methodcacher_spec.rb

@@ -9,7 +9,7 @@ class Example
   def initialize(skip_cache = false)
     return if skip_cache
     enable_caching [:repeat]
-    enable_caching [:time_repeat], BasicCache::TimeCache.new(1)
+    enable_caching [:time_repeat], BasicCache::TimeCache.new(lifetime: 1)
   end
 
   def repeat(input)

data/spec/stores/store_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe BasicCache::Store do
+  let(:store) do
+    store = BasicCache::Store.new
+    (1..5).each { |i| store[i] = i + 5 }
+    store
+  end
+
+  describe '#initialize' do
+    it 'creates a new store raw object' do
+      expect(store.raw).to be_an_instance_of Hash
+    end
+  end
+  describe '#clear!' do
+    describe 'when given no argument' do
+      it 'empties the store' do
+        expect(store.clear!).to eql Hash.new
+      end
+    end
+    describe 'when given an argument' do
+      it 'removes a key from the store' do
+        expect(store.size).to eql 5
+        store.clear! 1
+        expect(store.size).to eql 4
+      end
+    end
+  end
+  describe '#[]' do
+    it 'retrieves a key' do
+      expect(store[1]).to eql 6
+    end
+  end
+  describe '#[]=' do
+    it 'sets a key' do
+      expect(store[6] = 10).to eql 10
+    end
+  end
+  describe '#size' do
+    it 'returns the size of the store' do
+      expect(store.size).to eql 5
+    end
+  end
+  describe '#include?' do
+    it 'checks for a key in the store' do
+      expect(store.include? :foo).to be_false
+      expect(store.include? 1).to be_true
+    end
+  end
+  describe '#keys' do
+    it 'lists the keys in the store' do
+      expect(store.keys).to eql [1, 2, 3, 4, 5]
+    end
+  end
+end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: basiccache
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.29
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-25 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   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: travis-lint
   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: 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: coveralls
   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: 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: fuubar
   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: parser
   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'
 description: Allows an application to dynamically cache values and retrieve them later
@@ -114,10 +114,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -128,11 +128,13 @@ files:
 - lib/caches/cache.rb
 - lib/caches/timecache.rb
 - lib/methodcacher.rb
+- lib/stores/store.rb
 - spec/basiccache_spec.rb
 - spec/caches/cache_spec.rb
 - spec/caches/timecache_spec.rb
 - spec/methodcacher_spec.rb
 - spec/spec_helper.rb
+- spec/stores/store_spec.rb
 - vendor/cache/ast-1.1.0.gem
 - vendor/cache/coveralls-0.7.0.gem
 - vendor/cache/diff-lcs-1.2.5.gem
@@ -143,7 +145,7 @@ files:
 - vendor/cache/multi_json-1.8.2.gem
 - vendor/cache/parser-2.1.1.gem
 - vendor/cache/powerpack-0.0.9.gem
-- vendor/cache/rainbow-1.1.4.gem
+- vendor/cache/rainbow-1.99.1.gem
 - vendor/cache/rake-10.1.1.gem
 - vendor/cache/rest-client-1.6.7.gem
 - vendor/cache/rspec-2.14.1.gem
@@ -151,7 +153,7 @@ files:
 - vendor/cache/rspec-expectations-2.14.4.gem
 - vendor/cache/rspec-mocks-2.14.4.gem
 - vendor/cache/rubocop-0.16.0.gem
-- vendor/cache/ruby-progressbar-1.3.2.gem
+- vendor/cache/ruby-progressbar-1.4.0.gem
 - vendor/cache/simplecov-0.8.2.gem
 - vendor/cache/simplecov-html-0.8.0.gem
 - vendor/cache/slop-3.4.7.gem
@@ -169,17 +171,17 @@ 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.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Provides a minimal key/value caching layer
@@ -189,4 +191,4 @@ test_files:
 - spec/caches/timecache_spec.rb
 - spec/methodcacher_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/stores/store_spec.rb