memcached_store 2.0.1 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa72b41fd6b6cb58a042294012e8f736c3b5ef62
-  data.tar.gz: e053cc731f76cb2bc909e36f7f004002b2fd7e38
+SHA256:
+  metadata.gz: 4635e49b33c70f622363339dda844ed847785724779b9fa7820d4a34dbf372f8
+  data.tar.gz: 2371f00c595f4b9fb5f4fd37621a591e8ac11125b53467dbbd990febfa9296d9
 SHA512:
-  metadata.gz: 2045826e00f5d2c2d988eed051036713348bafcd7867bf06b1f6760decea9719e62a0cfc332ee82f3e3ef84f2eecb65ab7eba373f1e969f5592cfa53eb12a034
-  data.tar.gz: c36fde971c9abc498626b8662cb87977369e85c3818efbbb5bf23bf0ec0bf51e9a17e338dce98661c41b7fdb2abbf7fc6a1a271bea0cb0a8fd177e8f9e5dccf7
+  metadata.gz: 18831e059e7db2fae9d3733baa244f2ba69050bfc1d72ecd72dd80332a0e525b50a409f98cb76d224450fce01919e29695ba3c5585cadc42bfaef1b66474ac72
+  data.tar.gz: cc44c59b08101ac3934ce59b90c89179d0b88c64dd519d265b81e76adbb09c8d3e2f5b4445e7de6e8c73973df615c46a613a29dd5f9c0db8acfa6d2c788d4445

data/lib/active_support/cache/memcached_snappy_store.rb

@@ -12,6 +12,16 @@ module ActiveSupport
     class MemcachedSnappyStore < MemcachedStore
       class UnsupportedOperation < StandardError; end
 
+      module SnappyCompressor
+        def self.compress(source)
+          Snappy.deflate(source)
+        end
+
+        def self.decompress(source)
+          Snappy.inflate(source)
+        end
+      end
+
       def increment(*)
         raise UnsupportedOperation, "increment is not supported by: #{self.class.name}"
       end
@@ -25,21 +35,10 @@ module ActiveSupport
         false
       end
 
-      private
-
-      def serialize_entry(entry, options)
-        value = options[:raw] ? entry.value.to_s : Marshal.dump(entry)
-        [Snappy.deflate(value), true]
-      end
-
-      def deserialize_entry(compressed_value)
-        if compressed_value
-          super(Snappy.inflate(compressed_value))
-        end
-      end
-
-      def cas_raw?(_options)
-        true
+      def initialize(*addresses, **options)
+        options[:codec] ||= ActiveSupport::Cache::MemcachedStore::Codec.new(compressor: SnappyCompressor)
+        options[:compress] = false
+        super(*addresses, **options)
       end
     end
   end

data/lib/active_support/cache/memcached_store.rb

@@ -13,30 +13,86 @@ module ActiveSupport
     class MemcachedStore < Store
       ESCAPE_KEY_CHARS = /[\x00-\x20%\x7F-\xFF]/n
 
+      class Codec
+        # use dalli compatible flags
+        SERIALIZED_FLAG = 0x1
+        COMPRESSED_FLAG = 0x2
+
+        # Older versions of this gem would use 0 for the flags whether or not
+        # the value was marshal dumped. By setting this flag, we can tell if
+        # it were set with an older version for backwards compatible decoding.
+        RAW_FLAG = 0x10
+
+        def initialize(serializer: Marshal, compressor: nil)
+          @serializer = serializer
+          @compressor = compressor
+        end
+
+        def encode(_key, value, flags)
+          unless value.is_a?(String)
+            flags |= SERIALIZED_FLAG
+            value = @serializer.dump(value)
+          end
+          if @compressor
+            flags |= COMPRESSED_FLAG
+            value = @compressor.compress(value)
+          end
+          flags |= RAW_FLAG if flags == 0
+          [value, flags]
+        end
+
+        def decode(_key, value, flags)
+          if (flags & COMPRESSED_FLAG) != 0
+            value = @compressor.decompress(value)
+          end
+
+          if (flags & SERIALIZED_FLAG) != 0
+            @serializer.load(value)
+          elsif flags == 0 # legacy cache value
+            @serializer.load(value) rescue value
+          else
+            value
+          end
+        end
+      end
+
       attr_accessor :read_only, :swallow_exceptions
 
-      def initialize(*addresses)
+      def initialize(*addresses, **options)
         addresses = addresses.flatten
-        options = addresses.extract_options!
+        options[:codec] ||= Codec.new
         @swallow_exceptions = true
         @swallow_exceptions = options.delete(:swallow_exceptions) if options.key?(:swallow_exceptions)
 
         super(options)
 
         if addresses.first.is_a?(Memcached)
-          @data = addresses.first
+          @connection = addresses.first
           raise "Memcached::Rails is no longer supported, "\
-                "use a Memcached instance instead" if @data.is_a?(Memcached::Rails)
+                "use a Memcached instance instead" if @connection.is_a?(Memcached::Rails)
         else
           mem_cache_options = options.dup
           servers = mem_cache_options.delete(:servers)
           UNIVERSAL_OPTIONS.each { |name| mem_cache_options.delete(name) }
-          @data = Memcached.new([*addresses, *servers], mem_cache_options)
+          @connection = Memcached.new([*addresses, *servers], mem_cache_options)
         end
 
         extend Strategy::LocalCache
       end
 
+      def append(name, value, options = nil)
+        return true if read_only
+        options = merged_options(options)
+        normalized_key = normalize_key(name, options)
+
+        handle_exceptions(return_value_on_error: nil, on_miss: false, miss_exceptions: [Memcached::NotStored]) do
+          instrument(:append, name) do
+            @connection.append(normalized_key, value)
+          end
+          true
+        end
+      end
+
       def write(*)
         return true if read_only
         super
@@ -57,7 +113,7 @@ module ActiveSupport
 
         handle_exceptions(return_value_on_error: {}) do
           instrument(:read_multi, names, options) do
-            if raw_values = @data.get(keys_to_names.keys, false)
+            if raw_values = @connection.get(keys_to_names.keys)
               raw_values.each do |key, value|
                 entry = deserialize_entry(value)
                 values[keys_to_names[key]] = entry.value unless entry.expired?
@@ -74,19 +130,18 @@ module ActiveSupport
 
         handle_exceptions(return_value_on_error: false) do
           instrument(:cas, name, options) do
-            @data.cas(key, expiration(options), !cas_raw?(options)) do |raw_value|
+            @connection.cas(key, expiration(options)) do |raw_value|
               entry = deserialize_entry(raw_value)
               value = yield entry.value
               break true if read_only
-              serialize_entry(Entry.new(value, options), options).first
+              serialize_entry(Entry.new(value, **options), options)
             end
           end
           true
         end
       end
 
-      def cas_multi(*names)
-        options = names.extract_options!
+      def cas_multi(*names, **options)
         return if names.empty?
 
         options = merged_options(options)
@@ -94,7 +149,7 @@ module ActiveSupport
 
         handle_exceptions(return_value_on_error: false) do
           instrument(:cas_multi, names, options) do
-            @data.cas(keys_to_names.keys, expiration(options), !cas_raw?(options)) do |raw_values|
+            @connection.cas(keys_to_names.keys, expiration(options)) do |raw_values|
               values = {}
 
               raw_values.each do |key, raw_value|
@@ -107,7 +162,7 @@ module ActiveSupport
               break true if read_only
 
               serialized_values = values.map do |name, value|
-                [normalize_key(name, options), serialize_entry(Entry.new(value, options), options).first]
+                [normalize_key(name, options), serialize_entry(Entry.new(value, **options), options)]
               end
 
               Hash[serialized_values]
@@ -121,7 +176,7 @@ module ActiveSupport
         options = merged_options(options)
         handle_exceptions(return_value_on_error: nil) do
           instrument(:increment, name, amount: amount) do
-            @data.incr(normalize_key(name, options), amount)
+            @connection.incr(normalize_key(name, options), amount)
           end
         end
       end
@@ -130,20 +185,20 @@ module ActiveSupport
         options = merged_options(options)
         handle_exceptions(return_value_on_error: nil) do
           instrument(:decrement, name, amount: amount) do
-            @data.decr(normalize_key(name, options), amount)
+            @connection.decr(normalize_key(name, options), amount)
           end
         end
       end
 
       def clear(options = nil)
         ActiveSupport::Notifications.instrument("cache_clear.active_support", options || {}) do
-          @data.flush
+          @connection.flush
         end
       end
 
       def stats
         ActiveSupport::Notifications.instrument("cache_stats.active_support") do
-          @data.stats
+          @connection.stats
         end
       end
 
@@ -153,7 +208,7 @@ module ActiveSupport
 
       def reset #:nodoc:
         handle_exceptions(return_value_on_error: false) do
-          @data.reset
+          @connection.reset
         end
       end
 
@@ -161,7 +216,7 @@ module ActiveSupport
 
       def read_entry(key, _options) # :nodoc:
         handle_exceptions(return_value_on_error: nil) do
-          deserialize_entry(@data.get(escape_key(key), false))
+          deserialize_entry(@connection.get(escape_key(key)))
         end
       end
 
@@ -169,9 +224,9 @@ module ActiveSupport
         return true if read_only
         method = options && options[:unless_exist] ? :add : :set
         expires_in = expiration(options)
-        value, raw = serialize_entry(entry, options)
+        value = serialize_entry(entry, options)
         handle_exceptions(return_value_on_error: false) do
-          @data.send(method, escape_key(key), value, expires_in, !raw)
+          @connection.send(method, escape_key(key), value, expires_in)
           true
         end
       end
@@ -179,7 +234,7 @@ module ActiveSupport
       def delete_entry(key, _options) # :nodoc:
         return true if read_only
         handle_exceptions(return_value_on_error: false, on_miss: true) do
-          @data.delete(escape_key(key))
+          @connection.delete(escape_key(key))
           true
         end
       end
@@ -213,38 +268,31 @@ module ActiveSupport
         end
       end
 
-      def deserialize_entry(raw_value)
-        if raw_value
-          entry = begin
-                      Marshal.load(raw_value)
-                    rescue
-                      raw_value
-                    end
-          entry.is_a?(Entry) ? entry : Entry.new(entry)
+      def deserialize_entry(value)
+        if value
+          value.is_a?(Entry) ? value : Entry.new(value, compress: false)
         end
       end
 
       def serialize_entry(entry, options)
-        entry = entry.value.to_s if options[:raw]
-        [entry, options[:raw]]
-      end
-
-      def cas_raw?(options)
-        options[:raw]
+        if options[:raw]
+          entry.value.to_s
+        else
+          entry
+        end
       end
 
       def expiration(options)
         expires_in = options[:expires_in].to_i
-        if expires_in > 0 && !options[:raw]
-          # Set the memcache expire a few minutes in the future to support race condition ttls on read
-          expires_in += 5.minutes.to_i
+        if expires_in > 0 && options[:race_condition_ttl] && !options[:raw]
+          expires_in += options[:race_condition_ttl].to_i
         end
         expires_in
       end
 
-      def handle_exceptions(return_value_on_error:, on_miss: return_value_on_error)
+      def handle_exceptions(return_value_on_error:, on_miss: return_value_on_error, miss_exceptions: [])
         yield
-      rescue Memcached::NotFound, Memcached::ConnectionDataExists
+      rescue Memcached::NotFound, Memcached::ConnectionDataExists, *miss_exceptions
         on_miss
       rescue Memcached::Error => e
         log_warning(e)

data/lib/memcached_store/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module MemcachedStore
-  VERSION = "2.0.1"
+  VERSION = "2.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memcached_store
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.5
 platform: ruby
 authors:
 - Camilo Lopez
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,7 +75,8 @@ files:
 homepage: https://github.com/Shopify/memcached_store/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -91,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Plugin-able Memcached adapters to add features (compression, safety)