Merge pull request #317 from MITLibraries/use-300-update-displayed-highlights

Updates logic to filter highlights

Author: JPrevost

app/helpers/search_helper.rb

@@ -1,6 +1,8 @@
 module SearchHelper
+  # These fields are used to filter out highlights that are already displayed in the main result view. Keep in mind these values need to be the names of fields in TIMDEX, not the normalized record keys.
   def displayed_fields
-    ['title', 'title.exact_value', 'content_type', 'dates.value', 'contributors.value']
+    ['title', 'title.exact_value', 'content_type', 'dates.value', 'contributors.value', 'summary', 'citation',
+     'subjects.value']
   end
 
   def trim_highlights(result)

test/controllers/search_controller_test.rb

@@ -100,7 +100,7 @@ def mock_timdex_search_success
       'contributors' => [{ 'value' => 'Foo Barston', 'kind' => 'Creator' }],
       'highlight' => [
         {
-          'matchedField' => 'summary',
+          'matchedField' => 'notes',
           'matchedPhrases' => ['<span>sample</span> document']
         }
       ],

test/helpers/search_helper_test.rb

@@ -13,17 +13,17 @@ class SearchHelperTest < ActionView::TestCase
   end
 
   test 'does not remove undisplayed fields from highlights' do
-    result = { highlight: [{ 'matchedField' => 'summary', 'matchedPhrases' => 'Have some data' }] }
-    assert_equal [{ 'matchedField' => 'summary', 'matchedPhrases' => 'Have some data' }], trim_highlights(result)
+    result = { highlight: [{ 'matchedField' => 'notes', 'matchedPhrases' => 'Have some data' }] }
+    assert_equal [{ 'matchedField' => 'notes', 'matchedPhrases' => 'Have some data' }], trim_highlights(result)
   end
 
   test 'returns correct set of highlights when result includes displayed and undisplayed fields' do
     result = { highlight: [{ 'matchedField' => 'title', 'matchedPhrases' => 'Very important data' },
                            { 'matchedField' => 'content_type', 'matchedPhrases' => 'Dataset' },
-                           { 'matchedField' => 'summary', 'matchedPhrases' => '2022' },
-                           { 'matchedField' => 'citation', 'matchedPhrases' => 'Datascientist, Jane' }] }
-    assert_equal [{ 'matchedField' => 'summary', 'matchedPhrases' => '2022' },
-                  { 'matchedField' => 'citation', 'matchedPhrases' => 'Datascientist, Jane' }], trim_highlights(result)
+                           { 'matchedField' => 'numbering', 'matchedPhrases' => '2022' },
+                           { 'matchedField' => 'notes', 'matchedPhrases' => 'Datascientist, Jane' }] }
+    assert_equal [{ 'matchedField' => 'numbering', 'matchedPhrases' => '2022' },
+                  { 'matchedField' => 'notes', 'matchedPhrases' => 'Datascientist, Jane' }], trim_highlights(result)
   end
 
   test 'parse_geo_dates returns issued over coverage' do