[pluginize-solr] Moving solr reindex to a plugin

Starting pluginization of solr!

[pluginize-solr] Moving solr reindex to a plugin
Starting pluginization of solr!
Rodrigo Souto
1 parent 82ae16fc
Showing 36 changed files with 232 additions and 115 deletions Show diff stats
app/models/article.rb
app/models/category.rb
app/models/certifier.rb
app/models/comment.rb
app/models/enterprise.rb
app/models/product.rb
app/models/product_category.rb
app/models/profile.rb
app/models/qualifier.rb
plugins/solr/lib/ext/article.rb
plugins/solr/lib/ext/category.rb
plugins/solr/lib/ext/certifier.rb
plugins/solr/lib/ext/comment.rb
plugins/solr/lib/ext/enterprise.rb
plugins/solr/lib/ext/product.rb
plugins/solr/lib/ext/product_category.rb
plugins/solr/lib/ext/profile.rb
plugins/solr/lib/ext/qualifier.rb
plugins/solr/lib/solr_plugin.rb
plugins/solr/test/unit/category_test.rb
@@ -469,10 +469,6 @@ class Article &lt; ActiveRecord::Base
     allow_post_content?(user) || user && allow_members_to_edit && user.is_member_of?(profile)
   end
-  def comments_updated
-    solr_save
-  end
-
   def accept_category?(cat)
     !cat.is_a?(ProductCategory)
   end
@@ -106,7 +106,6 @@ class Category &lt; ActiveRecord::Base
     # ordered/query-boosted fields
     {:name_sortable => :string},
   ]
-  after_save_reindex [:articles, :profiles], :with => :delayed_job
   handle_asynchronously :solr_save
 end
@@ -24,6 +24,4 @@ class Certifier &lt; ActiveRecord::Base
     self.name.downcase.transliterate <=> b.name.downcase.transliterate
   end
-  after_save_reindex [:products], :with => :delayed_job
-
 end
@@ -74,12 +74,6 @@ class Comment &lt; ActiveRecord::Base
     self.find(:all, :order => 'created_at desc, id desc', :limit => limit)
   end
-  after_save :notify_article
-  after_destroy :notify_article
-  def notify_article
-    article.comments_updated if article.kind_of?(Article)
-  end
-
   after_create :new_follower
   def new_follower
     if source.kind_of?(Article)
@@ -14,7 +14,6 @@ class Enterprise &lt; Organization
   has_and_belongs_to_many :fans, :class_name => 'Person', :join_table => 'favorite_enteprises_people'
-  after_save_reindex [:products], :with => :delayed_job
   extra_data_for_index :product_categories
   def product_categories
     products.includes(:product_category).map{|p| p.category_full_name}.compact
@@ -294,6 +294,5 @@ class Product &lt; ActiveRecord::Base
     ], :facets => facets_option_for_solr,
     :boost => proc{ |p| boost = 1; Boosts.each{ |b| boost = boost * (1 - ((1 - b[2].call(p)) * b[1])) }; boost}
   handle_asynchronously :solr_save
-  after_save_reindex [:enterprise], :with => :delayed_job
 end
@@ -11,6 +11,4 @@ class ProductCategory &lt; Category
     top_category ? top_category.children : top_level_for(env).select{|c|c.kind_of?(ProductCategory)}
   end
-  after_save_reindex [:products], :with => :delayed_job
-
 end
@@ -963,7 +963,7 @@ private :generate_url, :url_options
       {:categories => {:fields => [:name, :path, :slug, :lat, :lng, :acronym, :abbreviation]}},
     ], :facets => facets_option_for_solr,
     :boost => proc{ |p| 10 if p.enabled }
-  after_save_reindex [:articles], :with => :delayed_job
+
   handle_asynchronously :solr_save
   def control_panel_settings_button
@@ -15,6 +15,4 @@ class Qualifier &lt; ActiveRecord::Base
     self.name.downcase.transliterate <=> b.name.downcase.transliterate
   end
-  after_save_reindex [:products], :with => :delayed_job
-
 end
@@ -0,0 +1,7 @@
+require_dependency 'article'
+
+class Article
+  def solr_plugin_comments_updated
+    solr_save
+  end
+end
@@ -0,0 +1,5 @@
+require_dependency 'category'
+
+class Category
+  after_save_reindex [:articles, :profiles], :with => :delayed_job
+end
@@ -0,0 +1,6 @@
+require_dependency 'certifier'
+
+class Certifier
+  after_save_reindex [:products], :with => :delayed_job
+end
+
@@ -0,0 +1,10 @@
+require_dependency 'comment'
+
+class Comment
+  after_save :solr_plugin_notify_article
+  after_destroy :solr_plugin_notify_article
+
+  def solr_plugin_notify_article
+    article.solr_plugin_comments_updated if article.kind_of?(Article)
+  end
+end
@@ -0,0 +1,5 @@
+require_dependency 'enterprise'
+
+class Enterprise
+  after_save_reindex [:products], :with => :delayed_job
+end
@@ -0,0 +1,5 @@
+require_dependency 'product'
+
+class Product
+  after_save_reindex [:enterprise], :with => :delayed_job
+end
@@ -0,0 +1,6 @@
+require_dependency 'product_category'
+
+class ProductCategory
+  after_save_reindex [:products], :with => :delayed_job
+end
+
@@ -0,0 +1,5 @@
+require_dependency 'profile'
+
+class Profile
+  after_save_reindex [:articles], :with => :delayed_job
+end
@@ -0,0 +1,6 @@
+require_dependency 'qualifier'
+
+class Qualifier
+  after_save_reindex [:products], :with => :delayed_job
+end
+
@@ -0,0 +1,13 @@
+class SolrPlugin < Noosfero::Plugin
+
+  def self.plugin_name
+    "Solr"
+  end
+
+  def self.plugin_description
+    _("Uses Solr as search engine.")
+  end
+
+end
+
+Dir[File.join(SolrPlugin.root_path, 'lib', 'ext', '*.rb')].each {|file| require_dependency file }
@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class CategoryTest < ActiveSupport::TestCase
+  def setup
+    @environment = Environment.default
+    @environment.enable_plugin(SolrPlugin)
+  end
+
+  attr_accessor :environment
+
+  should 'reindex articles after saving' do
+    cat = Category.create!(:name => 'category 1', :environment_id => Environment.default.id)
+    art = Article.create!(:name => 'something', :profile_id => fast_create(Person).id)
+    art.add_category cat
+    cat.reload
+
+    solr_doc = art.to_solr_doc
+    Article.any_instance.expects(:to_solr_doc).returns(solr_doc)
+    cat.save!
+  end
+end
@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class CertifierTest < ActiveSupport::TestCase
+  def setup
+    @environment = Environment.default
+    @environment.enable_plugin(SolrPlugin)
+  end
+
+  attr_accessor :environment
+
+  should 'reindex products after saving' do
+    product = mock
+    Certifier.any_instance.stubs(:products).returns([product])
+    Certifier.expects(:solr_batch_add).with(includes(product))
+    cert = fast_create(Certifier)
+    cert.save!
+  end
+end
+
@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class CommentTest < ActiveSupport::TestCase
+  def setup
+    @environment = Environment.default
+    @environment.enable_plugin(SolrPlugin)
+  end
+
+  attr_accessor :environment
+
+  should 'notify article to reindex after saving' do
+    owner = create_user('testuser').person
+    article = owner.articles.create!(:name => 'test', :body => '...')
+
+    article.expects(:solr_plugin_comments_updated)
+
+    c1 = article.comments.new(:title => "A comment", :body => '...', :author => owner)
+    c1.stubs(:article).returns(article)
+    c1.save!
+  end
+
+  should 'notify article to reindex after being removed' do
+    owner = create_user('testuser').person
+    article = owner.articles.create!(:name => 'test', :body => '...')
+    c1 = article.comments.create!(:title => "A comment", :body => '...', :author => owner)
+
+    c1.stubs(:article).returns(article)
+    article.expects(:solr_plugin_comments_updated)
+    c1.destroy
+  end
+end
+
@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class EnterpriseTest < ActiveSupport::TestCase
+  def setup
+    @environment = Environment.default
+    @environment.enable_plugin(SolrPlugin)
+    @product_category = fast_create(ProductCategory)
+  end
+
+  attr_accessor :environment, :product_category
+
+  should 'reindex when products are changed' do
+    enterprise = fast_create(Enterprise)
+    product = fast_create(Product, :enterprise_id => enterprise.id, :product_category_id => product_category.id)
+    Product.expects(:solr_batch_add_association).with(product, :enterprise)
+    product.update_attribute :name, "novo nome"
+  end
+end
@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class ProductCategoryTest < ActiveSupport::TestCase
+  def setup
+    @environment = Environment.default
+    @environment.enable_plugin(SolrPlugin)
+  end
+
+  attr_accessor :environment
+
+  should 'reindex products after save' do
+    product = mock
+    ProductCategory.any_instance.stubs(:products).returns([product])
+    ProductCategory.expects(:solr_batch_add).with(includes(product))
+    pc = fast_create(ProductCategory)
+    pc.save!
+  end
+end
+
@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class ProductTest < ActiveSupport::TestCase
+  def setup
+    @environment = Environment.default
+    @environment.enable_plugin(SolrPlugin)
+  end
+
+  attr_accessor :environment
+
+  should 'reindex enterprise after saving' do
+    ent = fast_create(Enterprise)
+    cat = fast_create(ProductCategory)
+    prod = Product.create!(:name => 'something', :enterprise_id => ent.id, :product_category_id => cat.id)
+    Product.expects(:solr_batch_add).with([ent])
+    prod.save!
+  end
+end
+
@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class ProfileTest < ActiveSupport::TestCase
+  def setup
+    @environment = Environment.default
+    @environment.enable_plugin(SolrPlugin)
+  end
+
+  attr_accessor :environment
+
+  should 'reindex articles after saving' do
+    profile = create(Person, :name => 'something', :user_id => fast_create(User).id)
+    art = profile.articles.build(:name => 'something')
+    Profile.expects(:solr_batch_add).with(includes(art))
+    profile.save!
+  end
+end
@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class QualifierTest < ActiveSupport::TestCase
+  def setup
+    @environment = Environment.default
+    @environment.enable_plugin(SolrPlugin)
+  end
+
+  attr_accessor :environment
+
+  should 'reindex products after saving' do
+    product = mock
+    Qualifier.any_instance.stubs(:products).returns([product])
+    Qualifier.expects(:solr_batch_add).with(includes(product))
+    qual = fast_create(Qualifier)
+    qual.save!
+  end
+end
@@ -357,12 +357,6 @@ class ArticleTest &lt; ActiveSupport::TestCase
     assert_equal true, a.display_to?(person)
   end
-  should 'reindex when comments are changed' do
-    a = Article.new
-    a.expects(:solr_save)
-    a.comments_updated
-  end
-
   should 'index comments title together with article' do
     TestSolr.enable
     owner = create_user('testuser').person
@@ -541,15 +541,4 @@ class CategoryTest &lt; ActiveSupport::TestCase
     c.save!
   end
-  should 'reindex articles after saving' do
-    cat = Category.create!(:name => 'category 1', :environment_id => Environment.default.id)
-    art = Article.create!(:name => 'something', :profile_id => fast_create(Person).id)
-    art.add_category cat
-    cat.reload
-
-    solr_doc = art.to_solr_doc
-    Article.any_instance.expects(:to_solr_doc).returns(solr_doc)
-    cat.save!
-  end
-
 end
@@ -58,14 +58,6 @@ class CertifierTest &lt; ActiveSupport::TestCase
     assert_equal [first, last], Certifier.all.sort
   end
-  should 'reindex products after saving' do
-    product = mock
-    Certifier.any_instance.stubs(:products).returns([product])
-    Certifier.expects(:solr_batch_add).with(includes(product))
-    cert = fast_create(Certifier)
-    cert.save!
-  end
-
   should 'set qualifier as self-certified when destroyed' do
     pq = mock
     Certifier.any_instance.stubs(:product_qualifiers).returns([pq])
@@ -175,27 +175,6 @@ class CommentTest &lt; ActiveSupport::TestCase
     assert c.errors.invalid?(:email)
   end
-  should 'notify article to reindex after saving' do
-    owner = create_user('testuser').person
-    article = owner.articles.create!(:name => 'test', :body => '...')
-
-    article.expects(:comments_updated)
-
-    c1 = article.comments.new(:title => "A comment", :body => '...', :author => owner)
-    c1.stubs(:article).returns(article)
-    c1.save!
-  end
-
-  should 'notify article to reindex after being removed' do
-    owner = create_user('testuser').person
-    article = owner.articles.create!(:name => 'test', :body => '...')
-    c1 = article.comments.create!(:title => "A comment", :body => '...', :author => owner)
-
-    c1.stubs(:article).returns(article)
-    article.expects(:comments_updated)
-    c1.destroy
-  end
-
   should 'generate links to comments on images with view set to true' do
     owner = create_user('testuser').person
     image = UploadedFile.create!(:profile => owner, :uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'))
@@ -443,13 +443,6 @@ class EnterpriseTest &lt; ActiveSupport::TestCase
     assert_equal product.inputs, enterprise.inputs
   end
-  should 'reindex when products are changed' do
-    enterprise = fast_create(Enterprise)
-    product = fast_create(Product, :enterprise_id => enterprise.id, :product_category_id => @product_category.id)
-    Product.expects(:solr_batch_add_association).with(product, :enterprise)
-    product.update_attribute :name, "novo nome"
-  end
-
   should "the followed_by? be true only to members" do
     e = fast_create(Enterprise)
     e.stubs(:closed?).returns(false)
@@ -480,17 +473,6 @@ class EnterpriseTest &lt; ActiveSupport::TestCase
     assert_respond_to e, :production_costs
   end
-  should 'reindex products with full category name after save' do
-    product = mock
-    products = mock
-    product.expects(:category_full_name)
-    products.stubs(:includes).returns([product])
-    Enterprise.any_instance.stubs(:products).returns(products)
-    Enterprise.expects(:solr_batch_add).with([products])
-    ent = fast_create(Enterprise)
-    ent.save!
-  end
-
   should 'return scraps as activities' do
     person = fast_create(Person)
     enterprise = fast_create(Enterprise)
@@ -36,12 +36,4 @@ class ProductCategoryTest &lt; ActiveSupport::TestCase
     assert_equal [c11], ProductCategory.menu_categories(c1, nil)
   end
-  should 'reindex products after save' do
-    product = mock
-    ProductCategory.any_instance.stubs(:products).returns([product])
-    ProductCategory.expects(:solr_batch_add).with(includes(product))
-    pc = fast_create(ProductCategory)
-    pc.save!
-  end
-
 end
@@ -636,14 +636,6 @@ class ProductTest &lt; ActiveSupport::TestCase
     assert_equal [in_name, in_desc], Product.find_by_contents('bananas')[:results].docs
   end
-  should 'reindex enterprise after saving' do
-    ent = fast_create(Enterprise)
-    cat = fast_create(ProductCategory)
-    prod = Product.create!(:name => 'something', :enterprise_id => ent.id, :product_category_id => cat.id)
-    Product.expects(:solr_batch_add).with([ent])
-    prod.save!
-  end
-
   should 'boost search results that include an image' do
     TestSolr.enable
     product_without_image = Product.create!(:name => 'product without image', :product_category => @product_category,
@@ -1909,13 +1909,6 @@ class ProfileTest &lt; ActiveSupport::TestCase
     assert_equal [in_name], Person.find_by_contents('bananas')[:results].docs
   end
-  should 'reindex articles after saving' do
-    profile = create(Person, :name => 'something', :user_id => fast_create(User).id)
-    art = profile.articles.build(:name => 'something')
-    Profile.expects(:solr_batch_add).with(includes(art))
-    profile.save!
-  end
-
   should 'respond to redirection_after_login' do
     assert_respond_to Profile.new, :redirection_after_login
   end
@@ -60,12 +60,4 @@ class QualifierTest &lt; ActiveSupport::TestCase
     Qualifier.destroy_all
     assert_equal [], product1.product_qualifiers(true)
   end
-
-  should 'reindex products after saving' do
-    product = mock
-    Qualifier.any_instance.stubs(:products).returns([product])
-    Qualifier.expects(:solr_batch_add).with(includes(product))
-    qual = fast_create(Qualifier)
-    qual.save!
-  end
 end
	@@ -106,7 +106,6 @@ class Category < ActiveRecord::Base		@@ -106,7 +106,6 @@ class Category < ActiveRecord::Base
106	# ordered/query-boosted fields	106	# ordered/query-boosted fields
107	{:name_sortable => :string},	107	{:name_sortable => :string},
108	]	108	]
109	- after_save_reindex [:articles, :profiles], :with => :delayed_job
110	handle_asynchronously :solr_save	109	handle_asynchronously :solr_save
111		110
112	end	111	end
	@@ -24,6 +24,4 @@ class Certifier < ActiveRecord::Base		@@ -24,6 +24,4 @@ class Certifier < ActiveRecord::Base
24	self.name.downcase.transliterate <=> b.name.downcase.transliterate	24	self.name.downcase.transliterate <=> b.name.downcase.transliterate
25	end	25	end
26		26
27	- after_save_reindex [:products], :with => :delayed_job
28	-
29	end	27	end
	@@ -74,12 +74,6 @@ class Comment < ActiveRecord::Base		@@ -74,12 +74,6 @@ class Comment < ActiveRecord::Base
74	self.find(:all, :order => 'created_at desc, id desc', :limit => limit)	74	self.find(:all, :order => 'created_at desc, id desc', :limit => limit)
75	end	75	end
76		76
77	- after_save :notify_article
78	- after_destroy :notify_article
79	- def notify_article
80	- article.comments_updated if article.kind_of?(Article)
81	- end
82	-
83	after_create :new_follower	77	after_create :new_follower
84	def new_follower	78	def new_follower
85	if source.kind_of?(Article)	79	if source.kind_of?(Article)
	@@ -14,7 +14,6 @@ class Enterprise < Organization		@@ -14,7 +14,6 @@ class Enterprise < Organization
14		14
15	has_and_belongs_to_many :fans, :class_name => 'Person', :join_table => 'favorite_enteprises_people'	15	has_and_belongs_to_many :fans, :class_name => 'Person', :join_table => 'favorite_enteprises_people'
16		16
17	- after_save_reindex [:products], :with => :delayed_job
18	extra_data_for_index :product_categories	17	extra_data_for_index :product_categories
19	def product_categories	18	def product_categories
20	products.includes(:product_category).map{\|p\| p.category_full_name}.compact	19	products.includes(:product_category).map{\|p\| p.category_full_name}.compact
	@@ -294,6 +294,5 @@ class Product < ActiveRecord::Base		@@ -294,6 +294,5 @@ class Product < ActiveRecord::Base
294	], :facets => facets_option_for_solr,	294	], :facets => facets_option_for_solr,
295	:boost => proc{ \|p\| boost = 1; Boosts.each{ \|b\| boost = boost * (1 - ((1 - b[2].call(p)) * b[1])) }; boost}	295	:boost => proc{ \|p\| boost = 1; Boosts.each{ \|b\| boost = boost * (1 - ((1 - b[2].call(p)) * b[1])) }; boost}
296	handle_asynchronously :solr_save	296	handle_asynchronously :solr_save
297	- after_save_reindex [:enterprise], :with => :delayed_job
298		297
299	end	298	end
	@@ -11,6 +11,4 @@ class ProductCategory < Category		@@ -11,6 +11,4 @@ class ProductCategory < Category
11	top_category ? top_category.children : top_level_for(env).select{\|c\|c.kind_of?(ProductCategory)}	11	top_category ? top_category.children : top_level_for(env).select{\|c\|c.kind_of?(ProductCategory)}
12	end	12	end
13		13
14	- after_save_reindex [:products], :with => :delayed_job
15	-
16	end	14	end
	@@ -963,7 +963,7 @@ private :generate_url, :url_options		@@ -963,7 +963,7 @@ private :generate_url, :url_options
963	{:categories => {:fields => [:name, :path, :slug, :lat, :lng, :acronym, :abbreviation]}},	963	{:categories => {:fields => [:name, :path, :slug, :lat, :lng, :acronym, :abbreviation]}},
964	], :facets => facets_option_for_solr,	964	], :facets => facets_option_for_solr,
965	:boost => proc{ \|p\| 10 if p.enabled }	965	:boost => proc{ \|p\| 10 if p.enabled }
966	- after_save_reindex [:articles], :with => :delayed_job	966	+
967	handle_asynchronously :solr_save	967	handle_asynchronously :solr_save
968		968
969	def control_panel_settings_button	969	def control_panel_settings_button
	@@ -15,6 +15,4 @@ class Qualifier < ActiveRecord::Base		@@ -15,6 +15,4 @@ class Qualifier < ActiveRecord::Base
15	self.name.downcase.transliterate <=> b.name.downcase.transliterate	15	self.name.downcase.transliterate <=> b.name.downcase.transliterate
16	end	16	end
17		17
18	- after_save_reindex [:products], :with => :delayed_job
19	-
20	end	18	end
@@ -0,0 +1,7 @@		@@ -0,0 +1,7 @@
	1	+require_dependency 'article'
	2	+
	3	+class Article
	4	+ def solr_plugin_comments_updated
	5	+ solr_save
	6	+ end
	7	+end
@@ -0,0 +1,5 @@		@@ -0,0 +1,5 @@
	1	+require_dependency 'category'
	2	+
	3	+class Category
	4	+ after_save_reindex [:articles, :profiles], :with => :delayed_job
	5	+end