modulerize code

Author: Reegan Viljoen

lib/view_component/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "action_view"
+require "view_component/cacheable"
 require "active_support/configurable"
 require "view_component/collection"
 require "view_component/compile_cache"
@@ -34,6 +35,7 @@ def config
     include ViewComponent::Slotable
     include ViewComponent::Translatable
     include ViewComponent::WithContentHelper
+    include ViewComponent::Cacheable
 
     RESERVED_PARAMETER = :content
     VC_INTERNAL_DEFAULT_FORMAT = :html
@@ -45,7 +47,7 @@ def config
     delegate :content_security_policy_nonce, to: :helpers
 
     # Config option that strips trailing whitespace in templates before compiling them.
-    class_attribute :__vc_cache_dependencies, default: []
+    # class_attribute :__vc_cache_dependencies, default: []
     class_attribute :__vc_strip_trailing_whitespace, instance_accessor: false, instance_predicate: false
     self.__vc_strip_trailing_whitespace = false # class_attribute:default doesn't work until Rails 5.2
 
@@ -110,14 +112,7 @@ def render_in(view_context, &block)
 
       if render?
         rendered_template = render_template_for(@__vc_variant, __vc_request&.format&.to_sym).to_s
-
-        if view_cache_dependencies.present?
-          Rails.cache.fetch(view_cache_dependencies) do
-            __vc_render_template(rendered_template)
-          end
-        else
-          __vc_render_template(rendered_template)
-        end
+        __vc_render_cacheable(rendered_template)
       else
         ""
       end
@@ -263,15 +258,6 @@ def virtual_path
       self.class.virtual_path
     end
 
-    # For caching, such as #cache_if
-    #
-    # @private
-    def view_cache_dependencies
-      return unless __vc_cache_dependencies.present? && __vc_cache_dependencies.any?
-
-      __vc_cache_dependencies.map { |dep| send(dep) }.compact
-    end
-
     # For caching, such as #cache_if
     #
     # @private
@@ -324,15 +310,6 @@ def __vc_render_in_block_provided?
       defined?(@view_context) && @view_context && @__vc_render_in_block
     end
 
-    def __vc_render_template(rendered_template)
-      # Avoid allocating new string when output_preamble and output_postamble are blank
-      if output_preamble.blank? && output_postamble.blank?
-        rendered_template
-      else
-        safe_output_preamble + rendered_template + safe_output_postamble
-      end
-    end
-
     def __vc_content_set_by_with_content_defined?
       defined?(@__vc_content_set_by_with_content)
     end
@@ -581,8 +558,6 @@ def render_template_for(variant = nil, format = nil)
           child.instance_variable_set(:@__vc_ancestor_calls, vc_ancestor_calls)
         end
 
-        child.__vc_cache_dependencies = __vc_cache_dependencies.dup
-
         super
       end
 

lib/view_component/cacheable.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ViewComponent::Cacheable
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :__vc_cache_dependencies, default: []
+
+    # For caching, such as #cache_if
+    #
+    # @private
+    def view_cache_dependencies
+      return unless __vc_cache_dependencies.present? && __vc_cache_dependencies.any?
+
+      __vc_cache_dependencies.map { |dep| send(dep) }.compact
+    end
+
+    # For handeling the output_preamble and output_postamble
+    #
+    # @private
+    def __vc_render_template(rendered_template)
+      # Avoid allocating new string when output_preamble and output_postamble are blank
+      if output_preamble.blank? && output_postamble.blank?
+        rendered_template
+      else
+        safe_output_preamble + rendered_template + safe_output_postamble
+      end
+    end
+
+    # For determing if a template is rendered with cache or not
+    #
+    # @private
+    def __vc_render_cacheable(rendered_template)
+      if view_cache_dependencies.present?
+        Rails.cache.fetch(view_cache_dependencies) do
+          __vc_render_template(rendered_template)
+        end
+      else
+        __vc_render_template(rendered_template)
+      end
+    end
+  end
+
+  class_methods do
+
+    # For caching the component
+    def cache_on(*args)
+      __vc_cache_dependencies.push(*args)
+    end
+
+    def inherited(child)
+      child.__vc_cache_dependencies = __vc_cache_dependencies.dup
+
+      super
+    end
+  end
+end