TIMDEX highlight to sym

Author: JPrevost

app/helpers/search_helper.rb

@@ -4,9 +4,9 @@ def displayed_fields
   end
 
   def trim_highlights(result)
-    return unless result['highlight']&.any?
+    return unless result[:highlight]&.any?
 
-    result['highlight'].reject { |h| displayed_fields.include? h['matchedField'] }
+    result[:highlight].reject { |h| displayed_fields.include? h['matchedField'] }
   end
 
   def format_highlight_label(field_name)

app/models/normalize_timdex_record.rb

@@ -24,7 +24,7 @@ def normalize
       content_type:,
       dates:,
       contributors:,
-      'highlight' => highlight,
+      highlight:,
       'source_link' => source_link
     }
   end

app/views/search/_result_geo.html.erb

@@ -25,9 +25,9 @@
       </p>
     <% end %>
 
-    <% if result_geo['highlight'] %>
+    <% if result_geo[:highlight] %>
       <div class="result-highlights">
-        <%= render partial: 'search/highlights', locals: { result: { 'highlight' => result_geo['highlight'] } } %>
+        <%= render partial: 'search/highlights', locals: { result: { highlight: result_geo[:highlight] } } %>
       </div>
     <% end %>
 

test/helpers/search_helper_test.rb

@@ -4,24 +4,24 @@ class SearchHelperTest < ActionView::TestCase
   include SearchHelper
 
   test 'removes displayed fields from highlights' do
-    result = { 'highlight' => [{ 'matchedField' => 'title', 'matchedPhrases' => 'Very important data' },
-                               { 'matchedField' => 'title.exact_value', 'matchedPhrases' => 'Very important data' },
-                               { 'matchedField' => 'content_type', 'matchedPhrases' => 'Dataset' },
-                               { 'matchedField' => 'dates.value', 'matchedPhrases' => '2022' },
-                               { 'matchedField' => 'contributors.value', 'matchedPhrases' => 'Jane Datascientist' }] }
+    result = { highlight: [{ 'matchedField' => 'title', 'matchedPhrases' => 'Very important data' },
+                           { 'matchedField' => 'title.exact_value', 'matchedPhrases' => 'Very important data' },
+                           { 'matchedField' => 'content_type', 'matchedPhrases' => 'Dataset' },
+                           { 'matchedField' => 'dates.value', 'matchedPhrases' => '2022' },
+                           { 'matchedField' => 'contributors.value', 'matchedPhrases' => 'Jane Datascientist' }] }
     assert_empty trim_highlights(result)
   end
 
   test 'does not remove undisplayed fields from highlights' do
-    result = { 'highlight' => [{ 'matchedField' => 'summary', 'matchedPhrases' => 'Have some data' }] }
+    result = { highlight: [{ 'matchedField' => 'summary', 'matchedPhrases' => 'Have some data' }] }
     assert_equal [{ 'matchedField' => 'summary', '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' }] }
+    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)
   end

test/models/normalize_timdex_record_test.rb

@@ -199,7 +199,7 @@ def minimal_record
       'title' => ['Sample <em>TIMDEX</em> Record'],
       'summary' => ['comprehensive <em>test</em> record']
     }
-    assert_equal expected_highlight, normalized['highlight']
+    assert_equal expected_highlight, normalized[:highlight]
   end
 
   test 'includes TIMDEX-specific source_link field' do

test/models/normalize_timdex_results_test.rb

@@ -30,7 +30,7 @@ def empty_timdex_response
     assert_includes first_result.keys, :content_type
     assert_includes first_result.keys, :dates
     assert_includes first_result.keys, :contributors
-    assert_includes first_result.keys, 'highlight'
+    assert_includes first_result.keys, :highlight
     assert_includes first_result.keys, 'source_link'
 
     # Check second record (minimal record)