jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/378932 )

Change subject: Finish new check result status for T175570
......................................................................


Finish new check result status for T175570

In Ia82a80aeb3, I added a new check result status for when a constraint
check is skipped because the context is not a 'statement'-type context.
This commit cleans it up a bit:

1. Change it to the slightly clearer 'not-main-snak'.
2. Add a missing i18n/ message, which is used on the special page.
3. Add a missing color, also used on the special page.
4. Explicitly declare its sort order. (Also, use named constants there.)

Also, document steps 2, 3 and 4 below the last status in CheckResult.php
so that perhaps they’re not forgotten the next time a status is added.

Bug: T175570
Change-Id: Ia3a14e4e232b2ceee4b100ccd07b177fc8f870ad
---
M i18n/en.json
M i18n/qqq.json
M includes/ConstraintCheck/Checker/ConflictsWithChecker.php
M includes/ConstraintCheck/Checker/DiffWithinRangeChecker.php
M includes/ConstraintCheck/Checker/InverseChecker.php
M includes/ConstraintCheck/Checker/ItemChecker.php
M includes/ConstraintCheck/Checker/MandatoryQualifiersChecker.php
M includes/ConstraintCheck/Checker/MultiValueChecker.php
M includes/ConstraintCheck/Checker/QualifiersChecker.php
M includes/ConstraintCheck/Checker/SingleValueChecker.php
M includes/ConstraintCheck/Checker/SymmetricChecker.php
M includes/ConstraintCheck/Checker/TypeChecker.php
M includes/ConstraintCheck/Checker/UniqueValueChecker.php
M includes/ConstraintCheck/DelegatingConstraintChecker.php
M includes/ConstraintCheck/Result/CheckResult.php
M modules/SpecialConstraintReportPage.css
16 files changed, 32 insertions(+), 21 deletions(-)

Approvals:
  jenkins-bot: Verified
  Thiemo Mättig (WMDE): Looks good to me, approved



diff --git a/i18n/en.json b/i18n/en.json
index 7939b0e..2b9c2cf 100644
--- a/i18n/en.json
+++ b/i18n/en.json
@@ -24,6 +24,7 @@
        "wbqc-constraintreport-status-bad-parameters": "Bad parameters",
        "wbqc-constraintreport-status-deprecated": "Deprecated",
        "wbqc-constraintreport-status-warning": "Warning",
+       "wbqc-constraintreport-status-not-main-snak": "Not main snak",
        "wbqc-constraintreport-result-table-header-status": "Status",
        "wbqc-constraintreport-result-table-header-claim": "Claim",
        "wbqc-constraintreport-result-table-header-constraint": "Constraint",
diff --git a/i18n/qqq.json b/i18n/qqq.json
index 8575536..f31c8b1 100644
--- a/i18n/qqq.json
+++ b/i18n/qqq.json
@@ -27,6 +27,7 @@
        "wbqc-constraintreport-status-bad-parameters": "Status for constraints 
that have missing or invalid constraint parameters.",
        "wbqc-constraintreport-status-deprecated": "Status for constraint 
checks that have been skipped because the statement is deprecated.",
        "wbqc-constraintreport-status-warning": "Status for statements that 
violate a non-mandatory constraint.\n{{Identical|Warning}}",
+       "wbqc-constraintreport-status-not-main-snak": "Status for constraint 
checks that have been skipped because the snak to be checked is not the main 
snak of a statement (e. g. a qualifier or reference).",
        "wbqc-constraintreport-result-table-header-status": "Header of the 
column that tells whether the check found a violation or something 
else.\n{{Identical|Status}}",
        "wbqc-constraintreport-result-table-header-claim": "Header of the 
column that displays a link to the claim, the used property and its 
value.\n{{Identical|Claim}}",
        "wbqc-constraintreport-result-table-header-constraint": "Header of the 
column that gives information about which constraint was 
checked.\n{{Identical|Constraint}}",
diff --git a/includes/ConstraintCheck/Checker/ConflictsWithChecker.php 
b/includes/ConstraintCheck/Checker/ConflictsWithChecker.php
index 3957a7d..54a685c 100644
--- a/includes/ConstraintCheck/Checker/ConflictsWithChecker.php
+++ b/includes/ConstraintCheck/Checker/ConflictsWithChecker.php
@@ -76,7 +76,7 @@
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
                        // TODO T175562
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $parameters = [];
diff --git a/includes/ConstraintCheck/Checker/DiffWithinRangeChecker.php 
b/includes/ConstraintCheck/Checker/DiffWithinRangeChecker.php
index ed88f83..c18f319 100644
--- a/includes/ConstraintCheck/Checker/DiffWithinRangeChecker.php
+++ b/includes/ConstraintCheck/Checker/DiffWithinRangeChecker.php
@@ -89,7 +89,7 @@
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
                        // TODO T175565
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $parameters = [];
diff --git a/includes/ConstraintCheck/Checker/InverseChecker.php 
b/includes/ConstraintCheck/Checker/InverseChecker.php
index 954e9b6..fc6c03a 100644
--- a/includes/ConstraintCheck/Checker/InverseChecker.php
+++ b/includes/ConstraintCheck/Checker/InverseChecker.php
@@ -76,7 +76,7 @@
                        return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_DEPRECATED );
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $parameters = [];
diff --git a/includes/ConstraintCheck/Checker/ItemChecker.php 
b/includes/ConstraintCheck/Checker/ItemChecker.php
index 1eaa65e..d1099d7 100644
--- a/includes/ConstraintCheck/Checker/ItemChecker.php
+++ b/includes/ConstraintCheck/Checker/ItemChecker.php
@@ -75,7 +75,7 @@
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
                        // TODO T175562
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $parameters = [];
diff --git a/includes/ConstraintCheck/Checker/MandatoryQualifiersChecker.php 
b/includes/ConstraintCheck/Checker/MandatoryQualifiersChecker.php
index f5805cc..4605ec1 100644
--- a/includes/ConstraintCheck/Checker/MandatoryQualifiersChecker.php
+++ b/includes/ConstraintCheck/Checker/MandatoryQualifiersChecker.php
@@ -57,7 +57,7 @@
                        return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_DEPRECATED );
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $parameters = [];
diff --git a/includes/ConstraintCheck/Checker/MultiValueChecker.php 
b/includes/ConstraintCheck/Checker/MultiValueChecker.php
index bdb00b8..00d6e90 100644
--- a/includes/ConstraintCheck/Checker/MultiValueChecker.php
+++ b/includes/ConstraintCheck/Checker/MultiValueChecker.php
@@ -41,7 +41,7 @@
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
                        // TODO T175566
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $propertyId = $context->getSnak()->getPropertyId();
diff --git a/includes/ConstraintCheck/Checker/QualifiersChecker.php 
b/includes/ConstraintCheck/Checker/QualifiersChecker.php
index b91cabe..b26d0d2 100644
--- a/includes/ConstraintCheck/Checker/QualifiersChecker.php
+++ b/includes/ConstraintCheck/Checker/QualifiersChecker.php
@@ -57,7 +57,7 @@
                        return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_DEPRECATED );
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $parameters = [];
diff --git a/includes/ConstraintCheck/Checker/SingleValueChecker.php 
b/includes/ConstraintCheck/Checker/SingleValueChecker.php
index 02d6fbc..03ba8f5 100644
--- a/includes/ConstraintCheck/Checker/SingleValueChecker.php
+++ b/includes/ConstraintCheck/Checker/SingleValueChecker.php
@@ -41,7 +41,7 @@
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
                        // TODO T175566
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $propertyId = $context->getSnak()->getPropertyId();
diff --git a/includes/ConstraintCheck/Checker/SymmetricChecker.php 
b/includes/ConstraintCheck/Checker/SymmetricChecker.php
index 4ad3829..515e9e7 100644
--- a/includes/ConstraintCheck/Checker/SymmetricChecker.php
+++ b/includes/ConstraintCheck/Checker/SymmetricChecker.php
@@ -66,7 +66,7 @@
                        return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_DEPRECATED );
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $parameters = [];
diff --git a/includes/ConstraintCheck/Checker/TypeChecker.php 
b/includes/ConstraintCheck/Checker/TypeChecker.php
index 245649f..73719f3 100644
--- a/includes/ConstraintCheck/Checker/TypeChecker.php
+++ b/includes/ConstraintCheck/Checker/TypeChecker.php
@@ -77,7 +77,7 @@
                        return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_DEPRECATED );
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $parameters = [];
diff --git a/includes/ConstraintCheck/Checker/UniqueValueChecker.php 
b/includes/ConstraintCheck/Checker/UniqueValueChecker.php
index ac5ee30..03c4b44 100644
--- a/includes/ConstraintCheck/Checker/UniqueValueChecker.php
+++ b/includes/ConstraintCheck/Checker/UniqueValueChecker.php
@@ -59,7 +59,7 @@
                }
                if ( $context->getType() !== Context::TYPE_STATEMENT ) {
                        // TODO T175561
-                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOSTATEMENT );
+                       return new CheckResult( $context, $constraint, [], 
CheckResult::STATUS_NOT_MAIN_SNAK );
                }
 
                $parameters = [];
diff --git a/includes/ConstraintCheck/DelegatingConstraintChecker.php 
b/includes/ConstraintCheck/DelegatingConstraintChecker.php
index c3ace71..7514830 100644
--- a/includes/ConstraintCheck/DelegatingConstraintChecker.php
+++ b/includes/ConstraintCheck/DelegatingConstraintChecker.php
@@ -384,12 +384,13 @@
                $sortFunction = function ( CheckResult $a, CheckResult $b ) {
                        $orderNum = 0;
                        $order = [
-                               'bad-parameters' => $orderNum++,
-                               'violation' => $orderNum++,
-                               'warning' => $orderNum++,
-                               'exception' => $orderNum++,
-                               'compliance' => $orderNum++,
-                               'deprecated' => $orderNum++,
+                               CheckResult::STATUS_BAD_PARAMETERS => 
$orderNum++,
+                               CheckResult::STATUS_VIOLATION => $orderNum++,
+                               CheckResult::STATUS_WARNING => $orderNum++,
+                               CheckResult::STATUS_EXCEPTION => $orderNum++,
+                               CheckResult::STATUS_COMPLIANCE => $orderNum++,
+                               CheckResult::STATUS_DEPRECATED => $orderNum++,
+                               CheckResult::STATUS_NOT_MAIN_SNAK => 
$orderNum++,
                                'other' => $orderNum++,
                        ];
 
diff --git a/includes/ConstraintCheck/Result/CheckResult.php 
b/includes/ConstraintCheck/Result/CheckResult.php
index 12dbd61..1750250 100644
--- a/includes/ConstraintCheck/Result/CheckResult.php
+++ b/includes/ConstraintCheck/Result/CheckResult.php
@@ -52,11 +52,18 @@
         */
        const STATUS_WARNING = 'warning';
        /**
-        * The constraint type is only checked on statements,
-        * but the current context is not a statement context,
+        * The constraint type is only checked on the main snak of a statement,
+        * but the current context is not a 'statement'-type context
+        * (e. g. a 'qualifier' or 'reference' context),
         * so the constraint check is skipped.
         */
-       const STATUS_NOSTATEMENT = 'no-statement';
+       const STATUS_NOT_MAIN_SNAK = 'not-main-snak';
+       /*
+        * When adding another status, don’t forget to also do the following:
+        * * define a message for it in i18n/
+        * * declare a color for it in modules/SpecialConstraintReportPage.css
+        * * update $order in updateDelegatingConstraintChecker::sortResult
+        */
 
        /**
         * @var Constraint
diff --git a/modules/SpecialConstraintReportPage.css 
b/modules/SpecialConstraintReportPage.css
index deb2ff2..3115b48 100644
--- a/modules/SpecialConstraintReportPage.css
+++ b/modules/SpecialConstraintReportPage.css
@@ -40,7 +40,8 @@
        color: #b32424; /* Red30 */
 }
 
-.wbqc-status-deprecated {
+.wbqc-status-deprecated,
+.wbqc-status-not-main-snak {
        color: #72777d; /* Base30 */
 }
 

-- 
To view, visit https://gerrit.wikimedia.org/r/378932
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Ia3a14e4e232b2ceee4b100ccd07b177fc8f870ad
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/WikibaseQualityConstraints
Gerrit-Branch: master
Gerrit-Owner: Lucas Werkmeister (WMDE) <[email protected]>
Gerrit-Reviewer: Lucas Werkmeister (WMDE) <[email protected]>
Gerrit-Reviewer: Siebrand <[email protected]>
Gerrit-Reviewer: Thiemo Mättig (WMDE) <[email protected]>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to