Merge pull request #21 from sunrise-php/release/v2.1.2

fenric · web-flow · commit 9f803c44745c · 2022-04-19T19:59:08.000+05:00
v2.1.2
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -10,40 +10,40 @@ jobs:
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php72:
     docker:
       - image: circleci/php:7.2-cli-node-browsers
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php73:
     docker:
       - image: circleci/php:7.3-cli-node-browsers
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php74:
     docker:
       - image: circleci/php:7.4-cli-node-browsers
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php80:
     docker:
       - image: circleci/php:8.0-cli-node-browsers
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
 workflows:
   version: 2
   build:
diff --git a/.editorconfig b/.editorconfig
@@ -11,8 +11,5 @@ indent_size = 4
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.md]
-trim_trailing_whitespace = false
-
 [*.yml]
 indent_size = 2
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,9 @@
-.php_cs.cache
-.phpunit.result.cache
-composer.lock
-coverage.xml
-phpbench.json
-phpcs.xml
-phpunit.xml
-vendor/
+/.php_cs.cache
+/.phpunit.result.cache
+/composer.lock
+/coverage.xml
+/phpbench.json
+/phpcs.xml
+/phpunit.xml
+/psalm.xml
+/vendor/
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -1,4 +1,7 @@
 build:
+  environment:
+    php:
+      version: '8.0'
   nodes:
     analysis:
       tests:
@@ -7,7 +10,7 @@ build:
     coverage:
       tests:
         override:
-          - command: php vendor/bin/phpunit --coverage-clover coverage.xml
+          - command: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-clover coverage.xml
             coverage:
               file: coverage.xml
               format: clover
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Sunrise // PHP
+Copyright (c) 2018 Anatoly Nekhay
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Simple slugger for PHP 7.1+ (incl. PHP 8) based on ICU
+# Simple slugger for PHP 7.1+ based on ICU
 
 [![Gitter](https://badges.gitter.im/sunrise-php/support.png)](https://gitter.im/sunrise-php/support)
 [![Build Status](https://circleci.com/gh/sunrise-php/slugger.svg?style=shield)](https://circleci.com/gh/sunrise-php/slugger)
@@ -8,10 +8,6 @@
 [![Latest Stable Version](https://poser.pugx.org/sunrise/slugger/v/stable?format=flat)](https://packagist.org/packages/sunrise/slugger)
 [![License](https://poser.pugx.org/sunrise/slugger/license?format=flat)](https://packagist.org/packages/sunrise/slugger)
 
-## Awards
-
-[![SymfonyInsight](https://insight.symfony.com/projects/64e80815-60f3-47eb-8163-8bd2538376e9/big.svg)](https://insight.symfony.com/projects/64e80815-60f3-47eb-8163-8bd2538376e9)
-
 ## Installation
 
 ```bash
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "sunrise/slugger",
     "homepage": "https://github.com/sunrise-php/slugger",
-    "description": "Simple slugger for PHP 7.1+ (incl. PHP 8) based on ICU",
+    "description": "Slugger for PHP 7.1+ based on ICU",
     "license": "MIT",
     "keywords": [
         "fenric",
@@ -14,17 +14,17 @@
     "authors": [
         {
             "name": "Anatoly Fenric",
-            "email": "anatoly@fenric.ru",
-            "homepage": "https://anatoly.fenric.ru/"
+            "email": "afenric@gmail.com",
+            "homepage": "https://github.com/fenric"
         }
     ],
     "require": {
-        "ext-intl": "*",
-        "php": "^7.1|^8.0"
+        "php": "^7.1|^8.0",
+        "ext-intl": "*"
     },
     "require-dev": {
-        "sunrise/coding-standard": "1.0.0",
-        "phpunit/phpunit": "7.5.20|9.5.0"
+        "phpunit/phpunit": "7.5.20|9.5.0",
+        "sunrise/coding-standard": "1.0.0"
     },
     "autoload": {
         "psr-4": {
@@ -34,7 +34,12 @@
     "scripts": {
         "test": [
             "phpcs",
-            "XDEBUG_MODE=coverage phpunit --colors=always --coverage-text"
+            "psalm",
+            "XDEBUG_MODE=coverage phpunit --coverage-text --colors=always"
+        ],
+        "build": [
+            "phpdoc -d src/ -t phpdoc/",
+            "XDEBUG_MODE=coverage phpunit --coverage-html coverage/"
         ]
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,15 +1,15 @@
 <?xml version="1.0"?>
 <phpunit
-    colors="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+>
     <coverage>
         <include>
             <directory>./src</directory>
         </include>
     </coverage>
     <testsuites>
-        <testsuite name="Sunrise Slugger Test Suite">
+        <testsuite name="sunrise/slugger">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>
diff --git a/src/Exception/Exception.php b/src/Exception/Exception.php
@@ -13,14 +13,9 @@
 
 namespace Sunrise\Slugger\Exception;
 
-/**
- * Import classes
- */
-use Exception as BaseException;
-
 /**
  * Exception
  */
-class Exception extends BaseException implements ExceptionInterface
+class Exception extends \Exception implements ExceptionInterface
 {
 }
diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php
@@ -13,14 +13,9 @@
 
 namespace Sunrise\Slugger\Exception;
 
-/**
- * Import classes
- */
-use Throwable as BaseExceptionInterface;
-
 /**
  * ExceptionInterface
  */
-interface ExceptionInterface extends BaseExceptionInterface
+interface ExceptionInterface extends \Throwable
 {
 }
diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * It's free open-source software released under the MIT License.
+ *
+ * @author Anatoly Fenric <anatoly@fenric.ru>
+ * @copyright Copyright (c) 2018, Anatoly Fenric
+ * @license https://github.com/sunrise-php/slugger/blob/master/LICENSE
+ * @link https://github.com/sunrise-php/slugger
+ */
+
+namespace Sunrise\Slugger\Exception;
+
+/**
+ * InvalidArgumentException
+ */
+class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
+{
+}
diff --git a/src/Exception/UnableToCreateTransliteratorException.php b/src/Exception/UnableToCreateTransliteratorException.php
@@ -16,6 +16,6 @@
 /**
  * UnableToCreateTransliteratorException
  */
-class UnableToCreateTransliteratorException extends Exception
+class UnableToCreateTransliteratorException extends \RuntimeException implements ExceptionInterface
 {
 }
diff --git a/src/Exception/UnableToTransliterateException.php b/src/Exception/UnableToTransliterateException.php
@@ -16,6 +16,6 @@
 /**
  * UnableToTransliterateException
  */
-class UnableToTransliterateException extends Exception
+class UnableToTransliterateException extends \RuntimeException implements ExceptionInterface
 {
 }
diff --git a/src/Slugger.php b/src/Slugger.php
@@ -16,14 +16,17 @@
 /**
  * Import classes
  */
-use Transliterator;
+use Sunrise\Slugger\Exception\InvalidArgumentException;
 use Sunrise\Slugger\Exception\UnableToCreateTransliteratorException;
 use Sunrise\Slugger\Exception\UnableToTransliterateException;
+use Transliterator;
 
 /**
  * Import functions
  */
+use function in_array;
 use function preg_replace;
+use function str_replace;
 use function strtr;
 use function trim;
 
@@ -33,44 +36,56 @@
 class Slugger implements SluggerInterface
 {
 
+    /**
+     * Default Basic ID
+     *
+     * @var string
+     *
+     * @link http://userguide.icu-project.org/transforms/general#TOC-Basic-IDs
+     */
+    protected const DEFAULT_BASIC_ID = 'Russian-Latin/BGN';
+
     /**
      * Transliterator
      *
      * @var Transliterator
      */
-    private $transliterator;
+    protected $transliterator;
 
     /**
      * Replacements
      *
-     * @var array<string,string>
+     * @var array<string, string>
      */
-    private $replacements = [
-        "'" => '', // <= <Ь>
-        '"' => '', // <= <Ъ>
-    ];
+    protected $replacements = [];
 
     /**
      * Constructor of the class
      *
-     * @param string $basicId
-     * @param array<string,string> $replacements
+     * @param string|null $basicId
+     * @param array<string, string> $replacements
      *
+     * @throws InvalidArgumentException
      * @throws UnableToCreateTransliteratorException
      */
     public function __construct(?string $basicId = null, array $replacements = [])
     {
         // http://userguide.icu-project.org/transforms/general#TOC-Basic-IDs
-        // http://userguide.icu-project.org/transforms/general#TOC-Compound-IDs
-        $compoundIds = ($basicId ?? 'Russian-Latin/BGN') . '; Any-Latin; Latin-ASCII; Lower()';
+        /** @var string */
+        $basicId = $basicId ?? static::DEFAULT_BASIC_ID;
+        if (!in_array($basicId, Transliterator::listIDs(), true)) {
+            throw new InvalidArgumentException('Unknown Basic ID');
+        }
 
-        $transliterator = Transliterator::create($compoundIds, Transliterator::FORWARD);
-        if (null === $transliterator) {
+        // http://userguide.icu-project.org/transforms/general#TOC-Compound-IDs
+        $compoundIds = $basicId . '; Any-Latin; Latin-ASCII; Lower()';
+        $transliterator = Transliterator::create($compoundIds);
+        if ($transliterator === null) {
             throw new UnableToCreateTransliteratorException('Unable to create transliterator');
         }
 
         $this->transliterator = $transliterator;
-        $this->replacements += $replacements;
+        $this->replacements = $replacements;
     }
 
     /**
@@ -81,11 +96,12 @@ public function __construct(?string $basicId = null, array $replacements = [])
     public function slugify(string $string, string $separator = '-') : string
     {
         $result = $this->transliterator->transliterate($string);
-        if (false === $result) {
+        if ($result === false) {
             throw new UnableToTransliterateException('Unable to transliterate');
         }
 
         $result = strtr($result, $this->replacements);
+        $result = str_replace(['"', "'"], '', $result);
         $result = preg_replace('/[^0-9A-Za-z]++/', $separator, $result);
         $result = trim($result, $separator);
 
diff --git a/src/SluggerInterface.php b/src/SluggerInterface.php
@@ -26,8 +26,6 @@ interface SluggerInterface
      * @param string $separator
      *
      * @return string
-     *
-     * @throws Exception\ExceptionInterface
      */
     public function slugify(string $string, string $separator) : string;
 }
diff --git a/tests/SluggerTest.php b/tests/SluggerTest.php

Original file line number	Diff line number	Diff line change
`@@ -13,14 +13,9 @@`
`13`	`13`
`14`	`14`	`namespace Sunrise\Slugger\Exception;`
`15`	`15`
`16`		`-/**`
`17`		`- * Import classes`
`18`		`- */`
`19`		`-use Exception as BaseException;`
`20`		`-`
`21`	`16`	`/**`
`22`	`17`	`* Exception`
`23`	`18`	`*/`
`24`		`-class Exception extends BaseException implements ExceptionInterface`
	`19`	`+class Exception extends \Exception implements ExceptionInterface`
`25`	`20`	`{`
`26`	`21`	`}`