WowApps\SlackBundle\Traits\SlackMessageTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	inlineMultilines()	0	4	1
A	formatBold()	0	4	1
A	formatItalic()	0	4	1
A	formatStrikeThought()	0	4	1
A	formatCode()	0	8	1
A	newLine()	0	4	1
A	formatLink()	0	4	1
A	escapeCharacters()	0	8	1
A	formatListMarker()	0	12	3
A	formatListNumeric()	0	14	3

<?php
/**
 * This file is part of the WoW-Apps/Symfony-Slack-Bot bundle for Symfony 3
 * https://github.com/wow-apps/symfony-slack-bot
 *
 * (c) 2016 WoW-Apps
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WowApps\SlackBundle\Traits;

/**
 * Trait SlackMessageTrait
 *
 * @author Alexey Samara <lion.samara@gmail.com>
 * @package WowApps\SlackBundle
 */
trait SlackMessageTrait
{
    /**
     * @param array $lines
     * @return string
     */
    public function inlineMultilines(array $lines): string
    {
        return implode("\n", $lines);
    }

    /**
     * @param string $string
     * @return string
     */
    public function formatBold(string $string): string
    {
        return sprintf("*%s*", $string);
    }

    /**
     * @param string $string
     * @return string
     */
    public function formatItalic(string $string): string
    {
        return sprintf("_%s_", $string);
    }

    /**
     * @param string $string
     * @return string
     */
    public function formatStrikeThought(string $string): string
    {
        return sprintf("~%s~", $string);
    }

    /**
     * @param array $list
     * @return string
     * @throws \InvalidArgumentException
     */
    public function formatListMarker(array $list): string
    {
        if (empty($list)) {
            throw new \InvalidArgumentException('The list must contain at least one value');
        }

        foreach ($list as $key => $value) {
            $list[$key] = sprintf('• %s', $value);
        }

        return sprintf("\n%s\n", implode("\n", $list));
    }

    /**
     * @param array $list
     * @return string
     * @throws \InvalidArgumentException
     */
    public function formatListNumeric(array $list): string
    {
        if (empty($list)) {
            throw new \InvalidArgumentException('The list must contain at least one value');
        }

        $num = 0;
        $output = "\n";
        foreach ($list as $value) {
            $output .= sprintf("%s. %s\n", ++$num, $value);
        }

        return $output;
    }

    /**
     * @param array $lines
     * @return string
     */
    public function formatCode(array $lines): string
    {
        $output = "\n```";
        $output .= $this->inlineMultilines($lines);
        $output .= "```\n";

        return $output;
    }

    /**
     * @return string
     */
    public function newLine(): string
    {
        return "\n";
    }

    /**
     * @param string $title
     * @param string $url
     * @return string
     */
    public function formatLink(string $title, string $url): string
    {
        return sprintf("<%s|%s>", $url, $title);
    }

    /**
     * @param string $string
     * @return string
     */
    public function escapeCharacters(string $string): string
    {
        $string = str_replace('&', '&amp;', $string);
        $string = str_replace('<', '&lt;', $string);
        $string = str_replace('>', '&gt;', $string);

        return $string;
    }
}