joshtronic/php-loremipsum
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat: ensure passed tags are strings

Browse source 
Newer versions of PHP raise a warning if you attempt to use array syntax
against non-strings / non-arrays. Added sanity check to ensure we're
working with a string, otherwise skip it.

Also added in PHP 8.1 to the testing suite and bumped the copyright.

Bumped version to 2.0 since as the change in expected output is a
breaking change.
This commit is contained in:
Josh Sherman 2022-01-04 21:06:55 -06:00
parent ae53465dad
commit c5b9becc0d
No known key found for this signature in database
GPG key ID: 55B058A80530EF22
5 changed files with 23 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

4
.github/workflows/test.yml vendored
View file

@ -6,7 +6,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
php-version: ['5.3', '5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0'] php-version: ['5.3', '5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1']
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v2
@ -23,7 +23,7 @@ jobs:
- name: Run Tests - name: Run Tests
run: vendor/bin/phpunit --coverage-clover ./coverage.xml run: vendor/bin/phpunit --coverage-clover ./coverage.xml
- name: Upload Coverage - name: Upload Coverage
if: ${{ matrix.php-version == '7.4' }} if: ${{ matrix.php-version == '8.1' }}
uses: codecov/codecov-action@v1 uses: codecov/codecov-action@v1
with: with:
file: ./coverage.xml file: ./coverage.xml

2
LICENSE
View file

@ -1,6 +1,6 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2014, 2015, 2016, 2017, 2018, 2019, 2020 Josh Sherman Copyright (c) 2014-2022 Josh Sherman
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

2
composer.json
View file

@ -1,7 +1,7 @@
{ {
"name": "joshtronic/php-loremipsum", "name": "joshtronic/php-loremipsum",
"description": "Lorem ipsum generator in PHP without dependencies", "description": "Lorem ipsum generator in PHP without dependencies",
"version": "1.0.6", "version": "2.0.0",
"type": "library", "type": "library",
"keywords": [ "keywords": [
"lorem", "lorem",

14
src/LoremIpsum.php
View file

@ -9,7 +9,7 @@
* Redistribution of these files must retain the above copyright notice. * Redistribution of these files must retain the above copyright notice.
* *
* @author Josh Sherman <hello@joshtronic.com> * @author Josh Sherman <hello@joshtronic.com>
* @copyright Copyright 2014, 2015, 2016, 2017, 2018, 2019, 2020 Josh Sherman * @copyright Copyright 2014-2022 Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html * @license http://www.opensource.org/licenses/mit-license.html
* @link https://github.com/joshtronic/php-loremipsum * @link https://github.com/joshtronic/php-loremipsum
*/ */
@ -351,11 +351,13 @@ class LoremIpsum
foreach ($strings as $key => $string) { foreach ($strings as $key => $string) {
foreach ($tags as $tag) { foreach ($tags as $tag) {
// Detects / applies back reference if (is_string($tag)) {
if ($tag[0] == '<') { // Detects / applies back reference
$string = str_replace('$1', $string, $tag); if ($tag[0] == '<') {
} else { $string = str_replace('$1', $string, $tag);
$string = sprintf('<%1$s>%2$s</%1$s>', $tag, $string); } else {
$string = sprintf('<%1$s>%2$s</%1$s>', $tag, $string);
}
} }
$strings[$key] = $string; $strings[$key] = $string;

11
tests/LoremIpsumTest.php
View file

@ -183,5 +183,16 @@ class LoremIpsumTest extends TestCase
$this->$assertRegExp('/^<li>[a-z]+<\/li>$/i', $word); $this->$assertRegExp('/^<li>[a-z]+<\/li>$/i', $word);
} }
} }
/**
* @depends testAssertRegExp
*/
public function testSkipNonStringTag($assertRegExp)
{
$lipsum = new LoremIpsum();
$this->$assertRegExp('/^[a-z]+$/i', $lipsum->word(123));
$this->$assertRegExp('/^[a-z]+$/i', $lipsum->word(array(1, 2, 3)));
$this->$assertRegExp('/^[a-z]+$/i', $lipsum->word(true));
}
} }