mailboxer 0.0.4 → 0.0.5

data/app/models/mailboxer_conversation.rb

@@ -2,10 +2,44 @@ class MailboxerConversation < ActiveRecord::Base
   attr_reader :originator, :original_message, :last_sender, :last_message, :users
   has_many :mailboxer_messages
   has_many :mailboxer_mails, :through => :mailboxer_messages
-  before_create :clean
+#  before_create :clean
   scope :participant, lambda {|participant|
-    joins(:mailboxer_messages,:mailboxer_mails).select('DISTINCT mailboxer_conversations.*').where('mailboxer_mails.receiver_id' => participant.id,'mailboxer_mails.receiver_type' => participant.class.to_s)    
+    joins(:mailboxer_mails).select('DISTINCT mailboxer_conversations.*').where('mailboxer_mails.receiver_id' => participant.id,'mailboxer_mails.receiver_type' => participant.class.to_s)    
   }
+  scope :inbox, lambda {|participant|
+    joins(:mailboxer_mails).select('DISTINCT mailboxer_conversations.*').where('mailboxer_mails.receiver_id' => participant.id,'mailboxer_mails.receiver_type' => participant.class.to_s, 'mailboxer_mails.mailbox_type' => 'inbox') 
+  }
+  scope :sentbox, lambda {|participant|
+    joins(:mailboxer_mails).select('DISTINCT mailboxer_conversations.*').where('mailboxer_mails.receiver_id' => participant.id,'mailboxer_mails.receiver_type' => participant.class.to_s, 'mailboxer_mails.mailbox_type' => 'sentbox')    
+  }
+  scope :trash, joins(:mailboxer_mails).select('DISTINCT mailboxer_conversations.*').where('mailboxer_mails.trashed' => true)    
+  scope :unread, joins(:mailboxer_mails).select('DISTINCT mailboxer_conversations.*').where('mailboxer_mails.read' => false)    
+  
+  class << self
+    def total
+      count('DISTINCT mailboxer_conversations.id')
+    end
+  end
+ 
+  def mark_as_read(participant)
+    return if participant.nil?
+    return MailboxerMail.conversation(self).receiver(participant).mark_as_read
+  end
+
+  def mark_as_unread(participant)
+    return if participant.nil?
+    return MailboxerMail.conversation(self).receiver(participant).mark_as_unread
+  end
+  
+  def move_to_trash(participant)
+    return if participant.nil?
+    return MailboxerMail.conversation(self).receiver(participant).move_to_trash
+  end
+  
+  def untrash(participant)
+    return if participant.nil?
+    return MailboxerMail.conversation(self).receiver(participant).untrash
+  end
   
   #originator of the conversation.
   def originator
@@ -53,12 +87,12 @@ class MailboxerConversation < ActiveRecord::Base
     return MailboxerMessage.conversation(self).count
   end
   
-  protected
-  #[empty method]
-  #
-  #this gets called before_create. Implement this if you wish to clean out illegal content such as scripts or anything that will break layout. This is left empty because what is considered illegal content varies.
-  def clean
-    return if subject.nil?
-    #strip all illegal content here. (scripts, shit that will break layout, etc.)
-  end
+#  protected
+#  #[empty method]
+#  #
+#  #this gets called before_create. Implement this if you wish to clean out illegal content such as scripts or anything that will break layout. This is left empty because what is considered illegal content varies.
+#  def clean
+#    return if subject.nil?
+#    #strip all illegal content here. (scripts, shit that will break layout, etc.)
+#  end
 end

data/app/models/mailboxer_mailbox.rb

@@ -15,25 +15,25 @@ class MailboxerMailbox
   end
 
   def conversations(options = {})
-    return MailboxerConversation.where(options).participant(@messageable)
-  end
-
-  def mail(options = {})
-    return MailboxerMail.where(options).receiver(@messageable)
+    return MailboxerConversation.where(options).participant(@messageable).uniq
   end
   
-  def inbox(options = {})
-    return self.mail(options).inbox
+  def inbox(options={})
+    return MailboxerConversation.where(options).inbox(@messageable).uniq    
   end
   
-  def sentbox(options = {})
-    return self.mail(options).sentbox
+  def sentbox(options={})
+    return MailboxerConversation.where(options).sentbox(@messageable).uniq
   end
   
-  def trash(options = {})
-    return self.mail(options).trash
+  def trash(options={})
+    return MailboxerConversation.where(options).participant(@messageable).trash.uniq    
   end
 
+  def mail(options = {})
+    return MailboxerMail.where(options).receiver(@messageable)
+  end
+  
   def [](mailbox_type)
     self.type = mailbox_type
     return self
@@ -54,7 +54,7 @@ class MailboxerMailbox
   end
 
   def empty_trash(options = {})
-    return self.trash(options).delete_all
+    return self.mail.trash(options).delete_all
   end
 
   def has_conversation?(conversation)
@@ -62,7 +62,10 @@ class MailboxerMailbox
   end
 
   def is_trashed?(conversation)
-    return self.trash.conversation(conversation).count!=0
+    return self.mail.trash.conversation(conversation).count!=0
+  end
+  def is_completely_trashed?(conversation)
+    return self.mail.trash.conversation(conversation).count==self.mail.conversation(conversation).count
   end
 
 end

data/lib/mailboxer/models/messageable.rb

@@ -5,67 +5,25 @@ module Mailboxer
       def self.included(mod)
         mod.extend(ClassMethods)
       end
-      # declare the class level helper methods which
-      # will load the relevant instance methods
-      # defined below when invoked
+ 
       module ClassMethods
-        #enables a class to send and receive messages to members of the same class - currently assumes the model is of class type 'User', 
-        #some modifications to the migrations and model classes will need to be made to use a model of different type
-        #
-        #====options:
-        #* :received - the mailbox type to store received messages (defaults to :inbox)
-        #
-        #* :sent - the mailbox type to store sent messages (defaults to :sentbox)
-        #
-        #* :deleted - the mailbox type to store deleted messages (defaults to :trash)
-        #
-        #====example:
-        #   acts_as_messageable :received => :in, :sent => :sent, :deleted => :garbage
+ 
         def acts_as_messageable          
           has_many :mailboxer_messages
-          cattr_accessor :mailbox_types
           has_many :mailboxer_mails, :order => 'created_at DESC', :dependent => :delete_all    
           
           include Mailboxer::Models::Messageable::InstanceMethods
         end
       end
-      
-      #Adds class methods
-      #module SingletonMethods
-      #end
-      
-      # Adds instance methods.
+
       module InstanceMethods
-        #returns an instance of class type Mailbox - this object essentially wraps the user's mail messages and provides a clean interface for accessing them. 
-        #see Mailbox for more details.
-        #
-        #====example:
-        #   phil = User.find(3123)
-        #   phil.mailbox[:inbox].unread_mail      #returns all unread mail in your inbox
-        #   phil.mailbox[:sentbox].mail         #returns all sent mail messages
-        #  
+ 
         def mailbox
           @mailbox = MailboxerMailbox.new(self) if @mailbox.nil?
           @mailbox.type = :all
           return @mailbox
         end
-        #creates new Message and Conversation objects from the given parameters and delivers Mail to each of the recipients' inbox.
-        #
-        #====params:
-        #recipients::
-        #     a single user object or array of users to deliver the message to.
-        #msg_body::
-        #     the body of the message.
-        #subject::
-        #     the subject of the message, defaults to empty string if not provided.
-        #====returns:
-        #the sent Mail.
-        #
-        #====example:
-        #   phil = User.find(3123)
-        #   todd = User.find(4141)
-        #   phil.send_message(todd, 'whats up for tonight?', 'hey guy')      #sends a Mail message to todd's inbox, and a Mail message to phil's sentbox
-        #  
+ 
         def send_message(recipients, msg_body, subject = '')
           convo = MailboxerConversation.create({:subject => subject})
           message = MailboxerMessage.create({:sender => self, :mailboxer_conversation => convo,  :body => msg_body, :subject => subject})
@@ -73,24 +31,7 @@ module Mailboxer
           message.deliver(:inbox)
           return mailbox[:sentbox] << message
         end
-        #creates a new Message associated with the given conversation and delivers the reply to each of the given recipients.
-        #
-        #*explicitly calling this method is rare unless you are replying to a subset of the users involved in the conversation or 
-        #if you are including someone that is not currently in the conversation. 
-        #reply_to_sender, reply_to_all, and reply_to_conversation will suffice in most cases.
-        #
-        #====params:
-        #conversation::
-        #     the Conversation object that the mail you are responding to belongs.
-        #recipients::
-        #     a single User object or array of Users to deliver the reply message to.
-        #reply_body::
-        #     the body of the reply message.
-        #subject::
-        #     the subject of the message, defaults to 'RE: [original subject]' if one isnt given.
-        #====returns:
-        #the sent Mail.
-        #
+ 
         def reply(conversation, recipients, reply_body, subject = nil)
           return nil if(reply_body.blank?)
           subject = subject || "RE: #{conversation.subject}"
@@ -99,33 +40,11 @@ module Mailboxer
           response.deliver(:inbox)
           return mailbox[:sentbox] << response
         end
-        #sends a Mail to the sender of the given mail message.
-        #
-        #====params:
-        #mail::
-        #     the Mail object that you are replying to.
-        #reply_body::
-        #     the body of the reply message.
-        #subject::
-        #     the subject of the message, defaults to 'RE: [original subject]' if one isnt given.
-        #====returns:
-        #the sent Mail.
-        #
+ 
         def reply_to_sender(mail, reply_body, subject = nil)
           return reply(mail.mailboxer_conversation, mail.mailboxer_message.sender, reply_body, subject)
         end
-        #sends a Mail to all of the recipients of the given mail message (excluding yourself).
-        #
-        #====params:
-        #mail::
-        #     the Mail object that you are replying to.
-        #reply_body::
-        #     the body of the reply message.
-        #subject::
-        #     the subject of the message, defaults to 'RE: [original subject]' if one isnt given.
-        #====returns:
-        #the sent Mail.
-        #
+ 
         def reply_to_all(mail, reply_body, subject = nil)
           msg = mail.mailboxer_message
           recipients = msg.get_recipients
@@ -137,20 +56,7 @@ module Mailboxer
           end
           return reply(mail.mailboxer_conversation, recipients, reply_body, subject)
         end
-        #sends a Mail to all users involved in the given conversation (excluding yourself).
-        #
-        #*this may have undesired effects if users have been added to the conversation after it has begun.
-        #
-        #====params:
-        #conversation::
-        #     the Conversation object that the mail you are responding to belongs.
-        #reply_body::
-        #     the body of the reply message.
-        #subject::
-        #     the subject of the message, defaults to 'RE: [original subject]' if one isnt given.
-        #====returns:
-        #the sent Mail.
-        #
+ 
         def reply_to_conversation(conversation, reply_body, subject = nil)
           #move conversation to inbox if it is currently in the trash - doesnt make much sense replying to a trashed convo.
           if(mailbox.is_trashed?(conversation))
@@ -165,29 +71,16 @@ module Mailboxer
             end
           end
           return reply(conversation,recipients, reply_body, subject)
-        end
-        #returns the mail given as the parameter, marked as read.
+        end 
+        
         def read_mail(mail)          
           return mail.mark_as_read if mail.receiver == self
-        end
-        #returns the mail given as the parameter, marked as unread.
+        end 
+        
         def unread_mail(mail)
           return mail.mark_as_unread if mail.receiver == self
         end
-        #returns an array of the user's Mail associated with the given conversation. 
-        #All mail is marked as read but the returning array is built before this so you can see which messages were unread when viewing the conversation.
-        #
-        #???This returns deleted/trashed messages as well for the purpose of reading trashed convos, to disable this send the option ':conditions => "mail.trashed != true"'
-        #
-        #====params:
-        #conversation::
-        #     the Conversation object that you want to read.
-        #options::
-        #     any options to filter the conversation, these are used as find options so all valid options for find will work.
-        #
-        #====returns:
-        #array of Mail belonging to the given conversation.
-        #
+ 
         def read_conversation(conversation, options = {})
           mails = conversation.mailboxer_mails.receiver(self)
           mails_clone = mails.clone

data/mailboxer.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |s|
   s.name = "mailboxer"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eduardo Casanova Cuesta"]

data/spec/models/mailboxer_mailbox_spec.rb

@@ -45,55 +45,55 @@ describe MailboxerMailbox do
   end
   
   it "should return sentbox" do
-    assert @entity1.mailbox.inbox
-    @entity1.mailbox.sentbox.count.should==2
-    @entity1.mailbox.sentbox[0].should==@mail1
-    @entity1.mailbox.sentbox[1].should==@mail3
+    assert @entity1.mailbox.mail.inbox
+    @entity1.mailbox.mail.sentbox.count.should==2
+    @entity1.mailbox.mail.sentbox[0].should==@mail1
+    @entity1.mailbox.mail.sentbox[1].should==@mail3
     
-    assert @entity2.mailbox.inbox
-    @entity2.mailbox.sentbox.count.should==2
-    @entity2.mailbox.sentbox[0].should==@mail2
-    @entity2.mailbox.sentbox[1].should==@mail4
+    assert @entity2.mailbox.mail.inbox
+    @entity2.mailbox.mail.sentbox.count.should==2
+    @entity2.mailbox.mail.sentbox[0].should==@mail2
+    @entity2.mailbox.mail.sentbox[1].should==@mail4
   end
   
   it "should return inbox" do
-    assert @entity1.mailbox.inbox
-    @entity1.mailbox.inbox.count.should==2
-    @entity1.mailbox.inbox[0].should==MailboxerMail.receiver(@entity1).inbox.conversation(@conversation)[0]
-    @entity1.mailbox.inbox[1].should==MailboxerMail.receiver(@entity1).inbox.conversation(@conversation)[1]
+    assert @entity1.mailbox.mail.inbox
+    @entity1.mailbox.mail.inbox.count.should==2
+    @entity1.mailbox.mail.inbox[0].should==MailboxerMail.receiver(@entity1).inbox.conversation(@conversation)[0]
+    @entity1.mailbox.mail.inbox[1].should==MailboxerMail.receiver(@entity1).inbox.conversation(@conversation)[1]
     
-    assert @entity2.mailbox.inbox
-    @entity2.mailbox.inbox.count.should==2
-    @entity2.mailbox.inbox[0].should==MailboxerMail.receiver(@entity2).inbox.conversation(@conversation)[0]
-    @entity2.mailbox.inbox[1].should==MailboxerMail.receiver(@entity2).inbox.conversation(@conversation)[1]
+    assert @entity2.mailbox.mail.inbox
+    @entity2.mailbox.mail.inbox.count.should==2
+    @entity2.mailbox.mail.inbox[0].should==MailboxerMail.receiver(@entity2).inbox.conversation(@conversation)[0]
+    @entity2.mailbox.mail.inbox[1].should==MailboxerMail.receiver(@entity2).inbox.conversation(@conversation)[1]
   end
   
   it "should return trashed mails" do 
     @entity1.mailbox.mail.move_to_trash
     
-    assert @entity1.mailbox.trash
-    @entity1.mailbox.trash.count.should==4
-    @entity1.mailbox.trash[0].should==MailboxerMail.receiver(@entity1).conversation(@conversation)[0]
-    @entity1.mailbox.trash[1].should==MailboxerMail.receiver(@entity1).conversation(@conversation)[1]
-    @entity1.mailbox.trash[2].should==MailboxerMail.receiver(@entity1).conversation(@conversation)[2]
-    @entity1.mailbox.trash[3].should==MailboxerMail.receiver(@entity1).conversation(@conversation)[3]
+    assert @entity1.mailbox.mail.trash
+    @entity1.mailbox.mail.trash.count.should==4
+    @entity1.mailbox.mail.trash[0].should==MailboxerMail.receiver(@entity1).conversation(@conversation)[0]
+    @entity1.mailbox.mail.trash[1].should==MailboxerMail.receiver(@entity1).conversation(@conversation)[1]
+    @entity1.mailbox.mail.trash[2].should==MailboxerMail.receiver(@entity1).conversation(@conversation)[2]
+    @entity1.mailbox.mail.trash[3].should==MailboxerMail.receiver(@entity1).conversation(@conversation)[3]
     
-    assert @entity2.mailbox.trash
-    @entity2.mailbox.trash.count.should==0    
+    assert @entity2.mailbox.mail.trash
+    @entity2.mailbox.mail.trash.count.should==0    
   end
   
   it "should delete trashed mails" do 
     @entity1.mailbox.mail.move_to_trash
     @entity1.mailbox.empty_trash
     
-    assert @entity1.mailbox.trash
-    @entity1.mailbox.trash.count.should==0    
+    assert @entity1.mailbox.mail.trash
+    @entity1.mailbox.mail.trash.count.should==0    
     
     assert @entity2.mailbox.mail
     @entity2.mailbox.mail.count.should==4
     
-    assert @entity2.mailbox.trash
-    @entity2.mailbox.trash.count.should==0    
+    assert @entity2.mailbox.mail.trash
+    @entity2.mailbox.mail.trash.count.should==0    
   end
   
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mailboxer
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Eduardo Casanova Cuesta