object-cache 0.0.3 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1d2f1ec4b3467a87297e809f094d3f75461b3fa9
-  data.tar.gz: bf7eef92986a7ddb52c5f7ec2aa3110ddbaa791d
+SHA256:
+  metadata.gz: 5702bb0b9df058e9fd36b86a712f11b716dc0d8e8ff3d05378a1b204f18bb6dc
+  data.tar.gz: a669e8209d07ce571313e6b63c7643e064e1e0b78ea39e8397b53a583016f49e
 SHA512:
-  metadata.gz: 323e1806f012635837d50ac2111d607232714308376d16e9ab32718cc2217fe760d745298b3e20165b1d3e70f339b90acca9aada9ec81cf44f5b75e971403006
-  data.tar.gz: 7b0cd11b83029e6e2b9701804a7426679e6002578777192916301c75af7faaf9780a61acd5ef8a32a8df52de45e977a5d86be1954f1a56dfdbd876bb7ea15dc7
+  metadata.gz: a59277f8c32bba979c8d5184c512b41b4faa816f1a9c1ed07af1ca826d69131f92980057e8ad9bd3975cb53bc5953867e4a3577eb84a7b12c592612c3483a9f0
+  data.tar.gz: 79b741e82962f83510437e93aa4d683bb59571452070f30fc55333c418395916d45b3363a70c775075908e4b26b9ae032222f0970382a5cf8d8813954742aac6

data/.rubocop.yml

@@ -1,10 +1,20 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Exclude:
     - '.wercker/**/*'
 
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
 
 Metrics/LineLength:
   Max: 100
+
+Style/RescueStandardError:
+  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

@@ -44,29 +44,37 @@ class Cache
     #   Cache.new { item } # item is only stored once, and then always
     #                      # retrieved, even if it is a different item
     #
-    def new(key = nil, ttl: default_ttl, key_prefix: default_key_prefix)
+    def new(key = nil, ttl: default_ttl, key_prefix: default_key_prefix, &block)
       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, block)
+
+        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)
-      replica.exists(key)
+      replica.exists?(key)
     rescue
       false
     end
@@ -89,7 +97,8 @@ class Cache
     end
 
     def replicas
-      [backend.is_a?(Hash) ? backend[:replicas] : backend].flatten
+      replicas = backend.is_a?(Hash) ? backend[:replicas] : backend
+      replicas.respond_to?(:sample) ? replicas : [replicas]
     end
 
     def replica
@@ -97,7 +106,7 @@ class Cache
     end
 
     def build_key(key, key_prefix, proc)
-      hash   = Digest::SHA1.hexdigest([key, proc.source_location].flatten.join)[0..5]
+      hash   = Digest::SHA1.hexdigest([key, proc.source_location].flatten.join)[0..11]
       prefix = build_key_prefix(key_prefix, proc)
 
       [prefix, hash].compact.join('_')
@@ -106,7 +115,7 @@ 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 = caller_locations.find { |l| proc.source_location.join == "#{l.path}#{l.lineno}" }
         location&.base_label
       when :class_name
         proc.binding.receiver.class.to_s

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.3'
+  VERSION = '0.1.2'
 end

data/object-cache.gemspec

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
-# encoding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 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 'bundler', '~> 2.1'
   spec.add_development_dependency 'm', '~> 1.5'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'mock_redis', '~> 0.16'
-  spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '~> 0.40'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
 end

data/test/cache_test.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require 'mock_redis'
 require 'object/cache'
@@ -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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: object-cache
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.2
 platform: ruby
 authors:
 - Jean
 - Mertz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: m
   requirement: !ruby/object:Gem::Requirement
@@ -43,16 +43,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
@@ -71,44 +71,44 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: '0'
 description: Easily cache objects in Ruby, using a Redis store backend
 email:
 - jean@mertz.fm
@@ -118,7 +118,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".wercker.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -133,7 +132,7 @@ homepage: https://github.com/blendle/object-cache
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,9 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Caching of objects, using a Redis store.
 test_files: []

data/.wercker.yml

@@ -1,7 +0,0 @@
-box: ruby:2.3
-build:
-  steps:
-  - bundle-install
-  - script:
-    name: tests
-    code: bundle exec rake