add methods and tests for participant string

Author: cmgmyr

composer.json

@@ -11,6 +11,7 @@
     ],
     "require": {
         "php": ">=5.4.0",
+        "illuminate/config": "~4.0",
         "illuminate/support": "~4.0",
         "illuminate/database": "~4.0",
         "nesbot/carbon": "~1.0"

src/Cmgmyr/Messenger/Models/Thread.php

@@ -201,4 +201,57 @@ public function activateAllParticipants()
             $participant->restore();
         }
     }
+
+    /**
+     * Generates a string of participant information
+     *
+     * @param null $userId
+     * @param array $columns
+     * @return string
+     */
+    public function participantsString($userId=null, $columns=['first_name', 'last_name'])
+    {
+        $selectString = $this->createSelectString($columns);
+
+        $participantNames = $this->getConnection()->table('users')
+            ->join('participants', 'users.id', '=', 'participants.user_id')
+            ->where('participants.thread_id', $this->id)
+            ->select($this->getConnection()->raw($selectString));
+
+        if ($userId !== null) {
+            $participantNames->where('users.id', '!=', $userId);
+        }
+
+        $userNames = $participantNames->lists('users.name');
+
+        return implode(', ', $userNames);
+    }
+
+    /**
+     * Generates a select string used in participantsString()
+     *
+     * @param $columns
+     * @return string
+     */
+    private function createSelectString($columns)
+    {
+        $dbDriver = $this->getConnection()->getDriverName();
+
+        switch ($dbDriver) {
+            case 'pgsql':
+            case 'sqlite':
+                $columnString = implode(" || ' ' || users.", $columns);
+                $selectString = "(users." . $columnString . ") as name";
+                break;
+            case 'sqlsrv':
+                $columnString = implode(" + ' ' + users.", $columns);
+                $selectString = "(users." . $columnString . ") as name";
+                break;
+            default:
+                $columnString = implode(", ' ', users.", $columns);
+                $selectString = "concat(users." . $columnString . ") as name";
+        }
+
+        return $selectString;
+    }
 }

src/Cmgmyr/Messenger/examples/views/index.blade.php

@@ -11,7 +11,8 @@
         <?php $class = $thread->isUnread($currentUserId) ? 'alert-info' : ''; ?>
         <div class="media alert {{$class}}">
             <h4 class="media-heading">{{link_to('messages/' . $thread->id, $thread->subject)}}</h4>
-            {{$thread->latestMessage()->body}}
+            <p>{{$thread->latestMessage()->body}}</p>
+            <p><small><strong>Participants:</strong> {{ $thread->participantsString(Auth::id()) }}</small></p>
         </div>
         @endforeach
     @else

tests/EloquentThreadTest.php

@@ -3,6 +3,7 @@
 use Carbon\Carbon;
 use Cmgmyr\Messenger\Models\Thread;
 use Illuminate\Database\Eloquent\Model as Eloquent;
+use ReflectionClass;
 
 class EloquentThreadTest extends TestCase
 {
@@ -12,6 +13,20 @@ public function setUp()
         Eloquent::unguard();
     }
 
+    /**
+     * Activate private/protected methods for testing
+     *
+     * @param $name
+     * @return \ReflectionMethod
+     */
+    protected static function getMethod($name)
+    {
+        $class = new ReflectionClass('Cmgmyr\Messenger\Models\Thread');
+        $method = $class->getMethod($name);
+        $method->setAccessible(true);
+        return $method;
+    }
+
     /** @test */
     public function it_should_create_a_new_thread()
     {
@@ -196,4 +211,44 @@ public function it_should_activate_all_deleted_participants()
         $participants = $thread->participants();
         $this->assertEquals(3, $participants->count());
     }
+
+    /** @test */
+    public function it_should_generate_participant_select_string()
+    {
+        $method = self::getMethod('createSelectString');
+        $thread = new Thread();
+
+        $columns = ['name'];
+        $select = $method->invokeArgs($thread, [$columns]);
+        $this->assertEquals("(users.name) as name", $select);
+
+        $columns = ['first_name', 'last_name'];
+        $select = $method->invokeArgs($thread, [$columns]);
+        $this->assertEquals("(users.first_name || ' ' || users.last_name) as name", $select);
+
+        $columns = ['first_name', 'last_name', 'email'];
+        $select = $method->invokeArgs($thread, [$columns]);
+        $this->assertEquals("(users.first_name || ' ' || users.last_name || ' ' || users.email) as name", $select);
+    }
+
+    /** @test */
+    public function it_should_get_participants_string()
+    {
+        $thread = $this->faktory->create('thread');
+
+        $participant_1 = $this->faktory->build('participant');
+        $participant_2 = $this->faktory->build('participant', ['user_id' => 2]);
+        $participant_3 = $this->faktory->build('participant', ['user_id' => 3]);
+
+        $thread->participants()->saveMany([$participant_1, $participant_2, $participant_3]);
+
+        $string = $thread->participantsString();
+        $this->assertEquals("Chris Gmyr, Adam Wathan, Taylor Otwell", $string);
+
+        $string = $thread->participantsString(1);
+        $this->assertEquals("Adam Wathan, Taylor Otwell", $string);
+
+        $string = $thread->participantsString(1, ['first_name']);
+        $this->assertEquals("Adam, Taylor", $string);
+    }
 }

tests/TestCase.php

@@ -55,6 +55,8 @@ private function migrateTables()
         $this->createThreadsTable();
         $this->createMessagesTable();
         $this->createParticipantsTable();
+
+        $this->seedUsersTable();
     }
 
     /**
@@ -75,6 +77,16 @@ function ($table) {
         );
     }
 
+    /**
+     * Create some users for the tests to use
+     */
+    private function seedUsersTable()
+    {
+        DB::insert('INSERT INTO users (id, first_name, last_name, email, created_at, updated_at) VALUES (?, ?, ?, ?, datetime(), datetime())', [1, 'Chris', 'Gmyr', '[email protected]']);
+        DB::insert('INSERT INTO users (id, first_name, last_name, email, created_at, updated_at) VALUES (?, ?, ?, ?, datetime(), datetime())', [2, 'Adam', 'Wathan', '[email protected]']);
+        DB::insert('INSERT INTO users (id, first_name, last_name, email, created_at, updated_at) VALUES (?, ?, ?, ?, datetime(), datetime())', [3, 'Taylor', 'Otwell', '[email protected]']);
+    }
+
     /**
      * Create the threads table in the database
      */