battle_ship 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 176aaef26568ed8973ea762f53fc72ce49825e73
-  data.tar.gz: d02c98c534224cdfb94dc769a8a0036681c91202
+  metadata.gz: 7ef0a6a6b19a150b4ead60d3f5a75f3ab226c9f8
+  data.tar.gz: 3bdcdab074f21e0e577a18e43db96e6648515016
 SHA512:
-  metadata.gz: d6f83679b0e0a52b8a2c6c6ed846071f9d73e1cf858ae4c7de8a322d6d4eeca3dfdf6c6730a59aaaeff388c38633f980d09017899060fc321d1eaf20bad130f3
-  data.tar.gz: 8525ef636a9fb6c271199861fb8c1f8ce69e49db3df1902c9d31bae2b4aa62f8442346f4f9baa2ea362a31c2c79826c9bfe9d825e4c94c4bfaae1e3323833387
+  metadata.gz: 716a2bdee834065f1868323ba2693c4a7e73a50045a367feef1ff21cb6df47adb2ca86bd1eec4ec8e8bd868f1c17cf216476dded05c9789206b98b3d714abe20
+  data.tar.gz: 9c935394e24b0f379a123a58c28a4c853f3f6115651f7ca24e5cb1ee7b3ed02d5f8c4cec2bf43dec3ee0c8191c97f7f461a490cdd4bf127548a9b942b4c24a0c

data/README.md

@@ -1,28 +1,30 @@
 # BattleShip
 
-### Keep track of your cache hits & misses
-
 #### Description
-If you make use of Rails.cache methods (e.g. #fetch, #read, #write), you may be
-curious what your success is with your caching strategies. Perhaps you cache
-some user objects, sessions, etc. How do you know whether it's working? What if
-it's mostly misses?
+The BattleShip gem answers the question "What is my cache hit rate?"
 
-BattleShip updates ActiveSupport::Cache::Store (and all its subclasses, so
-you're covered if you use RedisStore or MemcachedStore) to increment a counter
-for each cache hit and miss
+It does this by adding an increment to every cache read operation,
+counting each read as either a hit (returned non-nil value) or miss (returned
+nil). It stores the resulting numbers of hits and misses in the cache itself.
 
-#### Warnings, Caveats, etc.
-BattleShip works by updating ActiveSupport::Cache::Store, so requires this class
-to exist.
+BattleShip assumes you are caching objects (such as a User or Session object). On a hit, it
+will see the class name and increment the hit count at
+```"#{returned_object.class}_hits"```, where returned_object is the object that
+the cache call returns. On a miss, BattleShip assumes that the key represents
+the class name (e.g. you called Rails.cache.read("user_1")), and increments the
+miss counter accordingly (e.g. at "user_misses"). If you pass in a ```:namespace``` key in the options
+hash, it will use that instead.
 
-This cache must also be able to complete _atomic increment_ operations with the #increment method.
+## Usage
 
-This is early development days for BattleShip. Please feel free to open an issue
-here with either questions or suggestions. And, of course, contributions are
-welcome.
+Cache things just liek you do with Rails.cache methods already.
+
+Access the hits by calling ```#hits``` on your particular cache implementation (e.g.
+  ```Rails.cache.hits```) and passing in the namespace, e.g. User (either the string
+or the classname).
+Same deal with misses, but call ```#misses``` instead
 
-## Installation
+#### Installation
 
 Add this line to your application's Gemfile:
 
@@ -36,21 +38,9 @@ Or install it yourself as:
 
     $ gem install battle_ship
 
-## Usage
 
-Just keep on using Rails.cache methods like you do today. BattleShip makes
-certain assumptions that you should be aware of:
-* When there's a cache hit, it will increment the value of the returned object's
-  class name plus the string "\_hits" (e.g. a User object's hits will be stored
-in the cache at key ```"User_hits"```)
-* When there's a cache miss, BattleShip doesn't know exactly the class you were
-  expecting, so it assumes that you either: (1) Passed in a namespace key in
-the options hash, or (2) Named your key such that the first underscore occurs
-after the name of the class (e.g. "User_123").
-* Access the hits by calling ```#hits``` on your particular cache implementation (e.g.
-  ```Rails.cache.hits```) and passing in the namespace, e.g. User (either the string
-or the classname).
-* Same deal with misses, but call ```#misses``` instead
+#### Warnings, Caveats, etc.
+If you are using a cache store that does not subclass ActiveSupport::Cache::Store, please add an initializer file in ```config/initializers``` that calls ```BattleShip.include!```
 
 
 ## Contributing
@@ -64,6 +54,5 @@ or the classname).
 ## To Do
 
 1. Add performance measurements
-2. Add rails example app
 3. Add config option for turning on/off
 4. Add config option for setting time-frame of hits/misses

data/Rakefile

@@ -1,7 +1,9 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = 'spec/lib/*'
+end
 
 task :default => :spec
 task :test => :spec

data/battle_ship.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["DavidRagone"]
   spec.email         = ["dmragone@gmail.com"]
   spec.description   = %q{Adds counters to cache when successful read operation completes in order to track Rails.cache hits & misses}
-  spec.summary       = %q{Wrapper for Rails.cache methods}
+  spec.summary       = %q{Keep track of cache hits and misses}
   spec.homepage      = "https://github.com/DavidRagone/BattleShip"
   spec.license       = "MIT"
 

data/lib/battle_ship.rb

@@ -18,6 +18,10 @@ module BattleShip
     entry
   end
 
+  def self.include!
+    Rails.cache.class.class_eval("prepend BattleShip")
+  end
+
   private
   def namespace(key, options)
     (options[:namespace] || key_up_to_first_underscore(key)).camelize

data/lib/battle_ship/version.rb

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

data/spec/lib/active_support_cache_subclass_spec.rb

@@ -24,13 +24,13 @@ describe ActiveSupport::Cache::Something do
 
   context ".read" do
     it "increments the related counter on hits" do
-      cache.should_receive(:increment).with("User_hits")
+      cache.should_receive(:increment).with("User_hits", 1)
       cache.write("user_1", user)
       cache.read("user_1").should eq user
     end
 
     it "increments the related counter on misses" do
-      cache.should_receive(:increment).with("User_misses")
+      cache.should_receive(:increment).with("User_misses", 1)
       cache.read("user_1").should eq nil
     end
   end

data/spec/lib/battle_ship_spec.rb

@@ -1,19 +1,18 @@
 require 'spec_helper'
 
-# For tests of #read_entry, see spec/lib/active_support_cache_subclass_spec.rb
 describe BattleShip do
   let(:dummy) { Class.new { prepend(BattleShip) }.new }
 
   describe "#hits" do
     it "reads, skipping increment" do
-      dummy.should_receive(:read).with("Foo_hits", { skip_increment: true })
+      dummy.should_receive(:read).with("Foo_hits", { skip_increment: true, raw: true })
       dummy.hits("Foo")
     end
   end
 
   describe "#misses" do
     it "reads, skipping increment" do
-      dummy.should_receive(:read).with("Foo_misses", { skip_increment: true })
+      dummy.should_receive(:read).with("Foo_misses", { skip_increment: true, raw: true })
       dummy.misses("Foo")
     end
   end
@@ -44,4 +43,16 @@ describe BattleShip do
       end
     end
   end
+
+  describe ".include!" do
+    subject { BattleShip.include! }
+    it "forcefully prepends self to Rails.cache.class" do
+      klass = double
+      cache = double
+      Rails.should_receive(:cache) { cache }
+      cache.should_receive(:class) { klass }
+      klass.should_receive(:class_eval).with("prepend BattleShip")
+      subject
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,11 @@
+class Cache
+end
+class Rails
+  def self.cache
+    Cache
+  end
+end
+
 require 'active_support'
 require 'battle_ship'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: battle_ship
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - DavidRagone
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,7 +123,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Wrapper for Rails.cache methods
+summary: Keep track of cache hits and misses
 test_files:
 - spec/lib/active_support_cache_subclass_spec.rb
 - spec/lib/battle_ship_spec.rb