message_train 0.1.0

data/spec/factories/group.rb

@@ -0,0 +1,20 @@
+FactoryGirl.define do
+  factory :group do
+    title { Faker::Lorem.sentence }
+    description { Faker::Lorem.paragraphs([*1..5].sample).join("\n\n") }
+    transient do
+      owner { User.order("RANDOM()").first }
+      member_count 5
+    end
+    # the after(:create) yields two values; the user instance itself and the
+    # evaluator, which stores all values from the factory, including transient
+    # attributes; `create_list`'s second argument is the number of records
+    # to create and we make sure the user is associated properly to the post
+    after(:create) do |group, evaluator|
+      evaluator.owner.add_role(:owner, group)
+      User.where('id != ?', evaluator.owner.id).order("RANDOM()").limit(evaluator.member_count).find_each do |user|
+        user.add_role(:member, group)
+      end
+    end
+  end
+end

data/spec/factories/message.rb

@@ -0,0 +1,68 @@
+FactoryGirl.define do
+  factory :message, class: 'MessageTrain::Message' do
+    sender {
+      User
+         .order('RANDOM()')
+         .first
+    }
+    recipients_to_save { { 'users' =>
+       User
+         .where('id != ?', sender.id)
+         .order('RANDOM()')
+         .limit([*1..5].sample)
+         .collect { |x| x.slug }
+         .join(', ')
+    } }
+    subject { Faker::Lorem.sentence }
+    body { Faker::Lorem.paragraphs([*1..5].sample).join("\n\n") }
+    transient do
+      generate_attachment? { [*1..100].sample >= 80 }
+      generate_response? { [*1..100].sample >= 50 }
+      generate_ignore? { [*1..100].sample >= 80 }
+    end
+
+    # the after(:create) yields two values; the user instance itself and the
+    # evaluator, which stores all values from the factory, including transient
+    # attributes; `create_list`'s second argument is the number of records
+    # to create and we make sure the user is associated properly to the post
+    after(:create) do |message, evaluator|
+      if evaluator.generate_attachment?
+        FactoryGirl.create(:attachment, message: message)
+      end
+      if message.recipients_to_save['users'].present?
+        participants = (message.recipients_to_save['users'].split(',') + [message.sender.slug]).collect{ |x| x.strip }
+        if evaluator.generate_ignore?
+          ignorer = User.friendly.find(participants.sample)
+          participants = participants - [ignorer.slug]
+          message.conversation.set_ignored(ignorer)
+        end
+        if evaluator.generate_response? && participants.count > 1
+          response_sender = User.friendly.find(participants.sample)
+          response_recipients = participants - [response_sender.slug]
+          FactoryGirl.create(
+            :message,
+            sender: response_sender,
+            recipients_to_save: { 'users' => response_recipients.join(', ') },
+            conversation: message.conversation
+          )
+        end
+      end
+    end
+
+    factory :message_from_random_sender do
+      sender {
+        recipient_user_ids = recipients_to_save['users'].split(',').collect{ |x| User.friendly.find(x.strip).id }
+        User
+          .where('NOT (id IN (?))', recipient_user_ids )
+          .order('RANDOM()')
+          .first
+      }
+    end
+
+    factory :simple_message do
+      generate_ignore? false
+      generate_response? false
+      generate_attachment? false
+    end
+  end
+end

data/spec/factories/user.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :user do
+    display_name { Faker::Name.name }
+    email { "#{display_name.gsub(' ', '.').downcase}.#{rand(1000).to_s}@example.com" }
+    password "password"
+    password_confirmation "password"
+  end
+end

data/spec/features/boxes_spec.rb

@@ -0,0 +1,50 @@
+require 'rails_helper'
+RSpec.feature 'Boxes' do
+  include_context 'loaded site'
+
+  before do
+    login_as first_user
+  end
+  describe 'Showing' do
+    describe 'at /box/in' do
+      before do
+        visit '/box/in'
+      end
+      it_behaves_like 'a bootstrap page listing a collection of items', MessageTrain::Conversation, plural_title: 'Inbox', minimum: 2
+    end
+  end
+  describe 'Marking', js: true do
+    describe 'at /box/in' do
+      describe 'without checking anything' do
+        before do
+          visit '/box/in'
+          click_button 'Mark'
+          click_link 'mark-read'
+        end
+        it_behaves_like 'a bootstrap page with an alert', 'warning', 'Nothing to do'
+      end
+      describe 'after checking a box' do
+        describe 'Marking Read' do
+          before do
+            visit '/box/in'
+            click_link 'Last'
+            check "objects_conversations_#{unread_conversation.id.to_s}"
+            click_button 'Mark'
+            click_link 'mark-read'
+          end
+          it_behaves_like 'a bootstrap page with an alert', 'info', 'Update successful'
+        end
+        describe 'Marking Ignored' do
+          before do
+            visit '/box/in'
+            click_link 'Last'
+            check "objects_conversations_#{unread_conversation.id.to_s}"
+            click_button 'Mark'
+            click_link 'mark-ignored'
+          end
+          it_behaves_like 'a bootstrap page with an alert', 'info', 'Update successful'
+        end
+      end
+    end
+  end
+end

data/spec/features/conversations_spec.rb

@@ -0,0 +1,36 @@
+require 'rails_helper'
+RSpec.feature 'Conversations' do
+  include_context 'loaded site'
+
+  before do
+    login_as first_user
+  end
+  describe 'Showing' do
+    describe 'at /box/in/conversations/:id' do
+      before do
+        visit '/box/in/conversations/'+unread_conversation.id.to_s
+      end
+      it_behaves_like 'a bootstrap page showing an item', MessageTrain::Conversation, 'Unread Conversation'
+    end
+  end
+  describe 'Marking', js: true do
+    describe 'at /box/in/conversations/:id' do
+      describe 'Marking Read' do
+        before do
+          visit '/box/in/conversations/'+unread_conversation.id.to_s
+          click_link "mark_read_#{unread_conversation.messages.first.id.to_s}"
+        end
+        it_behaves_like 'a bootstrap page with an alert', 'info', 'Update successful'
+      end
+      describe 'Marking Ignored' do
+        before do
+          visit '/box/in/conversations/'+unread_conversation.id.to_s
+          accept_confirm do
+            click_link 'Mark as Ignored'
+          end
+        end
+        it_behaves_like 'a bootstrap page with an alert', 'info', 'Update successful'
+      end
+    end
+  end
+end

data/spec/features/messages_spec.rb

@@ -0,0 +1,53 @@
+require 'rails_helper'
+RSpec.feature 'Messages' do
+  include_context 'loaded site'
+
+  before do
+    login_as first_user
+  end
+  describe 'Drafting', js: true do
+    describe 'at /box/in/messages' do
+      before do
+        visit '/box/in/messages/new/'
+        recipient_input = find(:css, "#message_recipients_to_save_users .tags-input")
+        recipient_input.set("")
+        fill_in 'Subject', with: 'This is a draft.'
+        fill_in 'Body', with: 'This is the body.'
+        click_button 'Send'
+      end
+      it_behaves_like 'a bootstrap page with an alert', 'warning', 'Message saved as draft.'
+    end
+  end
+  describe 'Composing', js: true do
+    describe 'at /box/in/messages' do
+      before do
+        visit '/box/in/messages/new/'
+        recipient_input = find(:css, "#message_recipients_to_save_users .tags-input")
+        recipient_input.set("sec")
+        recipient_input.native.send_keys :arrow_down
+        recipient_input.native.send_keys :return
+        fill_in 'Subject', with: 'This is the subject.'
+        fill_in 'Body', with: 'This is the body.'
+        click_button 'Send'
+      end
+      it_behaves_like 'a bootstrap page with an alert', 'info', 'Message sent.'
+    end
+  end
+  describe 'Editing a Draft', js: true do
+    describe 'at /box/in/messages' do
+      before do
+        visit "/box/in/conversations/#{draft_conversation.id}"
+        recipient_input = find(:css, "#message_recipients_to_save_users .tags-input")
+        recipient_input.set("sec")
+        recipient_input.native.send_keys :arrow_down
+        recipient_input.native.send_keys :return
+        fill_in 'Subject', with: 'This is the subject.'
+        fill_in 'Body', with: 'This is the body.'
+        find(:css, "#message_draft").set(false)
+        click_button 'Send'
+      end
+      it_behaves_like 'a bootstrap page with an alert', 'info', 'Message sent.'
+      it_behaves_like 'a bootstrap page without an alert', 'warning'
+    end
+  end
+end

data/spec/helpers/message_train/boxes_helper_spec.rb

@@ -0,0 +1,44 @@
+require 'rails_helper'
+
+describe MessageTrain::BoxesHelper do
+  include_context 'loaded site'
+  include ControllerMacros
+
+  before do
+    login_user first_user
+  end
+  context '#box_nav_item' do
+    subject { helper.box_nav_item(first_user.box(:in)) }
+    it { should have_tag 'li', text: /Inbox/ }
+    it { should have_tag 'span', text: /[0-9]+/, with: { class: 'badge' } }
+  end
+
+  context '#box_list_item' do
+    subject { helper.box_list_item(first_user.box(:in), class: 'foo') }
+    it { should have_tag 'li', text: /Inbox/, with: { class: 'foo' } }
+    it { should have_tag 'span', text: /[0-9]+/, with: { class: 'badge' } }
+  end
+
+  context '#boxes_widget' do
+    subject { helper.boxes_widget }
+    it { should have_tag 'h3', text: /Messages/ }
+    it { should have_tag 'ul', with: { class: 'list-group' } }
+    it { should have_tag 'li', with: { class: 'list-group-item' }, count: 6 }
+  end
+
+  context '#boxes_dropdown_list' do
+    subject { helper.boxes_dropdown_list }
+    it { should have_tag 'ul', with: { class: 'dropdown-menu' } }
+    it { should have_tag 'li', minimum: 5 }
+  end
+
+  context '#box_participant_slug' do
+    subject { helper.box_participant_slug(first_user) }
+    it { should eq 'first-user' }
+  end
+
+  context '#box_participant_name' do
+    subject { helper.box_participant_name(first_user) }
+    it { should eq 'First User' }
+  end
+end

data/spec/message_train_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "MessageTrain" do
+  it 'should return correct version string' do
+    MessageTrain.version_string.should == "MessageTrain version #{MessageTrain::VERSION}"
+  end
+end

data/spec/models/group_spec.rb

@@ -0,0 +1,23 @@
+require 'rails_helper'
+
+RSpec.describe Group do
+  describe 'Model' do
+    # MessageTrain Gem, and Rolify Gem by extension
+    it { should have_many(:roles) }
+    
+    # MessageTrain Gem
+    it { should have_many(:receipts) }
+  end
+
+  describe 'Scopes and Methods from Message Train' do
+    include_context 'loaded site'
+
+    describe '#conversations' do
+      subject { first_group.conversations(:in) }
+      its(:first) { should be_a MessageTrain::Conversation }
+      its(:count) { should eq 1 }
+    end
+
+  end
+
+end

data/spec/models/message_train/attachment_spec.rb

@@ -0,0 +1,12 @@
+require 'rails_helper'
+
+module MessageTrain
+  RSpec.describe Attachment do
+    describe 'Model' do
+      it { should belong_to :message }
+    end
+    describe 'Scopes and Methods' do
+
+    end
+  end
+end

data/spec/models/message_train/box_spec.rb

@@ -0,0 +1,195 @@
+require 'rails_helper'
+
+module MessageTrain
+  RSpec.describe Box do
+    describe 'Model' do
+
+    end
+    describe 'Scopes and Methods' do
+      include_context 'loaded site'
+
+      describe '#unread_count' do
+        subject { first_user.box.unread_count }
+        it { should be >= 2 }
+      end
+      describe '#conversations' do
+        context 'with division as :in' do
+          subject { first_user.box.conversations }
+          it { should_not include sent_conversation }
+          it { should include unread_conversation }
+          it { should include read_conversation }
+          it { should_not include ignored_conversation }
+          it { should_not include trashed_conversation }
+          it { should_not include deleted_conversation }
+          it { should_not include draft_conversation }
+        end
+        context 'with division as :sent' do
+          subject { first_user.box(:sent).conversations }
+          it { should include sent_conversation }
+          it { should_not include unread_conversation }
+          it { should_not include read_conversation }
+          it { should_not include ignored_conversation }
+          it { should_not include trashed_conversation }
+          it { should_not include deleted_conversation }
+          it { should_not include draft_conversation }
+        end
+        context 'with division as :trash' do
+          subject { first_user.box(:trash).conversations }
+          it { should_not include sent_conversation }
+          it { should_not include unread_conversation }
+          it { should_not include read_conversation }
+          it { should_not include ignored_conversation }
+          it { should include trashed_conversation }
+          it { should_not include deleted_conversation }
+          it { should_not include draft_conversation }
+        end
+        context 'with division as :drafts' do
+          subject { first_user.box(:drafts).conversations }
+          it { should_not include sent_conversation }
+          it { should_not include trashed_conversation }
+          it { should_not include read_conversation }
+          it { should_not include unread_conversation }
+          it { should_not include deleted_conversation }
+          it { should_not include ignored_conversation }
+          it { should include draft_conversation }
+        end
+        context 'with unread set to true' do
+          subject { first_user.box.conversations(unread: true) }
+          it { should_not include sent_conversation }
+          it { should include unread_conversation }
+          it { should_not include read_conversation }
+          it { should_not include ignored_conversation }
+          it { should_not include trashed_conversation }
+          it { should_not include deleted_conversation }
+          it { should_not include draft_conversation }
+        end
+      end
+      describe '#ignore' do
+        context 'when authorized' do
+          before do
+            first_user.box.ignore(read_conversation)
+          end
+          subject { read_conversation.is_ignored?(first_user) }
+          it { should be true}
+        end
+        context 'when not authorized' do
+          before do
+            last_user.box.ignore(read_conversation)
+          end
+          subject { last_user.box.errors.all.first[:message] }
+          it { should match /Access to Conversation ([0-9]+) denied/ }
+        end
+      end
+      describe '#unignore' do
+        context 'when authorized' do
+          before do
+            first_user.box.unignore(ignored_conversation)
+          end
+          subject { ignored_conversation.is_ignored?(first_user) }
+          it { should be false }
+        end
+        context 'when not authorized' do
+          before do
+            last_user.box.unignore(read_conversation)
+          end
+          subject { last_user.box.errors.all.first[:message] }
+          it { should match /Access to Conversation ([0-9]+) denied/ }
+        end
+      end
+      describe '#title' do
+        context 'with division set to :in' do
+          subject { first_user.box.title }
+          it { should eq 'Inbox' }
+        end
+        context 'with division set to :sent' do
+          subject { first_user.box(:sent).title }
+          it { should eq 'Sent Messages' }
+        end
+        context 'with division set to :all' do
+          subject { first_user.box(:all).title }
+          it { should eq 'All Messages' }
+        end
+        context 'with division set to :drafts' do
+          subject { first_user.box(:drafts).title }
+          it { should eq 'Drafts' }
+        end
+        context 'with division set to :trash' do
+          subject { first_user.box(:trash).title }
+          it { should eq 'Trash' }
+        end
+      end
+      describe '#mark' do
+        before do
+          first_user.box.mark('unread', conversations: [read_conversation.id.to_s])
+        end
+        subject { read_conversation.includes_read_for?(first_user) }
+        it { should be false }
+      end
+      describe '.send_message' do
+        context 'when message is valid' do
+          let(:valid_attributes) { { recipients_to_save: {'users' => 'second-user, third-user'}, subject: 'Test Message', body: 'This is the content.' } }
+          subject { first_user.box.send_message(valid_attributes) }
+          it { should be_a MessageTrain::Message }
+          its(:new_record?) { should be false }
+          its('errors.full_messages.to_sentence') { should eq '' }
+          its(:recipients) { should include second_user }
+          its(:recipients) { should include third_user }
+          its(:draft) { should be false }
+        end
+        context 'when message is invalid' do
+          let(:invalid_attributes) { { recipients_to_save: {'users' => 'second-user, third-user'}, subject: nil, body: 'This is the content.' } }
+          subject { first_user.box.send_message(invalid_attributes) }
+          it { should be_a_new MessageTrain::Message }
+          its('errors.full_messages.to_sentence') { should eq "Subject can't be blank" }
+          its(:recipients) { should be_empty }
+        end
+      end
+      describe '.update_message' do
+        let(:draft_message) { draft_conversation.messages.first }
+        context 'when message is valid' do
+          let(:valid_attributes) { {
+              recipients_to_save: {'users' => 'second-user, third-user'},
+              subject: 'Test Message',
+              body: 'This is the content.',
+              draft: false
+          } }
+          subject { first_user.box.update_message(draft_message, valid_attributes) }
+          it { should be_a MessageTrain::Message }
+          its('errors.full_messages.to_sentence') { should eq '' }
+          its(:recipients) { should include second_user }
+          its(:recipients) { should include third_user }
+          its(:subject) { should eq 'Test Message' }
+          its(:draft) { should be false }
+        end
+        context 'when message is invalid' do
+          let(:invalid_attributes) { {
+              recipients_to_save: {'users' => 'second-user, third-user'},
+              subject: '',
+              body: 'This is the content.',
+              draft: false
+          } }
+          subject { first_user.box.update_message(draft_message, invalid_attributes) }
+          it { should be_a MessageTrain::Message }
+          its('errors.full_messages.to_sentence') { should eq "Subject can't be blank" }
+          its(:recipients) { should be_empty }
+        end
+      end
+
+      describe '.new_message' do
+        context 'when conversation is set' do
+          let(:expected_recipients) { { 'users' => 'second-user' } }
+          subject { first_user.box.new_message(conversation_id: unread_conversation.id) }
+          it { should be_a_new MessageTrain::Message }
+          its(:subject) { should eq 'Re: Unread Conversation' }
+          its(:recipients_to_save) { should eq expected_recipients }
+        end
+        context 'when conversation is not set' do
+          subject { first_user.box.new_message }
+          it { should be_a_new MessageTrain::Message }
+          its(:subject) { should eq nil }
+          its(:recipients_to_save) { should be_empty }
+        end
+      end
+    end
+  end
+end

data/spec/models/message_train/conversation_spec.rb

@@ -0,0 +1,98 @@
+require 'rails_helper'
+
+module MessageTrain
+  RSpec.describe Conversation do
+    describe 'Model' do
+      it { should have_many :messages }
+      it { should have_many :ignores }
+      it { should have_many(:receipts).through(:messages) }
+    end
+    describe 'Scopes and Methods' do
+      include_context 'loaded site'
+      describe '#default_recipients_for' do
+        subject { sent_conversation.default_recipients_for(first_user) }
+        it { should include second_user }
+        it { should_not include first_user }
+        it { should_not include third_user }
+      end
+      describe '#set_ignored and #is_ignored?' do
+        subject { ignored_conversation.is_ignored?(first_user) }
+        it { should be true }
+      end
+      describe '#set_unignored' do
+        before do
+          ignored_conversation.set_unignored(first_user)
+        end
+        subject { ignored_conversation.is_ignored?(first_user) }
+        it { should be false }
+      end
+      describe '#mark and #includes_read_for?' do
+        before do
+          unread_conversation.mark(:read, first_user)
+        end
+        subject { unread_conversation.includes_read_for?(first_user) }
+        it { should be true }
+      end
+      describe '#includes_drafts_by?' do
+        subject { draft_conversation.includes_drafts_by?(first_user) }
+        it { should be true }
+      end
+      describe '.with_drafts_by' do
+        subject { MessageTrain::Conversation.with_drafts_by(first_user) }
+        its(:first) { should be_a MessageTrain::Conversation }
+        its(:count) { should eq 1 }
+      end
+      describe 'Dynamic Methods' do
+        describe '.trashed_for' do
+          subject { MessageTrain::Conversation.with_trashed_for(first_user) }
+          it { should include trashed_conversation }
+        end
+        describe '.untrashed_for' do
+          subject { MessageTrain::Conversation.with_untrashed_for(first_user) }
+          it { should_not include trashed_conversation }
+        end
+        describe '.deleted_for' do
+          subject { MessageTrain::Conversation.with_deleted_for(first_user) }
+          it { should include deleted_conversation }
+        end
+        describe '.undeleted_for' do
+          subject { MessageTrain::Conversation.with_undeleted_for(first_user) }
+          it { should_not include deleted_conversation }
+        end
+        describe '.read_for' do
+          subject { MessageTrain::Conversation.with_read_for(first_user) }
+          it { should include read_conversation }
+        end
+        describe '.unread_for' do
+          subject { MessageTrain::Conversation.with_unread_for(first_user) }
+          it { should include sent_conversation }
+          it { should include unread_conversation }
+        end
+        describe '#includes_trashed_to?' do
+          subject { trashed_conversation.includes_trashed_to?(first_user) }
+          it { should be true }
+        end
+        describe '#includes_read_to?' do
+          subject { read_conversation.includes_read_to?(first_user) }
+          it { should be true }
+        end
+        describe '#includes_deleted_to?' do
+          subject { deleted_conversation.includes_deleted_to?(first_user) }
+          it { should be true }
+        end
+        describe '#includes_receipts_to?' do
+          subject { unread_conversation.includes_receipts_to?(first_user) }
+          it { should be true }
+        end
+        describe '#includes_receipts_by?' do
+          subject { sent_conversation.includes_receipts_by?(first_user) }
+          it { should be true }
+        end
+        describe '#includes_receipts_for?' do
+          subject { sent_conversation.includes_receipts_for?(first_user) }
+          it { should be true }
+        end
+      end
+    end
+  end
+end

data/spec/models/message_train/ignore_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+
+module MessageTrain
+  RSpec.describe Ignore do
+    describe 'Model' do
+      it { should belong_to :conversation }
+      it { should belong_to :participant }
+      it { should validate_presence_of :conversation }
+      it { should validate_presence_of :participant }
+    end
+    describe 'Scopes and Methods' do
+      include_context 'loaded site'
+      describe '.find_all_by_participant' do
+        subject { ignored_conversation.ignores.find_all_by_participant(first_user) }
+        its(:first) { should be_a MessageTrain::Ignore }
+      end
+      describe '.conversation_ids' do
+        subject { MessageTrain::Ignore.conversation_ids }
+        it { should include ignored_conversation.id }
+      end
+      describe '.conversations' do
+        subject { MessageTrain::Ignore.conversations }
+        it { should include ignored_conversation }
+      end
+    end
+  end
+end