active_remote-cached 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db04ead0732ea2b7c372a7c7f674a8d3450c483a05688a56ee3684f2dc7c2688
-  data.tar.gz: 6d0823e6ff844c6effb2da7dddc15353da1240a694cc88324a1ed9c1d273189c
+  metadata.gz: b076da51dcb6fbb2bea19dda19448c84e054f71b55c04790a04e892d3f7f5cba
+  data.tar.gz: dcaeb090f4125596ab16c923afe2dd7034bb54d25dadccb4b604a0956111e492
 SHA512:
-  metadata.gz: 760fe52b8cc4b6b1e3f5d7bb61af29567f0a8deb99ea0d4b29941bed11f293c1ef43667dcbefb9bf7a18423680871b7dbcd19ef314a9a7e58976385ae0305d59
-  data.tar.gz: 544d6d1e7d17afb3bb125af5d2e66efd41eae5676cd6984491fa9c611d0a0c258e8e8a69020adb13b9ad240dd4f4ab46e548defcd6b06194eee4789ee4402868
+  metadata.gz: 2ba115560d1beb045ed0bee808032dfaaf1c01829d6078be27437ef89ccbfeb28a169b5a3c701d0afcfd103e8f0a9bc0bef133083a5c0b74c6be61c8eaad8c56
+  data.tar.gz: 2f2599b18d3e6f3b655051a387a08ca2b66f11d1af0921201dcfff95b116181751e7cc5298f9a8d996378af9c3fc2c9f8ea7137479a3763f382dc03abc03b0ea

data/README.md

@@ -80,7 +80,25 @@ The default cache options used when interacting with the cache can be specified
 ActiveRemote::Cached.default_options(:expires_in => 1.hour)
 ```
 
-In Rails apps, the :race_condition_ttl option defaults to 5 seconds.
+In Rails apps, the railtie sets `:expires_in` to 5 minutes and `:race_condition_ttl` to 5 seconds. Change them with `config.active_remote_cached.expires_in` and `config.active_remote_cached.race_condition_ttl`.
+
+`default_options` merges the given options into the current options. An initializer that adds one option keeps the railtie's TTL:
+
+```ruby
+# config/initializers/active_remote_cached.rb
+ActiveRemote::Cached.default_options(:active_remote_cached_replace_characters => true)
+ActiveRemote::Cached.default_options
+# => { :expires_in => 5.minutes, :race_condition_ttl => 5.seconds, :active_remote_cached_replace_characters => true }
+```
+
+To replace all the options, use `default_options_overwrite`. Pass an empty hash to clear them:
+
+```ruby
+ActiveRemote::Cached.default_options_overwrite(:expires_in => 1.hour)
+ActiveRemote::Cached.default_options_overwrite({})
+```
+
+Without `:expires_in`, a cached finder writes an entry that never expires.
 
 #### Local overrides
 
@@ -149,6 +167,30 @@ CI runs this matrix on Ruby 3.1, Ruby 3.4, JRuby 9.4, and JRuby 10.0.
 `active_remote` 8.0 requires Ruby 3.2 or later. CI does not run that
 version on Ruby 3.1 or JRuby 9.4.
 
+## Upgrading to 1.3.0
+
+### default_options merges
+
+Before 1.3.0, each call to `default_options` replaced the options. In a
+Rails app, the railtie sets `:expires_in` and `:race_condition_ttl` before the
+app initializers run. An initializer that called `default_options` with other
+options removed the TTL, and every cached finder call with no `:expires_in`
+wrote an entry that never expired:
+
+```ruby
+# railtie:      { :expires_in => 5.minutes, :race_condition_ttl => 5.seconds }
+ActiveRemote::Cached.default_options(:active_remote_cached_replace_characters => true)
+# before:       { :active_remote_cached_replace_characters => true }
+# now:          { :expires_in => 5.minutes, :race_condition_ttl => 5.seconds, :active_remote_cached_replace_characters => true }
+```
+
+After the upgrade, an app like this gets a TTL again. Its finders call the
+remote service more often, because entries now expire.
+
+`default_options({})` no longer clears the options. Use
+`default_options_overwrite({})`. Use `default_options_overwrite` to keep the
+old replace behavior.
+
 ## Upgrading to 1.2.0
 
 ### Every cache key changes

data/active_remote-cached.gemspec

@@ -6,20 +6,18 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'active_remote/cached/version'
 
-HOMEPAGE = 'https://github.com/mxenabled/active_remote-cached'
+# Locals, not a constant or a def: `gem build` evals this file inside
+# Gem::Specification, so top-level definitions land on that class.
+homepage = 'https://github.com/mxenabled/active_remote-cached'
 
 # git ls-files returns nothing outside a checkout, so a build from a released
 # tarball needs the glob.
-def gem_files
-  files = if File.directory?(File.join(__dir__, '.git'))
-            `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-          else
-            Dir.glob('{lib,spec}/**/*', File::FNM_DOTMATCH) +
-              %w[LICENSE.txt README.md Rakefile Appraisals active_remote-cached.gemspec]
-          end
-
-  files.reject { |file| File.directory?(file) }
-end
+gem_files = if File.directory?(File.join(__dir__, '.git'))
+              `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+            else
+              Dir.glob('{lib,spec}/**/*', File::FNM_DOTMATCH) +
+                %w[LICENSE.txt README.md Rakefile Appraisals active_remote-cached.gemspec]
+            end
 
 Gem::Specification.new do |gem|
   gem.name          = 'active_remote-cached'
@@ -28,17 +26,17 @@ Gem::Specification.new do |gem|
   gem.email         = ['brandonsdewitt@gmail.com', 'devexperience@mx.com']
   gem.description   = ' Provides "cached" finders and a DSL to enumerate which finders should have cached versions '
   gem.summary       = ' Provides a configuration for caching mechanisms and finders on ActiveRemote models'
-  gem.homepage      = HOMEPAGE
+  gem.homepage      = homepage
   gem.license       = 'MIT'
 
   gem.metadata = {
-    'homepage_uri' => HOMEPAGE,
-    'source_code_uri' => HOMEPAGE,
+    'homepage_uri' => homepage,
+    'source_code_uri' => homepage,
     'rubygems_mfa_required' => 'true'
   }
 
   gem.required_ruby_version = '>= 3.1'
-  gem.files         = gem_files
+  gem.files         = gem_files.reject { |file| File.directory?(file) }
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ['lib']
 

data/lib/active_remote/cached/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRemote
   module Cached
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
   end
 end

data/lib/active_remote/cached.rb

@@ -31,12 +31,21 @@ module ActiveRemote
       @cache_provider
     end
 
+    # Merges the given options into the current options, and returns the
+    # result. A later call adds to the options, so an app initializer keeps the
+    # :expires_in and :race_condition_ttl that the Rails railtie set before it.
     def self.default_options(options = nil)
-      @default_options = options if options
+      @default_options = default_options.merge(options) if options
 
       @default_options || {}
     end
 
+    # Replaces the current options with the given options, and returns them.
+    # Pass an empty hash to clear the options.
+    def self.default_options_overwrite(options)
+      @default_options = options.dup
+    end
+
     module ClassMethods
       def cached_methods
         @cached_methods ||= []

data/spec/active_remote/cached_delete_methods_spec.rb

@@ -56,7 +56,7 @@ describe DeleteMethodClass do
     end
 
     after do
-      ::ActiveRemote::Cached.default_options({})
+      ::ActiveRemote::Cached.default_options_overwrite({})
     end
 
     it 'deletes the find cache key' do

data/spec/active_remote/cached_exist_methods_spec.rb

@@ -141,7 +141,7 @@ describe ExistMethodClass do
     end
 
     after do
-      ::ActiveRemote::Cached.default_options({})
+      ::ActiveRemote::Cached.default_options_overwrite({})
     end
 
     it 'returns false before the find cache key is written' do
@@ -186,7 +186,7 @@ describe ExistMethodClass do
     end
 
     after do
-      ::ActiveRemote::Cached.default_options({})
+      ::ActiveRemote::Cached.default_options_overwrite({})
     end
 
     it 'returns false before the search cache key is written' do

data/spec/active_remote/cached_find_methods_spec.rb

@@ -64,7 +64,7 @@ describe FindMethodClass do
     end
 
     after do
-      ::ActiveRemote::Cached.default_options({})
+      ::ActiveRemote::Cached.default_options_overwrite({})
     end
 
     it 'executes find_by_guid when cached_find with guid called' do
@@ -117,7 +117,7 @@ describe FindMethodClass do
     end
 
     after do
-      ::ActiveRemote::Cached.default_options({})
+      ::ActiveRemote::Cached.default_options_overwrite({})
     end
 
     it 'overrides the default options with cached_finder options for the fetch call' do

data/spec/active_remote/cached_search_methods_spec.rb

@@ -95,7 +95,7 @@ describe SearchMethodClass do
     end
 
     after do
-      ::ActiveRemote::Cached.default_options({})
+      ::ActiveRemote::Cached.default_options_overwrite({})
     end
 
     it 'executes the search block when a block is passed' do
@@ -203,7 +203,7 @@ describe SearchMethodClass do
     end
 
     after do
-      ::ActiveRemote::Cached.default_options({})
+      ::ActiveRemote::Cached.default_options_overwrite({})
     end
 
     it 'overrides the default options with cached_finder options for the fetch call' do
@@ -232,7 +232,7 @@ describe SearchMethodClass do
     end
 
     after do
-      ::ActiveRemote::Cached.default_options({})
+      ::ActiveRemote::Cached.default_options_overwrite({})
     end
 
     it 'and_return results when present' do
@@ -307,7 +307,7 @@ describe SearchMethodClass do
     end
 
     after do
-      ::ActiveRemote::Cached.default_options({})
+      ::ActiveRemote::Cached.default_options_overwrite({})
     end
 
     it 'calls the underlying method with params in correct order' do

data/spec/active_remote/cached_spec.rb

@@ -65,7 +65,7 @@ describe ::ActiveRemote::Cached do
   end
 
   after do
-    ::ActiveRemote::Cached.default_options({})
+    ::ActiveRemote::Cached.default_options_overwrite({})
   end
 
   describe '.cache' do
@@ -91,17 +91,76 @@ describe ::ActiveRemote::Cached do
       expect(::ActiveRemote::Cached.default_options).to eq(:expires_in => 100)
     end
 
-    # Passing nil reads the options. Callers must pass an empty hash to clear.
     it 'keeps the current options when nil is given' do
       ::ActiveRemote::Cached.default_options(:expires_in => 100)
 
       expect(::ActiveRemote::Cached.default_options(nil)).to eq(:expires_in => 100)
     end
 
+    it 'keeps the current options when an empty hash is given' do
+      ::ActiveRemote::Cached.default_options(:expires_in => 100)
+
+      expect(::ActiveRemote::Cached.default_options({})).to eq(:expires_in => 100)
+    end
+
+    # The Rails railtie sets :expires_in and :race_condition_ttl. An app
+    # initializer that sets one more option must not remove them.
+    it 'merges the given options into the current options' do
+      ::ActiveRemote::Cached.default_options(:expires_in => 100, :race_condition_ttl => 5)
+      ::ActiveRemote::Cached.default_options(:active_remote_cached_replace_characters => true)
+
+      expect(::ActiveRemote::Cached.default_options).to eq(
+        :expires_in => 100,
+        :race_condition_ttl => 5,
+        :active_remote_cached_replace_characters => true
+      )
+    end
+
+    it 'lets the given options win over the current options' do
+      ::ActiveRemote::Cached.default_options(:expires_in => 100)
+      ::ActiveRemote::Cached.default_options(:expires_in => 200)
+
+      expect(::ActiveRemote::Cached.default_options).to eq(:expires_in => 200)
+    end
+
+    it 'does not change a hash that the caller passed' do
+      first = { :expires_in => 100 }
+      ::ActiveRemote::Cached.default_options(first)
+      ::ActiveRemote::Cached.default_options(:race_condition_ttl => 5)
+
+      expect(first).to eq(:expires_in => 100)
+    end
+
+    it 'gives each finder call the merged options' do
+      ::ActiveRemote::Cached.default_options(:expires_in => 100)
+      ::ActiveRemote::Cached.default_options(:active_remote_cached_replace_characters => true)
+
+      expect(::ActiveRemote::Cached.cache).to receive(:fetch).with(
+        [versioned_prefix, ConfigurationClass.name, '#find', 'guid.guid'],
+        { :expires_in => 100, :active_remote_cached_replace_characters => true }
+      ).and_return(:find_result)
+
+      ConfigurationClass.cached_find_by_guid(:guid)
+    end
+  end
+
+  describe '.default_options_overwrite' do
+    it 'replaces the current options' do
+      ::ActiveRemote::Cached.default_options(:expires_in => 100, :race_condition_ttl => 5)
+      ::ActiveRemote::Cached.default_options_overwrite(:active_remote_cached_replace_characters => true)
+
+      expect(::ActiveRemote::Cached.default_options).to eq(:active_remote_cached_replace_characters => true)
+    end
+
     it 'clears the current options when an empty hash is given' do
       ::ActiveRemote::Cached.default_options(:expires_in => 100)
+      ::ActiveRemote::Cached.default_options_overwrite({})
+
+      expect(::ActiveRemote::Cached.default_options).to eq({})
+    end
 
-      expect(::ActiveRemote::Cached.default_options({})).to eq({})
+    it 'returns the new options' do
+      expect(::ActiveRemote::Cached.default_options_overwrite(:expires_in => 100)).to eq(:expires_in => 100)
     end
   end
 

data/spec/gemspec_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'open3'
+
+# `gem build` evals the gemspec inside Gem::Specification, but Bundler evals it
+# at the top level. Bundler has already loaded the gemspec in this process, so
+# a top-level def or constant from that load would hide the bug here. Load it
+# in a fresh ruby without Bundler instead.
+describe 'active_remote-cached.gemspec' do
+  let(:root) { File.expand_path('..', __dir__) }
+  let(:script) do
+    <<~RUBY
+      spec = Gem::Specification.load('active_remote-cached.gemspec')
+      abort 'Gem::Specification.load returned nil' unless spec
+      spec.validate
+      puts spec.full_name
+    RUBY
+  end
+
+  it 'loads and validates with Rubygems alone' do
+    stdout, stderr, status = ::Bundler.with_unbundled_env do
+      ::Open3.capture3(::RbConfig.ruby, '-e', script, :chdir => root)
+    end
+
+    expect(status).to be_success, stderr
+    expect(stdout).to eq("active_remote-cached-#{::ActiveRemote::Cached::VERSION}\n")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_remote-cached
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Brandon Dewitt
@@ -181,6 +181,7 @@ files:
 - spec/active_remote/cached_find_methods_spec.rb
 - spec/active_remote/cached_search_methods_spec.rb
 - spec/active_remote/cached_spec.rb
+- spec/gemspec_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mxenabled/active_remote-cached
 licenses:
@@ -203,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.15
 specification_version: 4
 summary: Provides a configuration for caching mechanisms and finders on ActiveRemote
   models