dalli 2.7.11 → 3.0.2

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of dalli might be problematic. Click here for more details.

checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4bc4fe873fe9319c9297219b7908d576470551d0e011d1299e54ebc162256a68
4
- data.tar.gz: b60393783d05152ad67aa12298f6867127f973fbf07cd2d0dc90ab96b1d7971f
3
+ metadata.gz: 3fadd6651330b2d8455d781253451bd4e47d6caaaad9c12002284c6541727adb
4
+ data.tar.gz: ea65f2d7199c5dea247c2909ac90775240bd3da1ccfaebcebc916788a8b0ebf2
5
5
  SHA512:
6
- metadata.gz: 1348b528243f253c111ad74e17a0ba20d8d14eb29d4f41e15f60bb2c87505c6d09404217c868f1623bd68f1ad70a644efd09fd1acca0ba2a1d0b6395387967ae
7
- data.tar.gz: 108c5477c6399ef838a8df14e4878509ec5f7c22c33d012c19a9deb635901e9251a52c392c080fd6eb65dfb54e8084ee70cf6668a6914fd1336120aabb19b4f9
6
+ metadata.gz: 368db20ef7ceb7a8301e8e027107ce90b238295f59aa8e1412f1e34a30a0e903ae56b6a07b2963eee0bc1a540fded0cacd3092a02f25ad1c17a21a05320baaf3
7
+ data.tar.gz: 32cc139bc122233910dddb62e1e3a6e1efec95e19d181dab04c8ced725806e238e1e6a62797cbbd8336e6e16b4a4a394c2f937bcaf8fffa63f66149d9f598e8c
data/Gemfile CHANGED
@@ -1,15 +1,10 @@
1
- source 'https://rubygems.org'
1
+ source "https://rubygems.org"
2
2
 
3
3
  gemspec
4
4
 
5
- gem 'appraisal'
6
- gem 'kgio', :platform => :mri
7
- gem 'rails'
8
-
9
5
  group :test do
10
- gem 'minitest'
11
- gem 'mocha'
12
- gem 'rake'
13
- gem 'connection_pool'
14
- gem 'simplecov'
6
+ gem "minitest"
7
+ gem "rake"
8
+ gem "simplecov"
9
+ gem "ruby-prof", platform: :mri
15
10
  end
data/History.md CHANGED
@@ -1,6 +1,47 @@
1
1
  Dalli Changelog
2
2
  =====================
3
3
 
4
+ 3.0.2
5
+ ==========
6
+
7
+ - Restore Windows compatibility (petergoldstein)
8
+ - Add JRuby to CI and make requisite changes (petergoldstein)
9
+ - Clarify documentation for supported rubies (petergoldstein)
10
+
11
+ 3.0.1
12
+ ==========
13
+
14
+ - Fix syntax error that prevented inclusion of Dalli::Server (ryanfb)
15
+ - Restore with method required by ActiveSupport::Cache::MemCacheStore
16
+
17
+ 3.0.0
18
+ ==========
19
+ - BREAKING CHANGES:
20
+
21
+ * Removes :dalli_store.
22
+ Use Rails' official :mem_cache_store instead.
23
+ https://guides.rubyonrails.org/caching_with_rails.html
24
+ * Attempting to store a larger value than allowed by memcached used to
25
+ print a warning and truncate the value. This now raises an error to
26
+ prevent silent data corruption.
27
+ * Compression now defaults to `true` for large values (greater than 4KB).
28
+ This is intended to minimize errors due to the previous note.
29
+ * Errors marshalling values now raise rather than just printing an error.
30
+ * The Rack session adapter has been refactored to remove support for thread-unsafe
31
+ configurations. You will need to include the `connection_pool` gem in
32
+ your Gemfile to ensure session operations are thread-safe.
33
+
34
+ - Raise NetworkError when multi response gets into corrupt state (mervync, #783)
35
+ - Validate servers argument (semaperepelitsa, petergoldstein, #776)
36
+ - Enable SSL support (bdunne, #775)
37
+ - Add gat operation (tbeauvais, #769)
38
+ - Removes inline native code, use Ruby 2.3+ support for bsearch instead. (mperham)
39
+ - Switch repo to Github Actions and upgrade Ruby versions (petergoldstein, bdunne, Fryguy)
40
+ - Update benchmark test for Rubyprof changes (nateberkopec)
41
+ - Remove support for the `kgio` gem, it is not relevant in Ruby 2.3+. (mperham)
42
+ - Remove inline native code, use Ruby 2.3+ support for bsearch instead. (mperham)
43
+
44
+
4
45
  2.7.11
5
46
  ==========
6
47
  - DEPRECATION: :dalli_store will be removed in Dalli 3.0.
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- Dalli [![Build Status](https://secure.travis-ci.org/petergoldstein/dalli.svg)](http://travis-ci.org/petergoldstein/dalli)
1
+ Dalli [![Tests](https://github.com/petergoldstein/dalli/actions/workflows/tests.yml/badge.svg)](https://github.com/petergoldstein/dalli/actions/workflows/tests.yml)
2
2
  =====
3
3
 
4
4
  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.
@@ -12,11 +12,10 @@ Dalli's initial development was sponsored by [CouchBase](http://www.couchbase.co
12
12
  Supported Ruby versions and implementations
13
13
  ------------------------------------------------
14
14
 
15
- Dalli should work identically on:
15
+ As of Dalli version 3.0 the following Ruby versions are supported:
16
16
 
17
- * JRuby 1.6+
18
- * Ruby 1.9.3+
19
- * Rubinius 2.0
17
+ * Ruby 2.5.x, 2.6.x, 2.7.x, 3.0.x
18
+ * JRuby 9.2.x, 9.3.x
20
19
 
21
20
  If you have problems, please enter an issue.
22
21
 
@@ -24,7 +23,7 @@ If you have problems, please enter an issue.
24
23
  Installation and Usage
25
24
  ------------------------
26
25
 
27
- Remember, Dalli **requires** memcached 1.4+. You can check the version with `memcached -h`. Please note that the memcached version that *Mac OS X Snow Leopard* ships with is 1.2.8 and it won't work. Install memcached 1.4.x using Homebrew with
26
+ Remember, Dalli **requires** memcached 1.4+. You can check the version with `memcached -h`. Please note that the memcached version that *Mac OS X Snow Leopard* ships with is 1.2.8 and it won't work. Install the most recent version of memcached using Homebrew with
28
27
 
29
28
  brew install memcached
30
29
 
@@ -40,89 +39,29 @@ gem install dalli
40
39
 
41
40
  ```ruby
42
41
  require 'dalli'
43
- options = { :namespace => "app_v1", :compress => true }
42
+ options = { namespace: "app_v1", compress: true }
44
43
  dc = Dalli::Client.new('localhost:11211', options)
45
44
  dc.set('abc', 123)
46
45
  value = dc.get('abc')
47
46
  ```
48
47
 
49
- 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.
50
-
51
- Dalli has no runtime dependencies.
52
-
53
- Usage with Rails 3.x and 4.x
54
- ---------------------------
55
-
56
- In your Gemfile:
57
-
58
- ```ruby
59
- gem 'dalli'
60
- ```
61
-
62
- In `config/environments/production.rb`:
63
-
64
- ```ruby
65
- config.cache_store = :dalli_store
66
- ```
67
-
68
- 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.
69
-
70
- ```ruby
71
- config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com:11211:2',
72
- { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
73
- ```
74
-
75
- 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` )
76
-
77
- 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:
78
-
79
- ```ruby
80
- config.cache_store = :dalli_store, nil, { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
81
- ```
82
-
83
- To use Dalli for Rails session storage that times out after 20 minutes, in `config/initializers/session_store.rb`:
84
-
85
- For Rails >= 3.2.4:
86
-
48
+ With SSL enabled:
87
49
  ```ruby
88
- Rails.application.config.session_store ActionDispatch::Session::CacheStore, :expire_after => 20.minutes
89
- ```
90
-
91
- For Rails 3.x:
92
-
93
- ```ruby
94
- require 'action_dispatch/middleware/session/dalli_store'
95
- Rails.application.config.session_store :dalli_store, :memcache_server => ['host1', 'host2'], :namespace => 'sessions', :key => '_foundation_session', :expire_after => 20.minutes
96
- ```
97
-
98
- Dalli does not support Rails 2.x.
99
-
100
-
101
- Multithreading and Rails
102
- --------------------------
103
-
104
- If you use Puma or another threaded app server, as of Dalli 2.7, you can use a pool
105
- of Dalli clients with Rails to ensure the `Rails.cache` singleton does not become a
106
- source of thread contention. You must add `gem 'connection_pool'` to your Gemfile and
107
- add :pool\_size to your `dalli_store` config:
108
-
109
- ```ruby
110
- config.cache_store = :dalli_store, 'cache-1.example.com', { :pool_size => 5 }
50
+ require 'dalli'
51
+ ssl_context = OpenSSL::SSL::SSLContext.new
52
+ ssl_context.ca_file = "./myCA.pem"
53
+ ssl_context.ssl_version = :SSLv23
54
+ ssl_context.verify_hostname = true if ssl_context.respond_to?(:verify_hostname=)
55
+ ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
56
+
57
+ dc = Dalli::Client.new("memcached:11212", ssl_context: ssl_context)
58
+ dc.set("abc", 123)
59
+ value = dc.get("abc")
111
60
  ```
112
61
 
113
- 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:
114
-
115
- ```ruby
116
- Rails.cache.fetch('foo', :expires_in => 300) do
117
- 'bar'
118
- end
119
-
120
- Rails.cache.dalli.with do |client|
121
- # client is a Dalli::Client instance which you can
122
- # use ONLY within this block
123
- end
124
- ```
62
+ 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.
125
63
 
64
+ Dalli has no runtime dependencies.
126
65
 
127
66
  Configuration
128
67
  ------------------------
@@ -142,25 +81,23 @@ Dalli::Client accepts the following options. All times are in seconds.
142
81
  **serializer**: The serializer to use for objects being stored (ex. JSON).
143
82
  Default is Marshal.
144
83
 
145
- **compress**: Boolean, if true Dalli will gzip-compress values larger than 1K. Default is false.
84
+ **compress**: Boolean, if true Dalli will gzip-compress values larger than compression_min_size. Default is true.
146
85
 
147
86
  **compression_min_size**: Minimum value byte size for which to attempt compression. Default is 1K.
148
87
 
149
- **compression_max_size**: Maximum value byte size for which to attempt compression. Default is unlimited.
150
-
151
88
  **compressor**: The compressor to use for objects being stored.
152
89
  Default is zlib, implemented under `Dalli::Compressor`.
153
90
  If serving compressed data using nginx's HttpMemcachedModule, set `memcached_gzip_flag 2` and use `Dalli::GzipCompressor`
154
91
 
155
92
  **keepalive**: Boolean. If true, Dalli will enable keep-alive for socket connections. Default is true.
156
93
 
157
- **socket_timeout**: Timeout for all socket operations (connect, read, write). Default is 0.5.
94
+ **socket_timeout**: Timeout for all socket operations (connect, read, write). Default is 1.
158
95
 
159
96
  **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.
160
97
 
161
- **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.
98
+ **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.
162
99
 
163
- **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.
100
+ **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.
164
101
 
165
102
  **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.
166
103
 
@@ -1,59 +1 @@
1
- # frozen_string_literal: true
2
- require 'dalli/client'
3
-
4
- module Dalli
5
- class Client
6
- ##
7
- # Get the value and CAS ID associated with the key. If a block is provided,
8
- # value and CAS will be passed to the block.
9
- def get_cas(key)
10
- (value, cas) = perform(:cas, key)
11
- value = (!value || value == 'Not found') ? nil : value
12
- if block_given?
13
- yield value, cas
14
- else
15
- [value, cas]
16
- end
17
- end
18
-
19
- ##
20
- # Fetch multiple keys efficiently, including available metadata such as CAS.
21
- # If a block is given, yields key/data pairs one a time. Data is an array:
22
- # [value, cas_id]
23
- # If no block is given, returns a hash of
24
- # { 'key' => [value, cas_id] }
25
- def get_multi_cas(*keys)
26
- if block_given?
27
- get_multi_yielder(keys) {|*args| yield(*args)}
28
- else
29
- Hash.new.tap do |hash|
30
- get_multi_yielder(keys) {|k, data| hash[k] = data}
31
- end
32
- end
33
- end
34
-
35
- ##
36
- # Set the key-value pair, verifying existing CAS.
37
- # Returns the resulting CAS value if succeeded, and falsy otherwise.
38
- def set_cas(key, value, cas, ttl=nil, options=nil)
39
- ttl ||= @options[:expires_in].to_i
40
- perform(:set, key, value, ttl, cas, options)
41
- end
42
-
43
- ##
44
- # Conditionally add a key/value pair, verifying existing CAS, only if the
45
- # key already exists on the server. Returns the new CAS value if the
46
- # operation succeeded, or falsy otherwise.
47
- def replace_cas(key, value, cas, ttl=nil, options=nil)
48
- ttl ||= @options[:expires_in].to_i
49
- perform(:replace, key, value, ttl, cas, options)
50
- end
51
-
52
- # Delete a key/value pair, verifying existing CAS.
53
- # Returns true if succeeded, and falsy otherwise.
54
- def delete_cas(key, cas=0)
55
- perform(:delete, key, cas)
56
- end
57
-
58
- end
59
- end
1
+ puts "You can remove `require 'dalli/cas/client'` as this code has been rolled into the standard 'dalli/client'."