Added stack() method for keyboards, streamlined tests

Author: TiiFuchs

README.md

@@ -163,7 +163,7 @@ pass the variable to the `row()` method.
 
 ### ForceReply and ReplyKeyboardRemove
 
-ForceReply and ReplyKeyboardRemove can be used the same way as a normal keyboard, but the do not receive any buttons:
+ForceReply and ReplyKeyboardRemove can be used the same way as a normal keyboard, but they do not receive any buttons:
 
 ```php
 $this->replyToUser('Thank you', [

src/InlineKeyboard/InlineKeyboardMarkup.php

@@ -3,37 +3,11 @@
 namespace PhpTelegramBot\FluentKeyboard\InlineKeyboard;
 
 use PhpTelegramBot\FluentKeyboard\FluentEntity;
+use PhpTelegramBot\FluentKeyboard\KeyboardMarkup;
 
-class InlineKeyboardMarkup extends FluentEntity
+class InlineKeyboardMarkup extends KeyboardMarkup
 {
 
-    protected $data = [
-        'inline_keyboard' => []
-    ];
-
-    /**
-     * Adds a row to the keyboard
-     * @param  array  $row
-     * @return $this
-     */
-    public function row(array $row = [])
-    {
-        $this->data['inline_keyboard'][] = $row;
-
-        return $this;
-    }
-
-    public function button(InlineKeyboardButton $button)
-    {
-        $count = count($this->data['inline_keyboard']);
-        if (count($this->data['inline_keyboard']) === 0) {
-            $this->data['inline_keyboard'][] = [];
-            $count++;
-        }
-
-        $this->data['inline_keyboard'][$count - 1][] = $button;
-
-        return $this;
-    }
+    protected static $keyboardFieldName = 'inline_keyboard';
 
 }

src/KeyboardMarkup.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace PhpTelegramBot\FluentKeyboard;
+
+abstract class KeyboardMarkup extends FluentEntity
+{
+
+    /**
+     * Defines the field name that contains the rows and buttons.
+     *
+     * @var string
+     */
+    protected static $keyboardFieldName = 'keyboard';
+
+    protected $currentRowIndex = 0;
+
+    public function __construct(array $data = [])
+    {
+        parent::__construct($data);
+
+        // Make sure we have one empty row from the beginning
+        $this->data[static::$keyboardFieldName] = [[]];
+    }
+
+    /**
+     * Adds a new row to the keyboard.
+     *
+     * @param  array  $buttons
+     * @return $this
+     */
+    public function row(array $buttons = [])
+    {
+        $keyboard = &$this->data[static::$keyboardFieldName];
+
+        // Last row is not empty
+        if (! empty($keyboard[$this->currentRowIndex])) {
+            $keyboard[] = [];
+            $this->currentRowIndex++;
+        }
+
+        // argument is not empty
+        if (! empty($buttons)) {
+            $keyboard[$this->currentRowIndex] = $buttons;
+            $this->currentRowIndex++;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Adds buttons one per row to the keyboard.
+     *
+     * @param  array  $buttons
+     * @return $this
+     */
+    public function stack(array $buttons)
+    {
+        // Every button gets its own row
+        foreach ($buttons as $button) {
+            $this->row([$button]);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Adds a button to the last row.
+     *
+     * @param  \JsonSerializable  $button
+     * @return $this
+     */
+    public function button(\JsonSerializable $button)
+    {
+        $keyboard = &$this->data[static::$keyboardFieldName];
+
+        $keyboard[$this->currentRowIndex][] = $button;
+
+        return $this;
+    }
+
+}

src/ReplyKeyboard/ReplyKeyboardMarkup.php

@@ -3,49 +3,24 @@
 namespace PhpTelegramBot\FluentKeyboard\ReplyKeyboard;
 
 use PhpTelegramBot\FluentKeyboard\FluentEntity;
+use PhpTelegramBot\FluentKeyboard\KeyboardMarkup;
 
 /**
  * @method self resizeKeyboard(bool $resize_keyboard = true)
  * @method self oneTimeKeyboard(bool $one_time_keyboard = true)
  * @method self inputFieldPlaceholder(string $input_field_placeholder)
  * @method self selective(bool $selective = true)
  */
-class ReplyKeyboardMarkup extends FluentEntity
+class ReplyKeyboardMarkup extends KeyboardMarkup
 {
 
-    protected $data = [
-        'keyboard' => [],
-    ];
+    protected static $keyboardFieldName = 'keyboard';
 
     protected $defaults = [
         'resize_keyboard'   => true,
         'one_time_keyboard' => true,
         'selective'         => true,
     ];
 
-    /**
-     * Adds a row to the keyboard
-     * @param  array  $row
-     * @return $this
-     */
-    public function row(array $row = [])
-    {
-        $this->data['keyboard'][] = $row;
-
-        return $this;
-    }
-
-    public function button(KeyboardButton $button)
-    {
-        $count = count($this->data['keyboard']);
-        if ($count === 0) {
-            $this->data['keyboard'][] = [];
-            $count++;
-        }
-
-        $this->data['keyboard'][$count - 1][] = $button;
-
-        return $this;
-    }
 
 }

tests/Pest.php

@@ -24,8 +24,8 @@
 |
 */
 
-expect()->extend('toBeJsonSerializable', function () {
-    return $this->jsonSerialize()->toBeArray();
+expect()->extend('toMatchEntity', function ($array) {
+    return expect(json_encode($this->value))->json()->toMatchArray($array);
 });
 
 /*
@@ -39,7 +39,7 @@
 |
 */
 
-function something()
-{
-    // ..
-}
+//function something()
+//{
+//    // ..
+//}

tests/Unit/ForceReplyTest.php

@@ -4,19 +4,17 @@
 
 it('creates valid JSON', function () {
     $keyboard = ForceReply::make();
-    $json = json_encode($keyboard);
 
-    expect($json)->json()->toMatchArray([
+    expect($keyboard)->toMatchEntity([
         'force_reply' => true,
     ]);
 });
 
 it('can set known fields', function () {
     $keyboard = ForceReply::make()
         ->selective();
-    $json = json_encode($keyboard);
 
-    expect($json)->json()->toMatchArray([
+    expect($keyboard)->toMatchEntity([
         'force_reply' => true,
         'selective'   => true,
     ]);
@@ -25,9 +23,8 @@
 it('can set unknown fields', function () {
     $keyboard = ForceReply::make()
         ->unknownFields('unknown');
-    $json = json_encode($keyboard);
 
-    expect($json)->json()->toMatchArray([
+    expect($keyboard)->toMatchEntity([
         'force_reply'    => true,
         'unknown_fields' => 'unknown'
     ]);

tests/Unit/InlineKeyboardButtonTest.php

@@ -4,9 +4,8 @@
 
 it('creates valid JSON', function () {
     $button = InlineKeyboardButton::make();
-    $json = json_encode($button);
 
-    expect($json)->json()->toMatchArray([
+    expect($button)->toMatchEntity([
 
     ]);
 });
@@ -21,9 +20,8 @@
         ->switchInlineQueryCurrentChat('Switch Inline Query Current Chat')
         ->callbackGame('Callback Game')
         ->pay();
-    $json = json_encode($button);
 
-    expect($json)->json()->toMatchArray([
+    expect($button)->toMatchEntity([
         'text'                             => 'Text',
         'url'                              => 'http://example.com',
         'login_url'                        => [],
@@ -37,19 +35,17 @@
 
 it('can set text via make', function () {
     $button = InlineKeyboardButton::make('Test');
-    $json = json_encode($button);
 
-    expect($json)->json()->toMatchArray([
+    expect($button)->toMatchEntity([
         'text' => 'Test',
     ]);
 });
 
 it('can set unknown fields', function () {
     $button = InlineKeyboardButton::make()
         ->unknownField('unknown');
-    $json = json_encode($button);
 
-    expect($json)->json()->toMatchArray([
+    expect($button)->toMatchEntity([
         'unknown_field' => 'unknown',
     ]);
 });