acts-as-messageable 0.3.1 → 0.4.0

data/Gemfile

@@ -1,6 +1,7 @@
 source "http://rubygems.org"
 
-gem "activerecord", "~> 3.0.0"
+gem "activerecord", ">= 3.0.0"
+gem "activesupport", ">= 3.0.0"
 gem "ancestry", "~> 1.2.4"
 
 group :development do

data/README.rdoc

@@ -20,8 +20,20 @@ To use it, add it to your Gemfile:
   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
@@ -62,7 +74,7 @@ or
   @message.conversation #=> [@message, @reply_message]
   @reply_message.conversation #=> [@message, @reply_message]
 
-== New API
+== API
   @alice.messages # all messages connected with @alice (inbox/outbox)
   @alice.received_messages # @alice inbox
   @alice.sent_messages # @alice outbox
@@ -73,7 +85,10 @@ or
   @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.unaded # all unreaded @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
 
@@ -82,9 +97,22 @@ You can use multiple filters at the same time
 
 === 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

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/acts-as-messageable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts-as-messageable}
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Piotr Nielacny"]
-  s.date = %q{2011-07-02}
+  s.authors = [%q{Piotr Nielacny}]
+  s.date = %q{2011-08-11}
   s.email = %q{piotr.nielacny@gmail.com}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -29,29 +29,33 @@ Gem::Specification.new do |s|
     "lib/acts-as-messageable/relation.rb",
     "lib/generators/acts-as-messageable/migration/migration_generator.rb",
     "lib/generators/acts-as-messageable/migration/templates/migration.rb",
+    "lib/generators/acts-as-messageable/migration/templates/migration_permanent.rb",
     "rails/init.rb",
     "spec/acts-as-messageable_spec.rb",
+    "spec/custom-class_spec.rb",
     "spec/custom-required_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/user.rb"
   ]
   s.homepage = %q{http://github.com/LTe/acts-as-messageable}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{Make user messageable!;-)}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0"])
+      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
-      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+      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"])
@@ -59,7 +63,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+    s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+    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"])

data/lib/acts-as-messageable.rb

@@ -1,5 +1,6 @@
 require "active_record"
-require 'acts-as-messageable/acts-as-messageable'
+require "active_support/core_ext"
+require "acts-as-messageable/acts-as-messageable"
 
 module ActsAsMessageable
   autoload :Message, "acts-as-messageable/message"

data/lib/acts-as-messageable/acts-as-messageable.rb

@@ -6,32 +6,32 @@ module ActsAsMessageable
     end
 
     module ClassMethods
+      mattr_accessor :class_name
+
       # Method make ActiveRecord::Base object messageable
       # @param [Symbol] :table_name - table name for messages
       def acts_as_messageable(options = {})
-        has_many  :received_messages, 
+        has_many  :received_messages_relation, 
                   :as => :received_messageable, 
-                  :class_name => "ActsAsMessageable::Message", 
+                  :class_name => options[:class_name] || "ActsAsMessageable::Message",
                   :dependent => :nullify
-        has_many  :sent_messages, 
+        has_many  :sent_messages_relation, 
                   :as => :sent_messageable,
-                  :class_name => "ActsAsMessageable::Message", 
+                  :class_name => options[:class_name] || "ActsAsMessageable::Message",
                   :dependent => :nullify
 
-
-        ActsAsMessageable::Message.set_table_name(options[:table_name] || "messages")
-        ActsAsMessageable::Message.validates_presence_of(options[:required] || [:topic ,:body])
+        self.class_name = (options[:class_name] || "ActsAsMessageable::Message").constantize
+        self.class_name.set_table_name(options[:table_name] || "messages")
 
         if options[:required].is_a? Symbol
-          ActsAsMessageable::Message.required = [options[:required]]
+          self.class_name.required = [options[:required]]
         elsif options[:required].is_a? Array
-          ActsAsMessageable::Message.required = options[:required]
+          self.class_name.required = options[:required]
         else
-          ActsAsMessageable::Message.required = [:topic, :body]
+          self.class_name.required = [:topic, :body]
         end
 
-        ActsAsMessageable::Message.validates_presence_of ActsAsMessageable::Message.required
-
+        self.class_name.validates_presence_of self.class_name.required
         include ActsAsMessageable::Model::InstanceMethods
     end
 
@@ -41,7 +41,21 @@ module ActsAsMessageable
       # Get all messages connected with user
       # @return [ActiveRecord::Relation] all messages connected with user
       def messages(trash = false)
-        result = ActsAsMessageable::Message.connected_with(self, trash)
+        result = self.class.class_name.connected_with(self, trash)
+        result.relation_context = self
+
+        result
+      end
+
+      def received_messages
+        result = received_messages_relation.scoped.where(:recipient_delete => false)
+        result.relation_context = self
+
+        result
+      end
+
+      def sent_messages
+        result = sent_messages_relation.scoped.where(:sender_delete => false)
         result.relation_context = self
 
         result
@@ -61,17 +75,17 @@ module ActsAsMessageable
         case args.first
           when String
             message_attributes = {}
-            ActsAsMessageable::Message.required.each_with_index do |attribute, index|
+            self.class.class_name.required.each_with_index do |attribute, index|
               message_attributes[attribute] = args[index]
             end
           when Hash
             message_attributes = args.first
         end
 
-        message = ActsAsMessageable::Message.create! message_attributes
+        message = self.class.class_name.create! message_attributes
 
-        self.sent_messages << message
-        to.received_messages << message
+        self.sent_messages_relation << message
+        to.received_messages_relation << message
 
         message
       end
@@ -88,9 +102,17 @@ module ActsAsMessageable
         current_user = self
 
         if message.received_messageable == current_user
-          message.update_attributes!(:recipient_delete => true)
+          unless message.recipient_delete
+            message.update_attributes!(:recipient_delete => true)
+          else
+            message.update_attributes!(:recipient_permanent_delete => true)
+          end
         elsif message.sent_messageable == current_user
-          message.update_attributes!(:sender_delete => true)
+          unless message.sender_delete
+            message.update_attributes!(:sender_delete => true)
+          else
+            message.update_attributes!(:sender_permanent_delete => true)
+          end
         end
       end
 

data/lib/acts-as-messageable/message.rb

@@ -15,29 +15,36 @@ module ActsAsMessageable
                     :sent_messageable_id,
                     :opened,
                     :recipient_delete,
-                    :sender_delete
+                    :sender_delete,
+                    :recipient_permanent_delete,
+                    :sender_permanent_delete,
+                    :created_at,
+                    :updated_at
 
     attr_accessor :removed
     cattr_accessor :required
 
 
     # Sample documentation for scope
+    default_scope order(:created_at)
     scope :are_from,          lambda { |*args| where("sent_messageable_id = :sender", :sender => args.first) }
     scope :are_to,            lambda { |*args| where("received_messageable_id = :receiver", :receiver => args.first) }
     scope :with_id,           lambda { |*args| where("id = :id", :id => args.first) }
 
     scope :connected_with,    lambda { |*args|  where("(sent_messageable_type = :sent_type and
                                                 sent_messageable_id = :sent_id and
-                                                sender_delete = :s_delete) or
+                                                sender_delete = :s_delete and sender_permanent_delete = :s_perm_delete) or
                                                 (received_messageable_type = :received_type and
                                                 received_messageable_id = :received_id and
-                                                recipient_delete = :r_delete)",
+                                                recipient_delete = :r_delete and recipient_permanent_delete = :r_perm_delete)",
                                                 :sent_type      => args.first.class.name,
                                                 :sent_id        => args.first.id,
                                                 :received_type  => args.first.class.name,
                                                 :received_id    => args.first.id,
                                                 :r_delete       => args.last,
-                                                :s_delete       => args.last)
+                                                :s_delete       => args.last,
+                                                :r_perm_delete  => false,
+                                                :s_perm_delete  => false)
                                      }
     scope :readed,            lambda { where("opened = :opened", :opened => true)  }
     scope :unread,            lambda { where("opened = :opened", :opened => false) }

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

@@ -15,6 +15,7 @@ module ActsAsMessageable
     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'
     end
 

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

@@ -8,6 +8,7 @@ class CreateMessagesTable < ActiveRecord::Migration
       t.boolean :opened, :default => false
       t.boolean :recipient_delete, :default => false
       t.boolean :sender_delete, :default => false
+      t.timestamps
 
       # ancestry
       t.string :ancestry

data/lib/generators/acts-as-messageable/migration/templates/migration_permanent.rb

@@ -0,0 +1,11 @@
+class AddRecipientPermanentDeleteAndSenderPermanentDeleteToMessages < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name %>, :recipient_permanent_delete, :boolean, :default => false
+    add_column :<%= table_name %>, :sender_permanent_delete, :boolean, :default => false
+  end
+
+  def self.down
+    remove_column :<%= table_name %>, :recipient_permanent_delete
+    remove_column :<%= table_name %>, :sender_permanent_delete
+  end
+end

data/spec/acts-as-messageable_spec.rb

@@ -95,4 +95,49 @@ describe "ActsAsMessageable" do
     @message.topic.should == "Topic"
     @message.body.should == "Body"
   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"
+  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
+
+    @bob.sent_messages.count.should == 1
+  end
+
+  it "received_messages should return ActiveRecord::Relation" do
+    @message = @bob.send_message(@alice, "Topic", "Message")
+    @alice.received_messages.class.should == ActiveRecord::Relation
+  end
+
+  it "sent_messages should return ActiveRecord::Relation" do
+    @message = @bob.send_message(@alice, "Topic", "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

data/spec/custom-class_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class CustomMessage < ActsAsMessageable::Message; end
+
+describe "custom class" do
+  before(:all) do
+    User.acts_as_messageable :class_name => "CustomMessage"
+  end
+
+  it "message should have CustomMessage class" do
+    message = @alice.send_message(@bob, :topic => "Helou bob!", :body => "What's up?")
+    message.class.should == CustomMessage
+  end
+end
+

data/spec/spec_helper.rb

@@ -21,7 +21,7 @@ RSpec.configure do |config|
   end
 
   config.after(:each) do
-    ActsAsMessageable::Message.destroy_all
+    User.class_name.destroy_all
   end
 end
 
@@ -35,7 +35,10 @@ def create_database
       t.boolean :opened, :default => false
       t.boolean :recipient_delete, :default => false
       t.boolean :sender_delete, :default => false
+      t.boolean :recipient_permanent_delete, :default => false
+      t.boolean :sender_permanent_delete, :default => false
       t.string :ancestry
+      t.timestamps
     end
 
     create_table :users do |t|

metadata

@@ -1,90 +1,141 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: acts-as-messageable
-version: !ruby/object:Gem::Version
-  version: 0.3.1
+version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
-authors:
+authors: 
 - Piotr Nielacny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-02 00:00:00.000000000 +02:00
-default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: &22115060 !ruby/object:Gem::Requirement
+
+date: 2011-08-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
         version: 3.0.0
+  version_requirements: *id001
+  name: activerecord
+  prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  version_requirements: *id002
+  name: activesupport
   prerelease: false
-  version_requirements: *22115060
-- !ruby/object:Gem::Dependency
-  name: ancestry
-  requirement: &22114520 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
         version: 1.2.4
-  type: :runtime
+  version_requirements: *id003
+  name: ancestry
   prerelease: false
-  version_requirements: *22114520
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &22113940 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
         version: 2.6.0
-  type: :development
+  version_requirements: *id004
+  name: rspec
   prerelease: false
-  version_requirements: *22113940
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &22113380 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-  type: :development
+  version_requirements: *id005
+  name: bundler
   prerelease: false
-  version_requirements: *22113380
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &22112860 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
         version: 1.6.0
-  type: :development
+  version_requirements: *id006
+  name: jeweler
   prerelease: false
-  version_requirements: *22112860
-- !ruby/object:Gem::Dependency
-  name: sqlite3-ruby
-  requirement: &22112200 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+- !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
+  name: sqlite3-ruby
   prerelease: false
-  version_requirements: *22112200
 description: 
 email: piotr.nielacny@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.rdoc
-files:
+files: 
 - .rspec
 - .travis.yml
 - Gemfile
@@ -99,37 +150,45 @@ files:
 - lib/acts-as-messageable/relation.rb
 - lib/generators/acts-as-messageable/migration/migration_generator.rb
 - lib/generators/acts-as-messageable/migration/templates/migration.rb
+- lib/generators/acts-as-messageable/migration/templates/migration_permanent.rb
 - rails/init.rb
 - spec/acts-as-messageable_spec.rb
+- spec/custom-class_spec.rb
 - spec/custom-required_spec.rb
 - spec/spec_helper.rb
 - spec/support/user.rb
-has_rdoc: true
 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
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -1671763449284017363
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Make user messageable!;-)
 test_files: []
+