ActionItem955: included plugin for timed cache

Moises Machado · Antonio Terceiro
1 parent 3d4039f4
Showing 8 changed files with 116 additions and 0 deletions Show diff stats
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
vendor/plugins/timed_cached_fragment/uninstall.rb
@@ -0,0 +1,29 @@
+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
@@ -0,0 +1,22 @@
+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
@@ -0,0 +1,2 @@
+# Include hook code here
+require 'timed_cache_fragment'
 \ No newline at end of file
@@ -0,0 +1 @@
+# Install hook code here
@@ -0,0 +1,49 @@
+# TimedCacheFragment
+module ActionController
+  module Cache
+    module TimedCache
+      #used to store the associated timeout time of cache key
+      @@cache_timeout_values = {}
+      #handles standard ERB fragments used in RHTML
+      def cache_timeout(name={}, expire = 10.minutes.from_now, &block)
+        unless perform_caching then block.call; return end
+        key = fragment_cache_key(name)
+        if is_cache_expired?(key,true)
+          expire_timeout_fragment(key)
+          @@cache_timeout_values[key] = expire
+        end
+        cache_erb_fragment(block,name)
+      end
+      #handles the expiration of timeout fragment
+      def expire_timeout_fragment(key)
+        @@cache_timeout_values[key] = nil
+        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)
+      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)
 \ No newline at end of file
@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :timed_cache_fragment do
+#   # Task goes here
+# end
 \ No newline at end of file
@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class TimedCacheFragmentTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end
@@ -0,0 +1 @@
+# Uninstall hook code here
...	...	@@ -0,0 +1,29 @@
	1	+TimedCacheFragment
	2	+==================
	3	+
	4	+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.
	5	+
	6	+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.
	7	+
	8	+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).
	9	+
	10	+Example usage:
	11	+
	12	+# This is last 5 minutes of posts from our forums:
	13	+ <%cache_timeout('forum_listing',5.minutes.from_now) do %>
	14	+ <ul>
	15	+ <% for post in @posts %>
	16	+ <li><b><%=post.title%></b> - by <%=post.author.username%> at <%=post.created_at></p></li>
	17	+ <%end%>
	18	+ </ul>
	19	+ <%end%>
	20	+
	21	+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.
	22	+
	23	+Example Usage within controller:
	24	+
	25	+def list
	26	+ if is_cache_expired?('forum_listing')
	27	+ @posts = Post.find(:all)
	28	+ end
	29	+end
0	30	\ No newline at end of file
...	...
...	...	@@ -0,0 +1,22 @@
	1	+require 'rake'
	2	+require 'rake/testtask'
	3	+require 'rake/rdoctask'
	4	+
	5	+desc 'Default: run unit tests.'
	6	+task :default => :test
	7	+
	8	+desc 'Test the timed_cache_fragment plugin.'
	9	+Rake::TestTask.new(:test) do \|t\|
	10	+ t.libs << 'lib'
	11	+ t.pattern = 'test/*/_test.rb'
	12	+ t.verbose = true
	13	+end
	14	+
	15	+desc 'Generate documentation for the timed_cache_fragment plugin.'
	16	+Rake::RDocTask.new(:rdoc) do \|rdoc\|
	17	+ rdoc.rdoc_dir = 'rdoc'
	18	+ rdoc.title = 'TimedCacheFragment'
	19	+ rdoc.options << '--line-numbers' << '--inline-source'
	20	+ rdoc.rdoc_files.include('README')
	21	+ rdoc.rdoc_files.include('lib/*/.rb')
	22	+end
...	...
...	...	@@ -0,0 +1,2 @@
	1	+# Include hook code here
	2	+require 'timed_cache_fragment'
0	3	\ No newline at end of file
...	...
...	...	@@ -0,0 +1,49 @@
	1	+# TimedCacheFragment
	2	+module ActionController
	3	+ module Cache
	4	+ module TimedCache
	5	+ #used to store the associated timeout time of cache key
	6	+ @@cache_timeout_values = {}
	7	+ #handles standard ERB fragments used in RHTML
	8	+ def cache_timeout(name={}, expire = 10.minutes.from_now, &block)
	9	+ unless perform_caching then block.call; return end
	10	+ key = fragment_cache_key(name)
	11	+ if is_cache_expired?(key,true)
	12	+ expire_timeout_fragment(key)
	13	+ @@cache_timeout_values[key] = expire
	14	+ end
	15	+ cache_erb_fragment(block,name)
	16	+ end
	17	+ #handles the expiration of timeout fragment
	18	+ def expire_timeout_fragment(key)
	19	+ @@cache_timeout_values[key] = nil
	20	+ expire_fragment(key)
	21	+ end
	22	+ #checks to see if a cache has fully expired
	23	+ def is_cache_expired?(name, is_key = false)
	24	+ key = is_key ? fragment_cache_key(name) : name
	25	+ return (!@@cache_timeout_values.has_key?(key)) \|\| (@@cache_timeout_values[key] < Time.now)
	26	+ end
	27	+ end
	28	+ end
	29	+end
	30	+
	31	+
	32	+module ActionView
	33	+ module Helpers
	34	+ module TimedCacheHelper
	35	+ def is_cache_expired?(name = nil)
	36	+ return false if name.nil?
	37	+ key = fragment_cache_key(name)
	38	+ return @controller.send('is_cache_expired?', key)
	39	+ end
	40	+ def cache_timeout(name,expire=10.minutes.from_now, &block)
	41	+ @controller.cache_timeout(name,expire,&block)
	42	+ end
	43	+ end
	44	+ end
	45	+end
	46	+
	47	+#add to the respective controllers
	48	+ActionView::Base.send(:include, ActionView::Helpers::TimedCacheHelper)
	49	+ActionController::Base.send(:include, ActionController::Cache::TimedCache)
0	50	\ No newline at end of file
...	...
...	...	@@ -0,0 +1,4 @@
	1	+# desc "Explaining what the task does"
	2	+# task :timed_cache_fragment do
	3	+# # Task goes here
	4	+# end
0	5	\ No newline at end of file
...	...
...	...	@@ -0,0 +1,8 @@
	1	+require 'test/unit'
	2	+
	3	+class TimedCacheFragmentTest < Test::Unit::TestCase
	4	+ # Replace this with your real tests.
	5	+ def test_this_plugin
	6	+ flunk
	7	+ end
	8	+end
...	...