memcached_store 0.12.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e458052cfc2aac92c629b37e02fc7ae66077dcd
-  data.tar.gz: af048ce101065d5bc3463a9e118b6c3fb45c7763
+  metadata.gz: 0915f7c2305d9b4962115d99c52997673e711a58
+  data.tar.gz: 0cc5bbca84c1aee1bcf70f782735d90cd562252d
 SHA512:
-  metadata.gz: 376570dd86abe4ca47cff7cb74aa934c7b26dac30ad24eeab5ee02b8310a24d9866d8c92ba2c85364c9c7bec426fe842e282b65d84742f2ba371db2cef478254
-  data.tar.gz: 8d958e238be593341eb041916ee4b47648a841ef3c87f45a3ebeeb1a2bca09808c43b1cf16aaf0ae5dba0b842ce49300ea9a3d600621e7f26d3deaeaa223b761
+  metadata.gz: b8a0873627bf43775afd6ef3a7aeb9788a3b5d96d82eaac63f3a49879942e43daf9ace73d8c90c697fc0ca4a4f8a6ee777b3314339634c18734953c84e065d94
+  data.tar.gz: 5326f2375fa65be54b8c0f5a9c163e0a606c8f6a474ee21f7476c8175fa39252813392e206ad599494b3b72251b6054ad8c824024e963dd9addc3ea16316513c

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Camilo Lopez
+Copyright (c) 2013-2016 Shopify Inc.
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -8,7 +8,7 @@ ActiveSupport memcached store. This wraps the memcached gem into a ActiveSupport
 
 ### MemcachedSnappyStore
 
-ActiveSupport cache store that adds snappy compression at the cost of making the ```incr, decr``` operations unavailable.
+ActiveSupport cache store that adds snappy compression at the cost of making the `incr, decr` operations unavailable.
 
 ## Installation
 
@@ -40,9 +40,13 @@ config.cache_store = :memcached_store,
 
 # for snappy store
 config.cache_store = :memcached_snappy_store,
-  Memcached::Rails.new(:servers => ['memcached1.foo.com', 'memcached2.foo.com'])
+  Memcached::Rails.new(servers: ['memcached1.foo.com', 'memcached2.foo.com'])
 ```
 
+## Benchmarks
+
+For benchmarks please refer to https://github.com/basecamp/memcached_bench.
+
 ## Code status
 
 [![Build Status](https://travis-ci.org/Shopify/memcached_store.svg?branch=master)](https://travis-ci.org/Shopify/memcached_store)

data/lib/active_support/cache/memcached_snappy_store.rb

@@ -12,12 +12,12 @@ module ActiveSupport
     class MemcachedSnappyStore < MemcachedStore
       class UnsupportedOperation < StandardError; end
 
-      def increment(*args)
-        raise UnsupportedOperation.new("increment is not supported by: #{self.class.name}")
+      def increment(*)
+        raise UnsupportedOperation, "increment is not supported by: #{self.class.name}"
       end
 
-      def decrement(*args)
-        raise UnsupportedOperation.new("decrement is not supported by: #{self.class.name}")
+      def decrement(*)
+        raise UnsupportedOperation, "decrement is not supported by: #{self.class.name}"
       end
 
       # IdentityCache has its own handling for read only.
@@ -26,6 +26,7 @@ module ActiveSupport
       end
 
       private
+
       def serialize_entry(entry, options)
         value = options[:raw] ? entry.value.to_s : Marshal.dump(entry)
         [Snappy.deflate(value), true]
@@ -34,12 +35,10 @@ module ActiveSupport
       def deserialize_entry(compressed_value)
         if compressed_value
           super(Snappy.inflate(compressed_value))
-        else
-          nil
         end
       end
 
-      def cas_raw?(options)
+      def cas_raw?(_options)
         true
       end
     end

data/lib/active_support/cache/memcached_store.rb

@@ -11,21 +11,20 @@ module ActiveSupport
     # MemcachedStore implements the Strategy::LocalCache strategy which implements
     # an in-memory cache inside of a block.
     class MemcachedStore < Store
-      FATAL_EXCEPTIONS = [ Memcached::ABadKeyWasProvidedOrCharactersOutOfRange,
-        Memcached::AKeyLengthOfZeroWasProvided,
-        Memcached::ConnectionBindFailure,
-        Memcached::ConnectionDataDoesNotExist,
-        Memcached::ConnectionFailure,
-        Memcached::ConnectionSocketCreateFailure,
-        Memcached::CouldNotOpenUnixSocket,
-        Memcached::NoServersDefined,
-        Memcached::TheHostTransportProtocolDoesNotMatchThatOfTheClient
-      ]
-
-      if defined?(::Rails) && ::Rails.env.test?
-        NONFATAL_EXCEPTIONS = []
+      FATAL_EXCEPTIONS = [Memcached::ABadKeyWasProvidedOrCharactersOutOfRange,
+                          Memcached::AKeyLengthOfZeroWasProvided,
+                          Memcached::ConnectionBindFailure,
+                          Memcached::ConnectionDataDoesNotExist,
+                          Memcached::ConnectionFailure,
+                          Memcached::ConnectionSocketCreateFailure,
+                          Memcached::CouldNotOpenUnixSocket,
+                          Memcached::NoServersDefined,
+                          Memcached::TheHostTransportProtocolDoesNotMatchThatOfTheClient]
+
+      NONFATAL_EXCEPTIONS = if defined?(::Rails) && ::Rails.env.test?
+        []
       else
-        NONFATAL_EXCEPTIONS = Memcached::EXCEPTIONS - FATAL_EXCEPTIONS
+        Memcached::EXCEPTIONS - FATAL_EXCEPTIONS
       end
 
       ESCAPE_KEY_CHARS = /[\x00-\x20%\x7F-\xFF]/n
@@ -41,7 +40,7 @@ module ActiveSupport
           @data = addresses.first
         else
           mem_cache_options = options.dup
-          UNIVERSAL_OPTIONS.each{|name| mem_cache_options.delete(name)}
+          UNIVERSAL_OPTIONS.each { |name| mem_cache_options.delete(name) }
           @data = Memcached::Rails.new(*(addresses + [mem_cache_options]))
         end
 
@@ -53,24 +52,24 @@ module ActiveSupport
         @logger = ::Rails.logger if defined?(::Rails)
       end
 
-      def write(*args)
+      def write(*)
         return true if read_only
-        super(*args)
+        super
       end
 
-      def delete(*args)
+      def delete(*)
         return true if read_only
-        super(*args)
+        super
       end
 
       def read_multi(*names)
         options = names.extract_options!
         options = merged_options(options)
-        keys_to_names = Hash[names.map{|name| [escape_key(namespaced_key(name, options)), name]}]
+        keys_to_names = Hash[names.map { |name| [normalize_key(name, options), name] }]
         values = {}
 
         instrument(:read_multi, names, options) do
-          if raw_values = @data.get_multi(keys_to_names.keys, :raw => true)
+          if raw_values = @data.get_multi(keys_to_names.keys, raw: true)
             raw_values.each do |key, value|
               entry = deserialize_entry(value)
               values[keys_to_names[key]] = entry.value unless entry.expired?
@@ -85,7 +84,7 @@ module ActiveSupport
 
       def cas(name, options = nil)
         options = merged_options(options)
-        key = namespaced_key(name, options)
+        key = normalize_key(name, options)
 
         instrument(:cas, name, options) do
           @data.cas(key, expiration(options), cas_raw?(options)) do |raw_value|
@@ -101,21 +100,30 @@ module ActiveSupport
       end
 
       def cas_multi(*names)
-
         options = names.extract_options!
+        return if names.empty?
+
         options = merged_options(options)
-        keys_to_names = Hash[names.map{|name| [escape_key(namespaced_key(name, options)), name]}]
+        keys_to_names = Hash[names.map { |name| [normalize_key(name, options), name] }]
 
         instrument(:cas_multi, names, options) do
           @data.cas(keys_to_names.keys, expiration(options), cas_raw?(options)) do |raw_values|
             values = {}
+
             raw_values.each do |key, raw_value|
               entry = deserialize_entry(raw_value)
               values[keys_to_names[key]] = entry.value unless entry.expired?
             end
+
             values = yield values
+
             break true if read_only
-            Hash[values.map{|name, value| [escape_key(namespaced_key(name, options)), serialize_entry(Entry.new(value, options), options).first]}]
+
+            serialized_values = values.map do |name, value|
+              [normalize_key(name, options), serialize_entry(Entry.new(value, options), options).first]
+            end
+
+            Hash[serialized_values]
           end
         end
       rescue *NONFATAL_EXCEPTIONS => e
@@ -125,8 +133,8 @@ module ActiveSupport
 
       def increment(name, amount = 1, options = nil) # :nodoc:
         options = merged_options(options)
-        instrument(:increment, name, :amount => amount) do
-          @data.incr(escape_key(namespaced_key(name, options)), amount)
+        instrument(:increment, name, amount: amount) do
+          @data.incr(normalize_key(name, options), amount)
         end
       rescue *NONFATAL_EXCEPTIONS => e
         @data.log_exception(e)
@@ -135,8 +143,8 @@ module ActiveSupport
 
       def decrement(name, amount = 1, options = nil) # :nodoc:
         options = merged_options(options)
-        instrument(:decrement, name, :amount => amount) do
-          @data.decr(escape_key(namespaced_key(name, options)), amount)
+        instrument(:decrement, name, amount: amount) do
+          @data.decr(normalize_key(name, options), amount)
         end
       rescue *NONFATAL_EXCEPTIONS => e
         @data.log_exception(e)
@@ -144,14 +152,18 @@ module ActiveSupport
       end
 
       def clear(options = nil)
-        instrument(:clear, options) { @data.flush_all }
+        ActiveSupport::Notifications.instrument("cache_clear.active_support", options || {}) do
+          @data.flush_all
+        end
       end
 
       def stats
-        instrument(:stats) { @data.stats }
+        ActiveSupport::Notifications.instrument("cache_stats.active_support") do
+          @data.stats
+        end
       end
 
-      def exist?(*args)
+      def exist?(*)
         !!super
       end
 
@@ -163,70 +175,90 @@ module ActiveSupport
       end
 
       protected
-        def read_entry(key, options) # :nodoc:
-          deserialize_entry(@data.get(escape_key(key), true))
-        rescue *NONFATAL_EXCEPTIONS => e
-          @data.log_exception(e)
-          nil
-        end
 
-        def write_entry(key, entry, options) # :nodoc:
-          return true if read_only
-          method = options && options[:unless_exist] ? :add : :set
-          expires_in = expiration(options)
-          value, raw = serialize_entry(entry, options)
-          @data.send(method, escape_key(key), value, expires_in, raw)
-        rescue *NONFATAL_EXCEPTIONS => e
-          @data.log_exception(e)
-          false
-        end
+      def read_entry(key, _options) # :nodoc:
+        deserialize_entry(@data.get(escape_key(key), true))
+      rescue *NONFATAL_EXCEPTIONS => e
+        @data.log_exception(e)
+        nil
+      end
 
-        def delete_entry(key, options) # :nodoc:
-          return true if read_only
-          @data.delete(escape_key(key))
-          true
-        rescue *NONFATAL_EXCEPTIONS => e
-          @data.log_exception(e)
-          false
-        end
+      def write_entry(key, entry, options) # :nodoc:
+        return true if read_only
+        method = options && options[:unless_exist] ? :add : :set
+        expires_in = expiration(options)
+        value, raw = serialize_entry(entry, options)
+        @data.send(method, escape_key(key), value, expires_in, raw)
+      rescue *NONFATAL_EXCEPTIONS => e
+        @data.log_exception(e)
+        false
+      end
+
+      def delete_entry(key, _options) # :nodoc:
+        return true if read_only
+        @data.delete(escape_key(key))
+        true
+      rescue *NONFATAL_EXCEPTIONS => e
+        @data.log_exception(e)
+        false
+      end
 
       private
 
+      if ActiveSupport::VERSION::MAJOR < 5
+        def normalize_key(key, options)
+          escape_key(namespaced_key(key, options))
+        end
+
         def escape_key(key)
           key = key.to_s.dup
           key = key.force_encoding(Encoding::ASCII_8BIT)
-          key = key.gsub(ESCAPE_KEY_CHARS){ |match| "%#{match.getbyte(0).to_s(16).upcase}" }
+          key = key.gsub(ESCAPE_KEY_CHARS) { |match| "%#{match.getbyte(0).to_s(16).upcase}" }
           key = "#{key[0, 213]}:md5:#{Digest::MD5.hexdigest(key)}" if key.size > 250
           key
         end
-
-        def deserialize_entry(raw_value)
-          if raw_value
-            entry = Marshal.load(raw_value) rescue raw_value
-            entry.is_a?(Entry) ? entry : Entry.new(entry)
-          else
-            nil
-          end
+      else
+        def normalize_key(key, options)
+          key = super.dup
+          key = key.force_encoding(Encoding::ASCII_8BIT)
+          key = key.gsub(ESCAPE_KEY_CHARS) { |match| "%#{match.getbyte(0).to_s(16).upcase}" }
+          key = "#{key[0, 213]}:md5:#{Digest::MD5.hexdigest(key)}" if key.size > 250
+          key
         end
 
-        def serialize_entry(entry, options)
-          entry = entry.value.to_s if options[:raw]
-          [entry, options[:raw]]
+        def escape_key(key)
+          key
         end
+      end
 
-        def cas_raw?(options)
-          options[:raw]
+      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)
         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
-          end
-          expires_in
-        end
+      def serialize_entry(entry, options)
+        entry = entry.value.to_s if options[:raw]
+        [entry, options[:raw]]
+      end
+
+      def cas_raw?(options)
+        options[:raw]
+      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
+        end
+        expires_in
+      end
     end
   end
 end

data/lib/memcached_store.rb

@@ -1,3 +1,3 @@
 require "memcached"
+require "active_support"
 require "active_support/cache"
-require "memcached_store/memcached_safety"

data/lib/memcached_store/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memcached_store
 version: !ruby/object:Gem::Version
-  version: 0.12.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Camilo Lopez
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: memcached
   requirement: !ruby/object:Gem::Requirement
@@ -65,25 +65,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/active_support/cache/memcached_snappy_store.rb
 - lib/active_support/cache/memcached_store.rb
 - lib/memcached_store.rb
-- lib/memcached_store/memcached_safety.rb
 - lib/memcached_store/version.rb
-- memcached_store.gemspec
-- shipit.rubygems.yml
-- test/test_helper.rb
-- test/test_memcached_safety.rb
-- test/test_memcached_snappy_store.rb
-- test/test_memcached_store.rb
 homepage: https://github.com/Shopify/memcached_store/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -93,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -105,8 +95,4 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Plugin-able Memcached adapters to add features (compression, safety)
-test_files:
-- test/test_helper.rb
-- test/test_memcached_safety.rb
-- test/test_memcached_snappy_store.rb
-- test/test_memcached_store.rb
+test_files: []