active_remote-cached 1.0.0 → 1.2.0

data/lib/active_remote/cached/cache.rb

@@ -1,72 +1,99 @@
+# frozen_string_literal: true
+
 require 'delegate'
 
-module ActiveRemote::Cached
-  class Cache < ::SimpleDelegator
-    attr_reader :cache_provider
+module ActiveRemote
+  module Cached
+    class Cache < ::SimpleDelegator
+      # Raised when the given cache provider is missing a method the library
+      # calls on it.
+      class InvalidCacheProvider < ::StandardError; end
 
-    def initialize(new_cache_provider)
-      @cache_provider = new_cache_provider
-      @nested_cache_provider = ::ActiveSupport::Cache::NullStore.new
+      attr_reader :cache_provider
 
-      validate_provider_method_present(:delete)
-      validate_provider_method_present(:exist?)
-      validate_provider_method_present(:fetch)
-      validate_provider_method_present(:read)
-      validate_provider_method_present(:write)
+      def initialize(new_cache_provider)
+        @cache_provider = new_cache_provider
+        @nested_cache_provider = ::ActiveSupport::Cache::NullStore.new
 
-      super(@cache_provider)
-    end
+        validate_provider_method_present(:delete)
+        validate_provider_method_present(:exist?)
+        validate_provider_method_present(:fetch)
+        validate_provider_method_present(:read)
+        validate_provider_method_present(:write)
 
-    def delete(*args)
-      nested_cache_provider.delete(*args)
-      super
-    end
+        super(@cache_provider)
+      end
 
-    def enable_nested_caching!
-      @nested_cache_provider = ::ActiveSupport::Cache::MemoryStore.new
-    end
+      def delete(*args)
+        nested_cache_provider.delete(*args)
+        super
+      end
 
-    def exist?(*args)
-      nested_cache_provider.exist?(*args) || super
-    end
+      def enable_nested_caching!
+        @nested_cache_provider = ::ActiveSupport::Cache::MemoryStore.new
+      end
 
-    def fetch(name, options = {})
-      fetch_value = nested_cache_provider.fetch(name, options) { super }
+      def nested_caching?
+        !nested_cache_provider.is_a?(::ActiveSupport::Cache::NullStore)
+      end
 
-      unless valid_fetched_value?(fetch_value, options)
-        delete(name)
+      def exist?(*args)
+        nested_cache_provider.exist?(*args) || super
       end
 
-      return fetch_value
-    end
+      def fetch(name, options = {})
+        provider_options = provider_fetch_options(options)
+        fetch_value = nested_cache_provider.fetch(name, provider_options) { super(name, provider_options) }
 
-    def read(*args)
-      nested_cache_provider.read(*args) || super
-    end
+        delete(name) if delete_after_fetch?(fetch_value, options, provider_options)
 
-    def write(*args)
-      nested_cache_provider.write(*args)
-      super
-    end
+        fetch_value
+      end
+
+      def read(*args)
+        nested_cache_provider.read(*args) || super
+      end
 
-  private
+      def write(*args)
+        nested_cache_provider.write(*args)
+        super
+      end
 
-    def nested_cache_provider
-      @nested_cache_provider
-    end
+      private
 
-    def valid_fetched_value?(value, options = {})
-      return false if value.nil? && !options.fetch(:allow_nil, false)
-      return false if !options.fetch(:allow_empty, false) && value.respond_to?(:empty?) && value.empty?
-      return true
-    end
+      attr_reader :nested_cache_provider
+
+      # :skip_nil tells the provider not to write a nil at all, which saves a
+      # write and the delete that follows it. Only an ActiveSupport store is
+      # known to honor the option.
+      def provider_fetch_options(options)
+        return options if options.fetch(:allow_nil, false)
+        return options unless cache_provider.is_a?(::ActiveSupport::Cache::Store)
+
+        options.merge(:skip_nil => true)
+      end
+
+      def delete_after_fetch?(value, options, provider_options)
+        return false if valid_fetched_value?(value, options)
+        # The provider already skipped the write.
+        return false if value.nil? && provider_options[:skip_nil]
+
+        true
+      end
+
+      def valid_fetched_value?(value, options = {})
+        return false if value.nil? && !options.fetch(:allow_nil, false)
+        return false if !options.fetch(:allow_empty, false) && value.respond_to?(:empty?) && value.empty?
+
+        true
+      end
+
+      def validate_provider_method_present(method_name)
+        return if cache_provider.respond_to?(method_name)
 
-    def validate_provider_method_present(method_name)
-      unless self.cache_provider.respond_to?(method_name)
-        raise <<-CACHE_METHOD
-          ActiveRemote::Cached::Cache must respond_to? #{method_name}
-          in order to be used as a caching interface for ActiveRemote
-        CACHE_METHOD
+        raise InvalidCacheProvider,
+              "ActiveRemote::Cached::Cache must respond_to? #{method_name} " \
+              'in order to be used as a caching interface for ActiveRemote'
       end
     end
   end

data/lib/active_remote/cached/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/ordered_options'
 
 module ActiveRemote
@@ -5,18 +7,16 @@ module ActiveRemote
     class Railtie < ::Rails::Railtie
       config.active_remote_cached = ::ActiveSupport::OrderedOptions.new
 
-      initializer "active_remote-cached.initialize_cache" do |app|
+      initializer 'active_remote-cached.initialize_cache' do |_app|
         config.active_remote_cached.expires_in ||= 5.minutes
         config.active_remote_cached.race_condition_ttl ||= 5.seconds
 
         ::ActiveRemote::Cached.cache(Rails.cache)
 
-        if config.active_remote_cached.enable_nested_caching
-          ::ActiveRemote::Cached.cache.enable_nested_caching!
-        end
+        ::ActiveRemote::Cached.cache.enable_nested_caching! if config.active_remote_cached.enable_nested_caching
 
         ::ActiveRemote::Cached.default_options(
-          :expires_in         => config.active_remote_cached.expires_in,
+          :expires_in => config.active_remote_cached.expires_in,
           :race_condition_ttl => config.active_remote_cached.race_condition_ttl
         )
       end

data/lib/active_remote/cached/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ActiveRemote
   module Cached
-    VERSION = "1.0.0"
+    VERSION = '1.2.0'
   end
 end