mailboxer 0.4.3 → 0.5.0

data/README.textile

@@ -1,4 +1,4 @@
-h1. Mailboxer "!https://secure.travis-ci.org/ging/mailboxer.png!":http://travis-ci.org/ging/mailboxer
+h1. Mailboxer 0.5.x "!https://secure.travis-ci.org/ging/mailboxer.png!":http://travis-ci.org/ging/mailboxer
 
 This project is based on the need of a private message system for "ging / social_stream":https://github.com/ging/social_stream. Instead of creating our core message system heavily dependent on our development we are trying to implement a generic and potent messaging gem.
 
@@ -37,29 +37,28 @@ We are now adding support for sending emails when a Notification or a Message is
   def name
     return "You should add method :name in your Messageable model"
   end
-  #Returning the email address of the model
-  def email
+  #Returning the email address of the model if an email should be sent for this object (Message or Notification).
+  #If no mail has to be sent, return nil. 
+  def mailboxer_email(object)
+    #Check if an email should be sent for that object
+    #if true
     return "define_email@on_your.model"
-  end
-  #Returning whether an email should be sent for this object (Message or Notification)
-  def should_email?(object)
-    return true
+    #if false
+    #return nil
   end
 </code></pre>
 These names are explicit enough to avoid colliding with other methods, but as long as you need to change them you can do it by using mailboxer initializer. Just add or uncomment the following lines:
 <pre><code>
   #Configures the methods needed by mailboxer
-  config.email_method = :email
+  config.email_method = :mailboxer_email
   config.name_method = :name
-  config.should_email_method = :should_email?
 </code></pre>
 You may change whatever you want or need. For example:
 <pre><code>
   config.email_method = :notifications_email
   config.name_method = :display_name
-  config.should_email_method = :do_you_want_this_to_be_mailed?
 </code></pre>
-Will use the method @notification_email@ instead of @email@, @display_name@ for @name@ and @do_you_want_this_to_be_mailed?@ for @should_email?@ 
+Will use the method @notification_email(object)@ instead of @mailboxer_email(object)@ and @display_name@ for @name@ 
 
 Using default or custom method names, if your model doesn't implement them, Mailboxer will use dummy methods not to crash but notify you the missing methods.
 

data/app/mailers/message_mailer.rb

@@ -19,7 +19,7 @@ class MessageMailer < ActionMailer::Base
     @receiver = receiver
     subject = message.subject.to_s
     subject = strip_tags(subject) unless subject.html_safe?
-    mail(:to => receiver.send(Mailboxer.email_method), :subject => t('mailboxer.message_mailer.subject_new', :subject => subject)) do |format|
+    mail(:to => receiver.send(Mailboxer.email_method,message), :subject => t('mailboxer.message_mailer.subject_new', :subject => subject)) do |format|
       format.text {render __method__}
       format.html {render __method__}
     end
@@ -31,7 +31,7 @@ class MessageMailer < ActionMailer::Base
     @receiver = receiver
     subject = message.subject.to_s
     subject = strip_tags(subject) unless subject.html_safe?
-    mail(:to => receiver.send(Mailboxer.email_method), :subject => t('mailboxer.message_mailer.subject_reply', :subject => subject)) do |format|
+    mail(:to => receiver.send(Mailboxer.email_method,message), :subject => t('mailboxer.message_mailer.subject_reply', :subject => subject)) do |format|
       format.text {render __method__}
       format.html {render __method__}
     end

data/app/mailers/notification_mailer.rb

@@ -14,7 +14,7 @@ class NotificationMailer < ActionMailer::Base
     @receiver = receiver
     subject = notification.subject.to_s
     subject = strip_tags(subject) unless subject.html_safe?
-    mail(:to => receiver.send(Mailboxer.email_method), :subject => t('mailboxer.notification_mailer.subject', :subject => subject)) do |format|
+    mail(:to => receiver.send(Mailboxer.email_method,notification), :subject => t('mailboxer.notification_mailer.subject', :subject => subject)) do |format|
       format.text {render __method__}
       format.html {render __method__}
     end

data/app/models/message.rb

@@ -42,8 +42,9 @@ class Message < Notification
       temp_receipts.each(&:save!) 	#Save receipts
       self.recipients.each do |r|
       #Should send an email?
-        if Mailboxer.uses_emails and r.send(Mailboxer.should_email_method,self)
-          unless r.send(Mailboxer.email_method).blank?
+        if Mailboxer.uses_emails 
+          email_to = r.send(Mailboxer.email_method,self)
+          unless email_to.blank?
             MessageMailer.send_email(self,r).deliver
           end
         end

data/app/models/notification.rb

@@ -48,8 +48,9 @@ class Notification < ActiveRecord::Base
       temp_receipts.each(&:save!)   #Save receipts
       self.recipients.each do |r|
         #Should send an email?
-        if Mailboxer.uses_emails and r.send(Mailboxer.should_email_method,self)
-          unless r.send(Mailboxer.email_method).blank?
+        if Mailboxer.uses_emails 
+          email_to = r.send(Mailboxer.email_method,self)
+          unless email_to.blank?
             NotificationMailer.send_email(self,r).deliver
           end
         end

data/lib/generators/mailboxer/templates/initializer.rb

@@ -7,7 +7,6 @@ Mailboxer.setup do |config|
   config.default_from = "no-reply@mailboxer.com"
   
   #Configures the methods needed by mailboxer
-  #config.email_method = :email
+  #config.email_method = :mailboxer_email
   #config.name_method = :name
-  #config.should_email_method = :should_email?
 end

data/lib/mailboxer.rb

@@ -6,11 +6,9 @@ module Mailboxer
   mattr_accessor :default_from
   mattr_accessor :uses_emails
   mattr_accessor :email_method
-  @@email_method = :email
+  @@email_method = :mailboxer_email
   mattr_accessor :name_method
   @@name_method = :name
-  mattr_accessor :should_email_method
-  @@should_email_method = :should_email?
   
    class << self
     def setup

data/lib/mailboxer/models/messageable.rb

@@ -25,19 +25,13 @@ module Mailboxer
              return "You should add method :name in your Messageable model"
            end
 
-           #Returning the email address of the model
-           def #{Mailboxer.email_method}
+           #Returning the email address of the model if an email should be sent for this object (Message or Notification).
+           #If no mail has to be sent, return nil. 
+           def #{Mailboxer.email_method}(object)
              super
            rescue NameError
              return "define_email@on_your.model"
            end
-
-           #Returning whether an email should be sent for this object (Message or Notification)
-           def #{Mailboxer.should_email_method}(object)
-             super
-           rescue NameError
-            return true
-            end
            EOM
         #Gets the mailbox of the messageable
         def mailbox

data/mailboxer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name = "mailboxer"
-	s.version = "0.4.3"
+	s.version = "0.5.0"
 	s.authors = ["Eduardo Casanova Cuesta"]
 	s.summary = "Messaging system for rails apps."
 	s.description = "A Rails engine that allows any model to act as messageable, allowing it to exchange messages " +

data/spec/dummy/app/models/cylon.rb

@@ -1,7 +1,6 @@
 class Cylon < ActiveRecord::Base
   acts_as_messageable
-    
-  def should_email?(object)
-    return false
+  def mailboxer_email(object)
+    return nil
   end
 end

data/spec/dummy/app/models/duck.rb

@@ -1,12 +1,11 @@
 class Duck < ActiveRecord::Base
   acts_as_messageable
-  
-  def should_email?(object)
+  def mailboxer_email(object)
     case object
     when Message
-      return false
+      return nil
     when Notification
-      return true
+      return email
     end
   end
 end

data/spec/dummy/app/models/user.rb

@@ -1,3 +1,6 @@
 class User < ActiveRecord::Base
   acts_as_messageable
+  def mailboxer_email(object)
+    return email
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mailboxer
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 3
-  version: 0.4.3
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Eduardo Casanova Cuesta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-22 00:00:00 +02:00
+date: 2011-07-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency