acts-as-messageable 0.4.11 → 1.0.0

data/spec/{acts-as-messageable_spec.rb → acts_as_messageable_spec.rb}

@@ -1,3 +1,6 @@
+# typed: ignore
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'ActsAsMessageable' do
@@ -70,14 +73,14 @@ describe 'ActsAsMessageable' do
     end
 
     it 'alice should be able to reply to a message from bob to alice' do
-      @reply_message =  @alice.reply_to(@message, 'Re: Topic', 'Body')
+      @reply_message = @alice.reply_to(@message, 'Re: Topic', 'Body')
       expect(@reply_message).not_to be_nil
       expect(@bob.messages.are_from(@alice).count).to eq(1)
       expect(@alice.sent_messages.are_to(@bob).count).to eq(1)
     end
 
     it 'alice should be able to reply to a message using the message object' do
-      @reply_message =  @message.reply('Re: Topic', 'Body')
+      @reply_message = @message.reply('Re: Topic', 'Body')
       expect(@reply_message).not_to be_nil
       expect(@bob.messages.are_from(@alice).count).to eq(1)
       expect(@alice.sent_messages.are_to(@bob).count).to eq(1)
@@ -85,13 +88,13 @@ describe 'ActsAsMessageable' do
 
     it 'bob try to add something to conversation' do
       @reply_message = @bob.reply_to(@message, 'Oh, I Forget', '1+1=2')
-      expect(@reply_message.from).to  eq(@message.from)
-      expect(@reply_message.to).to    eq(@message.to)
+      expect(@reply_message.from).to eq(@message.from)
+      expect(@reply_message.to).to eq(@message.to)
     end
 
     it 'bob try to add something to conversation and should receive proper order' do
       @reply_message = @bob.reply_to(@message, 'Oh, I Forget', '1+1=2')
-      @sec_message   = @alice.reply_to(@message, 'Yeah, right', '1+1=3!')
+      @sec_message = @alice.reply_to(@message, 'Yeah, right', '1+1=3!')
 
       expect(@message.conversation).to eq([@sec_message, @reply_message, @message])
     end
@@ -148,6 +151,12 @@ describe 'ActsAsMessageable' do
       expect(@alice.received_messages.count).to eq(1)
     end
 
+    it 'bob should be able to restore message' do
+      @bob.sent_messages.process(&:delete)
+      @bob.restore_message(@message.reload)
+      expect(@bob.sent_messages.count).to eq(1)
+    end
+
     it 'should works with relation' do
       @alice.received_messages.process(&:delete)
       expect(@alice.received_messages.count).to eq(0)
@@ -164,6 +173,7 @@ describe 'ActsAsMessageable' do
     it 'alice should have one unread message from bob' do
       expect(@alice.messages.are_from(@bob).unreaded.count).to eq(1)
       expect(@alice.messages.are_from(@bob).readed.count).to eq(0)
+      expect(@alice.messages.are_from(@bob).readed.all?(&:open?)).to be_truthy
     end
 
     it 'alice should able to read message from bob' do
@@ -177,11 +187,33 @@ describe 'ActsAsMessageable' do
       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
       expect(@alice.messages.are_from(@bob).reorder('updated_at asc').first.updated_at).to eq(read_datetime)
     end
+
+    describe '#open?' do
+      let(:message) { @alice.messages.are_from(@bob).first }
+
+      it 'returns false for closed message' do
+        expect(message.open?).to be_falsey
+      end
+
+      it 'returns true for open message' do
+        message.read
+        expect(message.open?).to be_truthy
+      end
+    end
   end
 
   it 'finds proper message' do
@@ -268,6 +300,10 @@ describe 'ActsAsMessageable' do
     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)
@@ -285,4 +321,43 @@ describe 'ActsAsMessageable' do
       expect(@bob.messages.are_from(@alice).size).to be_equal(0)
     end
   end
+
+  describe 'mass assigment', rails: 4 do
+    it 'allows to mass assign topic and body attributes' do
+      @message = send_message(@bob, @alice, 'Example', 'Example Body')
+      @message.update_attributes!(topic: 'Changed topic', body: 'Changed body')
+
+      expect(@message.topic).to eq('Changed topic')
+      expect(@message.body).to eq('Changed body')
+    end
+  end
+
+  describe 'ancestry initialization' do # GH#78
+    let(:message) { ActsAsMessageable::Message.create!(topic: 'topic', body: 'body') }
+
+    before do
+      # Use clean version of Message class we used here remove_const before
+      # but it doesn't work with sorbet so we use this hack to clear side effects
+      ActsAsMessageable::Message.table_name = 'messages'
+      ActsAsMessageable::Message.required = []
+      ActsAsMessageable::Message.clear_validators! if ActsAsMessageable::Message.respond_to?(:clear_validators!)
+    end
+
+    it 'returns root of the conversation' do
+      expect(message.conversation).to include(message)
+    end
+  end
+
+  describe 'user primary key is uuid type', rails: [5, 6, 7] do # GH#107
+    let(:bob) { UuidUser.create(id: SecureRandom.uuid, email: 'bob@example.com') }
+    let(:alice) { UuidUser.create(id: SecureRandom.uuid, email: 'alice@example.com') }
+
+    before do
+      bob.send_message(alice, 'Subject', 'Body')
+    end
+
+    it 'returns messages for alice' do
+      expect(alice.messages).not_to be_empty
+    end
+  end
 end

data/spec/{custom-class_spec.rb → custom_class_spec.rb}

@@ -1,12 +1,12 @@
-require 'spec_helper'
+# typed: ignore
+# frozen_string_literal: true
 
-class CustomMessage < ActsAsMessageable::Message
-  def custom_method; end
-end
+require 'spec_helper'
 
 describe 'custom class' do
   let(:alice) { User.find_by_email('alice@example.com') }
-  let(:bob)   { User.find_by_email('bob@example.com') }
+  let(:bob) { User.find_by_email('bob@example.com') }
+  let(:custom_user) { CustomSearchUser.find_by_email('custom@example.com') }
 
   before do
     User.acts_as_messageable class_name: 'CustomMessage', table_name: 'custom_messages'
@@ -36,4 +36,14 @@ describe 'custom class' do
     expect(@reply_message.root).to eq(@message)
     expect(@reply_message.root.class).to eq(CustomMessage)
   end
+
+  context 'with custom search scope' do
+    before do
+      send_message(custom_user, bob, 'Test subject', 'Test body')
+    end
+
+    it 'will use custom search scope' do
+      expect(custom_user.messages.custom_search('Test body').count).to eq(1)
+    end
+  end
 end

data/spec/{custom-required_spec.rb → custom_required_spec.rb}

@@ -1,10 +1,16 @@
+# typed: ignore
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'custom require' do
-  before(:each) do
-    # Use clean version of Message class
-    ActsAsMessageable.instance_eval { remove_const 'Message' }
-    load 'acts-as-messageable/message.rb'
+  before do
+    # Use clean version of Message class we used here remove_const before
+    # but it doesn't work with sorbet so we use this hack to clear side effects
+    ActsAsMessageable::Message.table_name = 'messages'
+    ActsAsMessageable::Message.required = []
+    ActsAsMessageable::Message.clear_validators! if ActsAsMessageable::Message.respond_to?(:clear_validators!)
+    ActsAsMessageable::Message.reset_callbacks(:validate)
   end
 
   it 'should work with non-array require' do

data/spec/{group-messages_spec.rb → group_messages_spec.rb}

@@ -1,9 +1,12 @@
+# typed: ignore
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'group messages' do
   let(:alice) { User.find_by_email('alice@example.com') }
-  let(:bob)   { User.find_by_email('bob@example.com') }
-  let(:pat)   { User.find_by_email('pat@example.com') }
+  let(:bob) { User.find_by_email('bob@example.com') }
+  let(:pat) { User.find_by_email('pat@example.com') }
 
   before do
     User.acts_as_messageable group_messages: true

data/spec/migrations_spec.rb

@@ -0,0 +1,76 @@
+# typed: ignore
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+def create_dummy_app
+  system <<-COMMAND
+    bundle exec rails new dummy --skip-test-unit --skip-spring --skip-webpack-install --skip-bootsnap \
+    --skip-active-storage --skip-active-job --skip-action-cable --skip-javascript --skip-action-mailer -d sqlite3
+  COMMAND
+end
+
+def add_gem_to_gemfile
+  run_in_app("echo gem \"'acts-as-messageable', path: '../'\" >> Gemfile; bundle")
+end
+
+def run_bundler
+  run_in_app('bundle update')
+end
+
+def run_generators(option = '')
+  run_in_app("bundle exec rails g acts_as_messageable:migration #{option}")
+end
+
+def run_migrations
+  run_in_app('bundle exec rake db:migrate')
+end
+
+def rollback_migrations
+  run_in_app('bundle exec rake db:migrate VERSION=0')
+end
+
+def run_in_app(command)
+  Bundler.clean_system("cd dummy; BUNDLE_GEMFILE=./Gemfile #{command}")
+end
+
+def remove_dummy_app
+  system 'rm -rf dummy'
+end
+
+def skip_generators?
+  ENV.fetch('RUN_GENERATORS', 'false') == 'false'
+end
+
+describe 'migration' do
+  before do
+    create_dummy_app
+    add_gem_to_gemfile
+    run_bundler
+  end
+
+  after do
+    remove_dummy_app
+  end
+
+  it 'runs migrations and revert them', skip: skip_generators? do
+    run_generators
+
+    expect(run_migrations).to be_truthy
+    expect(rollback_migrations).to be_truthy
+  end
+
+  it 'runs migrations and revert them with uuid option', skip: skip_generators? do
+    run_generators('--uuid')
+
+    expect(run_migrations).to be_truthy
+    expect(rollback_migrations).to be_truthy
+  end
+
+  it 'runs migrations and revert them with uuid option and custom table', skip: skip_generators? do
+    run_generators('my_messages --uuid')
+
+    expect(run_migrations).to be_truthy
+    expect(rollback_migrations).to be_truthy
+  end
+end

data/spec/spec_helper.rb

@@ -1,32 +1,43 @@
+# typed: ignore
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+T::Configuration.default_checked_level = :tests
+T::Configuration.enable_checking_for_sigs_marked_checked_tests
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'active_record/railtie'
-ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger = Logger.new($stderr)
 ActiveRecord::Base.logger.level = 3
 
 require 'coveralls'
 Coveralls.wear!
 
+require 'timecop'
+
 require 'bundler/setup'
 Bundler.require(:default)
 
+require 'pry'
 require 'acts-as-messageable'
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
 
 ActiveRecord::Migration.verbose = false
 
 RSpec.configure do |config|
   config.before(:all) do
-    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+    establish_connection
     create_database
 
-    @alice = User.create  email: 'alice@example.com'
-    @bob   = User.create  email: 'bob@example.com'
-    @pat   = User.create  email: 'pat@example.com'
+    @alice = User.create email: 'alice@example.com'
+    @bob = User.create email: 'bob@example.com'
+    @pat = User.create email: 'pat@example.com'
     @admin = Admin.create email: 'admin@example.com'
-    @men   = Men.create   email: 'men@example.com'
+    @men = Men.create email: 'men@example.com'
+    @custom_search_user = CustomSearchUser.create email: 'custom@example.com'
   end
 
   config.after(:all) do
@@ -36,44 +47,36 @@ RSpec.configure do |config|
   config.after(:each) do
     User.messages_class_name.destroy_all
   end
+
+  config.around(:each) do |example|
+    supported_rails = Array.wrap(example.metadata[:rails]).presence || [3, 4, 5, 6, 7]
+
+    example.run if supported_rails.include?(Rails::VERSION::MAJOR)
+  end
+end
+
+def establish_connection
+  ActiveRecord::Base.establish_connection(
+    adapter: ENV.fetch('DATABASE_ADAPTER', 'sqlite3'),
+    database: ENV.fetch('DATABASE_NAME', ':memory:'),
+    password: ENV.fetch('DATABASE_PASSWORD', 'password'),
+    host: 'localhost',
+    user: 'postgres'
+  )
 end
 
 def create_database
   ActiveRecord::Schema.define(version: 1) do
-    create_table :messages do |t|
-      t.string :topic
-      t.text :body
-      t.references :received_messageable, polymorphic: true, index: false
-      t.references :sent_messageable, polymorphic: true, index: false
-      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 :custom_messages do |t|
-      t.string :topic
-      t.text :body
-      t.references :received_messageable, polymorphic: true, index: false
-      t.references :sent_messageable, polymorphic: true, index: false
-      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|
-      t.string :email
-    end
-
-    create_table :admins do |t|
-      t.string :email
-    end
+    enable_extension 'pgcrypto' if ENV.fetch('DATABASE_ADAPTER', '') == 'postgresql' && !extension_enabled?('pgcrypto')
+
+    create_table(:messages, &TABLE_SCHEMA)
+    create_table(:custom_messages, &TABLE_SCHEMA)
+    create_table(:custom_messages_uuid, &TABLE_SCHEMA_UUID)
+
+    create_table(:users, &USER_SCHEMA)
+    create_table(:admins, &USER_SCHEMA)
+    create_table(:custom_search_users, &USER_SCHEMA)
+    create_table(:uuid_users, id: :uuid, &USER_SCHEMA)
   end
 end
 

data/spec/support/admin.rb

@@ -1,3 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
 class Admin < ActiveRecord::Base
+  extend ActsAsMessageable::Model::ClassMethods
+
   acts_as_messageable
 end

data/spec/support/custom_message.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+class CustomMessage < ActsAsMessageable::Message
+  extend T::Sig
+  sig { void }
+  def custom_method; end
+end

data/spec/support/custom_message_uuid.rb

@@ -0,0 +1,6 @@
+# typed: strict
+# frozen_string_literal: true
+
+class CustomMessageUUID < ActsAsMessageable::Message
+  self.table_name = :custom_messages_uuid
+end

data/spec/support/custom_search_user.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+class CustomSearchUser < ActiveRecord::Base
+  extend ActsAsMessageable::Model::ClassMethods
+
+  acts_as_messageable search_scope: :custom_search, class_name: 'CustomMessage'
+end

data/spec/support/men.rb

@@ -0,0 +1,7 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative './user'
+
+class Men < User
+end

data/spec/support/send_message.rb

@@ -1,3 +1,12 @@
-def send_message(from = @bob, to = @alice, topic = 'Topic', body = 'Body')
+# typed: true
+# frozen_string_literal: true
+
+extend T::Sig
+
+sig do
+  params(from: ActiveRecord::Base, to: ActiveRecord::Base, topic: String,
+         body: String).returns(ActsAsMessageable::Message)
+end
+def send_message(from = T.unsafe(@bob), to = T.unsafe(@alice), topic = 'Topic', body = 'Body')
   from.send_message(to, topic, body)
 end

data/spec/support/table_schema.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+TABLE_SCHEMA = T.let(lambda do |t|
+  t.string :topic
+  t.text :body
+  t.references :received_messageable, polymorphic: true, index: false
+  t.references :sent_messageable, polymorphic: true, index: false
+  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.datetime :opened_at, :datetime
+  t.string :ancestry
+  t.timestamps
+end, T.untyped)
+
+TABLE_SCHEMA_UUID = T.let(lambda do |t|
+  t.string :topic
+  t.text :body
+  t.references :received_messageable, polymorphic: true, index: false, type: :uuid
+  t.references :sent_messageable, polymorphic: true, index: false, type: :uuid
+  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.datetime :opened_at, :datetime
+  t.string :ancestry
+  t.timestamps
+end, T.untyped)
+
+USER_SCHEMA = T.let(lambda do |t|
+  t.string :email
+end, T.untyped)

data/spec/support/user.rb

@@ -1,6 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
 class User < ActiveRecord::Base
-  acts_as_messageable
-end
+  extend ActsAsMessageable::Model::ClassMethods
 
-class Men < User
+  acts_as_messageable
 end

data/spec/support/uuid_user.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+class UuidUser < ActiveRecord::Base
+  extend ActsAsMessageable::Model::ClassMethods
+
+  acts_as_messageable class_name: 'CustomMessageUUID', table_name: 'custom_messages_uuid'
+  self.table_name = :uuid_users
+end

data/tasks/types.rake

@@ -0,0 +1,46 @@
+# typed: ignore
+# frozen_string_literal: true
+
+def generate_type(model, model_name, file_name)
+  establish_connection
+  create_database
+
+  formatter = SorbetRails::ModelRbiFormatter.new(model, Set.new([model_name]))
+  file_path = File.expand_path("../sorbet/rbi/models/acts-as-messageable/#{file_name}.rbi", __dir__)
+  FileUtils.mkdir_p(File.dirname(file_path))
+  File.write(file_path, formatter.generate_rbi)
+
+  drop_database
+end
+
+def generate_types_for_active_record_runtime
+  establish_connection
+  create_database
+
+  dir_path = File.expand_path('../sorbet/rbi/rails-rbi/', __dir__)
+  FileUtils.mkdir_p(dir_path)
+
+  formatter = SorbetRails::ActiveRecordRbiFormatter.new
+
+  file_path = File.expand_path('../sorbet/rbi/rails-rbi/active_record_base.rbi', __dir__)
+  File.write(file_path, formatter.generate_active_record_base_rbi)
+
+  file_path = File.expand_path('../sorbet/rbi/rails-rbi/active_record_relation.rbi', __dir__)
+  File.write(file_path, formatter.generate_active_record_relation_rbi)
+
+  drop_database
+end
+
+desc 'Generate types for model'
+task :generate_rbi_for_model do
+  require_relative '../spec/spec_helper'
+  require 'active_support/core_ext/string'
+  require 'sorbet-rails'
+  require 'sorbet-rails/active_record_rbi_formatter'
+
+  SorbetRails.configure {} # rubocop:disable Lint/EmptyBlock
+
+  generate_type(ActsAsMessageable::Message, 'ActsAsMessageable::Message', 'message')
+  generate_type(CustomSearchUser, 'CustomSearchUser', 'user')
+  generate_types_for_active_record_runtime
+end