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
12 changed files with 243 additions and 148 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/.travis.yml
+++ b/.travis.yml
@ -1,40 +0,0 @@
-language: php
-dist: bionic
-sudo: required
-
-matrix:
-  include:
-    - php: 5.3
-      dist: precise
-    - php: 5.4
-      dist: trusty
-    - php: 5.5
-      dist: trusty
-    - php: 5.6
-      dist: trusty
-    - php: 7.0
-      dist: xenial
-    - php: 7.1
-    - php: 7.2
-    - php: 7.3
-    - php: 7.4
-      env: COVERAGE=true
-    - php: nightly
-  allow_failures:
-    - php: nightly
-
-install:
-  - php --version
-  - composer install
-
-before_script:
-  - mkdir -p build/logs
-
-script:
-  - vendor/bin/phpunit --coverage-clover build/logs/clover.xml
-
-after_success:
-  - |
-    if [[ $COVERAGE ]]; then
-      travis_retry php vendor/bin/php-coveralls --config .coveralls.yml -v
-    fi
--- a/FUNDING.yml
+++ b/FUNDING.yml
@ -1 +1 @@
-patreon: joshtronic
+github: joshtronic
--- a/2
+++ b/2
@ -1,6 +1,6 @@
 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
 of this software and associated documentation files (the "Software"), to deal
--- a/README.md
+++ b/README.md
@ -2,8 +2,8 @@

 [![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)
-[![Build Status](https://img.shields.io/travis/joshtronic/php-loremipsum/master?style=for-the-badge)](https://travis-ci.org/joshtronic/php-loremipsum)
-[![Coverage Status](https://img.shields.io/coveralls/github/joshtronic/php-loremipsum/master?style=for-the-badge)](https://coveralls.io/github/joshtronic/php-loremipsum?branch=master)
+[![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)

 Lorem ipsum generator in PHP without dependencies. Compatible with PHP 5.3+.
--- 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,7 +1,7 @@
 {
    "name": "joshtronic/php-loremipsum",
    "description": "Lorem ipsum generator in PHP without dependencies",
-  "version": "1.0.5",
+    "version": "2.1.0",
    "type": "library",
    "keywords": [
      "lorem",
@ -19,12 +19,16 @@
      "php": ">=5.3"
    },
    "require-dev": {
-    "php-coveralls/php-coveralls": ">=1",
-    "phpunit/phpunit": ">=4"
+      "phpunit/phpunit": "^4.8.36 || ^9.0"
    },
    "autoload": {
      "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
@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
+  bootstrap="vendor/autoload.php"
  colors="true"
  convertErrorsToExceptions="true"
  convertNoticesToExceptions="true"
--- a/src/LoremIpsum.php
+++ b/src/LoremIpsum.php
@ -9,7 +9,7 @@
 * Redistribution of these files must retain the above copyright notice.
 *
 * @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
 * @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,9 +35,9 @@ 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',

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

    /**
@ -94,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)
    {
@ -114,6 +114,7 @@ class LoremIpsum
     */
    public function words($count = 1, $tags = false, $array = false)
    {
+        $count      = (int) $count;
        $words      = array();
        $word_count = 0;

@ -151,7 +152,7 @@ class LoremIpsum
     */
    public function sentence($tags = false)
    {
-        return $this->sentences(1, $tags);
+        return strval($this->sentences(1, $tags));
    }

    /**
@ -162,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)
    {
@ -204,7 +205,7 @@ class LoremIpsum
     */
    public function paragraph($tags = false)
    {
-        return $this->paragraphs(1, $tags);
+        return strval($this->paragraphs(1, $tags));
    }

    /**
@ -215,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.
     *
@ -238,11 +242,14 @@ class LoremIpsum
        $paragraphs = array();

        for ($i = 0; $i < $count; $i++) {
-            $paragraphs[] = $this->sentences($this->gauss(5.8, 1.93));
+            $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
@ -255,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)
    {
@ -263,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);
    }

    /**
@ -273,6 +280,7 @@ class LoremIpsum
     * the first time we are generating the text.
     *
     * @access private
+     * @return void
     */
    private function shuffle()
    {
@ -298,18 +306,18 @@ 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) {
            $words = count($sentence);
-
            // Only worry about commas on sentences longer than 4 words
            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++) {
                    $word = round($i * $words / ($commas + 1));
@ -333,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()
@ -351,12 +359,14 @@ class LoremIpsum

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

                    $strings[$key] = $string;
                }
@ -370,4 +380,3 @@ class LoremIpsum
        return $strings;
    }
 }
-
--- a/tests/LoremIpsumTest.php
+++ b/tests/LoremIpsumTest.php
@ -1,139 +1,198 @@
 <?php
-require_once './src/LoremIpsum.php';
+namespace joshtronic\Tests;
+use joshtronic\LoremIpsum;
+use PHPUnit\Framework\TestCase;

-if (
-    !class_exists('\PHPUnit_Framework_TestCase')
-    && class_exists('\PHPUnit\Framework\TestCase')
-) {
-    class_alias('\PHPUnit\Framework\TestCase', '\PHPUnit_Framework_TestCase');
-}
-
-class LoremIpsumTest extends PHPUnit_Framework_TestCase
+class LoremIpsumTest extends TestCase
 {
-    public function testWord()
-    {
-        $lipsum = new joshtronic\LoremIpsum();
-        $this->assertRegExp('/^[a-z]+$/i', $lipsum->word());
+    /**
+     * @doesNotPerformAssertions
+     */
+    public function testAssertRegExp() {
+        if (version_compare(PHP_VERSION, '7.3.0', '>=')) {
+            return 'assertMatchesRegularExpression';
        }

-    public function testWords()
+        return 'assertRegExp';
+    }
+
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testWord($assertRegExp)
    {
-        $lipsum = new joshtronic\LoremIpsum();
-        $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',
            $lipsum->words(3)
        );
    }

-    public function testWordsArray()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testWordsArray($assertRegExp)
    {
-        $lipsum = new joshtronic\LoremIpsum();
+        $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);
+            $this->$assertRegExp('/^[a-z]+$/i', $word);
        }
    }

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

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

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

-    public function testSentencesArray()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testSentencesArray($assertRegExp)
    {
-        $lipsum = new joshtronic\LoremIpsum();
+        $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);
+            $this->$assertRegExp('/^[a-z, ]+\.$/i', $sentence);
        }
    }

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

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

-    public function testParagraphsArray()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testParagraphsArray($assertRegExp)
    {
-        $lipsum = new joshtronic\LoremIpsum();
+        $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);
+            $this->$assertRegExp('/^([a-z, ]+\.)+$/i', $paragraph);
        }
    }

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

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

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

-    public function testMarkupArrayReturn()
+    /**
+     * @depends testAssertRegExp
+     */
+    public function testMarkupArrayReturn($assertRegExp)
    {
-        $lipsum = new joshtronic\LoremIpsum();
+        $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);
+            $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