has_messages 0.3.0 → 0.3.1

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 == master
 
+== 0.3.1 / 2008-01-11
+
+* Use a state machine for the hidden_at field on Message/MessageRecipient
+* Add dependency on state_machine 0.5.0
+
 == 0.3.0 / 2008-12-14
 
 * Remove the PluginAWeek namespace

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'has_messages'
-  s.version           = '0.3.0'
+  s.version           = '0.3.1'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Demonstrates a reference implementation for sending messages between users.'
   
@@ -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    'state_machine', '>= 0.3.0'
+  s.add_dependency    'state_machine', '>= 0.5.0'
   
   s.author            = 'Aaron Pfeifer'
   s.email             = 'aaron@pluginaweek.org'

data/app/models/message.rb

@@ -14,12 +14,16 @@
 # * +queue+ - Queues the message so that you can send it in a separate process
 # * +deliver+ - Sends the message to all of the recipients
 # 
-# == Hiding messages
+# == Message visibility
 # 
 # Although you can delete a message, it will also delete it from the inbox of all
-# the message's recipients.  Instead, you can hide messages from users with the
-# following actions:
-# * +hide+ -Hides the message from the sender's inbox
+# the message's recipients.  Instead, you can change the *visibility* of the
+# message.  Messages have 1 of 2 states that define its visibility:
+# * +visible+ - The message is visible to the sender
+# * +hidden+ - The message is hidden from the sender
+# 
+# The visibility of a message can be changed by running the associated action:
+# * +hide+ -Hides the message from the sender
 # * +unhide+ - Makes the message visible again
 class Message < ActiveRecord::Base
   belongs_to  :sender,
@@ -43,17 +47,33 @@ class Message < ActiveRecord::Base
                 :conditions => {:hidden_at => nil}
   
   # Define actions for the message
-  state_machine :state, :initial => 'unsent' do
+  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 :to => :queued, :from => :unsent, :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 => %w(unsent queued), :if => :has_recipients?
+      transition :to => :sent, :from => [:unsent, :queued], :if => :has_recipients?
+    end
+  end
+  
+  # Defines actions for the visibility of the message
+  state_machine :hidden_at, :initial => :visible do
+    # Hides the message from the recipient's inbox
+    event :hide do
+      transition :to => :hidden
     end
+    
+    # Makes the message visible in the recipient's inbox
+    event :unhide do
+      transition :to => :visible
+    end
+    
+    state :visible, :value => nil
+    state :hidden, :value => lambda {Time.now}, :if => lambda {|value| value}
   end
   
   # Directly adds the receivers on the message (i.e. they are visible to all recipients)
@@ -101,21 +121,6 @@ class Message < ActiveRecord::Base
     message
   end
   
-  # Hides the message from the sender's inbox
-  def hide
-    update_attribute(:hidden_at, Time.now)
-  end
-  
-  # Makes the message visible in the sender's inbox
-  def unhide
-    update_attribute(:hidden_at, nil)
-  end
-  
-  # Is this message still hidden from the sender's inbox?
-  def hidden?
-    hidden_at?
-  end
-  
   private
     # Create/destroy any receivers that were added/removed
     def update_recipients

data/app/models/message_recipient.rb

@@ -17,8 +17,13 @@
 # 
 # Although you can delete a recipient, it will also delete it from everyone else's
 # message, meaning that no one will know that person was ever a recipient of the
-# message.  Instead, you can hide messages from users with the following actions:
-# * +hide+ -Hides the message from the recipient's inbox
+# message.  Instead, you can change the *visibility* of the message.  Messages
+# have 1 of 2 states that define its visibility:
+# * +visible+ - The message is visible to the recipient
+# * +hidden+ - The message is hidden from the recipient
+# 
+# The visibility of a message can be changed by running the associated action:
+# * +hide+ -Hides the message from the recipient
 # * +unhide+ - Makes the message visible again
 class MessageRecipient < ActiveRecord::Base
   belongs_to  :message
@@ -52,11 +57,28 @@ class MessageRecipient < ActiveRecord::Base
   named_scope :visible,
                 :conditions => {:hidden_at => nil}
   
-  state_machine :state, :initial => 'unread' do
+  # 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 :to => :read, :from => :unread, :if => :message_sent?
+    end
+  end
+  
+  # Defines actions for the visibility of the message to the recipient
+  state_machine :hidden_at, :initial => :visible do
+    # Hides the message from the recipient's inbox
+    event :hide do
+      transition :to => :hidden
     end
+    
+    # Makes the message visible in the recipient's inbox
+    event :unhide do
+      transition :to => :visible
+    end
+    
+    state :visible, :value => nil
+    state :hidden, :value => lambda {Time.now}, :if => lambda {|value| value}
   end
   
   # Forwards this message, including the original subject and body in the new
@@ -87,25 +109,10 @@ class MessageRecipient < ActiveRecord::Base
     message
   end
   
-  # Hides the message from the recipient's inbox
-  def hide
-    update_attribute(:hidden_at, Time.now)
-  end
-  
-  # Makes the message visible in the recipient's inbox
-  def unhide
-    update_attribute(:hidden_at, nil)
-  end
-  
-  # Is this message still hidden from the recipient's inbox?
-  def hidden?
-    hidden_at?
-  end
-  
   private
     # Has the message this recipient is on been sent?
     def message_sent?
-      message.state == 'sent'
+      message.sent?
     end
     
     # Sets the position of the current recipient based on existing recipients

data/lib/has_messages.rb

@@ -53,13 +53,13 @@ module HasMessages
     # Composed messages that have not yet been sent.  These consists of all
     # messages that are currently in the "unsent" state.
     def unsent_messages
-      messages.with_state('unsent')
+      messages.with_state(:unsent)
     end
     
     # Composed messages that have already been sent.  These consists of all
     # messages that are currently in the "queued" or "sent" states.
     def sent_messages
-      messages.with_states(%w(queued sent))
+      messages.with_states(:queued, :sent)
     end
   end
 end

data/test/unit/message_recipient_test.rb

@@ -234,6 +234,10 @@ class MessageRecipientHiddenTest < Test::Unit::TestCase
   def test_should_be_hidden
     assert @recipient.hidden?
   end
+  
+  def test_should_not_be_visible
+    assert !@recipient.visible?
+  end
 end
 
 class MessageRecipientUnhiddenTest < Test::Unit::TestCase
@@ -250,6 +254,10 @@ class MessageRecipientUnhiddenTest < Test::Unit::TestCase
   def test_should_not_be_hidden
     assert !@recipient.hidden?
   end
+  
+  def test_should_be_visible
+    assert @recipient.visible?
+  end
 end
 
 class MessageRecipientForwardedTest < Test::Unit::TestCase

data/test/unit/message_test.rb

@@ -278,6 +278,10 @@ class MessageHiddenTest < Test::Unit::TestCase
   def test_should_be_hidden
     assert @message.hidden?
   end
+  
+  def test_should_not_be_visible
+    assert !@message.visible?
+  end
 end
 
 class MessageUnhiddenTest < Test::Unit::TestCase
@@ -294,6 +298,10 @@ class MessageUnhiddenTest < Test::Unit::TestCase
   def test_should_not_be_hidden
     assert !@message.hidden?
   end
+  
+  def test_should_be_visible
+    assert @message.visible?
+  end
 end
 
 class MessageForwardedTest < Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: has_messages
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-14 00:00:00 -05:00
+date: 2009-01-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.0
+        version: 0.5.0
     version: 
 description: 
 email: aaron@pluginaweek.org