has_emails 0.0.1

data/db/migrate/003_add_email_recipient_specs.rb

@@ -0,0 +1,18 @@
+class AddEmailRecipientSpecs < ActiveRecord::Migration
+  def self.up
+    # Workaround change_column not allowing change to :null => true
+    remove_column :message_recipients, :receiver_id
+    remove_column :message_recipients, :receiver_type
+    
+    add_column :message_recipients, :receiver_id, :integer, :null => true, :default => nil, :references => nil
+    add_column :message_recipients, :receiver_type, :string, :null => true, :default => nil
+    add_column :message_recipients, :receiver_spec, :string, :limit => 320
+  end
+
+  def self.down
+    remove_column :message_recipients, :receiver_spec
+    
+    change_column :message_recipients, :receiver_id, :integer, :null => false, :references => nil
+    change_column :message_recipients, :receiver_type, :string, :null => false
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'has_emails'

data/lib/has_emails.rb

@@ -0,0 +1,92 @@
+require 'has_messages'
+require 'validates_as_email_address'
+require 'acts_as_tokenized'
+require 'nested_has_many_through'
+
+module PluginAWeek #:nodoc:
+  module Has #:nodoc:
+    # Adds support for sending emails to models
+    module Emails
+      def self.included(base) #:nodoc:
+        base.extend(MacroMethods)
+      end
+      
+      module MacroMethods
+        # Adds support for emailing instances of this model through multiple
+        # email addresses.
+        # 
+        # == Generated associations
+        # 
+        # The following +has_many+ associations are created for models that support
+        # emailing:
+        # * +email_addresses+ - The email addresses of this model
+        # * +emails+ - A collection of Emails of which this model was the sender
+        # * +email_recipients+ - A collection of EmailRecipients in which this record is a receiver
+        def has_email_addresses
+          has_many  :email_addresses,
+                      :class_name => 'EmailAddress',
+                      :as => :emailable,
+                      :dependent => :destroy
+          
+          # Add associations for all emails the model has sent and received
+          has_many  :emails,
+                      :through => :email_addresses
+          has_many  :email_recipients,
+                      :through => :email_addresses
+          
+          include PluginAWeek::Has::Emails::InstanceMethods
+        end
+        
+        # Adds support for emailing instances of this model through a single
+        # email address.
+        # 
+        # == Generated associations
+        # 
+        # The following associations are created for models that support emailing:
+        # * +email_address+ - The email address of this model
+        # * +emails+ - A collection of Emails of which this model was the sender
+        # * +email_recipients+ - A collection of EmailRecipients in which this record is a receiver
+        def has_email_address
+          has_one :email_address,
+                    :class_name => 'EmailAddress',
+                    :as => :emailable,
+                    :dependent => :destroy
+          
+          delegate  :emails,
+                    :email_recipients,
+                      :to => :email_address
+          
+          include PluginAWeek::Has::Emails::InstanceMethods
+        end
+      end
+      
+      module InstanceMethods
+        # All emails this model has received
+        def received_emails
+          email_recipients.active.find_in_states(:all, :unread, :read, :include => :message, :conditions => ['messages.state_id = ?', Message.states.find_by_name('sent').id]).collect do |recipient|
+            ReceivedMessage.new(recipient)
+          end
+        end
+        
+        # All emails that have not yet been sent by this model (excluding any that have been deleted)
+        def unsent_emails(*args)
+          emails.active.unsent(*args)
+        end
+        
+        # All emails that have been sent by this model (excluding any that have been deleted)
+        def sent_emails(*args)
+          emails.active.find_in_states(:all, :queued, :sent, *args)
+        end
+        
+        # Contains all of the emails that have been sent and received
+        def email_box
+          @email_box ||= MessageBox.new(received_emails, unsent_emails, sent_emails)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include PluginAWeek::Has::Emails
+end

data/test/app_root/app/models/department.rb

@@ -0,0 +1,2 @@
+class Department < ActiveRecord::Base
+end

data/test/app_root/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_email_addresses
+end

data/test/app_root/config/environment.rb

@@ -0,0 +1,33 @@
+require 'config/boot'
+
+$:.unshift("#{RAILS_ROOT}/../../../../../rails/plugin_dependencies/lib")
+begin
+  require 'plugin_dependencies'
+rescue Exception => e
+end
+
+Rails::Initializer.run do |config|
+  config.plugin_paths.concat([
+    "#{RAILS_ROOT}/../../..",
+    "#{RAILS_ROOT}/../../../../migrations",
+    "#{RAILS_ROOT}/../../../../../rails",
+    "#{RAILS_ROOT}/../../../../../test",
+    "#{RAILS_ROOT}/../../../../../third_party"
+  ])
+  config.plugins = [
+    'loaded_plugins',
+    'appable_plugins',
+    'plugin_migrations',
+    'has_states',
+    'has_finder',
+    'has_messages',
+    'acts_as_tokenized',
+    'nested_has_many_through',
+    File.basename(File.expand_path("#{RAILS_ROOT}/../..")),
+    'dry_validity_assertions'
+  ]
+  config.cache_classes = false
+  config.whiny_nils = true
+end
+
+Plugin.mix_code_from(:mailers => /.+_mailer/)

data/test/app_root/db/migrate/001_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.column :login, :string, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/test/app_root/db/migrate/002_create_departments.rb

@@ -0,0 +1,12 @@
+class CreateDepartments < ActiveRecord::Migration
+  def self.up
+    create_table :departments do |t|
+      t.column :name, :string, :null => false
+      t.column :email_address, :string, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :departments
+  end
+end

data/test/fixtures/departments.yml

@@ -0,0 +1,9 @@
+marketing:
+  id: 1
+  name: Marketing
+  email_address: marketing@companyxyz.com
+  
+testing:
+  id: 2
+  name: Testing
+  email_address: testing@companyxyz.com

data/test/fixtures/email_addresses.yml

@@ -0,0 +1,32 @@
+bob:
+  id: 1
+  emailable_id: 1
+  emailable_type: User
+  spec: bob@bob.com
+  verification_code: c2e4f499bf610fa95b8ee3a4e8013dbe
+  code_expiry: <%= Time.now.to_s(:db) %>
+  created_at: <%= Time.now.to_s(:db) %>
+  updated_at: <%= Time.now.to_s(:db) %>
+  state_id: 601
+  
+john:
+  id: 2
+  emailable_id: 2
+  emailable_type: User
+  spec: john@john.com
+  verification_code: 1d3955ee0d05ce5bb847f29d56b990cc
+  code_expiry: <%= Time.now.to_s(:db) %>
+  created_at: <%= Time.now.to_s(:db) %>
+  updated_at: <%= Time.now.to_s(:db) %>
+  state_id: 602
+  
+mary:
+  id: 3
+  emailable_id: 3
+  emailable_type: User
+  spec: mary@mary.com
+  verification_code: 8323145e816cb063d405f5e365d14807
+  code_expiry: <%= Time.now.to_s(:db) %>
+  created_at: <%= Time.now.to_s(:db) %>
+  updated_at: <%= Time.now.to_s(:db) %>
+  state_id: 602

data/test/fixtures/message_recipients.yml

@@ -0,0 +1,85 @@
+bob_to_john:
+  id: 1
+  message_id: 1
+  receiver_id: 2
+  receiver_type: EmailAddress
+  receiver_spec: john@john.com
+  kind: to
+  position: 1
+  state_id: 511
+  type: EmailRecipient
+  
+bob_to_mary:
+  id: 2
+  message_id: 1
+  receiver_id: 3
+  receiver_type: EmailAddress
+  receiver_spec: mary@mary.com
+  kind: cc
+  position: 1
+  state_id: 510
+  type: EmailRecipient
+  
+bob_to_random:
+  id: 3
+  message_id: 1
+  receiver_spec: random@random.com
+  kind: cc
+  position: 2
+  state_id: 510
+  type: EmailRecipient
+  
+bob_to_marketing:
+  id: 4
+  message_id: 1
+  receiver_id: 1
+  receiver_type: Department
+  receiver_spec: marketing@companyxyz.com
+  kind: cc
+  position: 3
+  state_id: 510
+  type: EmailRecipient
+  
+mary_to_john:
+  id: 5
+  message_id: 2
+  receiver_id: 2
+  receiver_type: EmailAddress
+  receiver_spec: john@john.com
+  kind: bcc
+  position: 1
+  state_id: 510
+  type: EmailRecipient
+  
+unsent_bob_to_john:
+  id: 6
+  message_id: 3
+  receiver_id: 2
+  receiver_type: EmailAddress
+  receiver_spec: john@john.com
+  kind: to
+  position: 1
+  state_id: 510
+  type: EmailRecipient
+  
+unsent_bob_to_mary:
+  id: 7
+  message_id: 3
+  receiver_id: 3
+  receiver_type: EmailAddress
+  receiver_spec: mary@mary.com
+  kind: cc
+  position: 1
+  state_id: 510
+  type: EmailRecipient
+  
+queued_bob_to_john:
+  id: 8
+  message_id: 4
+  receiver_id: 2
+  receiver_type: User
+  receiver_spec: john@john.com
+  kind: to
+  position: 1
+  state_id: 510
+  type: EmailRecipient

data/test/fixtures/messages.yml

@@ -0,0 +1,52 @@
+sent_from_bob:
+  id: 1
+  sender_id: 1
+  sender_type: EmailAddress
+  sender_spec: bob@bob.com
+  subject: "Funny joke"
+  body: "Why can't dinosaurs talk? ...Because they're dead!"
+  created_at: <%= Time.now.to_s(:db) %>
+  state_id: 502
+  type: Email
+  
+sent_from_mary:
+  id: 2
+  sender_id: 3
+  sender_type: EmailAddress
+  sender_spec: mary@mary.com
+  subject: "FW: Funny joke"
+  body: "> Why can't dinosaurs talk? ...Because they're dead!"
+  created_at: <%= Time.now.to_s(:db) %>
+  state_id: 502
+  type: Email
+  
+unsent_from_bob:
+  id: 3
+  sender_id: 1
+  sender_type: EmailAddress
+  sender_spec: bob@bob.com
+  subject: "Another funny joke"
+  body: "Where do cows go on a date? ...To the moovies!"
+  created_at: <%= Time.now.to_s(:db) %>
+  state_id: 500
+  type: Email
+  
+queued_from_bob:
+  id: 4
+  sender_id: 1
+  sender_type: EmailAddress
+  sender_spec: bob@bob.com
+  subject: ""
+  body: ""
+  created_at: <%= Time.now.to_s(:db) %>
+  state_id: 501
+  type: Email
+  
+unsent_from_stranger:
+  id: 5
+  sender_spec: stranger@somewhere.com
+  subject: "Do you know where I am?"
+  body: "Just wondering..."
+  created_at: <%= Time.now.to_s(:db) %>
+  state_id: 500
+  type: Email

data/test/fixtures/state_changes.yml

@@ -0,0 +1,128 @@
+# Emails
+sent_from_bob_unsent:
+  id: 1
+  stateful_id: 1
+  stateful_type: Email
+  to_state_id: 500
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+sent_from_bob_sent:
+  id: 2
+  stateful_id: 1
+  stateful_type: Email
+  from_state_id: 500
+  to_state_id: 502
+  event_id: 500
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+sent_from_mary_unsent:
+  id: 3
+  stateful_id: 2
+  stateful_type: Email
+  to_state_id: 500
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+sent_from_mary_sent:
+  id: 4
+  stateful_id: 2
+  stateful_type: Email
+  from_state_id: 500
+  to_state_id: 502
+  event_id: 500
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+unsent_from_bob_unsent:
+  id: 5
+  stateful_id: 3
+  stateful_type: Email
+  to_state_id: 500
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+queued_from_bob_unsent:
+  id: 6
+  stateful_id: 4
+  stateful_type: Email
+  to_state_id: 500
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+queued_from_bob_queued:
+  id: 7
+  stateful_id: 4
+  stateful_type: Email
+  from_state_id: 500
+  to_state_id: 501
+  event_id: 501
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+unsent_from_stranger_unsent:
+  id: 8
+  stateful_id: 5
+  stateful_type: Email
+  to_state_id: 500
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+# EmailRecipients
+bob_to_john_unread:
+  id: 9
+  stateful_id: 1
+  stateful_type: EmailRecipient
+  to_state_id: 510
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+bob_to_john_read:
+  id: 10
+  stateful_id: 1
+  stateful_type: EmailRecipient
+  from_state_id: 510
+  to_state_id: 511
+  event_id: 510
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+bob_to_mary_unread:
+  id: 11
+  stateful_id: 2
+  stateful_type: EmailRecipient
+  to_state_id: 510
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+bob_to_random_unread:
+  id: 12
+  stateful_id: 3
+  stateful_type: EmailRecipient
+  to_state_id: 510
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+bob_to_marketing_unread:
+  id: 13
+  stateful_id: 4
+  stateful_type: EmailRecipient
+  to_state_id: 510
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+mary_to_john_unread:
+  id: 14
+  stateful_id: 5
+  stateful_type: EmailRecipient
+  to_state_id: 510
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+unsent_bob_to_john_unread:
+  id: 15
+  stateful_id: 6
+  stateful_type: EmailRecipient
+  to_state_id: 510
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+unsent_bob_to_mary_unread:
+  id: 16
+  stateful_id: 7
+  stateful_type: EmailRecipient
+  to_state_id: 510
+  occurred_at: <%= Time.now.to_s(:db) %>
+  
+queued_bob_to_john_unread:
+  id: 17
+  stateful_id: 8
+  stateful_type: EmailRecipient
+  to_state_id: 510
+  occurred_at: <%= Time.now.to_s(:db) %>

data/test/fixtures/users.yml

@@ -0,0 +1,11 @@
+bob:
+  id: 1
+  login: bob
+  
+john:
+  id: 2
+  login: john
+  
+mary:
+  id: 3
+  login: mary

data/test/test_helper.rb

@@ -0,0 +1,76 @@
+# Load local repository plugin paths
+$:.unshift("#{File.dirname(__FILE__)}/../../../associations/class_associations/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../../has/has_messages/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../../has/has_states/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../../miscellaneous/custom_callbacks/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../../miscellaneous/dry_transaction_rollbacks/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../../validations/validates_as_email_address/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../../../ruby/object/eval_call/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../../../third_party/acts_as_tokenized/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../../../third_party/nested_has_many_through/lib")
+
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../../../test/plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'
+
+# Run the plugin migrations
+%w(has_states has_messages has_emails).each do |plugin|
+  Rails.plugins[plugin].migrate
+end
+
+# Run the test app migrations
+ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate")
+
+# Bootstrap the database
+%w(has_messages has_emails).each do |plugin|
+  plugin = Rails.plugins[plugin]
+  bootstrap_path = "#{plugin.migration_path}/../bootstrap"
+  
+  Dir.glob("#{bootstrap_path}/*.{yml,csv}").each do |fixture_file|
+    table_name = File.basename(fixture_file, '.*')
+    Fixtures.new(ActiveRecord::Base.connection, table_name, nil, File.join(bootstrap_path, table_name)).insert_fixtures
+  end
+end
+
+class Test::Unit::TestCase #:nodoc:
+  def self.require_fixture_classes(table_names=nil)
+    # Don't allow fixture classes to be required because classes like Message are
+    # going to throw an error since the states and events have not yet been
+    # loaded
+  end
+  
+  # Freezes time for running email tests
+  def freeze_time(frozen_time = 946702800)
+    Time.instance_eval do
+      frozen_now = (frozen_time)
+      alias :original_now :now
+      alias :now :frozen_now
+    end
+    
+    if block_given?
+      begin
+        yield
+      ensure
+        unfreeze_time
+      end
+    end
+  end
+  
+  # Restores the original method for time
+  def unfreeze_time
+    Time.instance_eval do
+      alias :now :original_now
+    end    
+  end
+end
+
+class Time
+  def self.frozen_now=(val)
+    @frozen_now = val
+  end
+  
+  def self.frozen_now
+    Time.at(@frozen_now || 946702800)
+  end
+end

data/test/unit/application_mailer_test.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ApplicationMailerTest < Test::Unit::TestCase
+  fixtures :users, :email_addresses, :messages, :message_recipients, :state_changes
+  
+  class TestMailer < ApplicationMailer
+    def signed_up(recipient)
+      recipients recipient
+      subject    'Thanks for signing up'
+      from       'welcome@mywebapp.com'
+      cc         'nobody@mywebapp.com'
+      bcc        'root@mywebapp.com'
+      body       'Congratulations!'
+    end
+  end
+  
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.raise_delivery_errors = true
+    ActionMailer::Base.deliveries = []
+    
+    @original_logger = TestMailer.logger
+    @recipient = email_addresses(:bob)
+  end
+  
+  def test_should_use_camelized_application_name_for_default_subject_prefix
+    assert_equal '[AppRoot] ', ApplicationMailer.default_subject_prefix
+  end
+  
+  def test_should_queue_email
+    assert_nothing_raised { TestMailer.queue_signed_up(@recipient) }
+    assert_equal 6, Email.count
+    
+    email = Email.find(6)
+    assert_equal '[AppRoot] Thanks for signing up', email.subject
+    assert_equal 'Congratulations!', email.body
+    assert_equal [@recipient], email.to.map(&:receiver)
+    assert_equal 'welcome@mywebapp.com', email.sender
+    assert_equal ['nobody@mywebapp.com'], email.cc.map(&:receiver)
+    assert_equal ['root@mywebapp.com'], email.bcc.map(&:receiver)
+  end
+  
+  def test_should_deliver_email
+    freeze_time do 
+      expected = new_mail
+      expected.to      = 'john@john.com'
+      expected.cc      = 'mary@mary.com'
+      expected.subject = 'Another funny joke'
+      expected.body    = 'Where do cows go on a date? ...To the moovies!'
+      expected.from    = 'bob@bob.com'
+      expected.date    = Time.now
+      
+      assert_nothing_raised { ApplicationMailer.deliver_email(messages(:unsent_from_bob)) }
+      assert_not_nil ActionMailer::Base.deliveries.first
+      assert_equal expected.encoded, ActionMailer::Base.deliveries.first.encoded
+    end
+  end
+  
+  private
+  def new_mail( charset="utf-8" )
+    mail = TMail::Mail.new
+    mail.mime_version = "1.0"
+    if charset
+      mail.set_content_type "text", "plain", { "charset" => charset }
+    end
+    mail
+  end
+end