chore: bump version

Remove phpstan from dependancies - want to keep this compatible with php 7.0 as per github build steps
Refactors to satisfy phpstan level 8
2022-01-23 17:27:44 -06:00 · 2022-01-23 17:26:15 -06:00 · 2022-01-23 17:26:15 -06:00 · 2022-01-23 17:26:15 -06:00 · 2022-01-23 17:26:15 -06:00 · 2022-01-04 22:01:25 -06:00
13 changed files with 358 additions and 259 deletions
--- a/.coveralls.yml
+++ b/.coveralls.yml
@ -1 +0,0 @@
-service_name: travis-ci
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@ -0,0 +1,29 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  test:
+    name: Test PHP ${{ matrix.php-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        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:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-version }}
+    - name: PHP Version
+      run: php --version
+    - name: Composer Version
+      run: composer --version
+    - name: Install Dependencies
+      run: COMPOSER_MEMORY_LIMIT=-1 composer install
+    - name: Run Tests
+      run: vendor/bin/phpunit --coverage-clover ./coverage.xml
+    - name: Upload Coverage
+      if: ${{ matrix.php-version == '8.1' }}
+      uses: codecov/codecov-action@v1
+      with:
+        file: ./coverage.xml
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1,4 @@
+composer.lock
+composer.phar
+.phpunit.result.cache
+/vendor/
--- a/.travis.yml
+++ b/.travis.yml
@ -1,26 +0,0 @@
-language: php
-
-php:
-  - 5.3
-  - 5.4
-  - 5.5
-  - 5.6
-  - hhvm
-
-matrix:
-  allow_failures:
-    - php: 5.6
-    - php: hhvm
-
-install:
-  - composer install
-
-before_script:
-  - mkdir -p build/logs
-  - cd tests
-
-script:
-  - phpunit --colors --coverage-clover /home/travis/build/joshtronic/php-loremipsum/build/logs/clover.xml .
-
-after_success:
-  - php ../vendor/bin/coveralls --config ../.coveralls.yml -v
--- a/FUNDING.yml
+++ b/FUNDING.yml
@ -0,0 +1 @@
+github: joshtronic
--- a/2
+++ b/2
@ -1,6 +1,6 @@
 The MIT License (MIT)

-Copyright (c) 2014 Josh Sherman
+Copyright (c) 2014-2022 Josh Sherman

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
--- a/README.md
+++ b/README.md
@ -1,53 +1,25 @@
 # php-loremipsum

-[![Build Status](http://img.shields.io/travis/joshtronic/php-loremipsum.svg?style=flat)][travis]
-[![Coverage Status](http://img.shields.io/coveralls/joshtronic/php-loremipsum.svg?style=flat)][coveralls]
-[![Downloads](http://img.shields.io/packagist/dt/joshtronic/php-loremipsum.svg?style=flat)][packagist]
-[![Gittip](http://img.shields.io/gittip/joshtronic.svg?style=flat)][gittip]
+[![License](https://img.shields.io/packagist/l/joshtronic/php-loremipsum?style=for-the-badge)](https://github.com/joshtronic/php-loremipsum/blob/master/LICENSE)
+![PHP Version](https://img.shields.io/packagist/php-v/joshtronic/php-loremipsum?style=for-the-badge)
+[![Test Status](https://img.shields.io/github/workflow/status/joshtronic/php-loremipsum/Test?style=for-the-badge)](https://github.com/joshtronic/php-loremipsum/actions)
+[![Code Coverage](https://img.shields.io/codecov/c/github/joshtronic/php-loremipsum?style=for-the-badge)](https://codecov.io/gh/joshtronic/php-loremipsum)
+[![Monthly Downloads](https://img.shields.io/packagist/dm/joshtronic/php-loremipsum?style=for-the-badge)](https://packagist.org/packages/joshtronic/php-loremipsum)

-[travis]:    http://travis-ci.org/joshtronic/php-loremipsum
-[coveralls]: https://coveralls.io/r/joshtronic/php-loremipsum
-[packagist]: https://packagist.org/packages/joshtronic/php-loremipsum
-[gittip]:    https://www.gittip.com/joshtronic/
-
-Lorem ipsum generator in PHP without dependencies. Compatible with PHP 5.3+ as
-well as HHVM.
-
-## Origins
-
-Once upon a time, I was attempting to find a lorem ipsum generator over on
-[Packagist](https://packagist.org/search/?q=lorem%20ipsum). I was presented
-with many options, and some of those options were good. Unfortunately, the
-bulk of those options depended on Symphony or the Zend Framework. This
-wouldn’t have been a big deal but under the circumstances, I wanted something
-that was not tightly coupled to these frameworks because I wanted to use the
-generator in my _own_ framework.
-
-I had decided to use
-[badcow/lorem-ipsum](https://packagist.org/packages/badcow/lorem-ipsum)
-because it did not have any dependencies nor did it rely on any external APIs.
-As I started to use the library, I found that I was going to have to fight
-with it to get it to do what I wanted. After digging through the code, I
-realized that I was going to end up gutting most of it to bend it to my will.
-I know when you overhaul someone’s code the liklihood of them accepting a pull
-request goes down dramatically, hence building this library while taking cues
-from it’s predecessor.
-
-Also, the aforementioned package had a bunch of “setter” and “getter” methods
-that were grossing me out :scream:
+Lorem ipsum generator in PHP without dependencies. Compatible with PHP 5.3+.

 ## Installation

-The preferred installation method is via `composer`. First add the following
-to your `composer.json`
+The preferred installation method is via `composer`. First add the following to
+your `composer.json`:

 ```json
 "require": {
-    "joshtronic/php-loremipsum": "1.0.*"
+    "joshtronic/php-loremipsum": "dev-master"
 }
 ```

-Then run `composer update`
+Then run `composer update`.

 ## Usage

@ -64,21 +36,21 @@ echo '1 word: '  . $lipsum->word();
 echo '5 words: ' . $lipsum->words(5);
 ```

-### Generating sentences
+### Generating Sentences

 ```php
 echo '1 sentence: '  . $lipsum->sentence();
 echo '5 sentences: ' . $lipsum->sentences(5);
 ```

-### Generating paragraphs
+### Generating Paragraphs

 ```php
 echo '1 paragraph: '  . $lipsum->paragraph();
 echo '5 paragraphs: ' . $lipsum->paragraphs(5);
 ```

-### Wrapping text with HTML tags
+### Wrapping Text with HTML Tags

 If you would like to wrap the generated text with a tag, pass it as the second
 parameter:
@ -105,7 +77,7 @@ echo $lipsum->words(3, '<li><a href="$1">$1</a></li>');
 // Generates: <li><a href="...">...</a></li><li><a href="...">...</a></li><li><a href="...">...</a></li>
 ```

-### Return as an array
+### Return as an Array

 Perhaps you want an array instead of a string:

@ -118,21 +90,30 @@ print_r($lipsum->paragraphsArray(5));
 You can still wrap with markup when returning an array:

 ```php
-print_r($lipsum->wordsArray(5), 'li');
+print_r($lipsum->wordsArray(5, 'li'));
 ```

 ## Assumptions

-Instead of having an option as to whether or not a string should start the
-generated output with “Lorem ipsum dolor sit amet, consectetur adipiscing
-elit.” a few assumptions are baked in. The first string generated will always
-start with the traditional “Lorem ipsum…”. Subsequent strings may contain
+The first string generated will always start with the traditional "Lorem ipsum
+dolor sit amet, consectetur adipiscing elit". Subsequent strings may contain
 those words but will not explicitly start with them.

 ## Contributing

-Suggestions and bug reports are always welcome, but karma points are earned
-for pull requests.
+Suggestions and bug reports are always welcome, but karma points are earned for
+pull requests.

-Unit tests are required for all contributions. You can run the test suite
-from the `tests` directory simply by running `phpunit .`
+Unit tests are required for all contributions. You can run the test suite from
+the project's root directory simply by running `phpunit`.
+
+## Credits
+
+`php-loremipsum` was originally inspired by
+[badcow/lorem-ipsum](https://packagist.org/packages/badcow/lorem-ipsum) with a
+goal of being a dependency free lorem ipsum generator with flexible generation
+options.
+
+## License
+
+MIT
--- a/codecov.yml
+++ b/codecov.yml
@ -0,0 +1,20 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "reach,diff,flags,tree"
+  behavior: default
+  require_changes: no
--- a/composer.json
+++ b/composer.json
@ -1,23 +1,34 @@
 {
    "name": "joshtronic/php-loremipsum",
    "description": "Lorem ipsum generator in PHP without dependencies",
-    "version":     "1.0.0",
+    "version": "2.1.0",
    "type": "library",
-    "keywords":    ["lorem", "ipsum", "generator"],
+    "keywords": [
+      "lorem",
+      "ipsum",
+      "generator"
+    ],
    "homepage": "https://github.com/joshtronic/php-loremipsum",
    "license": "MIT",
    "authors": [{
      "name": "Josh Sherman",
-        "email":    "josh@gravityblvd.com",
-        "homepage": "http://joshtronic.com"
+      "email": "hello@joshtronic.com",
+      "homepage": "https://joshtronic.com"
    }],
    "require": {
-        "php": ">=5.3.0"
+      "php": ">=5.3"
    },
    "require-dev": {
-        "satooshi/php-coveralls": "dev-master"
+      "phpunit/phpunit": "^4.8.36 || ^9.0"
    },
    "autoload": {
-        "psr-4": {"joshtronic\\": "src/"}
+      "psr-4": {
+        "joshtronic\\": "src/"
+      }
+    },
+    "autoload-dev": {
+      "psr-4": {
+        "joshtronic\\Tests\\": "tests/"
+      }
    }
  }
--- a/phpstan.neon
+++ b/phpstan.neon
@ -0,0 +1,14 @@
+parameters:
+
+    paths:
+        - src
+
+    # The level 8 is the highest level
+    level: max
+
+    excludePaths:
+        - ./*/*/FileToBeExcluded.php
+
+    checkMissingIterableValueType: true
+
+    #editorUrl: 'vscode://file/%%file%%:%%line%%'
--- a/phpunit.xml
+++ b/phpunit.xml
@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+  bootstrap="vendor/autoload.php"
+  colors="true"
+  convertErrorsToExceptions="true"
+  convertNoticesToExceptions="true"
+  convertWarningsToExceptions="true"
+  failOnRisky="true"
+  stopOnError="true"
+  stopOnFailure="true"
+  stopOnIncomplete="true"
+  verbose="true"
+>
+  <testsuites>
+    <testsuite name="Lorem Ipsum">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <filter>
+    <whitelist addUncoveredFilesFromWhitelist="true">
+      <directory>./src</directory>
+    </whitelist>
+  </filter>
+</phpunit>
--- a/src/LoremIpsum.php
+++ b/src/LoremIpsum.php
@ -8,8 +8,8 @@
 * Licensed under The MIT License.
 * Redistribution of these files must retain the above copyright notice.
 *
- * @author    Josh Sherman <josh@gravityblvd.com>
- * @copyright Copyright 2014, Josh Sherman
+ * @author    Josh Sherman <hello@joshtronic.com>
+ * @copyright Copyright 2014-2022 Josh Sherman
 * @license   http://www.opensource.org/licenses/mit-license.html
 * @link      https://github.com/joshtronic/php-loremipsum
 */
@ -24,7 +24,7 @@ class LoremIpsum
     * Whether or not we should be starting the string with "Lorem ipsum..."
     *
     * @access private
-     * @var    boolean
+     * @var    mixed
     */
    private $first = true;

@ -35,57 +35,41 @@ class LoremIpsum
     * a complete list exists and if so, where to get it.
     *
     * @access private
-     * @var    array
+     * @var    array<string>
     */
-    public $words = array(
+    private $words = array(
        // Lorem ipsum...
-        'lorem',        'ipsum',       'dolor',        'sit',
-        'amet',         'consectetur', 'adipiscing',   'elit',
-        // The rest of the vocabulary
-        'a',            'ac',          'accumsan',     'ad',
-        'aenean',       'aliquam',     'aliquet',      'ante',
-        'aptent',       'arcu',        'at',           'auctor',
-        'augue',        'bibendum',    'blandit',      'class',
-        'commodo',      'condimentum', 'congue',       'consequat',
-        'conubia',      'convallis',   'cras',         'cubilia',
-        'cum',          'curabitur',   'curae',        'cursus',
-        'dapibus',      'diam',        'dictum',       'dictumst',
-        'dignissim',    'dis',         'donec',        'dui',
-        'duis',         'egestas',     'eget',         'eleifend',
-        'elementum',    'enim',        'erat',         'eros',
-        'est',          'et',          'etiam',        'eu',
-        'euismod',      'facilisi',    'facilisis',    'fames',
-        'faucibus',     'felis',       'fermentum',    'feugiat',
-        'fringilla',    'fusce',       'gravida',      'habitant',
-        'habitasse',    'hac',         'hendrerit',    'himenaeos',
-        'iaculis',      'id',          'imperdiet',    'in',
-        'inceptos',     'integer',     'interdum',     'justo',
-        'lacinia',      'lacus',       'laoreet',      'lectus',
-        'leo',          'libero',      'ligula',       'litora',
-        'lobortis',     'luctus',      'maecenas',     'magna',
-        'magnis',       'malesuada',   'massa',        'mattis',
-        'mauris',       'metus',       'mi',           'molestie',
-        'mollis',       'montes',      'morbi',        'mus',
-        'nam',          'nascetur',    'natoque',      'nec',
-        'neque',        'netus',       'nibh',         'nisi',
-        'nisl',         'non',         'nostra',       'nulla',
-        'nullam',       'nunc',        'odio',         'orci',
-        'ornare',       'parturient',  'pellentesque', 'penatibus',
-        'per',          'pharetra',    'phasellus',    'placerat',
-        'platea',       'porta',       'porttitor',    'posuere',
-        'potenti',      'praesent',    'pretium',      'primis',
-        'proin',        'pulvinar',    'purus',        'quam',
-        'quis',         'quisque',     'rhoncus',      'ridiculus',
-        'risus',        'rutrum',      'sagittis',     'sapien',
-        'scelerisque',  'sed',         'sem',          'semper',
-        'senectus',     'sociis',      'sociosqu',     'sodales',
-        'sollicitudin', 'suscipit',    'suspendisse',  'taciti',
-        'tellus',       'tempor',      'tempus',       'tincidunt',
-        'torquent',     'tortor',      'tristique',    'turpis',
-        'ullamcorper',  'ultrices',    'ultricies',    'urna',
-        'ut',           'varius',      'vehicula',     'vel',
-        'velit',        'venenatis',   'vestibulum',   'vitae',
-        'vivamus',      'viverra',     'volutpat',     'vulputate',
+        'lorem', 'ipsum', 'dolor', 'sit', 'amet', 'consectetur', 'adipiscing', 'elit',
+
+        // and the rest of the vocabulary
+        'a', 'ac', 'accumsan', 'ad', 'aenean', 'aliquam', 'aliquet', 'ante',
+        'aptent', 'arcu', 'at', 'auctor', 'augue', 'bibendum', 'blandit',
+        'class', 'commodo', 'condimentum', 'congue', 'consequat', 'conubia',
+        'convallis', 'cras', 'cubilia', 'curabitur', 'curae', 'cursus',
+        'dapibus', 'diam', 'dictum', 'dictumst', 'dignissim', 'dis', 'donec',
+        'dui', 'duis', 'efficitur', 'egestas', 'eget', 'eleifend', 'elementum',
+        'enim', 'erat', 'eros', 'est', 'et', 'etiam', 'eu', 'euismod', 'ex',
+        'facilisi', 'facilisis', 'fames', 'faucibus', 'felis', 'fermentum',
+        'feugiat', 'finibus', 'fringilla', 'fusce', 'gravida', 'habitant',
+        'habitasse', 'hac', 'hendrerit', 'himenaeos', 'iaculis', 'id',
+        'imperdiet', 'in', 'inceptos', 'integer', 'interdum', 'justo',
+        'lacinia', 'lacus', 'laoreet', 'lectus', 'leo', 'libero', 'ligula',
+        'litora', 'lobortis', 'luctus', 'maecenas', 'magna', 'magnis',
+        'malesuada', 'massa', 'mattis', 'mauris', 'maximus', 'metus', 'mi',
+        'molestie', 'mollis', 'montes', 'morbi', 'mus', 'nam', 'nascetur',
+        'natoque', 'nec', 'neque', 'netus', 'nibh', 'nisi', 'nisl', 'non',
+        'nostra', 'nulla', 'nullam', 'nunc', 'odio', 'orci', 'ornare',
+        'parturient', 'pellentesque', 'penatibus', 'per', 'pharetra',
+        'phasellus', 'placerat', 'platea', 'porta', 'porttitor', 'posuere',
+        'potenti', 'praesent', 'pretium', 'primis', 'proin', 'pulvinar',
+        'purus', 'quam', 'quis', 'quisque', 'rhoncus', 'ridiculus', 'risus',
+        'rutrum', 'sagittis', 'sapien', 'scelerisque', 'sed', 'sem', 'semper',
+        'senectus', 'sociosqu', 'sodales', 'sollicitudin', 'suscipit',
+        'suspendisse', 'taciti', 'tellus', 'tempor', 'tempus', 'tincidunt',
+        'torquent', 'tortor', 'tristique', 'turpis', 'ullamcorper', 'ultrices',
+        'ultricies', 'urna', 'ut', 'varius', 'vehicula', 'vel', 'velit',
+        'venenatis', 'vestibulum', 'vitae', 'vivamus', 'viverra', 'volutpat',
+        'vulputate',
    );

    /**
@ -99,7 +83,7 @@ class LoremIpsum
     */
    public function word($tags = false)
    {
-        return $this->words(1, $tags);
+        return strval($this->words(1, $tags));
    }

    /**
@ -110,7 +94,7 @@ class LoremIpsum
     * @access public
     * @param  integer $count how many words to generate
     * @param  mixed   $tags string or array of HTML tags to wrap output with
-     * @return array   generated lorem ipsum words
+     * @return mixed  generated lorem ipsum words
     */
    public function wordsArray($count = 1, $tags = false)
    {
@ -130,23 +114,21 @@ class LoremIpsum
     */
    public function words($count = 1, $tags = false, $array = false)
    {
+        $count      = (int) $count;
        $words      = array();
        $word_count = 0;

        // Shuffles and appends the word list to compensate for count
        // arguments that exceed the size of our vocabulary list
-        while ($word_count < $count)
-        {
+        while ($word_count < $count) {
            $shuffle = true;

-            while ($shuffle)
-            {
+            while ($shuffle) {
                $this->shuffle();

                // Checks that the last word of the list and the first word of
                // the list that's about to be appended are not the same
-                if (!$word_count || $words[$word_count - 1] != $this->words[0])
-                {
+                if (!$word_count || $words[$word_count - 1] != $this->words[0]) {
                    $words      = array_merge($words, $this->words);
                    $word_count = count($words);
                    $shuffle    = false;
@ -170,7 +152,7 @@ class LoremIpsum
     */
    public function sentence($tags = false)
    {
-        return $this->sentences(1, $tags);
+        return strval($this->sentences(1, $tags));
    }

    /**
@ -181,7 +163,7 @@ class LoremIpsum
     * @access public
     * @param  integer $count how many sentences to generate
     * @param  mixed   $tags string or array of HTML tags to wrap output with
-     * @return array   generated lorem ipsum sentences
+     * @return mixed   generated lorem ipsum sentences
     */
    public function sentencesArray($count = 1, $tags = false)
    {
@ -203,8 +185,7 @@ class LoremIpsum
    {
        $sentences = array();

-        for ($i = 0; $i < $count; $i++)
-        {
+        for ($i = 0; $i < $count; $i++) {
            $sentences[] = $this->wordsArray($this->gauss(24.46, 5.08));
        }

@ -224,7 +205,7 @@ class LoremIpsum
     */
    public function paragraph($tags = false)
    {
-        return $this->paragraphs(1, $tags);
+        return strval($this->paragraphs(1, $tags));
    }

    /**
@ -235,15 +216,18 @@ class LoremIpsum
     * @access public
     * @param  integer $count how many paragraphs to generate
     * @param  mixed   $tags string or array of HTML tags to wrap output with
-     * @return array   generated lorem ipsum paragraphs
+     * @return array<string>   generated lorem ipsum paragraphs
     */
    public function paragraphsArray($count = 1, $tags = false)
    {
+        // The $array parameter set to true means an array is returned.
+        // Return type is mixed, we should probably cast to array.
+        // @phpstan-ignore-next-line
        return $this->paragraphs($count, $tags, true);
    }

    /**
-     * Paragraphss
+     * Paragraphs
     *
     * Generates paragraphs of lorem ipsum.
     *
@ -257,13 +241,15 @@ class LoremIpsum
    {
        $paragraphs = array();

-        for ($i = 0; $i < $count; $i++)
-        {
-            $paragraphs[] = $this->sentences($this->gauss(5.8, 1.93));
+        for ($i = 0; $i < $count; $i++) {
+            $paragraphs[] = strval($this->sentences($this->gauss(5.8, 1.93)));
        }

+        if ($array) {
            return $this->output($paragraphs, $tags, $array, "\n\n");
        }
+        return strval($this->output($paragraphs, $tags, false, "\n\n"));
+    }

    /**
     * Gaussian Distribution
@ -276,7 +262,7 @@ class LoremIpsum
     * @access private
     * @param  double  $mean average value
     * @param  double  $std_dev stadnard deviation
-     * @return double  calculated distribution
+     * @return int  calculated distribution
     */
    private function gauss($mean, $std_dev)
    {
@ -284,7 +270,7 @@ class LoremIpsum
        $y = mt_rand() / mt_getrandmax();
        $z = sqrt(-2 * log($x)) * cos(2 * pi() * $y);

-        return $z * $std_dev + $mean;
+        return intval($z * $std_dev + $mean);
    }

    /**
@ -294,11 +280,11 @@ class LoremIpsum
     * the first time we are generating the text.
     *
     * @access private
+     * @return void
     */
    private function shuffle()
    {
-        if ($this->first)
-        {
+        if ($this->first) {
            $this->first = array_slice($this->words, 0, 8);
            $this->words = array_slice($this->words, 8);

@ -307,9 +293,7 @@ class LoremIpsum
            $this->words = $this->first + $this->words;

            $this->first = false;
-        }
-        else
-        {
+        } else {
            shuffle($this->words);
        }
    }
@ -322,27 +306,23 @@ class LoremIpsum
     * first word of the sentence.
     *
     * @access private
-     * @param  array   $sentences the sentences we would like to punctuate
+     * @param  array<string>   $sentences the sentences we would like to punctuate
+     * @return void
     */
    private function punctuate(&$sentences)
    {
-        foreach ($sentences as $key => $sentence)
-        {
+        foreach ($sentences as $key => $sentence) {
            $words = count($sentence);
-
            // Only worry about commas on sentences longer than 4 words
-            if ($words > 4)
-            {
+            if ($words > 4) {
                $mean    = log($words, 6);
                $std_dev = $mean / 6;
-                $commas  = round($this->gauss($mean, $std_dev));
+                $commas  = $this->gauss($mean, $std_dev);

-                for ($i = 1; $i <= $commas; $i++)
-                {
+                for ($i = 1; $i <= $commas; $i++) {
                    $word = round($i * $words / ($commas + 1));

-                    if ($word < ($words - 1) && $word > 0)
-                    {
+                    if ($word < ($words - 1) && $word > 0) {
                        $sentence[$word] .= ',';
                    }
                }
@ -361,7 +341,7 @@ class LoremIpsum
     * into a string or not.
     *
     * @access private
-     * @param  array   $strings an array of generated strings
+     * @param  array<string>   $strings an array of generated strings
     * @param  mixed   $tags string or array of HTML tags to wrap output with
     * @param  boolean $array whether an array or a string should be returned
     * @param  string  $delimiter the string to use when calling implode()
@ -369,43 +349,34 @@ class LoremIpsum
     */
    private function output($strings, $tags, $array, $delimiter = ' ')
    {
-        if ($tags)
-        {
-            if (!is_array($tags))
-            {
+        if ($tags) {
+            if (!is_array($tags)) {
                $tags = array($tags);
-            }
-            else
-            {
+            } else {
                // Flips the array so we can work from the inside out
                $tags = array_reverse($tags);
            }

-            foreach ($strings as $key => $string)
-            {
-                foreach ($tags as $tag)
-                {
+            foreach ($strings as $key => $string) {
+                foreach ($tags as $tag) {
+                    if (is_string($tag)) {
                        // Detects / applies back reference
-                    if ($tag[0] == '<')
-                    {
+                        if ($tag[0] == '<') {
                            $string = str_replace('$1', $string, $tag);
-                    }
-                    else
-                    {
+                        } else {
                            $string = sprintf('<%1$s>%2$s</%1$s>', $tag, $string);
                        }
+                    }

                    $strings[$key] = $string;
                }
            }
        }

-        if (!$array)
-        {
+        if (!$array) {
            $strings = implode($delimiter, $strings);
        }

        return $strings;
    }
 }
-
--- a/tests/LoremIpsumTest.php
+++ b/tests/LoremIpsumTest.php
@ -1,127 +1,198 @@
 <?php
+namespace joshtronic\Tests;
+use joshtronic\LoremIpsum;
+use PHPUnit\Framework\TestCase;

-require_once '../src/LoremIpsum.php';
-
-class LoremIpsumTest extends PHPUnit_Framework_TestCase
+class LoremIpsumTest extends TestCase
 {
-    private $lipsum;
-
-    public function setUp()
-    {
-        $this->lipsum = new joshtronic\LoremIpsum();
+    /**
+     * @doesNotPerformAssertions
+     */
+    public function testAssertRegExp() {
+        if (version_compare(PHP_VERSION, '7.3.0', '>=')) {
+            return 'assertMatchesRegularExpression';
        }

-    public function testWord()
-    {
-        $this->assertRegExp('/^[a-z]+$/i', $this->lipsum->word());
+        return 'assertRegExp';
    }

-    public function testWords()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testWord($assertRegExp)
    {
-        $this->assertRegExp(
+        $lipsum = new LoremIpsum();
+        $this->$assertRegExp('/^[a-z]+$/i', $lipsum->word());
+    }
+
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testWords($assertRegExp)
+    {
+        $lipsum = new LoremIpsum();
+        $this->$assertRegExp(
            '/^[a-z]+ [a-z]+ [a-z]+$/i',
-            $this->lipsum->words(3)
+            $lipsum->words(3)
        );
    }

-    public function testWordsArray()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testWordsArray($assertRegExp)
    {
-        $words = $this->lipsum->wordsArray(3);
+        $lipsum = new LoremIpsum();
+        $words = $lipsum->wordsArray(3);
        $this->assertTrue(is_array($words));
        $this->assertCount(3, $words);

-        foreach ($words as $word)
-        {
-            $this->assertRegExp('/^[a-z]+$/i', $word);
+        foreach ($words as $word) {
+            $this->$assertRegExp('/^[a-z]+$/i', $word);
        }
    }

-    public function testWordsExceedingVocab()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testWordsExceedingVocab($assertRegExp)
    {
-        $this->assertCount(500, $this->lipsum->wordsArray(500));
+        $lipsum = new LoremIpsum();
+        $this->assertCount(500, $lipsum->wordsArray(500));
    }

-    public function testSentence()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testSentence($assertRegExp)
    {
-        $this->assertRegExp('/^[a-z, ]+\.$/i', $this->lipsum->sentence());
+        $lipsum = new LoremIpsum();
+        $this->$assertRegExp('/^[a-z, ]+\.$/i', $lipsum->sentence());
    }

-    public function testSentences()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testSentences($assertRegExp)
    {
-        $this->assertRegExp('/^[a-z, ]+\. [a-z, ]+\. [a-z, ]+\.$/i', $this->lipsum->sentences(3));
+        $lipsum = new LoremIpsum();
+        $this->$assertRegExp(
+            '/^[a-z, ]+\. [a-z, ]+\. [a-z, ]+\.$/i',
+            $lipsum->sentences(3)
+        );
    }

-    public function testSentencesArray()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testSentencesArray($assertRegExp)
    {
-        $sentences = $this->lipsum->sentencesArray(3);
+        $lipsum = new LoremIpsum();
+        $sentences = $lipsum->sentencesArray(3);
        $this->assertTrue(is_array($sentences));
        $this->assertCount(3, $sentences);

-        foreach ($sentences as $sentence)
-        {
-            $this->assertRegExp('/^[a-z, ]+\.$/i', $sentence);
+        foreach ($sentences as $sentence) {
+            $this->$assertRegExp('/^[a-z, ]+\.$/i', $sentence);
        }
    }

-    public function testParagraph()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testParagraph($assertRegExp)
    {
-        $this->assertRegExp('/^([a-z, ]+\.)+$/i', $this->lipsum->paragraph());
+        $lipsum = new LoremIpsum();
+        $this->$assertRegExp('/^([a-z, ]+\.)+$/i', $lipsum->paragraph());
    }

-    public function testParagraphs()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testParagraphs($assertRegExp)
    {
-        $this->assertRegExp(
+        $lipsum = new LoremIpsum();
+        $this->$assertRegExp(
            '/^([a-z, ]+\.)+\n\n([a-z, ]+\.)+\n\n([a-z, ]+\.)+$/i',
-            $this->lipsum->paragraphs(3)
+            $lipsum->paragraphs(3)
        );
    }

-    public function testParagraphsArray()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testParagraphsArray($assertRegExp)
    {
-        $paragraphs = $this->lipsum->paragraphsArray(3);
+        $lipsum = new LoremIpsum();
+        $paragraphs = $lipsum->paragraphsArray(3);
        $this->assertTrue(is_array($paragraphs));
        $this->assertCount(3, $paragraphs);

-        foreach ($paragraphs as $paragraph)
-        {
-            $this->assertRegExp('/^([a-z, ]+\.)+$/i', $paragraph);
+        foreach ($paragraphs as $paragraph) {
+            $this->$assertRegExp('/^([a-z, ]+\.)+$/i', $paragraph);
        }
    }

-    public function testMarkupString()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testMarkupString($assertRegExp)
    {
-        $this->assertRegExp(
+        $lipsum = new LoremIpsum();
+        $this->$assertRegExp(
            '/^<li>[a-z]+<\/li>$/i',
-            $this->lipsum->word('li')
+            $lipsum->word('li')
        );
    }

-    public function testMarkupArray()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testMarkupArray($assertRegExp)
    {
-        $this->assertRegExp(
+        $lipsum = new LoremIpsum();
+        $this->$assertRegExp(
            '/^<div><p>[a-z]+<\/p><\/div>$/i',
-            $this->lipsum->word(array('div', 'p'))
+            $lipsum->word(array('div', 'p'))
        );
    }

-    public function testMarkupBackReference()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testMarkupBackReference($assertRegExp)
    {
-        $this->assertRegExp(
+        $lipsum = new LoremIpsum();
+        $this->$assertRegExp(
            '/^<li><a href="[a-z]+">[a-z]+<\/a><\/li>$/i',
-            $this->lipsum->word('<li><a href="$1">$1</a></li>')
+            $lipsum->word('<li><a href="$1">$1</a></li>')
        );
    }

-    public function testMarkupArrayReturn()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testMarkupArrayReturn($assertRegExp)
    {
-        $words = $this->lipsum->wordsArray(3, 'li');
+        $lipsum = new LoremIpsum();
+        $words = $lipsum->wordsArray(3, 'li');
        $this->assertTrue(is_array($words));
        $this->assertCount(3, $words);

-        foreach ($words as $word)
-        {
-            $this->assertRegExp('/^<li>[a-z]+<\/li>$/i', $word);
-        }
+        foreach ($words as $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));
    }
 }
Author	SHA1	Message	Date
Josh Sherman	6d7f8cff6a	chore: bump version	2022-01-23 17:27:44 -06:00
Roy Verrips	a84cdd8917	Remove phpstan from dependancies - want to keep this compatible with php 7.0 as per github build steps	2022-01-23 17:26:15 -06:00
Roy Verrips	7cebbfc06a	Refactors to satisfy phpstan level 8	2022-01-23 17:26:15 -06:00
Roy Verrips	6e973db521	Add phpstan with config set to max	2022-01-23 17:26:15 -06:00
Roy Verrips	63a52c853b	PHP 8.1: Implicit incompatible float to int conversion is deprecated In PHP 8.1 floats are not implicitly converted to integers as before. The array_slice on line 139 requires an integer as the third parameter (the $count variable) so added line 117 to do the conversion of $count.	2022-01-23 17:26:15 -06:00
Josh Sherman	c9e2957c23	feat: ensure passed tags are strings 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.	2022-01-04 22:01:25 -06:00
peter279k	ae53465dad	Improvements about namespace and PHPUnit version	2020-12-29 16:23:21 -06:00
Josh Sherman	732be48504	test: update assertion syntax Tweaked the assertion syntax based on some upcoming changes to PHPUnit.	2020-10-12 18:01:46 -05:00
Umair Khan	007b7a211e	Fix #7 Change visibility of $words The PHPDoc block of `$words` say that the visibility / access of `$words` is private but its `public` in php code. https://github.com/joshtronic/php-loremipsum/blob/master/src/LoremIpsum.php#L37-L40	2020-10-02 10:50:21 -05:00
Josh Sherman	f0ec43a045	ci: switch to github actions Dropped Travis CI and Coveralls for GitHub Actions and CodeCov.	2020-06-01 22:25:24 -05:00
Josh Sherman	73e356956c	docs: update funding	2020-03-02 20:53:03 -06:00
Josh Sherman	cdb2e05cf4	chore(ci): test against PHP 7.4 * Updated to test again PHP 7.4 and to use that for coverage reporting. * Added PHP nightly builds as an allowable failure. * Added a git ignore as well as a `phpunit` configuration. * Updated the tests and CI configuration to better handle the juggling of PHP and `phpunit` versions. * Updated the coveralls dependency to be the latest and greatest instead of the deprecated package. * Tweaked the README, updated the LICENSE years and bumped this package's version. * Dropped Patreon link in favor of using Github Sponsors.	2020-01-09 21:49:13 -06:00
Josh Sherman	e41f4f7630	PHP 7.3 and more * Added CI for PHP 7.3 * Dropped CI for HHVM (was running into too many issues out of no where) * Reworked CI distros where I could * Bumped copyright year * Cleaned up the README, fixed spacing, dumped some of the wordiness	2019-01-03 00:21:50 -06:00
Josh Sherman	24b768a630	Merge pull request #1 from joshtronic/development Vocab tweaks, 7.2 and HHVM testing, cleanup	2018-01-08 23:57:45 -06:00
Josh Sherman	e6668afb5a	Updated email address	2018-01-08 23:43:09 -06:00
Josh Sherman	5fa8d5b300	Made some adjustments to the word list	2018-01-08 23:38:06 -06:00
Josh Sherman	a82b10394d	Bumped version, small bit of cleanup	2018-01-07 23:53:45 -06:00
Josh Sherman	fc7ce83cbc	Let's try to get that path right	2018-01-07 23:46:32 -06:00
Josh Sherman	dd120b7832	Cleaned up env stuff Was triggering a few extra builds and was kinda borked	2018-01-07 23:39:20 -06:00
Josh Sherman	551a2d790d	Let's try to install it directly	2018-01-07 23:31:46 -06:00
Josh Sherman	1f016c6b4b	Try composer install phpunit	2018-01-07 23:13:00 -06:00
Josh Sherman	3d4ceeb6fd	Do that didn't help	2018-01-07 22:41:41 -06:00
Josh Sherman	c6b8669c2c	Trying to fix HHVM errors Also some code cleanup	2018-01-07 22:36:46 -06:00
Josh Sherman	9cbee4918f	Bumped years	2018-01-07 22:36:27 -06:00
Josh Sherman	ffbdd892a3	Tell curl to follow 302	2018-01-07 22:16:46 -06:00
Josh Sherman	a7bf9d29c0	Simplified sanity check, report version for debugging	2018-01-07 22:08:59 -06:00
Josh Sherman	1943a9b79f	How about this?	2018-01-07 21:42:37 -06:00
Josh Sherman	5ed7322647	Whoops, fixed syntax	2018-01-07 21:35:12 -06:00
Josh Sherman	30f193b036	Install a different phpunit on HHVM	2018-01-07 21:26:18 -06:00
Josh Sherman	8d0bd22b1b	Added PHP 7.2 and HHVM 7.2 is out and the README still says HHVM, figure should be testing against it.	2018-01-07 21:02:24 -06:00
Josh Sherman	333323c9b3	Bumped years	2018-01-07 20:58:33 -06:00
Josh Sherman	e033baaa79	Bump version number	2017-05-28 18:30:23 -05:00
Josh Sherman	62835bea13	Clean up debug stuff	2017-05-28 17:05:14 -05:00
Josh Sherman	1bd9b03dda	Tweakin'	2017-05-28 17:02:08 -05:00
Josh Sherman	c4f6f06000	Debugging path	2017-05-28 16:56:13 -05:00
Josh Sherman	a6a4017906	Dropped version report,debugging coveralls	2017-05-28 16:53:19 -05:00
Josh Sherman	5352b2d7ff	Meh, dropping HHVM tests Just too much wrong with travis-ci's implementation and versions	2017-05-28 16:42:28 -05:00
Josh Sherman	010f86775a	Maybe run them all on trusty	2017-05-28 16:33:22 -05:00
Josh Sherman	2e3b28d12d	Fix hhvm versions	2017-05-28 16:26:39 -05:00
Josh Sherman	3454bd7488	Not going to worry about nightlies	2017-05-28 16:23:23 -05:00
Josh Sherman	02bae95170	Let's try a polyfill	2017-05-28 16:16:50 -05:00
Josh Sherman	c270610543	Ok, that made it worse	2017-05-28 16:14:49 -05:00
Josh Sherman	31f5869ed9	Add phpunit autoloader	2017-05-28 16:09:34 -05:00
Josh Sherman	6e8495f056	Force precise for 5.3, dump phpunit version	2017-05-28 16:00:54 -05:00
Josh Sherman	19be9e5dcd	Reworking languages	2017-05-28 12:49:36 -05:00
Josh Sherman	1a73da34f4	Drop HHVM from allowed failures	2017-05-28 12:25:42 -05:00
Josh Sherman	283a730230	Expand to test on 7.1 and nightly builds HHVM and Nightly builds are allowed failures	2017-05-28 12:21:59 -05:00
Josh Sherman	57f38f3193	Fixed typo	2017-05-28 12:12:13 -05:00
Josh Sherman	5ad1e4e9f7	Updated badges	2016-06-08 22:04:41 -05:00
Josh Sherman	cf41dcfdad	Downgraded coveralls for PHP <5.5 support	2016-06-08 21:51:39 -05:00
Josh Sherman	6a03636f11	Updated a bunch of shit Updated PHP versions to test against, copyright dates, dropped gittip, cleaned up a bit of formatting to make more PSR-compliant and bumped the version number slightly	2016-06-08 21:46:22 -05:00
Josh Sherman	ece0a6f057	Update README.md Went back to dev-master, no need to specify a version (even though there is a formal release). Will leave that up to the dev to figure out if they need a specific version.	2014-09-17 13:01:49 -04:00