ActionItem955: created a sweeper to observe the article model

changed the expiration of caches based on article changes to observe the model instead of being called by the cms controller so the daemon scripts that update/create/destroy articles cause the expiration of the caches too

ActionItem955: created a sweeper to observe the article model
changed the expiration of caches based on article changes to observe the model instead of being called by the cms controller so the daemon scripts that update/create/destroy articles cause the expiration of the caches too
Moises Machado · Antonio Terceiro
1 parent 229bedec
Showing 5 changed files with 47 additions and 22 deletions Show diff stats
app/controllers/my_profile/cms_controller.rb
app/sweepers/article_sweeper.rb
config/environment.rb
test/functional/profile_design_controller_test.rb
test/unit/profile_test.rb
@@ -67,7 +67,6 @@ 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
@@ -114,7 +113,6 @@ class CmsController &lt; MyProfileController
     @article.last_changed_by = user
     if request.post?
       if @article.save
-        expire_caches(@article)
         redirect_back
         return
       end
@@ -161,7 +159,6 @@ 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
@@ -252,12 +249,5 @@ class CmsController &lt; MyProfileController
       nil
     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
@@ -0,0 +1,27 @@
+class ArticleSweeper < ActiveRecord::Observer
+  observe :article
+
+  def after_save(article)
+    expire_caches(article)
+  end
+
+  def after_destroy(article)
+    expire_caches(article)
+  end
+
+protected
+
+  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
+
+  def expire_fragment(*args)
+    ActionController::Base.new().expire_fragment(*args)
+  end
+
+  def expire_timeout_fragment(*args)
+    ActionController::Base.new().expire_timeout_fragment(*args)
+  end
+end
@@ -10,6 +10,16 @@ RAILS_GEM_VERSION = &#39;2.0.2&#39; unless defined? RAILS_GEM_VERSION
 # Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')
+# locally-developed modules
+require 'gettext/rails'
+require 'acts_as_filesystem'
+require 'acts_as_having_settings'
+require 'acts_as_searchable'
+require 'acts_as_having_boxes'
+require 'acts_as_having_image'
+require 'will_paginate'
+require 'route_if'
+
 # extra directories for controllers organization 
 extra_controller_dirs = %w[
   app/controllers/my_profile
@@ -37,6 +47,7 @@ Rails::Initializer.run do |config|
   # Add additional load paths for your own custom dirs
   # config.load_paths += %W( #{RAILS_ROOT}/extras )
+  config.load_paths += %W( #{RAILS_ROOT}/app/sweepers )
   # Force all environments to use the same logger level 
   # (by default production uses :info, the others :debug)
@@ -53,6 +64,7 @@ Rails::Initializer.run do |config|
   # Activate observers that should always be running
   # config.active_record.observers = :cacher, :garbage_collector
+  config.active_record.observers = :article_sweeper
   # Make Active Record use UTC-base instead of local time
   # config.active_record.default_timezone = :utc
@@ -94,7 +106,7 @@ end
 # Include your application configuration below
-require 'gettext/rails'
+
 Noosfero.locales = {
   'en' => 'English',
   'pt_BR' => 'Português',
@@ -107,17 +119,7 @@ Tag.hierarchical = true
 # several local libraries
 require 'noosfero'
-
-# locally-developed modules
-require 'acts_as_filesystem'
-require 'acts_as_searchable'
-require 'acts_as_having_boxes'
-require 'acts_as_having_settings'
-require 'acts_as_having_image'
 require 'sqlite_extension'
-require 'will_paginate'
-
-require 'route_if'
 # load a local configuration if present, but not under test environment.
 if ENV['RAILS_ENV'] != 'test'
@@ -60,6 +60,8 @@ class ProfileDesignControllerTest &lt; Test::Unit::TestCase
     @request.env['HTTP_REFERER'] = '/editor'
+    holder.blocks(true)
+
     @controller.stubs(:boxes_holder).returns(holder)
     login_as 'designtestuser'
   end
@@ -211,6 +213,7 @@ class ProfileDesignControllerTest &lt; Test::Unit::TestCase
     enterprise.boxes.first.blocks << block
     enterprise.add_admin(holder)
+    enterprise.blocks(true)
     @controller.stubs(:boxes_holder).returns(enterprise)
     login_as('designtestuser')
@@ -230,6 +233,7 @@ class ProfileDesignControllerTest &lt; Test::Unit::TestCase
     enterprise.boxes.first.blocks << block
     enterprise.add_admin(holder)
+    enterprise.blocks(true)
     @controller.stubs(:boxes_holder).returns(enterprise)
     login_as('designtestuser')
@@ -296,6 +300,7 @@ class ProfileDesignControllerTest &lt; Test::Unit::TestCase
   should 'be able to edit FeedReaderBlock' do
     @box1.blocks << FeedReaderBlock.new(:address => 'feed address')
+    holder.blocks(true)
     get :edit, :profile => 'designtestuser', :id => @box1.blocks[-1].id
@@ -306,6 +311,7 @@ class ProfileDesignControllerTest &lt; Test::Unit::TestCase
   should 'be able to save FeedReaderBlock configurations' do
     @box1.blocks << FeedReaderBlock.new(:address => 'feed address')
+    holder.blocks(true)
     post :save, :profile => 'designtestuser', :id => @box1.blocks[-1].id, :block => {:address => 'new feed address', :limit => '20'}
@@ -239,7 +239,7 @@ class ProfileTest &lt; Test::Unit::TestCase
     profile.boxes.first.blocks << MainBlock.new
     profile_boxes = profile.boxes.size
-    profile_blocks = profile.blocks.size
+    profile_blocks = profile.blocks(true).size
     assert profile_boxes > 0, 'profile should have some boxes'
     assert profile_blocks > 0, 'profile should have some blocks'
@@ -0,0 +1,27 @@		@@ -0,0 +1,27 @@
	1	+class ArticleSweeper < ActiveRecord::Observer
	2	+ observe :article
	3	+
	4	+ def after_save(article)
	5	+ expire_caches(article)
	6	+ end
	7	+
	8	+ def after_destroy(article)
	9	+ expire_caches(article)
	10	+ end
	11	+
	12	+protected
	13	+
	14	+ def expire_caches(article)
	15	+ article.hierarchy.each {\|a\| expire_fragment(/#{a.cache_key}/) }
	16	+ blocks = article.profile.blocks.select{\|b\|[RecentDocumentsBlock, BlogArchivesBlock].any?{\|c\| b.kind_of?(c)}}
	17	+ blocks.map(&:cache_keys).each{\|ck\|expire_timeout_fragment(ck)}
	18	+ end
	19	+
	20	+ def expire_fragment(*args)
	21	+ ActionController::Base.new().expire_fragment(*args)
	22	+ end
	23	+
	24	+ def expire_timeout_fragment(*args)
	25	+ ActionController::Base.new().expire_timeout_fragment(*args)
	26	+ end
	27	+end
	@@ -10,6 +10,16 @@ RAILS_GEM_VERSION = '2.0.2' unless defined? RAILS_GEM_VERSION		@@ -10,6 +10,16 @@ RAILS_GEM_VERSION = '2.0.2' unless defined? RAILS_GEM_VERSION
10	# Bootstrap the Rails environment, frameworks, and default configuration	10	# Bootstrap the Rails environment, frameworks, and default configuration
11	require File.join(File.dirname(__FILE__), 'boot')	11	require File.join(File.dirname(__FILE__), 'boot')
12		12
		13	+# locally-developed modules
		14	+require 'gettext/rails'
		15	+require 'acts_as_filesystem'
		16	+require 'acts_as_having_settings'
		17	+require 'acts_as_searchable'
		18	+require 'acts_as_having_boxes'
		19	+require 'acts_as_having_image'
		20	+require 'will_paginate'
		21	+require 'route_if'
		22	+
13	# extra directories for controllers organization	23	# extra directories for controllers organization
14	extra_controller_dirs = %w[	24	extra_controller_dirs = %w[
15	app/controllers/my_profile	25	app/controllers/my_profile
	@@ -37,6 +47,7 @@ Rails::Initializer.run do \|config\|		@@ -37,6 +47,7 @@ Rails::Initializer.run do \|config\|
37		47
38	# Add additional load paths for your own custom dirs	48	# Add additional load paths for your own custom dirs
39	# config.load_paths += %W( #{RAILS_ROOT}/extras )	49	# config.load_paths += %W( #{RAILS_ROOT}/extras )
		50	+ config.load_paths += %W( #{RAILS_ROOT}/app/sweepers )
40		51
41	# Force all environments to use the same logger level	52	# Force all environments to use the same logger level
42	# (by default production uses :info, the others :debug)	53	# (by default production uses :info, the others :debug)
	@@ -53,6 +64,7 @@ Rails::Initializer.run do \|config\|		@@ -53,6 +64,7 @@ Rails::Initializer.run do \|config\|
53		64
54	# Activate observers that should always be running	65	# Activate observers that should always be running
55	# config.active_record.observers = :cacher, :garbage_collector	66	# config.active_record.observers = :cacher, :garbage_collector
		67	+ config.active_record.observers = :article_sweeper
56	# Make Active Record use UTC-base instead of local time	68	# Make Active Record use UTC-base instead of local time
57	# config.active_record.default_timezone = :utc	69	# config.active_record.default_timezone = :utc
58		70
	@@ -94,7 +106,7 @@ end		@@ -94,7 +106,7 @@ end
94	# Include your application configuration below	106	# Include your application configuration below
95		107
96		108
97	-require 'gettext/rails'	109	+
98	Noosfero.locales = {	110	Noosfero.locales = {
99	'en' => 'English',	111	'en' => 'English',
100	'pt_BR' => 'Português',	112	'pt_BR' => 'Português',
	@@ -107,17 +119,7 @@ Tag.hierarchical = true		@@ -107,17 +119,7 @@ Tag.hierarchical = true
107		119
108	# several local libraries	120	# several local libraries
109	require 'noosfero'	121	require 'noosfero'
110	-
111	-# locally-developed modules
112	-require 'acts_as_filesystem'
113	-require 'acts_as_searchable'
114	-require 'acts_as_having_boxes'
115	-require 'acts_as_having_settings'
116	-require 'acts_as_having_image'
117	require 'sqlite_extension'	122	require 'sqlite_extension'
118	-require 'will_paginate'
119	-
120	-require 'route_if'
121		123
122	# load a local configuration if present, but not under test environment.	124	# load a local configuration if present, but not under test environment.
123	if ENV['RAILS_ENV'] != 'test'	125	if ENV['RAILS_ENV'] != 'test'
	@@ -239,7 +239,7 @@ class ProfileTest < Test::Unit::TestCase		@@ -239,7 +239,7 @@ class ProfileTest < Test::Unit::TestCase
239	profile.boxes.first.blocks << MainBlock.new	239	profile.boxes.first.blocks << MainBlock.new
240		240
241	profile_boxes = profile.boxes.size	241	profile_boxes = profile.boxes.size
242	- profile_blocks = profile.blocks.size	242	+ profile_blocks = profile.blocks(true).size
243		243
244	assert profile_boxes > 0, 'profile should have some boxes'	244	assert profile_boxes > 0, 'profile should have some boxes'
245	assert profile_blocks > 0, 'profile should have some blocks'	245	assert profile_blocks > 0, 'profile should have some blocks'