app/models/message_recipient/easy_build_bcc_extension.rb app/models/message_recipient/easy_build_cc_extension.rb app/models/message_recipient/easy_build_extension.rb app/models/message_recipient/easy_build_to_extension.rb app/models/receiver_message.rb app/models/sender_message.rb lib/has_messages.rb test/app_root/app/models/user.rb test/app_root/config/environment.rb test/app_root/db/migrate/001_create_users.rb test/app_root/test/fixtures/message_recipients.yml test/app_root/test/fixtures/messages.yml test/app_root/test/fixtures/users.yml test/test_helper.rb test/unit/has_messages_test.rb test/unit/message_box_test.rb test/unit/message_recipient_test.rb test/unit/message_test.rb test/unit/receiver_message_test.rb test/unit/recipient_extension_test.rb test/unit/sender_message_test.rb @@ -1,12 +1,12 @@ -= acts_as_messageable += has_messages -acts_as_messageable . +has_messages . == Resources Wiki -* http://wiki.pluginaweek.org/Acts_as_messageable +* http://wiki.pluginaweek.org/Has_messages Announcement @@ -14,17 +14,12 @@ Announcement Source -* http://svn.pluginaweek.org/trunk/plugins/active_record/acts/acts_as_messageable +* http://svn.pluginaweek.org/trunk/plugins/active_record/has/has_messages Development -* http://dev.pluginaweek.org/browser/trunk/plugins/active_record/acts/acts_as_messageable +* http://dev.pluginaweek.org/browser/trunk/plugins/active_record/has/has_messages == Description - -== Migrations - -rake db:migrate:plugins PLUGIN=acts_as_state_machine -rake db:migrate:plugins PLUGIN=acts_as_messageable \ No newline at end of file README @@ -3,7 +3,7 @@ require 'rake/rdoctask' require 'rake/gempackagetask' require 'rake/contrib/sshpublisher' -PKG_NAME = 'acts_as_messageable' +PKG_NAME = 'has_messages' PKG_VERSION = '0.0.1' PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}" RUBY_FORGE_PROJECT = 'pluginaweek' @@ -11,17 +11,17 @@ RUBY_FORGE_PROJECT = 'pluginaweek' desc 'Default: run unit tests.' task :default => :test -desc 'Test the acts_as_messageable plugin.' +desc 'Test the has_messages plugin.' Rake::TestTask.new(:test) do |t| t.libs << 'lib' - t.pattern = 'test/**/*_test.rb' + t.pattern = 'test/unit/**/*_test.rb' t.verbose = true end -desc 'Generate documentation for the acts_as_messageable plugin.' +desc 'Generate documentation for the has_messages plugin.' Rake::RDocTask.new(:rdoc) do |rdoc| rdoc.rdoc_dir = 'rdoc' - rdoc.title = 'ActsAsMessageable' + rdoc.title = 'HasMessages' rdoc.options << '--line-numbers' << '--inline-source' rdoc.rdoc_files.include('README') rdoc.rdoc_files.include('lib/**/*.rb') @@ -35,7 +35,7 @@ spec = Gem::Specification.new do |s| s.files = FileList['{app,db,lib,tasks,test}/**/*'].to_a + %w(init.rb MIT-LICENSE Rakefile README) s.require_path = 'lib' - s.autorequire = 'acts_as_messageable' + s.autorequire = 'has_messages' s.has_rdoc = true s.test_files = Dir['test/**/*_test.rb'] Rakefile @@ -1,140 +1,40 @@ # class Message < ActiveRecord::Base - acts_as_state_machine :initial => Proc.new {|message| message.recipient ? :unread : :unsent} + has_states :initial => :deleted - belongs_to :from, - :polymorphic => true - belongs_to :recipient, - :polymorphic => true - - # Add associations for different types of recipients: - # * to - Your direct recipients - # * cc - Carbon copies - # * bcc - Blind carbon copies - with_options( - :class_name => 'MessageRecipient', - :foreign_key => 'message_id', - :order => 'position ASC', - :extend => Message::EasyBuildRecipientExtension - ) do |w| - w.has_many :to, - :conditions => ['kind = ?', 'to'] - w.has_many :cc, - :conditions => ['kind = ?', 'cc'] - w.has_many :bcc, - :conditions => ['kind = ?', 'bcc'] - end - - # Support reading from, to, cc, and bcc from the reference message - # if this message was forwarded - [:from, :to, :cc, :bcc].each do |method| - eval <<-end_eval - def #{method}_with_reference_message - recipient ? reference_message.#{method} : #{method}_without_reference_message - end - alias_method_chain :#{method}, :reference_message - end_eval - end - - # Reference messages are used for forwarding so that we don't duplicate data - # and so we can track where it came from - belongs_to :reference_message, - :class_name => 'Message', - :foreign_key => 'reference_message_id' - - validates_xor_presence_of :from_id, - :recipient_id, - :if => :only_model_participants? - - state :unsent - state :queued - state :sent, :after_enter => :deliver - state :unread - state :read state :deleted - # Queues the message so that it is sent in a separate process - event :queue do - transition_to :queued, :from => :unsent, - :if => Proc.new {|message| message.number_of_recipients > 0} - end - - # Sends the message to all of the recipients as long as at least one - # recipient has been aded - event :send do - transition_to :sent, :from => [:unsent, :queued], - :if => Proc.new {|message| message.number_of_recipients > 0} - end - - # Indicates that the message has been viewed by the recipient of this - # message - event :view do - transition_to :read, :from => :unread - end + validates_presence_of :owner_id, + :state_id - # Deletes the message - event :delete do - transition_to :deleted, :from => [:unread, :read, :sent] - end - - [:subject, :body].each do |method| - class_eval <<-end_eval - def #{method} - from ? read_attribute(:#{method}) : reference_message.#{method} - end - end_eval - end - - # Support getting all of the messageables of the message's - # recipients regardless of whether cross-model messaging is being - # allowed + # Support getting all of the messageables of the message's recipients [:to, :cc, :bcc].each do |method| eval <<-end_eval - def #{method}_recipients + def #{method}_receivers #{method}.collect {|recipient| recipient.messageable} end end_eval end # - def all_recipients - to + cc + bcc + def all_receivers + all_recipients.collect {|recipient| recipient.messageable} end # def number_of_recipients - to.size + cc.size + bcc.size + all_recipients.size end # - def forward - message = self.class.new - message.reference_message = self - message - end - - private - # Are only models allowed to be the from/recipient of this message? Or can - # other classes, like strings, be allowed? - def only_model_participants? - true - end - - # Copies the current message to all recipients - def copy_to_recipients - received_messages = "received_#{self.class.name.underscore.pluralize}" - - (to + cc + bcc).each do |recipient| - if recipient.messageable.respond_to?(received_messages) - message = recipient.messageable.send(received_messages).build - else - message = self.class.new - message.recipient = recipient.messageable + def reply_to_all + message = reply + [:cc, :bcc].each do |recipient_type| + send(recipient_type).each do |recipient| + message.send(recipient_type) << recipient.messageable end - - message.reference_message = self - message.save end + + message end - alias_method :deliver, :copy_to_recipients end app/models/message.rb @@ -1,9 +1,10 @@ -# +# Contains the received and sent messages for a particular box class MessageBox attr_reader :inbox, + :unsent, :sent - def initialize(inbox, sent) - @inbox, @sent = inbox, sent + def initialize(inbox, unsent, sent) + @inbox, @unsent, @sent = inbox, unsent, sent end end \ No newline at end of file app/models/message_box.rb @@ -1,11 +1,43 @@ # Represents a recipient of a message class MessageRecipient < ActiveRecord::Base - acts_as_list :scope => 'message_id = #{message_id} AND kind = #{quote_value(kind)}' + acts_as_list :scope => 'message_id = #{message_id} AND kind = #{quote_value(kind)}' - belongs_to :message - belongs_to :messageable, - :polymorphic => true + has_states :initial => :unsent + + state :unsent, + :sent + + event :deliver do + transition_to :sent, :from => :unsent + end + + belongs_to :message, + :class_name => 'SenderMessage', + :foreign_key => 'message_id' + belongs_to :messageable, + :polymorphic => true + has_one :receiver_message, + :foreign_key => 'owner_id' + has_many :receiver_messages, + :foreign_key => 'owner_id' +# :as => :owner, +# :source_type => nil validates_presence_of :message_id, - :kind + :kind, + :state_id + validates_presence_of :messageable_id, + :messageable_type, + :if => :model_participant? + + # + def deliver + message = build_receiver_message + message.save! + end + + private + def model_participant? + true + end end \ No newline at end of file app/models/message_recipient.rb @@ -1,29 +1,24 @@ -<% -type = <<-EOV -owner_type: 'Message' -EOV -%> - -queue: - id: 501 +delete: + id: 500 + name: delete + owner_type: Message + +sender_deliver: + id: 510 + name: deliver + owner_type: SenderMessage + +sender_queue: + id: 511 name: queue - long_description: Queues the messages to be sent at a later time - <%= type %> + owner_type: SenderMessage -send: - id: 502 - name: send - long_description: The message has been sent - <%= type %> +recipient_deliver: + id: 520 + name: deliver + owner_type: MessageRecipient -view: - id: 503 +receiver_view: + id: 530 name: view - long_description: The message has been view - <%= type %> - -delete: - id: 504 - name: delete - long_description: The message has been deleted - <%= type %> \ No newline at end of file + owner_type: ReceiverMessage \ No newline at end of file db/bootstrap/events.yml @@ -1,41 +1,34 @@ -<% -type = <<-EOV -owner_type: 'Message' -EOV -%> - -unsent: - id: 501 +deleted: + id: 500 + name: deleted + owner_type: Message + +sender_unsent: + id: 510 name: unsent - long_description: The message has not been sent yet. - <%= type %> + owner_type: SenderMessage -queued: - id: 502 - name: queued - long_description: The message has been queued to be sent at a later time. - <%= type %> +sender_sent: + id: 511 + name: sent + owner_type: SenderMessage -sent: - id: 503 +recipient_unsent: + id: 520 + name: unsent + owner_type: MessageRecipient + +recipient_sent: + id: 521 name: sent - long_description: The message has been sent. - <%= type %> + owner_type: MessageRecipient -unread: - id: 504 +receiver_unread: + id: 530 name: unread - long_description: The message has not been read yet. - <%= type %> + owner_type: ReceiverMessage -read: - id: 505 +receiver_read: + id: 531 name: read - long_description: The message has been read. - <%= type %> - -deleted: - id: 506 - name: deleted - long_description: The message has been deleted. - <%= type %> \ No newline at end of file + owner_type: ReceiverMessage \ No newline at end of file db/bootstrap/states.yml @@ -1,48 +1,20 @@ class CreateMessages < ActiveRecord::Migration - class Message < ActiveRecord::Base; end - class StateChange < ActiveRecord::Base; end - class StateDeadline < ActiveRecord::Base; end - - class State < ActiveRecord::Base - set_table_name 'states' - - has_many :messages, :class_name => Message.to_s, :dependent => :destroy - has_many :from_changes, :class_name => StateChange.to_s, :foreign_key => 'from_state_id', :dependent => :destroy - has_many :to_changes, :class_name => StateChange.to_s, :foreign_key => 'to_state_id', :dependent => :destroy - end - - class Event < ActiveRecord::Base - set_table_name 'events' - - has_many :state_changes, :class_name => StateChange.to_s, :foreign_key => 'event_id', :dependent => :destroy - has_many :state_deadlines, :class_name => StateDeadline.to_s, :foreign_key => 'event_id', :dependent => :destroy - end - def self.up create_table :messages do |t| - t.column :from_id, :integer, :null => false, :unsigned => true, :references => nil - t.column :from_type, :string, :null => false - t.column :recipient_id, :integer, :null => false, :unsigned => true, :references => nil - t.column :recipient_type, :string, :null => false - t.column :reference_message_id, :integer, :unsigned => true, :references => :messages - t.column :subject, :text, :null => false - t.column :body, :text, :null => false - t.column :created_at, :datetime, :null => false + t.column :owner_id, :integer, :null => false, :references => nil + t.column :owner_type, :string + t.column :subject, :text + t.column :body, :text + t.column :created_at, :datetime, :null => false + t.column :type, :string, :null => false end - PluginAWeek::Acts::StateMachine.migrate_up(:messages) + PluginAWeek::Has::States.migrate_up(:messages) end def self.down - PluginAWeek::Acts::StateMachine.migrate_down(:messages) + PluginAWeek::Has::States.migrate_down(:messages) drop_table :messages end - - def self.bootstrap - { - :states => {:class => State, :conditions => ['owner_type = ?', 'Message']}, - :events => {:class => Event, :conditions => ['owner_type = ?', 'Message']} - } - end end \ No newline at end of file db/migrate/001_create_messages.rb @@ -1,17 +1,20 @@ class CreateMessageRecipients < ActiveRecord::Migration def self.up create_table :message_recipients do |t| - t.column :message_id, :integer, :null => false, :unsigned => true - t.column :messageable_id, :integer, :null => false, :unsigned => true, :references => nil - t.column :messageable_type, :string, :null => false - t.column :kind, :string, :null => false, :default => 'to' - t.column :position, :integer, :null => false + t.column :message_id, :integer, :null => false + t.column :messageable_id, :integer, :null => false, :references => nil + t.column :messageable_type, :string, :null => false + t.column :kind, :string, :null => false, :default => 'to' + t.column :position, :integer, :null => false end - add_index :message_recipients, [:message_id, :messageable_id, :messageable_type], :unique => true, :name => 'index_message_recipients_on_message_id_and_messageable' add_index :message_recipients, [:message_id, :kind, :position], :unique => true + + PluginAWeek::Has::States.migrate_up(:message_recipients) end def self.down + PluginAWeek::Has::States.migrate_down(:message_recipients) + drop_table :message_recipients end end \ No newline at end of file db/migrate/002_create_message_recipients.rb @@ -1 +1 @@ -require 'acts_as_messageable' \ No newline at end of file +require 'has_messages' \ No newline at end of file init.rb app/models/message/easy_build_recipient_extension.rb lib/acts_as_messageable.rb test/acts_as_messageable_test.rb ae63f8b9510fab02ac91b2e093cc1b050aa7eb99 Aaron Pfeifer aaron.pfeifer@gmail.com http://github.com/pluginaweek/has_messages/commit/dd028bdcbc7aaeda88bdb3d45838a6e78d8c3f43 dd028bdcbc7aaeda88bdb3d45838a6e78d8c3f43 2007-07-29T14:06:41-07:00 2007-07-29T14:06:41-07:00 Initial release 5f2c194a7e76a7a35cac6332484cb06aca1f7c0b Aaron Pfeifer aaron.pfeifer@gmail.com