Skip to content

Commit 1387536

Browse files
evilstreakevilstreak
committed
Merge pull request #784 from alphagov/surface-other-results
Show other results from GOV.UK in a scoped search
2 parents 40b266d + a933fc9 commit 1387536

File tree

11 files changed

+348
-141
lines changed

11 files changed

+348
-141
lines changed

‎app/assets/stylesheets/views/_search.scss‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,20 @@ main.search{
228228
}
229229
}
230230

231+
li.descoped-results{
232+
border-left: 4pxsolid$govuk-blue;
233+
padding: $gutter-half00$gutter-half;
234+
margin-bottom: $gutter;
235+
236+
.descope-message{
237+
@includecore-16;
238+
}
239+
240+
ol{
241+
padding: $gutter-half00;
242+
}
243+
}
244+
231245
h3{
232246
@includecore-24;
233247
margin: 0;

‎app/controllers/search_controller.rb‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,13 @@ def index
1717
search_response=search_client.search(search_params)
1818

1919
@search_term=search_params.search_term
20-
@results=SearchResultsPresenter.new(search_response,search_params)
20+
21+
if(search_response["scope"].present?)
22+
@results=ScopedSearchResultsPresenter.new(search_response,search_params)
23+
else
24+
@results=SearchResultsPresenter.new(search_response,search_params)
25+
end
26+
2127
@facets=search_response["facets"]
2228
@spelling_suggestion=@results.spelling_suggestion
2329

‎app/presenters/scoped_search_results_presenter.rb‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
classScopedSearchResultsPresenter < SearchResultsPresenter
2+
3+
defto_hash
4+
super.merge({
5+
is_scoped?: true,
6+
scope_title: scope_title,
7+
unscoped_results_any?: unscoped_results.any?,
8+
unscoped_result_count: result_count_string(unscoped_result_count),
9+
})
10+
end
11+
12+
private
13+
14+
attr_reader:unscoped_results
15+
16+
deffilter_fields
17+
[]
18+
end
19+
20+
defscope_title
21+
search_response["scope"]["title"]
22+
end
23+
24+
defresults
25+
result_list=search_response["results"].map{ |result| build_scoped_result(result).to_hash}
26+
27+
ifunscoped_results.any?
28+
insertion_point=[result_list.count,3].min
29+
unscoped_results_sublist={results: unscoped_results,is_multiple_results: true}
30+
31+
result_list.insert(insertion_point,unscoped_results_sublist)
32+
end
33+
result_list
34+
end
35+
36+
defunscoped_result_count
37+
search_response["unscoped_results"]["total"]
38+
end
39+
40+
defunscoped_results
41+
@unscoped_results ||= build_result_presenters
42+
43+
end
44+
45+
defbuild_result_presenters
46+
search_response["unscoped_results"]["results"].map{ |result| build_result(result).to_hash}
47+
end
48+
49+
defbuild_scoped_result(result)
50+
ScopedResult.new(search_parameters,result)
51+
end
52+
53+
end

‎app/presenters/search_result.rb‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ def self.result_accessor(*keys)
3535
end
3636
end
3737

38-
result_accessor:link,:title,:format,:es_score
38+
result_accessor:link,:title,:format,:es_score,:section,:subsection,:subsubsection
3939

40-
# Avoid the mundanity of creating these all by hand by making
41-
# dynamic method and accessors.
42-
%w(sectionsubsectionsubsubsection).eachdo |key|
43-
define_method"formatted_#{key}_name"do
44-
mapped_name(send(key)) || humanized_name(send(key))
45-
end
40+
defformatted_section_name
41+
mapped_name(section) || humanized_name(section)
42+
end
4643

47-
define_methodkeydo
48-
result[key]
49-
end
44+
defformatted_subsection_name
45+
mapped_name(subsection) || humanized_name(subsection)
46+
end
47+
48+
defformatted_subsubsection_name
49+
mapped_name(subsubsection) || humanized_name(subsubsection)
5050
end
5151

5252
# External links have a truncated version of their URLs displayed on the

‎app/presenters/search_results_presenter.rb‎

Lines changed: 15 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ def to_hash
1717
{
1818
query: search_parameters.search_term,
1919
result_count: result_count,
20-
result_count_string: result_count_string,
20+
result_count_string: result_count_string(result_count),
2121
results_any?: results.any?,
22-
results: results.map{ |result| result.to_hash},
22+
results: results,
2323
filter_fields: filter_fields,
2424
debug_score: search_parameters.debug_score,
2525
has_next_page?: has_next_page?,
@@ -29,25 +29,19 @@ def to_hash
2929
previous_page_link: previous_page_link,
3030
previous_page_label: previous_page_label,
3131
first_result_number: (search_parameters.start + 1),
32-
is_scoped?: is_scoped?,
33-
scope_title: scope_title,
3432
}
3533
end
3634

3735
deffilter_fields
38-
ifis_scoped?
39-
[]
40-
else
41-
search_response["facets"].mapdo |field,value|
42-
external=SearchParameters::external_field_name(field)
43-
facet_params=search_parameters.filter(external)
44-
facet=SearchFacetPresenter.new(value,facet_params)
45-
{
46-
field: external,
47-
field_title: FACET_TITLES.fetch(field,field),
48-
options: facet.to_hash,
49-
}
50-
end
36+
search_response["facets"].mapdo |field,value|
37+
external=SearchParameters::external_field_name(field)
38+
facet_params=search_parameters.filter(external)
39+
facet=SearchFacetPresenter.new(value,facet_params)
40+
{
41+
field: external,
42+
field_title: FACET_TITLES.fetch(field,field),
43+
options: facet.to_hash,
44+
}
5145
end
5246
end
5347

@@ -72,18 +66,16 @@ def result_count
7266
search_response["total"].to_i
7367
end
7468

75-
defresult_count_string
76-
pluralize(number_with_delimiter(result_count),"result")
69+
defresult_count_string(count)
70+
pluralize(number_with_delimiter(count),"result")
7771
end
7872

7973
defresults
80-
search_response["results"].map{ |result| build_result(result)}
74+
search_response["results"].map{ |result| build_result(result).to_hash}
8175
end
8276

8377
defbuild_result(result)
84-
ifis_scoped?
85-
ScopedResult.new(search_parameters,result)
86-
elsifresult["document_type"] == "group"
78+
ifresult["document_type"] == "group"
8779
GroupResult.new(search_parameters,result)
8880
elsifresult["document_type"] && result["document_type"] != "edition"
8981
NonEditionResult.new(search_parameters,result)
@@ -127,16 +119,6 @@ def previous_page_label
127119
end
128120
end
129121

130-
defis_scoped?
131-
search_response[:scope].present?
132-
end
133-
134-
defscope_title
135-
ifis_scoped?
136-
search_response[:scope][:title]
137-
end
138-
end
139-
140122
private
141123

142124
attr_reader:search_parameters,:search_response

‎app/views/search/_result.mustache‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<li{{#external}}class="external"{{/external}}>
2+
<h3><ahref="{{link}}"{{#external}}rel="external"{{/external}}>{{title}}</a></h3>
3+
4+
{{#debug_score}}
5+
<pclass="debug-link">
6+
{{link}}
7+
</p>
8+
<pclass="debug-info">
9+
<span>Score: {{es_score}}</span>
10+
<span>Format: {{#government}}government{{/government}} {{format}}</span>
11+
</p>
12+
{{/debug_score}}
13+
14+
{{#external}}
15+
<pclass="meta">
16+
<spanclass="visuallyhidden">Part of </span>
17+
<spanclass="url">{{display_link }}</span>
18+
</p>
19+
{{/external}}
20+
21+
{{#section}}
22+
<pclass="meta crumbtrail">
23+
<spanclass="visuallyhidden">Part of </span>
24+
<spanclass="section">{{formatted_section_name}}</span>
25+
{{#formatted_subsection_name}}
26+
<spanclass="visuallyhidden">, </span>
27+
<spanclass="subsection">{{formatted_subsection_name }}</span>
28+
{{/formatted_subsection_name}}
29+
{{#formatted_subsubsection_name}}
30+
<spanclass="visuallyhidden">, </span>
31+
<spanclass="subsubsection">{{formatted_subsubsection_name }}</span>
32+
{{/formatted_subsubsection_name}}
33+
</p>
34+
{{/section}}
35+
36+
{{#metadata_any?}}
37+
<ulclass="attributes">
38+
{{#metadata}}
39+
<li> {{{.}}} </li>
40+
{{/metadata}}
41+
</ul>
42+
{{/metadata_any?}}
43+
44+
{{#historic?}}
45+
{{#government_name}}
46+
<pclass="historic">
47+
First published during the {{government_name}}
48+
</p>
49+
{{/government_name}}
50+
{{/historic?}}
51+
52+
<p>{{description}}</p>
53+
54+
{{#sections_present?}}
55+
<ulclass="sections">
56+
{{#sections}}
57+
<li><ahref="{{link}}#{{hash}}">{{title}}</a></li>
58+
{{/sections}}
59+
</ul>
60+
{{/sections_present?}}
61+
62+
{{#examples_present?}}
63+
<ulclass="examples">
64+
{{#examples}}
65+
<li>
66+
<h4><ahref="{{link}}">{{title}}</a></h4>
67+
<p>{{description}}</p>
68+
</li>
69+
{{/examples}}
70+
71+
{{#suggested_filter_present?}}
72+
<li>
73+
<h4class="see-all"><ahref="{{suggested_filter_link}}">{{suggested_filter_title}}</a><h4>
74+
</li>
75+
{{/suggested_filter_present?}}
76+
</ul>
77+
{{/examples_present?}}
78+
79+
{{^examples_present?}}
80+
{{#suggested_filter_present?}}
81+
<h4class="see-all"><ahref="{{suggested_filter_link}}">{{suggested_filter_title}}</a><h4>
82+
{{/suggested_filter_present?}}
83+
{{/examples_present?}}
84+
85+
</li>

0 commit comments

Comments
(0)