Slug generation from cyrillic strings

README.md

@@ -468,6 +468,7 @@ It also provides an easy entry point to use 3rd party libraries like the exellen
 Sluggable generates slugs (uniqueness is not guaranteed) for an entity.
 Will automatically generate on update/persist (you can disable the on update generation by overriding `getRegenerateSlugOnUpdate` to return false.
 You can also override the slug delimiter from the default hyphen by overriding `getSlugDelimiter`.
+Slug generation algo can be changed by overriding `generateSlugValue`.
 Use cases include SEO (i.e. URLs like http://mysite.com/post/3/introduction-to-php)
 ```php
 <?php
@@ -486,11 +487,16 @@ class BlogPost
      * @ORM\Column(type="string")
      */
     protected $title;
-
+    
     public function getSluggableFields()
     {
         return [ 'title' ];
     }
+
+    public function generateSlugValue($values) 
+    {
+        return implode('-', $values);
+    }
 }
 ```
 
@@ -589,4 +595,4 @@ In the case of geocodable, you can set it as any service that implements `__invo
 
 ## Testing
 
-[Read the documentation for testing ](doc/test.md)
+[Read the documentation for testing ](doc/test.md)

composer.json

@@ -22,7 +22,8 @@
     ],
     "require": {
         "php":              ">=5.4",
-        "doctrine/common":  ">=2.2"
+        "doctrine/common":  ">=2.2",
+        "behat/transliterator": "~1.0"
     },
     "require-dev": {
         "ext-pdo_sqlite":                   "*",

src/Model/Sluggable/SluggableMethods.php

@@ -64,14 +64,45 @@ public function getSlug()
         return $this->slug;
     }
 
+    /**
+     * @param $values
+     * @return mixed|string
+     */
+    private function generateSlugValue($values)
+    {
+        $usableValues = [];
+        foreach ($values as $fieldName => $fieldValue) {
+            if (!empty($fieldValue)) {
+                $usableValues[] = $fieldValue;
+            }
+        }
+
+        if (count($usableValues) < 1) {
+            throw new \UnexpectedValueException(
+                'Sluggable expects to have at least one usable (non-empty) field from the following: [ ' . implode(array_keys($values), ',') .' ]'
+            );
+        }
+
+        // generate the slug itself
+        $sluggableText = implode(' ', $usableValues);
+
+        $transliterator = new Transliterator;
+        $sluggableText = $transliterator->transliterate($sluggableText, $this->getSlugDelimiter());
+
+        $urlized = strtolower( trim( preg_replace("/[^a-zA-Z0-9\/_|+ -]/", '', $sluggableText ), $this->getSlugDelimiter() ) );
+        $urlized = preg_replace("/[\/_|+ -]+/", $this->getSlugDelimiter(), $urlized);
+
+        return $urlized;
+    }
+
     /**
      * Generates and sets the entity's slug. Called prePersist and preUpdate
      */
     public function generateSlug()
     {
         if ( $this->getRegenerateSlugOnUpdate() || empty( $this->slug ) ) {
             $fields = $this->getSluggableFields();
-            $usableValues = [];
+            $values = [];
 
             foreach ($fields as $field) {
                 if (property_exists($this, $field)) {
@@ -85,21 +116,10 @@ public function generateSlug()
                     }
                 }
 
-                if ( !empty( $val ) ) {
-                    $usableValues[] = $val;
-                }
-            }
-
-            if ( count($usableValues) < 1 ) {
-                throw new \UnexpectedValueException('Sluggable expects to have at least one usable (non-empty) field from the following: [ ' . implode($fields, ',') .' ]');
+                $values[] = $val;
             }
 
-            // generate the slug itself
-            $sluggableText = implode($usableValues, ' ');
-            $urlized = strtolower( trim( preg_replace("/[^a-zA-Z0-9\/_|+ -]/", '', iconv('UTF-8', 'ASCII//TRANSLIT', $sluggableText) ), $this->getSlugDelimiter() ) );
-            $urlized = preg_replace("/[\/_|+ -]+/", $this->getSlugDelimiter(), $urlized);
-
-            $this->slug = $urlized;
+            $this->slug = $this->generateSlugValue($values);
         }
     }
 }

src/Model/Sluggable/Transliterator.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * @author Lusitanian
+ * Freely released with no restrictions, re-license however you'd like!
+ */
+
+namespace Knp\DoctrineBehaviors\Model\Sluggable;
+
+/**
+* Transliteration utility
+*/
+class Transliterator extends \Behat\Transliterator\Transliterator
+{
+
+}

tests/Knp/DoctrineBehaviors/ORM/SluggableMultiTest.php

@@ -38,7 +38,7 @@ public function testSlugLoading()
 
         $entity = new \BehaviorFixtures\ORM\SluggableMultiEntity();
 
-        $expected = 'the-name-title';
+        $expected = 'the+name+title';
 
         $entity->setName('The name');
 
@@ -61,7 +61,7 @@ public function testNotUpdatedSlug()
 
         $entity = new \BehaviorFixtures\ORM\SluggableMultiEntity();
 
-        $expected = 'the-name-title';
+        $expected = 'the+name+title';
 
         $entity->setName('The name');
 
@@ -82,7 +82,7 @@ public function testUpdatedSlug()
 
         $entity = new \BehaviorFixtures\ORM\SluggableMultiEntity();
 
-        $expected = 'the-name-title';
+        $expected = 'the+name+title';
 
         $entity->setName('The name');
 
@@ -91,7 +91,7 @@ public function testUpdatedSlug()
 
         $this->assertEquals($entity->getSlug(), $expected);
 
-        $expected = 'the-name-2-title';
+        $expected = 'the+name+2+title';
 
         $entity->setName('The name 2');
 

tests/Knp/DoctrineBehaviors/ORM/SluggableTest.php

@@ -13,9 +13,9 @@ class SluggableTest extends \PHPUnit_Framework_TestCase
 
     protected function getUsedEntityFixtures()
     {
-        return array(
+        return [
             'BehaviorFixtures\\ORM\\SluggableEntity'
-        );
+        ];
     }
 
     protected function getEventManager()
@@ -52,28 +52,51 @@ public function testSlugLoading()
         $entity = $em->getRepository('BehaviorFixtures\ORM\SluggableEntity')->find($id);
 
         $this->assertNotNull($entity);
-        $this->assertEquals($entity->getSlug(), $expected);
+        $this->assertEquals($expected, $entity->getSlug());
     }
 
     public function testNotUpdatedSlug()
     {
         $em = $this->getEntityManager();
 
-        $entity = new \BehaviorFixtures\ORM\SluggableEntity();
-
-        $expected = 'the-name';
-
-        $entity->setName('The name');
-
-        $em->persist($entity);
-        $em->flush();
-
-        $entity->setDate(new \DateTime);
-
-        $em->persist($entity);
-        $em->flush();
-
-        $this->assertEquals($entity->getSlug(), $expected);
+        $data = [
+            [
+                'slug' => 'the-name',
+                'name' => 'The name',
+            ],
+            [
+                'slug' => 'loic-rene',
+                'name' => 'Löic & René',
+            ],
+            [
+                'slug' => 'ivan-ivanovich',
+                'name' => 'Иван Иванович',
+            ],
+            [
+                'slug' => 'chateauneuf-du-pape',
+                'name' => 'Châteauneuf du Pape'
+            ],
+            [
+                'slug' => 'zlutoucky-kun',
+                'name' => 'Žluťoučký kůň'
+            ]
+        ];
+
+        foreach ($data as $row) {
+            $entity = new \BehaviorFixtures\ORM\SluggableEntity();
+
+            $entity->setName($row['name']);
+
+            $em->persist($entity);
+            $em->flush();
+
+            $entity->setDate(new \DateTime);
+
+            $em->persist($entity);
+            $em->flush();
+
+            $this->assertEquals($row['slug'], $entity->getSlug());
+        }
     }
 
     public function testUpdatedSlug()
@@ -98,6 +121,6 @@ public function testUpdatedSlug()
         $em->persist($entity);
         $em->flush();
 
-        $this->assertEquals($entity->getSlug(), $expected);
+        $this->assertEquals($expected, $entity->getSlug());
     }
 }

tests/fixtures/BehaviorFixtures/ORM/SluggableMultiEntity.php

@@ -68,7 +68,7 @@ public function setDate($date)
         return $this;
     }
 
-    protected function getSluggableFields()
+    public function getSluggableFields()
     {
         return [ 'name', 'title' ];
     }
@@ -77,4 +77,15 @@ public function getTitle()
     {
         return 'title';
     }
+
+    /**
+     * @param $values
+     * @return mixed|string
+     */
+    public function generateSlugValue($values)
+    {
+        $sluggableText = implode(' ', $values);
+
+        return strtolower(str_replace(' ', '+', $sluggableText));
+    }
 }