Specificy sender fields (#191)

* Allow specifying sender fields for queries

* Apply fixes from StyleCI (#190)

Author: musonza

config/musonza_chat.php

@@ -26,4 +26,10 @@
      * Automatically convert conversations with more than two users to public
      */
     'make_three_or_more_users_public' => true,
+
+    /*
+     * Specify the fields that you want to return each time for the sender.
+     * If not set or empty, all the columns for the sender will be returned
+     */
+    'sender_fields_whitelist' => [],
 ];

src/Chat.php

@@ -130,4 +130,11 @@ public static function makeThreeOrMoreUsersPublic()
     {
         return config('musonza_chat.make_three_or_more_users_public', true);
     }
+
+    public static function senderFieldsWhitelist()
+    {
+        $fields = config('musonza_chat.sender_fields_whitelist', []);
+
+        return (is_array($fields) && !empty($fields)) ? $fields : null;
+    }
 }

src/Models/Message.php

@@ -30,6 +30,12 @@ class Message extends BaseModel
 
     public function sender()
     {
+        $fields = Chat::senderFieldsWhitelist();
+
+        if ($fields) {
+            return $this->belongsTo(Chat::userModel(), 'user_id')->select($fields);
+        }
+
         return $this->belongsTo(Chat::userModel(), 'user_id');
     }
 

tests/Unit/ConversationTest.php

@@ -304,4 +304,15 @@ public function it_filters_conversations_by_type()
         $publicConversations = Chat::conversations()->setUser($this->users[0])->isPrivate(false)->get();
         $this->assertCount(1, $publicConversations);
     }
+
+    /** @test */
+    public function it_specifies_fields_to_return_for_sender()
+    {
+        $this->app['config']->set('musonza_chat.sender_fields_whitelist', ['uid', 'email']);
+
+        $conversation = Chat::createConversation([$this->users[0]->getKey(), $this->users[1]->getKey()]);
+        $message = Chat::message('Hello')->from($this->users[0])->to($conversation)->send();
+
+        $this->assertSame(['uid', 'email'], array_keys($message->sender->attributesToArray()));
+    }
 }