dalli 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fadd6651330b2d8455d781253451bd4e47d6caaaad9c12002284c6541727adb
-  data.tar.gz: ea65f2d7199c5dea247c2909ac90775240bd3da1ccfaebcebc916788a8b0ebf2
+  metadata.gz: 4afe70ee94b027c2934fa368a16ca42bf41b7a844c0785c706e2035dba372f66
+  data.tar.gz: 340cf977e332834bfae268995e2d5c70158813f5405fbeee7764e3cc8fa1eb9f
 SHA512:
-  metadata.gz: 368db20ef7ceb7a8301e8e027107ce90b238295f59aa8e1412f1e34a30a0e903ae56b6a07b2963eee0bc1a540fded0cacd3092a02f25ad1c17a21a05320baaf3
-  data.tar.gz: 32cc139bc122233910dddb62e1e3a6e1efec95e19d181dab04c8ced725806e238e1e6a62797cbbd8336e6e16b4a4a394c2f937bcaf8fffa63f66149d9f598e8c
+  metadata.gz: a3f8a4ca2792149afa6c5b125edad177a69f2bfdaba5106632da7e1ff8c80d0549ea9f4077240d853115caa1711e10e0e966191b9fbb4a5f7103a95bd70629b2
+  data.tar.gz: 28b0926d7367973a0aa57b1d9c95b57f82bf3d7ffd1874259715285538eaa3ab07ab40b67d7c7444734d23da8b20c8f099b1c5c7664f43028aa01715efd48239

data/History.md

@@ -1,6 +1,16 @@
 Dalli Changelog
 =====================
 
+3.0.3
+==========
+
+- Restore ability for `compress` to be disabled on a per request basis (petergoldstein)
+- Fix broken image in README (deining)
+- Use bundler-cache in CI (olleolleolle)
+- Remove the OpenSSL extensions dependency (petergoldstein)
+- Add Memcached 1.5.x to the CI matrix
+- Updated compression documentation (petergoldstein)
+
 3.0.2
 ==========
 

data/README.md

@@ -5,7 +5,7 @@ Dalli is a high performance pure Ruby client for accessing memcached servers.  I
 
 The name is a variant of Salvador Dali for his famous painting [The Persistence of Memory](http://en.wikipedia.org/wiki/The_Persistence_of_Memory).
 
-![Persistence of Memory](http://www.virtualdali.com/assets/paintings/31PersistenceOfMemory.jpg)
+![Persistence of Memory](https://upload.wikimedia.org/wikipedia/en/d/dd/The_Persistence_of_Memory.jpg)
 
 Dalli's initial development was sponsored by [CouchBase](http://www.couchbase.com/).  Many thanks to them!
 
@@ -81,9 +81,9 @@ Dalli::Client accepts the following options. All times are in seconds.
 **serializer**: The serializer to use for objects being stored (ex. JSON).
 Default is Marshal.
 
-**compress**: Boolean, if true Dalli will gzip-compress values larger than compression_min_size. Default is true.
+**compress**: Boolean, if true Dalli will gzip-compress values larger than compression_min_size.  Can be overridden on a per-request basis. Default is true.
 
-**compression_min_size**: Minimum value byte size for which to attempt compression. Default is 1K.
+**compression_min_size**: Minimum value byte size for which to attempt compression. Default is 4K.
 
 **compressor**: The compressor to use for objects being stored.
 Default is zlib, implemented under `Dalli::Compressor`.
@@ -101,8 +101,6 @@ If serving compressed data using nginx's HttpMemcachedModule, set `memcached_gzi
 
 **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.
 
-**error_when_over_max_size**: Boolean. If true, Dalli will throw a Dalli::ValueOverMaxSize exception when trying to store data larger than **value_max_bytes**. Defaults to false, meaning only a warning is logged.
-
 **username**: The username to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
 
 **password**: The password to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
@@ -135,7 +133,7 @@ Helping Out
 
 If you have a fix you wish to provide, please fork the code, fix in your local project and then send a pull request on github.  Please ensure that you include a test which verifies your fix and update `History.md` with a one sentence description of your fix so you get credit as a contributor.
 
-We're not accepting new compressors. They are trivial to add in an initializer. See #385 (LZ4), #406 (Snappy)
+We're not accepting new compressors. They are trivial to add in an initializer. See [#385](https://github.com/petergoldstein/dalli/pull/385) (LZ4), [#406](https://github.com/petergoldstein/dalli/pull/406) (Snappy)
 
 Thanks
 ------------

data/lib/dalli/client.rb

@@ -25,7 +25,8 @@ module Dalli
     # - :failover - if a server is down, look for and store values on another server in the ring.  Default: true.
     # - :threadsafe - ensure that only one thread is actively using a socket at a time. Default: true.
     # - :expires_in - default TTL in seconds if you do not pass TTL as a parameter to an individual operation, defaults to 0 or forever
-    # - :compress - defaults to false, if true Dalli will compress values larger than 1024 bytes before sending them to memcached.
+    # - :compress - if true Dalli will compress values larger than compression_min_size bytes before sending them to memcached.  Default: true.
+    # - :compression_min_size - the minimum size (in bytes) for which Dalli will compress values sent to Memcached.  Defaults to 4K.
     # - :serializer - defaults to Marshal
     # - :compressor - defaults to zlib
     # - :cache_nils - defaults to false, if true Dalli will not treat cached nil values as 'not found' for #fetch operations.

data/lib/dalli/protocol/binary.rb

@@ -26,10 +26,6 @@ module Dalli
         socket_failure_delay: 0.1,
         # max size of value in bytes (default is 1 MB, can be overriden with "memcached -I <size>")
         value_max_bytes: 1024 * 1024,
-        compress: true,
-        compressor: Compressor,
-        # min byte size to attempt compression
-        compression_min_size: 4 * 1024,
         serializer: Marshal,
         username: nil,
         password: nil,
@@ -46,6 +42,7 @@ module Dalli
         @down_at = nil
         @last_down_at = nil
         @options = DEFAULTS.merge(options)
+        @value_compressor = ValueCompressor.new(@options)
         @sock = nil
         @msg = nil
         @error = nil
@@ -117,10 +114,6 @@ module Dalli
         @options[:serializer]
       end
 
-      def compressor
-        @options[:compressor]
-      end
-
       # Start reading key/value pairs from this connection. This is usually called
       # after a series of GETKQ commands. A NOOP is sent, and the server begins
       # flushing responses for kv pairs that were found.
@@ -408,11 +401,9 @@ module Dalli
         generic_response(true, !!(options && options.is_a?(Hash) && options[:cache_nils]))
       end
 
-      # http://www.hjp.at/zettel/m/memcached_flags.rxml
+      # https://www.hjp.at/zettel/m/memcached_flags.rxml
       # Looks like most clients use bit 0 to indicate native language serialization
-      # and bit 1 to indicate gzip compression.
       FLAG_SERIALIZED = 0x1
-      FLAG_COMPRESSED = 0x2
 
       def serialize(key, value, options = nil)
         marshalled = false
@@ -432,21 +423,16 @@ module Dalli
             raise exc
           end
         end
-        compressed = false
-        set_compress_option = true if options && options[:compress]
-        if (@options[:compress] || set_compress_option) && value.bytesize >= @options[:compression_min_size]
-          value = compressor.compress(value)
-          compressed = true
-        end
 
-        flags = 0
-        flags |= FLAG_COMPRESSED if compressed
-        flags |= FLAG_SERIALIZED if marshalled
-        [value, flags]
+        bitflags = 0
+        value, bitflags = @value_compressor.store(value, options, bitflags)
+
+        bitflags |= FLAG_SERIALIZED if marshalled
+        [value, bitflags]
       end
 
       def deserialize(value, flags)
-        value = compressor.decompress(value) if (flags & FLAG_COMPRESSED) != 0
+        value = @value_compressor.retrieve(value, flags)
         value = serializer.load(value) if (flags & FLAG_SERIALIZED) != 0
         value
       rescue TypeError
@@ -458,8 +444,6 @@ module Dalli
       rescue NameError
         raise unless /uninitialized constant/.match?($!.message)
         raise UnmarshalError, "Unable to unmarshal value: #{$!.message}"
-      rescue Zlib::Error
-        raise UnmarshalError, "Unable to uncompress value: #{$!.message}"
       end
 
       def data_cas_response

data/lib/dalli/protocol/value_compressor.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'English'
+
+module Dalli
+  module Protocol
+    ##
+    # Dalli::Protocol::ValueCompressor compartmentalizes the logic for managing
+    # compression and decompression of stored values.  It manages interpreting
+    # relevant options from both client and request, determining whether to
+    # compress/decompress on store/retrieve, and processes bitflags as necessary.
+    ##
+    class ValueCompressor
+      DEFAULTS = {
+        compress: true,
+        compressor: ::Dalli::Compressor,
+        # min byte size to attempt compression
+        compression_min_size: 4 * 1024 # 4K
+      }.freeze
+
+      OPTIONS = DEFAULTS.keys.freeze
+
+      # https://www.hjp.at/zettel/m/memcached_flags.rxml
+      # Looks like most clients use bit 1 to indicate gzip compression.
+      FLAG_COMPRESSED = 0x2
+
+      def initialize(client_options)
+        # Support the deprecated compression option, but don't allow it to override
+        # an explicit compress
+        # Remove this with 4.0
+        if client_options.key?(:compression) && !client_options.key?(:compress)
+          Dalli.logger.warn "DEPRECATED: Dalli's :compression option is now just 'compress: true'.  " \
+                            'Please update your configuration.'
+          client_options[:compress] = client_options.delete(:compression)
+        end
+
+        @compression_options =
+          DEFAULTS.merge(client_options.select { |k, _| OPTIONS.include?(k) })
+      end
+
+      def store(value, req_options, bitflags)
+        do_compress = compress_value?(value, req_options)
+        store_value = do_compress ? compressor.compress(value) : value
+        bitflags |= FLAG_COMPRESSED if do_compress
+
+        [store_value, bitflags]
+      end
+
+      def retrieve(value, bitflags)
+        compressed = (bitflags & FLAG_COMPRESSED) != 0
+        compressed ? compressor.decompress(value) : value
+
+      # TODO: We likely want to move this rescue into the Dalli::Compressor / Dalli::GzipCompressor
+      # itself, since not all compressors necessarily use Zlib.  For now keep it here, so the behavior
+      # of custom compressors doesn't change.
+      rescue Zlib::Error
+        raise UnmarshalError, "Unable to uncompress value: #{$ERROR_INFO.message}"
+      end
+
+      def compress_by_default?
+        @compression_options[:compress]
+      end
+
+      def compressor
+        @compression_options[:compressor]
+      end
+
+      def compression_min_size
+        @compression_options[:compression_min_size]
+      end
+
+      # Checks whether we should apply compression when serializing a value
+      # based on the specified options.  Returns false unless the value
+      # is greater than the minimum compression size.  Otherwise returns
+      # based on a method-level option if specified, falling back to the
+      # server default.
+      def compress_value?(value, req_options)
+        return false unless value.bytesize >= compression_min_size
+        return compress_by_default? unless req_options && !req_options[:compress].nil?
+
+        req_options[:compress]
+      end
+    end
+  end
+end

data/lib/dalli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dalli
-  VERSION = "3.0.2"
+  VERSION = "3.0.3"
 end

data/lib/dalli.rb

@@ -5,6 +5,7 @@ require "dalli/client"
 require "dalli/ring"
 require "dalli/protocol"
 require "dalli/protocol/binary"
+require 'dalli/protocol/value_compressor'
 require "dalli/socket"
 require "dalli/version"
 require "dalli/options"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dalli
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Peter M. Goldstein
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -39,20 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: openssl-extensions
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: High performance memcached client for Ruby
 email:
 - peter.m.goldstein@gmail.com
@@ -72,6 +58,7 @@ files:
 - lib/dalli/options.rb
 - lib/dalli/protocol.rb
 - lib/dalli/protocol/binary.rb
+- lib/dalli/protocol/value_compressor.rb
 - lib/dalli/ring.rb
 - lib/dalli/server.rb
 - lib/dalli/socket.rb