caches 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89ecbca50c8eeca4f3a3ba844fc8af31051e0aca
-  data.tar.gz: 7bb00ffe94dd6f21767037d14217223e7f4bad86
+  metadata.gz: c9e78a1f8363d6a34aa3ecfcf301b2bc1390ade2
+  data.tar.gz: 3cb95979ea3b0c416029e2b0791558b48c190b1f
 SHA512:
-  metadata.gz: afa402ae0b268873414fbd05f13a9c1d15982272523ab3e70d6badd37b6d05d03bf5054e774e1f17cfee93317460839018766fd76b7d8eb286b118821acfaadd
-  data.tar.gz: 36e84e288dc638a1c0b184136965fba84b737d243d81f334a0feddd356c95d3fb16631336bed1b0770ed76e29635e5d34390418ffa57fa7846083b1b4c6c594c
+  metadata.gz: 413dc61d9667e5825611409ec0a3b2d1abd8b20f3c93128440ab1a5226755ae331093a18e32d478255c25e5b94430912c566b8d25fbfcf7d9ccc75bbf68a3a9e
+  data.tar.gz: 3e11bc28feb7a34b4a782c4020b7ee61c7e73113636f74c4146ba686a1722f8265af2347c80aebb68483cecc0f20139fbd7eec7adf1a86b2c424740d851f3565

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## Unreleased
+
+- Nothing
+
+## 0.0.5 - 2015-03-09
+
+### Added
+
+- `Caches::TTL` and `Caches::LRU` support `#stats`, which gives counts of how many cache hits and misses have occurred
+
 ## 0.0.4 - 2015-03-03
 
 ### Added
@@ -10,12 +20,6 @@ All notable changes to this project will be documented in this file.
 - Benchmarking with Ruby 2.1.3
 - `Caches::LRU` can handle `max_keys: 0`
 
-### Changed
-Nothing
-
-### Removed
-Nothing
-
 ## 0.0.3 - 2014-08-22
 
 Currently have `Caches::TTL` and `Caches::LRU`

data/README.md

@@ -61,6 +61,12 @@ h[:d] = "dingo"
 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
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/caches/accessible.rb

@@ -2,7 +2,8 @@ module Caches
   module Accessible
 
     def fetch(key, default = (default_omitted = true; nil))
-      return self[key]  if data.has_key?(key)
+      value = self[key]
+      return value if data.has_key?(key)
       return yield(key) if block_given?
       return default    unless default_omitted
       raise KeyError
@@ -10,8 +11,8 @@ module Caches
 
     def memoize(key)
       raise ArgumentError, "Block is required" unless block_given?
-      self[key] # triggers flush or refresh if expired
-      return self[key]       if data.has_key?(key)
+      value = self[key]
+      return value if data.has_key?(key)
       self[key] = yield(key) if block_given?
     end
 

data/lib/caches/lru.rb

@@ -1,20 +1,29 @@
 require_relative 'accessible'
 require_relative 'linked_list'
+require_relative 'stats'
 
 module Caches
   class LRU
     include Accessible
+    prepend Stats
     attr_accessor :max_keys
 
+    attr_accessor :keys, :data
+    private       :keys, :data
+
     def initialize(options = {})
       self.max_keys = options.fetch(:max_keys, 20)
       self.data     = {}
-      self.keys = LinkedList.new
+      self.keys     = LinkedList.new
     end
 
     def [](key)
       return nil if max_keys.zero?
-      return nil unless data.has_key?(key)
+      unless data.has_key?(key)
+        record_cache_miss
+        return nil 
+      end
+      record_cache_hit
       value, node = data[key]
       keys.move_to_head(node)
       value
@@ -37,7 +46,6 @@ module Caches
     end
 
     private
-    attr_accessor :keys, :data
 
     def prune
       return unless keys.length > max_keys

data/lib/caches/stats.rb

@@ -0,0 +1,25 @@
+module Caches
+  module Stats
+
+    def initialize(*args)
+      @hits   = 0
+      @misses = 0
+      super
+    end
+
+    def stats
+      {hits: @hits, misses: @misses}
+    end
+
+    private
+
+    def record_cache_hit
+      @hits += 1
+    end
+
+    def record_cache_miss
+      @misses += 1
+    end
+
+  end
+end

data/lib/caches/ttl.rb

@@ -1,12 +1,17 @@
 require 'time'
 require_relative 'accessible'
 require_relative 'linked_list'
+require_relative 'stats'
 
 module Caches
   class TTL
     include Accessible
+    prepend Stats
     attr_accessor :ttl, :refresh
 
+    attr_accessor :data, :nodes, :max_keys
+    private       :data, :nodes, :max_keys
+
     def initialize(options = {})
       self.ttl      = options.fetch(:ttl) { 3600 }
       self.refresh  = !!(options.fetch(:refresh, false))
@@ -16,12 +21,17 @@ module Caches
     end
 
     def [](key)
-      return nil unless data.has_key?(key)
+      unless data.has_key?(key)
+        record_cache_miss
+        return nil
+      end
       if current?(key)
+        record_cache_hit
         data[key][:value].tap {
           data[key][:time] = current_time if refresh
         }
       else
+        record_cache_miss
         delete(key)
         nil
       end
@@ -74,8 +84,6 @@ module Caches
       max_keys && size >= max_keys
     end
 
-    attr_accessor :data, :nodes, :max_keys
-
     def current_time
       Time.now
     end

data/lib/caches/version.rb

@@ -1,3 +1,3 @@
 module Caches
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/caches/lru_spec.rb

@@ -123,5 +123,16 @@ describe Caches::LRU do
 
   end
 
+  describe "stats" do
+
+    it "can report hits and misses" do
+      cache[:a]
+      cache[:b]
+      cache[:nope]
+      expect(cache.stats).to eq(hits: 2, misses: 1)
+    end
+
+  end
+
 end
 

data/spec/caches/ttl_spec.rb

@@ -222,4 +222,15 @@ describe Caches::TTL do
 
   end
 
+  describe "stats" do
+
+    it "can report hits and misses" do
+      cache[:a]
+      cache[:b]
+      cache[:nope]
+      expect(cache.stats).to eq(hits: 2, misses: 1)
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caches
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nathan Long
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - lib/caches/all.rb
 - lib/caches/linked_list.rb
 - lib/caches/lru.rb
+- lib/caches/stats.rb
 - lib/caches/ttl.rb
 - lib/caches/version.rb
 - spec/benchmark_spec.rb