Merge pull request #89 from MITLibraries/timx-177-facets-to-filters

Rename facet arguments to filter

Author: jazairi

app/assets/stylesheets/application.css.scss

@@ -6,7 +6,7 @@
 @import "fonts";
 @import "partials/_variables";
 @import "partials/_alerts";
-@import "partials/_facets";
+@import "partials/_filters";
 @import "partials/_global_alerts";
 @import "partials/_pagination";
 @import "partials/_panels";

app/assets/stylesheets/partials/_facets.scss renamed to app/assets/stylesheets/partials/_filters.scss

@@ -1,4 +1,4 @@
-#facets {
+#filters {
   h3 {
     margin-bottom: 0;
   }

app/controllers/search_controller.rb

@@ -20,7 +20,7 @@ def results
 
     # Display stuff
     @results = extract_results(response)
-    @facets = extract_facets(response)
+    @filters = extract_filters(response)
   end
 
   private
@@ -29,7 +29,7 @@ def extract_errors(response)
     response&.errors&.details&.to_h&.dig('data')
   end
 
-  def extract_facets(response)
+  def extract_filters(response)
     response&.data&.search&.to_h&.dig('aggregations')
   end
 

app/helpers/facet_helper.rb renamed to app/helpers/filter_helper.rb

@@ -1,19 +1,19 @@
-module FacetHelper
-  def add_facet(query, facet, term)
+module FilterHelper
+  def add_filter(query, filter, term)
     new_query = query.deep_dup
     new_query[:page] = 1
 
-    # source is being treated as single value in facet application
+    # source is being treated as single value in filter application
     # even though we allow OR-ing multiple sources via advanced search
     # This might feel somewhat odd, but until we get feedback from UX this
     # seems like the best solution as each record only has a single source
     # in the data so there will never be a case to apply multiple in an AND
-    # which is all we support in facet application.
-    if new_query[facet].present? && facet != 'source'
-      new_query[facet] << term
-      new_query[facet].uniq!
+    # which is all we support in filter application.
+    if new_query[filter].present? && filter != 'source'
+      new_query[filter] << term
+      new_query[filter].uniq!
     else
-      new_query[facet] = [term]
+      new_query[filter] = [term]
     end
 
     new_query
@@ -26,10 +26,10 @@ def nice_labels
     }
   end
 
-  def remove_facet(query, facet)
+  def remove_filter(query, filter)
     new_query = query.deep_dup
     new_query[:page] = 1
-    new_query.delete facet.to_sym
+    new_query.delete filter.to_sym
     new_query
   end
 end

app/models/query_builder.rb

@@ -30,7 +30,7 @@ def extract_query(enhanced_query)
 
   def extract_filters(enhanced_query)
     # NOTE: ui and backend naming are not aligned so we can't loop here. we should fix in UI
-    @query['sourceFacet'] = enhanced_query[:source]
+    @query['sourceFilter'] = enhanced_query[:source]
     @query['contentType'] = enhanced_query[:contentType]
   end
 end

app/models/timdex_search.rb

@@ -12,7 +12,7 @@ class TimdexSearch < TimdexBase
       $locations: String
       $subjects: String
       $title: String
-      $sourceFacet: [String!]
+      $sourceFilter: [String!]
       $index: String
       $from: String
       $contentType: [String!]
@@ -26,10 +26,10 @@ class TimdexSearch < TimdexBase
         locations: $locations
         subjects: $subjects
         title: $title
-        sourceFacet: $sourceFacet
+        sourceFilter: $sourceFilter
         index: $index
         from: $from
-        contentTypeFacet: $contentType
+        contentTypeFilter: $contentType
       ) {
         hits
         records {

app/views/search/_facet_empty.html.erb

@@ -5,15 +5,15 @@
   <ul class="category-terms list-unbulleted">
   <% values.each do |term| %>
     <li class="term">
-      <a href="<%= results_path(add_facet(@enhanced_query, category, term['key'])) %>" class="<%= "applied" if @enhanced_query[category.to_sym] == term['key'] %>">
+      <a href="<%= results_path(add_filter(@enhanced_query, category, term['key'])) %>" class="<%= "applied" if @enhanced_query[category.to_sym] == term['key'] %>">
         <span class="name"><%= term['key'] %></span>
         <span class="count"><%= term['docCount'] %> <span class="sr">records</span></span>
       </a>
     </li>
   <% end %>
   </ul>
   <% if @enhanced_query[category.to_sym].present? %>
-    <div><%= link_to "Show all #{nice_labels[category]&.downcase || category}", results_path(remove_facet(@enhanced_query, category)) %>
+    <div><%= link_to "Show all #{nice_labels[category]&.downcase || category}", results_path(remove_filter(@enhanced_query, category)) %>
     </div>
   <% end %>
 </div>

app/views/search/_facet.html.erb renamed to app/views/search/_filter.html.erb

@@ -0,0 +1 @@
+<p>There are no filters.</p>

app/views/search/_filter_empty.html.erb

@@ -55,11 +55,11 @@
       </ul>
     </div>
 
-    <aside class="col1q facet-container">
-      <div id="facets">
+    <aside class="col1q filter-container">
+      <div id="filters">
         <h2>Available filters</h2>
-        <% @facets&.each do |category, values| %>
-          <%= render(partial: 'search/facet', locals: {category: category, values: values}) %>
+        <% @filters&.each do |category, values| %>
+          <%= render(partial: 'search/filter', locals: {category: category, values: values}) %>
         <% end %>
       </div>
     </aside>