Module: ViewComponent::CacheDigest::DependencyTracking

Defined in:
lib/view_component/cache_digest/dependency_tracking.rb

Overview

Teaches ActionView::DependencyTracker to see components.

Prepended to the tracker's singleton class rather than to a specific tracker implementation (ERBTracker, RubyTracker, or the trackers registered by the Haml and Slim gems). find_dependencies is the single seam every tracker flows through, so hooking it here works regardless of which handler a template uses and doesn't depend on tracker internals.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.install! ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/view_component/cache_digest/dependency_tracking.rb', line 38

def self.install!
  tracker = ActionView::DependencyTracker.singleton_class
  return if tracker.include?(self)

  tracker.prepend(self)
end

Instance Method Details

#find_dependencies(name, template, view_paths = nil) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/view_component/cache_digest/dependency_tracking.rb', line 17

def find_dependencies(name, template, view_paths = nil)
  dependencies = super
  source = template.source

  # `# Template Dependency: SomeComponent` names a class, which Rails
  # would resolve as a template path and never find. Swap it for the path
  # the component is digested under, so the declaration resolves instead
  # of becoming a missing node.
  CacheDigest.explicit_component_dependencies(source).each do |declared, virtual_path|
    dependencies = dependencies - [declared] + [virtual_path]
  end

  dependencies + CacheDigest.dependencies_in(template)
rescue
  # A broken digest is preferable to a broken render. Falling back to the
  # dependencies Rails found on its own means the component simply isn't
  # tracked, which is the pre-existing behavior.
  super
end