Skip to content

Commit

Permalink
- Initial Commit
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Niehoff <info@martin-niehoff.de>
  • Loading branch information
swatty007 committed Feb 18, 2021
1 parent 81e4fd5 commit 924e499
Show file tree
Hide file tree
Showing 19 changed files with 659 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
; This file is for unifying the coding style for different editors and IDEs.
; More information at http://editorconfig.org

root = true

[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false
11 changes: 11 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Path-based git attributes
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html

# Ignore all test and documentation with "export-ignore".
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/phpunit.xml.dist export-ignore
/.scrutinizer.yml export-ignore
/tests export-ignore
/.editorconfig export-ignore
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
build
composer.lock
package-lock.json
vendor
coverage
node_modules
storage
.idea
.php_cs.cache
.phpstorm.meta.php
.phpunit.result.cache
20 changes: 20 additions & 0 deletions .php_cs.dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

$finder = Symfony\Component\Finder\Finder::create()
->notPath('vendor')
->notPath('bootstrap')
->notPath('storage')
->in(__DIR__)
->name('*.php')
->notName('_ide_helper.php')
->notName('*.blade.php');

return PhpCsFixer\Config::create()
->setRules([
'@PSR2' => true,
'array_syntax' => ['syntax' => 'short'],
'ordered_imports' => ['sortAlgorithm' => 'alpha'],
'no_unused_imports' => true,
'no_leading_import_slash' => true
])
->setFinder($finder);
19 changes: 19 additions & 0 deletions .scrutinizer.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
filter:
excluded_paths: [tests/*]

checks:
php:
remove_extra_empty_lines: true
remove_php_closing_tag: true
remove_trailing_whitespace: true
fix_use_statements:
remove_unused: true
preserve_multiple: false
preserve_blanklines: true
order_alphabetically: true
fix_php_opening_tag: true
fix_linefeed: true
fix_line_ending: true
fix_identation_4spaces: true
fix_doc_comments: true

4 changes: 4 additions & 0 deletions .styleci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
preset: laravel

disabled:
- single_class_element_per_statement
20 changes: 20 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
language: php

php:
- 7.4
- 8.0

env:
matrix:
- COMPOSER_FLAGS="--prefer-lowest"
- COMPOSER_FLAGS=""

before_script:
- travis_retry composer self-update
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source

script:
- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover

after_script:
- php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

All notable changes to `laravel-context-prohibited-rule` will be documented in this file

## 1.0.0 - 2021-02-18

- initial release
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.

Please read and understand the contribution guide before creating an issue or pull request.

## Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

## Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open
source projects are used by many developers, who may have entirely different needs to your own. Think about
whether or not your feature is likely to be used by other users of the project.

## Procedure

Before filing an issue:

- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
- Check to make sure your feature suggestion isn't already present within the project.
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
- Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.

- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

**Happy coding**!
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Martin Niehoff

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.
86 changes: 86 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Context prohibited validation rule for Laravel

![Package Banner](./docs/banner.png "Package Banner")

[![Latest Version on Packagist](https://img.shields.io/packagist/v/swatty007/laravel-context-prohibited-rule.svg?style=flat-square)](https://packagist.org/packages/swatty007/laravel-context-prohibited-rule)
[![Build Status](https://img.shields.io/travis/swatty007/laravel-context-prohibited-rule/master.svg?style=flat-square)](https://travis-ci.org/swatty007/laravel-context-prohibited-rule)
[![Quality Score](https://img.shields.io/scrutinizer/g/swatty007/laravel-context-prohibited-rule.svg?style=flat-square)](https://scrutinizer-ci.com/g/swatty007/laravel-context-prohibited-rule)
[![Total Downloads](https://img.shields.io/packagist/dt/swatty007/laravel-context-prohibited-rule.svg?style=flat-square)](https://packagist.org/packages/swatty007/laravel-context-prohibited-rule)

Simple validation rule to disallow application related words within passwords.
Its checks that the entered data does not contain your application name, or url to prevent users weakening their passwords.

## Installation

You can install the package via composer:

```bash
composer require swatty007/laravel-context-prohibited-rule
```
Laravel's service provider discovery will automatically configure our service provider for you.

Add the validation message to your validation lang file:

For each language add a validation message to **validation.php** like below
```php
'context_prohibited' => 'Your :attribute shall not contain any of the following words: :prohibited',
```

## Configuration

After installing the package you can publish the configuration file via:
```php
php artisan vendor:publish --provider="Swatty007\LaravelContextProhibitedRule\ContextProhibitedServiceProvider"
```
It contains some optional configuration parameters and is fully documented.

## Usage
After installation, the ```php context_prohibited ``` validator will be available for use directly in your validation rules.
```php
'password' => 'context_prohibited'
// or preferred
'password' => ['required', new ContextProhibited],
```
> For error message to work correctly you should prefer to initialize the rule object!
Within the context of a registration form, it would look like this:
```php
return Validator::make($data, [
'name' => 'required|string|max:255',
'email' => 'required|string|email|max:255|unique:users',
'password' => 'required|string|min:8|context_prohibited|confirmed',
]);
```

### Testing
Yes we do!
``` bash
composer test
```

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## TODO

- Currently None

Pull Requests are welcome :monocle_face:

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

If you discover any security related issues, please email info@martin-niehoff.de instead of using the issue tracker.

## Credits

- [Martin Niehoff](https://github.com/swatty007)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
61 changes: 61 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{
"name": "swatty007/laravel-context-prohibited-rule",
"description": "Simple validation rule to disallow application related words within passwords.",
"keywords": [
"swatty007",
"laravel-context-prohibited-rule",
"laravel",
"validation",
"password",
"rule"
],
"homepage": "https://github.com/swatty007/laravel-context-prohibited-rule",
"license": "MIT",
"type": "library",
"authors": [
{
"name": "Martin Niehoff",
"email": "info@martin-niehoff.de",
"role": "Developer"
}
],
"require": {
"php": "^7.4|^8.0",
"illuminate/support": "^7.0|^8.0"
},
"require-dev": {
"orchestra/testbench": "^4.0|^5.0",
"phpunit/phpunit": "^8.0",
"phpmd/phpmd": "@stable",
"phpmetrics/phpmetrics": "^2.7",
"friendsofphp/php-cs-fixer": "^2.18"
},
"autoload": {
"psr-4": {
"Swatty007\\LaravelContextProhibitedRule\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Swatty007\\LaravelContextProhibitedRule\\Tests\\": "tests"
}
},
"scripts": {
"test": "vendor/bin/phpunit",
"test-f": "vendor/bin/phpunit --filter",
"test-coverage": "vendor/bin/phpunit --coverage-html coverage",
"format": "vendor/bin/php-cs-fixer fix --config=.php_cs.dist",
"smell": "vendor/bin/phpmd src/ html cleancode,naming --reportfile ./build/phpmd.html",
"metrics": "vendor/bin/phpmetrics --report-html=./build/metrics src/"
},
"config": {
"sort-packages": true
},
"extra": {
"laravel": {
"providers": [
"Swatty007\\LaravelContextProhibitedRule\\ContextProhibitedServiceProvider"
]
}
}
}
53 changes: 53 additions & 0 deletions config/config.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<?php

/*
* You can place your custom package configuration in here.
*/
return [
/*
|--------------------------------------------------------------------------
| Allow Application Name
|--------------------------------------------------------------------------
|
| This option defines, if your application name is allowed to pass our validation rule.
|
*/

'allow_application_name' => false,

/*
|--------------------------------------------------------------------------
| Allow Hostname
|--------------------------------------------------------------------------
|
| This option defines, if your applications hostname is allowed to pass our validation rule.
|
*/

'allow_hostname' => false,

/*
|--------------------------------------------------------------------------
| Min Length
|--------------------------------------------------------------------------
|
| This option defines the min length a word needs to have for our rule to take effect
|
*/

'min_length' => 3,

/*
|--------------------------------------------------------------------------
| Prohibited Words
|--------------------------------------------------------------------------
|
| This option allows you to define a set of default words,
| which should be disallowed.
|
*/

'prohibited_words' => [

],
];
Binary file added docs/banner.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 924e499

Please sign in to comment.