dalli 2.0.5 → 2.1.0

data/History.md

@@ -1,6 +1,11 @@
 Dalli Changelog
 =====================
 
+2.1.0
+=======
+
+- Add Railtie to auto-configure Dalli when included in Gemfile [#217, steveklabnik]
+
 2.0.5
 =======
 

data/README.md

@@ -81,14 +81,11 @@ Here's a more comprehensive example that sets a reasonable default for maximum c
     config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com',
         { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
 
-To use Dalli for Rails session storage, in `config/initializers/session_store.rb`:
+To use Dalli for Rails session storage that times out after 20 minutes, in `config/initializers/session_store.rb`:
 
-    require 'action_dispatch/middleware/session/dalli_store'
-    Rails.application.config.session_store :dalli_store, :memcache_server => ['host1', 'host2'], :namespace => 'sessions', :key => '_foundation_session', :expire_after => 30.minutes
+    Rails.application.config.session_store ActionDispatch::Session::CacheStore, :expire_after => 20.minutes
 
-Both cache and session stores support `:raise_errors` parameter, which propagates exceptions (e.g. if all memcache servers are down) instead of silently hiding errors.
-
-Dalli does not support Rails 2.x any longer.
+Dalli does not support Rails 2.x.
 
 
 Configuration

data/lib/active_support/cache/dalli_store.rb

@@ -1,6 +1,5 @@
 # encoding: ascii
 require 'dalli'
-require 'digest/md5'
 
 module ActiveSupport
   module Cache
@@ -164,6 +163,10 @@ module ActiveSupport
       # be used with care when using a shared cache.
       def clear(options=nil)
         @data.flush_all
+      rescue Dalli::DalliError => e
+        logger.error("DalliError: #{e.message}") if logger
+        raise if @raise_errors
+        nil
       end
 
       # Get the statistics from the memcached servers.
@@ -233,7 +236,6 @@ module ActiveSupport
         key = key.to_s.dup
         key = key.force_encoding("BINARY") if key.encoding_aware?
         key = key.gsub(ESCAPE_KEY_CHARS){ |match| "%#{match.getbyte(0).to_s(16).upcase}" }
-        key = "#{key[0, 213]}:md5:#{Digest::MD5.hexdigest(key)}" if key.size > 250
         key
       end
 

data/lib/dalli.rb

@@ -4,6 +4,7 @@ require 'dalli/server'
 require 'dalli/socket'
 require 'dalli/version'
 require 'dalli/options'
+require 'dalli/railtie' if defined?(Rails)
 
 module Dalli
   # generic error

data/lib/dalli/client.rb

@@ -1,3 +1,5 @@
+require 'digest/md5'
+
 # encoding: ascii
 module Dalli
   class Client
@@ -83,7 +85,7 @@ module Dalli
     end
 
     def fetch(key, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in]
+      ttl ||= @options[:expires_in].to_i
       val = get(key, options)
       if val.nil? && block_given?
         val = yield
@@ -104,7 +106,7 @@ module Dalli
     # - false if the value was changed by someone else.
     # - true if the value was successfully updated.
     def cas(key, ttl=nil, options=nil, &block)
-      ttl ||= @options[:expires_in]
+      ttl ||= @options[:expires_in].to_i
       (value, cas) = perform(:cas, key)
       value = (!value || value == 'Not found') ? nil : value
       if value
@@ -114,7 +116,7 @@ module Dalli
     end
 
     def set(key, value, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in]
+      ttl ||= @options[:expires_in].to_i
       perform(:set, key, value, ttl, 0, options)
     end
 
@@ -122,7 +124,7 @@ module Dalli
     # Conditionally add a key/value pair, if the key does not already exist
     # on the server.  Returns true if the operation succeeded.
     def add(key, value, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in]
+      ttl ||= @options[:expires_in].to_i
       perform(:add, key, value, ttl, options)
     end
 
@@ -130,7 +132,7 @@ module Dalli
     # Conditionally add a key/value pair, only if the key already exists
     # on the server.  Returns true if the operation succeeded.
     def replace(key, value, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in]
+      ttl ||= @options[:expires_in].to_i
       perform(:replace, key, value, ttl, options)
     end
 
@@ -172,7 +174,7 @@ module Dalli
     # #cas.
     def incr(key, amt=1, ttl=nil, default=nil)
       raise ArgumentError, "Positive values only: #{amt}" if amt < 0
-      ttl ||= @options[:expires_in]
+      ttl ||= @options[:expires_in].to_i
       perform(:incr, key, amt.to_i, ttl, default)
     end
 
@@ -192,7 +194,7 @@ module Dalli
     # #cas.
     def decr(key, amt=1, ttl=nil, default=nil)
       raise ArgumentError, "Positive values only: #{amt}" if amt < 0
-      ttl ||= @options[:expires_in]
+      ttl ||= @options[:expires_in].to_i
       perform(:decr, key, amt.to_i, ttl, default)
     end
 
@@ -257,7 +259,11 @@ module Dalli
     def validate_key(key)
       raise ArgumentError, "key cannot be blank" if !key || key.length == 0
       key = key_with_namespace(key)
-      raise ArgumentError, "key too long #{key.inspect}" if key.length > 250
+      if key.length > 250
+        namespace_length = @options[:namespace] ? @options[:namespace].size : 0
+        max_length_before_namespace = 212 - namespace_length
+        key = "#{key[0, max_length_before_namespace]}:md5:#{Digest::MD5.hexdigest(key)}"
+      end
       return key
     end
 
@@ -274,7 +280,11 @@ module Dalli
         Dalli.logger.warn "DEPRECATED: Dalli's :compression option is now just :compress => true.  Please update your configuration."
         opts[:compress] = opts.delete(:compression)
       end
-      opts[:expires_in] ||= 0
+      begin
+        opts[:expires_in] = opts[:expires_in].to_i if opts[:expires_in]
+      rescue NoMethodError
+        raise ArgumentError, "cannot convert :expires_in => #{opts[:expires_in].inspect} to an integer"
+      end
       opts
     end
   end

data/lib/dalli/railtie.rb

@@ -0,0 +1,7 @@
+module Dalli
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      config.cache_store = :dalli_store
+    end
+  end
+end

data/lib/dalli/version.rb

@@ -1,3 +1,3 @@
 module Dalli
-  VERSION = '2.0.5'
+  VERSION = '2.1.0'
 end

data/test/test_dalli.rb

@@ -14,6 +14,15 @@ describe 'Dalli' do
       # Rails.logger.expects :warn
       assert dc.instance_variable_get(:@options)[:compress]
     end
+    
+    should 'raises error with invalid expires_in' do
+      bad_data = [{:bad => 'expires in data'}, Hash, [1,2,3]]
+      bad_data.each do |bad|
+        assert_raises ArgumentError do
+          dc = Dalli::Client.new('foo', {:expires_in => bad})
+        end
+      end
+    end
   end
 
   describe 'key validation' do
@@ -404,11 +413,16 @@ describe 'Dalli' do
         dc2.set('namespaced', 2)
         assert_equal 1, dc.get('namespaced')
         assert_equal 2, dc2.get('namespaced')
-
-        dc3 = Dalli::Client.new('localhost:19122', :namespace => 'c' * 100)
-        assert_raises ArgumentError do
-          dc3.get "a" * 151
-        end
+      end
+    end
+    
+    should 'truncate cache keys that are too long' do
+      memcached do
+        @dalli = Dalli::Client.new('localhost:19122', :namespace => 'some:namspace')
+        key = "this cache key is far too long so it must be hashed and truncated and stuff" * 10
+        value = "some value"
+        assert_equal true, @dalli.set(key, value)
+        assert_equal value, @dalli.get(key)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dalli
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2012-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_shoulda
-  requirement: &70288172335520 !ruby/object:Gem::Requirement
+  requirement: &70203098892260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70288172335520
+  version_requirements: *70203098892260
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70288172334260 !ruby/object:Gem::Requirement
+  requirement: &70203098891120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70288172334260
+  version_requirements: *70203098891120
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70288172333720 !ruby/object:Gem::Requirement
+  requirement: &70203098890540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '3'
   type: :development
   prerelease: false
-  version_requirements: *70288172333720
+  version_requirements: *70203098890540
 description: High performance memcached client for Ruby
 email: mperham@gmail.com
 executables: []
@@ -54,6 +54,7 @@ files:
 - lib/active_support/cache/dalli_store.rb
 - lib/dalli/client.rb
 - lib/dalli/options.rb
+- lib/dalli/railtie.rb
 - lib/dalli/ring.rb
 - lib/dalli/server.rb
 - lib/dalli/socket.rb