vident-view_component-caching 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c92605001e18a9f49a3ba28db60fc0269bb78f74b3333b2484511dc4d240653
+  data.tar.gz: 4dd98bc48794cd45f023fdb71beb4b0e1035a1e4bbcd5c6397256d20bf5e1e95
+SHA512:
+  metadata.gz: b619b40a8d2ad65ff8bf906cea5b303353de96cd2c7eeef7087d6de439913629e9127dda7e2e8ccf95cfb488af4dc371bcc2ed57f4646f133ca26349d6f7d6f9
+  data.tar.gz: 8a87104ad9b01147cc473dbea7b0e950d66d82be3839a223b6829df48bfe1051ada6ee5b1599901e20c77d520e2c6cdadb4d29a780a95eef9730cbb46e848d22

data/README.md

@@ -0,0 +1,28 @@
+# Vident::ViewComponent::Caching
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "vident-view_component-caching"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install vident-view_component-caching
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/tasks/vident/view_component/caching_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :vident_view_component_caching do
+#   # Task goes here
+# end

data/lib/vident/view_component/caching/railtie.rb

@@ -0,0 +1,8 @@
+module Vident
+  module ViewComponent
+    module Caching
+      class Railtie < ::Rails::Railtie
+      end
+    end
+  end
+end

data/lib/vident/view_component/caching/version.rb

@@ -0,0 +1,7 @@
+module Vident
+  module ViewComponent
+    module Caching
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/vident/view_component/caching.rb

@@ -0,0 +1,145 @@
+require "vident/view_component/caching/version"
+require "vident/view_component/caching/railtie"
+
+module Vident
+  module ViewComponent
+    # Rails fragment caching works by either expecting the cached key object to respond to `cache_key` or for that object
+    # to be an array or hash.
+    module Caching
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def inherited(subclass)
+          subclass.instance_variable_set(
+            :@named_cache_key_attributes,
+            @named_cache_key_attributes.clone
+          )
+          super
+        end
+
+        def with_cache_key(*attrs, name: :_collection)
+          raise StandardError, "with_cache_key can only be used on components *without* slots as there is no eary way to track their content changes so too risky" if respond_to?(:slots?) && slots?
+          # Add view file to cache key
+          attrs << :component_modified_time
+          named_cache_key_includes(name, *attrs)
+        end
+
+        attr_reader :named_cache_key_attributes
+
+        # TypedComponents can be used with fragment caching, but you need to be careful! Read on...
+        #
+        #     <% cache component do %>
+        #      <%= render component %>
+        #    <% end %>
+        #
+        # The most important point is that Rails cannot track dependencies on the component itself, so you need to
+        # be careful to be explicit on the attributes, and manually specify any sub Viewcomponent dependencies that the
+        # component has. The assumption is that the subcomponent takes any attributes from the parent, so the cache key
+        # depends on the parent component attributes. Otherwise changes to the parent or sub component views/Ruby class
+        # will result in different cache keys too. Of course if you invalidate all cache keys with a modifier on deploy
+        # then no need to worry about changing the cache key on component changes, only on attribute/data changes.
+        #
+        # A big caveat is that the cache key cannot depend on anything related to the view_context of the component (such
+        # as `helpers` as the key is created before the rending pipline is invoked (which is when the view_context is set).
+        def depends_on(*klasses)
+          @component_dependencies ||= []
+          @component_dependencies += klasses
+        end
+
+        attr_reader :component_dependencies
+
+        def component_modified_time
+          return @component_modified_time if Rails.env.production? && @component_modified_time
+          # FIXME: This could stack overflow if there are circular dependencies
+          deps = component_dependencies&.map(&:component_modified_time)&.join("-") || ""
+          @component_modified_time = deps + sidecar_view_modified_time + rb_component_modified_time
+        end
+
+        def sidecar_view_modified_time
+          return @sidecar_view_modified_time if Rails.env.production? && defined?(@sidecar_view_modified_time)
+          @sidecar_view_modified_time = ::File.exist?(template_path) ? ::File.mtime(template_path).to_i.to_s : ""
+        end
+
+        def rb_component_modified_time
+          return @rb_component_modified_time if Rails.env.production? && defined?(@rb_component_modified_time)
+          @rb_component_modified_time = ::File.exist?(component_path) ? ::File.mtime(component_path).to_i.to_s : ""
+        end
+
+        def template_path
+          File.join components_base_path, "#{virtual_path}.html.erb"
+        end
+
+        def component_path
+          File.join components_base_path, "#{virtual_path}.rb"
+        end
+
+        def components_base_path
+          ::Rails.configuration.view_component.view_component_path || "app/components"
+        end
+
+        private
+
+        def named_cache_key_includes(name, *attrs)
+          define_cache_key_method unless @named_cache_key_attributes
+          @named_cache_key_attributes ||= {}
+          @named_cache_key_attributes[name] = attrs
+        end
+
+        def define_cache_key_method
+          # If the presenter defines cache key setup then define the method. Otherwise Rails assumes this
+          # will return a valid key if the class will respond to this
+          define_method :cache_key do |n = :_collection|
+            if defined?(@cache_key)
+              return @cache_key[n] if @cache_key.key?(n)
+            else
+              @cache_key ||= {}
+            end
+            generate_cache_key(n)
+            @cache_key[n]
+          end
+        end
+      end
+
+      # Component modified time which is combined with other cache key attributes to generate cache key for an instance
+      def component_modified_time
+        self.class.component_modified_time
+      end
+
+      def cacheable?
+        respond_to? :cache_key
+      end
+
+      def cache_key_modifier
+        ENV["RAILS_CACHE_ID"]
+      end
+
+      def cache_keys_for_sources(key_attributes)
+        sources = key_attributes.flat_map { |n| n.is_a?(Proc) ? instance_eval(&n) : send(n) }
+        sources.compact.map do |item|
+          next if item == self
+          generate_item_cache_key_from(item)
+        end
+      end
+
+      def generate_item_cache_key_from(item)
+        if item.respond_to? :cache_key_with_version
+          item.cache_key_with_version
+        elsif item.respond_to? :cache_key
+          item.cache_key
+        elsif item.is_a?(String)
+          Digest::SHA1.hexdigest(item)
+        else
+          Digest::SHA1.hexdigest(Marshal.dump(item))
+        end
+      end
+
+      def generate_cache_key(index)
+        key_attributes = self.class.named_cache_key_attributes[index]
+        return nil unless key_attributes
+        key = "#{self.class.name}/#{cache_keys_for_sources(key_attributes).join("/")}"
+        raise StandardError, "Cache key for key #{key} is blank!" if key.blank?
+        @cache_key[index] = cache_key_modifier.present? ? "#{key}/#{cache_key_modifier}" : key
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: vident-view_component-caching
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Ierodiaconou
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: vident-view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Cache key computation for Vident components with ViewComponent
+email:
+- stevegeek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/tasks/vident/view_component/caching_tasks.rake
+- lib/vident/view_component/caching.rb
+- lib/vident/view_component/caching/railtie.rb
+- lib/vident/view_component/caching/version.rb
+homepage: https://github.com/stevegeek/vident-view_component-caching
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stevegeek/vident-view_component-caching
+  source_code_uri: https://github.com/stevegeek/vident-view_component-caching
+  changelog_uri: https://github.com/stevegeek/vident-view_component-caching/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Cache key computation for Vident components with ViewComponent
+test_files: []