Remove timed_cached_fragment plugin

In Rails 2.3 the memcache driver already supports adding timeout to cache keys.

Remove timed_cached_fragment plugin
In Rails 2.3 the memcache driver already supports adding timeout to cache keys.
Antonio Terceiro
1 parent 01946cfc
Showing 21 changed files with 16 additions and 156 deletions Show diff stats
app/helpers/application_helper.rb
app/helpers/sweeper_helper.rb
app/views/friends/index.rhtml
app/views/profile/_common.rhtml
app/views/profile/_person_profile.rhtml
app/views/profile/communities.rhtml
app/views/profile/content_tagged.rhtml
app/views/profile/friends.rhtml
app/views/profile/members.rhtml
app/views/profile/tags.rhtml
app/views/search/tag.rhtml
app/views/search/tags.rhtml
app/views/shared/block.rhtml
vendor/plugins/timed_cached_fragment/README
vendor/plugins/timed_cached_fragment/Rakefile
vendor/plugins/timed_cached_fragment/init.rb
vendor/plugins/timed_cached_fragment/install.rb
vendor/plugins/timed_cached_fragment/lib/timed_cache_fragment.rb
vendor/plugins/timed_cached_fragment/tasks/timed_cache_fragment_tasks.rake
vendor/plugins/timed_cached_fragment/test/timed_cache_fragment_test.rb
@@ -1310,4 +1310,8 @@ module ApplicationHelper
       ) + content_tag('span', ' | ', :class => 'comment-footer comment-footer-hide')
     end
   end
+
+  def cache_timeout(key, timeout, &block)
+    cache(key, { :expires_in => timeout }, &block)
+  end
 end
@@ -4,9 +4,7 @@ module SweeperHelper
     ActionController::Base.new().expire_fragment(*args)
   end
-  def expire_timeout_fragment(*args)
-    ActionController::Base.new().expire_timeout_fragment(*args)
-  end
+  alias :expire_timeout_fragment :expire_fragment
   def expire_friends(profile)
     # public friends page
@@ -2,7 +2,7 @@
 <h1><%= __("%s's friends") % profile.name %></h1>
-<% cache_timeout(profile.manage_friends_cache_key(params), 4.hours.from_now) do %>
+<% cache_timeout(profile.manage_friends_cache_key(params), 4.hours) do %>
   <% if @friends.empty? %>
   <p>
   <em>
@@ -9,7 +9,7 @@
 </script>
 <% unless @action %>
-  <% cache_timeout(profile.cache_key + '-profile-general-info', 4.hours.from_now) do %>
+  <% cache_timeout(profile.cache_key + '-profile-general-info', 4.hours) do %>
     <tr>
       <th colspan='2'>
         <%= _('Content') %>
@@ -23,7 +23,7 @@
     <%= display_field(_('e-Mail:'), profile, :email, true) { |email| link_to_email(email) } %>
   <% end %>
-  <% cache_timeout(profile.relationships_cache_key, 4.hours.from_now) do %>
+  <% cache_timeout(profile.relationships_cache_key, 4.hours) do %>
     <% if !(profile.organization.blank? && profile.organization_website.blank?) && (profile.active_fields.include?('organization') || profile.active_fields.include?('organization_website')) %>
       <tr>
         <th colspan='2'><%= _('Work')%></th>
@@ -2,7 +2,7 @@
 <h1><%= _("%s's communities") % profile.name %></h1>
-<% cache_timeout(profile.communities_cache_key(params), 4.hour.from_now) do %>
+<% cache_timeout(profile.communities_cache_key(params), 4.hour) do %>
   <ul class='profile-list'>
   <% @communities.each do |community| %>
     <li><%= profile_image_link(community)%></li>
@@ -6,7 +6,7 @@
 <%= link_to image_tag('icons-mime/rss-feed.png', :alt => _('Feed for this tag'), :title => _('Feed for this tag')), tag_feed_path, :class => 'blog-feed-link'%>
 </p>
-<% cache_timeout(@tag_cache_key, 4.hour.from_now) do %>
+<% cache_timeout(@tag_cache_key, 4.hour) do %>
   <div class='search-tagged-items'>
     <ul>
     <% for doc in @tagged %>
@@ -2,7 +2,7 @@
 <h1><%= __("%s's friends") % profile.name %></h1>
-<% cache_timeout(profile.friends_cache_key(params), 4.hours.from_now) do %>
+<% cache_timeout(profile.friends_cache_key(params), 4.hours) do %>
 <ul class='profile-list'>
   <% @friends.each do |friend| %>
     <%= profile_image_link(friend) %>
@@ -2,7 +2,7 @@
 <h1><%= _("%s's members") % profile.name %></h1>
-<% cache_timeout(profile.members_cache_key(params), 4.hours.from_now) do %>
+<% cache_timeout(profile.members_cache_key(params), 4.hours) do %>
   <ul class='profile-list'>
     <% @members.each do |member| %>
       <%= profile_image_link(member) %>
 <h1><%= _("%s's tags") % @profile.name %></h1>
 <div class='tag_cloud'>
-<% cache_timeout(@tags_cache_key, 4.hour.from_now) do %>
+<% cache_timeout(@tags_cache_key, 4.hour) do %>
   <%= tag_cloud @tags, :id, { :action => :tags }, {:show_count => true} %>
 <% end %>
 </div>
@@ -6,7 +6,7 @@
   <%= button('back', _('Back to tag cloud'), :action => 'tags') %>
 <% end %>
-<% cache_timeout(@tag_cache_key, 4.hour.from_now) do %>
+<% cache_timeout(@tag_cache_key, 4.hour) do %>
   <div class='search-tagged-items'>
   <% @tagged.each do |hit| %>
     <ul class="clean-list">
 <h1><%= _('Tag cloud') %></h1>
 <div class='tag_cloud'>
-<% cache_timeout(@tags_cache_key, 4.hour.from_now) do %>
+<% cache_timeout(@tags_cache_key, 4.hour) do %>
   <%= tag_cloud @tags, :tag, {:action => 'tag'}, {:show_count => true} %>
 <% end %>
 </div>
 <% if block.cacheable? && use_cache %>
-  <% cache_timeout(block.cache_key, block.timeout.from_now) do %>
+  <% cache_timeout(block.cache_key, block.timeout) do %>
     <%= display_block_content(block, main_content) %>
   <% end %>
 <% else %>
@@ -1,29 +0,0 @@
-TimedCacheFragment
-==================
-
-In Rails, caching is one of those things that is made pretty easy, but can also be difficult when you want to do complex tasks with the caching -- such as expiring it. There are two ways with expire_fragment within the logic of your controllers or using an Observers.
-
-This plugin allows caching to be expired on predefined time limit. The idea is that the caching takes cared of the expiration instead of writing conditions in the controller. I understand that it goes against the idea of why the caching mechanism does not have them now.
-
-To the plugin. Its an extension of cache method that has logic for the time limit. The method to use within views is called cache_timeout. The first argument of the method is the regular Hash/String of the cache key and the second argument is the timeout value (being a Time class value).
-
-Example usage:
-
-# This is last 5 minutes of posts from our forums:  
- <%cache_timeout('forum_listing',5.minutes.from_now) do %>  
- <ul>  
-    <% for post in @posts %>  
-    <li><b><%=post.title%></b> - by <%=post.author.username%> at <%=post.created_at></p></li>  
-    <%end%>  
- </ul>  
- <%end%>
-
-To enforce the timeout cache value within the controller don't use the read_fragment method -- unless really needed. The method that is provided to check that the timeout value has is expired is is_cache_expired?. The method takes the argument of the cache key.
-
-Example Usage within controller:
-
-def list
-	if is_cache_expired?('forum_listing')
-		@posts = Post.find(:all)
-	end
-end
 \ No newline at end of file
@@ -1,22 +0,0 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the timed_cache_fragment plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the timed_cache_fragment plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'TimedCacheFragment'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
@@ -1,2 +0,0 @@
-# Include hook code here
-require 'timed_cache_fragment'
 \ No newline at end of file
@@ -1 +0,0 @@
-# Install hook code here
@@ -1,75 +0,0 @@
-# TimedCacheFragment
-module ActionController
-  module Cache
-    module TimedCache
-      #handles standard ERB fragments used in RHTML
-      def cache_timeout(key={}, expire = 10.minutes.from_now, &block)
-        unless perform_caching then block.call; return end
-        if is_cache_expired?(key,true)
-          expire_timeout_fragment(key)
-          set_timeout(key, expire)
-        end
-        cache_erb_fragment(block,key)
-      end
-      #handles the expiration of timeout fragment
-      def expire_timeout_fragment(key)
-        delete_timeout(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 ? name : fragment_cache_key(name)
-        return true unless read_fragment(key)
-        timeout = get_timeout(key)
-        return (!timeout) || (timeout < Time.now)
-      end
-
-      # from http://code.google.com/p/timedcachedfragment/issues/detail?id=1
-      def cache_erb_fragment(block, name = {}, options = nil)
-        unless perform_caching then block.call; return end
-
-        buffer = eval(ActionView::Base.erb_variable, block.binding)
-
-        if cache = read_fragment(name, options)
-          buffer.concat(cache)
-        else
-          pos = buffer.length
-          block.call
-          write_fragment(name, buffer[pos..-1], options)
-        end
-      end
-
-      def delete_timeout(key)
-        expire_fragment('timeout:' + key)
-      end
-      def get_timeout(key)
-        frag = read_fragment('timeout:' + key)
-        frag ? frag.to_time : nil
-      end
-      def set_timeout(key, value)
-        write_fragment('timeout:' + key, value)
-      end
-
-    end
-  end
-end
-
-
-module ActionView
-  module Helpers
-    module TimedCacheHelper
-      def is_cache_expired?(name = nil)
-        return false if name.nil?
-        key = fragment_cache_key(name)
-        return @controller.send('is_cache_expired?', key)
-      end
-      def cache_timeout(name,expire=10.minutes.from_now, &block)
-        @controller.cache_timeout(name,expire,&block)
-      end
-    end
-  end
-end
-
-#add to the respective controllers
-ActionView::Base.send(:include, ActionView::Helpers::TimedCacheHelper)
-ActionController::Base.send(:include, ActionController::Cache::TimedCache)
@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :timed_cache_fragment do
-#   # Task goes here
-# end
 \ No newline at end of file
@@ -1,8 +0,0 @@
-require 'test/unit'
-
-class TimedCacheFragmentTest < Test::Unit::TestCase
-  # Replace this with your real tests.
-  def test_this_plugin
-    flunk
-  end
-end
@@ -1 +0,0 @@
-# Uninstall hook code here
	@@ -1310,4 +1310,8 @@ module ApplicationHelper		@@ -1310,4 +1310,8 @@ module ApplicationHelper
1310	) + content_tag('span', ' \| ', :class => 'comment-footer comment-footer-hide')	1310	) + content_tag('span', ' \| ', :class => 'comment-footer comment-footer-hide')
1311	end	1311	end
1312	end	1312	end
		1313	+
		1314	+ def cache_timeout(key, timeout, &block)
		1315	+ cache(key, { :expires_in => timeout }, &block)
		1316	+ end
1313	end	1317	end
	@@ -2,7 +2,7 @@		@@ -2,7 +2,7 @@
2		2
3	<h1><%= __("%s's friends") % profile.name %></h1>	3	<h1><%= __("%s's friends") % profile.name %></h1>
4		4
5	-<% cache_timeout(profile.manage_friends_cache_key(params), 4.hours.from_now) do %>	5	+<% cache_timeout(profile.manage_friends_cache_key(params), 4.hours) do %>
6	<% if @friends.empty? %>	6	<% if @friends.empty? %>
7	<p>	7	<p>
8	<em>	8	<em>
	@@ -9,7 +9,7 @@		@@ -9,7 +9,7 @@
9	</script>	9	</script>
10		10
11	<% unless @action %>	11	<% unless @action %>
12	- <% cache_timeout(profile.cache_key + '-profile-general-info', 4.hours.from_now) do %>	12	+ <% cache_timeout(profile.cache_key + '-profile-general-info', 4.hours) do %>
13	<tr>	13	<tr>
14	<th colspan='2'>	14	<th colspan='2'>
15	<%= _('Content') %>	15	<%= _('Content') %>
	@@ -23,7 +23,7 @@		@@ -23,7 +23,7 @@
23	<%= display_field(_('e-Mail:'), profile, :email, true) { \|email\| link_to_email(email) } %>	23	<%= display_field(_('e-Mail:'), profile, :email, true) { \|email\| link_to_email(email) } %>
24	<% end %>	24	<% end %>
25		25
26	- <% cache_timeout(profile.relationships_cache_key, 4.hours.from_now) do %>	26	+ <% cache_timeout(profile.relationships_cache_key, 4.hours) do %>
27	<% if !(profile.organization.blank? && profile.organization_website.blank?) && (profile.active_fields.include?('organization') \|\| profile.active_fields.include?('organization_website')) %>	27	<% if !(profile.organization.blank? && profile.organization_website.blank?) && (profile.active_fields.include?('organization') \|\| profile.active_fields.include?('organization_website')) %>
28	<tr>	28	<tr>
29	<th colspan='2'><%= _('Work')%></th>	29	<th colspan='2'><%= _('Work')%></th>
	@@ -2,7 +2,7 @@		@@ -2,7 +2,7 @@
2		2
3	<h1><%= _("%s's communities") % profile.name %></h1>	3	<h1><%= _("%s's communities") % profile.name %></h1>
4		4
5	-<% cache_timeout(profile.communities_cache_key(params), 4.hour.from_now) do %>	5	+<% cache_timeout(profile.communities_cache_key(params), 4.hour) do %>
6	<ul class='profile-list'>	6	<ul class='profile-list'>
7	<% @communities.each do \|community\| %>	7	<% @communities.each do \|community\| %>
8	<li><%= profile_image_link(community)%></li>	8	<li><%= profile_image_link(community)%></li>
	@@ -6,7 +6,7 @@		@@ -6,7 +6,7 @@
6	<%= link_to image_tag('icons-mime/rss-feed.png', :alt => _('Feed for this tag'), :title => _('Feed for this tag')), tag_feed_path, :class => 'blog-feed-link'%>	6	<%= link_to image_tag('icons-mime/rss-feed.png', :alt => _('Feed for this tag'), :title => _('Feed for this tag')), tag_feed_path, :class => 'blog-feed-link'%>
7	</p>	7	</p>
8		8
9	-<% cache_timeout(@tag_cache_key, 4.hour.from_now) do %>	9	+<% cache_timeout(@tag_cache_key, 4.hour) do %>
10	<div class='search-tagged-items'>	10	<div class='search-tagged-items'>
11	<ul>	11	<ul>
12	<% for doc in @tagged %>	12	<% for doc in @tagged %>
	@@ -2,7 +2,7 @@		@@ -2,7 +2,7 @@
2		2
3	<h1><%= _("%s's members") % profile.name %></h1>	3	<h1><%= _("%s's members") % profile.name %></h1>
4		4
5	-<% cache_timeout(profile.members_cache_key(params), 4.hours.from_now) do %>	5	+<% cache_timeout(profile.members_cache_key(params), 4.hours) do %>
6	<ul class='profile-list'>	6	<ul class='profile-list'>
7	<% @members.each do \|member\| %>	7	<% @members.each do \|member\| %>
8	<%= profile_image_link(member) %>	8	<%= profile_image_link(member) %>
1	<h1><%= _("%s's tags") % @profile.name %></h1>	1	<h1><%= _("%s's tags") % @profile.name %></h1>
2		2
3	<div class='tag_cloud'>	3	<div class='tag_cloud'>
4	-<% cache_timeout(@tags_cache_key, 4.hour.from_now) do %>	4	+<% cache_timeout(@tags_cache_key, 4.hour) do %>
5	<%= tag_cloud @tags, :id, { :action => :tags }, {:show_count => true} %>	5	<%= tag_cloud @tags, :id, { :action => :tags }, {:show_count => true} %>
6	<% end %>	6	<% end %>
7	</div>	7	</div>
	@@ -6,7 +6,7 @@		@@ -6,7 +6,7 @@
6	<%= button('back', _('Back to tag cloud'), :action => 'tags') %>	6	<%= button('back', _('Back to tag cloud'), :action => 'tags') %>
7	<% end %>	7	<% end %>
8		8
9	-<% cache_timeout(@tag_cache_key, 4.hour.from_now) do %>	9	+<% cache_timeout(@tag_cache_key, 4.hour) do %>
10	<div class='search-tagged-items'>	10	<div class='search-tagged-items'>
11	<% @tagged.each do \|hit\| %>	11	<% @tagged.each do \|hit\| %>
12	<ul class="clean-list">	12	<ul class="clean-list">
1	<h1><%= _('Tag cloud') %></h1>	1	<h1><%= _('Tag cloud') %></h1>
2		2
3	<div class='tag_cloud'>	3	<div class='tag_cloud'>
4	-<% cache_timeout(@tags_cache_key, 4.hour.from_now) do %>	4	+<% cache_timeout(@tags_cache_key, 4.hour) do %>
5	<%= tag_cloud @tags, :tag, {:action => 'tag'}, {:show_count => true} %>	5	<%= tag_cloud @tags, :tag, {:action => 'tag'}, {:show_count => true} %>
6	<% end %>	6	<% end %>
7	</div>	7	</div>