Merge pull request #1350 from theseyi/annotation-filters

updates visual hint for dataset compliance annotations. updates wordi…

wherehows-web/app/components/dataset-compliance.ts

@@ -71,7 +71,6 @@ import { notificationDialogActionFactory } from 'wherehows-web/utils/notificatio
 import { isMetadataObject, jsonValuesMatch } from 'wherehows-web/utils/datasets/compliance/metadata-schema';
 import { typeOf } from '@ember/utils';
 import { pick } from 'wherehows-web/utils/object';
-import { pluralize } from 'ember-inflector';
 import { service } from '@ember-decorators/service';
 
 const {
@@ -194,7 +193,7 @@ export default class DatasetCompliance extends Component {
   });
 
   /**
-   * Indicates if the first step does not need further user review to advance
+   * Indicates if the compliance annotation does not need further user review to advance
    * @type {ComputedProperty<boolean>}
    * @memberof DatasetCompliance
    */
@@ -295,23 +294,21 @@ export default class DatasetCompliance extends Component {
    * @type {ComputedProperty<string>}
    * @memberof DatasetCompliance
    */
-  fieldReviewHint: ComputedProperty<string> = computed('fieldReviewOption', 'changeSetReviewCount', function(
+  fieldReviewHint: ComputedProperty<string> = computed('fieldReviewOption', 'foldedChangeSet.length', function(
     this: DatasetCompliance
   ): string {
     type TagFilterHint = { [K in TagFilter]: string };
 
-    const { fieldReviewOption, changeSetReviewCount } = getProperties(this, [
+    const { fieldReviewOption, foldedChangeSet = [] } = getProperties(this, ['fieldReviewOption', 'foldedChangeSet']);
-      'fieldReviewOption',
-      'changeSetReviewCount'
-    ]);
 
     const hint = (<TagFilterHint>{
-      [TagFilter.showAll]: `${pluralize(changeSetReviewCount, 'field')} to be reviewed`,
+      [TagFilter.showAll]: '',
-      [TagFilter.showReview]: 'It is required to select compliance info for all fields',
+      [TagFilter.showReview]: '? Please select at least one type for each field',
-      [TagFilter.showSuggested]: 'Please review suggestions and provide feedback'
+      [TagFilter.showSuggested]:
+        '! Please review suggestions and click thumbs up or down, based on the accuracy of the suggestion'
     })[fieldReviewOption];
 
-    return changeSetReviewCount ? hint : '';
+    return foldedChangeSet.length ? hint : '';
   });
 
   /**
@@ -519,9 +516,9 @@ export default class DatasetCompliance extends Component {
    * @memberof DatasetCompliance
    */
   fieldReviewOptions: Array<{ value: DatasetCompliance['fieldReviewOption']; label: string }> = [
-    { value: TagFilter.showAll, label: 'Show all fields' },
+    { value: TagFilter.showAll, label: '  Show all fields' },
-    { value: TagFilter.showReview, label: 'Show required fields' },
+    { value: TagFilter.showReview, label: '? Show fields missing a data type' },
-    { value: TagFilter.showSuggested, label: 'Show suggested fields' }
+    { value: TagFilter.showSuggested, label: '! Show fields that need review' }
   ];
 
   didReceiveAttrs(): void {
@@ -887,7 +884,7 @@ export default class DatasetCompliance extends Component {
    * @type {Array<IdentifierFieldWithFieldChangeSetTuple>}
    * @memberof DatasetCompliance
    */
-  foldedChangeSet: Array<IdentifierFieldWithFieldChangeSetTuple>;
+  foldedChangeSet: Array<IdentifierFieldWithFieldChangeSetTuple> | void;
 
   /**
    * Task to retrieve platform policies and set supported policies for the current platform

wherehows-web/app/styles/components/dataset-compliance/_compliance-table.scss

@@ -29,6 +29,23 @@
     }
   }
 
+  &__filter-count {
+    color: $compliance-suggestion-color;
+    margin-left: item-spacing(2);
+  }
+
+  &__subtitle {
+    display: flex;
+    align-items: center;
+    padding: item-spacing(2 0);
+  }
+
+  &__review-hint {
+    color: $compliance-suggestion-color;
+    height: item-spacing(5);
+    padding-left: item-spacing(5);
+  }
+
   &__has-suggestions {
     color: $compliance-suggestion-color;
     margin-left: item-spacing(2);

wherehows-web/app/templates/datasets/dataset-compliance/-dataset-compliance-entities.hbs

@@ -44,11 +44,9 @@
       selectionDidChange=(action "onFieldReviewChange")
     }}
 
-    {{#if fieldReviewHint}}
+    <span class="dataset-compliance-fields__filter-count">
-      <span class="dataset-compliance-fields__has-suggestions">
+      {{pluralize foldedChangeSet.length "field"}}
-        {{fieldReviewHint}}
+    </span>
-      </span>
-    {{/if}}
   {{/if}}
 
   {{#if isEditing}}
@@ -89,6 +87,12 @@
   {{/if}}
 </section>
 
+<div class="dataset-compliance-fields__subtitle">
+  <div class="dataset-compliance-fields__review-hint">
+    {{fieldReviewHint}}
+  </div>
+</div>
+
 {{#if showGuidedComplianceEditMode}}
   {{#if foldedChangeSet.length}}
     {{#dataset-table
@@ -148,10 +152,11 @@
             <tr class="{{if row.isReadonly 'dataset-compliance-fields--readonly'}}" ondblclick={{action
               row.onFragmentDblClick}}>
               {{#row.cell}}
+                {{! primary tag has an identifierType, field has a suggestion that does not match the identifierType, and suggestion resolution}}
                 {{#if
-                  (and row.suggestion (and (not row.suggestionMatchesCurrentValue) (not row.suggestionResolution)))}}
+                  (and row.fieldProps.identifierType (and row.suggestion (and (not row.suggestionMatchesCurrentValue) (not row.suggestionResolution))))}}
 
-                  <span class="nacho-tooltip" data-title="Has suggestions">
+                  <span class="nacho-tooltip" data-title="Suggestion conflicts with data type">
                     <i class="fa fa-exclamation dataset-compliance-fields__has-suggestions__icon"
                        title="Compliance field has suggested values"></i>
                   </span>