spammable: encapsulate the spam logic to a module

Rodrigo Souto
1 parent 13bd4e38
Showing 5 changed files with 54 additions and 49 deletions Show diff stats
app/models/comment.rb
app/models/suggest_article.rb
app/models/task.rb
lib/spammable.rb
plugins/anti_spam/test/unit/anti_spam_plugin_test.rb
@@ -16,9 +16,7 @@ class Comment &lt; ActiveRecord::Base
   has_many :children, :class_name => 'Comment', :foreign_key => 'reply_of_id', :dependent => :destroy
   belongs_to :reply_of, :class_name => 'Comment', :foreign_key => 'reply_of_id'
-  named_scope :without_spam, :conditions => ['spam IS NULL OR spam = ?', false]
   named_scope :without_reply, :conditions => ['reply_of_id IS NULL']
-  named_scope :spam, :conditions => ['spam = ?', true]
   # unauthenticated authors:
   validates_presence_of :name, :if => (lambda { |record| !record.email.blank? })
@@ -205,27 +203,15 @@ class Comment &lt; ActiveRecord::Base
     @rejected = true
   end
-  def spam?
-    !spam.nil? && spam
-  end
-
-  def ham?
-    !spam.nil? && !spam
-  end
+  include Spammable
-  def spam!
-    self.spam = true
-    self.save!
+  def after_spam!
     SpammerLogger.log(ip_address, self)
     Delayed::Job.enqueue(CommentHandler.new(self.id, :marked_as_spam))
-    self
   end
-  def ham!
-    self.spam = false
-    self.save!
+  def after_ham!
     Delayed::Job.enqueue(CommentHandler.new(self.id, :marked_as_ham))
-    self
   end
   def marked_as_spam
@@ -76,17 +76,13 @@ class SuggestArticle &lt; Task
     _('You need to login on %{system} in order to approve or reject this article.') % { :system => target.environment.name }
   end
-  def spam!
-    super
+  def after_spam!
     SpammerLogger.log(ip_address, self)
     self.delay.marked_as_spam
-    self
   end
-  def ham!
-    super
+  def after_ham!
     self.delay.marked_as_ham
-    self
   end
   def marked_as_spam
@@ -235,25 +235,7 @@ class Task &lt; ActiveRecord::Base
     end
   end
-  def spam?
-    !spam.nil? && spam
-  end
-
-  def ham?
-    !spam.nil? && !spam
-  end
-
-  def spam!
-    self.spam = true
-    self.save!
-    self
-  end
-
-  def ham!
-    self.spam = false
-    self.save!
-    self
-  end
+  include Spammable
   protected
@@ -294,8 +276,6 @@ class Task &lt; ActiveRecord::Base
   named_scope :opened, :conditions => { :status =>  [Task::Status::ACTIVE, Task::Status::HIDDEN] }
   named_scope :of, lambda { |type| conditions = type ? "type LIKE '#{type}'" : "1=1"; {:conditions =>  [conditions]} }
   named_scope :order_by, lambda { |attribute, ord| {:order => "#{attribute} #{ord}"} }
-  named_scope :without_spam, :conditions => ['spam IS NULL OR spam = ?', false]
-  named_scope :spam, :conditions => ['spam = ?', true]
   named_scope :to, lambda { |profile|
@@ -0,0 +1,44 @@
+module Spammable
+  def self.included(recipient)
+    recipient.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def self.extended (base)
+      base.class_eval do
+        named_scope :without_spam, :conditions => ['spam IS NULL OR spam = ?', false]
+        named_scope :spam, :conditions => ['spam = ?', true]
+      end
+    end
+  end
+
+  def spam?
+    !spam.nil? && spam
+  end
+
+  def ham?
+    !spam.nil? && !spam
+  end
+
+  def spam!
+    before_spam!
+    self.spam = true
+    self.save!
+    after_spam!
+    self
+  end
+
+  def ham!
+    before_ham!
+    self.spam = false
+    self.save!
+    after_ham!
+    self
+  end
+
+  def after_spam!; end
+  def before_spam!; end
+
+  def after_ham!; end
+  def before_ham!; end
+end
@@ -2,24 +2,23 @@ require &#39;test_helper&#39;
 class AntiSpamPluginTest < ActiveSupport::TestCase
-  class Spammable
+  class SpammableContent
     attr_accessor :spam
+    include Spammable
     def save!; end
-    def spam!; end
-    def ham!; end
-    def spam?; true; end
     def environment; Environment.default; end
   end
   def setup
-    @spammable = Spammable.new
+    @spammable = SpammableContent.new
     @plugin = AntiSpamPlugin.new
   end
   attr_accessor :spammable
   should 'check for spam and mark as spam if server says it is spam' do
+    spammable.expects(:spam?).returns(true)
     spammable.expects(:save!)
     @plugin.check_for_spam(spammable)
	@@ -235,25 +235,7 @@ class Task < ActiveRecord::Base		@@ -235,25 +235,7 @@ class Task < ActiveRecord::Base
235	end	235	end
236	end	236	end
237		237
238	- def spam?
239	- !spam.nil? && spam
240	- end
241	-
242	- def ham?
243	- !spam.nil? && !spam
244	- end
245	-
246	- def spam!
247	- self.spam = true
248	- self.save!
249	- self
250	- end
251	-
252	- def ham!
253	- self.spam = false
254	- self.save!
255	- self
256	- end	238	+ include Spammable
257		239
258	protected	240	protected
259		241
	@@ -294,8 +276,6 @@ class Task < ActiveRecord::Base		@@ -294,8 +276,6 @@ class Task < ActiveRecord::Base
294	named_scope :opened, :conditions => { :status => [Task::Status::ACTIVE, Task::Status::HIDDEN] }	276	named_scope :opened, :conditions => { :status => [Task::Status::ACTIVE, Task::Status::HIDDEN] }
295	named_scope :of, lambda { \|type\| conditions = type ? "type LIKE '#{type}'" : "1=1"; {:conditions => [conditions]} }	277	named_scope :of, lambda { \|type\| conditions = type ? "type LIKE '#{type}'" : "1=1"; {:conditions => [conditions]} }
296	named_scope :order_by, lambda { \|attribute, ord\| {:order => "#{attribute} #{ord}"} }	278	named_scope :order_by, lambda { \|attribute, ord\| {:order => "#{attribute} #{ord}"} }
297	- named_scope :without_spam, :conditions => ['spam IS NULL OR spam = ?', false]
298	- named_scope :spam, :conditions => ['spam = ?', true]
299		279
300		280
301	named_scope :to, lambda { \|profile\|	281	named_scope :to, lambda { \|profile\|
@@ -0,0 +1,44 @@		@@ -0,0 +1,44 @@
	1	+module Spammable
	2	+ def self.included(recipient)
	3	+ recipient.extend(ClassMethods)
	4	+ end
	5	+
	6	+ module ClassMethods
	7	+ def self.extended (base)
	8	+ base.class_eval do
	9	+ named_scope :without_spam, :conditions => ['spam IS NULL OR spam = ?', false]
	10	+ named_scope :spam, :conditions => ['spam = ?', true]
	11	+ end
	12	+ end
	13	+ end
	14	+
	15	+ def spam?
	16	+ !spam.nil? && spam
	17	+ end
	18	+
	19	+ def ham?
	20	+ !spam.nil? && !spam
	21	+ end
	22	+
	23	+ def spam!
	24	+ before_spam!
	25	+ self.spam = true
	26	+ self.save!
	27	+ after_spam!
	28	+ self
	29	+ end
	30	+
	31	+ def ham!
	32	+ before_ham!
	33	+ self.spam = false
	34	+ self.save!
	35	+ after_ham!
	36	+ self
	37	+ end
	38	+
	39	+ def after_spam!; end
	40	+ def before_spam!; end
	41	+
	42	+ def after_ham!; end
	43	+ def before_ham!; end
	44	+end