cached_key_value_store 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,12 @@
 # CachedKeyValueStore
 
-TODO: Write a gem description
+Sending redis a request for each of those thousands of translations scattered
+throughout your app is slow. This gem memoizes those requests, and sets up a
+simple mechanism to bust the cache.
+
+If you want to use Redis for I18n, I recommend you watch
+[this railscast](http://railscasts.com/episodes/256-i18n-backends),
+and use this backend instead of the KeyValue one that he uses.
 
 ## Installation
 
@@ -18,7 +24,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your initializer:
+
+    I18n.backend = I18n::Backend::CachedKeyValueStore.new($redis)
+
+### Busting the Cache
+
+The ```#ensure_freshness!``` method can be called periodically to make sure
+that new changes show up. I put mine in a before filter:
+
+    class ApplicationController < ActionController::Base
+      before_filter :ensure_fresh_i18n
+
+      private
+      def ensure_fresh_i18n
+        I18n.backend.ensure_freshness! I18n.locale
+      end
+    end
+
+You can also call ```#update_version!(locale)``` yourself to signal that the
+translations have been modified.
+
+The ```on_update_version``` hook will be triggered every time the version is
+updated.
+
 
 ## Contributing
 

data/cached_key_value_store.gemspec

@@ -5,9 +5,9 @@ Gem::Specification.new do |s|
   s.name          = 'cached_key_value_store'
   s.version       = CachedKeyValueStore::VERSION
   s.summary       = 'An I18n Backend with in-memory cacheing'
-  s.description   = %q{This gem is designed for usage with a key-value store
-                       database, where latency is an issue. Locale changes are
-                       versioned to allow for an easy cache-bust. }
+  s.description   = %q{This gem is designed for usage with a I18n backend
+                       key-value database, where latency is an issue. I18n
+                       changes are versioned to allow for an easy cache-bust.}
   s.authors       = ['Mike Wheeler']
   s.email         = 'mwheeler@g2crowd.com'
 
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   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.homepage      = 'http://rubygems.org/gems/cached-key-value-store'
+  s.homepage      = 'https://github.com/wheeyls/cached_key_value_store'
 
   s.add_dependency "activesupport"
   s.add_development_dependency "rspec", "~> 2.6"

data/lib/cached_key_value_store/version.rb

@@ -1,3 +1,3 @@
 module CachedKeyValueStore
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/i18n/backend/cached_key_value_store.rb

@@ -25,11 +25,20 @@ module I18n
 
       def update_version!(locale)
         @store["#{KEY_PREFIX}#{locale}"] = Time.now.to_i
+        on_update_version locale
       end
 
       def current_version(locale)
         @store["#{KEY_PREFIX}#{locale}"]
       end
+
+      def on_update_version(locale = nil, &block)
+        if block_given?
+          @on_store_block = block
+        elsif @on_store_block != nil
+          @on_store_block.call locale
+        end
+      end
     end
   end
 end

data/spec/i18n/backend/cached_key_value_store_spec.rb

@@ -51,4 +51,46 @@ describe I18n::Backend::CachedKeyValueStore do
       store['en.simple'].should match(/test/)
     end
   end
+
+  describe '#update_version!' do
+    it 'writes a timestamp to the store' do
+      Time.should_receive(:now).and_return '123'
+      key = 'i18n:locale_version:en'
+
+      subject.update_version!(:en)
+      store[key].should == 123
+    end
+
+    it 'triggers a hook' do
+      subject.should_receive(:on_update_version).with :en
+      subject.update_version!(:en)
+    end
+  end
+
+  describe '#on_update_version' do
+    context 'with a block' do
+      before do
+        @prc = Proc.new { }
+        subject.on_update_version &@prc
+      end
+
+      it 'stores a block you pass to it' do
+        @prc.should_not_receive(:call)
+        subject.on_update_version { }
+      end
+
+      it 'triggers the block if no block is passed' do
+        @prc.should_receive(:call).with :en
+        subject.on_update_version :en
+      end
+    end
+
+    context 'without a block' do
+      it 'does nothing if no block is passed' do
+        expect {
+          subject.on_update_version
+        }.to_not raise_error
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cached_key_value_store
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-26 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,9 +43,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
-description: ! "This gem is designed for usage with a key-value store\n                       database,
-  where latency is an issue. Locale changes are\n                       versioned
-  to allow for an easy cache-bust. "
+description: ! "This gem is designed for usage with a I18n backend\n                       key-value
+  database, where latency is an issue. I18n\n                       changes are versioned
+  to allow for an easy cache-bust."
 email: mwheeler@g2crowd.com
 executables: []
 extensions: []
@@ -63,7 +63,7 @@ files:
 - lib/i18n/backend/cached_key_value_store.rb
 - spec/i18n/backend/cached_key_value_store_spec.rb
 - spec/spec_helper.rb
-homepage: http://rubygems.org/gems/cached-key-value-store
+homepage: https://github.com/wheeyls/cached_key_value_store
 licenses: []
 post_install_message: 
 rdoc_options: []