1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/actionview/test/template/digestor_test.rb
2021-04-22 22:08:34 -03:00

392 lines
12 KiB
Ruby

# frozen_string_literal: true
require "abstract_unit"
require "fileutils"
require "action_view/dependency_tracker"
class FixtureFinder < ActionView::LookupContext
FIXTURES_DIR = File.expand_path("../fixtures/digestor", __dir__)
def self.build(details = {})
new(ActionView::PathSet.new(["digestor", "digestor/api"]), details, [])
end
end
class ActionView::Digestor::Node
def flatten
[self] + children.flat_map(&:flatten)
end
end
class TemplateDigestorTest < ActionView::TestCase
def setup
@cwd = Dir.pwd
@tmp_dir = Dir.mktmpdir
ActionView::LookupContext::DetailsKey.clear
FileUtils.cp_r FixtureFinder::FIXTURES_DIR, @tmp_dir
Dir.chdir @tmp_dir
end
def teardown
Dir.chdir @cwd
FileUtils.rm_r @tmp_dir
end
def test_top_level_change_reflected
assert_digest_difference("messages/show") do
change_template("messages/show")
end
end
def test_explicit_dependency
assert_digest_difference("messages/show") do
change_template("messages/_message")
end
end
def test_explicit_dependency_in_multiline_erb_tag
assert_digest_difference("messages/show") do
change_template("messages/_form")
end
end
def test_explicit_dependency_wildcard
assert_digest_difference("events/index") do
change_template("events/_completed")
end
end
def test_explicit_dependency_wildcard_picks_up_added_file
disable_resolver_caching do
assert_digest_difference("events/index") do
add_template("events/_uncompleted")
end
end
end
def test_explicit_dependency_wildcard_picks_up_removed_file
disable_resolver_caching do
add_template("events/_subscribers_changed")
assert_digest_difference("events/index") do
remove_template("events/_subscribers_changed")
end
end
end
def test_second_level_dependency
assert_digest_difference("messages/show") do
change_template("comments/_comments")
end
end
def test_second_level_dependency_within_same_directory
assert_digest_difference("messages/show") do
change_template("messages/_header")
end
end
def test_third_level_dependency
assert_digest_difference("messages/show") do
change_template("comments/_comment")
end
end
def test_directory_depth_dependency
assert_digest_difference("level/below/index") do
change_template("level/below/_header")
end
end
def test_logging_of_missing_template
assert_logged "Couldn't find template for digesting: messages/something_missing" do
digest("messages/show")
end
end
def test_logging_of_missing_template_ending_with_number
assert_logged "Couldn't find template for digesting: messages/something_missing_1" do
digest("messages/show")
end
end
def test_logging_of_missing_template_for_dependencies
assert_logged "Couldn't find template for digesting: messages/something_missing" do
dependencies("messages/something_missing")
end
end
def test_logging_of_missing_template_for_nested_dependencies
assert_logged "Couldn't find template for digesting: messages/something_missing" do
nested_dependencies("messages/something_missing")
end
end
def test_getting_of_singly_nested_dependencies
singly_nested_dependencies = ["messages/header", "messages/form", "messages/message", "events/event", "comments/comment"]
assert_equal singly_nested_dependencies, nested_dependencies("messages/edit")
end
def test_getting_of_doubly_nested_dependencies
doubly_nested = [{ "comments/comments" => ["comments/comment"] }, "messages/message"]
assert_equal doubly_nested, nested_dependencies("messages/peek")
end
def test_nested_template_directory
assert_digest_difference("messages/show") do
change_template("messages/actions/_move")
end
end
def test_nested_template_deps
nested_deps = ["messages/header", { "comments/comments" => ["comments/comment"] }, "messages/actions/move", "events/event", "messages/something_missing", "messages/something_missing_1", "messages/message", "messages/form"]
assert_equal nested_deps, nested_dependencies("messages/show")
end
def test_nested_template_deps_with_non_default_rendered_format
nested_deps = [{ "comments/comments" => ["comments/comment"] }]
assert_equal nested_deps, nested_dependencies("messages/thread")
end
def test_template_formats_of_nested_deps_with_non_default_rendered_format
@finder = finder.with_prepended_formats([:json])
assert_equal [:json], tree_template_formats("messages/thread").uniq
end
def test_template_formats_of_dependencies_with_same_logical_name_and_different_rendered_format
assert_equal [:html], tree_template_formats("messages/show").uniq
end
def test_template_dependencies_with_fallback_from_js_to_html_format
assert_equal ["comments/comment"], dependencies("comments/show")
end
def test_template_digest_with_fallback_from_js_to_html_format
assert_digest_difference("comments/show") do
change_template("comments/_comment")
end
end
def test_recursion_in_renders
assert digest("level/recursion") # assert recursion is possible
assert_not_nil digest("level/recursion") # assert digest is stored
end
def test_chaining_the_top_template_on_recursion
assert digest("level/recursion") # assert recursion is possible
assert_digest_difference("level/recursion") do
change_template("level/recursion")
end
assert_not_nil digest("level/recursion") # assert digest is stored
end
def test_chaining_the_partial_template_on_recursion
assert digest("level/recursion") # assert recursion is possible
assert_digest_difference("level/recursion") do
change_template("level/_recursion")
end
assert_not_nil digest("level/recursion") # assert digest is stored
end
def test_dont_generate_a_digest_for_missing_templates
assert_equal "", digest("nothing/there")
end
def test_collection_dependency
assert_digest_difference("messages/index") do
change_template("messages/_message")
end
assert_digest_difference("messages/index") do
change_template("events/_event")
end
end
def test_collection_derived_from_record_dependency
assert_digest_difference("messages/show") do
change_template("events/_event")
end
end
def test_details_are_included_in_cache_key
# Cache the template digest.
@finder = FixtureFinder.build(formats: [:html])
old_digest = digest("events/_event")
# Change the template; the cached digest remains unchanged.
change_template("events/_event")
# The details are changed, so a new cache key is generated.
@finder = FixtureFinder.build
# The cache is busted.
assert_not_equal old_digest, digest("events/_event")
end
def test_extra_whitespace_in_render_partial
assert_digest_difference("messages/edit") do
change_template("messages/_form")
end
end
def test_extra_whitespace_in_render_named_partial
assert_digest_difference("messages/edit") do
change_template("messages/_header")
end
end
def test_extra_whitespace_in_render_record
assert_digest_difference("messages/edit") do
change_template("messages/_message")
end
end
def test_extra_whitespace_in_render_with_parenthesis
assert_digest_difference("messages/edit") do
change_template("events/_event")
end
end
def test_old_style_hash_in_render_invocation
assert_digest_difference("messages/edit") do
change_template("comments/_comment")
end
end
def test_variants
assert_digest_difference("messages/new", variants: [:iphone]) do
change_template("messages/new", :iphone)
change_template("messages/_header", :iphone)
end
end
def test_dependencies_via_options_results_in_different_digest
digest_plain = digest("comments/_comment")
digest_fridge = digest("comments/_comment", dependencies: ["fridge"])
digest_phone = digest("comments/_comment", dependencies: ["phone"])
digest_fridge_phone = digest("comments/_comment", dependencies: ["fridge", "phone"])
assert_not_equal digest_plain, digest_fridge
assert_not_equal digest_plain, digest_phone
assert_not_equal digest_plain, digest_fridge_phone
assert_not_equal digest_fridge, digest_phone
assert_not_equal digest_fridge, digest_fridge_phone
assert_not_equal digest_phone, digest_fridge_phone
end
def test_different_formats_with_same_logical_template_names_results_in_different_digests
html_digest = digest("comments/_comment", format: :html)
json_digest = digest("comments/_comment", format: :json)
assert_not_equal html_digest, json_digest
end
def test_digest_cache_cleanup_with_recursion
first_digest = digest("level/_recursion")
second_digest = digest("level/_recursion")
assert first_digest
# If the cache is cleaned up correctly, subsequent digests should return the same
assert_equal first_digest, second_digest
end
def test_digest_cache_cleanup_with_recursion_and_template_caching_off
disable_resolver_caching do
first_digest = digest("level/_recursion")
second_digest = digest("level/_recursion")
assert first_digest
# If the cache is cleaned up correctly, subsequent digests should return the same
assert_equal first_digest, second_digest
end
end
private
def assert_logged(message)
old_logger = ActionView::Base.logger
log = StringIO.new
ActionView::Base.logger = Logger.new(log)
begin
yield
log.rewind
assert_match message, log.read
ensure
ActionView::Base.logger = old_logger
end
end
def assert_digest_difference(template_name, options = {})
previous_digest = digest(template_name, options)
finder.view_paths.each(&:clear_cache)
finder.digest_cache.clear
yield
assert_not_equal previous_digest, digest(template_name, options), "digest didn't change"
finder.digest_cache.clear
finder.view_paths.each(&:clear_cache)
end
def digest(template_name, options = {})
options = options.dup
finder_options = options.extract!(:variants, :format)
finder.variants = finder_options[:variants] || []
finder_with_formats = if finder_options[:format]
finder.with_prepended_formats(Array(finder_options[:format]))
else
finder
end
ActionView::Digestor.digest(name: template_name, format: finder_options[:format], finder: finder_with_formats, dependencies: (options[:dependencies] || []))
end
def dependencies(template_name)
tree = ActionView::Digestor.tree(template_name, finder)
tree.children.map(&:name)
end
def nested_dependencies(template_name)
tree = ActionView::Digestor.tree(template_name, finder)
tree.children.map(&:to_dep_map)
end
def tree_template_formats(template_name)
tree = ActionView::Digestor.tree(template_name, finder)
tree.flatten.filter_map { |node| node.template&.format }
end
def disable_resolver_caching
old_caching, ActionView::Resolver.caching = ActionView::Resolver.caching, false
yield
ensure
ActionView::Resolver.caching = old_caching
end
def finder
@finder ||= FixtureFinder.build
end
def change_template(template_name, variant = nil)
variant = "+#{variant}" if variant.present?
File.open("digestor/#{template_name}.html#{variant}.erb", "w") do |f|
f.write "\nTHIS WAS CHANGED!"
end
end
alias_method :add_template, :change_template
def remove_template(template_name)
File.delete("digestor/#{template_name}.html.erb")
end
end