feat: repository moved from GitLab to GitHub

Author: Saligzhanov Ilya

.gitattributes

@@ -0,0 +1,7 @@
+.gitlab/               export-ignore
+tests/                 export-ignore
+.gitignore             export-ignore
+.gitattributes         export-ignore
+.php-cs-fixer.dist.php export-ignore
+phpstan.neon           export-ignore
+phpunit.xml            export-ignore

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+<!-- Развёрнутое описание изменений на русском -->
+
+## Чек-лист
+
+- [ ] Я **самостоятельно** проверил код моих изменений **перед** тем, как отдать его на code-review
+- [ ] Я подтянул `main`-ветку
+- [ ] Заголовок MR-а соответствует сути задачи и написан в формате [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

.gitignore

@@ -0,0 +1,3 @@
+.idea
+/vendor/
+*.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,19 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+                           ->in(__DIR__ . '/')
+                           ->in(__DIR__ . '/src')
+                           ->append(['.php_cs']);
+
+$rules = [
+    '@PSR12'                      => true,
+    'array_syntax'                => ['syntax' => 'short'],
+    'blank_line_before_statement' => true,
+];
+
+$rules['increment_style'] = ['style' => 'post'];
+
+return (new PhpCsFixer\Config())
+    ->setUsingCache(false)
+    ->setRules($rules)
+    ->setFinder($finder);

ASSURANCE.md

@@ -0,0 +1,28 @@
+# Honesty assurance
+
+1. [ru_RU Русский](#Клятва чести)
+2. [en_EN English](#Oath of honor)
+
+## Клятва чести
+
+Я, `LeTraceurSnork`, торжественно клянусь, что этот и все мои другие OpenSource проекты я не закрою, не подвергну
+сознательным вредоносным изменениям, не ограничу доступ, не буду использовать пакет в политических, культурных и любых
+других, не связанных с назначением проекта, целях и буду по мере сил и возможностей способствовать его продвижению и
+общедоступности*. Нарушение мной клятвы по любым, особенно политическим причинам, даёт право обнаружившему нарушение
+называть меня маленькой сопливой девочкой, пуськой и другими обидными прозвищами, а также отказаться от использования
+всех моих пакетов. Удаление данного файла из репозитория приравнивается к нарушению клятвы.
+
+*- Кроме случаев, когда это противоречит законодательству страны, контролирующей территорию распространения, или
+предоставляющей гражданство получателю.
+
+## Oath of honor
+
+I, `LeTraceurSnork`, do solemnly swear that this and all my other OpenSource projects I will not shut down, subject to
+deliberately harmful changes, restrict access to, or use the package for political, cultural, or any other purposes that
+is unrelated to the project designation, and I will, to the best of my ability, contribute to its promotion and public
+access*. Violation of my oath for any, especially political reasons, entitles the person who discovered the violation to
+call me a snotty little girl and other offensive nicknames, and also refuse to use all my packages. Removing
+this file from the repository is tantamount to breaking an oath.
+
+*- Except when it is contrary to the laws of the country that controls the territory of distribution, or grants
+citizenship to the recipient.

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog][keepachangelog] and this project adheres to [Semantic Versioning][semver].
+
+---
+
+## [v1.0.0](https://gitlab.com/LeTraceurSnork/russian-validators/-/compare/905c00d52eb9a65b5af902bef6ccdbaf7224a24c...v1.0.0)
+
+### Added
+
+- INN, KPP, OGRN/OGRNIP and SNILS validators and its tests
+- AbstractValidator class and its Interface to grant an ability to extend the functionality
+
+[keepachangelog]:https://keepachangelog.com/en/1.0.0/
+
+[semver]:https://semver.org/spec/v2.0.0.html
+
+[@saligzhanov.i]:https://gitlab.spectrumdata.tech/saligzhanov.i

README.md

@@ -1,2 +1,47 @@
-# russian-validators
-Валидаторы российских идентификаторов
+# Russian Validators
+
+## Описание
+
+Пакет предназначен для валидации различных идентификаторов, принятых в РФ - СНИЛС, ИНН, ОГРН/ОГРНИП и КПП, поскольку
+"международные" валидаторы (напр., из пакета Symfony) не учитывают их отдельно от VAT и прочих международных
+аналогов
+
+В описании каждого класса валидатора приведена ссылка на Википедию и, по возможности, на соответствующий закон
+Правительства, поясняющий, почему тот или иной идентификатор валидируется именно так
+
+## Установка с помощью composer
+
+```
+composer install letraceursnork/russian-validators
+```
+
+## Требования
+
+Пакет требует всего двух пунктов:
+
+1. PHP 8.0+
+2. Установленную и подключенную библиотеку `BCMath` (`ext-bcmath`)
+
+## Пример использования
+
+```php
+use LTS\RussianValidators\InnValidator;
+//use LTS\RussianValidators\KppValidator;
+//use LTS\RussianValidators\OgrnipValidator;
+//use LTS\RussianValidators\OgrnValidator;
+//use LTS\RussianValidators\SnilsValidator;
+
+$value = '<SOME_INN>';
+$validator = new InnValidator(); // или любой другой класс валидатора из перечисленных выше
+
+$validator->setPurifyPattern('[-+\/\*\\_\.,\s]'); // установить $pattern для функции preg_replace. Все символы, попадающие под $pattern будут удалены из строки перед валидацией. Позволяет очистить строку от разделителей - $pattern по-умолчанию `[-+\/\*\\_\.,\s]`
+
+$is_valid  = $validator->validate($value); // true|false
+
+$validator->throwErrorOnInvalid(); // При неудачной валидации не возвращает false, а выбрасывает исключение типа InvalidArgumentException
+try {
+    $is_valid = $validator->validate($value); // true, если валидация успешна
+} catch(InvalidArgumentException $exception) {
+    // Обработка исключения
+}
+```

composer.json

@@ -0,0 +1,33 @@
+{
+  "name": "letraceursnork/russian-validators",
+  "description": "A package containing various validators of Russian identifiers e.g. INN, SNILS, OGRN etc.",
+  "type": "library",
+  "license": "MIT",
+  "autoload": {
+    "psr-4": {
+      "LTS\\RussianValidators\\": "src/",
+      "LTS\\RussianValidators\\Tests\\": "tests/"
+    }
+  },
+  "authors": [
+    {
+      "name": "letraceursnork",
+      "email": "[email protected]"
+    }
+  ],
+  "minimum-stability": "stable",
+  "require": {
+    "php": ">=8.0",
+    "ext-bcmath": "*"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^9.5",
+    "phpstan/phpstan": "^1.9",
+    "friendsofphp/php-cs-fixer": "^3.13"
+  },
+  "scripts": {
+    "phpunit": "@php ./vendor/bin/phpunit ./tests --configuration phpunit.xml --no-coverage --color=always",
+    "phpstan": "@php ./vendor/bin/phpstan analyze -c ./phpstan.neon --no-progress --ansi --verbose",
+    "php-cs-fixer-fix": "@php ./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php"
+  }
+}