acts-as-messageable 0.4.0 → 0.4.1

data/Gemfile

@@ -6,7 +6,6 @@ gem "ancestry", "~> 1.2.4"
 
 group :development do
   gem "rspec", "~> 2.6.0"
-  gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.0"
   gem "sqlite3-ruby"
 end

data/README.md

@@ -0,0 +1,165 @@
+
+ActsAsMessageable
+=================
+
+The Acts As Messageable allows communication between the models.
+
+[![Build Status](http://travis-ci.org/LTe/acts-as-messageable.png)](http://github.com/LTe/acts-as-messageable)
+
+Usage
+=====
+
+To use it, add it to your Gemfile:
+
+```ruby
+gem 'acts-as-messageable'
+```
+
+Post instalation
+================
+
+```
+rails g acts-as-messageable:migration table_name # default 'messages'
+rake db:migrate
+```
+
+Usage
+=====
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_messageable :table_name => "table_with_messages", # default 'messages'
+                      :required   => :body                  # default [:topic, :body]
+                      :class_name => "CustomMessages"       # default "ActsAsMessageable::Message"
+end
+```
+
+Upgrade
+=======
+
+Just type once again
+
+```
+rails g acts-as-messageable:migration
+```
+
+And new migrations should be created.
+
+```
+~$ rails g acts-as-messageable:migration
+    create  db/migrate/20110811223435_add_recipient_permanent_delete_and_sender_permanent_delete_to_messages.rb
+```
+
+Send message
+============
+
+```ruby
+@alice = User.first
+@bob   = User.last
+
+@alice.send_message(@bob, "Message topic", "Hi bob!")
+@bob.send_message(@alice, "Re: Message topic", "Hi alice!")
+```
+
+With hash
+=========
+
+```ruby
+@alice.send_message(@bob, { :body => "Hash body", :topic => "Hash topic" })
+```
+
+Custom required
+===============
+
+In User model
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_messageable :required => :body
+end
+
+@alice.send_message(@bob, { :body => "Hash body" })
+```
+
+or
+
+```ruby
+@alice.send_message(@bob, "body")
+```
+
+Required sequence
+=================
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_messageable :required => [:body, :topic]
+end
+
+@alice.send_message(@bob, "body", "topic")
+```
+
+Conversation
+============
+
+```ruby
+@message = @alice.send_message(@bob, "Hello bob!", "How are you?")
+@reply_message = @bob.reply_to(@message, "Re: Hello bob!", "I'm fine!")
+# or @bob.reply_to(@message, :topic => "Re: Hello bob!", :body => "I'm fine!")
+
+@message.conversation #=> [@message, @reply_message]
+@reply_message.conversation #=> [@message, @reply_message]
+```
+
+Search
+===
+
+```ruby
+@alice.messages # all messages connected with @alice (inbox/outbox)
+@alice.received_messages # @alice inbox
+@alice.sent_messages # @alice outbox
+
+@alice.deleted_messages # all messages connected with @alice (trash)
+
+@alice.messages.are_from(@bob) # all message form @bob
+@alice.messages.are_to(@bob) # all message to @bob
+@alice.messages.with_id(@id_of_message) # message with id id_of_message
+@alice.messages.readed # all readed @alice  messages
+@alice.messages.unread # all unreaded @alice messages
+
+@alice.received_messages.are_from(@bob) # all messages from bob (inbox)
+@alice.sent_messages.are_to(@bob) # all messages do bob (outbox)
+```
+
+You can use multiple filters at the same time
+
+```ruby
+@alice.messages.are_from(@bob).are_to(@alice).readed # all message from @bob to @alice and readed
+@alice.deleted_messages.are_from(@bob) # all deleted messages from @bob
+```
+
+Delete message
+==============
+
+```ruby
+@message = @alice.send_message(@bob, "Topic", "Body")
+
+@alice.messages.process do |message|
+    message.delete
+end
+```
+
+Now we can find message in trash
+
+```ruby
+@alice.deleted_messages #=> [@message]
+
+@alice.deleted_messages.process do |message|
+  message.delete
+end
+
+@alice.delete_message #=> []
+```
+
+Message was permanent delete
+
+Copyright © 2011 Piotr Niełacny (http://ruby-blog.pl), released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/acts-as-messageable.gemspec

@@ -4,22 +4,22 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{acts-as-messageable}
-  s.version = "0.4.0"
+  s.name = "acts-as-messageable"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Piotr Nielacny}]
-  s.date = %q{2011-08-11}
-  s.email = %q{piotr.nielacny@gmail.com}
+  s.authors = ["Piotr Nielacny"]
+  s.date = "2011-11-16"
+  s.email = "piotr.nielacny@gmail.com"
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".rspec",
     ".travis.yml",
     "Gemfile",
     "MIT-LICENSE",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "acts-as-messageable.gemspec",
@@ -37,10 +37,10 @@ Gem::Specification.new do |s|
     "spec/spec_helper.rb",
     "spec/support/user.rb"
   ]
-  s.homepage = %q{http://github.com/LTe/acts-as-messageable}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{Make user messageable!;-)}
+  s.homepage = "http://github.com/LTe/acts-as-messageable"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Make user messageable!;-)"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
@@ -50,7 +50,6 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
       s.add_runtime_dependency(%q<ancestry>, ["~> 1.2.4"])
       s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
     else
@@ -58,7 +57,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<activesupport>, [">= 3.0.0"])
       s.add_dependency(%q<ancestry>, ["~> 1.2.4"])
       s.add_dependency(%q<rspec>, ["~> 2.6.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     end
@@ -67,7 +65,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activesupport>, [">= 3.0.0"])
     s.add_dependency(%q<ancestry>, ["~> 1.2.4"])
     s.add_dependency(%q<rspec>, ["~> 2.6.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
   end

data/lib/generators/acts-as-messageable/migration/migration_generator.rb

@@ -11,13 +11,12 @@ module ActsAsMessageable
     argument :table_name, :type => :string, :default => "messages"
 
     def self.next_migration_number(dirname)
-        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
     end
 
     def create_migration_file
-      migration_template 'migration_permanent.rb', 'db/migrate/add_recipient_permanent_delete_and_sender_permanent_delete_to_messages.rb'
-      migration_template 'migration.rb', 'db/migrate/create_messages_table.rb'
+      migration_template 'migration.rb', 'db/migrate/create_messages_table.rb' rescue nil
+      migration_template 'migration_permanent.rb', 'db/migrate/add_recipient_permanent_delete_and_sender_permanent_delete_to_messages.rb' rescue nil
     end
-
   end
 end

data/spec/acts-as-messageable_spec.rb

@@ -4,140 +4,160 @@ class User < ActiveRecord::Base
   acts_as_messageable
 end
 
+def send_message(from=@bob, to=@alice, topic="Topic", body="Body")
+  from.send_message(to, topic, body)
+end
+
 describe "ActsAsMessageable" do
 
   before(:all) do
     User.acts_as_messageable
   end
 
-  it "should be two users in database" do
-    User.count.should == 2
+  describe "prepare for specs" do
+    it "should be two users in database" do
+      User.count.should == 2
+    end
   end
 
-  it "alice should have one message from bob" do
-    @bob.send_message(@alice, "Topic", "Message body")
-    @alice.messages.count.should == 1
-    @alice.messages.are_from(@bob).count.should == 1
-  end
+  describe "send messages" do
+    it "alice should have one message" do
+      send_message
+      @alice.messages.count.should == 1
+    end
 
-  it "bob should have one message to alice in outbox" do
-    @bob.send_message(@alice, "Topic", "Message body")
-    @bob.messages.count.should == 1
-    @bob.messages.are_to(@alice).count.should == 1
-  end
+    it "alice should have one message from bob" do
+      send_message
+      @alice.messages.are_from(@bob).count.should == 1
+    end
+
+    it "bob should have one message" do
+      send_message
+      @bob.messages.count.should == 1
+    end
 
-  it "bob should have one open message from alice" do
-    @message =  @alice.send_message(@bob, "Topic", "Message body")
-    @bob.messages.are_from(@alice).process do |m|
-      m.open
+    it "bob should have one message to alice in outbox" do
+      send_message
+      @bob.sent_messages.are_to(@alice).count.should == 1
     end
 
-    @bob.messages.readed.count.should == 1
+    it "bob should have one open message from alice" do
+      send_message
+      @alice.messages.are_from(@bob).process { |m| m.open }
+      @alice.messages.readed.count.should == 1
+    end
   end
 
-  it "bob should have one deleted message from alice" do
-    @alice.send_message(@bob, "Topic", "Message body")
-    @bob.messages.process do |m|
-      m.delete
+  describe "delete messages" do
+    it "bob should have one deleted message from alice" do
+      send_message
+      @bob.messages.process do |m|
+        m.delete
+      end
+
+      @bob.messages.each do |m|
+        m.recipient_delete.should == true
+        m.sender_delete.should == false
+      end
+
+      @bob.deleted_messages.count.should == 1
+      @bob.messages.count.should == 0
     end
 
-    @bob.messages.each do |m|
-      m.recipient_delete.should == true
-      m.sender_delete.should == false
+    it "received_messages and sent_messages should work with .process method" do
+      @message = send_message
+
+      @bob.sent_messages.count.should == 1
+      @alice.received_messages.count.should == 1
+
+      @bob.sent_messages.process { |m| m.delete }
+      @bob.sent_messages.count.should == 0
+      @alice.received_messages.count.should == 1
+
+      @alice.received_messages.process { |m| m.delete }
+      @alice.received_messages.count.should == 0
     end
 
-    @bob.deleted_messages.count.should == 1
-    @bob.messages.count.should == 0
+    it "message should permanent delete" do
+      @message = send_message
+      @alice.messages.process { |m| m.delete }
+      @alice.messages.count.should == 0
+
+      @alice.deleted_messages.count.should == 1
+      @alice.deleted_messages.process { |m| m.delete }
+      @alice.deleted_messages.count.should == 0
+
+      @message.reload
+      @message.recipient_permanent_delete.should == true
+
+      @bob.sent_messages.count.should == 1
+    end
   end
 
-  it "alice should have one unread message from bob" do
-    @bob.send_message(@alice, "Topic", "Message body")
-    @alice.messages.are_from(@bob).unread.count.should == 1
-    @alice.messages.are_from(@bob).readed.count.should == 0
+  describe "read/unread feature" do
+    it "alice should have one unread message from bob" do
+      send_message
+      @alice.messages.are_from(@bob).unread.count.should == 1
+      @alice.messages.are_from(@bob).readed.count.should == 0
+    end
   end
 
   it "should be in database message with id ..." do
-    message_id = @bob.send_message(@alice, "Topic", "Message body").id
+    message_id = send_message.id
     @bob.messages.with_id(message_id).count.should == 1
   end
 
   it "message should have proper topic" do
-    @bob.send_message(@alice, "Topic", "Message body")
+    send_message
     @bob.messages.count.should == 1
     @bob.messages.first.topic == "Topic"
-    @bob.messages.first.body == "Message body"
   end
 
-  it "bob send message to alice, and alice reply to bob message and show proper tree" do
-    @message = @bob.send_message(@alice, "Topic", "Body")
-    @reply_message =  @alice.reply_to(@message, "Re: Topic", "Body")
-  
-    @reply_message.conversation.size.should == 2
-    @reply_message.conversation.first.topic.should == "Topic"
-    @reply_message.conversation.last.topic.should == "Re: Topic"
-  end
+  describe "conversation" do
+    it "bob send message to alice, and alice reply to bob message and show proper tree" do
+      @message = send_message
+      @reply_message =  @alice.reply_to(@message, "Re: Topic", "Body")
 
-  it "bob send message to alice, alice answer, and bob answer for alice answer" do
-    @message = @bob.send_message(@alice, "Topic", "Body")
-    @reply_message =  @alice.reply_to(@message, "Re: Topic", "Body")
-    @reply_reply_message = @bob.reply_to(@reply_message, "Re: Re: Topic", "Body")
-
-    [@message, @reply_message, @reply_reply_message].each do |m|
-      m.conversation.size.should == 3
+      @reply_message.conversation.size.should == 2
+      @reply_message.conversation.first.topic.should == "Topic"
+      @reply_message.conversation.last.topic.should == "Re: Topic"
     end
 
-    @message.conversation.last.should == @reply_reply_message
-    @reply_reply_message.conversation.last.should == @reply_reply_message
-  end
+    it "bob send message to alice, alice answer, and bob answer for alice answer" do
+      @message = send_message
+      @reply_message = @alice.reply_to(@message, "Re: Topic", "Body")
+      @reply_reply_message = @bob.reply_to(@reply_message, "Re: Re: Topic", "Body")
 
-  it "send message with hash" do
-    @message = @bob.send_message(@alice, {:body => "Body", :topic => "Topic"})
-    @message.topic.should == "Topic"
-    @message.body.should == "Body"
-  end
+      [@message, @reply_message, @reply_reply_message].each do |m|
+        m.conversation.size.should == 3
+      end
 
-  it "messages should return in right order :created_at" do
-    @message = @bob.send_message(@alice, "Topic", "First message")
-    @message = @bob.send_message(@alice, "Topic", "Sec message")
-    @alice.messages.first.body.should == "First message"
+      @message.conversation.last.should == @reply_reply_message
+      @reply_reply_message.conversation.last.should == @reply_reply_message
+    end
   end
 
-  it "message should permanent delete" do
-    @message = @bob.send_message(@alice, "Topic", "Message")
-    @alice.messages.process { |m| m.delete }
-    @alice.messages.count.should == 0
-
-    @alice.deleted_messages.count.should == 1
-    @alice.deleted_messages.process { |m| m.delete }
-    @alice.deleted_messages.count.should == 0
-
-    @message.reload
-    @message.recipient_permanent_delete.should == true
+  describe "send messages with hash" do
+    it "send message with hash" do
+      @message = @bob.send_message(@alice, {:body => "Body", :topic => "Topic"})
+      @message.topic.should == "Topic"
+      @message.body.should == "Body"
+    end
+  end
 
-    @bob.sent_messages.count.should == 1
+  it "messages should return in right order :created_at" do
+    @message = send_message
+    @message = send_message(@bob, @alice, "Example", "Example Body")
+    @alice.messages.first.body.should == "Body"
   end
 
   it "received_messages should return ActiveRecord::Relation" do
-    @message = @bob.send_message(@alice, "Topic", "Message")
+    send_message
     @alice.received_messages.class.should == ActiveRecord::Relation
   end
 
   it "sent_messages should return ActiveRecord::Relation" do
-    @message = @bob.send_message(@alice, "Topic", "Message")
+    send_message
     @bob.sent_messages.class.should == ActiveRecord::Relation
   end
-
-  it "received_messages and sent_messages should work with .process method" do
-    @message = @bob.send_message(@alice, "Helou", "Alice")
-
-    @bob.sent_messages.count.should == 1
-    @alice.received_messages.count.should == 1
-
-    @bob.sent_messages.process { |m| m.delete }
-    @bob.sent_messages.count.should == 0
-    @alice.received_messages.count.should == 1
-
-    @alice.received_messages.process { |m| m.delete }
-    @alice.received_messages.count.should == 0
-  end
 end

metadata

@@ -1,146 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: acts-as-messageable
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 0.4.1
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 0
-  version: 0.4.0
 platform: ruby
-authors: 
+authors:
 - Piotr Nielacny
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2011-11-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &69822268751920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
-  version_requirements: *id001
-  name: activerecord
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: *69822268751920
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &69822268749940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
-  version_requirements: *id002
-  name: activesupport
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :runtime
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: *69822268749940
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: &69822268747920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 2
-        - 4
+      - !ruby/object:Gem::Version
         version: 1.2.4
-  version_requirements: *id003
-  name: ancestry
+  type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *69822268747920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &69822268746840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.6.0
-  version_requirements: *id004
-  name: rspec
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id005
-  name: bundler
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *69822268746840
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &69822268745520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.6.0
-  version_requirements: *id006
-  name: jeweler
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id007
+  prerelease: false
+  version_requirements: *69822268745520
+- !ruby/object:Gem::Dependency
   name: sqlite3-ruby
+  requirement: &69822268743820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
+  version_requirements: *69822268743820
 description: 
 email: piotr.nielacny@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
+extra_rdoc_files:
+- README.md
+files:
 - .rspec
 - .travis.yml
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - acts-as-messageable.gemspec
@@ -159,36 +107,29 @@ files:
 - spec/support/user.rb
 homepage: http://github.com/LTe/acts-as-messageable
 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
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3869198984656405401
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Make user messageable!;-)
 test_files: []
-

data/README.rdoc

@@ -1,118 +0,0 @@
-
-= ActsAsMessageable
-The Acts As Messageable allows communication between the models.
-
-http://travis-ci.org/LTe/acts-as-messageable.png
-
-
-== Usage
-To use it, add it to your Gemfile:
-
-  gem 'acts-as-messageable'
-
-== Post instalation
-
-  rails g acts-as-messageable:migration table_name # default 'messages'
-  rake db:migrate
-
-== Usage
-
-  class User < ActiveRecord::Base
-    acts_as_messageable :table_name => "table_with_messages", # default 'messages'
-                        :required   => :body                  # default [:topic, :body]
-                        :class_name => "CustomMessages"       # default "ActsAsMessageable::Message"
-    end
-
-== Upgrade
-Just type once again
-
-  rails g acts-as-messageable:migration
-
-And new migrations should be created.
-
-  ~$ rails g acts-as-messageable:migration
-      create  db/migrate/20110811223435_add_recipient_permanent_delete_and_sender_permanent_delete_to_messages.rb
-      Another migration is already named create_messages_table: /home/lite/work/acts_test/db/migrate/20110811184810_create_messages_table.rb
-
-== Send message
-
-  @alice = User.first
-  @bob   = User.last
-
-  @alice.send_message(@bob, "Message topic", "Hi bob!")
-  @bob.send_message(@alice, "Re: Message topic", "Hi alice!")
-
-=== With hash
-
-  @alice.send_message(@bob, { :body => "Hash body", :topic => "Hash topic" })
-
-=== Custom required
-
-In User model
-  class User < ActiveRecord::Base
-    acts_as_messageable :required => :body
-  end
-
-  @alice.send_message(@bob, { :body => "Hash body" })
-or
-  @alice.send_message(@bob, "body")
-
-==== Required sequence
-
-
-  class User < ActiveRecord::Base
-    acts_as_messageable :required => [:body, :topic]
-  end
-
-  @alice.send_message(@bob, "body", "topic")
-
-== Conversation
-  @message = @alice.send_message(@bob, "Hello bob!", "How are you?")
-  @reply_message = @bob.reply_to(@message, "Re: Hello bob!", "I'm fine!")
-  # or @bob.reply_to(@message, :topic => "Re: Hello bob!", :body => "I'm fine!")
-
-  @message.conversation #=> [@message, @reply_message]
-  @reply_message.conversation #=> [@message, @reply_message]
-
-== API
-  @alice.messages # all messages connected with @alice (inbox/outbox)
-  @alice.received_messages # @alice inbox
-  @alice.sent_messages # @alice outbox
-
-  @alice.deleted_messages # all messages connected with @alice (trash)
-
-  @alice.messages.are_from(@bob) # all message form @bob
-  @alice.messages.are_to(@bob) # all message to @bob
-  @alice.messages.with_id(@id_of_message) # message with id id_of_message
-  @alice.messages.readed # all readed @alice  messages
-  @alice.messages.unread # all unreaded @alice messages
-
-  @alice.received_messages.are_from(@bob) # all messages from bob (inbox)
-  @alice.sent_messages.are_to(@bob) # all messages do bob (outbox)
-
-You can use multiple filters at the same time
-
-  @alice.messages.are_from(@bob).are_to(@alice).readed # all message from @bob to @alice and readed
-  @alice.deleted_messages.are_from(@bob) # all deleted messages from @bob
-
-=== Delete message
-
-  @message = @alice.send_message(@bob, "Topic", "Body")
-
-  @alice.messages.process do |message|
-      message.delete
-  end
-
-Now we can find message in trash
-
-  @alice.deleted_messages #=> [@message]
-
-  @alice.deleted_messages.process do |message|
-    message.delete
-  end
-
-  @alice.delete_message #=> []
-
-Message was permanent delete
-
-Copyright © 2011 Piotr Niełacny (http://ruby-blog.pl), released under the MIT license