[Feature] Not intersect evaluator (#64)

* add evaluator

* up doc

* split feature bug

* fix stat analyse

* clean make

* add test

* fix make docs

* up docs

* fix evaluator when values count > 2

* catch invalid environment variable value

* up version

* up version

* add unreleased link to changelog

Author: ArtARTs36

.mr-linter.yml

@@ -75,6 +75,13 @@ rules:
         labels:
           has: "Feature"
 
+    - definition: "Split feature / bug PR"
+      rules:
+        labels:
+          notIntersect:
+            - Feature
+            - Bug
+
 notifications:
   channels:
     dev:

CHANGELOG.md

@@ -4,6 +4,15 @@ This file contains changelogs.
 
 [View all Releases](https://github.com/ArtARTs36/php-merge-request-linter/releases)
 
+## [Unreleased](https://github.com/ArtARTs36/php-merge-request-linter/compare/0.19.1..master)
+
+## [v0.19.1 (2023-09-12)](https://github.com/ArtARTs36/php-merge-request-linter/compare/0.19.0..0.19.1)
+
+### Added
+* Added an Evaluator `notIntersect` to check that the array does not intersect with the user array.
+
+[💾 Assets](https://github.com/ArtARTs36/php-merge-request-linter/releases/tag/0.19.1)
+
 -----------------------------------------------------------------
 
 ## [v0.19.0 (2023-09-11)](https://github.com/ArtARTs36/php-merge-request-linter/compare/0.18.1..0.19.0)

Makefile

@@ -4,59 +4,65 @@ ifneq ("$(wildcard .env)","")
 endif
 
 .PHONY: docs
+.DEFAULT_GOAL: help
 
-env:
+# Thanks to https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+help: ## Show this help
+	@printf "\033[33m%s:\033[0m\n" 'Available commands'
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / {printf "  \033[32m%-18s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+env: ## Create environment file for local testing
 	echo "MR_LINTER_GITHUB_HTTP_TOKEN=token\nMR_LINTER_GITLAB_HTTP_TOKEN=token\n" > .env
 	echo "E2E_MR_LINTER_GITHUB_HTTP_TOKEN=token\nE2E_MR_LINTER_GITLAB_HTTP_TOKEN=token" >> .env
 	echo "E2E_MR_LINTER_BITBUCKET_APP_USER=token\nE2E_MR_LINTER_BITBUCKET_APP_PASSWORD=token\n" >> .env
 
-# usage as `make try MR_ID=1`
-try:
-	GITHUB_ACTIONS=1 \
-	GITHUB_REPOSITORY=artarts36/php-merge-request-linter \
-	GITHUB_GRAPHQL_URL=https://api.github.com/graphql \
-	GITHUB_REF_NAME=${MR_ID}/merge \
-	./bin/mr-linter lint --debug --metrics
-
-# usage as `make try-phar MR_ID=1`
-try-phar: build-phar
-	GITHUB_ACTIONS=1 \
-	GITHUB_REPOSITORY=artarts36/php-merge-request-linter \
-	GITHUB_GRAPHQL_URL=https://api.github.com/graphql \
-	GITHUB_REF_NAME=${MR_ID}/merge \
-	./bin/build/mr-linter.phar lint --debug --metrics
+#######################################
+# Locally run of MR-Linter
+######################################
 
-# usage as `make try MR_ID=1`
-try-docker: docker-build
+try: docker-build ## Try lint on docker with GitHub Actions: usage as `make try MR_ID=1`
 	docker run \
+		--rm \
 		--env-file .env \
 		--env GITHUB_ACTIONS=1 \
 		--env GITHUB_REPOSITORY=artarts36/php-merge-request-linter \
 		--env GITHUB_GRAPHQL_URL=https://api.github.com/graphql \
 		--env GITHUB_REF_NAME=${MR_ID}/merge \
 		artarts36/merge-request-linter:testing "lint" --debug --metrics
 
-# usage as `make try-gitlab MR_ID=1`
-try-gitlab:
-	GITLAB_CI=1 \
-	CI_MERGE_REQUEST_IID=${MR_ID} \
-	CI_MERGE_REQUEST_PROJECT_ID=41749211 \
-	CI_SERVER_URL=https://gitlab.com \
- 	./bin/mr-linter lint --debug --metrics
-
-# usage as `make try-bitbucket MR_ID=2`
-try-bitbucket:
-	BITBUCKET_PROJECT_KEY=ArtARTs36 \
-	BITBUCKET_PR_ID=${MR_ID} \
-	BITBUCKET_WORKSPACE=ArtARTs36 \
-	BITBUCKET_REPO_SLUG=test-repo \
- 	./bin/mr-linter lint --debug --metrics
-
-docker-build:
-	docker build . -t artarts36/merge-request-linter:testing
+try-gitlab: ## Try lint on docker with Gitlab CI: usage as `make try-gitlab MR_ID=1`
+	docker run \
+		--rm \
+		--env-file .env \
+		--env GITLAB_CI=1 \
+		--env CI_MERGE_REQUEST_IID=${MR_ID} \
+		--env CI_MERGE_REQUEST_PROJECT_ID=41749211 \
+		--env CI_SERVER_URL=https://gitlab.com \
+		artarts36/merge-request-linter:testing "lint" --debug --metrics
+
+try-bitbucket: ## Try lint on docker with Gitlab CI: usage as `make try-bitbucket MR_ID=1`
+	docker run \
+		--rm \
+		--env-file .env \
+		--env BITBUCKET_PROJECT_KEY=ArtARTs36 \
+		--env BITBUCKET_PR_ID=${MR_ID} \
+		--env BITBUCKET_WORKSPACE=ArtARTs36 \
+		--env BITBUCKET_REPO_SLUG=test-repo \
+		artarts36/merge-request-linter:testing "lint" --debug --metrics
 
-docker-lint: docker-build
-	docker run artarts36/merge-request-linter lint
+try-phar: build-phar ## Try lint on PHAR: usage as `make try-phar MR_ID=1`
+	GITHUB_ACTIONS=1 \
+	GITHUB_REPOSITORY=artarts36/php-merge-request-linter \
+	GITHUB_GRAPHQL_URL=https://api.github.com/graphql \
+	GITHUB_REF_NAME=${MR_ID}/merge \
+	./bin/build/mr-linter.phar lint --debug --metrics
+
+#######################################
+# Build of MR-Linter
+######################################
+
+docker-build: ## Build docker image for local testing
+	docker build . -t artarts36/merge-request-linter:testing
 
 # usage as `make docker-pub-build MR_LINTER_VERSION=0.2.0`
 docker-pub-build:
@@ -85,17 +91,12 @@ docker-pub-try:
 		-v "${PWD}/.mr-linter.yml:/app/.mr-linter.yml:ro" \
 		artarts36/merge-request-linter:${MR_LINTER_VERSION} lint
 
-docs:
-	php docs/Builder/build_rules.php
-	php docs/Builder/build_config_json_schema.php
-	php docs/Builder/build_conditions.php
-
-docs-docker: docker-build
+docs: ## Build documentation
 	docker run \
 		--rm \
 		--volume ./:/app \
 		--env-file .env \
-		--entrypoint "make" \
+		--entrypoint "composer" \
 		artarts36/merge-request-linter:testing "docs"
 
 deps-check:
@@ -110,16 +111,18 @@ check: deps-check
 	composer deptrac
 	composer test
 
-info:
-	./bin/mr-linter info
-
-dump:
-	./bin/mr-linter dump
+info: ## Run "mr-linter info" on docker
+	docker run \
+		--rm \
+		--volume ./:/app \
+		--env-file .env \
+		artarts36/merge-request-linter:testing "info"
 
-dump-docker: docker-build
+dump: ## Run "mr-linter dump" on docker
 	docker run \
+		--rm \
 		--volume ./:/app \
-		--entrypoint "make" \
+		--env-file .env \
 		artarts36/merge-request-linter:testing "dump"
 
 push-docs:
@@ -139,37 +142,38 @@ lint-fix-docker: docker-build
 		--entrypoint "composer" \
 		artarts36/merge-request-linter:testing "lint-fix"
 
-stat-analyse-docker: docker-build
+stat-analyse: docker-build
 	docker run \
+		--rm \
 		--env-file .env \
 		--entrypoint "composer" \
 		artarts36/merge-request-linter:testing "stat-analyse"
 
-test-e2e:
-	composer test-e2e
-
-test-e2e-docker: docker-build
+test-e2e: docker-build
 	docker run \
+		--rm \
 		--env-file .env \
 		--entrypoint "composer" \
 		artarts36/merge-request-linter:testing "test-e2e"
 
-test-docker: docker-build
+test: docker-build ## Run tests
 	docker run \
+		--rm \
 		--volume ./:/app/ \
 		--env-file .env \
 		--entrypoint "composer" \
 		artarts36/merge-request-linter:testing "test"
 
-deptrac-docker: docker-build
+deptrac: docker-build ## Run deptrac
 	docker run \
+		--rm \
 		--env-file .env \
 		--entrypoint "composer" \
 		artarts36/merge-request-linter:testing "deptrac"
 
-check-docker: lint-docker stat-analyse-docker test-docker deptrac-docker
+check-docker: lint-docker stat-analyse test deptrac
 
-build-phar:
+build-phar: ## Build PHAR
 	composer install --no-interaction --no-dev --prefer-dist --optimize-autoloader
 	cd dev/build/ && composer install
 	./dev/build/vendor/bin/box compile

composer.json

@@ -83,6 +83,9 @@
         ],
         "test-e2e": [
             "./vendor/bin/phpunit --filter testLint ./tests/E2E/LintE2ETest.php"
+        ],
+        "docs": [
+            "@php ./docs/builder/build.php"
         ]
     },
     "config": {

docs/Builder/ConfigJsonSchema/OperatorSchemaArrayGenerator.php

@@ -21,6 +21,7 @@
 use ArtARTs36\MergeRequestLinter\Application\Condition\Evaluators\NotEqualsEvaluator;
 use ArtARTs36\MergeRequestLinter\Application\Condition\Evaluators\NotHasAnyEvaluator;
 use ArtARTs36\MergeRequestLinter\Application\Condition\Evaluators\NotHasEvaluator;
+use ArtARTs36\MergeRequestLinter\Application\Condition\Evaluators\NotIntersectEvaluator;
 use ArtARTs36\MergeRequestLinter\Application\Condition\Evaluators\Strings\Cases\IsCamelCaseEvaluator;
 use ArtARTs36\MergeRequestLinter\Application\Condition\Evaluators\Strings\Cases\IsKebabCaseEvaluator;
 use ArtARTs36\MergeRequestLinter\Application\Condition\Evaluators\Strings\Cases\IsLowerCaseEvaluator;
@@ -110,6 +111,7 @@ class OperatorSchemaArrayGenerator
             IsEmptyEvaluator::class,
             AllEvaluator::class,
             AnyEvaluator::class,
+            NotIntersectEvaluator::class,
         ],
         Map::class => [
             CountMinEvaluator::class,
@@ -124,6 +126,7 @@ class OperatorSchemaArrayGenerator
             IsEmptyEvaluator::class,
             AllEvaluator::class,
             AnyEvaluator::class,
+            NotIntersectEvaluator::class,
         ],
         Arrayee::class => [
             CountMinEvaluator::class,
@@ -138,6 +141,7 @@ class OperatorSchemaArrayGenerator
             IsEmptyEvaluator::class,
             AllEvaluator::class,
             AnyEvaluator::class,
+            NotIntersectEvaluator::class,
         ],
         'bool' => [
             EqualsEvaluator::class,

docs/Builder/build.php

@@ -0,0 +1,50 @@
+<?php
+
+use ArtARTs36\MergeRequestLinter\DocBuilder\ConditionsPageBuilder;
+use ArtARTs36\MergeRequestLinter\DocBuilder\RulesPageBuilder;
+
+require __DIR__ . '/../../vendor/autoload.php';
+
+$builders = [
+    [
+        'name' => 'Rules page',
+        'path' => __DIR__ . '/../rules.md',
+        'builder' => function () {
+            $builder = new RulesPageBuilder();
+
+            return $builder->build();
+        },
+    ],
+    [
+        'name' => 'Config JSON Schema',
+        'path' => __DIR__ . '/../../mr-linter-config-schema.json',
+        'builder' => function () {
+            $jsonSchema = new \ArtARTs36\MergeRequestLinter\DocBuilder\ConfigJsonSchema\Generator();
+
+            return $jsonSchema->generate()->toJson();
+        },
+    ],
+    [
+        'name' => 'Conditions page',
+        'path' => __DIR__ . '/../conditions.md',
+        'builder' => function () {
+            $builder = new ConditionsPageBuilder();
+
+            return $builder->build();
+        },
+    ],
+];
+
+$saver = new \ArtARTs36\MergeRequestLinter\DocBuilder\Saver();
+
+foreach ($builders as $builder) {
+    $result = $builder['builder']();
+
+    $updated = $saver->save($builder['path'], $result);
+
+    if ($updated) {
+        echo sprintf('-> %s: Documentation page updated', $builder['name']) . "\n";
+    } else {
+        echo sprintf('-> %s: Documentation page is actually', $builder['name']) . "\n";
+    }
+}

docs/Builder/build_conditions.php

@@ -48,4 +48,5 @@ Currently is available that operators:
 | containsHeading4 | Check if a markdown-string contains a heading. | string |
 | containsHeading5 | Check if a markdown-string contains a heading. | string |
 | containsHeading6 | Check if a markdown-string contains a heading. | string |
+| notIntersect | Check that the array does not intersect with the user array. | array of strings |