memcached_store 0.12.7 → 0.12.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 705667e198b18bcd4d65f50390e5b739e12065b2
-  data.tar.gz: 238f5c0a7cbcbdec4000fe7d753eb439e2868765
+  metadata.gz: 3e458052cfc2aac92c629b37e02fc7ae66077dcd
+  data.tar.gz: af048ce101065d5bc3463a9e118b6c3fb45c7763
 SHA512:
-  metadata.gz: a50651983aa2380199e6ccb94b912e0d24f99791977cea55951fbd286adbb305f7e230308e6efcd27a7393775ede1e4dc4a78cb4cbf8eef974269e445f042d3a
-  data.tar.gz: bf9f4f47644e8e73d5d0a4bf3b0f7679902b457ada045f0f0c5c4a8b6736a3f2958b3f60eb0f90b9b77d94fe735327ce86cf0345fec87a011035e0562d7bb34a
+  metadata.gz: 376570dd86abe4ca47cff7cb74aa934c7b26dac30ad24eeab5ee02b8310a24d9866d8c92ba2c85364c9c7bec426fe842e282b65d84742f2ba371db2cef478254
+  data.tar.gz: 8d958e238be593341eb041916ee4b47648a841ef3c87f45a3ebeeb1a2bca09808c43b1cf16aaf0ae5dba0b842ce49300ea9a3d600621e7f26d3deaeaa223b761

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 services: memcache
+before_install:
+  - gem update bundler
 rvm:
   - 1.9.3
   - 2.0.0

data/Gemfile

@@ -11,5 +11,11 @@ else
   "~> #{version}"
 end
 
-gem 'minitest', '~> 4.0' if version == "3.2.18"
 gem "activesupport", as_version
+
+group :test do
+  gem "minitest", '~> 4.0' if version == "3.2.18"
+  gem "mocha"
+  gem "timecop"
+  gem "snappy"
+end

data/lib/active_support/cache/memcached_snappy_store.rb

@@ -20,6 +20,11 @@ module ActiveSupport
         raise UnsupportedOperation.new("decrement is not supported by: #{self.class.name}")
       end
 
+      # IdentityCache has its own handling for read only.
+      def read_only
+        false
+      end
+
       private
       def serialize_entry(entry, options)
         value = options[:raw] ? entry.value.to_s : Marshal.dump(entry)

data/lib/active_support/cache/memcached_store.rb

@@ -30,6 +30,8 @@ module ActiveSupport
 
       ESCAPE_KEY_CHARS = /[\x00-\x20%\x7F-\xFF]/n
 
+      attr_accessor :read_only
+
       def initialize(*addresses)
         addresses = addresses.flatten
         options = addresses.extract_options!
@@ -46,6 +48,21 @@ module ActiveSupport
         extend Strategy::LocalCache
       end
 
+      def logger
+        return @logger if defined?(@logger)
+        @logger = ::Rails.logger if defined?(::Rails)
+      end
+
+      def write(*args)
+        return true if read_only
+        super(*args)
+      end
+
+      def delete(*args)
+        return true if read_only
+        super(*args)
+      end
+
       def read_multi(*names)
         options = names.extract_options!
         options = merged_options(options)
@@ -74,6 +91,7 @@ module ActiveSupport
           @data.cas(key, expiration(options), cas_raw?(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
           end
         end
@@ -83,6 +101,7 @@ module ActiveSupport
       end
 
       def cas_multi(*names)
+
         options = names.extract_options!
         options = merged_options(options)
         keys_to_names = Hash[names.map{|name| [escape_key(namespaced_key(name, options)), name]}]
@@ -95,6 +114,7 @@ module ActiveSupport
               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]}]
           end
         end
@@ -151,6 +171,7 @@ module ActiveSupport
         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)
@@ -161,6 +182,7 @@ module ActiveSupport
         end
 
         def delete_entry(key, options) # :nodoc:
+          return true if read_only
           @data.delete(escape_key(key))
           true
         rescue *NONFATAL_EXCEPTIONS => e

data/lib/memcached_store/memcached_safety.rb

@@ -23,6 +23,7 @@ module MemcachedStore
     def exist_with_rescue?(*args)
       exist_without_rescue?(*args)
     rescue *NONFATAL_EXCEPTIONS
+      report_exception($!)
     end
     alias_method :exist_without_rescue?, :exist?
     alias_method :exist?, :exist_with_rescue?
@@ -30,6 +31,7 @@ module MemcachedStore
     def cas_with_rescue(*args)
       cas_without_rescue(*args)
     rescue *NONFATAL_EXCEPTIONS
+      report_exception($!)
       false
     end
     alias_method_chain :cas, :rescue
@@ -37,6 +39,7 @@ module MemcachedStore
     def get_multi_with_rescue(*args)
       get_multi_without_rescue(*args)
     rescue *NONFATAL_EXCEPTIONS
+      report_exception($!)
       {}
     end
     alias_method_chain :get_multi, :rescue
@@ -44,6 +47,7 @@ module MemcachedStore
     def set_with_rescue(*args)
       set_without_rescue(*args)
     rescue *NONFATAL_EXCEPTIONS
+      report_exception($!)
       false
     end
     alias_method_chain :set, :rescue
@@ -51,6 +55,7 @@ module MemcachedStore
     def add_with_rescue(*args)
       add_without_rescue(*args)
     rescue *NONFATAL_EXCEPTIONS
+      report_exception($!)
       @string_return_types? "NOT STORED\r\n" : true
     end
     alias_method_chain :add, :rescue
@@ -60,9 +65,24 @@ module MemcachedStore
         def #{meth}_with_rescue(*args)
           #{meth}_without_rescue(*args)
         rescue *NONFATAL_EXCEPTIONS
+          report_exception($!)
         end
         alias_method_chain :#{meth}, :rescue
       ENV
     end
+
+    def logger
+      return @logger if @logger
+      @logger = ::Rails.logger if defined?(::Rails)
+    end
+
+    private
+
+    def report_exception(exception)
+      if defined?(::Rails)
+        logger.error "[#{self.class}] exception=#{exception}"
+      end
+      nil # make sure return value is nil
+    end
   end
 end

data/lib/memcached_store/version.rb

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

data/memcached_store.gemspec

@@ -19,8 +19,4 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "memcached", "~> 1.8.0"
 
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "minitest"
-  gem.add_development_dependency "mocha"
-  gem.add_development_dependency "timecop"
-  gem.add_development_dependency "snappy"
 end

data/shipit.rubygems.yml

@@ -1 +1,4 @@
-# use default config
+dependencies:
+  bundler:
+    without:
+      - test

data/test/test_helper.rb

@@ -5,3 +5,17 @@ require 'timecop'
 require 'active_support/test_case'
 
 require 'memcached_store'
+
+class Rails
+  def self.logger
+    @logger ||= Logger.new("/dev/null")
+  end
+
+  def self.env
+    Struct.new("Env") do
+      def self.test?
+        true
+      end
+    end
+  end
+end

data/test/test_memcached_safety.rb

@@ -125,6 +125,11 @@ class TestMemcachedSafety < ActiveSupport::TestCase
       @cache.prepend("a-key", "other")
     end
   end
+
+  test "logger defaults to rails logger" do
+    assert_equal Rails.logger, @cache.logger
+  end
+
   private
 
   def expect_nonfatal(sym)

data/test/test_memcached_store.rb

@@ -1,9 +1,13 @@
 require 'test_helper'
+require 'logger'
 
 class TestMemcachedStore < ActiveSupport::TestCase
   setup do
     @cache = ActiveSupport::Cache.lookup_store(:memcached_store, expires_in: 60, support_cas: true)
     @cache.clear
+
+    # Enable ActiveSupport notifications. Can be disabled in Rails 5.
+    Thread.current[:instrument_cache_store] = true
   end
 
   def test_write_not_found
@@ -153,26 +157,11 @@ class TestMemcachedStore < ActiveSupport::TestCase
     assert_equal({"fu" => "baz"}, @cache.read_multi('foo', 'fu'))
   end
 
-  def test_read_multi
-    @cache.write('foo', 'bar')
-    @cache.write('fu', 'baz')
-    @cache.write('fud', 'biz')
-    assert_equal({"foo" => "bar", "fu" => "baz"}, @cache.read_multi('foo', 'fu'))
-  end
-
   def test_read_multi_not_found
     expect_not_found
     assert_equal({}, @cache.read_multi('foe', 'fue'))
   end
 
-  def test_read_multi_with_expires
-    @cache.write('foo', 'bar', :expires_in => 0.001)
-    @cache.write('fu', 'baz')
-    @cache.write('fud', 'biz')
-    sleep(0.002)
-    assert_equal({"fu" => "baz"}, @cache.read_multi('foo', 'fu'))
-  end
-
   def test_read_and_write_compressed_small_data
     @cache.write('foo', 'bar', :compress => true)
     assert_equal 'bar', @cache.read('foo')
@@ -388,15 +377,224 @@ class TestMemcachedStore < ActiveSupport::TestCase
     assert_equal "", client.prefix_key, "should not send the namespace to the client"
     assert_equal "foo::key", cache.send(:namespaced_key, "key", cache.options)
   end
-  
+
   def test_reset
     client = @cache.instance_variable_get(:@data)
     client.expects(:reset).once
     @cache.reset
   end
 
+  def test_write_to_read_only_memcached_store_should_not_write
+    with_read_only(@cache) do
+      assert @cache.write("walrus", "awesome"), "Writing to a disabled memcached
+      store should return truthy to make clients not care"
+
+      assert_nil @cache.read("walrus"), "Key should have nil value in disabled cache"
+    end
+  end
+
+  def test_delete_with_read_only_memcached_store_should_not_delete
+    assert @cache.write("walrus", "big")
+
+    with_read_only(@cache) do
+      assert @cache.delete("walrus"), "Should return truthy when deleted to not raise in client"
+    end
+
+    assert_equal "big", @cache.read("walrus"), "Cache entry should not have been deleted from read only client"
+  end
+
+  def test_cas_with_read_only_memcached_store_should_not_s
+    called_block = false
+    @cache.write('walrus', 'slimy')
+
+    with_read_only(@cache) do
+      assert(@cache.cas('walrus') { |value|
+        assert_equal 'slimy', value
+        called_block = true
+        'full'
+      })
+    end
+
+    assert_equal 'slimy', @cache.read('walrus')
+    assert called_block, "CAS with read only should have called the inner block with an assertion"
+  end
+
+  def test_cas_multi_with_read_only_memcached_store_should_not_s
+    called_block = false
+
+    @cache.write('walrus', 'cool')
+    @cache.write('narwhal', 'horn')
+
+    with_read_only(@cache) do
+      assert(@cache.cas_multi('walrus', 'narwhal') {
+        called_block = true
+        { "walrus" => "not cool", "narwhal" => "not with horns" }
+      })
+    end
+
+    assert_equal 'cool', @cache.read('walrus')
+    assert_equal 'horn', @cache.read('narwhal')
+    assert called_block, "CAS with read only should have called the inner block with an assertion"
+  end
+
+  def test_write_with_read_only_should_not_send_activesupport_notification
+    assert_notifications(/cache/, 0) do
+      with_read_only(@cache) do
+        assert @cache.write("walrus", "bestest")
+      end
+    end
+  end
+
+  def test_delete_with_read_only_should_not_send_activesupport_notification
+    assert_notifications(/cache/, 0) do
+      with_read_only(@cache) do
+        assert @cache.delete("walrus")
+      end
+    end
+  end
+
+  def test_fetch_with_expires_in_with_read_only_should_not_send_activesupport_notification
+    expires_in = 10
+    @cache.fetch("walrus", expires_in: expires_in) { "yo" }
+
+    Timecop.travel(Time.now + expires_in + 1) do
+      assert_notifications(/cache_write/, 0) do
+        with_read_only(@cache) do
+          @cache.fetch("walrus") { "no" }
+        end
+      end
+    end
+  end
+
+  def test_fetch_with_expired_entry_with_read_only_should_return_nil_and_not_delete_from_cache
+    expires_in = 10
+    @cache.fetch("walrus", expires_in: expires_in) { "yo" }
+
+    Timecop.travel(Time.now + expires_in + 1) do
+      with_read_only(@cache) do
+        value = @cache.fetch("walrus", expires_in: expires_in) { "no" }
+
+        assert_equal "no", value
+        refute @cache.fetch("walrus"), "Client should return nil for expired key"
+        assert_equal "yo", @cache.instance_variable_get(:@data).get("walrus").value
+      end
+    end
+  end
+
+  def test_fetch_with_expired_entry_and_race_condition_ttl_with_read_only_should_return_nil_and_not_delete_from_cache
+    expires_in = 10
+    race_condition_ttl = 10
+    @cache.fetch("walrus", expires_in: expires_in) { "yo" }
+
+    Timecop.travel(Time.now + expires_in + 1) do
+      with_read_only(@cache) do
+        value = @cache.fetch("walrus", expires_in: expires_in, race_condition_ttl: race_condition_ttl) { "no" }
+
+        assert_equal "no", value
+        assert_equal "no", @cache.fetch("walrus") { "no" }
+        refute @cache.fetch("walrus")
+
+        assert_equal "yo", @cache.instance_variable_get(:@data).get("walrus").value
+      end
+    end
+  end
+
+  def test_read_with_expired_with_read_only_entry_should_return_nil_and_not_delete_from_cache
+    expires_in = 10
+    @cache.fetch("walrus", expires_in: expires_in) { "yo" }
+
+    Timecop.travel(Time.now + expires_in + 1) do
+      with_read_only(@cache) do
+        refute @cache.read("walrus")
+
+        assert_equal "yo", @cache.instance_variable_get(:@data).get("walrus").value
+      end
+    end
+  end
+
+  def test_read_multi_with_expired_entry_should_return_nil_and_not_delete_from_cache
+    expires_in = 10
+    @cache.fetch("walrus", expires_in: expires_in) { "yo" }
+    @cache.fetch("narwhal", expires_in: expires_in) { "yiir" }
+
+    Timecop.travel(Time.now + expires_in + 1) do
+      with_read_only(@cache) do
+        assert_predicate @cache.read_multi("walrus", "narwhal"), :empty?
+
+        assert_equal "yo", @cache.instance_variable_get(:@data).get("walrus").value
+        assert_equal "yiir", @cache.instance_variable_get(:@data).get("narwhal").value
+      end
+    end
+  end
+
+  def test_fetch_with_race_condition_ttl_with_read_only_should_not_send_activesupport_notification
+    expires_in = 10
+    race_condition_ttl = 10
+    @cache.fetch("walrus", expires_in: expires_in) { "yo" }
+
+    Timecop.travel(Time.now + expires_in + 1) do
+      assert_notifications(/cache_write/, 0) do
+        with_read_only(@cache) do
+          @cache.fetch("walrus", expires_in: expires_in, race_condition_ttl: race_condition_ttl) { "no" }
+        end
+      end
+    end
+  end
+
+  def test_cas_with_read_only_should_send_activesupport_notification
+    @cache.write("walrus", "yes")
+
+    with_read_only(@cache) do
+      assert_notifications(/cache_cas/, 1) do
+        assert(@cache.cas("walrus") { |value| "no" })
+      end
+    end
+
+    assert_equal "yes", @cache.fetch("walrus")
+  end
+
+  def test_cas_multi_with_read_only_should_send_activesupport_notification
+    @cache.write("walrus", "yes")
+    @cache.write("narwhal", "yes")
+
+    with_read_only(@cache) do
+      assert_notifications(/cache_cas/, 1) do
+        assert(@cache.cas_multi("walrus", "narwhal") { |*values|
+          { "walrus" => "no", "narwhal" => "no" }
+        })
+      end
+    end
+
+    assert_equal "yes", @cache.fetch("walrus")
+    assert_equal "yes", @cache.fetch("narwhal")
+  end
+
+  def test_logger_defaults_to_rails_logger
+    assert_equal Rails.logger, @cache.logger
+  end
+
   private
 
+  def assert_notifications(pattern, num)
+    count = 0
+    subscriber = ActiveSupport::Notifications.subscribe(pattern) do |name, start, finish, id, payload|
+      count += 1
+    end
+
+    yield
+
+    assert_equal num, count, "Expected #{num} notifications for #{pattern}, but got #{count}"
+  ensure
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+  end
+
+  def with_read_only(client)
+    previous, client.read_only = client.read_only, true
+    yield
+  ensure
+    client.read_only = previous
+  end
+
   def expect_not_found
     @cache.instance_variable_get(:@data).expects(:check_return_code).raises(Memcached::NotFound)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memcached_store
 version: !ruby/object:Gem::Version
-  version: 0.12.7
+  version: 0.12.8
 platform: ruby
 authors:
 - Camilo Lopez
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -55,62 +55,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  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'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  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'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  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'
-- !ruby/object:Gem::Dependency
-  name: snappy
-  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: Plugin-able Memcached adapters to add features (compression, safety)
 email:
 - camilo@camilolopez.com
@@ -157,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Plugin-able Memcached adapters to add features (compression, safety)