dalli 1.1.3 → 1.1.4

data/History.md

@@ -1,6 +1,19 @@
 Dalli Changelog
 =====================
 
+1.1.4
+=======
+
+- Use 127.0.0.1 instead of localhost as default to avoid IPv6 issues
+- Extend DalliStore's :expires\_in when :race\_condition\_ttl is also used.
+- Fix :expires\_in option not propogating from DalliStore to Client, GH-136
+- Added support for native Rack session store.  Until now, Dalli's
+  session store has required Rails.  Now you can use Dalli to store
+  sessions for any Rack application.
+
+    require 'rack/session/dalli'
+    use Rack::Session::Dalli, :memcache_server => 'localhost:11211', :compression => true
+
 1.1.3
 =======
 

data/README.md

@@ -80,7 +80,7 @@ In `config/environments/production.rb`:
 A more comprehensive example (note that we are setting a reasonable default for maximum cache entry lifetime (one day), enabling compression for large values, and namespacing all entries for this rails app.  Remove the namespace if you have multiple apps which share cached values):
 
     config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com',
-        { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
+        { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compression => true }
 
 To use Dalli for Rails session storage, in `config/initializers/session_store.rb`:
 

data/lib/action_dispatch/middleware/session/dalli_store.rb

@@ -15,7 +15,7 @@ module ActionDispatch
         @default_options = { :namespace => 'rack:session' }.merge(@default_options)
 
         @pool = options[:cache] || begin
-          Dalli::Client.new( 
+          Dalli::Client.new(
               @default_options[:memcache_server], @default_options)
         end
         @namespace = @default_options[:namespace]

data/lib/active_support/cache/dalli_store.rb

@@ -6,11 +6,12 @@ rescue LoadError => e
   raise e
 end
 require 'digest/md5'
+require 'active_support/cache'
 
 module ActiveSupport
   module Cache
     # A cache store implementation which stores data in Memcached:
-    # http://www.danga.com/memcached/
+    # http://www.memcached.org
     #
     # DalliStore implements the Strategy::LocalCache strategy which implements
     # an in memory cache inside of a block.
@@ -19,13 +20,6 @@ module ActiveSupport
       ESCAPE_KEY_CHARS = /[\x00-\x20%\x7F-\xFF]/
       RAW = { :raw => true }
 
-      def self.build_mem_cache(*addresses)
-        addresses = addresses.flatten
-        options = addresses.extract_options!
-        addresses = ["localhost:11211"] if addresses.empty?
-        Dalli::Client.new(addresses, options)
-      end
-
       # Creates a new DalliStore object, with the given memcached server
       # addresses. Each address is either a host name, or a host-with-port string
       # in the form of "host_name:port". For example:
@@ -40,9 +34,12 @@ module ActiveSupport
         options = addresses.extract_options!
         super(options)
 
-        mem_cache_options = options.dup
-        UNIVERSAL_OPTIONS.each{|name| mem_cache_options.delete(name)}
-        @data = self.class.build_mem_cache(*(addresses + [mem_cache_options]))
+        addresses << 'localhost:11211' if addresses.empty?
+        options = options.dup
+        # Extend expiry by stale TTL or else memcached will never return stale data.
+        # See ActiveSupport::Cache#fetch.
+        options[:expires_in] += options[:race_condition_ttl] if options[:expires_in] && options[:race_condition_ttl]
+        @data = Dalli::Client.new(addresses, options)
 
         extend Strategy::LocalCache
         extend LocalCacheWithRaw

data/lib/dalli/client.rb

@@ -6,7 +6,7 @@ module Dalli
     # Dalli::Client is the main class which developers will use to interact with
     # the memcached server.  Usage:
     #
-    #   Dalli::Client.new(['localhost:11211:10', 'cache-2.example.com:11211:5', '192.168.0.1:22122:5'], 
+    #   Dalli::Client.new(['localhost:11211:10', 'cache-2.example.com:11211:5', '192.168.0.1:22122:5'],
     #                   :threadsafe => true, :failover => true, :expires_in => 300)
     #
     # servers is an Array of "host:port:weight" where weight allows you to distribute cache unevenly.
@@ -30,7 +30,7 @@ module Dalli
     # - :async - assume its running inside the EM reactor. Requires em-synchrony to be installed. Default: false.
     #
     def initialize(servers=nil, options={})
-      @servers = env_servers || servers || 'localhost:11211'
+      @servers = env_servers || servers || '127.0.0.1:11211'
       @options = { :expires_in => 0 }.merge(options)
       self.extend(Dalli::Client::MemcacheClientCompatibility) if Dalli::Client.compatibility_mode
       @ring = nil
@@ -184,13 +184,14 @@ module Dalli
     ##
     # Incr adds the given amount to the counter on the memcached server.
     # Amt must be a positive value.
-    # 
-    # memcached counters are unsigned and cannot hold negative values.  Calling
-    # decr on a counter which is 0 will just return 0.
     #
     # If default is nil, the counter must already exist or the operation
     # will fail and will return nil.  Otherwise this method will return
     # the new value for the counter.
+    #
+    # Note that the ttl will only apply if the counter does not already
+    # exist.  To increase an existing counter and update its TTL, use
+    # #cas.
     def incr(key, amt=1, ttl=nil, default=nil)
       raise ArgumentError, "Positive values only: #{amt}" if amt < 0
       ttl ||= @options[:expires_in]
@@ -200,13 +201,17 @@ module Dalli
     ##
     # Decr subtracts the given amount from the counter on the memcached server.
     # Amt must be a positive value.
-    # 
+    #
     # memcached counters are unsigned and cannot hold negative values.  Calling
     # decr on a counter which is 0 will just return 0.
     #
     # If default is nil, the counter must already exist or the operation
     # will fail and will return nil.  Otherwise this method will return
     # the new value for the counter.
+    #
+    # Note that the ttl will only apply if the counter does not already
+    # exist.  To decrease an existing counter and update its TTL, use
+    # #cas.
     def decr(key, amt=1, ttl=nil, default=nil)
       raise ArgumentError, "Positive values only: #{amt}" if amt < 0
       ttl ||= @options[:expires_in]
@@ -263,7 +268,7 @@ module Dalli
         retry
       end
     end
-    
+
     def validate_key(key)
       raise ArgumentError, "illegal character in key #{key}" if key.respond_to?(:ascii_only?) && !key.ascii_only?
       raise ArgumentError, "illegal character in key #{key}" if key =~ /\s/
@@ -271,7 +276,7 @@ module Dalli
       raise ArgumentError, "key cannot be blank" if key.nil? || key.strip.size == 0
       raise ArgumentError, "key too long #{key.inspect}" if key.length > 250
     end
-    
+
     def key_with_namespace(key)
       @options[:namespace] ? "#{@options[:namespace]}:#{key}" : key
     end

data/lib/dalli/ring.rb

@@ -4,9 +4,9 @@ require 'zlib'
 module Dalli
   class Ring
     POINTS_PER_SERVER = 160 # this is the default in libmemcached
-    
+
     attr_accessor :servers, :continuum
-    
+
     def initialize(servers, options)
       @servers = servers
       @continuum = nil
@@ -26,7 +26,7 @@ module Dalli
       threadsafe! unless options[:threadsafe] == false
       @failover = options[:failover] != false
     end
-    
+
     def server_for_key(key)
       if @continuum
         hkey = hash_for(key)
@@ -44,7 +44,7 @@ module Dalli
 
       raise Dalli::RingError, "No server available"
     end
-    
+
     def lock
       @servers.each { |s| s.lock! }
       begin
@@ -53,7 +53,7 @@ module Dalli
         @servers.each { |s| s.unlock! }
       end
     end
-    
+
     private
 
     def threadsafe!

data/lib/dalli/socket.rb

@@ -28,7 +28,7 @@ begin
       loop do
         value << kgio_read!(count - value.bytesize)
         break if value.bytesize == count
-      end 
+      end
       value
     end
 
@@ -149,13 +149,22 @@ rescue LoadError
   puts "Could not define alternate em-synchrony socket IO" if defined?($TESTING) && $TESTING
 end
 
-class Dalli::Server::USocket < UNIXSocket
-  def readfull(count)
-    value = ''
-    loop do
-      value << read(count - value.bytesize)
-      break if value.bytesize == count
-    end 
-    value
+require 'rbconfig'
+if RbConfig::CONFIG['host_os'] =~ /mingw|mswin/
+  class Dalli::Server::USocket
+    def initialize(*args)
+      raise Dalli::DalliError, "Unix sockets are not supported on Windows platform."
+    end
+  end
+else
+  class Dalli::Server::USocket < UNIXSocket
+    def readfull(count)
+      value = ''
+      loop do
+        value << read(count - value.bytesize)
+        break if value.bytesize == count
+      end
+      value
+    end
   end
 end

data/lib/dalli/version.rb

@@ -1,3 +1,3 @@
 module Dalli
-  VERSION = '1.1.3'
+  VERSION = '1.1.4'
 end

data/lib/rack/session/dalli.rb

@@ -0,0 +1,52 @@
+require 'rack/session/abstract/id'
+require 'dalli'
+
+module Rack
+  module Session
+    class Dalli < Abstract::ID
+      attr_reader :pool
+
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge \
+        :namespace => 'rack:session',
+        :memcache_server => 'localhost:11211'
+
+      def initialize(app, options={})
+        super
+        mserv = @default_options[:memcache_server]
+        mopts = @default_options.reject{|k,v| !DEFAULT_OPTIONS.include? k }
+        @pool = options[:cache] || Dalli::Client.new(mserv, mopts)
+      end
+
+      def generate_sid
+        loop do
+          sid = super
+          break sid unless @pool.get(sid)
+        end
+      end
+
+      def get_session(env, sid)
+        unless sid and session = @pool.get(sid)
+          sid, session = generate_sid, {}
+          unless @pool.add(sid, session)
+            raise "Session collision on '#{sid.inspect}'"
+          end
+        end
+        [sid, session]
+      end
+
+      def set_session(env, session_id, new_session, options)
+        expiry = options[:expire_after]
+        expiry = expiry.nil? ? 0 : expiry + 1
+
+        @pool.set session_id, new_session, expiry
+        session_id
+      end
+
+      def destroy_session(env, session_id, options)
+        @pool.delete(session_id)
+        generate_sid unless options[:drop]
+      end
+
+    end
+  end
+end

data/test/benchmark_test.rb

@@ -20,10 +20,10 @@ class TestBenchmark < Test::Unit::TestCase
     @key6 = "Long3"*40
     @counter = 'counter'
   end
-  
+
   def test_benchmark
     memcached do
-    
+
       Benchmark.bm(31) do |x|
 
         n = 2500

data/test/memcached_mock.rb

@@ -18,7 +18,7 @@ module MemcachedMock
   def self.tmp_socket_path
     "#{Dir.pwd}/tmp.sock"
   end
- 
+
   module Helper
     # Forks the current process and starts a new mock Memcached server on
     # port 22122.
@@ -74,7 +74,7 @@ module MemcachedMock
       return unless supports_fork?
       Memcached.path ||= find_memcached
 
-      cmd = if options[:unix] 
+      cmd = if options[:unix]
         "#{Memcached.path}memcached #{args} -s #{MemcachedMock.tmp_socket_path}"
       else
         "#{Memcached.path}memcached #{args} -p #{port}"

data/test/test_active_support.rb

@@ -180,6 +180,15 @@ class TestActiveSupport < Test::Unit::TestCase
     end
   end
 
+  should 'normalize options as expected' do
+    with_activesupport do
+      memcached do
+        @dalli = ActiveSupport::Cache::DalliStore.new('localhost:19122', :expires_in => 1, :race_condition_ttl => 1)
+        assert_equal 2, @dalli.instance_variable_get(:@data).instance_variable_get(:@options)[:expires_in]
+      end
+    end
+  end
+
   def connect
     @dalli = ActiveSupport::Cache.lookup_store(:dalli_store, 'localhost:19122', :expires_in => 10.seconds, :namespace => 'x')
     @mc = ActiveSupport::Cache.lookup_store(:mem_cache_store, 'localhost:19122', :expires_in => 10.seconds, :namespace => 'a')

data/test/test_dalli.rb

@@ -22,7 +22,7 @@ class TestDalli < Test::Unit::TestCase
     assert_equal 1, ring.servers.size
     dc.close
 
-    assert_equal s1, s2
+    assert_equal '127.0.0.1', s1
     assert_equal s2, s3
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dalli
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-26 00:00:00.000000000Z
+date: 2011-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2152632040 !ruby/object:Gem::Requirement
+  requirement: &70233391291560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152632040
+  version_requirements: *70233391291560
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152630860 !ruby/object:Gem::Requirement
+  requirement: &70233391290560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152630860
+  version_requirements: *70233391290560
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2152629740 !ruby/object:Gem::Requirement
+  requirement: &70233391290000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *2152629740
+  version_requirements: *70233391290000
 - !ruby/object:Gem::Dependency
   name: memcache-client
-  requirement: &2152628780 !ruby/object:Gem::Requirement
+  requirement: &70233391289240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: 1.8.5
   type: :development
   prerelease: false
-  version_requirements: *2152628780
+  version_requirements: *70233391289240
 description: High performance memcached client for Ruby
 email: mperham@gmail.com
 executables: []
@@ -73,6 +73,7 @@ files:
 - lib/dalli/socket.rb
 - lib/dalli/version.rb
 - lib/dalli.rb
+- lib/rack/session/dalli.rb
 - LICENSE
 - README.md
 - History.md