has_messages_huacnlee 0.4.1 → 0.4.2

data/{README.rdoc → README.md}

@@ -1,26 +1,8 @@
-= has_messages
+# has_messages
 
 +has_messages+ demonstrates a reference implementation for sending messages between users.
 
-== Resources
-
-API
-
-* http://rdoc.info/projects/pluginaweek/has_messages
-
-Bugs
-
-* http://pluginaweek.lighthouseapp.com/projects/13274-has_messages
-
-Development
-
-* http://github.com/pluginaweek/has_messages
-
-Source
-
-* git://github.com/pluginaweek/has_messages.git
-
-== Description
+## Description
 
 Messaging between users is fairly common in web applications, especially those
 that support social networking.  Messaging doesn't necessarily need to be
@@ -31,82 +13,104 @@ 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 reference implementation of these features.
 
-== Usage
+## Usage
+
+### Installation
 
-=== Installation
+In your Gemfile:
 
-+has_messages+ requires additional database tables to work.  You can generate
+```ruby
+gem 'has_messages_huacnlee'
+```
+
+`has_messages` requires additional database tables to work.  You can generate
 a migration for these tables like so:
 
-  rails g has_messages
+```bash
+$ rails g has_messages
+```
 
 Then simply migrate your database:
 
-  rake db:migrate
+```bash
+$ rake db:migrate
+```
 
 === Adding message support
 
-  class User < ActiveRecord::Base
-    has_messages
-  end
+```ruby
+class User < ActiveRecord::Base
+  has_messages
+end
+```
 
 This will build the following associations:
+
 * +messages+
 * +unsent_messages+
 * +sent_messages+
 * +received_messages+
 
 If you have more specific needs, you can create the same associations manually
-that +has_messages+ builds.  See 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
+### Creating new messages
 
-  message = user.messages.build
-  message.to user1, user2
-  message.subject = 'Hey!'
-  message.body = 'Does anyone want to go out tonight?'
-  message.deliver
+```ruby
+message = user.messages.build
+message.to user1, user2
+message.subject = 'Hey!'
+message.body = 'Does anyone want to go out tonight?'
+message.deliver
+```
 
-=== Replying to messages
+### Replying to messages
 
-  reply = message.reply_to_all
-  reply.body = "I'd love to go out!"
-  reply.deliver
+```ruby
+reply = message.reply_to_all
+reply.body = "I'd love to go out!"
+reply.deliver
+```
 
-=== Forwarding messages
+### Forwarding messages
 
-  forward = message.forward
-  forward.body = 'Interested?'
-  forward.deliver
+```ruby
+forward = message.forward
+forward.body = 'Interested?'
+forward.deliver
+```
 
-=== Processing messages asynchronously
+### Processing messages asynchronously
 
 In addition to delivering messages immediately, you can also *queue* messages so
 that an external application processes and delivers them.  This is especially
 useful for messages that need to be sent outside of the confines of the application.
 
 To queue messages for external processing, you can use the +queue+ event,
-rather than +deliver+.  This will indicate to any external processes that
+rather than `deliver`.  This will indicate to any external processes that
 the message is ready to be sent.
 
 To process queued emails, you need an external cron job that checks and sends
 them like so:
 
-  Message.with_state('queued').each do |message|
-    message.deliver
-  end
+```ruby
+Message.with_state('queued').each do |message|
+  message.deliver
+end
+```
 
-== Testing
+## Testing
 
 Before you can run any tests, the following gem must be installed:
 * plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
 
 To run against a specific version of Rails:
 
-  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
-
-== Dependencies
+```bash
+$ rake test
+```
+## Dependencies
 
-* Rails 2.3 or later
+* Rails 3.2.x
 * state_machine[http://github.com/pluginaweek/state_machine]

data/init.rb

@@ -1 +1 @@
-require 'has_messages'
+require "has_messages"

data/lib/generators/has_messages/templates/001_create_messages.rb

@@ -3,12 +3,15 @@ class CreateMessages < ActiveRecord::Migration
     create_table :messages do |t|
       t.references :sender, :polymorphic => true, :null => false
       t.text :subject, :body
-      t.string :state, :null => false
+      t.string :state, :null => false, :length => 10
       t.datetime :hidden_at
-      t.string :type
+      t.string :type, :length => 20
       t.belongs_to :original_message
       t.timestamps
     end
+    add_index :messages, [:sender_type,:sender_id]
+    add_index :messages, :hidden_at
+    add_index :messages, :state
   end
 
   def self.down

data/lib/generators/has_messages/templates/002_create_message_recipients.rb

@@ -3,11 +3,12 @@ class CreateMessageRecipients < ActiveRecord::Migration
     create_table :message_recipients do |t|
       t.references :message, :null => false
       t.references :receiver, :polymorphic => true, :null => false
-      t.string :kind, :null => false
+      t.string :kind, :null => false, :length => 20
       t.integer :position
-      t.string :state, :null => false
+      t.string :state, :null => false, :length => 10
       t.datetime :hidden_at
     end
+    add_index :message_recipients, [:receiver_type, :receiver_id]
     add_index :message_recipients, [:message_id, :kind, :position], :unique => true
   end
   

data/lib/has_messages.rb

@@ -2,101 +2,54 @@ require 'state_machine'
 
 # 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 DESC'
-      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 DESC'
-#      has_many  :received_message_threads,
-#                  :as => :receiver,
-#                  :class_name => 'MessageRecipient',
-#                  :include => :message,
-#                  :conditions => ['message_recipients.hidden_at IS NULL AND messages.state = ? and messages.original_message_id IS NOT NULL', 'sent'],
-#                  :group => 'messages.original_message_id',
-#                  :order => 'messages.created_at DESC'
-
-      include HasMessages::InstanceMethods
-    end
+  extend ActiveSupport::Concern
+  
+  included do
+    has_many  :messages,
+                :as => :sender,
+                :class_name => 'Message',
+                :conditions => {:hidden_at => nil},
+                :order => 'messages.id DESC'
+    has_many  :received_messages,
+                :as => :receiver,
+                :class_name => 'MessageRecipient',
+                :include => :message,
+                :conditions => ['message_recipients.hidden_at IS NULL AND messages.state = ?', 'sent'],
+                :order => 'messages.id DESC'
   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(:queued, :sent)
-    end
-
-    # Returns the most recent message of each thread
-    def last_received_message_per_thread
-      MessageRecipient.find_all_by_receiver_id(id, :order => 'id desc', :joins => :message, :conditions => 'message_recipients.hidden_at is null', :group => 'COALESCE(original_message_id,messages.id)')
-    end
-    
-    def conversations
-      (messages + received_messages.map(&:message)).compact.uniq
-    end
+  # 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(:queued, :sent)
+  end
 
-    def original_conversations
-      conversations.select{ |message| message.original_message_id == nil }
-    end
+  # Returns the most recent message of each thread
+  def last_received_message_per_thread
+    MessageRecipient.find_all_by_receiver_id(id, :order => 'id desc', :joins => :message, :conditions => 'message_recipients.hidden_at is null', :group => 'COALESCE(original_message_id,messages.id)')
+  end
+  
+  def conversations
+    (messages + received_messages.map(&:message)).compact.uniq
+  end
 
-    def find_conversation_by_id(id)
-      conversations.select{ |message| message.id == id.to_i }.first
-    end
+  def original_conversations
+    conversations.select{ |message| message.original_message_id == nil }
+  end
 
-    def unread_messages
-      received_messages.select(&:unread?).map(&:message)
-    end
+  def find_conversation_by_id(id)
+    conversations.select{ |message| message.id == id.to_i }.first
   end
-end
 
-ActiveRecord::Base.class_eval do
-  extend HasMessages::MacroMethods
+  def unread_messages
+    received_messages.select(&:unread?).map(&:message)
+  end
 end
 
 require 'has_messages/models/message.rb'

data/lib/has_messages/models/message_recipient.rb

@@ -31,7 +31,7 @@ class MessageRecipient < ActiveRecord::Base
   
   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

data/lib/has_messages_huacnlee.rb

@@ -0,0 +1 @@
+require 'has_messages.rb'

metadata

@@ -1,47 +1,40 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: has_messages_huacnlee
-version: !ruby/object:Gem::Version 
-  hash: 13
+version: !ruby/object:Gem::Version
+  version: 0.4.2
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
 platform: ruby
-authors: 
+authors:
 - Aaron Pfeifer
+- Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-03-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2010-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: state_machine
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 7
-        - 0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.7.0
+    none: false
   type: :runtime
-  version_requirements: *id001
-description: has_messages fork for Rails 3, Demonstrates a reference implementation for sending messages between users in ActiveRecord
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+    none: false
+description: has_messages fork for Rails 3, Demonstrates a reference implementation
+  for sending messages between users in ActiveRecord
 email: aaron@pluginaweek.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/generators/has_messages/has_messages_generator.rb
 - lib/generators/has_messages/templates/001_create_messages.rb
 - lib/generators/has_messages/templates/002_create_message_recipients.rb
@@ -49,57 +42,32 @@ files:
 - lib/has_messages/models/message.rb
 - lib/has_messages/models/message_recipient.rb
 - lib/has_messages.rb
+- lib/has_messages_huacnlee.rb
 - init.rb
-- README.rdoc
-- 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/db/migrate/002_migrate_has_messages_to_version_2.rb
-- test/factory.rb
-- test/functional/has_messages_test.rb
-- test/test_helper.rb
-- test/unit/message_recipient_test.rb
-- test/unit/message_test.rb
-homepage: http://www.pluginaweek.org
+- README.md
+homepage: https://github.com/huacnlee/has_messages
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
 requirements: []
-
-rubyforge_project: pluginaweek
-rubygems_version: 1.8.8
+rubyforge_project: 
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Demonstrates a reference implementation for sending messages between users in ActiveRecord
-test_files: 
-- 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/db/migrate/002_migrate_has_messages_to_version_2.rb
-- test/factory.rb
-- test/functional/has_messages_test.rb
-- test/test_helper.rb
-- test/unit/message_recipient_test.rb
-- test/unit/message_test.rb
+summary: Demonstrates a reference implementation for sending messages between users
+  in ActiveRecord
+test_files: []