Show other results from GOV.UK in a scoped search

[alicebartlett]

Pivotal: https://www.pivotaltracker.com/story/show/

What
This PR exposes the top three search results from the whole of GOV.UK in a search that has been scoped to a single document.

Before:

After:

Summary of commits:

• 6c3d93f, dc90a5e, f9c24d7 and 318731b (the first three commits) are refactoring done as part of the prep work for adding this feature.
• 5b7049b modifies search_api.rb to add an the additional call to rummager for three GOV.UK wide search results. Tests for this request are also included in this commit.
• 804af74 refactors out scoped search functionality to a new class ScopedSearchResultsPresenter and adds tests for this new presenter.
• e4c0154 is where the bulk of the changes are. This commit takes the new search results returned by the changes to search_api.rb in 5b7049b, and formats them properly and displays them in the view.
• 248d2e8 is CSS for the new results pull out.

How to review this PR
I've done quite a lot of hindsight based refactoring so each commit should make sense in isolation. Review however you prefer.

Who should review this PR

• Anyone in the core team is especially encouraged to pile in.
• I paired with @evilstreak, @jennyd, and @binaryberry on different bits of this at various times.
• @rivalee / @markhurrell if you could check you're happy with the design and the micro-copy is what was agreed with the content team, I know it changed quite a bit and I'm not sure I got the right stuff in the end.
• Anyone else with an interest in search/rummager/manuals

[binaryberry]

This PR is too advanced for me to review but 👍 on the detailed commit messages!

[edds]

I have had a quick look and this looks great to me. Thanks for taking the time to make the commits really easy to follow.

[rboulton]

I'm very excited to see this, it looks shiny. ✨.

[benilovj]

this bit of the test is quite involved. I wonder whether it'd be more obvious if you checked the actual (hard-coded) values instead of variables.

[alicebartlett]

The hard-coded values are more like:

<[{:attributes=>[],
    :debug_score=>1,
    :description=>nil,
    :display_link=>nil,
    :es_score=>nil,
    :examples=>nil,
    :examples_present?=>false,
    :external=>false,
    :format=>nil,
    :formatted_section_name=>nil,
    :formatted_subsection_name=>nil,
    :formatted_subsubsection_name=>nil,
    :link=>nil,
    :section=>nil,
    :suggested_filter_link=>nil,
    :suggested_filter_present?=>false,
    :suggested_filter_title=>nil,
    :title=>"scoped_result_1"},
   {:attributes=>[],
    :debug_score=>1,
    :description=>nil,
    :display_link=>nil,
    :es_score=>nil,
    :examples=>nil,
    :examples_present?=>false,
    :external=>false,
    :format=>nil,
    :formatted_section_name=>nil,
    :formatted_subsection_name=>nil,
    :formatted_subsubsection_name=>nil,
    :link=>nil,
    :section=>nil,
    :suggested_filter_link=>nil,
    :suggested_filter_present?=>false,
    :suggested_filter_title=>nil,
    :title=>"scoped_result_2"},
   {:attributes=>[],
    :debug_score=>1,
    :description=>nil,
    :display_link=>nil,
    :es_score=>nil,
    :examples=>nil,
    :examples_present?=>false,
    :external=>false,
    :format=>nil,
    :formatted_section_name=>nil,
    :formatted_subsection_name=>nil,
    :formatted_subsubsection_name=>nil,
    :link=>nil,
    :section=>nil,
    :suggested_filter_link=>nil,
    :suggested_filter_present?=>false,
    :suggested_filter_title=>nil,
    :title=>"scoped_result_3"},
   {:is_multiple_results=>true,
    :results=>
     [{:attributes=>[],
       :debug_score=>1,
       :description=>nil,
       :display_link=>nil,
       :es_score=>nil,
       :examples=>nil,
       :examples_present?=>false,
       :external=>false,
       :format=>nil,
       :formatted_section_name=>nil,
       :formatted_subsection_name=>nil,
       :formatted_subsubsection_name=>nil,
       :link=>nil,
       :section=>nil,
       :suggested_filter_link=>nil,
       :suggested_filter_present?=>false,
       :suggested_filter_title=>nil,
       :title=>"unscoped_result_1"},
      {:attributes=>[],
       :debug_score=>1,
       :description=>nil,
       :display_link=>nil,
       :es_score=>nil,
       :examples=>nil,
       :examples_present?=>false,
       :external=>false,
       :format=>nil,
       :formatted_section_name=>nil,
       :formatted_subsection_name=>nil,
       :formatted_subsubsection_name=>nil,
       :link=>nil,
       :section=>nil,
       :suggested_filter_link=>nil,
       :suggested_filter_present?=>false,
       :suggested_filter_title=>nil,
       :title=>"unscoped_result_2"},
      {:attributes=>[],
       :debug_score=>1,
       :description=>nil,
       :display_link=>nil,
       :es_score=>nil,
       :examples=>nil,
       :examples_present?=>false,
       :external=>false,
       :format=>nil,
       :formatted_section_name=>nil,
       :formatted_subsection_name=>nil,
       :formatted_subsubsection_name=>nil,
       :link=>nil,
       :section=>nil,
       :suggested_filter_link=>nil,
       :suggested_filter_present?=>false,
       :suggested_filter_title=>nil,
       :title=>"unscoped_result_3"}]},
   {:attributes=>[],
    :debug_score=>1,
    :description=>nil,
    :display_link=>nil,
    :es_score=>nil,
    :examples=>nil,
    :examples_present?=>false,
    :external=>false,
    :format=>nil,
    :formatted_section_name=>nil,
    :formatted_subsection_name=>nil,
    :formatted_subsubsection_name=>nil,
    :link=>nil,
    :section=>nil,
    :suggested_filter_link=>nil,
    :suggested_filter_present?=>false,
    :suggested_filter_title=>nil,
    :title=>"scoped_result_4"}]>.

which is why I've written it this way, though I understand your point. Do you think this is clearer:

     expected_results_list = [{ "title"=> "scoped_result_1" },
                               { "title"=> "scoped_result_2" },
                               { "title"=> "scoped_result_3" },
                               { "is_multiple_results" => true,
                                 "results" => [{ "title"=> "unscoped_result_1" },
                                               { "title"=> "unscoped_result_2" },
                                               { "title"=> "unscoped_result_3" },
                                              ]
                                },
                                { "title"=> "scoped_result_4" },
                              ]

      results.

      # Scoped results
     expected_results_list[0..2].each_with_index do | result, i |
        assert_equal result["title"], results[:results][i][:title]
      end

      # Check un-scoped sub-list has flag
      assert_equal true, results[:results][3][:is_multiple_results]

      # iterate unscoped sublist of results
      expected_results_list[3]["results"].each_with_index do | result, i |
        assert_equal result["title"], results[:results][3][:results][i][:title]
      end

      # iterate remaining results
      expected_results_list[3..-1].each_with_index do | result, i |
        assert_equal result["title"], results[:results][i+4][:title]
      end
    end

[rivalee]

Design looks good to me and the copy is correct!

[boffbowsh]

I wonder if this would be better as an override of the results method?

def results
  presentable_result_list = super # possibly a better local var name than this, but I'm currently unable to brain

  if unscoped_results.any?
    insertion_point = [results.count, 3].min
    unscoped_results_sublist = { results: unscoped_results, is_multiple_results: true }
     presentable_result_list.insert(insertion_point, unscoped_results_sublist)
  end
  presentable_result_list
end

Then you wouldn't need to change results in to_hash above, and intent is clearer.

[alicebartlett]

Aaaaactually, I'm already overwriting results in this class to only dish out ScopedResults which I don't want the super to have to know about, so this won't work. There's probably still a clearer way though, want to come pair on it when you're free?

[boffbowsh]

Pedantic style comments, but otherwise seems to do the trick 👍

[alicebartlett]

OK I think I've responded to all the comments now, thanks everyone!

[boffbowsh]

Looks good to me 👍

[evilstreak]

👍