has_emails 0.0.1 → 0.1.0

data/lib/has_emails.rb

@@ -1,92 +1,65 @@
 require 'has_messages'
 require 'validates_as_email_address'
-require 'acts_as_tokenized'
-require 'nested_has_many_through'
+require 'has_emails/extensions/action_mailer'
 
 module PluginAWeek #:nodoc:
-  module Has #:nodoc:
-    # Adds support for sending emails to models
-    module Emails
-      def self.included(base) #:nodoc:
-        base.extend(MacroMethods)
+  # Adds a generic implementation for sending emails
+  module HasEmails
+    def self.included(base) #:nodoc:
+      base.class_eval do
+        extend PluginAWeek::HasEmails::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
+    end
+    
+    module MacroMethods
+      # Creates the following email associations:
+      # * +emails+ - Emails that were composed and are visible to the owner.  Emails may have been sent or unsent.
+      # * +received_emails - Emails that have been received from others and are visible.  Emails may have been read or unread.
+      # 
+      # == Creating new emails
+      # 
+      # To create a new email, the +emails+ association should be used, for example:
+      # 
+      #   address = EmailAddress.find(123)
+      #   email = user.emails.build
+      #   email.subject = 'Hello'
+      #   email.body = 'How are you?'
+      #   email.to User.EmailAddress(456)
+      #   email.save!
+      #   email.deliver!
+      # 
+      # Alternatively, 
+      def has_emails
+        has_many  :emails,
+                    :as => :sender,
+                    :class_name => 'Email',
+                    :conditions => {:hidden_at => nil},
+                    :order => 'messages.created_at ASC'
+        has_many  :received_emails,
+                    :as => :receiver,
+                    :class_name => 'MessageRecipient',
+                    :include => :message,
+                    :conditions => ['message_recipients.hidden_at IS NULL AND messages.state = ?', 'sent'],
+                    :order => 'messages.created_at ASC'
         
-        # 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
+        include PluginAWeek::HasEmails::InstanceMethods
+      end
+    end
+    
+    module InstanceMethods
+      # Composed emails that have not yet been sent
+      def unsent_emails
+        emails.with_state('unsent')
       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
+      # Composed emails that have already been sent
+      def sent_emails
+        emails.with_states(%w(queued sent))
       end
     end
   end
 end
 
 ActiveRecord::Base.class_eval do
-  include PluginAWeek::Has::Emails
+  include PluginAWeek::HasEmails
 end

data/test/app_root/config/environment.rb

@@ -1,33 +1,10 @@
 require 'config/boot'
-
-$:.unshift("#{RAILS_ROOT}/../../../../../rails/plugin_dependencies/lib")
-begin
-  require 'plugin_dependencies'
-rescue Exception => e
-end
+require "#{File.dirname(__FILE__)}/../../../../plugins_plus/boot"
 
 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.plugin_paths << '..'
+  config.plugins = %w(plugins_plus state_machine has_messages validates_as_email_address has_emails)
   config.cache_classes = false
   config.whiny_nils = true
+  config.action_mailer.delivery_method = :test
 end
-
-Plugin.mix_code_from(:mailers => /.+_mailer/)

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

@@ -0,0 +1,9 @@
+class MigrateHasMessagesToVersion2 < ActiveRecord::Migration
+  def self.up
+    Rails::Plugin.find(:has_messages).migrate(2)
+  end
+  
+  def self.down
+    Rails::Plugin.find(:has_messages).migrate(0)
+  end
+end

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

@@ -0,0 +1,9 @@
+class MigrateHasEmailsToVersion1 < ActiveRecord::Migration
+  def self.up
+    Rails::Plugin.find(:has_emails).migrate(1)
+  end
+  
+  def self.down
+    Rails::Plugin.find(:has_emails).migrate(0)
+  end
+end

data/test/factory.rb

@@ -0,0 +1,48 @@
+module Factory
+  # Build actions for the class
+  def self.build(klass, &block)
+    name = klass.to_s.underscore
+    define_method("#{name}_attributes", block)
+    
+    module_eval <<-end_eval
+      def valid_#{name}_attributes(attributes = {})
+        #{name}_attributes(attributes)
+        attributes
+      end
+      
+      def new_#{name}(attributes = {})
+        #{klass}.new(valid_#{name}_attributes(attributes))
+      end
+      
+      def create_#{name}(*args)
+        record = new_#{name}(*args)
+        record.save!
+        record.reload
+        record
+      end
+    end_eval
+  end
+  
+  build Email do |attributes|
+    attributes[:sender] = create_user unless attributes.include?(:sender)
+    attributes.reverse_merge!(
+      :subject => 'New features',
+      :body => 'Lots of new things to talk about... come to the meeting tonight to find out!'
+    )
+  end
+  
+  build EmailAddress do |attributes|
+    attributes.reverse_merge!(
+      :name => 'John Smith',
+      :spec => 'john.smith@gmail.com'
+    )
+  end
+  
+  build MessageRecipient do |attributes|
+    attributes[:message] = create_message unless attributes.include?(:message)
+    attributes[:receiver] = create_user(:login => 'me') unless attributes.include?(:receiver)
+    attributes.reverse_merge!(
+      :kind => 'to'
+    )
+  end
+end

data/test/functional/has_emails_test.rb

@@ -0,0 +1,139 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class EmailAddressByDefaultFunctionalTest < Test::Unit::TestCase
+  def setup
+    @email_address = create_email_address
+  end
+  
+  def test_should_not_have_any_emails
+    assert @email_address.emails.empty?
+  end
+  
+  def test_should_not_have_any_unsent_emails
+    assert @email_address.unsent_emails.empty?
+  end
+  
+  def test_should_not_have_any_sent_emails
+    assert @email_address.sent_emails.empty?
+  end
+  
+  def test_should_not_have_any_received_emails
+    assert @email_address.received_emails.empty?
+  end
+end
+
+class EmailAddresFunctionalsTest < Test::Unit::TestCase
+  def setup
+    @email_address = create_email_address
+  end
+  
+  def test_should_be_able_to_create_new_emails
+    email = @email_address.emails.build
+    assert_instance_of Email, email
+    assert_equal @email_address, email.sender
+  end
+  
+  def test_should_be_able_to_send_new_emails
+    email = @email_address.emails.build
+    email.to create_email_address(:spec => 'jane.smith@gmail.com')
+    assert email.deliver!
+  end
+end
+
+class EmailAddressWithUnsentEmails < Test::Unit::TestCase
+  def setup
+    @email_address = create_email_address
+    @sent_email = create_email(:sender => @email_address, :to => create_email_address(:spec => 'jane.smith@gmail.com'))
+    @sent_email.deliver!
+    @first_draft = create_email(:sender => @email_address)
+    @second_draft = create_email(:sender => @email_address)
+  end
+  
+  def test_should_have_unsent_emails
+    assert_equal [@first_draft, @second_draft], @email_address.unsent_emails
+  end
+  
+  def test_should_include_unsent_emails_in_emails
+    assert_equal [@sent_email, @first_draft, @second_draft], @email_address.emails
+  end
+end
+
+class EmailAddressWithSentEmails < Test::Unit::TestCase
+  def setup
+    @email_address = create_email_address
+    @to = create_email_address(:spec => 'jane.smith@gmail.com')
+    @draft = create_email(:sender => @email_address)
+    
+    @first_sent_email = create_email(:sender => @email_address, :to => @to)
+    @first_sent_email.deliver!
+    
+    @second_sent_email = create_email(:sender => @email_address, :to => @to)
+    @second_sent_email.deliver!
+  end
+  
+  def test_should_have_sent_emails
+    assert_equal [@first_sent_email, @second_sent_email], @email_address.sent_emails
+  end
+  
+  def test_should_include_sent_emails_in_emails
+    assert_equal [@draft, @first_sent_email, @second_sent_email], @email_address.emails
+  end
+end
+
+class EmailAddressWithReceivedEmails < Test::Unit::TestCase
+  def setup
+    @sender = create_email_address
+    @email_address = create_email_address(:spec => 'jane.smith@gmail.com')
+    
+    @unsent_email = create_email(:sender => @sender, :to => @email_address)
+    
+    @first_sent_email = create_email(:sender => @sender, :to => @email_address)
+    @first_sent_email.deliver!
+    
+    @second_sent_email = create_email(:sender => @sender, :to => @email_address)
+    @second_sent_email.deliver!
+  end
+  
+  def test_should_have_received_emails
+    assert_equal [@first_sent_email, @second_sent_email], @email_address.received_emails.map(&:message)
+  end
+end
+
+class EmailAddressWithHiddenEmailsTest < Test::Unit::TestCase
+  def setup
+    @email_address = create_email_address
+    @friend = create_email_address(:spec => 'jane.smith@gmail.com')
+    
+    hidden_unsent_email = create_email(:sender => @email_address)
+    hidden_unsent_email.hide!
+    @unsent_email = create_email(:sender => @email_address)
+    
+    hidden_sent_email = create_email(:sender => @email_address, :to => @friend)
+    hidden_sent_email.deliver!
+    hidden_sent_email.hide!
+    @sent_email = create_email(:sender => @email_address, :to => @friend)
+    @sent_email.deliver!
+    
+    hidden_received_email = create_email(:sender => @friend, :to => @email_address)
+    hidden_received_email.deliver!
+    hidden_received_email.recipients.first.hide!
+    @received_email = create_email(:sender => @friend, :to => @email_address)
+    @received_email.deliver!
+  end
+  
+  def test_should_not_include_hidden_emails_in_emails
+    assert_equal [@unsent_email, @sent_email], @email_address.emails
+  end
+  
+  def test_should_not_include_hidden_emails_in_unsent_emails
+    assert_equal [@unsent_email], @email_address.unsent_emails
+  end
+  
+  def test_should_not_include_hidden_emails_in_sent_emails
+    assert_equal [@sent_email], @email_address.sent_emails
+  end
+  
+  def test_should_not_include_hidden_emails_in_received_emails
+    assert_equal [@received_email], @email_address.received_emails.map(&:message)
+  end
+end

data/test/test_helper.rb

@@ -1,76 +1,13 @@
-# 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")
+$:.unshift("#{File.dirname(__FILE__)}/../../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
+# Run the 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
-
+# Mixin the factory helper
+require File.expand_path("#{File.dirname(__FILE__)}/factory")
 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
+  include Factory
 end

data/test/unit/action_mailer_test.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class ActionMailerTest < Test::Unit::TestCase
+  class TestMailer < ActionMailer::Base
+    def signed_up(recipient)
+      subject    'Thanks for signing up'
+      from       'MyWebApp <welcome@mywebapp.com>'
+      recipients recipient
+      cc         'Nobody <nobody@mywebapp.com>'
+      bcc        'root@mywebapp.com'
+      body       'Congratulations!'
+    end
+  end
+  
+  def setup
+    ActionMailer::Base.deliveries = []
+  end
+  
+  def test_should_use_camelized_application_name_for_default_subject_prefix
+    assert_equal '[AppRoot] ', ActionMailer::Base.default_subject_prefix
+  end
+  
+  def test_should_queue_email
+    assert_nothing_raised {TestMailer.queue_signed_up('john.smith@gmail.com')}
+    assert_equal 1, Email.count
+    
+    email = Email.find(1)
+    assert_equal '[AppRoot] Thanks for signing up', email.subject
+    assert_equal 'Congratulations!', email.body
+    assert_equal 'MyWebApp <welcome@mywebapp.com>', email.sender.with_name
+    assert_equal ['john.smith@gmail.com'], email.to.map(&:with_name)
+    assert_equal ['Nobody <nobody@mywebapp.com>'], email.cc.map(&:with_name)
+    assert_equal ['root@mywebapp.com'], email.bcc.map(&:with_name)
+  end
+  
+  def test_should_deliver_email
+    email = create_email(
+      :subject => 'Hello',
+      :body => 'How are you?',
+      :sender => create_email_address(:name => 'MyWebApp', :spec => 'welcome@mywebapp.com'),
+      :to => create_email_address(:spec => 'john.smith@gmail.com'),
+      :cc => create_email_address(:name => 'Nobody', :spec => 'nobody@mywebapp.com'),
+      :bcc => create_email_address(:spec => 'root@mywebapp.com')
+    )
+    
+    assert_nothing_raised {ActionMailer::Base.deliver_email(email)}
+    assert_equal 1, ActionMailer::Base.deliveries.size
+    
+    delivery = ActionMailer::Base.deliveries.first
+    assert_equal 'Hello', delivery.subject
+    assert_equal 'How are you?', delivery.body
+    assert_equal ['welcome@mywebapp.com'], delivery.from
+    assert_equal ['john.smith@gmail.com'], delivery.to
+    assert_equal ['nobody@mywebapp.com'], delivery.cc
+    assert_equal ['root@mywebapp.com'], delivery.bcc
+  end
+end