object-cache 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 487f736bf28cb7076dac918d31e3bea6c1cfb8e9
-  data.tar.gz: d7ba6df09f50de96fe22b27193d3dfad0525751f
+  metadata.gz: 1eca8358ecaf741c5815a28a6647a528b316df8c
+  data.tar.gz: af038164c54204cc910039bc035d501e729ec69a
 SHA512:
-  metadata.gz: c418ab5a7584b586d285565113b788326c69518123cdfa0b7a6cc4f55b4f754fc8be807de2044a94f04275b66940f2178a3e96be4109b83209596f6136c79307
-  data.tar.gz: 61813326dfabf36d852481cae061b9bd9739fdf793619451285bb8aab04cd9b2b749e6cf4f205ec123fd0585a7ebe535e9b64a9e9f1ff324d4e91cdfab181273
+  metadata.gz: 338d80cb2a6fd6c1720003655d23770074cca0a0df1f958805ffcf6987016748aa1cb39e8ad59b0fdca0227a19f9810dd026c3c8786e861c26d6828e8d3502d0
+  data.tar.gz: 88d4a44e5d94dc74bcb46d4ce81056871dd9c9e1a592ff8a929f1dc8347fadefdd1399072eec16e5e876f2f22d2c2ef8d4a90344f0986131c78eac05346b36f5

data/.rubocop.yml

@@ -4,7 +4,17 @@ AllCops:
     - '.wercker/**/*'
 
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
 
 Metrics/LineLength:
   Max: 100
+
+Lint/RescueWithoutErrorClass:
+  Exclude:
+    - 'lib/object/cache.rb'
+    - 'test/cache_test.rb'
+
+Security/MarshalLoad:
+  Exclude:
+    - 'lib/object/cache.rb'
+    - 'test/cache_test.rb'

data/Gemfile

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -157,7 +157,8 @@ Cache.backend.keys # => ["hello_22abcc"]
 This allows you to selectively purge keys from Redis:
 
 ```ruby
-Cache.backend.del('hello_')
+keys = Cache.backend.keys('hello_*')
+Cache.backend.del(keys)
 ```
 
 You can also use the special value `:method_name` to dynamically set the key
@@ -209,8 +210,8 @@ from the primary instance.
 
 #### core extension
 
-Finally, if you want, you can extend `Object` with a `cache` method, for
-convenient access to the cache object:
+Finally, if you want, you can use the `cache` method, for convenient
+access to the cache object:
 
 ```ruby
 require 'object/cache/core_extension'
@@ -220,15 +221,6 @@ cache('hello', ttl: 60) { 'hello world' }
 Cache.new('hello', ttl: 60) { 'hello world' }
 ```
 
-You can also call this method directly on any instances inheriting from
-`Object`:
-
-```ruby
-require 'object/cache/core_extension'
-
-'hello world'.cache(ttl: 60)
-```
-
 That's it!
 
 ## License

data/Rakefile

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new do |t|
-  t.options = %w(--display-cop-names --extra-details --display-style-guide)
+  t.options = %w[--display-cop-names --extra-details --display-style-guide]
 end
 
 Rake::TestTask.new(:test) do |t|
@@ -13,4 +14,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task default: %i(test rubocop)
+task default: %i[test rubocop]

data/lib/object/cache.rb

@@ -47,22 +47,30 @@ class Cache
     def new(key = nil, ttl: default_ttl, key_prefix: default_key_prefix)
       return yield unless replica
 
-      key = build_key(key, key_prefix, Proc.new)
-
-      if (cached_value = replica.get(key)).nil?
-        yield.tap { |value| update_cache(key, value, ttl: ttl) }
-      else
-        Marshal.load(cached_value)
+      begin
+        key = build_key(key, key_prefix, Proc.new)
+
+        if (cached_value = replica.get(key)).nil?
+          yield.tap do |value|
+            begin
+              update_cache(key, value, ttl: ttl)
+            rescue TypeError
+              # if `TypeError` is raised, the data could not be Marshal dumped. In that
+              # case, delete anything left in the cache store, and get the data without
+              # caching.
+              #
+              delete(key)
+            end
+          end
+        else
+          begin
+            Marshal.load(cached_value)
+          rescue
+            delete(key)
+            yield
+          end
+        end
       end
-    rescue TypeError
-      # if `TypeError` is raised, the data could not be Marshal dumped. In that
-      # case, delete anything left in the cache store, and get the data without
-      # caching.
-      #
-      delete(key)
-      yield
-    rescue
-      yield
     end
 
     def include?(key)
@@ -107,8 +115,8 @@ class Cache
     def build_key_prefix(key_prefix, proc)
       case key_prefix
       when :method_name
-        location = caller_locations.find { |l| "#{l.path}#{l.lineno}" == proc.source_location.join }
-        location && location.base_label
+        location = caller_locations.find { |l| proc.source_location.join == "#{l.path}#{l.lineno}" }
+        location&.base_label
       when :class_name
         proc.binding.receiver.class.to_s
       else

data/lib/object/cache/core_extension.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
+
 require 'object/cache'
 
 # :no-doc:
-class Object
+module Kernel
   def cache(key = nil, **options, &block)
-    block = -> { self } unless block_given?
-
     Cache.new(key, **options, &block)
   end
 end

data/lib/object/cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Cache
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/object-cache.gemspec

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 # encoding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'object/cache'
@@ -7,15 +8,15 @@ require 'object/cache'
 Gem::Specification.new do |spec|
   spec.name          = 'object-cache'
   spec.version       = Cache::VERSION
-  spec.authors       = %w(Jean Mertz)
-  spec.email         = %w(jean@mertz.fm)
+  spec.authors       = %w[Jean Mertz]
+  spec.email         = %w[jean@mertz.fm]
 
   spec.summary       = 'Caching of objects, using a Redis store.'
   spec.description   = 'Easily cache objects in Ruby, using a Redis store backend'
   spec.homepage      = 'https://github.com/blendle/object-cache'
   spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.require_paths = %w(lib)
+  spec.require_paths = %w[lib]
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'm', '~> 1.5'

data/test/cache_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'mock_redis'
@@ -21,7 +22,7 @@ class CacheTest < Minitest::Test # rubocop:disable Metrics/ClassLength
   end
 
   def test_cache_returns_object
-    assert_equal 'hello world', Cache.new { 'hello world' }
+    assert_equal('hello world', Cache.new { 'hello world' })
   end
 
   def test_cache_stores_object
@@ -94,28 +95,15 @@ class CacheTest < Minitest::Test # rubocop:disable Metrics/ClassLength
 
   def test_core_extension
     load 'object/cache/core_extension.rb'
-    assert_equal 'hello world', cache { 'hello world' }
-    assert Object.send(:remove_method, :cache)
+    assert_equal('hello world', cache { 'hello world' })
+    assert Kernel.send(:remove_method, :cache)
   end
 
   def test_core_extension_options
     load 'object/cache/core_extension.rb'
     cache(ttl: 60) { 'hello world' }
     assert_equal 60, redis.ttl(redis.keys.first)
-    assert Object.send(:remove_method, :cache)
-  end
-
-  def test_core_extension_on_objects
-    load 'object/cache/core_extension.rb'
-    assert_equal 'hello world', 'hello world'.cache
-    assert Object.send(:remove_method, :cache)
-  end
-
-  def test_core_extension_on_objects_with_arguments
-    load 'object/cache/core_extension.rb'
-    'hello world'.cache(ttl: 30)
-    assert_equal 30, redis.ttl(redis.keys.first)
-    assert Object.send(:remove_method, :cache)
+    assert Kernel.send(:remove_method, :cache)
   end
 
   def test_backend_with_replicas
@@ -183,4 +171,53 @@ class CacheTest < Minitest::Test # rubocop:disable Metrics/ClassLength
     Cache.new(key_prefix: :class_name) { 'hello world' }
     assert_match(/^CacheTest/, redis.keys.first)
   end
+
+  def test_unset_backend
+    Cache.backend = nil
+    val = 0
+    block = -> { val += 1 }
+    Cache.new(&block)
+    Cache.backend = MockRedis.new
+
+    assert_equal 1, val
+  end
+
+  def test_unset_backend_raising_type_error
+    Cache.backend = nil
+    val = 0
+    begin
+      Cache.new do
+        val += 1
+        raise TypeError
+      end
+    rescue
+      nil
+    end
+
+    Cache.backend = MockRedis.new
+    assert_equal 1, val
+  end
+
+  def test_single_yield_on_failure
+    val = 0
+    begin
+      Cache.new do
+        val += 1
+        raise TypeError
+      end
+    rescue
+      nil
+    end
+
+    assert_equal 1, val
+  end
+
+  def test_yield_when_marshal_load_fails
+    testing = -> { Cache.new(key_prefix: 'marshal') { 'hello world' } }
+
+    assert_equal 'hello world', testing.call
+    redis.set(redis.keys('marshal*').first, 'garbage')
+    assert_equal 'hello world', testing.call
+    assert_empty redis.keys('marshal*')
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object-cache
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Jean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Caching of objects, using a Redis store.