Merge pull request #95 from LTe/convert-opened-to-opened-at

Add support for `opened_at`

Gemfile

@@ -14,4 +14,5 @@ group :development do
   gem 'rspec'
   gem 'rubocop', require: false
   gem 'sqlite3'
+  gem 'timecop'
 end

Gemfile.lock

@@ -151,6 +151,7 @@ GEM
       tins (~> 1.0)
     thor (1.0.1)
     thread_safe (0.3.6)
+    timecop (0.9.1)
     tins (1.24.1)
       sync
     tzinfo (1.2.7)
@@ -172,6 +173,7 @@ DEPENDENCIES
   rspec
   rubocop
   sqlite3
+  timecop
 
 BUNDLED WITH
    2.1.4

gemfiles/rails_3.2.gemfile

@@ -16,4 +16,5 @@ group :development do
   gem 'rspec'
   gem 'rubocop', require: false
   gem 'sqlite3', '~> 1.3.6'
+  gem 'timecop'
 end

gemfiles/rails_4.2.11.gemfile

@@ -17,4 +17,5 @@ group :development do
   gem 'rspec'
   gem 'rubocop', require: false
   gem 'sqlite3', '~> 1.3.6'
+  gem 'timecop'
 end

gemfiles/rails_5.2.gemfile

@@ -16,4 +16,5 @@ group :development do
   gem 'rspec'
   gem 'rubocop', require: false
   gem 'sqlite3', '~> 1.3.6'
+  gem 'timecop'
 end

gemfiles/rails_6.0.gemfile

@@ -16,4 +16,5 @@ group :development do
   gem 'rspec'
   gem 'rubocop', require: false
   gem 'sqlite3', '~> 1.4.0'
+  gem 'timecop'
 end

gemfiles/rails_master.gemfile

@@ -16,4 +16,5 @@ group :development do
   gem 'rspec'
   gem 'rubocop', require: false
   gem 'sqlite3'
+  gem 'timecop'
 end

lib/acts_as_messageable/message.rb

@@ -13,7 +13,7 @@ class Message < ::ActiveRecord::Base
     cattr_accessor :required
 
     ActsAsMessageable.rails_api.new(self).attr_accessible(
-      :topic, :body, :opened, :recipient_permanent_delete,
+      :topic, :body, :opened, :opened_at, :recipient_permanent_delete,
       :recipient_delete, :sender_permanent_delete, :sender_delete
     )
     ActsAsMessageable.rails_api.new(self).default_scope('created_at desc')
@@ -22,14 +22,20 @@ def open?
       opened?
     end
 
+    def opened?
+      opened_at.present? || super
+    end
+
     def open
+      update_attributes!(opened_at: DateTime.now)
       update_attributes!(opened: true)
     end
 
     alias mark_as_read open
     alias read open
 
     def close
+      update_attributes!(opened_at: nil)
       update_attributes!(opened: false)
     end
 

lib/acts_as_messageable/scopes.rb

@@ -37,8 +37,8 @@ def initialize_scopes
                 r_perm_delete: false,
                 s_perm_delete: false)
         }
-        scope :readed, -> { where(opened: true) }
-        scope :unreaded, -> { where(opened: false) }
+        scope :readed, -> { where('opened_at is not null OR opened = ?', true) }
+        scope :unreaded, -> { where('opened_at is null OR opened = ?', false) }
         scope :deleted, -> { where(recipient_delete: true, sender_delete: true) }
       end
     end

lib/generators/acts_as_messageable/migration/migration_generator.rb

@@ -18,15 +18,18 @@ def self.next_migration_number(dirname)
 
     def create_migration_file
       begin
-        migration_template('migration.rb', 'db/migrate/create_messages_table.rb')
+        migration_template 'migration.rb', 'db/migrate/create_messages_table.rb'
       rescue StandardError
         nil
       end
       begin
-        migration_template(
-          'migration_permanent.rb',
-          'db/migrate/add_recipient_permanent_delete_and_sender_permanent_delete_to_messages.rb'
-        )
+        migration_template 'migration_permanent.rb',
+                           'db/migrate/add_recipient_permanent_delete_and_sender_permanent_delete_to_messages.rb'
+      rescue StandardError
+        nil
+      end
+      begin
+        migration_template 'migration_opened_as_datetime.rb', 'db/migrate/add_opened_at_to_messages.rb'
       rescue StandardError
         nil
       end

lib/generators/acts_as_messageable/migration/templates/migration_opened_as_datetime.rb

@@ -0,0 +1,11 @@
+class AddOpenedAtToMessages < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name %>, :opened_at, :datetime
+    <%= table_name.classify %>.where(opened:true).update_all(opened_at: DateTime.now)
+  end
+
+  def self.down
+    <%= table_name.classify %>.where.not(opened_at:nil).update_all(opened: true)
+    remove_column :<%= table_name %>, :opened_at
+  end
+end

spec/acts_as_messageable_spec.rb

@@ -180,6 +180,15 @@
       expect(@alice.messages.are_from(@bob).unreaded.count).to eq(1)
     end
 
+    it 'alice should see the read_at updated' do
+      date_time_when_read = Time.new(2014, 9, 4, 15, 12, 34)
+      Timecop.freeze(date_time_when_read) do
+        @alice.messages.are_from(@bob).first.read
+        first_message = @alice.messages.are_from(@bob).first
+        expect(first_message.opened_at).to eql(date_time_when_read)
+      end
+    end
+
     it 'alice should able to get datetime when he read bob message' do
       @alice.messages.are_from(@bob).first.read
       read_datetime = @alice.messages.are_from(@bob).first.updated_at
@@ -271,6 +280,10 @@
     expect(@bob.sent_messages.loaded?).to be_falsey
   end
 
+  it 'sent_messages should return unloaded messages' do
+    expect(@bob.sent_messages.loaded?).to be_falsey
+  end
+
   describe 'send messages between two different models (the same id)' do
     it 'should have the same id' do
       expect(@alice.id).to be_equal(@admin.id)

spec/spec_helper.rb

@@ -10,6 +10,8 @@
 require 'coveralls'
 Coveralls.wear!
 
+require 'timecop'
+
 require 'bundler/setup'
 Bundler.require(:default)
 

spec/support/table_schema.rb

@@ -10,6 +10,7 @@
   t.boolean :sender_delete, default: false
   t.boolean :recipient_permanent_delete, default: false
   t.boolean :sender_permanent_delete, default: false
+  t.datetime :opened_at, :datetime
   t.string :ancestry
   t.timestamps
 end