ActionItem955: added cache to blocks and friends listing

* basic implementation of cache in blocks * fixed the timed cache plugin * polished the cache timeouts * expiring cache for recent documents and blog archive blocks * minor performace improvement * fixed expiring cache of articles

ActionItem955: added cache to blocks and friends listing
* basic implementation of cache in blocks * fixed the timed cache plugin * polished the cache timeouts * expiring cache for recent documents and blog archive blocks * minor performace improvement * fixed expiring cache of articles
Moises Machado · Antonio Terceiro
1 parent a5acd408
Showing 20 changed files with 103 additions and 15 deletions Show diff stats
app/controllers/box_organizer_controller.rb
app/controllers/my_profile/cms_controller.rb
app/controllers/my_profile/friends_controller.rb
app/controllers/public/home_controller.rb
app/helpers/boxes_helper.rb
app/models/article.rb
app/models/block.rb
app/models/login_block.rb
app/models/main_block.rb
app/models/my_network_block.rb
app/models/profile.rb
app/models/profile_image_block.rb
app/models/profile_info_block.rb
app/models/recent_documents_block.rb
app/models/tags_block.rb
app/views/content_viewer/view_page.rhtml
app/views/profile/friends.rhtml
app/views/shared/block.rhtml
test/unit/block_test.rb
vendor/plugins/timed_cached_fragment/lib/timed_cache_fragment.rb
@@ -80,6 +80,7 @@ class BoxOrganizerController &lt; ApplicationController
   def save
     @block = boxes_holder.blocks.find(params[:id])
     @block.update_attributes(params[:block])
+    expire_timeout_fragment(@block.cache_keys)
     redirect_to :action => 'index'
   end
@@ -90,6 +91,7 @@ class BoxOrganizerController &lt; ApplicationController
   def remove
     @block = Block.find(params[:id])
     if @block.destroy
+      expire_timeout_fragment(@block.cache_keys)
       redirect_to :action => 'index'
     else
       flash[:notice] = _('Failed to remove block')
@@ -67,6 +67,7 @@ class CmsController &lt; MyProfileController
     if request.post?
       @article.last_changed_by = user
       if @article.update_attributes(params[:article])
+        expire_caches(@article)
         redirect_back
         return
       end
@@ -113,6 +114,7 @@ class CmsController &lt; MyProfileController
     @article.last_changed_by = user
     if request.post?
       if @article.save
+        expire_caches(@article)
         redirect_back
         return
       end
@@ -158,6 +160,7 @@ class CmsController &lt; MyProfileController
   def destroy
     @article = profile.articles.find(params[:id])
     if request.post?
+      expire_caches(@article)
       @article.destroy
       redirect_to :action => (@article.parent ? 'view' : 'index'), :id => @article.parent
     end
@@ -249,5 +252,11 @@ class CmsController &lt; MyProfileController
     end
   end
+  def expire_caches(article)
+    article.hierarchy.each {|a| expire_fragment(/#{a.cache_key}/) }
+    blocks = article.profile.blocks.select{|b|[RecentDocumentsBlock, BlogArchivesBlock].any?{|c| b.kind_of?(c)}}
+    blocks.map(&:cache_keys).each{|ck|expire_timeout_fragment(ck)}
+  end
+
 end
@@ -23,6 +23,7 @@ class FriendsController &lt; MyProfileController
   def remove
     @friend = profile.friends.find(params[:id])
     if request.post? && params[:confirmation]
+      expire_fragment(:action => 'friends', :controller => 'profile', :profile => profile.identifier)
       profile.remove_friend(@friend)
       redirect_to :action => 'index'
     end
 class HomeController < PublicController
   def index
-    @articles = environment.recent_documents(10)
   end
 end
@@ -55,6 +55,14 @@ module BoxesHelper
   end
   def display_block(block, main_content = nil)
+    render :file => 'shared/block', :locals => {:block => block, :main_content => main_content, :use_cache => use_cache? }
+  end
+
+  def use_cache?
+    box_decorator == DontMoveBlocks
+  end
+
+  def display_block_content(block, main_content = nil)
     content = block.main? ? main_content : block.content
     result = extract_block_content(content)
     footer_content = extract_block_content(block.footer)
@@ -189,12 +197,13 @@ module BoxesHelper
   end
   def current_blocks
-    @controller.boxes_holder.boxes.map(&:blocks).flatten
+    @controller.boxes_holder.boxes.map(&:blocks).inject([]){|ac, a| ac + a}
   end
   def import_blocks_stylesheets
-    stylesheet_import( current_blocks.map{|b|'blocks/' + b.css_class_name}.uniq ) + "\n" +
-    stylesheet_import( current_blocks.map{|b|'blocks/' + b.css_class_name}.uniq, :themed_source => true )
+    blocks_css_files = current_blocks.map{|b|'blocks/' + b.css_class_name}.uniq
+    stylesheet_import(blocks_css_files) + "\n" +
+    stylesheet_import(blocks_css_files, :themed_source => true )
   end
 end
@@ -171,11 +171,11 @@ class Article &lt; ActiveRecord::Base
   end
   def url
-    self.profile.url.merge(:page => path.split('/'))
+    @url ||= self.profile.url.merge(:page => path.split('/'))
   end
   def view_url
-    image? ? url.merge(:view => true) : url
+    @view_url ||= image? ? url.merge(:view => true) : url
   end
   def allow_children?
@@ -254,6 +254,10 @@ class Article &lt; ActiveRecord::Base
       profile
   end
+  def cache_key
+    "article-id-#{id}"
+  end
+
   private
   def sanitize_tag_list
@@ -86,4 +86,16 @@ class Block &lt; ActiveRecord::Base
     end
   end
+  def cacheable?
+    true
+  end
+
+  def cache_keys
+    "block-id-#{id}"
+  end
+
+  def timeout
+    4.hours
+  end
+
 end
@@ -18,4 +18,8 @@ class LoginBlock &lt; Block
     end
   end
+  def cacheable?
+    false
+  end
+
 end
@@ -20,4 +20,8 @@ class MainBlock &lt; Block
     false
   end
+  def cacheable?
+   false
+  end
+
 end
@@ -24,4 +24,8 @@ class MyNetworkBlock &lt; Block
     end
   end
+  def cacheable?
+    false
+  end
+
 end
@@ -326,7 +326,7 @@ class Profile &lt; ActiveRecord::Base
   end
   def url
-    if self.domains.empty?
+    @url ||= if self.domains.empty?
       generate_url(:controller => 'content_viewer', :action => 'view_page', :page => [])
     else
       Noosfero.url_options.merge({ :host => self.domains.first.name, :controller => 'content_viewer', :action => 'view_page', :page => []})
@@ -19,4 +19,8 @@ class ProfileImageBlock &lt; Block
     false
   end
+  def cacheable?
+    false
+  end
+
 end
@@ -19,4 +19,8 @@ class ProfileInfoBlock &lt; Block
     false
   end
+  def cacheable?
+    false
+  end
+
 end
@@ -32,4 +32,8 @@ class RecentDocumentsBlock &lt; Block
     end
   end
+  def timeout
+    2.months
+  end
+
 end
@@ -29,4 +29,8 @@ class TagsBlock &lt; Block
     "\n</div><!-- end class='tag_cloud' -->\n";
   end
+  def timeout
+    15.minutes
+  end
+
 end
@@ -83,10 +83,12 @@
   </div>
 <% end %>
-<div class="<%="article-body article-body-" + @page.css_class_name %>">
-  <%= article_to_html(@page) %>
-  <br style="clear:both" />
-</div> <!-- end class="article-body" -->
+<% cache(@page.cache_key) do %>
+  <div class="<%="article-body article-body-" + @page.css_class_name %>">
+    <%= article_to_html(@page) %>
+    <br style="clear:both" />
+  </div> <!-- end class="article-body" -->
+<% end %>
 <% if ! @page.categories.empty? %>
 <div id="article-cat">
@@ -3,11 +3,13 @@
 <h1><%= __("%s's friends") % profile.name %></h1>
+<% cache do%>
 <ul class='profile-list'>
   <% @friends.each do |friend| %>
     <li><%= profile_image_link(friend) %></li>
   <% end%>
 </ul>
+<% end %>
 <% button_bar do %>
   <% if user == profile %>
@@ -0,0 +1,7 @@
+<% if block.cacheable? && use_cache %>
+  <% cache_timeout(block.cache_keys, block.timeout.from_now) do %>
+    <%= display_block_content(block, main_content) %>
+  <% end %>
+<% else %>
+  <%= display_block_content(block, main_content) %>
+<% end %>
@@ -54,4 +54,17 @@ class BlockTest &lt; Test::Unit::TestCase
     assert !b.visible?
   end
+  should 'be cacheable' do
+    b = Block.new
+    assert b.cacheable?
+  end
+
+  should 'provide chache keys' do
+     p = create_user('test_user').person
+     box = p.boxes[0]
+     b = Block.create!(:box => box)
+
+     assert_equal( "block-id-#{b.id}", b.cache_keys)
+  end
+
 end
@@ -17,12 +17,12 @@ module ActionController
       #handles the expiration of timeout fragment
       def expire_timeout_fragment(key)
         @@cache_timeout_values[key] = nil
-        expire_fragment(key)
+        expire_fragment(/#{key}/)
       end
       #checks to see if a cache has fully expired
       def is_cache_expired?(name, is_key = false)
-        key = is_key ? fragment_cache_key(name) : name
-        return (!@@cache_timeout_values.has_key?(key)) || (@@cache_timeout_values[key] < Time.now)
+        key = is_key ? name : fragment_cache_key(name)
+        return (!@@cache_timeout_values[key]) || (@@cache_timeout_values[key] < Time.now)
       end
     end
   end
@@ -46,4 +46,4 @@ end
 #add to the respective controllers
 ActionView::Base.send(:include, ActionView::Helpers::TimedCacheHelper)
-ActionController::Base.send(:include, ActionController::Cache::TimedCache)
 \ No newline at end of file
+ActionController::Base.send(:include, ActionController::Cache::TimedCache)
1	class HomeController < PublicController	1	class HomeController < PublicController
2		2
3	def index	3	def index
4	- @articles = environment.recent_documents(10)
5	end	4	end
6		5
7	end	6	end
	@@ -86,4 +86,16 @@ class Block < ActiveRecord::Base		@@ -86,4 +86,16 @@ class Block < ActiveRecord::Base
86	end	86	end
87	end	87	end
88		88
		89	+ def cacheable?
		90	+ true
		91	+ end
		92	+
		93	+ def cache_keys
		94	+ "block-id-#{id}"
		95	+ end
		96	+
		97	+ def timeout
		98	+ 4.hours
		99	+ end
		100	+
89	end	101	end
	@@ -18,4 +18,8 @@ class LoginBlock < Block		@@ -18,4 +18,8 @@ class LoginBlock < Block
18	end	18	end
19	end	19	end
20		20
		21	+ def cacheable?
		22	+ false
		23	+ end
		24	+
21	end	25	end
	@@ -20,4 +20,8 @@ class MainBlock < Block		@@ -20,4 +20,8 @@ class MainBlock < Block
20	false	20	false
21	end	21	end
22		22
		23	+ def cacheable?
		24	+ false
		25	+ end
		26	+
23	end	27	end
	@@ -24,4 +24,8 @@ class MyNetworkBlock < Block		@@ -24,4 +24,8 @@ class MyNetworkBlock < Block
24	end	24	end
25	end	25	end
26		26
		27	+ def cacheable?
		28	+ false
		29	+ end
		30	+
27	end	31	end
	@@ -326,7 +326,7 @@ class Profile < ActiveRecord::Base		@@ -326,7 +326,7 @@ class Profile < ActiveRecord::Base
326	end	326	end
327		327
328	def url	328	def url
329	- if self.domains.empty?	329	+ @url \|\|= if self.domains.empty?
330	generate_url(:controller => 'content_viewer', :action => 'view_page', :page => [])	330	generate_url(:controller => 'content_viewer', :action => 'view_page', :page => [])
331	else	331	else
332	Noosfero.url_options.merge({ :host => self.domains.first.name, :controller => 'content_viewer', :action => 'view_page', :page => []})	332	Noosfero.url_options.merge({ :host => self.domains.first.name, :controller => 'content_viewer', :action => 'view_page', :page => []})
	@@ -19,4 +19,8 @@ class ProfileImageBlock < Block		@@ -19,4 +19,8 @@ class ProfileImageBlock < Block
19	false	19	false
20	end	20	end
21		21
		22	+ def cacheable?
		23	+ false
		24	+ end
		25	+
22	end	26	end
	@@ -19,4 +19,8 @@ class ProfileInfoBlock < Block		@@ -19,4 +19,8 @@ class ProfileInfoBlock < Block
19	false	19	false
20	end	20	end
21		21
		22	+ def cacheable?
		23	+ false
		24	+ end
		25	+
22	end	26	end
	@@ -32,4 +32,8 @@ class RecentDocumentsBlock < Block		@@ -32,4 +32,8 @@ class RecentDocumentsBlock < Block
32	end	32	end
33	end	33	end
34		34
		35	+ def timeout
		36	+ 2.months
		37	+ end
		38	+
35	end	39	end
	@@ -29,4 +29,8 @@ class TagsBlock < Block		@@ -29,4 +29,8 @@ class TagsBlock < Block
29	"\n</div><!-- end class='tag_cloud' -->\n";	29	"\n</div><!-- end class='tag_cloud' -->\n";
30	end	30	end
31		31
		32	+ def timeout
		33	+ 15.minutes
		34	+ end
		35	+
32	end	36	end