has_emails 0.1.4 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 == master
 
+== 0.2.0 / 2008-12-14
+
+* Remove the PluginAWeek namespace
+
 == 0.1.4 / 2008-10-26
 
 * Add compatibility with has_messages 0.2.0

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'has_emails'
-  s.version           = '0.1.4'
+  s.version           = '0.2.0'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Demonstrates a reference implementation for sending emails with logging and asynchronous support.'
   
@@ -13,7 +13,7 @@ spec = Gem::Specification.new do |s|
   s.require_path      = 'lib'
   s.has_rdoc          = true
   s.test_files        = Dir['test/**/*_test.rb']
-  s.add_dependency    'has_messages', '>= 0.2.0'
+  s.add_dependency    'has_messages', '>= 0.3.0'
   s.add_dependency    'validates_as_email_address', '>= 0.0.2'
   
   s.author            = 'Aaron Pfeifer'

data/lib/has_emails/extensions/action_mailer.rb

@@ -1,119 +1,117 @@
-module PluginAWeek #:nodoc:
-  module HasEmails
-    module Extensions #:nodoc:
-      # Adds support for queueing emails so that they can be procssed in the
-      # background.  Emails are stored in the database using the Email ActiveRecord
-      # model.
-      # 
-      # == Queueing mail
-      # 
-      # Once a mailer action and template are defined, you can queue your message
-      # for background processing like so:
-      # 
-      #   Notifier.queue_signup_notification(john_smith) # Queues the email
-      # 
-      # If you were to deliver the mail immediately, the normal process would be
-      # used like so:
-      # 
-      #   Notifier.deliver_signup_notification(john_smith) # Delivers the email
-      module ActionMailer
-        def self.included(base) #:nodoc:
-          base.class_eval do
-            @@default_subject_prefix = "[#{File.basename(File.expand_path(Rails.root)).camelize}] "
-            cattr_accessor :default_subject_prefix
-            
-            # Specify the prefix to use for the subject. This defaults to the
-            # +default_subject_prefix+ specified for ActionMailer::Base.
-            adv_attr_accessor :subject_prefix
-            
-            include PluginAWeek::HasEmails::Extensions::ActionMailer::InstanceMethods
-            extend PluginAWeek::HasEmails::Extensions::ActionMailer::ClassMethods
-          end
-        end
-        
-        module ClassMethods
-          def self.extended(base) #:nodoc:
-            class << base
-              alias_method_chain :method_missing, :has_emails
-            end
-          end
+module HasEmails
+  module Extensions #:nodoc:
+    # Adds support for queueing emails so that they can be procssed in the
+    # background.  Emails are stored in the database using the Email ActiveRecord
+    # model.
+    # 
+    # == Queueing mail
+    # 
+    # Once a mailer action and template are defined, you can queue your message
+    # for background processing like so:
+    # 
+    #   Notifier.queue_signup_notification(john_smith) # Queues the email
+    # 
+    # If you were to deliver the mail immediately, the normal process would be
+    # used like so:
+    # 
+    #   Notifier.deliver_signup_notification(john_smith) # Delivers the email
+    module ActionMailer
+      def self.included(base) #:nodoc:
+        base.class_eval do
+          @@default_subject_prefix = "[#{File.basename(File.expand_path(Rails.root)).camelize}] "
+          cattr_accessor :default_subject_prefix
           
-          # Handles calls to queue_*
-          def method_missing_with_has_emails(method_symbol, *parameters)
-            case method_symbol.id2name
-              when /^queue_([_a-z]\w*)/
-                # Queues the mail so that it's processed in the background
-                new($1, *parameters).queue
-              else
-                # Handle the mail delivery as normal
-                method_missing_without_has_emails(method_symbol, *parameters)
-            end
+          # Specify the prefix to use for the subject. This defaults to the
+          # +default_subject_prefix+ specified for ActionMailer::Base.
+          adv_attr_accessor :subject_prefix
+          
+          include HasEmails::Extensions::ActionMailer::InstanceMethods
+          extend HasEmails::Extensions::ActionMailer::ClassMethods
+        end
+      end
+      
+      module ClassMethods
+        def self.extended(base) #:nodoc:
+          class << base
+            alias_method_chain :method_missing, :has_emails
           end
         end
         
-        module InstanceMethods
-          def self.included(base) #:nodoc:
-            base.class_eval do
-              alias_method_chain :initialize_defaults, :subject_prefix
-              alias_method_chain :subject, :prefix
-              alias_method :subject=, :subject_with_prefix
-            end
-          end
-          
-          # Sets or gets the subject of the email.  All subjects are prefixed with a
-          # value indicating the application it is coming from.
-          def subject_with_prefix(*parameters)
-            if parameters.empty?
-              subject_without_prefix
+        # Handles calls to queue_*
+        def method_missing_with_has_emails(method_symbol, *parameters)
+          case method_symbol.id2name
+            when /^queue_([_a-z]\w*)/
+              # Queues the mail so that it's processed in the background
+              new($1, *parameters).queue
             else
-              subject_without_prefix(subject_prefix + subject_without_prefix(*parameters))
-            end
+              # Handle the mail delivery as normal
+              method_missing_without_has_emails(method_symbol, *parameters)
           end
-          
-          # Sets the default subject prefix
-          def initialize_defaults_with_subject_prefix(method_name) #:nodoc
-            initialize_defaults_without_subject_prefix(method_name)
-            @subject_prefix ||= ::ActionMailer::Base.default_subject_prefix.dup
+        end
+      end
+      
+      module InstanceMethods
+        def self.included(base) #:nodoc:
+          base.class_eval do
+            alias_method_chain :initialize_defaults, :subject_prefix
+            alias_method_chain :subject, :prefix
+            alias_method :subject=, :subject_with_prefix
           end
-          
-          # Delivers an email based on the content in the specified email
-          def email(email)
-            @from       = email.sender.with_name
-            @recipients = email.to.map(&:with_name)
-            @cc         = email.cc.map(&:with_name)
-            @bcc        = email.bcc.map(&:with_name)
-            @subject    = email.subject || ''
-            @body       = email.body || ''
-            @sent_on    = email.updated_at
+        end
+        
+        # Sets or gets the subject of the email.  All subjects are prefixed with a
+        # value indicating the application it is coming from.
+        def subject_with_prefix(*parameters)
+          if parameters.empty?
+            subject_without_prefix
+          else
+            subject_without_prefix(subject_prefix + subject_without_prefix(*parameters))
           end
-          
-          # Queues the current e-mail that has been constructed
-          def queue
-            Email.transaction do
-              # Create the main email
-              email = EmailAddress.find_or_create_by_address(from).emails.build(
-                :subject => subject,
-                :body => body,
-                :to => email_addresses_for(:recipients),
-                :cc => email_addresses_for(:cc),
-                :bcc => email_addresses_for(:bcc)
-              )
-              email.queue!
-            end
+        end
+        
+        # Sets the default subject prefix
+        def initialize_defaults_with_subject_prefix(method_name) #:nodoc
+          initialize_defaults_without_subject_prefix(method_name)
+          @subject_prefix ||= ::ActionMailer::Base.default_subject_prefix.dup
+        end
+        
+        # Delivers an email based on the content in the specified email
+        def email(email)
+          @from       = email.sender.with_name
+          @recipients = email.to.map(&:with_name)
+          @cc         = email.cc.map(&:with_name)
+          @bcc        = email.bcc.map(&:with_name)
+          @subject    = email.subject || ''
+          @body       = email.body || ''
+          @sent_on    = email.updated_at
+        end
+        
+        # Queues the current e-mail that has been constructed
+        def queue
+          Email.transaction do
+            # Create the main email
+            email = EmailAddress.find_or_create_by_address(from).emails.build(
+              :subject => subject,
+              :body => body,
+              :to => email_addresses_for(:recipients),
+              :cc => email_addresses_for(:cc),
+              :bcc => email_addresses_for(:bcc)
+            )
+            email.queue!
           end
-          
-          private
-            # Finds or creates all of the email addresses for the given type of
-            # recipient (can be :recipients, :cc, or :bcc)
-            def email_addresses_for(kind)
-              [send(kind)].flatten.collect {|address| EmailAddress.find_or_create_by_address(address)}
-            end
         end
+        
+        private
+          # Finds or creates all of the email addresses for the given type of
+          # recipient (can be :recipients, :cc, or :bcc)
+          def email_addresses_for(kind)
+            [send(kind)].flatten.collect {|address| EmailAddress.find_or_create_by_address(address)}
+          end
       end
     end
   end
 end
 
 ActionMailer::Base.class_eval do
-  include PluginAWeek::HasEmails::Extensions::ActionMailer
+  include HasEmails::Extensions::ActionMailer
 end

data/lib/has_emails.rb

@@ -2,58 +2,56 @@ require 'has_messages'
 require 'validates_as_email_address'
 require 'has_emails/extensions/action_mailer'
 
-module PluginAWeek #:nodoc:
-  # Adds a generic implementation for sending emails
-  module HasEmails
-    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 EmailAddress.find(456)
-      #   email.save!
-      #   email.deliver!
-      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'
-        
-        include PluginAWeek::HasEmails::InstanceMethods
-      end
+# Adds a generic implementation for sending emails
+module HasEmails
+  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 EmailAddress.find(456)
+    #   email.save!
+    #   email.deliver!
+    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'
+      
+      include HasEmails::InstanceMethods
+    end
+  end
+  
+  module InstanceMethods
+    # Composed emails that have not yet been sent.  These consists of all
+    # emails that are currently in the "unsent" state.
+    def unsent_emails
+      emails.with_state('unsent')
     end
     
-    module InstanceMethods
-      # Composed emails that have not yet been sent.  These consists of all
-      # emails that are currently in the "unsent" state.
-      def unsent_emails
-        emails.with_state('unsent')
-      end
-      
-      # Composed emails that have already been sent.  These consist of all emails
-      # that are currently in the "queued" or "sent states.
-      def sent_emails
-        emails.with_states(%w(queued sent))
-      end
+    # Composed emails that have already been sent.  These consist of all emails
+    # that are currently in the "queued" or "sent states.
+    def sent_emails
+      emails.with_states(%w(queued sent))
     end
   end
 end
 
 ActiveRecord::Base.class_eval do
-  extend PluginAWeek::HasEmails::MacroMethods
+  extend HasEmails::MacroMethods
 end

data/test/functional/has_emails_test.rb

@@ -105,18 +105,18 @@ class EmailAddressWithHiddenEmailsTest < Test::Unit::TestCase
     @friend = create_email_address(:spec => 'jane.smith@gmail.com')
     
     hidden_unsent_email = create_email(:sender => @email_address)
-    hidden_unsent_email.hide!
+    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!
+    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!
+    hidden_received_email.recipients.first.hide
     @received_email = create_email(:sender => @friend, :to => @email_address)
     @received_email.deliver
   end

data/test/unit/email_address_test.rb

@@ -23,19 +23,19 @@ class EmailAddressTest < Test::Unit::TestCase
   def test_should_require_a_spec
     email_address = new_email_address(:spec => nil)
     assert !email_address.valid?
-    assert_equal 3, Array(email_address.errors.on(:spec)).size
+    assert email_address.errors.invalid?(:spec)
   end
   
   def test_should_require_a_properly_formatted_email
     email_address = new_email_address(:spec => '!@@!@@!')
     assert !email_address.valid?
-    assert_equal 1, Array(email_address.errors.on(:spec)).size
+    assert email_address.errors.invalid?(:spec)
   end
   
   def test_should_not_allow_emails_less_than_3_characters
     email_address = new_email_address(:spec => 'aa')
     assert !email_address.valid?
-    assert_equal 2, Array(email_address.errors.on(:spec)).size
+    assert email_address.errors.invalid?(:spec)
     
     email_address.spec = 'a@a'
     assert email_address.valid?
@@ -47,7 +47,7 @@ class EmailAddressTest < Test::Unit::TestCase
     
     email_address.spec += 'a'
     assert !email_address.valid?
-    assert_equal 1, Array(email_address.errors.on(:spec)).size
+    assert email_address.errors.invalid?(:spec)
   end
   
   def test_should_require_a_unique_spec_scoped_by_name
@@ -58,7 +58,7 @@ class EmailAddressTest < Test::Unit::TestCase
     
     second_email_address = new_email_address(:spec => 'john.smith@gmail.com', :name => 'John Smith')
     assert !second_email_address.valid?
-    assert_equal 1, Array(second_email_address.errors.on(:spec)).size
+    assert second_email_address.errors.invalid?(:spec)
   end
   
   def test_should_not_require_a_name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: has_emails
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-26 00:00:00 -04:00
+date: 2008-12-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.0
+        version: 0.3.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: validates_as_email_address
@@ -46,28 +46,28 @@ files:
 - app/models/email_address.rb
 - db/migrate
 - db/migrate/001_create_email_addresses.rb
+- lib/has_emails.rb
 - lib/has_emails
 - lib/has_emails/extensions
 - lib/has_emails/extensions/action_mailer.rb
-- lib/has_emails.rb
-- test/app_root
-- test/app_root/app
-- test/app_root/app/models
-- test/app_root/app/models/empty
-- test/app_root/config
-- test/app_root/config/environment.rb
-- test/app_root/db
-- test/app_root/db/migrate
-- test/app_root/db/migrate/001_migrate_has_messages_to_version_2.rb
-- test/app_root/db/migrate/002_migrate_has_emails_to_version_1.rb
+- test/factory.rb
+- test/test_helper.rb
 - test/functional
 - test/functional/has_emails_test.rb
-- test/test_helper.rb
-- test/factory.rb
 - test/unit
-- test/unit/email_address_test.rb
 - test/unit/action_mailer_test.rb
 - test/unit/email_test.rb
+- test/unit/email_address_test.rb
+- test/app_root
+- test/app_root/db
+- test/app_root/db/migrate
+- test/app_root/db/migrate/002_migrate_has_emails_to_version_1.rb
+- test/app_root/db/migrate/001_migrate_has_messages_to_version_2.rb
+- test/app_root/config
+- test/app_root/config/environment.rb
+- test/app_root/app
+- test/app_root/app/models
+- test/app_root/app/models/empty
 - CHANGELOG.rdoc
 - init.rb
 - LICENSE
@@ -101,6 +101,6 @@ specification_version: 2
 summary: Demonstrates a reference implementation for sending emails with logging and asynchronous support.
 test_files: 
 - test/functional/has_emails_test.rb
-- test/unit/email_address_test.rb
 - test/unit/action_mailer_test.rb
 - test/unit/email_test.rb
+- test/unit/email_address_test.rb