@@ -1,5 +1,9 @@ == master +* Add dependency on Rails 2.3 +* Add dependency on plugin_test_helper 0.3.0 +* Add dependency on state_machine 0.7.0 + == 0.3.1 / 2009-01-11 * Use a state machine for the hidden_at field on Message/MessageRecipient CHANGELOG.rdoc @@ -28,8 +28,8 @@ between users, but can also act as a way for the web application to send notices and other notifications to users. Designing and building a framework that supports this can be complex and takes -away from the business focus. This plugin can help ease that process by demonstrating -a complete implementation of these features. +away from the business focus. This plugin can help ease that process by +demonstrating a reference implementation of these features. == Usage @@ -45,7 +45,7 @@ This will build the following associations: * +sent_messages+ * +received_messages+ -If you have more specified needs, you can create the same associations manually +If you have more specific needs, you can create the same associations manually that +has_messages+ builds. See HasMessages::MacroMethods#has_messages for more information about the asssociations that are generated from this macro. @@ -97,6 +97,5 @@ To run against a specific version of Rails: == Dependencies -* Rails 2.1 or later +* Rails 2.3 or later * state_machine[http://github.com/pluginaweek/state_machine] -* plugins_plus[http://github.com/pluginaweek/plugins_plugins] (optional if app files are copied to your project tree) README.rdoc @@ -26,37 +26,28 @@ # * +hide+ -Hides the message from the sender # * +unhide+ - Makes the message visible again class Message < ActiveRecord::Base - belongs_to :sender, - :polymorphic => true - has_many :recipients, - :class_name => 'MessageRecipient', - :order => 'kind DESC, position ASC', - :dependent => :destroy + belongs_to :sender, :polymorphic => true + has_many :recipients, :class_name => 'MessageRecipient', :order => 'kind DESC, position ASC', :dependent => :destroy - validates_presence_of :state, - :sender_id, - :sender_type + validates_presence_of :state, :sender_id, :sender_type - attr_accessible :subject, - :body, - :to, :cc, :bcc + attr_accessible :subject, :body, :to, :cc, :bcc after_save :update_recipients - named_scope :visible, - :conditions => {:hidden_at => nil} + named_scope :visible, :conditions => {:hidden_at => nil} # Define actions for the message state_machine :state, :initial => :unsent do # Queues the message so that it's sent in a separate process event :queue do - transition :to => :queued, :from => :unsent, :if => :has_recipients? + transition :unsent => :queued, :if => :has_recipients? end # Sends the message to all of the recipients as long as at least one # recipient has been added event :deliver do - transition :to => :sent, :from => [:unsent, :queued], :if => :has_recipients? + transition [:unsent, :queued] => :sent, :if => :has_recipients? end end @@ -64,12 +55,12 @@ class Message < ActiveRecord::Base state_machine :hidden_at, :initial => :visible do # Hides the message from the recipient's inbox event :hide do - transition :to => :hidden + transition all => :hidden end # Makes the message visible in the recipient's inbox event :unhide do - transition :to => :visible + transition all => :visible end state :visible, :value => nil app/models/message.rb @@ -27,41 +27,26 @@ # * +unhide+ - Makes the message visible again class MessageRecipient < ActiveRecord::Base belongs_to :message - belongs_to :receiver, - :polymorphic => true + belongs_to :receiver, :polymorphic => true - validates_presence_of :message_id, - :kind, - :state, - :receiver_id, - :receiver_type + validates_presence_of :message_id, :kind, :state, :receiver_id, :receiver_type - attr_protected :state, - :position, - :hidden_at + attr_protected :state, :position, :hidden_at before_create :set_position before_destroy :reorder_positions # Make this class look like the actual message - delegate :sender, - :subject, - :body, - :recipients, - :to, - :cc, - :bcc, - :created_at, + delegate :sender, :subject, :body, :recipients, :to, :cc, :bcc, :created_at, :to => :message - named_scope :visible, - :conditions => {:hidden_at => nil} + named_scope :visible, :conditions => {:hidden_at => nil} # Defines actions for the recipient state_machine :state, :initial => :unread do # Indicates that the message has been viewed by the receiver event :view do - transition :to => :read, :from => :unread, :if => :message_sent? + transition :unread => :read, :if => :message_sent? end end @@ -69,12 +54,12 @@ class MessageRecipient < ActiveRecord::Base state_machine :hidden_at, :initial => :visible do # Hides the message from the recipient's inbox event :hide do - transition :to => :hidden + transition all => :hidden end # Makes the message visible in the recipient's inbox event :unhide do - transition :to => :visible + transition all => :visible end state :visible, :value => nil app/models/message_recipient.rb @@ -2,8 +2,7 @@ class CreateMessages < ActiveRecord::Migration def self.up create_table :messages do |t| t.references :sender, :polymorphic => true, :null => false - t.text :subject - t.text :body + t.text :subject, :body t.string :state, :null => false t.datetime :hidden_at t.string :type db/migrate/001_create_messages.rb @@ -4,12 +4,15 @@ require 'state_machine' module HasMessages module MacroMethods # Creates the following message associations: - # * +messages+ - Messages that were composed and are visible to the owner. Mesages may have been sent or unsent. - # * +received_messages - Messages that have been received from others and are visible. Messages may have been read or unread. + # * +messages+ - Messages that were composed and are visible to the owner. + # Mesages may have been sent or unsent. + # * +received_messages - Messages that have been received from others and + # are visible. Messages may have been read or unread. # # == Creating new messages # - # To create a new message, the +messages+ association should be used, for example: + # To create a new message, the +messages+ association should be used, + # for example: # # user = User.find(123) # message = user.messages.build lib/has_messages.rb @@ -1,9 +1,9 @@ require 'config/boot' -require "#{File.dirname(__FILE__)}/../../../../plugins_plus/boot" Rails::Initializer.run do |config| config.plugin_paths << '..' - config.plugins = %w(plugins_plus state_machine has_messages) + config.plugins = %w(state_machine has_messages) config.cache_classes = false config.whiny_nils = true + config.action_controller.session = {:key => 'rails_session', :secret => 'd229e4d22437432705ab3985d4d246'} end test/app_root/config/environment.rb @@ -1,9 +1,13 @@ class MigrateHasMessagesToVersion2 < ActiveRecord::Migration def self.up - Rails::Plugin.find(:has_messages).migrate(2) + ActiveRecord::Migrator.new(:up, "#{Rails.root}/../../db/migrate", 0).migrations.each do |migration| + migration.migrate(:up) + end end def self.down - Rails::Plugin.find(:has_messages).migrate(0) + ActiveRecord::Migrator.new(:up, "#{Rails.root}/../../db/migrate", 0).migrations.each do |migration| + migration.migrate(:down) + end end end test/app_root/db/migrate/002_migrate_has_messages_to_version_2.rb @@ -1,6 +1,6 @@ require File.expand_path(File.dirname(__FILE__) + '/../test_helper') -class UserByDefaultTest < Test::Unit::TestCase +class UserByDefaultTest < ActiveSupport::TestCase def setup @user = create_user end @@ -22,7 +22,7 @@ class UserByDefaultTest < Test::Unit::TestCase end end -class UserTest < Test::Unit::TestCase +class UserTest < ActiveSupport::TestCase def setup @user = create_user end @@ -40,7 +40,7 @@ class UserTest < Test::Unit::TestCase end end -class UserWithUnsentMessages < Test::Unit::TestCase +class UserWithUnsentMessages < ActiveSupport::TestCase def setup @user = create_user @sent_message = create_message(:sender => @user, :to => create_user(:login => 'you')) @@ -58,7 +58,7 @@ class UserWithUnsentMessages < Test::Unit::TestCase end end -class UserWithSentMessages < Test::Unit::TestCase +class UserWithSentMessages < ActiveSupport::TestCase def setup @user = create_user @to = create_user(:login => 'you') @@ -80,7 +80,7 @@ class UserWithSentMessages < Test::Unit::TestCase end end -class UserWithReceivedMessages < Test::Unit::TestCase +class UserWithReceivedMessages < ActiveSupport::TestCase def setup @sender = create_user @user = create_user(:login => 'me') @@ -99,7 +99,7 @@ class UserWithReceivedMessages < Test::Unit::TestCase end end -class UserWithHiddenMessagesTest < Test::Unit::TestCase +class UserWithHiddenMessagesTest < ActiveSupport::TestCase def setup @user = create_user @friend = create_user(:login => 'you') test/functional/has_messages_test.rb @@ -1,6 +1,6 @@ require File.expand_path(File.dirname(__FILE__) + '/../test_helper') -class MessageRecipientByDefaultTest < Test::Unit::TestCase +class MessageRecipientByDefaultTest < ActiveSupport::TestCase def setup @recipient = MessageRecipient.new end @@ -35,7 +35,7 @@ class MessageRecipientByDefaultTest < Test::Unit::TestCase end end -class MesageRecipientTest < Test::Unit::TestCase +class MesageRecipientTest < ActiveSupport::TestCase def test_should_be_valid_with_a_set_of_valid_attributes recipient = new_message_recipient assert recipient.valid? @@ -99,7 +99,7 @@ class MesageRecipientTest < Test::Unit::TestCase end end -class MessageRecipientAfterBeingCreatedTest < Test::Unit::TestCase +class MessageRecipientAfterBeingCreatedTest < ActiveSupport::TestCase def setup @admin = create_user(:login => 'admin') @erich = create_user(:login => 'Erich') @@ -157,7 +157,7 @@ class MessageRecipientAfterBeingCreatedTest < Test::Unit::TestCase end end -class MessageRecipientOfMultipleTest < Test::Unit::TestCase +class MessageRecipientOfMultipleTest < ActiveSupport::TestCase def setup @erich = create_user(:login => 'Erich') @richard = create_user(:login => 'Richard') @@ -176,7 +176,7 @@ class MessageRecipientOfMultipleTest < Test::Unit::TestCase end end -class MessageRecipientUnreadWithUnsentMessageTest < Test::Unit::TestCase +class MessageRecipientUnreadWithUnsentMessageTest < ActiveSupport::TestCase def setup @recipient = create_message_recipient end @@ -190,7 +190,7 @@ class MessageRecipientUnreadWithUnsentMessageTest < Test::Unit::TestCase end end -class MessageRecipientUnreadWithSentMessageTest < Test::Unit::TestCase +class MessageRecipientUnreadWithSentMessageTest < ActiveSupport::TestCase def setup @recipient = create_message_recipient @recipient.message.deliver @@ -205,7 +205,7 @@ class MessageRecipientUnreadWithSentMessageTest < Test::Unit::TestCase end end -class MessageRecipientReadTest < Test::Unit::TestCase +class MessageRecipientReadTest < ActiveSupport::TestCase def setup @recipient = create_message_recipient @recipient.message.deliver @@ -221,7 +221,7 @@ class MessageRecipientReadTest < Test::Unit::TestCase end end -class MessageRecipientHiddenTest < Test::Unit::TestCase +class MessageRecipientHiddenTest < ActiveSupport::TestCase def setup @recipient = create_message_recipient @recipient.hide @@ -240,7 +240,7 @@ class MessageRecipientHiddenTest < Test::Unit::TestCase end end -class MessageRecipientUnhiddenTest < Test::Unit::TestCase +class MessageRecipientUnhiddenTest < ActiveSupport::TestCase def setup @recipient = create_message_recipient @recipient.hide @@ -260,7 +260,7 @@ class MessageRecipientUnhiddenTest < Test::Unit::TestCase end end -class MessageRecipientForwardedTest < Test::Unit::TestCase +class MessageRecipientForwardedTest < ActiveSupport::TestCase def setup @erich = create_user(:login => 'Erich') original_message = create_message( @@ -309,7 +309,7 @@ class MessageRecipientForwardedTest < Test::Unit::TestCase end end -class MessageRecipientRepliedTest < Test::Unit::TestCase +class MessageRecipientRepliedTest < ActiveSupport::TestCase def setup @erich = create_user(:login => 'Erich') @john = create_user(:login => 'John') @@ -360,7 +360,7 @@ class MessageRecipientRepliedTest < Test::Unit::TestCase end end -class MessageRecipientRepliedToAllTest < Test::Unit::TestCase +class MessageRecipientRepliedToAllTest < ActiveSupport::TestCase def setup @erich = create_user(:login => 'Erich') @john = create_user(:login => 'John') @@ -413,7 +413,7 @@ class MessageRecipientRepliedToAllTest < Test::Unit::TestCase end end -class MessageRecipientAfterBeingDestroyedTest < Test::Unit::TestCase +class MessageRecipientAfterBeingDestroyedTest < ActiveSupport::TestCase def setup message = create_message @first_recipient = create_message_recipient( @@ -436,7 +436,7 @@ class MessageRecipientAfterBeingDestroyedTest < Test::Unit::TestCase end end -class MessageRecipientAsAClassTest < Test::Unit::TestCase +class MessageRecipientAsAClassTest < ActiveSupport::TestCase def setup message = create_message @hidden_recipient = create_message_recipient(:message => message, :receiver => create_user(:login => 'erich'), :hidden_at => Time.now) test/unit/message_recipient_test.rb @@ -1,6 +1,6 @@ require File.expand_path(File.dirname(__FILE__) + '/../test_helper') -class MessageByDefaultTest < Test::Unit::TestCase +class MessageByDefaultTest < ActiveSupport::TestCase def setup @message = Message.new end @@ -27,7 +27,7 @@ class MessageByDefaultTest < Test::Unit::TestCase end end -class MessageTest < Test::Unit::TestCase +class MessageTest < ActiveSupport::TestCase def test_should_be_valid_with_a_set_of_valid_attributes message = new_message assert message.valid? @@ -88,7 +88,7 @@ class MessageTest < Test::Unit::TestCase end end -class MessageBeforeBeingCreatedTest < Test::Unit::TestCase +class MessageBeforeBeingCreatedTest < ActiveSupport::TestCase def setup @message = new_message end @@ -128,7 +128,7 @@ class MessageBeforeBeingCreatedTest < Test::Unit::TestCase end end -class MesageAfterBeingCreatedTest < Test::Unit::TestCase +class MesageAfterBeingCreatedTest < ActiveSupport::TestCase def setup @message = create_message end @@ -176,7 +176,7 @@ class MesageAfterBeingCreatedTest < Test::Unit::TestCase end end -class MessageWithoutRecipientsTest < Test::Unit::TestCase +class MessageWithoutRecipientsTest < ActiveSupport::TestCase def setup @message = create_message end @@ -190,7 +190,7 @@ class MessageWithoutRecipientsTest < Test::Unit::TestCase end end -class MessageWithRecipientsTest < Test::Unit::TestCase +class MessageWithRecipientsTest < ActiveSupport::TestCase def setup @erich = create_user(:login => 'Erich') @richard = create_user(:login => 'Richard') @@ -227,7 +227,7 @@ class MessageWithRecipientsTest < Test::Unit::TestCase end end -class MessageQueuedTest < Test::Unit::TestCase +class MessageQueuedTest < ActiveSupport::TestCase def setup @message = create_message(:to => create_user(:login => 'coward')) @message.queue @@ -246,7 +246,7 @@ class MessageQueuedTest < Test::Unit::TestCase end end -class MessageDeliveredTest < Test::Unit::TestCase +class MessageDeliveredTest < ActiveSupport::TestCase def setup @message = create_message(:to => create_user(:login => 'coward')) @message.deliver @@ -265,7 +265,7 @@ class MessageDeliveredTest < Test::Unit::TestCase end end -class MessageHiddenTest < Test::Unit::TestCase +class MessageHiddenTest < ActiveSupport::TestCase def setup @message = create_message @message.hide @@ -284,7 +284,7 @@ class MessageHiddenTest < Test::Unit::TestCase end end -class MessageUnhiddenTest < Test::Unit::TestCase +class MessageUnhiddenTest < ActiveSupport::TestCase def setup @message = create_message @message.hide @@ -304,7 +304,7 @@ class MessageUnhiddenTest < Test::Unit::TestCase end end -class MessageForwardedTest < Test::Unit::TestCase +class MessageForwardedTest < ActiveSupport::TestCase def setup @admin = create_user(:login => 'admin') original_message = create_message( @@ -351,7 +351,7 @@ class MessageForwardedTest < Test::Unit::TestCase end end -class MessageRepliedTest < Test::Unit::TestCase +class MessageRepliedTest < ActiveSupport::TestCase def setup @admin = create_user(:login => 'admin') @erich = create_user(:login => 'Erich') @@ -402,7 +402,7 @@ class MessageRepliedTest < Test::Unit::TestCase end end -class MessageRepliedToAllTest < Test::Unit::TestCase +class MessageRepliedToAllTest < ActiveSupport::TestCase def setup @admin = create_user(:login => 'admin') @erich = create_user(:login => 'Erich') @@ -453,7 +453,7 @@ class MessageRepliedToAllTest < Test::Unit::TestCase end end -class MessageAsAClassTest < Test::Unit::TestCase +class MessageAsAClassTest < ActiveSupport::TestCase def setup @hidden_message = create_message(:hidden_at => Time.now) @visible_message = create_message test/unit/message_test.rb 50f032db3ae9e761411b36a97f2bd6000dfdaea7 Aaron Pfeifer aaron.pfeifer@gmail.com http://github.com/pluginaweek/has_messages/commit/8ffa5d6b2cc3d3fba005f4e553c8ad211c562ad2 8ffa5d6b2cc3d3fba005f4e553c8ad211c562ad2 2009-04-19T12:21:26-07:00 2009-04-19T12:21:26-07:00 Add dependency on Rails 2.3 Add dependency on plugin_test_helper 0.3.0 Add dependency on state_machine 0.7.0 ec40d2b3d6912287738b091389b56c587390cf41 Aaron Pfeifer aaron.pfeifer@gmail.com