caches 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 413c1adc86d415334b1ff133cf124fe7f82a4831
-  data.tar.gz: 90d46e2b56699932fe3e1b76699fb92c37b23d7f
+  metadata.gz: 443cc1eff19b292441d504e849ba7cfe09931f03
+  data.tar.gz: 18ab2f338cada16695d69e18452f223c276c7050
 SHA512:
-  metadata.gz: a461ad78571ebf10c4b54fc9ec00122750b1b71754e7a2b07080c12b634009c2e02adcbc6eb0d1532ad657419752e7d4217e09a61a256ae116916926d7c7380e
-  data.tar.gz: e8f5022d40eecfc8c386d41ecc35812c1b071bf0b36dd518eec449e057b2b33f71f669634c792b30b7b30535a49a6dbd999f81c98ded88ac873fc59fbef2c657
+  metadata.gz: 7902d5bb624352d4c0122d247f09ba28dfe41ca68f3041bccc83f7035799102299b2c084d7a2a5bb98071358febc3bff51c7b59516182d6bcb89c55e738c5191
+  data.tar.gz: 38f8cdec9b5e46634c2cdd9b4124a6f17c70171813fcecc56e1c2242961b359d27bb47273c0a3edb6f4c4a5e3cfc0ebda9d4f4e2c7a7a89547ea24abc5ad61f8

data/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 
 - Nothing
 
+## 0.0.7 - 2015-03-09
+
+- `#clear` method clears a cache's data and stats
+- Bugfix for `#stats`: 0 hits and 0 misses is `0%`, not `NaN`
+
 ## 0.0.6 - 2015-03-09
 
 - Stats include a percentage
@@ -13,7 +18,7 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
-- `Caches::TTL` and `Caches::LRU` support `#stats`, which gives counts of how many cache hits and misses have occurred
+- `#stats` method gives counts of how many cache hits and misses have occurred
 
 ## 0.0.4 - 2015-03-03
 

data/README.md

@@ -63,9 +63,10 @@ puts h[:a] # => nil
 
 ## Methods Common to All Caches
 
-- `stats` tells how many cache hits and misses have occurred
-- `fetch` works like `Hash#fetch`
-- `memoize` returns the key's value, if any; if not, it gets its return value from the block, and sets the key before it returns
+- `#fetch` works like `Hash#fetch`
+- `#memoize` returns the key's value, if any; if not, it gets its return value from the block, and sets the key before it returns
+- `#stats` tells how many cache hits and misses have occurred
+- `#clear` resets all data and stats
 
 ## Installation
 

data/lib/caches/lru.rb

@@ -13,8 +13,7 @@ module Caches
 
     def initialize(options = {})
       self.max_keys = options.fetch(:max_keys, 20)
-      self.data     = {}
-      self.keys     = LinkedList.new
+      initialize_data
     end
 
     def [](key)
@@ -45,8 +44,18 @@ module Caches
       keys.length
     end
 
+    def clear
+      initialize_data
+    end
+
     private
 
+    def initialize_data
+      self.data     = {}
+      self.keys     = LinkedList.new
+      self
+    end
+
     def prune
       return unless keys.length > max_keys
       expiring_node = keys.pop

data/lib/caches/stats.rb

@@ -1,7 +1,7 @@
 module Caches
   module Stats
 
-    def initialize(*args)
+    def initialize_data
       @hits   = 0
       @misses = 0
       super
@@ -22,8 +22,9 @@ module Caches
     end
 
     def hit_rate
-      rate = (Float(@hits) / (Float(@hits) + Float(@misses)))
-      "#{rate * 100}%"
+      attempts = Float(@hits) + Float(@misses)
+      ratio    = attempts.zero? ? 0.0 : Float(@hits) / attempts
+      "#{ratio * 100}%"
     end
 
   end

data/lib/caches/ttl.rb

@@ -15,9 +15,8 @@ module Caches
     def initialize(options = {})
       self.ttl      = options.fetch(:ttl) { 3600 }
       self.refresh  = !!(options.fetch(:refresh, false))
-      self.data     = {}
-      self.nodes    = LinkedList.new
       self.max_keys = options[:max_keys]
+      initialize_data
     end
 
     def [](key)
@@ -70,8 +69,18 @@ module Caches
       data.values.map { |h| h.fetch(:value) }
     end
 
+    def clear
+      initialize_data
+    end
+
     private
 
+    def initialize_data
+      self.data     = {}
+      self.nodes    = LinkedList.new
+      self
+    end
+
     def current?(key)
       (current_time - data[key][:time]) < ttl
     end

data/lib/caches/version.rb

@@ -1,3 +1,3 @@
 module Caches
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/caches/lru_spec.rb

@@ -134,5 +134,27 @@ describe Caches::LRU do
 
   end
 
+  describe "clear" do
+
+    it "clears all cached data" do
+      cache.clear
+      expect(cache.size).to eq(0)
+    end
+
+    it "clears the stats" do
+      cache[:a]
+      cache[:nope]
+      cache.clear
+      expect(cache.stats).to eq(hits: 0, misses: 0, hit_rate: "0.0%")
+    end
+
+    it "returns the empty cache" do
+      id = cache.object_id
+      returned = cache.clear
+      expect(returned.object_id).to eq(id)
+    end
+
+  end
+
 end
 

data/spec/caches/ttl_spec.rb

@@ -233,4 +233,26 @@ describe Caches::TTL do
 
   end
 
+  describe "clear" do
+
+    it "clears all cached data" do
+      cache.clear
+      expect(cache.size).to eq(0)
+    end
+
+    it "clears the stats" do
+      cache[:a]
+      cache[:nope]
+      cache.clear
+      expect(cache.stats).to eq(hits: 0, misses: 0, hit_rate: "0.0%")
+    end
+
+    it "returns the empty cache" do
+      id = cache.object_id
+      returned = cache.clear
+      expect(returned.object_id).to eq(id)
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caches
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Nathan Long