initial commit

Author: arondeparon

.gitignore

@@ -0,0 +1,4 @@
+build
+composer.lock
+vendor
+.idea

.travis.yml

@@ -0,0 +1,18 @@
+language: php
+
+php:
+- 7.0
+- 7.1
+- 7.2
+
+env:
+  matrix:
+  - COMPOSER_FLAGS="--prefer-lowest"
+  - COMPOSER_FLAGS=""
+
+before_script:
+- travis_retry composer self-update
+- travis_wait composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
+
+script:
+- vendor/bin/phpunit --testdox

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Aron Rotteveel <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,75 @@
+# Laravel Request Sanitizer
+
+[![Build Status](https://travis-ci.org/ArondeParon/laravel-request-sanitizer.svg?branch=master)](https://travis-ci.org/ArondeParon/laravel-request-sanitizer)
+
+The `arondeparon/laravel-request-sanitizer` package provides a fluent interface to sanitize form requests before validating them.
+
+## Why should I use this package?
+
+Often, validating your request is not enough. The request sanitizer allows you to easily 
+sanitize your form data before passing it to the validator. You can start using it in a matter
+of minutes and it is fully compatible with Laravel's `FormRequest` object.
+
+## How to use
+
+Syntax is similar to the way `rules` are added to a Form Request.
+
+```php
+class StoreCustomerInformationRequest extends FormRequest
+{
+     use SanitizesInputs;
+     
+     protected $sanitizers = [
+        'lastname' => [
+            Capitalize::class,
+        ],
+        'mobile_phone' => [
+            RemoveNonNumeric::class
+        ],
+     ];
+}
+```
+
+## Installing
+
+`composer require arondeparon/laravel-request-sanitizer`
+
+## Usage
+
+- Add the `SanitizesInputs` trait to your form request.
+- Write your own sanitizers or use one of the supplied sanitizers and add them to the `$sanitizers`
+property of your form request.
+- Your request data will not be sanitized before being validated.
+
+## Predefined Sanitizers
+
+- [`RemoveNonNumeric`](./src/Sanitizers/RemoveNonNumeric.php) - removes any non numeric character
+- [`Trim`](./src/Sanitizers/Trim.php) - simple PHP `trim()` implementation
+- [`TrimDuplicateSpaces`](./src/Sanitizers/TrimDuplicateSpaces.php) replaces duplicate spaces with a single space.
+- ...
+- Contributions are appreciated!
+
+## Writing your own Sanitizers
+
+Writing your own sanitizer can be done by implementing the `Sanitizer` interface, which requires only
+one method.
+
+```php
+interface Sanitizer
+ {
+     public function sanitize($input);
+ }
+```
+
+## Testing
+
+`$ phpunit`
+
+## Credits
+
+- [Aron Rotteveel](https://github.com/arondeparon)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,46 @@
+{
+    "name": "arondeparon/laravel-request-sanitizer",
+    "description": "An easy to use request sanitizer that allows you to sanitize your form data before validating it.",
+    "homepage": "https://github.com/arondeparon/laravel-request-sanitizer",
+    "keywords": [
+        "laravel",
+        "arondeparon",
+        "request",
+        "sanitizer",
+        "validation",
+        "form"
+    ],
+    "type": "library",
+    "authors": [
+        {
+            "name": "Aron Rotteveel",
+            "email": "[email protected]",
+            "homepage": "https://github.com/arondeparon",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^7.0",
+        "illuminate/contracts": "~5.5.0|~5.6.0",
+        "illuminate/support": "~5.5.0|~5.6.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^6.2|7.2",
+        "orchestra/testbench": "~3.5.0|~3.6.0",
+        "mockery/mockery": "0.9.*"
+    },
+    "autoload": {
+        "psr-4": {
+            "ArondeParon\\RequestSanitizer\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "ArondeParon\\RequestSanitizer\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
+    },
+    "license": "MIT"
+}

phpunit.xml.dist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Laravel Request Sanitizer Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Contracts/Sanitizer.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace ArondeParon\RequestSanitizer\Contracts;
+
+interface Sanitizer
+{
+    /**
+     * Sanitize an input and return it.
+     *
+     * @param $input
+     * @return mixed
+     */
+    public function sanitize($input);
+}

src/RequestSanitizerServiceProvider.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ArondeParon\RequestSanitizer\Sanitizers;
+
+use ArondeParon\RequestSanitizer\Contracts\Sanitizer;
+
+class RemoveNonNumeric implements Sanitizer
+{
+    /**
+     * @param $input
+     * @return string
+     */
+    public function sanitize($input)
+    {
+        return preg_replace('~[^0-9]+~', '', $input);
+    }
+}

src/Sanitizers/RemoveNonNumeric.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ArondeParon\RequestSanitizer\Sanitizers;
+
+use ArondeParon\RequestSanitizer\Contracts\Sanitizer;
+
+class Trim implements Sanitizer
+{
+    /**
+     * @param $input
+     * @return string
+     */
+    public function sanitize($input)
+    {
+        return trim($input);
+    }
+}

src/Sanitizers/Trim.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ArondeParon\RequestSanitizer\Sanitizers;
+
+use ArondeParon\RequestSanitizer\Contracts\Sanitizer;
+
+class TrimDuplicateSpaces implements Sanitizer
+{
+    /**
+     * @param $input
+     * @return string
+     */
+    public function sanitize($input)
+    {
+        return preg_replace('~\s{2,}~', ' ', $input);
+    }
+}

src/Sanitizers/TrimDuplicateSpaces.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace ArondeParon\RequestSanitizer\Traits;
+
+use ArondeParon\RequestSanitizer\Contracts\Sanitizer;
+
+trait SanitizesInputs
+{
+    /**
+     * Get data to be validated from the request.
+     *
+     * @return array
+     */
+    protected function validationData()
+    {
+        // Sanitize data before passing it to the validator.
+        $this->sanitize();
+
+        return $this->all();
+    }
+
+    public function sanitize()
+    {
+        $input = $this->all();
+
+        if (!property_exists($this, 'sanitizers')) {
+            $this->sanitizers = [];
+        }
+
+        foreach ($this->sanitizers as $formKey => $sanitizers) {
+            $sanitizers = (array) $sanitizers;
+            foreach ($sanitizers as $sanitizer) {
+                if (is_string($sanitizer)) {
+                    $sanitizer = app()->make($sanitizer);
+                }
+                $input[$formKey] = $sanitizer->sanitize($input[$formKey] ?? null);
+            }
+        }
+
+        return $this->replace($input);
+    }
+
+    /**
+     * Add a single sanitizer.
+     *
+     * @param string $formKey
+     * @param Sanitizer $sanitizer
+     * @return $this
+     */
+    public function addSanitizer(string $formKey, $sanitizer)
+    {
+        if (!isset($this->sanitizers[$formKey])) {
+            $this->sanitizers[$formKey] = [];
+        }
+
+        $this->sanitizers[$formKey][] = $sanitizer;
+
+        return $this;
+    }
+
+    /**
+     * Add multiple sanitizers.
+     *
+     * @param $formKey
+     * @param array $sanitizers
+     * @return $this
+     */
+    public function addSanitizers($formKey, $sanitizers = [])
+    {
+        foreach ($sanitizers as $sanitizer) {
+            $this->addSanitizer($formKey, $sanitizer);
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param null $formKey
+     * @return array
+     */
+    public function getSanitizers($formKey = null)
+    {
+        if ($formKey !== null) {
+            return $this->sanitizers[$formKey] ?? [];
+        }
+
+        return $this->sanitizers;
+    }
+}

src/Traits/SanitizesInputs.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace ArondeParon\RequestSanitizer\Tests\Objects;
+
+use ArondeParon\RequestSanitizer\Traits\SanitizesInputs;
+use Illuminate\Foundation\Http\FormRequest;
+
+class Request extends FormRequest
+{
+    use SanitizesInputs;
+}