vident 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 481f74d4370e94387dfa81c6d6287e8a5a8dd022d6e353d656cfa3807f069b03
-  data.tar.gz: b462c2871a4f48b2193ad91a630a773d37efb581d5efae91699523602d18b68f
+  metadata.gz: b58f418c48b9c37897a26d83c5b500bacd54c8f37cdb95bf549e5b283c00a36a
+  data.tar.gz: f2f76b2518a26933cac78eb7c7eb3ab6c0c1091a0e0bca020c8672ed7b947594
 SHA512:
-  metadata.gz: d9eea045322f4bad4bcbc03bf4985163674385c08db20aa5aec398edabf56c428aeac532bacdbfd32f3188d3e5a7cc5f6b3bea4c9ba1c51209befd32c5810128
-  data.tar.gz: 06b566851995e5b4873dcca265345900b89cf516a13ae50fe4a6d08c848764e8fd6f7fd0c520d71985347a29befbcae8bd514639c525541bded0617f4188899a
+  metadata.gz: ab7baf21555430c664923fdfb1bbfc75a9eb8e56fef39839f1597951c48cf433c89d669898f429dcf87c724ccd5d016d89d06b82193db74dd57f7c3762a93392
+  data.tar.gz: a93dd215124bd3b6799e8b1519db632ae6521ce091ae9515b6bf943a3fc5987e5cbc301ecf751f778a891ef0ef6c21161103b07978580c4ca2c6430b5d789d48

data/Gemfile

@@ -17,7 +17,9 @@ gem "stimulus-rails"
 
 gem "dry-struct"
 
-gem "phlex", "~> 0.5.3", require: "phlex/rails"
+gem "phlex-rails"
+
+# FIXME: versions greater than 2.74 cause issues: https://github.com/ViewComponent/view_component/pull/1571
 gem "view_component", "2.74.1"
 
 gem "sqlite3"

data/README.md

@@ -39,7 +39,26 @@ This gem is a work in progress and I would love to get your feedback and contrib
   exposes a simple API for configuring and adding Stimulus controllers, targets and actions. Normally you create these
   using the `root` helper method on `Vident::Component`/`Vident::TypedComponent`.
 
-# Example
+
+# Examples
+
+Before we dive into a specific example note that there are some components implemented with
+both ViewComponent and Phlex (with and without Vident) in the `test/dummy`.
+- https://github.com/stevegeek/vident/tree/main/test/dummy/app/components
+- https://github.com/stevegeek/vident/tree/main/test/dummy/app/views
+
+Start Rails:
+
+```bash
+cd test/dummy
+bundle install
+rails assets:precompile
+rails s
+```
+
+and visit http://localhost:3000
+
+## ViewComponent + Vident example
 
 Consider the following ERB that might be part of an application's views. The app uses `ViewComponent`, `Stimulus` and `Vident`.
 
@@ -327,14 +346,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Running the Examples in `test/dummy`
 
-```bash
-cd test/dummy
-bundle install
-rails assets:precompile
-rails s
-```
 
 ## Contributing
 

data/lib/vident/base.rb

@@ -23,66 +23,6 @@ module Vident
         registered_slots.present?
       end
 
-      # TODO: move stuff related to cache key to a module
-
-      # 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 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 slots?
-        # Add view file to cache key
-        attrs << :component_modified_time
-        super
-      end
-
-      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
-
       # Dont check collection params, we use kwargs
       def validate_collection_parameter!(validate_default: false)
       end
@@ -197,12 +137,6 @@ module Vident
       self.class.stimulus_identifier
     end
 
-    # TODO: Move to caching module
-    # 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
-
     # The `component` class name is used to create the controller name.
     # The path of the Stimulus controller when none is explicitly set
     def default_controller_path

data/lib/vident/caching/cache_key.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require "benchmark"
+
+# 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. In our case the object maybe an instance of Core::Presenter so here we add a default
+# `cache_key` implementation.
+module Vident
+  module Caching
+    module CacheKey
+      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
+
+        def enable_cache_key_benchmarking
+          @enable_cache_key_benchmarking = true
+        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
+            if @enable_cache_key_benchmarking
+              time = ::Benchmark.measure { generate_cache_key(n) }
+              ::Logging::Log.debug "Cache key #{self.class.name}: #{time.real}"
+              ::Thread.current[:total_key_generation_time] ||= 0
+              ::Thread.current[:total_key_generation_time] += time.real
+            else
+              generate_cache_key(n)
+            end
+            @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

data/lib/vident/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vident
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/vident.rb

@@ -31,3 +31,4 @@ require_relative "vident/root_component/using_view_component"
 require_relative "vident/base"
 require_relative "vident/component"
 require_relative "vident/typed_component"
+require_relative "vident/caching/cache_key"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vident
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2022-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 description: Vident makes using Stimulus with your `ViewComponent` or `Phlex` view
   components as easy as writing Ruby. It also provides a base class for your components
   to inherit from.
@@ -47,6 +53,7 @@ files:
 - lib/vident/attributes/typed_niling_struct.rb
 - lib/vident/attributes/types.rb
 - lib/vident/base.rb
+- lib/vident/caching/cache_key.rb
 - lib/vident/component.rb
 - lib/vident/railtie.rb
 - lib/vident/root_component/base.rb
@@ -77,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Vident is a view component base class for your design system implementation,