dalli 2.7.11 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bc4fe873fe9319c9297219b7908d576470551d0e011d1299e54ebc162256a68
-  data.tar.gz: b60393783d05152ad67aa12298f6867127f973fbf07cd2d0dc90ab96b1d7971f
+  metadata.gz: 48a2e02ec2d89d9304b68d36ed3827f4677398043a875f10c78a47f0517f579b
+  data.tar.gz: f2f365d5bc6d353fed61fd72866460c2e2929de9097018639f78687d96dae320
 SHA512:
-  metadata.gz: 1348b528243f253c111ad74e17a0ba20d8d14eb29d4f41e15f60bb2c87505c6d09404217c868f1623bd68f1ad70a644efd09fd1acca0ba2a1d0b6395387967ae
-  data.tar.gz: 108c5477c6399ef838a8df14e4878509ec5f7c22c33d012c19a9deb635901e9251a52c392c080fd6eb65dfb54e8084ee70cf6668a6914fd1336120aabb19b4f9
+  metadata.gz: 732930e9654c116fbf3769bac8091126f831eb22d795ed8f7d70479ab3a15591576b9e88d150fc5a79590dbec309249d144de909698c010284bbb30b585c5180
+  data.tar.gz: 54aa18fc3808423e74507f1a3934afbbc60b78c080fc3e5bf790a1daf7832af9a8481f77c5dc8fcb428ca9743ec3f5eb3cb0258517d7cb126e5dd3c749e8f56f

data/Gemfile

@@ -1,15 +1,10 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'appraisal'
-gem 'kgio', :platform => :mri
-gem 'rails'
-
 group :test do
-  gem 'minitest'
-  gem 'mocha'
-  gem 'rake'
-  gem 'connection_pool'
-  gem 'simplecov'
+  gem "minitest"
+  gem "rake"
+  gem "simplecov"
+  gem "ruby-prof", platform: :mri
 end

data/History.md

@@ -1,6 +1,34 @@
 Dalli Changelog
 =====================
 
+3.0.0
+==========
+- BREAKING CHANGES:
+
+- Removes :dalli_store.
+  Use Rails' official :mem_cache_store instead.
+  https://guides.rubyonrails.org/caching_with_rails.html
+- Attempting to store a larger value than allowed by memcached used to
+  print a warning and truncate the value. This now raises an error to
+  prevent silent data corruption.
+- Compression now defaults to `true` for large values (greater than 4KB).
+  This is intended to minimize errors due to the previous note.
+- Errors marshalling values now raise rather than just printing an error.
+- The Rack session adapter has been refactored to remove support for thread-unsafe
+  configurations. You will need to include the `connection_pool` gem in
+  your Gemfile to ensure session operations are thread-safe.
+
+- Raise NetworkError when multi response gets into corrupt state (mervync, #783)
+- Validate servers argument (semaperepelitsa, petergoldstein, #776)
+- Enable SSL support (bdunne, #775)
+- Add gat operation (tbeauvais, #769)
+- Removes inline native code, use Ruby 2.3+ support for bsearch instead. (mperham)
+- Switch repo to Github Actions and upgrade Ruby versions (petergoldstein, bdunne, Fryguy)
+- Update benchmark test for Rubyprof changes (nateberkopec)
+- Remove support for the `kgio` gem, it is not relevant in Ruby 2.3+. (mperham)
+- Remove inline native code, use Ruby 2.3+ support for bsearch instead. (mperham)
+
+
 2.7.11
 ==========
 - DEPRECATION: :dalli_store will be removed in Dalli 3.0.

data/README.md

@@ -1,4 +1,4 @@
-Dalli [![Build Status](https://secure.travis-ci.org/petergoldstein/dalli.svg)](http://travis-ci.org/petergoldstein/dalli)
+Dalli [![Tests](https://github.com/petergoldstein/dalli/actions/workflows/tests.yml/badge.svg)](https://github.com/petergoldstein/dalli/actions/workflows/tests.yml)
 =====
 
 Dalli is a high performance pure Ruby client for accessing memcached servers.  It works with memcached 1.4+ only as it uses the newer binary protocol.  It should be considered a replacement for the memcache-client gem.
@@ -46,83 +46,23 @@ dc.set('abc', 123)
 value = dc.get('abc')
 ```
 
-The test suite requires memcached 1.4.3+ with SASL enabled (`brew install memcached --enable-sasl ; mv /usr/bin/memcached /usr/bin/memcached.old`).  Currently only supports the PLAIN mechanism.
-
-Dalli has no runtime dependencies.
-
-Usage with Rails 3.x and 4.x
----------------------------
-
-In your Gemfile:
-
+With SSL enabled:
 ```ruby
-gem 'dalli'
-```
-
-In `config/environments/production.rb`:
-
-```ruby
-config.cache_store = :dalli_store
-```
-
-Here's a more comprehensive example that sets a reasonable default for maximum cache entry lifetime (one day), enables compression for large values and namespaces all entries for this rails app.  Remove the namespace if you have multiple apps which share cached values.
-
-```ruby
-config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com:11211:2',
-  { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
-```
-
-You can specify a port and a weight by appending to the server name. You may wish to increase the weight of a server with more memory configured.  (e.g. to specify port 11211 and a weight of 2, append `:11211:2` ) 
-
-If your servers are specified in `ENV["MEMCACHE_SERVERS"]` (e.g. on Heroku when using a third-party hosted addon), simply provide `nil` for the servers:
-
-```ruby
-config.cache_store = :dalli_store, nil, { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
-```
-
-To use Dalli for Rails session storage that times out after 20 minutes, in `config/initializers/session_store.rb`:
-
-For Rails >= 3.2.4:
-
-```ruby
-Rails.application.config.session_store ActionDispatch::Session::CacheStore, :expire_after => 20.minutes
-```
-
-For Rails 3.x:
-
-```ruby
-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 => 20.minutes
-```
-
-Dalli does not support Rails 2.x.
-
-
-Multithreading and Rails
---------------------------
-
-If you use Puma or another threaded app server, as of Dalli 2.7, you can use a pool
-of Dalli clients with Rails to ensure the `Rails.cache` singleton does not become a
-source of thread contention.  You must add `gem 'connection_pool'` to your Gemfile and
-add :pool\_size to your `dalli_store` config:
-
-```ruby
-config.cache_store = :dalli_store, 'cache-1.example.com', { :pool_size => 5 }
+require 'dalli'
+ssl_context = OpenSSL::SSL::SSLContext.new
+ssl_context.ca_file = "./myCA.pem"
+ssl_context.ssl_version = :SSLv23
+ssl_context.verify_hostname = true
+ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+dc = Dalli::Client.new("memcached:11212", :ssl_context => ssl_context)
+dc.set("abc", 123)
+value = dc.get("abc")
 ```
 
-You can then use the Rails cache as normal and Rails.cache will use the pool transparently under the covers, or you can check out a Dalli client directly from the pool:
-
-```ruby
-Rails.cache.fetch('foo', :expires_in => 300) do
-  'bar'
-end
-
-Rails.cache.dalli.with do |client|
-  # client is a Dalli::Client instance which you can
-  # use ONLY within this block
-end
-```
+The test suite requires memcached 1.4.3+ with SASL enabled (`brew install memcached --enable-sasl ; mv /usr/bin/memcached /usr/bin/memcached.old`).  Currently only supports the PLAIN mechanism.
 
+Dalli has no runtime dependencies.
 
 Configuration
 ------------------------
@@ -154,13 +94,13 @@ If serving compressed data using nginx's HttpMemcachedModule, set `memcached_gzi
 
 **keepalive**: Boolean. If true, Dalli will enable keep-alive for socket connections.  Default is true.
 
-**socket_timeout**: Timeout for all socket operations (connect, read, write). Default is 0.5.
+**socket_timeout**: Timeout for all socket operations (connect, read, write). Default is 1.
 
 **socket_max_failures**: When a socket operation fails after socket_timeout, the same operation is retried. This is to not immediately mark a server down when there's a very slight network problem. Default is 2.
 
-**socket_failure_delay**: Before retrying a socket operation, the process sleeps for this amount of time. Default is 0.01.  Set to nil for no delay.
+**socket_failure_delay**: Before retrying a socket operation, the process sleeps for this amount of time. Default is 0.1.  Set to nil for no delay.
 
-**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value too low, otherwise each request which tries the failed server might hang for the maximum **socket_timeout**. Default is 60 seconds.
+**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value too low, otherwise each request which tries the failed server might hang for the maximum **socket_timeout**. Default is 30 seconds.
 
 **value_max_bytes**: The maximum size of a value in memcached.  Defaults to 1MB, this can be increased with memcached's -I parameter.  You must also configure Dalli to allow the larger size here.
 

data/lib/dalli/cas/client.rb

@@ -1,59 +1 @@
-# frozen_string_literal: true
-require 'dalli/client'
-
-module Dalli
-  class Client
-    ##
-    # Get the value and CAS ID associated with the key.  If a block is provided,
-    # value and CAS will be passed to the block.
-    def get_cas(key)
-      (value, cas) = perform(:cas, key)
-      value = (!value || value == 'Not found') ? nil : value
-      if block_given?
-        yield value, cas
-      else
-        [value, cas]
-      end
-    end
-
-    ##
-    # Fetch multiple keys efficiently, including available metadata such as CAS.
-    # If a block is given, yields key/data pairs one a time.  Data is an array:
-    # [value, cas_id]
-    # If no block is given, returns a hash of
-    #   { 'key' => [value, cas_id] }
-    def get_multi_cas(*keys)
-      if block_given?
-        get_multi_yielder(keys) {|*args| yield(*args)}
-      else
-        Hash.new.tap do |hash|
-          get_multi_yielder(keys) {|k, data| hash[k] = data}
-        end
-      end
-    end
-
-    ##
-    # Set the key-value pair, verifying existing CAS.
-    # Returns the resulting CAS value if succeeded, and falsy otherwise.
-    def set_cas(key, value, cas, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in].to_i
-      perform(:set, key, value, ttl, cas, options)
-    end
-
-    ##
-    # Conditionally add a key/value pair, verifying existing CAS, only if the
-    # key already exists on the server.  Returns the new CAS value if the
-    # operation succeeded, or falsy otherwise.
-    def replace_cas(key, value, cas, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in].to_i
-      perform(:replace, key, value, ttl, cas, options)
-    end
-
-    # Delete a key/value pair, verifying existing CAS.
-    # Returns true if succeeded, and falsy otherwise.
-    def delete_cas(key, cas=0)
-      perform(:delete, key, cas)
-    end
-
-  end
-end
+puts "You can remove `require 'dalli/cas/client'` as this code has been rolled into the standard 'dalli/client'.