path: root/actionview/lib/action_view/digestor.rb

require 'concurrent/map'
require 'action_view/dependency_tracker'
require 'monitor'

module ActionView
  class Digestor
    cattr_reader(:cache)
    @@cache          = Concurrent::Map.new
    @@digest_mutex   = Mutex.new

    class PerRequestDigestCacheExpiry < Struct.new(:app) # :nodoc:
      def call(env)
        ActionView::Digestor.cache.clear
        app.call(env)
      end
    end

    class << self
      # Supported options:
      #
      # * <tt>name</tt>   - Template name
      # * <tt>finder</tt>  - An instance of <tt>ActionView::LookupContext</tt>
      # * <tt>dependencies</tt>  - An array of dependent views
      # * <tt>partial</tt>  - Specifies whether the template is a partial
      def digest(name:, finder:, **options)
        options.assert_valid_keys(:dependencies, :partial)

        dependencies = Array.wrap(options[:dependencies])
        cache_key = ([ name, finder.details_key.hash ].compact + dependencies).join('.')

        # this is a correctly done double-checked locking idiom
        # (Concurrent::Map's lookups have volatile semantics)
        @@cache[cache_key] || @@digest_mutex.synchronize do
          @@cache.fetch(cache_key) do # re-check under lock
            @@cache[cache_key] = tree(name, finder, dependencies).digest
          end
        end
      end

      def logger
        ActionView::Base.logger || NullLogger
      end

      # Create a dependency tree for template named +name+.
      def tree(name, finder, injected = [], partial = false, seen = {})
        logical_name = name.gsub(%r|/_|, "/")
        partial = partial || name.include?("/_")

        if finder.disable_cache { finder.exists?(logical_name, [], partial) }
          template = finder.disable_cache { finder.find(logical_name, [], partial) }

          if obj = seen[template.identifier]
            obj
          else
            node = seen[template.identifier] = Node.create(name, logical_name, template, partial)

            deps = DependencyTracker.find_dependencies(name, template, finder.view_paths)
            deps.uniq { |n| n.gsub(%r|/_|, "/") }.each do |dep_file|
              node.children << tree(dep_file, finder, [], true, seen)
            end
            injected.each do |injected_dep|
              node.children << Injected.new(injected_dep, nil, nil)
            end
            node
          end
        else
          logger.error "  '#{name}' file doesn't exist, so no dependencies"
          logger.error "  Couldn't find template for digesting: #{name}"
          seen[name] ||= Missing.new(name, logical_name, nil)
        end
      end
    end

    class Node
      attr_reader :name, :logical_name, :template, :children

      def self.create(name, logical_name, template, partial)
        klass = partial ? Partial : Node
        klass.new(name, logical_name, template, [])
      end

      def initialize(name, logical_name, template, children = [])
        @name         = name
        @logical_name = logical_name
        @template     = template
        @children     = children
      end

      def digest(stack = [])
        Digest::MD5.hexdigest("#{template.source}-#{dependency_digest(stack)}")
      end

      def dependency_digest(stack)
        children.map do |node|
          if stack.include?(node)
            false
          else
            stack.push node
            node.digest(stack).tap { stack.pop }
          end
        end.join("-")
      end

      def to_dep_map
        children.any? ? { name => children.map(&:to_dep_map) } : name
      end
    end

    class Partial < Node; end

    class Missing < Node
      def digest(_ = []); '' end
    end

    class Injected < Node
      def digest(_ = []); name end
    end

    class NullLogger
      def self.debug(_); end
      def self.error(_); end
    end
  end
end