aiwilliams-mlist 0.1.6 → 0.1.7

data/CHANGELOG

@@ -1,3 +1,14 @@
+*0.1.7 [Bug Fixes, Delivery Improvements] (2009-08-14)
+
+*   is maintained as spacing in html_to_text conversions [aiwilliams]
+* Fixed bug where delivered email included the original Cc header. This could cause all kinds of problems. [aiwilliams]
+* Fixed bug where list addresses in Cc header were not be utilized in determining the lists to deliver to. [aiwilliams]
+* Fixed bug where delivery date was left to the mercy of the Rails time configuration. Using Time.now. [aiwilliams]
+* Manager list can indicate if reply-to should be list address or subscriber. [aiwilliams]
+* Leaving the reply-to field intact when it already exists on incoming email. [aiwilliams]
+* Messages will not be delivered to addresses found in the TO and CC fields in order to keep those recipients from getting two emails. [aiwilliams]
+* Added ability to optionally copy sender. [aiwilliams]
+
 *0.1.6 [Bug Fixes] (March 5, 2009)
 
 * Messages are processed even when there are no recipients [aiwilliams]

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 1
-:patch: 6
+:patch: 7
 :major: 0
+:minor: 1

data/lib/mlist/email.rb

@@ -10,6 +10,14 @@ module MList
       tmail.header_string('x-beenthere') == list.address
     end
     
+    def date
+      if date_from_email = super
+        return date_from_email
+      else
+        self.created_at ||= Time.now
+      end
+    end
+    
     def from
       tmail.header_string('from')
     end
@@ -17,7 +25,7 @@ module MList
     # Answers the usable destination addresses of the email.
     #
     def list_addresses
-      bounce? ? tmail.header_string('to').match(/\Amlist-(.*)\Z/)[1] : tmail.to.collect(&:downcase)
+      bounce? ? tmail.header_string('to').match(/\Amlist-(.*)\Z/)[1] : recipient_addresses
     end
     
     # Answers true if this email is a bounce.
@@ -48,6 +56,12 @@ module MList
       end
     end
     
+    # Answers the set of addresses found in the TO and CC fields of the email.
+    #
+    def recipient_addresses
+      (Array(tmail.to) + Array(tmail.cc)).collect(&:downcase).uniq
+    end
+    
     def respond_to?(method)
       super || (method.to_s !~ /=\Z/ && tmail.respond_to?(method))
     end

data/lib/mlist/email_post.rb

@@ -12,7 +12,7 @@ module MList
   class EmailPost
     include MList::Util::EmailHelpers
     
-    ATTRIBUTE_NAMES = %w(html text mailer subject subscriber)
+    ATTRIBUTE_NAMES = %w(copy_sender html text mailer subject subscriber)
     ATTRIBUTE_NAMES.each do |attribute_name|
       define_method(attribute_name) do
         @attributes[attribute_name]
@@ -44,6 +44,10 @@ module MList
       end
     end
     
+    def copy_sender=(value)
+      @attributes['copy_sender'] = %w(true 1).include?(value.to_s)
+    end
+    
     def reply_to_message=(message)
       if message
         @parent_identifier = message.identifier
@@ -74,10 +78,7 @@ module MList
         builder.references = [bracket(parent_identifier)]
       end
       
-      from = subscriber.email_address
-      from = "#{subscriber.display_name} #{bracket(from)}" if subscriber.respond_to?(:display_name)
-      builder.from = from
-      
+      builder.from = subscriber_name_and_address(subscriber)
       builder.subject = subject
       
       if html
@@ -94,6 +95,14 @@ module MList
     
     # vvv  ActiveRecord validations interface implementation  vvv
     
+    def self.human_name(options = {})
+      self.name.humanize
+    end
+    
+    def self.self_and_descendants_from_active_record #nodoc:
+      [self]
+    end
+    
     def self.human_attribute_name(attribute_key_name, options = {})
       attribute_key_name.humanize
     end

data/lib/mlist/list.rb

@@ -25,10 +25,10 @@ module MList
     end
     
     # Answers the footer content for this list. Default implementation is very
-    # simple right now. Expect improvements in the future.
+    # simple.
     #
     def footer_content(message)
-      %Q{The "#{label}" mailing list\nTo post messages, send email to #{post_url}}
+      %Q{The "#{label}" mailing list\nPost messages: #{post_url}}
     end
     
     # Answer a suitable label for the list, which will be used in various
@@ -67,6 +67,16 @@ module MList
       nil
     end
     
+    # Should the sender of an email be copied in the publication? Defaults to
+    # false. If _recipients_ includes the sender email address, it will be
+    # removed if this answers false.
+    #
+    # The sending subscriber is provided to support preferential answering.
+    #
+    def copy_sender?(subscriber)
+      false
+    end
+    
     # The web address of the list help site, nil if this is not supported.
     #
     def help_url
@@ -86,6 +96,13 @@ module MList
       address
     end
     
+    # Should the reply-to header be set to the list's address? Defaults to
+    # true. If false is returned, the reply-to will be the subscriber address.
+    #
+    def reply_to_list?
+      true
+    end
+    
     # The web url where subscriptions to this list may be created, nil if this
     # is not supported.
     #
@@ -100,16 +117,15 @@ module MList
       nil
     end
     
-    # A list is responsible for answering the recipient subscribers.
+    # A list is responsible for answering the recipient subscribers. The
+    # answer may or may not include the subscriber; _copy_sender?_ will be
+    # invoked and the subscriber will be added or removed from the Array.
     #
-    # The subscriber of the incoming message is provided if the list would
-    # like to exclude it from the returned list. It is not assumed that it
-    # will be included or excluded, thereby allowing the list to decide. This
-    # default implementation does not include the sending subscriber in the
-    # list of recipients.
+    # The sending subscriber is provided if the list would like to utilize it
+    # in calculating the recipients.
     #
     def recipients(subscriber)
-      subscribers.reject {|s| s.email_address == subscriber.email_address}
+      subscribers
     end
     
     # A list must answer the subscriber who's email address is that of the one

data/lib/mlist/mail_list.rb

@@ -43,7 +43,7 @@ module MList
         :subscriber => email.subscriber,
         :recipients => list.recipients(email.subscriber),
         :email => MList::Email.new(:source => email.to_s)
-      ), :search_parent => false
+      ), :search_parent => false, :copy_sender => email.copy_sender
     end
     
     # Processes the email received by the MList::Server.
@@ -55,7 +55,7 @@ module MList
         :subscriber => subscriber,
         :recipients => recipients,
         :email => email
-      )
+      ), :copy_sender => list.copy_sender?(subscriber)
     end
     
     # Answers the provided subject with superfluous 're:' and this list's
@@ -175,7 +175,8 @@ module MList
         
         options = {
           :search_parent => true,
-          :delivery_time => Time.now
+          :delivery_time => Time.now,
+          :copy_sender => false
         }.merge(options)
         
         transaction do
@@ -198,15 +199,25 @@ module MList
         message.identifier = outgoing_server.generate_message_id
         message.created_at = options[:delivery_time]
         message.subject = clean_subject(message.subject)
+        
+        recipient_addresses = message.recipient_addresses
+        sender_address = message.subscriber.email_address
+        if options[:copy_sender]
+          recipient_addresses << sender_address unless recipient_addresses.include?(sender_address)
+        else
+          recipient_addresses.delete(sender_address)
+        end
+        
         returning(message.delivery) do |delivery|
-          delivery.date = message.created_at
+          delivery.date ||= options[:delivery_time]
           delivery.message_id = message.identifier
           delivery.mailer = message.mailer
           delivery.headers = list_headers
           delivery.subject = list_subject(message.subject)
           delivery.to = address
-          delivery.bcc = message.recipients.collect(&:email_address)
-          delivery.reply_to = "#{label} <#{post_url}>"
+          delivery.cc = []
+          delivery.bcc = recipient_addresses
+          delivery.reply_to ||= reply_to_header(message)
           prepare_list_footer(delivery, message)
         end
       end
@@ -240,6 +251,14 @@ module MList
         message.parent ? message.parent.thread : threads.build
       end
       
+      def reply_to_header(message)
+        if list.reply_to_list?
+          "#{label} #{bracket(address)}"
+        else
+          subscriber_name_and_address(message.subscriber)
+        end
+      end
+      
       def subject_prefix_regex
         @subject_prefix_regex ||= Regexp.new(Regexp.escape(subject_prefix) + ' ')
       end

data/lib/mlist/message.rb

@@ -86,6 +86,16 @@ module MList
     end
     alias_method_chain :parent=, :identifier_capture
     
+    # Answers the recipient email addresses from the MList::List recipient
+    # subscribers, except those that are in the email TO or CC fields as
+    # placed there by the sending MUA. It is assumed that those addresses have
+    # received a copy of the email already, and that by including them here,
+    # we would cause them to receive two copies of the message.
+    #
+    def recipient_addresses
+      @recipients.collect(&:email_address).collect(&:downcase) - email.recipient_addresses
+    end
+    
     # Answers the subject with 'Re:' prefixed. Note that it is the
     # responsibility of the MList::MailList to perform any processing of the
     # persisted subject (ie, cleaning up labels, etc).

data/lib/mlist/thread.rb

@@ -15,12 +15,12 @@ module MList
     
     def next(message)
       i = tree_order.index(message)
-      messages[i + 1] unless messages.size < i
+      tree_order[i + 1] unless messages.size < i
     end
     
     def previous(message)
       i = tree_order.index(message)
-      messages[i - 1] if i > 0
+      tree_order[i - 1] if i > 0
     end
     
     def subject

data/lib/mlist/util/email_helpers.rb

@@ -2,8 +2,15 @@ module MList
   module Util
     
     class HtmlTextExtraction
+      
+      # We need a way to maintain non-breaking spaces. Hpricot will replace
+      # them with ??.chr. We can easily teach it to convert it to a space, but
+      # then we lose the information in the Text node that we need to keep the
+      # space around, since that is what they would see in a view of the HTML.
+      NBSP = '!!!NBSP!!!'
+      
       def initialize(html)
-        @doc = Hpricot(html)
+        @doc = Hpricot(html.gsub(' ', NBSP))
       end
       
       def execute
@@ -19,7 +26,7 @@ module MList
           end
           @text << "\n\n--\n#{refs.join("\n")}"
         end
-        @text
+        @text.gsub(NBSP, ' ')
       end
       
       def extract_text_from_node(node)
@@ -95,6 +102,12 @@ module MList
         text.to_s.gsub(/\r\n?/, "\n")
       end
       
+      def subscriber_name_and_address(subscriber)
+        a = subscriber.email_address
+        a = "#{subscriber.display_name} #{bracket(a)}" if subscriber.respond_to?(:display_name)
+        a
+      end
+      
       BRACKETS_RE = /\A<(.*?)>\Z/
       def bracket(string)
         string.blank? || string =~ BRACKETS_RE ? string : "<#{string}>"

data/lib/mlist/util/tmail_methods.rb

@@ -5,8 +5,6 @@ module MList
       def date
         if date = tmail.header_string('date')
           Time.parse(date)
-        else
-          self.created_at ||= Time.now
         end
       end
       

data/rails/init.rb

@@ -1,28 +1,22 @@
-require 'dispatcher' unless defined?(::Dispatcher)
-
-Dispatcher.module_eval do
-  # Provides the mechinism to support applications that want to observe MList
-  # models.
-  #
-  # ActiveRecord observers are reloaded at each request in development mode.
-  # They will be registered with the MList models each time. Since the MList
-  # models are required once at initialization, there will always only be one
-  # instance of the model class, and therefore, many instances of the observer
-  # class registered with it; all but the most recent are invalid, since they
-  # were undefined when the dispatcher reloaded the application.
-  #
-  # Why not an initializer "to_prepare" block? Simply because we must clear
-  # the observers in the ActiveRecord classes before the
-  # ActiveRecord::Base.instantiate_observers call is made by the prepare block
-  # that we cannot get in front of with the initializer approach. Also, it
-  # lessens the configuration burden of the MList client application.
-  #
-  # Should we ever have observers in MList, this will likely need more careful
-  # attention.
-  #    
-  def reload_application_with_plugin_record_support
-    ActiveRecord::Base.send(:subclasses).each(&:delete_observers)
-    reload_application_without_plugin_record_support
+# Provides the mechinism to support applications that want to observe MList
+# models.
+#
+# ActiveRecord observers are reloaded at each request in development mode.
+# They will be registered with the MList models each time. Since the MList
+# models are required once at initialization, there will always only be one
+# instance of the model class, and therefore, many instances of the observer
+# class registered with it; all but the most recent are invalid, since they
+# were undefined when the dispatcher reloaded the application.
+#
+# Should we ever have observers in MList, this will likely need more careful
+# attention.
+#
+unless Rails.configuration.cache_classes
+  class << ActiveRecord::Base
+    def instantiate_observers_with_mlist_observers
+      subclasses.each(&:delete_observers)
+      instantiate_observers_without_mlist_observers
+    end
+    alias_method_chain :instantiate_observers, :mlist_observers
   end
-  alias_method_chain :reload_application, :plugin_record_support
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aiwilliams-mlist
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Adam Williams
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-03 00:00:00 -08:00
+date: 2009-08-14 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -59,6 +59,7 @@ files:
 - rails/init.rb
 has_rdoc: false
 homepage: http://github.com/aiwilliams/mlist
+licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: A Ruby mailing list library designed to be integrated into other applications.