├── .gitignore ├── .scrutinizer.yml ├── .travis.yml ├── LICENSE ├── README.md ├── composer.json ├── composer.lock ├── phpunit.xml ├── src └── Subdomain.php └── tests ├── Feature └── SubdomainTest.php └── TestCase.php /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor 2 | /.idea 3 | coverage.xml 4 | -------------------------------------------------------------------------------- /.scrutinizer.yml: -------------------------------------------------------------------------------- 1 | filter: 2 | paths: [src/*] 3 | excluded_paths: [tests/*] 4 | checks: 5 | php: 6 | code_rating: true 7 | remove_extra_empty_lines: true 8 | remove_php_closing_tag: true 9 | remove_trailing_whitespace: true 10 | fix_use_statements: 11 | remove_unused: true 12 | preserve_multiple: false 13 | preserve_blanklines: true 14 | order_alphabetically: true 15 | fix_php_opening_tag: true 16 | fix_linefeed: true 17 | fix_line_ending: true 18 | fix_identation_4spaces: true 19 | fix_doc_comments: true 20 | tools: 21 | external_code_coverage: true 22 | php_code_coverage: false 23 | php_code_sniffer: 24 | config: 25 | standard: PSR2 26 | filter: 27 | paths: ['src'] 28 | php_loc: 29 | enabled: true 30 | excluded_dirs: [vendor] 31 | php_cpd: 32 | enabled: true 33 | excluded_dirs: [vendor] 34 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: php 2 | 3 | matrix: 4 | include: 5 | - php: 7.1 6 | env: ILLUMINATE_MINOR_VERSION=5 PHP_UNIT=6.0 7 | - php: 7.2 8 | env: ILLUMINATE_MINOR_VERSION=5 PHP_UNIT=6.0 9 | - php: 7.3 10 | env: ILLUMINATE_MINOR_VERSION=5 PHP_UNIT=6.0 11 | 12 | - php: 7.1 13 | env: ILLUMINATE_MINOR_VERSION=6 PHP_UNIT=7.0 14 | - php: 7.2 15 | env: ILLUMINATE_MINOR_VERSION=6 PHP_UNIT=7.0 16 | - php: 7.3 17 | env: ILLUMINATE_MINOR_VERSION=6 PHP_UNIT=7.0 18 | 19 | - php: 7.1 20 | env: ILLUMINATE_MINOR_VERSION=7 PHP_UNIT=7.0 21 | - php: 7.2 22 | env: ILLUMINATE_MINOR_VERSION=7 PHP_UNIT=7.0 23 | - php: 7.3 24 | env: ILLUMINATE_MINOR_VERSION=7 PHP_UNIT=7.0 25 | 26 | - php: 7.1 27 | env: ILLUMINATE_MINOR_VERSION=8 PHP_UNIT=7.0 28 | - php: 7.2 29 | env: ILLUMINATE_MINOR_VERSION=8 PHP_UNIT=7.0 30 | - php: 7.3 31 | env: ILLUMINATE_MINOR_VERSION=8 PHP_UNIT=7.0 32 | 33 | cache: 34 | directories: 35 | - $HOME/.composer/cache 36 | 37 | before_install: 38 | - travis_retry composer self-update 39 | - composer require "illuminate/contracts:5.${ILLUMINATE_MINOR_VERSION}.*" --no-update 40 | - composer require "orchestra/testbench:3.${ILLUMINATE_MINOR_VERSION}.*" --no-update 41 | - composer require "phpunit/phpunit:^${PHP_UNIT}" --no-update 42 | 43 | install: 44 | - travis_retry composer update --prefer-source --no-interaction --no-suggest 45 | 46 | script: 47 | - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover 48 | 49 | after_script: 50 | - wget https://scrutinizer-ci.com/ocular.phar 51 | - php ocular.phar code-coverage:upload --format=php-clover coverage.clover 52 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Subdomain 2 | 3 | Validates a user submitted subdomain in your application. 4 | 5 |

6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 |

19 | 20 | Supports Laravel: 5.5, 5.6, 5.7 & 5.8 21 | 22 | ## Installation 23 | 24 | ```bash 25 | composer require laravel-validation-rules/subdomain 26 | ``` 27 | 28 | ## Usage 29 | 30 | ```php 31 | use LVR\Subdomain\Subdomain; 32 | 33 | $request->validate([ 34 | 'domain' => ['required', new Subdomain], 35 | ]); 36 | ``` 37 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "laravel-validation-rules/subdomain", 3 | "description": "Validate a user submitted subdomain", 4 | "type": "library", 5 | "license": "Apache-2.0", 6 | "authors": [ 7 | { 8 | "name": "Ashley Clarke", 9 | "email": "me@ashleyclarke.me" 10 | }, 11 | { 12 | "name": "Scott Robinson", 13 | "email": "scott@dor.ky", 14 | "homepage": "http://dor.ky" 15 | } 16 | ], 17 | "require": { 18 | "illuminate/contracts": "^5.5|^6.0|^7.0|^8.0|^9.0" 19 | }, 20 | "require-dev": { 21 | "orchestra/testbench": "^3.5|^5.0|^7.0", 22 | "phpunit/phpunit": "^6.0|^7.0|^9.0" 23 | }, 24 | "autoload": { 25 | "psr-4": { 26 | "LVR\\Subdomain\\": "src/" 27 | } 28 | }, 29 | "autoload-dev": { 30 | "psr-4": { 31 | "LVR\\Subdomain\\Tests\\": "tests/" 32 | } 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /phpunit.xml: -------------------------------------------------------------------------------- 1 | 2 | 11 | 12 | 13 | ./tests/Feature 14 | 15 | 16 | 17 | ./tests/Unit 18 | 19 | 20 | 21 | 22 | ./src 23 | 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /src/Subdomain.php: -------------------------------------------------------------------------------- 1 | $value], ['slug' => new Subdomain]); 25 | } 26 | 27 | /** 28 | * @param $value 29 | * 30 | * @return string 31 | */ 32 | public function message($value) 33 | { 34 | return $this->validate($value)->messages()->first('slug'); 35 | } 36 | 37 | /** 38 | * @test 39 | */ 40 | public function it_must_start_and_end_with_an_alpha_numeric_character() 41 | { 42 | Assert::assertTrue($this->validate('example')->passes()); 43 | 44 | Assert::assertFalse($this->validate('-example')->passes()); 45 | Assert::assertFalse($this->validate('.example')->passes()); 46 | Assert::assertFalse($this->validate('example-')->passes()); 47 | Assert::assertFalse($this->validate('example-')->passes()); 48 | } 49 | 50 | /** 51 | * @test 52 | */ 53 | public function it_can_contain_dashes() 54 | { 55 | Assert::assertFalse($this->validate('-example')->passes()); 56 | Assert::assertFalse($this->validate('example-')->passes()); 57 | 58 | Assert::assertTrue($this->validate('this-is-a-test')->passes()); 59 | } 60 | 61 | /** 62 | * @test 63 | */ 64 | public function it_checks_against_a_list_of_reserved_subdomains() 65 | { 66 | Assert::assertTrue($this->validate('mycompany')->passes()); 67 | 68 | Assert::assertFalse($this->validate('www')->passes()); 69 | Assert::assertFalse($this->validate('mail')->passes()); 70 | Assert::assertFalse($this->validate('assets')->passes()); 71 | Assert::assertFalse($this->validate('ftp')->passes()); 72 | Assert::assertFalse($this->validate('billing')->passes()); 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /tests/TestCase.php: -------------------------------------------------------------------------------- 1 |