mailboxer 0.10.3 → 0.11.0

data/gemfiles/rails3.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 3.2.6"
+gem "mailboxer", :path=>"../"
+
+gemspec :path=>"../"

data/gemfiles/rails4.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", ">=4.0.0"
+gem "mailboxer", :path=>"../"
+
+gemspec :path=>"../"

data/lib/mailboxer.rb

@@ -1,12 +1,14 @@
-module Mailboxer 
+module Mailboxer
   module Models
     autoload :Messageable, 'mailboxer/models/messageable'
-  end  
-  
+  end
+
   mattr_accessor :default_from
   @@default_from = "no-reply@mailboxer.com"
   mattr_accessor :uses_emails
   @@uses_emails = true
+  mattr_accessor :mailer_wants_array
+  @@mailer_wants_array = false
   mattr_accessor :search_enabled
   @@search_enabled = false
   mattr_accessor :search_engine
@@ -18,14 +20,18 @@ module Mailboxer
   mattr_accessor :notification_mailer
   mattr_accessor :message_mailer
 
-   class << self
+  class << self
     def setup
       yield self
     end
-   end
-   
+
+    def protected_attributes?
+      Rails.version < '4' || defined?(ProtectedAttributes)
+    end
+  end
+
 end
 # reopen ActiveRecord and include all the above to make
 # them available to all our models if they want it
-require 'mailboxer/engine' 
+require 'mailboxer/engine'
 require 'mailboxer/concerns/configurable_mailer'

data/lib/mailboxer/engine.rb

@@ -1,14 +1,13 @@
 # Database foreign keys
 require 'foreigner'
 require 'carrierwave'
-begin 
+begin
   require 'sunspot_rails'
 rescue LoadError
 end
 
 module Mailboxer
   class Engine < Rails::Engine
-    
     initializer "mailboxer.models.messageable" do
       ActiveSupport.on_load(:active_record) do
         extend Mailboxer::Models::Messageable::ActiveRecord

data/lib/mailboxer/models/messageable.rb

@@ -13,7 +13,12 @@ module Mailboxer
 
       included do
         has_many :messages, :as => :sender
-        has_many :receipts, :order => 'created_at DESC', :dependent => :destroy, :as => :receiver
+        if Rails::VERSION::MAJOR == 4
+          has_many :receipts, -> { order 'created_at DESC' }, dependent: :destroy, as: :receiver
+        else
+          # Rails 3 does it this way
+          has_many :receipts, :order => 'created_at DESC', :dependent => :destroy, :as => :receiver
+        end
       end
 
       unless defined?(Mailboxer.name_method)
@@ -28,8 +33,8 @@ module Mailboxer
       end
 
       unless defined?(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.
+        #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.
         define_method Mailboxer.email_method do |object|
           begin
             super
@@ -43,12 +48,12 @@ module Mailboxer
       def mailbox
         @mailbox = Mailbox.new(self) if @mailbox.nil?
         @mailbox.type = :all
-        return @mailbox
+        @mailbox
       end
 
       #Sends a notification to the messageable
       def notify(subject,body,obj = nil,sanitize_text=true,notification_code=nil,send_mail=true)
-        return Notification.notify_all([self],subject,body,obj,sanitize_text,notification_code,send_mail)
+        Notification.notify_all([self],subject,body,obj,sanitize_text,notification_code,send_mail)
       end
 
       #Sends a messages, starting a new conversation, with the messageable
@@ -63,7 +68,7 @@ module Mailboxer
         message.conversation = convo
         message.recipients = recipients.is_a?(Array) ? recipients : [recipients]
         message.recipients = message.recipients.uniq
-        return message.deliver false,sanitize_text
+        message.deliver false, sanitize_text
       end
 
       #Basic reply method. USE NOT RECOMENDED.
@@ -75,17 +80,17 @@ module Mailboxer
         response.recipients = recipients.is_a?(Array) ? recipients : [recipients]
         response.recipients = response.recipients.uniq
         response.recipients.delete(self)
-        return response.deliver true, sanitize_text
+        response.deliver true, sanitize_text
       end
 
       #Replies to the sender of the message in the conversation
       def reply_to_sender(receipt, reply_body, subject=nil, sanitize_text=true, attachment=nil)
-        return reply(receipt.conversation, receipt.message.sender, reply_body, subject, sanitize_text, attachment)
+        reply(receipt.conversation, receipt.message.sender, reply_body, subject, sanitize_text, attachment)
       end
 
       #Replies to all the recipients of the message in the conversation
       def reply_to_all(receipt, reply_body, subject=nil, sanitize_text=true, attachment=nil)
-        return reply(receipt.conversation, receipt.message.recipients, reply_body, subject, sanitize_text, attachment)
+        reply(receipt.conversation, receipt.message.recipients, reply_body, subject, sanitize_text, attachment)
       end
 
       #Replies to all the recipients of the last message in the conversation and untrash any trashed message by messageable
@@ -94,8 +99,10 @@ module Mailboxer
         #move conversation to inbox if it is currently in the trash and should_untrash parameter is true.
         if should_untrash && mailbox.is_trashed?(conversation)
           mailbox.receipts_for(conversation).untrash
+          mailbox.receipts_for(conversation).mark_as_not_deleted
         end
-        return reply(conversation, conversation.last_message.recipients, reply_body, subject, sanitize_text, attachment)
+
+        reply(conversation, conversation.last_message.recipients, reply_body, subject, sanitize_text, attachment)
       end
 
       #Mark the object as read for messageable.
@@ -109,15 +116,13 @@ module Mailboxer
       def mark_as_read(obj)
         case obj
         when Receipt
-          return obj.mark_as_read if obj.receiver == self
+          obj.mark_as_read if obj.receiver == self
         when Message, Notification
           obj.mark_as_read(self)
         when Conversation
           obj.mark_as_read(self)
         when Array
           obj.map{ |sub_obj| mark_as_read(sub_obj) }
-        else
-          return nil
         end
       end
 
@@ -132,15 +137,36 @@ module Mailboxer
       def mark_as_unread(obj)
         case obj
         when Receipt
-          return obj.mark_as_unread if obj.receiver == self
+          obj.mark_as_unread if obj.receiver == self
         when Message, Notification
           obj.mark_as_unread(self)
         when Conversation
           obj.mark_as_unread(self)
         when Array
           obj.map{ |sub_obj| mark_as_unread(sub_obj) }
-        else
-        return nil
+        end
+      end
+
+      #Mark the object as deleted for messageable.
+      #
+      #Object can be:
+      #* A Receipt
+      #* A Notification
+      #* A Message
+      #* A Conversation
+      #* An array with any of them
+      def mark_as_deleted(obj)
+        case obj
+          when Receipt
+            return obj.mark_as_deleted if obj.receiver == self
+          when Message, Notification
+            obj.mark_as_deleted(self)
+          when Conversation
+            obj.mark_as_deleted(self)
+          when Array
+            obj.map{ |sub_obj| mark_as_deleted(sub_obj) }
+          else
+            return nil
         end
       end
 
@@ -155,15 +181,13 @@ module Mailboxer
       def trash(obj)
         case obj
         when Receipt
-          return obj.move_to_trash if obj.receiver == self
+          obj.move_to_trash if obj.receiver == self
         when Message, Notification
           obj.move_to_trash(self)
         when Conversation
           obj.move_to_trash(self)
         when Array
           obj.map{ |sub_obj| trash(sub_obj) }
-        else
-        return nil
         end
       end
 
@@ -178,15 +202,13 @@ module Mailboxer
       def untrash(obj)
         case obj
         when Receipt
-          return obj.untrash if obj.receiver == self
+          obj.untrash if obj.receiver == self
         when Message, Notification
           obj.untrash(self)
         when Conversation
           obj.untrash(self)
         when Array
           obj.map{ |sub_obj| untrash(sub_obj) }
-        else
-        return nil
         end
       end
 

data/mailboxer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "mailboxer"
-  s.version = "0.10.3"
+  s.version = "0.11.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, adding the ability to exchange messages " +
@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.email = "ecasanovac@gmail.com"
   s.homepage = "https://github.com/ging/mailboxer"
   s.files = `git ls-files`.split("\n")
+  s.license = 'MIT'
 
   # Gem dependencies
   #
@@ -26,6 +27,7 @@ Gem::Specification.new do |s|
   end
   # Specs
   s.add_development_dependency('rspec-rails', '>= 2.6.1')
+  s.add_development_dependency("appraisal")
   # Fixtures
   #if RUBY_VERSION >= '1.9.2'
    # s.add_development_dependency('factory_girl', '>= 3.0.0')
@@ -38,7 +40,10 @@ Gem::Specification.new do |s|
   # Integration testing
   s.add_development_dependency('capybara', '>= 0.3.9')
   # Testing database
-  s.add_development_dependency('sqlite3-ruby') unless RUBY_PLATFORM == 'java'
-  s.add_development_dependency('jdbc-sqlite3') if RUBY_PLATFORM == 'java'
-  s.add_development_dependency('activerecord-jdbcsqlite3-adapter') if RUBY_PLATFORM == 'java'
+  if RUBY_PLATFORM == 'java'
+    s.add_development_dependency('jdbc-sqlite3')
+    s.add_development_dependency('activerecord-jdbcsqlite3-adapter', '1.3.0.rc1')
+  else
+    s.add_development_dependency('sqlite3')
+  end
 end

data/spec/dummy/config/environments/test.rb

@@ -7,9 +7,7 @@ Dummy::Application.configure do
   # and recreated between test runs.  Don't rely on the data there!
   config.cache_classes = true
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
-
+  config.eager_load = false unless Rails::VERSION::MAJOR == 3
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false

data/spec/mailers/message_mailer_spec.rb

@@ -1,95 +1,94 @@
 require 'spec_helper'
 
 describe MessageMailer do
-  describe "when sending new message" do
-    before do
-      @sender = FactoryGirl.create(:user)
-      @entity1 = FactoryGirl.create(:user)
-      @entity2 = FactoryGirl.create(:duck)
-      @entity3 = FactoryGirl.create(:cylon)
-      @receipt1 = @sender.send_message([@entity1,@entity2,@entity3], "Body Body Body Body Body Body Body Body Body Body Body Body","Subject")
-    end
+  shared_examples 'message_mailer' do
+    let(:sender) { FactoryGirl.create(:user) }
+    let(:entity1) { FactoryGirl.create(:user) }
+    let(:entity2) { FactoryGirl.create(:duck) }
+    let(:entity3) { FactoryGirl.create(:cylon) }
 
-    it "should send emails when should_email? is true (1 out of 3)" do
-      ActionMailer::Base.deliveries.empty?.should==false
-      ActionMailer::Base.deliveries.size.should==1
+    def sent_to?(entity)
+      ActionMailer::Base.deliveries.any? do |email|
+        email.to.first.to_s == entity.email
+      end
     end
 
-    it "should send an email to user entity" do
-      temp = false
-      ActionMailer::Base.deliveries.each do |email|
-        if email.to.first.to_s.eql? @entity1.email
-        temp = true
-        end
+    describe "when sending new message" do
+      before do
+        @receipt1 = sender.send_message([entity1, entity2, entity3], "Body", "Subject")
+      end
+
+      it "should send emails when should_email? is true (1 out of 3)" do
+        ActionMailer::Base.deliveries.should_not be_empty
+        ActionMailer::Base.deliveries.should have(1).item
+      end
+
+      it "should send an email to user entity" do
+        sent_to?(entity1).should be_true
       end
-      temp.should==true
-    end
 
-    it "shouldn't send an email to duck entity" do
-      temp = false
-      ActionMailer::Base.deliveries.each do |email|
-        if email.to.first.to_s.eql? @entity2.email
-        temp = true
-        end
+      it "shouldn't send an email to duck entity" do
+        sent_to?(entity2).should be_false
+      end
+
+      it "shouldn't send an email to cylon entity" do
+        sent_to?(entity3).should be_false
       end
-      temp.should==false
     end
 
-    it "shouldn't send an email to cylon entity" do
-      temp = false
-      ActionMailer::Base.deliveries.each do |email|
-        if email.to.first.to_s.eql? @entity3.email
-        temp = true
-        end
+    describe "when replying" do
+      before do
+        @receipt1 = sender.send_message([entity1, entity2, entity3], "Body", "Subject")
+        @receipt2 = sender.reply_to_all(@receipt1, "Body")
+      end
+
+      it "should send emails when should_email? is true (1 out of 3)" do
+        ActionMailer::Base.deliveries.should_not be_empty
+        ActionMailer::Base.deliveries.should have(2).items
+      end
+
+      it "should send an email to user entity" do
+        sent_to?(entity1).should be_true
+      end
+
+      it "shouldn't send an email to duck entity" do
+        sent_to?(entity2).should be_false
+      end
+
+      it "shouldn't send an email to cylon entity" do
+        sent_to?(entity3).should be_false
       end
-      temp.should==false
     end
   end
 
-  describe "when replying" do
-    before do
-      @sender = FactoryGirl.create(:user)
-      @entity1 = FactoryGirl.create(:user)
-      @entity2 = FactoryGirl.create(:duck)
-      @entity3 = FactoryGirl.create(:cylon)
-      @receipt1 = @sender.send_message([@entity1,@entity2,@entity3], "Body","Subject")
-      @receipt2 = @sender.reply_to_all(@receipt1, "Body")
-    end
-    
-    it "should send emails when should_email? is true (1 out of 3)" do
-      ActionMailer::Base.deliveries.empty?.should==false
-      ActionMailer::Base.deliveries.size.should==2
-    end
+  context "when mailer_wants_array is false" do
+    it_behaves_like 'message_mailer'
+  end
 
-    it "should send an email to user entity" do
-      temp = false
-      ActionMailer::Base.deliveries.each do |email|
-        if email.to.first.to_s.eql? @entity1.email
-        temp = true
-        end
+  context "mailer_wants_array is true" do
+    class ArrayMailer < MessageMailer
+      default template_path: 'message_mailer'
+
+      def new_message_email(message, receivers)
+        receivers.each { |receiver| super(message, receiver) if receiver.mailboxer_email(message).present? }
       end
-      temp.should==true
-    end
 
-    it "shouldn't send an email to duck entity" do
-      temp = false
-      ActionMailer::Base.deliveries.each do |email|
-        if email.to.first.to_s.eql? @entity2.email
-        temp = true
-        end
+      def reply_message_email(message, receivers)
+        receivers.each { |receiver| super(message, receiver) if receiver.mailboxer_email(message).present? }
       end
-      temp.should==false
     end
 
-    it "shouldn't send an email to cylon entity" do
-      temp = false
-      ActionMailer::Base.deliveries.each do |email|
-        if email.to.first.to_s.eql? @entity3.email
-        temp = true
-        end
-      end
-      temp.should==false
+    before :all do
+      Mailboxer.mailer_wants_array = true
+      Mailboxer.message_mailer = ArrayMailer
     end
+
+    after :all do
+      Mailboxer.mailer_wants_array = false
+      Mailboxer.message_mailer = MessageMailer
+    end
+
+    it_behaves_like 'message_mailer'
   end
 end