mirror of
https://github.com/ivuorinen/bbcodeparser.git
synced 2026-01-26 03:13:57 +00:00
Initial commit with tests, and stuff.
This commit is contained in:
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
/vendor
|
||||
composer.lock
|
||||
22
.travis.yml
Normal file
22
.travis.yml
Normal file
@@ -0,0 +1,22 @@
|
||||
language: php
|
||||
php:
|
||||
- 5.6
|
||||
- 7.0
|
||||
- 7.1
|
||||
- 7.2
|
||||
- nightly
|
||||
matrix:
|
||||
allow_failures:
|
||||
- php: nightly
|
||||
fast_finish: true
|
||||
cache:
|
||||
directories:
|
||||
- $HOME/.composer/cache/files
|
||||
before_script:
|
||||
- phpenv global "$TRAVIS_PHP_VERSION"
|
||||
- composer config extra.platform.php $TRAVIS_PHP_VERSION
|
||||
install:
|
||||
- flags="--ansi --prefer-dist --no-interaction --optimize-autoloader --no-suggest --no-progress"
|
||||
- travis_wait 30 composer install $flags
|
||||
script:
|
||||
- ./vendor/bin/phpunit -c phpunit.xml
|
||||
87
CHANGELOG.md
Normal file
87
CHANGELOG.md
Normal file
@@ -0,0 +1,87 @@
|
||||
# Changelog
|
||||
|
||||
All Notable changes to `ivuorinen\BBCodeParser` will be documented in this file.
|
||||
|
||||
## v3.0.0 - 2018-06-08
|
||||
|
||||
- Project now in new hands
|
||||
- Tests
|
||||
|
||||
# Changelog of `Golonka\BBCodeParser`
|
||||
|
||||
## v2.2.0 - 2015-09-07
|
||||
|
||||
### Added
|
||||
- You can now strip all BBCode tags by using the ``stripBBCodeTags`` function.
|
||||
|
||||
## v2.1.0 - 2015-06-20
|
||||
|
||||
### Added
|
||||
- Made ``parseCaseSensitive`` and ``parseCaseInsensitive`` functions to make parsing more readable.
|
||||
|
||||
## v2.0.0 - 2015-06-02
|
||||
|
||||
### Added
|
||||
- Using PSR-4 instead of PSR-0
|
||||
- Moved the ``arrayOnly`` and ``arrayExcept`` functions into a trait
|
||||
- Minimum supported PHP version bumped to 5.4
|
||||
|
||||
### Fixed
|
||||
- Renamed some tag names, mostly making them all lowercase
|
||||
- `` underLine -> underline ``
|
||||
- `` lineThrough -> linethrough ``
|
||||
- `` fontSize -> size ``
|
||||
- `` fontColor -> color ``
|
||||
- `` namedQuote -> namedquote ``
|
||||
- `` namedQuote -> namedquote ``
|
||||
- `` namedLink -> namedlink ``
|
||||
- `` orderedListNumerical -> orderedlistnumerical ``
|
||||
- `` orderedListAlpha -> orderedlistalpha ``
|
||||
- `` unorderedList -> unorderedlist ``
|
||||
- `` listItem -> listitem ``
|
||||
|
||||
### Removed
|
||||
- The ``iterate`` property is removed. Unneeded after improvements in parsing method.
|
||||
- Removed deprecated tags ``[ul]`` and ``[ol]``
|
||||
|
||||
## v1.4 - 2015-05-05
|
||||
|
||||
### Added
|
||||
- Optional parameter enables or disables case insensitivity. Disabled by default.
|
||||
|
||||
## v1.3.0 - 2014-06-30
|
||||
|
||||
### Fixed
|
||||
- The only/except functionally have been broken since like 1.1, but now it´s working. Better late then never!
|
||||
|
||||
## v1.2.7 - 2014-05-19
|
||||
|
||||
### Added
|
||||
- A new iterate key is added to tags that typically could contain more tags of the same kind, like quotes.
|
||||
|
||||
### Fixed
|
||||
- Problem where tags of the same kind would just parse the top level.
|
||||
|
||||
## v1.2.6 - 2014-05-17
|
||||
|
||||
### Fixed
|
||||
- Fixed a problem where if a tag had a line break in them they wouldn't parse.
|
||||
|
||||
## v1.2.5 - 2014-05-15
|
||||
|
||||
### Fixed
|
||||
- Improved most regex matches by removing unnecessary greediness.
|
||||
|
||||
## v1.2.0 - 2014-03-25
|
||||
|
||||
### Fixed
|
||||
- Better syntax for lists.
|
||||
|
||||
## v1.1.0 - 2014-01-27
|
||||
|
||||
### Added
|
||||
- Support for custom bbcode tags.
|
||||
|
||||
## v1.0.0 - 2013-11-07
|
||||
|
||||
Released the package.
|
||||
32
CONTRIBUTING.md
Normal file
32
CONTRIBUTING.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Contributing
|
||||
|
||||
Contributions are **welcome** and will be fully **credited**.
|
||||
|
||||
We accept contributions via Pull Requests on [Github](https://github.com/ivuorinen/bbcodeparser).
|
||||
|
||||
|
||||
## Pull Requests
|
||||
|
||||
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
|
||||
|
||||
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
|
||||
|
||||
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
|
||||
|
||||
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
|
||||
|
||||
- **Create feature branches** - Don't ask us to pull from your master branch.
|
||||
|
||||
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
|
||||
|
||||
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
|
||||
|
||||
|
||||
## Running Tests
|
||||
|
||||
``` bash
|
||||
$ vendor/bin/phpunit
|
||||
```
|
||||
|
||||
|
||||
**Happy coding**!
|
||||
22
LICENSE.md
Normal file
22
LICENSE.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Ismo Vuorinen <ismo@ivuorinen.net>
|
||||
Copyright (c) 2013-2015 Joseph Landberg <joseph.landberg@gmail.com>
|
||||
|
||||
> Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
> of this software and associated documentation files (the "Software"), to deal
|
||||
> in the Software without restriction, including without limitation the rights
|
||||
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
> copies of the Software, and to permit persons to whom the Software is
|
||||
> furnished to do so, subject to the following conditions:
|
||||
>
|
||||
> The above copyright notice and this permission notice shall be included in
|
||||
> all copies or substantial portions of the Software.
|
||||
>
|
||||
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
> THE SOFTWARE.
|
||||
120
README.md
Normal file
120
README.md
Normal file
@@ -0,0 +1,120 @@
|
||||
[](https://github.com/ivuorinen/bbcodeparser/releases)
|
||||
[](LICENSE.md)
|
||||
[](https://travis-ci.org/ivuorinen/BBCodeParser)
|
||||
[](https://scrutinizer-ci.com/g/ivuorinen/bbcodeparser/code-structure)
|
||||
[](https://scrutinizer-ci.com/g/ivuorinen/bbcodeparser)
|
||||
[](https://packagist.org/packages/ivuorinen/bbcodeparser)
|
||||
|
||||
The ``ivuorinen\BBCodeParser`` package will help you with parsing BBCode.
|
||||
This package is build on work by [Joseph Landberg](https://github.com/golonka).
|
||||
|
||||
## Install
|
||||
|
||||
Via Composer
|
||||
|
||||
``` bash
|
||||
$ composer require ivuorinen/bbcodeparser
|
||||
```
|
||||
|
||||
## Usage
|
||||
To parse some text it's as easy as this!
|
||||
``` php
|
||||
$bbcode = new ivuorinen\BBCode\BBCodeParser;
|
||||
|
||||
echo $bbcode->parse('[b]Bold Text![/b]');
|
||||
// <strong>Bold Text!</strong>
|
||||
```
|
||||
Would like the parser to not use all bbcodes? Just do like this.
|
||||
``` php
|
||||
$bbcode = new ivuorinen\BBCode\BBCodeParser;
|
||||
|
||||
echo $bbcode->only('bold', 'italic')
|
||||
->parse('[b][u]Bold[/u] [i]Italic[/i]![/b]');
|
||||
// <strong>[u]Bold[/u] <em>Italic</em>!</strong>
|
||||
|
||||
echo $bbcode->except('bold')
|
||||
->parse('[b]Bold[/b] [i]Italic[/i]');
|
||||
// [b]Bold[/b] <em>Italic</em>
|
||||
```
|
||||
|
||||
By default the parser is case sensitive. But if you would like the parser to accept tags like `` [B]Bold Text[/B] `` it's really easy.
|
||||
``` php
|
||||
$bbcode = new ivuorinen\BBCode\BBCodeParser;
|
||||
|
||||
// Case insensitive
|
||||
echo $bbcode->parse('[b]Bold[/b] [I]Italic![/I]', true);
|
||||
// <strong>Bold</strong> <em>Italic!</em>
|
||||
|
||||
// Or like this
|
||||
|
||||
echo $bbcode->parseCaseInsensitive('[b]Bold[/b] [i]Italic[/i]');
|
||||
// <strong>Bold</strong> <em>Italic!</em>
|
||||
```
|
||||
You could also make it more explicit that the parser is case sensitive by using another helper function.
|
||||
``` php
|
||||
$bbcode = new ivuorinen\BBCode\BBCodeParser;
|
||||
|
||||
echo $bbcode->parseCaseSensitive('[b]Bold[/b] [I]Italic![/I]');
|
||||
// <strong>Bold</strong> [I]Italic![/I]
|
||||
```
|
||||
|
||||
If you would like to completely remove all BBCode it's just one function call away.
|
||||
``` php
|
||||
$bbcode = new ivuorinen\BBCode\BBCodeParser;
|
||||
|
||||
echo $bbcode->stripBBCodeTags('[b]Bold[/b] [i]Italic![/i]');
|
||||
// Bold Italic!
|
||||
```
|
||||
|
||||
## Laravel integration
|
||||
The integration into Laravel is really easy, and the method is the same for both Laravel 4 and Laravel 5.
|
||||
This package supports Laravel Package Auto-Discovery, so it should be picked up automatically.
|
||||
|
||||
If you don't want auto-discovery, or because of old habits, just open your ``app.php`` config file.
|
||||
|
||||
In there you just add this to your providers array
|
||||
``` php
|
||||
'ivuorinen\BBCode\BBCodeParserServiceProvider'
|
||||
```
|
||||
|
||||
And this to your facades array
|
||||
``` php
|
||||
'BBCode' => 'ivuorinen\BBCode\Facades\BBCodeParser'
|
||||
```
|
||||
|
||||
The syntax is the same as if you would use it in vanilla PHP but with the ``BBCode::`` before the methods.
|
||||
Here are some examples.
|
||||
``` php
|
||||
// Simple parsing
|
||||
echo BBCode::parse('[b]Bold Text![/b]');
|
||||
|
||||
// Limiting the parsers with the only method
|
||||
echo BBCode::only('bold', 'italic')
|
||||
->parse('[b][u]Bold[/u] [i]Italic[/i]![/b]');
|
||||
// <strong>[u]Bold[/u] <em>Italic</em>!</strong>
|
||||
|
||||
// Or the except method
|
||||
echo BBCode::except('bold')
|
||||
->parse('[b]Bold[/b] [i]Italic[/i]');
|
||||
// [b]Bold[/b] <em>Italic</em>
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
``` bash
|
||||
$ phpunit
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
|
||||
|
||||
## Credits
|
||||
|
||||
- [Ismo Vuorinen](https://github.com/ivuorinen)
|
||||
- [Joseph Landberg](https://github.com/golonka)
|
||||
- [All Contributors](../../contributors)
|
||||
|
||||
## License
|
||||
|
||||
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|
||||
50
composer.json
Normal file
50
composer.json
Normal file
@@ -0,0 +1,50 @@
|
||||
{
|
||||
"name": "ivuorinen/bbcodeparser",
|
||||
"description": "Parse your BBCode easy with this library.",
|
||||
"keywords": ["bbcode", "parser", "laravel", "psr-1", "psr-2", "psr-4"],
|
||||
"homepage": "https://github.com/ivuorinen/bbcodeparser",
|
||||
"type": "library",
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{
|
||||
"name": "Ismo Vuorinen",
|
||||
"email": "ismo@ivuorinen.net",
|
||||
"homepage": "https://github.com/ivuorinen"
|
||||
},
|
||||
{
|
||||
"name": "Joseph Landberg",
|
||||
"email": "joseph.landberg@gmail.com",
|
||||
"homepage": "https://github.com/golonka/"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=7"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "~5",
|
||||
"squizlabs/php_codesniffer": "~2",
|
||||
"orchestra/testbench": "~3.0"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"ivuorinen\\BBCode\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": { "ivuorinen\\BBCode\\Tests\\": "tests/" },
|
||||
"classmap": [
|
||||
"tests/"
|
||||
]
|
||||
},
|
||||
"minimum-stability": "stable",
|
||||
"extra": {
|
||||
"laravel": {
|
||||
"providers": [
|
||||
"ivuorinen\\BBCode\\BBCodeParserServiceProvider"
|
||||
],
|
||||
"aliases": {
|
||||
"BBCode": "ivuorinen\\BBCode\\Facades\\BBCodeParser"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
21
phpunit.xml
Normal file
21
phpunit.xml
Normal file
@@ -0,0 +1,21 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit backupGlobals="false"
|
||||
backupStaticAttributes="false"
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true"
|
||||
convertErrorsToExceptions="true"
|
||||
convertNoticesToExceptions="true"
|
||||
convertWarningsToExceptions="true"
|
||||
processIsolation="false"
|
||||
stopOnFailure="false">
|
||||
<testsuites>
|
||||
<testsuite name="Tests">
|
||||
<directory suffix="Test.php">./tests</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<filter>
|
||||
<whitelist processUncoveredFilesFromWhitelist="true">
|
||||
<directory suffix=".php">./src</directory>
|
||||
</whitelist>
|
||||
</filter>
|
||||
</phpunit>
|
||||
245
src/BBCodeParser.php
Normal file
245
src/BBCodeParser.php
Normal file
@@ -0,0 +1,245 @@
|
||||
<?php namespace ivuorinen\BBCode;
|
||||
|
||||
use \ivuorinen\BBCode\Traits\ArrayTrait;
|
||||
|
||||
class BBCodeParser
|
||||
{
|
||||
use ArrayTrait;
|
||||
|
||||
public $parsers = [
|
||||
'bold' => [
|
||||
'pattern' => '/\[b\](.*?)\[\/b\]/s',
|
||||
'replace' => '<strong>$1</strong>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'italic' => [
|
||||
'pattern' => '/\[i\](.*?)\[\/i\]/s',
|
||||
'replace' => '<em>$1</em>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'underline' => [
|
||||
'pattern' => '/\[u\](.*?)\[\/u\]/s',
|
||||
'replace' => '<u>$1</u>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'linethrough' => [
|
||||
'pattern' => '/\[s\](.*?)\[\/s\]/s',
|
||||
'replace' => '<del>$1</del>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'size' => [
|
||||
'pattern' => '/\[size\=([1-7])\](.*?)\[\/size\]/s',
|
||||
'replace' => '<font size="$1">$2</font>',
|
||||
'content' => '$2'
|
||||
],
|
||||
'color' => [
|
||||
'pattern' => '/\[color\=(#[A-f0-9]{6}|#[A-f0-9]{3})\](.*?)\[\/color\]/s',
|
||||
'replace' => '<font color="$1">$2</font>',
|
||||
'content' => '$2'
|
||||
],
|
||||
'center' => [
|
||||
'pattern' => '/\[center\](.*?)\[\/center\]/s',
|
||||
'replace' => '<div style="text-align:center;">$1</div>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'left' => [
|
||||
'pattern' => '/\[left\](.*?)\[\/left\]/s',
|
||||
'replace' => '<div style="text-align:left;">$1</div>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'right' => [
|
||||
'pattern' => '/\[right\](.*?)\[\/right\]/s',
|
||||
'replace' => '<div style="text-align:right;">$1</div>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'quote' => [
|
||||
'pattern' => '/\[quote\](.*?)\[\/quote\]/s',
|
||||
'replace' => '<blockquote>$1</blockquote>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'namedquote' => [
|
||||
'pattern' => '/\[quote\=(.*?)\](.*)\[\/quote\]/s',
|
||||
'replace' => '<blockquote><small>$1</small>$2</blockquote>',
|
||||
'content' => '$2'
|
||||
],
|
||||
'link' => [
|
||||
'pattern' => '/\[url\](.*?)\[\/url\]/s',
|
||||
'replace' => '<a href="$1">$1</a>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'namedlink' => [
|
||||
'pattern' => '/\[url\=(.*?)\](.*?)\[\/url\]/s',
|
||||
'replace' => '<a href="$1">$2</a>',
|
||||
'content' => '$2'
|
||||
],
|
||||
'image' => [
|
||||
'pattern' => '/\[img\](.*?)\[\/img\]/s',
|
||||
'replace' => '<img src="$1">',
|
||||
'content' => '$1'
|
||||
],
|
||||
'orderedlistnumerical' => [
|
||||
'pattern' => '/\[list=1\](.*?)\[\/list\]/s',
|
||||
'replace' => '<ol>$1</ol>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'orderedlistalpha' => [
|
||||
'pattern' => '/\[list=a\](.*?)\[\/list\]/s',
|
||||
'replace' => '<ol type="a">$1</ol>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'unorderedlist' => [
|
||||
'pattern' => '/\[list\](.*?)\[\/list\]/s',
|
||||
'replace' => '<ul>$1</ul>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'listitem' => [
|
||||
'pattern' => '/\[\*\](.*)/',
|
||||
'replace' => '<li>$1</li>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'code' => [
|
||||
'pattern' => '/\[code\](.*?)\[\/code\]/s',
|
||||
'replace' => '<code>$1</code>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'youtube' => [
|
||||
'pattern' => '/\[youtube\](.*?)\[\/youtube\]/s',
|
||||
'replace' => '<iframe width="560" height="315" src="//www.youtube.com/embed/$1" frameborder="0" allowfullscreen></iframe>',
|
||||
'content' => '$1'
|
||||
],
|
||||
'linebreak' => [
|
||||
'pattern' => '/\r\n/',
|
||||
'replace' => '<br />',
|
||||
'content' => ''
|
||||
]
|
||||
];
|
||||
|
||||
private $enabledParsers;
|
||||
|
||||
public function __construct()
|
||||
{
|
||||
$this->enabledParsers = $this->parsers;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses the BBCode string
|
||||
* @param string $source String containing the BBCode
|
||||
* @param bool $caseInsensitive
|
||||
* @return string Parsed string
|
||||
*/
|
||||
public function parse($source, $caseInsensitive = false)
|
||||
{
|
||||
foreach ($this->enabledParsers as $name => $parser) {
|
||||
$pattern = ($caseInsensitive) ? $parser['pattern'] . 'i' : $parser['pattern'];
|
||||
|
||||
$source = $this->searchAndReplace($pattern, $parser['replace'], $source);
|
||||
}
|
||||
return $source;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove all BBCode
|
||||
* @param string $source
|
||||
* @return string Parsed text
|
||||
*/
|
||||
public function stripBBCodeTags($source)
|
||||
{
|
||||
foreach ($this->parsers as $name => $parser) {
|
||||
$source = $this->searchAndReplace($parser['pattern'] . 'i', $parser['content'], $source);
|
||||
}
|
||||
return $source;
|
||||
}
|
||||
|
||||
/**
|
||||
* Searches after a specified pattern and replaces it with provided structure
|
||||
* @param string $pattern Search pattern
|
||||
* @param string $replace Replacement structure
|
||||
* @param string $source Text to search in
|
||||
* @return string Parsed text
|
||||
*/
|
||||
protected function searchAndReplace($pattern, $replace, $source)
|
||||
{
|
||||
while (preg_match($pattern, $source)) {
|
||||
$source = preg_replace($pattern, $replace, $source);
|
||||
}
|
||||
|
||||
return $source;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper function to parse case sensitive
|
||||
* @param string $source String containing the BBCode
|
||||
* @return string Parsed text
|
||||
*/
|
||||
public function parseCaseSensitive($source)
|
||||
{
|
||||
return $this->parse($source, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper function to parse case insensitive
|
||||
* @param string $source String containing the BBCode
|
||||
* @return string Parsed text
|
||||
*/
|
||||
public function parseCaseInsensitive($source)
|
||||
{
|
||||
return $this->parse($source, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Limits the parsers to only those you specify
|
||||
* @param mixed $only parsers
|
||||
* @return object BBCodeParser object
|
||||
*/
|
||||
public function only($only = null)
|
||||
{
|
||||
$only = (is_array($only)) ? $only : func_get_args();
|
||||
$this->enabledParsers = $this->arrayOnly($this->parsers, $only);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the parsers you want to exclude
|
||||
* @param mixed $except parsers
|
||||
* @return BBCodeParser
|
||||
*/
|
||||
public function except($except = null)
|
||||
{
|
||||
$except = (is_array($except)) ? $except : func_get_args();
|
||||
$this->enabledParsers = $this->arrayExcept($this->parsers, $except);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* List of chosen parsers
|
||||
* @return array array of parsers
|
||||
*/
|
||||
public function getParsers()
|
||||
{
|
||||
return $this->enabledParsers;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the parser pattern and replace.
|
||||
* This can be used for new parsers or overwriting existing ones.
|
||||
* @param string $name Parser name
|
||||
* @param string $pattern Pattern
|
||||
* @param string $replace Replace pattern
|
||||
* @param string $content Parsed text pattern
|
||||
* @return void
|
||||
*/
|
||||
public function setParser($name, $pattern, $replace, $content)
|
||||
{
|
||||
$this->parsers[$name] = array(
|
||||
'pattern' => $pattern,
|
||||
'replace' => $replace,
|
||||
'content' => $content
|
||||
);
|
||||
|
||||
$this->enabledParsers[$name] = array(
|
||||
'pattern' => $pattern,
|
||||
'replace' => $replace,
|
||||
'content' => $content
|
||||
);
|
||||
}
|
||||
}
|
||||
36
src/BBCodeParserServiceProvider.php
Normal file
36
src/BBCodeParserServiceProvider.php
Normal file
@@ -0,0 +1,36 @@
|
||||
<?php namespace ivuorinen\BBCode;
|
||||
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
|
||||
class BBCodeParserServiceProvider extends ServiceProvider
|
||||
{
|
||||
|
||||
/**
|
||||
* Indicates if loading of the provider is deferred.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $defer = true;
|
||||
|
||||
/**
|
||||
* Register the service provider.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
$this->app->bind('bbcode', function () {
|
||||
return new BBCodeParser;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the services provided by the provider.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function provides()
|
||||
{
|
||||
return ['bbcode'];
|
||||
}
|
||||
}
|
||||
11
src/Facades/BBCodeParser.php
Normal file
11
src/Facades/BBCodeParser.php
Normal file
@@ -0,0 +1,11 @@
|
||||
<?php namespace ivuorinen\BBCode\Facades;
|
||||
|
||||
use Illuminate\Support\Facades\Facade;
|
||||
|
||||
class BBCodeParser extends Facade
|
||||
{
|
||||
protected static function getFacadeAccessor()
|
||||
{
|
||||
return 'bbcode';
|
||||
}
|
||||
}
|
||||
26
src/Traits/ArrayTrait.php
Normal file
26
src/Traits/ArrayTrait.php
Normal file
@@ -0,0 +1,26 @@
|
||||
<?php namespace ivuorinen\BBCode\Traits;
|
||||
|
||||
trait ArrayTrait
|
||||
{
|
||||
/**
|
||||
* Filters all parsers that you don´t want
|
||||
* @param array $parsers An array of all parsers
|
||||
* @param array $only Chosen parsers
|
||||
* @return array parsers
|
||||
*/
|
||||
private function arrayOnly(array $parsers, $only)
|
||||
{
|
||||
return array_intersect_key($parsers, array_flip((array)$only));
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the parsers that you don´t want
|
||||
* @param array $parsers An array of all parsers
|
||||
* @param array $except Parsers to exclude
|
||||
* @return array parsers
|
||||
*/
|
||||
private function arrayExcept(array $parsers, $except)
|
||||
{
|
||||
return array_diff_key($parsers, array_flip((array)$except));
|
||||
}
|
||||
}
|
||||
30
tests/ArrayTraitHelper.php
Normal file
30
tests/ArrayTraitHelper.php
Normal file
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
|
||||
use ivuorinen\BBCode\Traits\ArrayTrait;
|
||||
|
||||
class ArrayTraitHelper
|
||||
{
|
||||
use ArrayTrait;
|
||||
|
||||
/**
|
||||
* @param array $parsers
|
||||
* @param $only
|
||||
* @see \ivuorinen\BBCode\Traits\ArrayTrait::arrayOnly
|
||||
* @return array
|
||||
*/
|
||||
public function publicArrayOnly(array $parsers, $only)
|
||||
{
|
||||
return $this->arrayOnly($parsers, $only);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $parsers
|
||||
* @param $except
|
||||
* @see \ivuorinen\BBCode\Traits\ArrayTrait::arrayExcept
|
||||
* @return array
|
||||
*/
|
||||
public function publicArrayExcept(array $parsers, $except)
|
||||
{
|
||||
return $this->arrayExcept($parsers, $except);
|
||||
}
|
||||
}
|
||||
26
tests/ArrayTraitTest.php
Normal file
26
tests/ArrayTraitTest.php
Normal file
@@ -0,0 +1,26 @@
|
||||
<?php
|
||||
|
||||
namespace ivuorinen\BBCode\Tests;
|
||||
|
||||
use ArrayTraitHelper;
|
||||
use TestCase;
|
||||
|
||||
class ArrayTraitTest extends TestCase
|
||||
{
|
||||
private $class;
|
||||
|
||||
public function setUp()
|
||||
{
|
||||
$this->class = new ArrayTraitHelper();
|
||||
}
|
||||
|
||||
public function test_array_only()
|
||||
{
|
||||
$this->assertTrue(\method_exists($this->class, 'arrayOnly'));
|
||||
}
|
||||
|
||||
public function test_array_except()
|
||||
{
|
||||
$this->assertTrue(\method_exists($this->class, 'arrayExcept'));
|
||||
}
|
||||
}
|
||||
34
tests/BBCodeParserFacadeTest.php
Normal file
34
tests/BBCodeParserFacadeTest.php
Normal file
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
class BBCodeParserFacadeTest extends TestCase
|
||||
{
|
||||
public function test_facade_exists_and_has_bbcode()
|
||||
{
|
||||
try {
|
||||
$method = $this->callMethod(
|
||||
new \ivuorinen\BBCode\Facades\BBCodeParser,
|
||||
'getFacadeAccessor',
|
||||
[]
|
||||
);
|
||||
$this->assertEquals('bbcode', $method);
|
||||
} catch (ReflectionException $e) {
|
||||
$this->throwException($e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $obj
|
||||
* @param $name
|
||||
* @param array $args
|
||||
* @return mixed
|
||||
* @throws ReflectionException
|
||||
*/
|
||||
public static function callMethod($obj, $name, array $args)
|
||||
{
|
||||
$class = new \ReflectionClass($obj);
|
||||
$method = $class->getMethod($name);
|
||||
$method->setAccessible(true);
|
||||
return $method->invokeArgs($obj, $args);
|
||||
}
|
||||
|
||||
}
|
||||
20
tests/BBCodeParserServiceProviderTest.php
Normal file
20
tests/BBCodeParserServiceProviderTest.php
Normal file
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
use ivuorinen\BBCode\BBCodeParserServiceProvider;
|
||||
|
||||
class BBCodeParserServiceProviderTest extends TestCase
|
||||
{
|
||||
public function testProvides()
|
||||
{
|
||||
$provider = new BBCodeParserServiceProvider($this->app);
|
||||
$this->assertEquals(['bbcode'], $provider->provides());
|
||||
}
|
||||
|
||||
public function testRegister()
|
||||
{
|
||||
$this->assertInstanceOf(
|
||||
\ivuorinen\BBCode\BBCodeParser::class,
|
||||
$this->app['bbcode']
|
||||
);
|
||||
}
|
||||
}
|
||||
376
tests/BBCodeParserTest.php
Normal file
376
tests/BBCodeParserTest.php
Normal file
@@ -0,0 +1,376 @@
|
||||
<?php
|
||||
|
||||
use ivuorinen\BBCode\BBCodeParser;
|
||||
|
||||
class BBCodeParserTest extends TestCase
|
||||
{
|
||||
/** @var \ivuorinen\BBCode\BBCodeParser $parser */
|
||||
private $parser;
|
||||
|
||||
/**
|
||||
* @var array These are harder to test, so we postponed them.
|
||||
*/
|
||||
public $skipParsers = array();
|
||||
|
||||
/**
|
||||
* @see \ivuorinen\BBCode\BBCodeParser::$parsers
|
||||
* @var array Easier to maintain basic tests
|
||||
*/
|
||||
public $testedParsers = array(
|
||||
'bold' => array(
|
||||
'bbcode' => 'b',
|
||||
'expected' => 'strong',
|
||||
),
|
||||
'italic' => array(
|
||||
'bbcode' => 'i',
|
||||
'expected' => 'em',
|
||||
),
|
||||
'underline' => array(
|
||||
'bbcode' => 'u'
|
||||
),
|
||||
'linethrough' => array(
|
||||
'bbcode' => 'u'
|
||||
),
|
||||
'size' => array(
|
||||
'bbcode_test' => '[size=%s]%s[/size]',
|
||||
'expected_test' => '<font size="%s">%s</font>',
|
||||
'values' => ['1', 'text']
|
||||
),
|
||||
'color' => array(
|
||||
'bbcode_test' => '[color=%s]%s[/color]',
|
||||
'expected_test' => '<font color="%s">%s</font>',
|
||||
'values' => ['#123456', 'color']
|
||||
),
|
||||
'center' => array(
|
||||
'bbcode' => 'center',
|
||||
'expected_test' => '<div style="text-align:center;">%s</div>',
|
||||
'values' => ['center aligned']
|
||||
),
|
||||
'left' => array(
|
||||
'bbcode' => 'left',
|
||||
'expected_test' => '<div style="text-align:left;">%s</div>',
|
||||
'values' => ['left aligned']
|
||||
),
|
||||
'right' => array(
|
||||
'bbcode' => 'right',
|
||||
'expected_test' => '<div style="text-align:right;">%s</div>',
|
||||
'values' => ['right aligned']
|
||||
),
|
||||
'quote' => array(
|
||||
'bbcode' => 'quote',
|
||||
'expected_test' => '<blockquote>%s</blockquote>',
|
||||
'values' => ['quotable text']
|
||||
),
|
||||
'namedquote' => array(
|
||||
'bbcode_test' => '[quote=%s]%s[/quote]',
|
||||
'expected_test' => '<blockquote><small>%s</small>%s</blockquote>',
|
||||
'values' => ['name', 'quotable text']
|
||||
),
|
||||
'link' => array(
|
||||
'bbcode' => 'url',
|
||||
'bbcode_test' => '[url]%s[/url]',
|
||||
'expected_test' => '<a href="%1$s">%1$s</a>',
|
||||
'values' => ['value']
|
||||
),
|
||||
'namedlink' => array(
|
||||
'bbcode' => 'url',
|
||||
'bbcode_test' => '[url=%s]%s[/url]',
|
||||
'expected_test' => '<a href="%s">%s</a>',
|
||||
'values' => ['link', 'value']
|
||||
),
|
||||
'image' => array(
|
||||
'bbcode' => 'img',
|
||||
'expected_test' => '<img src="%s">',
|
||||
'values' => ['link']
|
||||
),
|
||||
'linebreak' => array(
|
||||
'bbcode_test' => "\r\n",
|
||||
'expected_test' => '<br />'
|
||||
),
|
||||
'code' => array(
|
||||
'bbcode' => 'code',
|
||||
'values' => ['link']
|
||||
),
|
||||
'youtube' => array(
|
||||
'bbcode' => 'youtube',
|
||||
'expected_test' => '<iframe width="560" height="315" src="//www.youtube.com/embed/%s" frameborder="0" allowfullscreen></iframe>',
|
||||
'values' => ['dQw4w9WgXcQ']
|
||||
),
|
||||
'listitem' => array(
|
||||
'bbcode_test' => "[*] List item",
|
||||
'expected_test' => '<li> List item</li>'
|
||||
),
|
||||
'orderedlistnumerical' => array(
|
||||
'bbcode' => 'list',
|
||||
'bbcode_test' => '[list=1]%s[/list]',
|
||||
'expected_test' => '<ol>%s</ol>',
|
||||
'values' => ['X']
|
||||
),
|
||||
'orderedlistalpha' => array(
|
||||
'bbcode' => 'list',
|
||||
'bbcode_test' => '[list=a]%s[/list]',
|
||||
'expected_test' => '<ol type="a">%s</ol>',
|
||||
'values' => ['X']
|
||||
),
|
||||
'unorderedlist' => array(
|
||||
'bbcode' => 'list',
|
||||
'bbcode_test' => '[list]%s[/list]',
|
||||
'expected_test' => '<ul>%s</ul>',
|
||||
'values' => ['X']
|
||||
),
|
||||
);
|
||||
|
||||
public $lowerCaseTests = array(
|
||||
['bbcode' => '[code]Result[/code]', 'expected' => '<code>Result</code>'],
|
||||
['bbcode' => '[i]Result[/i]', 'expected' => '<em>Result</em>'],
|
||||
);
|
||||
|
||||
public $upperCaseTests = array(
|
||||
['bbcode' => '[CODE]Result[/CODE]', 'expected' => '<code>Result</code>'],
|
||||
['bbcode' => '[I]Result[/I]', 'expected' => '<em>Result</em>'],
|
||||
);
|
||||
|
||||
public $mixedCaseTests = array(
|
||||
['bbcode' => '[Code]Result[/Code]', 'expected' => '<code>Result</code>'],
|
||||
['bbcode' => '[I]Result[/i]', 'expected' => '<em>Result</em>'],
|
||||
);
|
||||
|
||||
protected function setUp()
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->parser = new BBCodeParser();
|
||||
}
|
||||
|
||||
public function test_it_has_known_parsers()
|
||||
{
|
||||
$this->assertEquals(
|
||||
$this->parser->parsers,
|
||||
$this->parser->getParsers()
|
||||
);
|
||||
}
|
||||
|
||||
public function test_parsers_have_required_keys()
|
||||
{
|
||||
$keys = array('pattern', 'replace', 'content');
|
||||
$parsers = $this->parser->getParsers();
|
||||
|
||||
foreach ($parsers as $parserName => $parser) {
|
||||
foreach ($keys as $key) {
|
||||
$this->assertArrayHasKey(
|
||||
$key,
|
||||
$parser,
|
||||
sprintf('Parser: %s, Key: %s', $parserName, $key)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public function test_parser_regexp_is_valid()
|
||||
{
|
||||
$parsers = $this->parser->getParsers();
|
||||
foreach ($parsers as $parserName => $parser) {
|
||||
$pattern = $parser['pattern'];
|
||||
|
||||
$this->assertTrue(
|
||||
$this->assertRegexpIsValid($pattern),
|
||||
sprintf('Key: %s, Regexp %s', $parserName, $pattern)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
public function test_parser_default()
|
||||
{
|
||||
foreach ($this->testedParsers as $name => $options) {
|
||||
$test = $this->createTest($options, $name);
|
||||
|
||||
$result = $this->parser->parse($test['bbcode_test']);
|
||||
$this->assertEquals($test['expected_test'], $result, $name);
|
||||
}
|
||||
}
|
||||
|
||||
public function test_parser_sensitive()
|
||||
{
|
||||
$testTemp = 'Test: %s / bbcode: %s / Actual: %s / Expected: %s';
|
||||
|
||||
/**
|
||||
* We expect these to pass
|
||||
* Using: assertEquals
|
||||
*/
|
||||
foreach ($this->lowerCaseTests as $case) {
|
||||
$bbcode = $case['bbcode'];
|
||||
$expected = $case['expected'];
|
||||
|
||||
$result = $this->parser->parseCaseSensitive($bbcode);
|
||||
$this->assertEquals($expected, $result, sprintf(
|
||||
$testTemp, 'lowercase, sensitive', $bbcode, $result, $expected
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* We expect these to fail
|
||||
* Using: assertNotEquals
|
||||
*/
|
||||
foreach ($this->upperCaseTests as $case) {
|
||||
$bbcode = $case['bbcode'];
|
||||
$expected = $case['expected'];
|
||||
|
||||
$result = $this->parser->parseCaseSensitive($bbcode);
|
||||
$this->assertNotEquals($expected, $result, sprintf(
|
||||
$testTemp, 'uppercase, sensitive', $bbcode, $result, $expected
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* We expect these to fail
|
||||
* Using: assertNotEquals
|
||||
*/
|
||||
foreach ($this->mixedCaseTests as $case) {
|
||||
$bbcode = $case['bbcode'];
|
||||
$expected = $case['expected'];
|
||||
|
||||
$result = $this->parser->parseCaseSensitive($bbcode);
|
||||
$this->assertNotEquals($expected, $result, sprintf(
|
||||
$testTemp, 'mixed case, sensitive', $bbcode, $result, $expected
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
public function test_parser_insensitive()
|
||||
{
|
||||
/**
|
||||
* Now we run with insensitive case turned on, so everything
|
||||
* should pass -- why this is not the default in original
|
||||
* package baffles me.
|
||||
*/
|
||||
$cases = array_merge(
|
||||
$this->lowerCaseTests,
|
||||
$this->upperCaseTests,
|
||||
$this->mixedCaseTests
|
||||
);
|
||||
|
||||
foreach ($cases as $case) {
|
||||
$bbcode = $case['bbcode'];
|
||||
$expected = $case['expected'];
|
||||
$this->assertEquals(
|
||||
$expected, $this->parser->parse($bbcode, true)
|
||||
);
|
||||
|
||||
$this->assertEquals(
|
||||
$expected,
|
||||
$this->parser->parseCaseInsensitive($bbcode)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
public function test_stripBBCodeTags()
|
||||
{
|
||||
foreach ($this->mixedCaseTests as $test) {
|
||||
$this->assertEquals(
|
||||
\strip_tags($test['expected']),
|
||||
$this->parser->stripBBCodeTags($test['bbcode'])
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
public function test_only()
|
||||
{
|
||||
$keys = array('bold', 'underline');
|
||||
|
||||
$parsers = $this->parser->getParsers();
|
||||
$onlyFew = $this->parser->only($keys)->getParsers();
|
||||
|
||||
$this->assertEquals($keys, array_keys($onlyFew));
|
||||
$this->assertNotEquals(array_keys($parsers), array_keys($onlyFew));
|
||||
}
|
||||
|
||||
public function test_except()
|
||||
{
|
||||
$keys = array('bold', 'underline');
|
||||
|
||||
$parsers = $this->parser->getParsers();
|
||||
$exceptFew = $this->parser->except($keys)->getParsers();
|
||||
|
||||
$this->assertNotEquals($keys, array_keys($exceptFew));
|
||||
$this->assertNotEquals(array_keys($parsers), array_keys($exceptFew));
|
||||
}
|
||||
|
||||
public function test_adding_a_new_parser()
|
||||
{
|
||||
$this->parser->setParser('test', 'x', 'y', 'z');
|
||||
$expected = array('pattern' => 'x', 'replace' => 'y', 'content' => 'z');
|
||||
$parsers = $this->parser->getParsers();
|
||||
|
||||
$this->assertArrayHasKey('test', $parsers);
|
||||
$this->assertArraySubset($expected, $parsers['test']);
|
||||
}
|
||||
|
||||
public function test_we_have_all_parsers_tested()
|
||||
{
|
||||
$parsers = array_keys($this->parser->except($this->skipParsers)->getParsers());
|
||||
$missing = array();
|
||||
|
||||
foreach ($parsers as $parser) {
|
||||
$result = isset($this->testedParsers[$parser]);
|
||||
|
||||
if ($result) {
|
||||
$this->assertTrue($result, sprintf('Parser missing: %s', $parser));
|
||||
}
|
||||
|
||||
if (!$result) {
|
||||
$missing[$parser] = $parser;
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($missing)) {
|
||||
$missing = sprintf(
|
||||
'Missing tests: %s',
|
||||
implode(", ", $missing)
|
||||
);
|
||||
$this->markTestIncomplete($missing);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This is a helper to use our self::testedParsers
|
||||
* rules for automated test generation. Automation ftw.
|
||||
*
|
||||
* @param array $options
|
||||
* @param $name
|
||||
* @return array
|
||||
*/
|
||||
public function createTest($options = [], $name)
|
||||
{
|
||||
if (!isset($options['bbcode'])) {
|
||||
$options['bbcode'] = $name;
|
||||
}
|
||||
|
||||
if (!isset($options['values']) || empty($options['values'])) {
|
||||
$options['values'] = ['Testing'];
|
||||
}
|
||||
|
||||
if (!isset($options['bbcode_test'])) {
|
||||
$bbcodeValues = $options['values'];
|
||||
array_unshift($bbcodeValues, $options['bbcode']);
|
||||
array_push($bbcodeValues, $options['bbcode']);
|
||||
$options['bbcode_test'] = vsprintf('[%s]%s[/%s]', $bbcodeValues);
|
||||
} else {
|
||||
$options['bbcode_test'] = vsprintf($options['bbcode_test'], $options['values']);
|
||||
}
|
||||
|
||||
if (!isset($options['expected'])) {
|
||||
$options['expected'] = $options['bbcode'];
|
||||
}
|
||||
|
||||
if (!isset($options['expected_test'])) {
|
||||
$expectedValues = $options['values'];
|
||||
array_unshift($expectedValues, $options['expected']);
|
||||
array_push($expectedValues, $options['expected']);
|
||||
$options['expected_test'] = vsprintf('<%s>%s</%s>', $expectedValues);
|
||||
} else {
|
||||
$options['expected_test'] = vsprintf($options['expected_test'], $options['values']);
|
||||
}
|
||||
|
||||
return $options;
|
||||
}
|
||||
}
|
||||
21
tests/TestCase.php
Normal file
21
tests/TestCase.php
Normal file
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
class TestCase extends Orchestra\Testbench\TestCase
|
||||
{
|
||||
protected function getPackageProviders($app)
|
||||
{
|
||||
return ['ivuorinen\BBCode\BBCodeParserServiceProvider'];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $pattern
|
||||
* @return bool
|
||||
*/
|
||||
protected function assertRegexpIsValid($pattern = '')
|
||||
{
|
||||
if (@preg_match($pattern, null) === false) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user