Add automatic template digests to all CacheHelper#cache calls (originally spiked in the cache_digests plugin) *DHH*

10 files changed, 158 insertions, 5 deletions

diff --git a/actionpack/test/controller/caching_test.rb b/actionpack/test/controller/caching_test.rb
index 0efba5b77f..2c3511f6a0 100644
--- a/actionpack/test/controller/caching_test.rb
+++ b/actionpack/test/controller/caching_test.rb
@@ -854,14 +854,17 @@ Ciao
 CACHED
     assert_equal expected_body, @response.body
 
-    assert_equal "This bit's fragment cached", @store.read('views/test.host/functional_caching/fragment_cached')
+    assert_equal "This bit's fragment cached",
+      @store.read("views/test.host/functional_caching/fragment_cached/#{template_digest("functional_caching/fragment_cached", "html")}")
   end
 
   def test_fragment_caching_in_partials
     get :html_fragment_cached_with_partial
     assert_response :success
     assert_match(/Old fragment caching in a partial/, @response.body)
-    assert_match("Old fragment caching in a partial", @store.read('views/test.host/functional_caching/html_fragment_cached_with_partial'))
+    
+    assert_match("Old fragment caching in a partial",
+      @store.read("views/test.host/functional_caching/html_fragment_cached_with_partial/#{template_digest("functional_caching/_partial", "html")}"))
   end
 
   def test_render_inline_before_fragment_caching
@@ -869,7 +872,8 @@ CACHED
     assert_response :success
     assert_match(/Some inline content/, @response.body)
     assert_match(/Some cached content/, @response.body)
-    assert_match("Some cached content", @store.read('views/test.host/functional_caching/inline_fragment_cached'))
+    assert_match("Some cached content", 
+      @store.read("views/test.host/functional_caching/inline_fragment_cached/#{template_digest("functional_caching/inline_fragment_cached", "html")}"))
   end
 
   def test_html_formatted_fragment_caching
@@ -879,7 +883,8 @@ CACHED
 
     assert_equal expected_body, @response.body
 
-    assert_equal "<p>ERB</p>", @store.read('views/test.host/functional_caching/formatted_fragment_cached')
+    assert_equal "<p>ERB</p>", 
+      @store.read("views/test.host/functional_caching/formatted_fragment_cached/#{template_digest("functional_caching/formatted_fragment_cached", "html")}")
   end
 
   def test_xml_formatted_fragment_caching
@@ -889,8 +894,14 @@ CACHED
 
     assert_equal expected_body, @response.body
 
-    assert_equal "  <p>Builder</p>\n", @store.read('views/test.host/functional_caching/formatted_fragment_cached')
+    assert_equal "  <p>Builder</p>\n",
+      @store.read("views/test.host/functional_caching/formatted_fragment_cached/#{template_digest("functional_caching/formatted_fragment_cached", "xml")}")
   end
+  
+  private
+    def template_digest(name, format)
+      ActionView::Digestor.digest(name, format, @controller.lookup_context)
+    end
 end
 
 class CacheHelperOutputBufferTest < ActionController::TestCase
diff --git a/actionpack/test/fixtures/digestor/comments/_comment.html.erb b/actionpack/test/fixtures/digestor/comments/_comment.html.erb
new file mode 100644
index 0000000000..f172e749da
--- /dev/null
+++ b/actionpack/test/fixtures/digestor/comments/_comment.html.erb
@@ -0,0 +1 @@
+Great story, bro!
diff --git a/actionpack/test/fixtures/digestor/comments/_comments.html.erb b/actionpack/test/fixtures/digestor/comments/_comments.html.erb
new file mode 100644
index 0000000000..c28646a283
--- /dev/null
+++ b/actionpack/test/fixtures/digestor/comments/_comments.html.erb
@@ -0,0 +1 @@
+<%= render partial: "comments/comment", collection: commentable.comments %>
diff --git a/actionpack/test/fixtures/digestor/events/_event.html.erb b/actionpack/test/fixtures/digestor/events/_event.html.erb
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/actionpack/test/fixtures/digestor/events/_event.html.erb
diff --git a/actionpack/test/fixtures/digestor/messages/_header.html.erb b/actionpack/test/fixtures/digestor/messages/_header.html.erb
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/actionpack/test/fixtures/digestor/messages/_header.html.erb
diff --git a/actionpack/test/fixtures/digestor/messages/_message.html.erb b/actionpack/test/fixtures/digestor/messages/_message.html.erb
new file mode 100644
index 0000000000..406a0fb848
--- /dev/null
+++ b/actionpack/test/fixtures/digestor/messages/_message.html.erb
@@ -0,0 +1 @@
+THIS BE WHERE THEM MESSAGE GO, YO!
\ No newline at end of file
diff --git a/actionpack/test/fixtures/digestor/messages/actions/_move.html.erb b/actionpack/test/fixtures/digestor/messages/actions/_move.html.erb
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/actionpack/test/fixtures/digestor/messages/actions/_move.html.erb
diff --git a/actionpack/test/fixtures/digestor/messages/index.html.erb b/actionpack/test/fixtures/digestor/messages/index.html.erb
new file mode 100644
index 0000000000..1937b652e4
--- /dev/null
+++ b/actionpack/test/fixtures/digestor/messages/index.html.erb
@@ -0,0 +1,2 @@
+<%= render @messages %>
+<%= render @events %>
diff --git a/actionpack/test/fixtures/digestor/messages/show.html.erb b/actionpack/test/fixtures/digestor/messages/show.html.erb
new file mode 100644
index 0000000000..9f73345a9f
--- /dev/null
+++ b/actionpack/test/fixtures/digestor/messages/show.html.erb
@@ -0,0 +1,9 @@
+<%# Template Dependency: messages/message %>
+<%= render "header" %>
+<%= render "comments/comments" %>
+
+<%= render "messages/actions/move" %>
+
+<%= render @message.history.events %>
+
+<%# render "something_missing"  %>
\ No newline at end of file
diff --git a/actionpack/test/template/digestor_test.rb b/actionpack/test/template/digestor_test.rb
new file mode 100644
index 0000000000..067ab500f5
--- /dev/null
+++ b/actionpack/test/template/digestor_test.rb
@@ -0,0 +1,128 @@
+require 'abstract_unit'
+require 'fileutils'
+
+class FixtureTemplate
+  attr_reader :source
+  
+  def initialize(template_path)
+    @source = File.read(template_path)
+  rescue Errno::ENOENT
+    raise ActionView::MissingTemplate.new([], "", [], true, [])
+  end
+end
+
+class FixtureFinder
+  FIXTURES_DIR = "#{File.dirname(__FILE__)}/../fixtures/digestor"
+  TMP_DIR      = "#{File.dirname(__FILE__)}/../tmp"
+  
+  def find(logical_name, keys, partial, options)
+    FixtureTemplate.new("#{TMP_DIR}/#{partial ? logical_name.gsub(%r|/([^/]+)$|, '/_\1') : logical_name}.#{options[:formats].first}.erb")
+  end
+end
+
+class TemplateDigestorTest < ActionView::TestCase
+  def setup
+    FileUtils.cp_r FixtureFinder::FIXTURES_DIR, FixtureFinder::TMP_DIR
+  end
+  
+  def teardown
+    FileUtils.rm_r FixtureFinder::TMP_DIR
+    ActionView::Digestor.cache.clear
+  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_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_logging_of_missing_template
+    assert_logged "Couldn't find template for digesting: messages/something_missing.html" do
+      digest("messages/show")
+    end
+  end
+
+  def test_nested_template_directory
+    assert_digest_difference("messages/show") do
+      change_template("messages/actions/_move")
+    end
+  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
+
+
+  private
+    def assert_logged(message)
+      log = StringIO.new
+      ActionView::Digestor.logger = Logger.new(log)
+
+      yield
+      
+      log.rewind
+      assert_match message, log.read
+      
+      ActionView::Digestor.logger = nil
+    end
+
+    def assert_digest_difference(template_name)
+      previous_digest = digest(template_name)
+      ActionView::Digestor.cache.clear
+
+      yield
+
+      assert previous_digest != digest(template_name), "digest didn't change"
+      ActionView::Digestor.cache.clear
+    end
+  
+    def digest(template_name)
+      ActionView::Digestor.digest(template_name, :html, FixtureFinder.new)
+    end
+    
+    def change_template(template_name)
+      File.open("#{FixtureFinder::TMP_DIR}/#{template_name}.html.erb", "w") do |f|
+        f.write "\nTHIS WAS CHANGED!"
+      end
+    end
+end