Initial commit

Author: wouterj

.gitignore

@@ -0,0 +1,3 @@
+phpunit.xml
+composer.lock
+vendor

.travis.yml

@@ -0,0 +1,20 @@
+language: php
+
+php:
+  - 5.3
+  - 5.4
+  - 5.5
+  - 5.6
+  - 7.0
+  - hhvm
+
+sudo: false
+
+before_install: phpenv config-rm xdebug.ini || true
+  
+install: composer dump-autoload
+
+script: phpunit
+
+notifications:
+  irc: "irc.freenode.org#symfony-cmf"

CallbackSlugifier.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2016 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Api\Slugifier;
+
+/**
+ * Slugifier service which uses a callback.
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class CallbackSlugifier implements SlugifierInterface
+{
+    protected $callback;
+
+    /**
+     * @param callable $callback
+     */
+    public function __construct($callback)
+    {
+        if (!is_callable($callback)) {
+            throw new \InvalidArgumentException(sprintf('Expected a valid callable as callback, %s given.', gettype($callback)));
+        }
+
+        $this->callback = $callback;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function slugify($string)
+    {
+        return call_user_func($this->callback, $string);
+    }
+}

README.md

@@ -0,0 +1,43 @@
+# Symfony CMF Slugifier API
+
+[![Build Status](https://travis-ci.org/symfony-cmf/slugifier-api.svg?branch=master)](https://travis-ci.org/symfony-cmf/slugifier-api)
+[![Latest Stable Version](https://poser.pugx.org/symfony-cmf/slugifier-api/version.png)](https://packagist.org/packages/symfony-cmf/slugifier-api)
+[![Total Downloads](https://poser.pugx.org/symfony-cmf/slugifier-api/d/total.png)](https://packagist.org/packages/symfony-cmf/slugifier-api)
+
+This package is part of the [Symfony Content Management Framework (CMF)](http://cmf.symfony.com/)
+and licensed under the [MIT License](LICENSE).
+
+The Slugifier API provides a basic interface to use for third party slugifiers.
+Besides this, it comes with a usefull `CallbackSlugifier` which is capable of
+handling most third party slugifiers.
+
+
+## Requirements
+
+* See also the `require` section of [composer.json](composer.json)
+
+
+## Documentation
+
+For the install guide and reference, see:
+
+* Slugifier documentation
+
+See also:
+
+* [All Symfony CMF documentation](http://symfony.com/doc/master/cmf/index.html) - complete Symfony CMF reference
+* [Symfony CMF Website](http://cmf.symfony.com/) - introduction, live demo, support and community links
+
+
+## Contributing
+
+Pull requests are welcome. Please see our
+[CONTRIBUTING](https://github.com/symfony-cmf/symfony-cmf/blob/master/CONTRIBUTING.md)
+guide.
+
+Unit and/or functional tests exist for this bundle. See the
+[Testing documentation](http://symfony.com/doc/master/cmf/components/testing.html)
+for a guide to running the tests.
+
+Thanks to
+[everyone who has contributed](https://github.com/symfony-cmf/RoutingBundle/contributors) already.

SlugifierInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2016 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Api\Slugifier;
+
+/**
+ * Slugifier interface.
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+interface SlugifierInterface
+{
+    /**
+     * Return a slugified (or urlized) representation of a given string.
+     *
+     * @param string $string
+     *
+     * @return string
+     */
+    public function slugify($string);
+}

Tests/CallbackSlugifierTest.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Api\Slugifier\Tests;
+
+use Symfony\Cmf\Api\Slugifier\CallbackSlugifier;
+
+class CallbackSlugifierTest extends \PHPUnit_Framework_TestCase
+{
+    private $slugifier;
+
+    protected function setUp()
+    {
+        $this->slugifier = new CallbackSlugifier(
+            'Symfony\Cmf\Api\Slugifier\Tests\CallbackSlugifierTest::slugify'
+        );
+    }
+
+    public function testSlugify()
+    {
+        $this->assertEquals('this-is-slugified', $this->slugifier->slugify('this is slugified'));
+    }
+
+    public static function slugify($val)
+    {
+        return str_replace(' ', '-', $val);
+    }
+}

composer.json

@@ -0,0 +1,26 @@
+{
+    "name": "symfony-cmf/slugifier-api",
+    "description": "Provides a basic slugifier interface",
+    "keywords": ["slugify"],
+    "homepage": "http://cmf.symfony.com",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Symfony CMF Community",
+            "homepage": "https://github.com/symfony-cmf/RoutingBundle/contributors"
+        }
+    ],
+    "require": {
+        "php": "^5.3.9|^7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Symfony\\Cmf\\Api\\Slugifier\\": ""
+        }
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0-dev"
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- http://www.phpunit.de/manual/current/en/appendixes.configuration.html -->
+<phpunit
+    colors="true"
+    bootstrap="vendor/autoload.php"
+>
+
+    <testsuites>
+        <testsuite name="Symfony Slugifier Api Test Suite">
+            <directory>./Tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="true">
+            <directory>.</directory>
+            <exclude>
+                <directory>Tests/</directory>
+                <directory>vendor/</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+
+</phpunit>