Enable access to files filter

README.md

@@ -51,7 +51,8 @@ change as part of the work.
 
 - `ABOUT_APP`: If populated, an 'about' partial containing the contents of this variable will render on 
 `basic_search#index`.
-- `ACTIVE_FILTERS`: If populated, this list of strings defines which filters are shown to the user, and the order in which they appear. Values are case sensitive, and must match those used in the TIMDEX GraphQL query. Extraneous values will be ignored. If not populated, all filters will be shown.
+- `ACTIVE_FILTERS`: If populated, this list of strings defines which filters are shown to the user, and the order in which they appear. Values are case sensitive, and must match the corresponding aggregations used in the TIMDEX GraphQL query. Extraneous values will be ignored. If not populated, all filters will be shown.
+- `FILTER_ACCESS_TO_FILES`: The name to use instead of "Access to files" for that filter / aggregation.
 - `FILTER_CONTENT_TYPE`: The name to use instead of "Content type" for that filter / aggregation.
 - `FILTER_CONTRIBUTOR`: The name to use instead of "Contributor" for that filter / aggregation.
 - `FILTER_FORMAT`: The name to use instead of "Format" for that filter / aggregation.

app/helpers/filter_helper.rb

@@ -21,6 +21,7 @@ def add_filter(query, filter, term)
 
   def nice_labels
     {
+      accessToFilesFilter: ENV.fetch('FILTER_ACCESS_TO_FILES', 'Access to files'),
       contentTypeFilter: ENV.fetch('FILTER_CONTENT_TYPE', 'Content type'),
       contributorsFilter: ENV.fetch('FILTER_CONTRIBUTOR', 'Contributor'),
       formatFilter: ENV.fetch('FILTER_FORMAT', 'Format'),

app/models/enhancer.rb

@@ -2,8 +2,8 @@ class Enhancer
   attr_accessor :enhanced_query
 
   QUERY_PARAMS = %i[q citation contentType contributors fundingInformation identifiers locations subjects title].freeze
-  FILTER_PARAMS = %i[contentTypeFilter contributorsFilter formatFilter languagesFilter literaryFormFilter placesFilter
-                     sourceFilter subjectsFilter].freeze
+  FILTER_PARAMS = %i[accessToFilesFilter contentTypeFilter contributorsFilter formatFilter languagesFilter
+                     literaryFormFilter placesFilter sourceFilter subjectsFilter].freeze
   GEO_PARAMS = %i[geoboxMinLongitude geoboxMinLatitude geoboxMaxLongitude geoboxMaxLatitude geodistanceLatitude
                   geodistanceLongitude geodistanceDistance].freeze
 

app/models/query_builder.rb

@@ -3,8 +3,8 @@ class QueryBuilder
 
   RESULTS_PER_PAGE = 20
   QUERY_PARAMS = %w[q citation contributors fundingInformation identifiers locations subjects title].freeze
-  FILTER_PARAMS = %i[contentTypeFilter contributorsFilter formatFilter languagesFilter literaryFormFilter placesFilter
-                     sourceFilter subjectsFilter].freeze
+  FILTER_PARAMS = %i[accessToFilesFilter contentTypeFilter contributorsFilter formatFilter languagesFilter
+                     literaryFormFilter placesFilter sourceFilter subjectsFilter].freeze
   GEO_PARAMS = %w[geoboxMinLongitude geoboxMinLatitude geoboxMaxLongitude geoboxMaxLatitude geodistanceLatitude
                   geodistanceLongitude geodistanceDistance].freeze
 

app/models/timdex_search.rb

@@ -14,6 +14,7 @@ class TimdexSearch < TimdexBase
       $title: String
       $index: String
       $from: String
+      $accessToFilesFilter: [String!]
       $contentTypeFilter: [String!]
       $contributorsFilter: [String!]
       $formatFilter: [String!]
@@ -34,6 +35,7 @@ class TimdexSearch < TimdexBase
         title: $title
         index: $index
         from: $from
+        accessToFilesFilter: $accessToFilesFilter
         contentTypeFilter: $contentTypeFilter
         contributorsFilter: $contributorsFilter
         formatFilter: $formatFilter
@@ -81,6 +83,10 @@ class TimdexSearch < TimdexBase
           summary
         }
         aggregations {
+          accessToFiles {
+            key
+            docCount
+          }
           contentType {
             key
             docCount
@@ -134,6 +140,7 @@ class TimdexSearch < TimdexBase
       $geoboxMinLongitude: Float!
       $geoboxMaxLatitude: Float!
       $geoboxMaxLongitude: Float!
+      $accessToFilesFilter: [String!]
       $contentTypeFilter: [String!]
       $contributorsFilter: [String!]
       $formatFilter: [String!]
@@ -159,6 +166,7 @@ class TimdexSearch < TimdexBase
           maxLongitude: $geoboxMaxLongitude,
           maxLatitude: $geoboxMaxLatitude
         }
+        accessToFilesFilter: $accessToFilesFilter
         contentTypeFilter: $contentTypeFilter
         contributorsFilter: $contributorsFilter
         formatFilter: $formatFilter
@@ -205,6 +213,10 @@ class TimdexSearch < TimdexBase
           summary
         }
         aggregations {
+          accessToFiles {
+            key
+            docCount
+          }
           contentType {
             key
             docCount
@@ -250,6 +262,7 @@ class TimdexSearch < TimdexBase
       $title: String
       $index: String
       $from: String
+      $accessToFilesFilter: [String!]
       $geodistanceDistance: String!
       $geodistanceLatitude: Float!
       $geodistanceLongitude: Float!
@@ -277,6 +290,7 @@ class TimdexSearch < TimdexBase
           latitude: $geodistanceLatitude,
           longitude: $geodistanceLongitude
         }
+        accessToFilesFilter: $accessToFilesFilter
         contentTypeFilter: $contentTypeFilter
         contributorsFilter: $contributorsFilter
         formatFilter: $formatFilter
@@ -323,6 +337,10 @@ class TimdexSearch < TimdexBase
           summary
         }
         aggregations {
+          accessToFiles {
+            key
+            docCount
+          }
           contentType {
             key
             docCount
@@ -368,6 +386,7 @@ class TimdexSearch < TimdexBase
       $title: String
       $index: String
       $from: String
+      $accessToFilesFilter: [String!]
       $geodistanceDistance: String!
       $geodistanceLatitude: Float!
       $geodistanceLongitude: Float!
@@ -405,6 +424,7 @@ class TimdexSearch < TimdexBase
           maxLongitude: $geoboxMaxLongitude,
           maxLatitude: $geoboxMaxLatitude
         }
+        accessToFilesFilter: $accessToFilesFilter
         contentTypeFilter: $contentTypeFilter
         contributorsFilter: $contributorsFilter
         formatFilter: $formatFilter
@@ -451,6 +471,10 @@ class TimdexSearch < TimdexBase
           summary
         }
         aggregations {
+          accessToFiles {
+            key
+            docCount
+          }
           contentType {
             key
             docCount