object-cache 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b329bb499b49a3b608f4ba5a756e09a246228c28
-  data.tar.gz: e5bf39f2fd0025bd30568d4fe87aaf29eb2e077b
+  metadata.gz: b3be3bd853f9ffd24ff89cff95d2762241021a1f
+  data.tar.gz: 48fc790b6f2a15b13d945a9fe6f0483355bc9995
 SHA512:
-  metadata.gz: e14b55bf9cf2fa92ca9d307740ad8d31df097616a8f0642e362b4b1398ac7eef4480646df252e3abfdf154de5f9b06610406426fdcffa61bc32bef2007114a71
-  data.tar.gz: 4ab4b813991e17132477fa97531636d8a04778eeb14ef221a85afbe0503061e85671e6b195f80bca42f6962cf1b60d297c7672a683bc28528273375721b73276
+  metadata.gz: 6e1cd521b1b326ab8a381b71a0c39677fc37885dd0f714c8e8db010d7cc22dd5e88067827be3c4a863bda017f847ff63f77ab5814be6de0e20d527f986b4cf2e
+  data.tar.gz: 12f817db636a6d87ed92dbc80885d999f0b19b11b507aab5283fcf1ee7d9941495e430b0ff47571ab2601c559a5017703dde3de97f7d8666f04b6bf97dd4f4ae

data/.rubocop.yml

@@ -6,5 +6,8 @@ AllCops:
 Metrics/MethodLength:
   Max: 15
 
+Metrics/AbcSize:
+  Max: 16
+
 Metrics/LineLength:
   Max: 100

data/README.md

@@ -83,7 +83,14 @@ that every request after the first request uses the value from the cached
 object. After one week, the cached value becomes stale, and the first request
 after that will again store the (possibly changed) object in the cache store.
 
-You can easily modify the `ttl` using the keyword argument by that same name:
+You can globaly set the default ttl to a different value:
+
+```ruby
+Cache.default_ttl = 120
+```
+
+You can easily modify the `ttl` per cached object, using the keyword argument by
+that same name:
 
 ```ruby
 Cache.new(ttl: 60) { 'remember me for 60 seconds!' }
@@ -96,6 +103,11 @@ Cache.new(ttl: nil) { 'I am forever in your cache!' }
 Cache.new(ttl: 0) { 'me too!' }
 ```
 
+Note that it is best to never leave a value in the backend forever. Since this
+library uses file names and line numbers to store the value, a change in your
+code might mean a new cache object is created after a deployment, and your old
+cache object becomes orphaned, and will polute your storage forever.
+
 #### namespaced keys
 
 When storing the key/value object into Redis, the key name is based on the file
@@ -136,6 +148,9 @@ backend config, with a `primary` and `replicas` key:
 Cache.backend = { primary: Redis.new, replicas: [Redis.new, Redis.new] }
 ```
 
+When writing the initial object to the backend, the `primary` Redis is used. On
+subsequent requests, a random replica is used to retrieve the stored value.
+
 The above example obiously only works if the replicas receive the written data
 from the primary instance.
 
@@ -152,6 +167,15 @@ cache('hello', ttl: 60) { 'hello world' }
 Cache.new('hello', ttl: 60) { 'hello world' }
 ```
 
+Since the core extension adds the `cache` method to the `Object` class, 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/lib/object/cache.rb

@@ -5,10 +5,11 @@ require 'object/cache/version'
 
 # Caching of objects in a Redis store
 class Cache
-  DEFAULT_TTL = (7 * 24 * 60 * 60) # 1 week
+  @default_ttl = (7 * 24 * 60 * 60) # 1 week
 
   class << self
     attr_accessor :backend
+    attr_accessor :default_ttl
 
     # new
     #
@@ -42,7 +43,7 @@ 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)
+    def new(key = nil, ttl: default_ttl)
       return yield unless replica
 
       key = Digest::SHA1.hexdigest([key, Proc.new.source_location].flatten.join)[0..5]
@@ -76,7 +77,7 @@ class Cache
       true
     end
 
-    def update_cache(key, value, ttl: DEFAULT_TTL)
+    def update_cache(key, value, ttl: default_ttl)
       return unless primary && (value = Marshal.dump(value))
 
       ttl.to_i.zero? ? primary.set(key, value) : primary.setex(key, ttl.to_i, value)

data/lib/object/cache/core_extension.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
+require 'object/cache'
 
 # :no-doc:
 class Object
   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.1'
+  VERSION = '0.0.2'
 end

data/test/cache_test.rb

@@ -6,9 +6,10 @@ require 'object/cache'
 require 'minitest/autorun'
 
 # :no-doc:
-class CacheTest < Minitest::Test
+class CacheTest < Minitest::Test # rubocop:disable Metrics/ClassLength
   def setup
     Cache.backend = MockRedis.new
+    Cache.default_ttl = 604_800
   end
 
   def redis
@@ -77,7 +78,13 @@ class CacheTest < Minitest::Test
 
   def test_cache_default_ttl
     Cache.new { 'hello world' }
-    assert_equal Cache::DEFAULT_TTL, redis.ttl(redis.keys.first)
+    assert_equal Cache.default_ttl, redis.ttl(redis.keys.first)
+  end
+
+  def test_cache_custom_default_ttl
+    Cache.default_ttl = 60
+    Cache.new { 'hello world' }
+    assert_equal 60, redis.ttl(redis.keys.first)
   end
 
   def test_cache_with_ttl
@@ -98,6 +105,19 @@ class CacheTest < Minitest::Test
     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)
+  end
+
   def test_backend_with_replicas
     Cache.backend = { primary: redis, replicas: [redis, redis] }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object-cache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jean
@@ -154,4 +154,3 @@ signing_key:
 specification_version: 4
 summary: Caching of objects, using a Redis store.
 test_files: []
-has_rdoc: