atomic_cache 0.2.5.rc1 → 0.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c6e0bf96718fb99b6047009b67c12f3fb4da0b36fd18ba8eb7aded71b744cb2
-  data.tar.gz: 8443307bb59ff3e3ca393cb6401f6c30974ec97bc3729024848be74504c5abda
+  metadata.gz: becad2b31944cbd2f93353a4b5e015f8f39c6f508f605f3adcd672fd7e8482b9
+  data.tar.gz: a76b093ad299c779adabe12053731f6582eca33b169a4b05c3a2c619f8747855
 SHA512:
-  metadata.gz: f438b868a3b60d2d64be72fa314f8cb4ca2a04d9972286d623393bf9754b488577f150d4726c26ee236a0a0cbaae9444fc892fc808b8cda3b23052e2adb8fb8d
-  data.tar.gz: d84517bed76804507f0dc395205eaad4e114e0dfda3023b33f6a1e1191e396d1643b7fb501ebd66e677d8d682ef822b5fa5329660ee5c0c2947d3adb4009c99c
+  metadata.gz: 71ea9a439a06adde2a837132820555a564aa2168344a9b9b455fcf04e3293aa3ce147ca9a534ed97266dda92a1db09aa0cc33af22262c6997f8dca334ac0ec66
+  data.tar.gz: 3e4c87333014f120f9ef8055492886734525cbc85ef5245fe87c32a3e908ce0ab059f5ea297a6bc3c2c05517c294ac6ee7891e0caa3d3d4f44db83ea3583fc64

data/README.md

@@ -23,7 +23,7 @@ In a nutshell:
 class Foo < ActiveRecord::Base
   include AtomicCache::GlobalLMTCacheConcern
 
-  cache_class(:custom_foo)  # optional
+  force_cache_class(:custom_foo)  # optional
   cache_version(5)          # optional
 
   def active_foos(ids)

data/docs/MODEL_SETUP.md

@@ -7,13 +7,13 @@ class Foo < ActiveRecord::Base
 end
 ```
 
-### cache_class
+### force_cache_class
 By default the cache identifier for a class is set to the name of a class (ie. `self.to_s`).  In some cases it makes sense to set a custom value for the cache identifier.  In cases where a custom cache identifier is set, it's important that the identifier remain unique across the project.
 
 ```ruby
 class SuperDescriptiveDomainModelAbstractFactoryImplManager < ActiveRecord::Base
   include AtomicCache::GlobalLMTCacheConcern
-  cache_class('sddmafim')
+  force_cache_class('sddmafim')
 end
 ```
 

data/docs/PROJECT_SETUP.md

@@ -23,9 +23,10 @@ AtomicCache::DefaultConfig.configure do |config|
   config.metrics = Datadog::Statsd.new('localhost', 8125, namespace: 'cache.atomic')
 
   # note: these values can also be set in an env file for env-specific settings
-  config.namespace      = 'atom'
-  config.cache_storage  = AtomicCache::Storage::SharedMemory.new
-  config.key_storage    = AtomicCache::Storage::SharedMemory.new
+  config.namespace        = 'atom'
+  config.default_options  = { generate_ttl_ms: 500 }
+  config.cache_storage    = AtomicCache::Storage::SharedMemory.new
+  config.key_storage      = AtomicCache::Storage::SharedMemory.new
 end
 ```
 
@@ -36,7 +37,7 @@ Note that `Datadog::Statsd` is not _required_.  Adding it, however, will enable
   * `key_storage` - Storage adapter for key manager (see below)
 
 #### Optional
-  * `default_options` - Default options for every fetch call.  See [fetch options](/Ibotta/atomic_cache/blob/main/docs/USAGE.md#fetch).
+  * `default_options` - Override default options for every fetch call, unless specified at call site.  See [fetch options](/Ibotta/atomic_cache/blob/main/docs/USAGE.md#fetch).
   * `logger` - Logger instance.  Used for debug and warn logs. Defaults to nil.
   * `timestamp_formatter` - Proc to format last modified time for storage. Defaults to timestamp (`Time.to_i`)
   * `metrics` - Metrics instance. Defaults to nil.
@@ -45,6 +46,49 @@ Note that `Datadog::Statsd` is not _required_.  Adding it, however, will enable
 #### ★ Best Practice ★
 Keep the global namespace short.  For example, memcached has a limit of 250 characters for key length.
 
+#### More Complex Rails Configuration
+
+In any real-world project, the need to run multiple caching strategies or setups is likely to arise. In those cases, it's often advantageous
+to keep a DRY setup, with multiple caching clients sharing the same config. Because Rails initializers run after the environment-specific
+config files, a sane way to manage this is to keep client network settings int he config files, then reference them from the initializer.
+
+```ruby
+# config/environments/staging
+config.memcache_hosts = [ "staging.host.cache.amazonaws.com" ]
+config.cache_store_options = {
+  expires_in: 15.minutes,
+  compress: true,
+  # ...
+}
+
+# config/environments/production
+config.memcache_hosts = [ "prod1.host.cache.amazonaws.com", "prod2.host.cache.amazonaws.com" ]
+config.cache_store_options = {
+  expires_in: 1.hour,
+  compress: true,
+  # ...
+}
+
+# config/initializers/cache.rb
+AtomicCache::DefaultConfig.configure do |config|
+  if Rails.env.development? || Rails.env.test?
+    config.cache_storage  = AtomicCache::Storage::SharedMemory.new
+    config.key_storage    = AtomicCache::Storage::SharedMemory.new
+
+  elsif Rails.env.staging? || Rails.env.production?
+    # Your::Application.config will be loaded by config/environments/*
+    memcache_hosts = Your::Application.config.memcache_hosts
+    options = Your::Application.config.cache_store_options
+    
+    dc = Dalli::Client.new(memcache_hosts, options)
+    config.cache_storage  = AtomicCache::Storage::Dalli.new(dc)
+    config.key_storage    = AtomicCache::Storage::Dalli.new(dc)
+  end
+  
+  # other AtomicCache configuration...
+end
+```
+
 ## Storage Adapters
 
 ### InstanceMemory & SharedMemory

data/lib/atomic_cache/concerns/global_lmt_cache_concern.rb

@@ -26,7 +26,7 @@ module AtomicCache
         end
       end
 
-      def cache_class(kls)
+      def force_cache_class(kls)
         ATOMIC_CACHE_CONCERN_MUTEX.synchronize do
           @atomic_cache_class = kls
         end

data/lib/atomic_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AtomicCache
-  VERSION = "0.2.5.rc1"
+  VERSION = "0.3.0.rc1"
 end

data/spec/atomic_cache/concerns/global_lmt_cache_concern_spec.rb

@@ -104,12 +104,12 @@ describe 'AtomicCacheConcern' do
       class Foo2
         include AtomicCache::GlobalLMTCacheConcern
         cache_version(3)
-        cache_class('foo')
+        force_cache_class('foo')
       end
       Foo2
     end
 
-    it 'uses the given version and cache_class become part of the cache keyspace' do
+    it 'uses the given version and force_cache_class become part of the cache keyspace' do
       subject.expire_cache
       expect(key_storage.store).to have_key(:'foo:v3:lmt')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic_cache
 version: !ruby/object:Gem::Version
-  version: 0.2.5.rc1
+  version: 0.3.0.rc1
 platform: ruby
 authors:
 - Ibotta Developers
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler