has_messages 0.2.0 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 == master
 
+== 0.3.0 / 2008-12-14
+
+* Remove the PluginAWeek namespace
+* Rename Message#hide!/unhide! to Message#hide/unhide and MessageRecipient#hide!/unhide! to MessageRecipient#hide/unhide
+
 == 0.2.0 / 2008-10-26
 
 * Add mass-assignment protection in the Message/MessageRecipient models

data/README.rdoc

@@ -46,7 +46,7 @@ This will build the following associations:
 * +received_messages+
 
 If you have more specified needs, you can create the same associations manually
-that +has_messages+ builds.  See PluginAWeek::HasMessages::MacroMethods#has_messages
+that +has_messages+ builds.  See HasMessages::MacroMethods#has_messages
 for more information about the asssociations that are generated from this macro.
 
 === Creating new messages

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'has_messages'
-  s.version           = '0.2.0'
+  s.version           = '0.3.0'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Demonstrates a reference implementation for sending messages between users.'
   

data/app/models/message.rb

@@ -11,16 +11,16 @@
 # 
 # In order to perform actions on the message, such as queueing or delivering,
 # you should always use the associated event action:
-# * +queue!+ - Queues the message so that you can send it in a separate process
-# * +deliver!+ - Sends the message to all of the recipients
+# * +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
 # 
 # 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
-# * +unhide!+ - Makes the message visible again
+# * +hide+ -Hides the message from the sender's inbox
+# * +unhide+ - Makes the message visible again
 class Message < ActiveRecord::Base
   belongs_to  :sender,
                 :polymorphic => true
@@ -102,12 +102,12 @@ class Message < ActiveRecord::Base
   end
   
   # Hides the message from the sender's inbox
-  def hide!
+  def hide
     update_attribute(:hidden_at, Time.now)
   end
   
   # Makes the message visible in the sender's inbox
-  def unhide!
+  def unhide
     update_attribute(:hidden_at, nil)
   end
   

data/app/models/message_recipient.rb

@@ -11,15 +11,15 @@
 # 
 # In order to perform actions on the message, such as viewing, you should always
 # use the associated event action:
-# * +view!+ - Marks the message as read by the recipient
+# * +view+ - Marks the message as read by the recipient
 # 
 # == Hiding messages
 # 
 # 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
-# * +unhide!+ - Makes the message visible again
+# * +hide+ -Hides the message from the recipient's inbox
+# * +unhide+ - Makes the message visible again
 class MessageRecipient < ActiveRecord::Base
   belongs_to  :message
   belongs_to  :receiver,
@@ -88,12 +88,12 @@ class MessageRecipient < ActiveRecord::Base
   end
   
   # Hides the message from the recipient's inbox
-  def hide!
+  def hide
     update_attribute(:hidden_at, Time.now)
   end
   
   # Makes the message visible in the recipient's inbox
-  def unhide!
+  def unhide
     update_attribute(:hidden_at, nil)
   end
   

data/lib/has_messages.rb

@@ -1,71 +1,69 @@
 require 'state_machine'
 
-module PluginAWeek #:nodoc:
-  # Adds a generic implementation for sending messages between users
-  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.
-      # 
-      # == Creating new messages
-      # 
-      # To create a new message, the +messages+ association should be used, for example:
-      # 
-      #   user = User.find(123)
-      #   message = user.messages.build
-      #   message.subject = 'Hello'
-      #   message.body = 'How are you?'
-      #   message.to User.find(456)
-      #   message.save
-      #   message.deliver
-      # 
-      # == Drafts
-      # 
-      # You can get the drafts for a particular user by using the +unsent_messages+
-      # helper method.  This will find all messages in the "unsent" state.  For example,
-      # 
-      #   user = User.find(123)
-      #   user.unsent_messages
-      # 
-      # You can also get at the messages that *have* been sent, using the +sent_messages+
-      # helper method.  For example,
-      # 
-      #  user = User.find(123)
-      #  user.sent_messages
-      def has_messages
-        has_many  :messages,
-                    :as => :sender,
-                    :class_name => 'Message',
-                    :conditions => {:hidden_at => nil},
-                    :order => 'messages.created_at ASC'
-        has_many  :received_messages,
-                    :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::HasMessages::InstanceMethods
-      end
+# Adds a generic implementation for sending messages between users
+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.
+    # 
+    # == Creating new messages
+    # 
+    # To create a new message, the +messages+ association should be used, for example:
+    # 
+    #   user = User.find(123)
+    #   message = user.messages.build
+    #   message.subject = 'Hello'
+    #   message.body = 'How are you?'
+    #   message.to User.find(456)
+    #   message.save
+    #   message.deliver
+    # 
+    # == Drafts
+    # 
+    # You can get the drafts for a particular user by using the +unsent_messages+
+    # helper method.  This will find all messages in the "unsent" state.  For example,
+    # 
+    #   user = User.find(123)
+    #   user.unsent_messages
+    # 
+    # You can also get at the messages that *have* been sent, using the +sent_messages+
+    # helper method.  For example,
+    # 
+    #  user = User.find(123)
+    #  user.sent_messages
+    def has_messages
+      has_many  :messages,
+                  :as => :sender,
+                  :class_name => 'Message',
+                  :conditions => {:hidden_at => nil},
+                  :order => 'messages.created_at ASC'
+      has_many  :received_messages,
+                  :as => :receiver,
+                  :class_name => 'MessageRecipient',
+                  :include => :message,
+                  :conditions => ['message_recipients.hidden_at IS NULL AND messages.state = ?', 'sent'],
+                  :order => 'messages.created_at ASC'
+      
+      include HasMessages::InstanceMethods
+    end
+  end
+  
+  module InstanceMethods
+    # 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')
     end
     
-    module InstanceMethods
-      # 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')
-      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))
-      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))
     end
   end
 end
 
 ActiveRecord::Base.class_eval do
-  extend PluginAWeek::HasMessages::MacroMethods
+  extend HasMessages::MacroMethods
 end

data/test/functional/has_messages_test.rb

@@ -105,18 +105,18 @@ class UserWithHiddenMessagesTest < Test::Unit::TestCase
     @friend = create_user(:login => 'you')
     
     hidden_unsent_message = create_message(:sender => @user)
-    hidden_unsent_message.hide!
+    hidden_unsent_message.hide
     @unsent_message = create_message(:sender => @user)
     
     hidden_sent_message = create_message(:sender => @user, :to => @friend)
     hidden_sent_message.deliver
-    hidden_sent_message.hide!
+    hidden_sent_message.hide
     @sent_message = create_message(:sender => @user, :to => @friend)
     @sent_message.deliver
     
     hidden_received_message = create_message(:sender => @friend, :to => @user)
     hidden_received_message.deliver
-    hidden_received_message.recipients.first.hide!
+    hidden_received_message.recipients.first.hide
     @received_message = create_message(:sender => @friend, :to => @user)
     @received_message.deliver
   end

data/test/unit/message_recipient_test.rb

@@ -44,31 +44,31 @@ class MesageRecipientTest < Test::Unit::TestCase
   def test_should_require_a_message
     recipient = new_message_recipient(:message => nil)
     assert !recipient.valid?
-    assert_equal 1, Array(recipient.errors.on(:message_id)).size
+    assert recipient.errors.invalid?(:message_id)
   end
   
   def test_should_require_a_kind
     recipient = new_message_recipient(:kind => nil)
     assert !recipient.valid?
-    assert_equal 1, Array(recipient.errors.on(:kind)).size
+    assert recipient.errors.invalid?(:kind)
   end
   
   def test_should_require_a_state
     recipient = new_message_recipient(:state => nil)
     assert !recipient.valid?
-    assert_equal 1, Array(recipient.errors.on(:state)).size
+    assert recipient.errors.invalid?(:state)
   end
   
   def test_should_require_a_receiver_id
     recipient = new_message_recipient(:receiver => nil)
     assert !recipient.valid?
-    assert_equal 1, Array(recipient.errors.on(:receiver_id)).size
+    assert recipient.errors.invalid?(:receiver_id)
   end
   
   def test_should_require_a_receiver_type
     recipient = new_message_recipient(:receiver => nil)
     assert !recipient.valid?
-    assert_equal 1, Array(recipient.errors.on(:receiver_type)).size
+    assert recipient.errors.invalid?(:receiver_type)
   end
   
   def test_should_not_require_a_position
@@ -224,7 +224,7 @@ end
 class MessageRecipientHiddenTest < Test::Unit::TestCase
   def setup
     @recipient = create_message_recipient
-    @recipient.hide!
+    @recipient.hide
   end
   
   def test_should_record_when_it_was_hidden
@@ -239,8 +239,8 @@ end
 class MessageRecipientUnhiddenTest < Test::Unit::TestCase
   def setup
     @recipient = create_message_recipient
-    @recipient.hide!
-    @recipient.unhide!
+    @recipient.hide
+    @recipient.unhide
   end
   
   def test_should_not_have_the_recorded_value_when_it_was_hidden

data/test/unit/message_test.rb

@@ -36,19 +36,19 @@ class MessageTest < Test::Unit::TestCase
   def test_should_require_a_sender_id
     message = new_message(:sender => nil)
     assert !message.valid?
-    assert_equal 1, Array(message.errors.on(:sender_id)).size
+    assert message.errors.invalid?(:sender_id)
   end
   
   def test_should_require_a_sender_type
     message = new_message(:sender => nil)
     assert !message.valid?
-    assert_equal 1, Array(message.errors.on(:sender_type)).size
+    assert message.errors.invalid?(:sender_type)
   end
   
   def test_should_require_a_state
     message = new_message(:state => nil)
     assert !message.valid?
-    assert_equal 1, Array(message.errors.on(:state)).size
+    assert message.errors.invalid?(:state)
   end
   
   def test_should_not_require_a_subject
@@ -268,7 +268,7 @@ end
 class MessageHiddenTest < Test::Unit::TestCase
   def setup
     @message = create_message
-    @message.hide!
+    @message.hide
   end
   
   def test_should_record_when_it_was_hidden
@@ -283,8 +283,8 @@ end
 class MessageUnhiddenTest < Test::Unit::TestCase
   def setup
     @message = create_message
-    @message.hide!
-    @message.unhide!
+    @message.hide
+    @message.unhide
   end
   
   def test_should_not_have_the_recorded_value_when_it_was_hidden

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: has_messages
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.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 
@@ -32,29 +32,29 @@ extra_rdoc_files: []
 
 files: 
 - app/models
-- app/models/message.rb
 - app/models/message_recipient.rb
+- app/models/message.rb
 - db/migrate
-- db/migrate/002_create_message_recipients.rb
 - db/migrate/001_create_messages.rb
+- db/migrate/002_create_message_recipients.rb
 - lib/has_messages.rb
-- test/app_root
-- test/app_root/app
-- test/app_root/app/models
-- test/app_root/app/models/user.rb
-- 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_create_users.rb
-- test/app_root/db/migrate/002_migrate_has_messages_to_version_2.rb
+- test/factory.rb
+- test/test_helper.rb
 - test/functional
 - test/functional/has_messages_test.rb
-- test/test_helper.rb
-- test/factory.rb
 - test/unit
 - test/unit/message_test.rb
 - test/unit/message_recipient_test.rb
+- test/app_root
+- test/app_root/db
+- test/app_root/db/migrate
+- test/app_root/db/migrate/002_migrate_has_messages_to_version_2.rb
+- test/app_root/db/migrate/001_create_users.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/user.rb
 - CHANGELOG.rdoc
 - init.rb
 - LICENSE