blacklight 7.34.0 → 8.0.0.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (393) hide show
  1. checksums.yaml +4 -4
  2. data/.env +2 -3
  3. data/.github/workflows/ruby.yml +32 -127
  4. data/.rubocop.yml +241 -2
  5. data/.rubocop_todo.yml +214 -270
  6. data/Gemfile +7 -10
  7. data/README.md +11 -3
  8. data/VERSION +1 -1
  9. data/app/assets/javascripts/blacklight/blacklight.esm.js +384 -0
  10. data/app/assets/javascripts/blacklight/blacklight.esm.js.map +1 -0
  11. data/app/assets/javascripts/blacklight/blacklight.js +374 -489
  12. data/app/assets/javascripts/blacklight/blacklight.js.map +1 -0
  13. data/app/assets/stylesheets/blacklight/_autocomplete.scss +25 -0
  14. data/app/assets/stylesheets/blacklight/_blacklight_base.scss +1 -1
  15. data/app/assets/stylesheets/blacklight/_bookmark.scss +16 -0
  16. data/app/assets/stylesheets/blacklight/_bootstrap_overrides.scss +8 -0
  17. data/app/assets/stylesheets/blacklight/_facets.scss +72 -44
  18. data/app/assets/stylesheets/blacklight/_header.scss +0 -15
  19. data/app/assets/stylesheets/blacklight/_icons.scss +0 -14
  20. data/app/assets/stylesheets/blacklight/_mixins.scss +20 -0
  21. data/app/assets/stylesheets/blacklight/_modal.scss +8 -2
  22. data/app/assets/stylesheets/blacklight/_search_form.scss +30 -3
  23. data/app/assets/stylesheets/blacklight/_search_history.scss +10 -1
  24. data/app/assets/stylesheets/blacklight/_search_results.scss +6 -2
  25. data/app/assets/stylesheets/blacklight/blacklight_defaults.scss +4 -1
  26. data/app/builders/blacklight/action_builder.rb +18 -9
  27. data/app/components/blacklight/advanced_search_form_component.html.erb +2 -2
  28. data/app/components/blacklight/advanced_search_form_component.rb +8 -10
  29. data/app/components/blacklight/constraints_component.rb +27 -37
  30. data/app/components/blacklight/document/action_component.rb +9 -9
  31. data/app/components/blacklight/document/actions_component.rb +2 -2
  32. data/app/components/blacklight/document/bookmark_component.html.erb +9 -0
  33. data/app/components/blacklight/document/bookmark_component.rb +4 -2
  34. data/app/components/blacklight/document/citation_component.rb +5 -3
  35. data/app/components/blacklight/document/group_component.rb +7 -3
  36. data/app/components/blacklight/document/sidebar_component.html.erb +2 -0
  37. data/app/components/blacklight/document/sidebar_component.rb +16 -0
  38. data/app/components/blacklight/document/thumbnail_component.html.erb +2 -7
  39. data/app/components/blacklight/document/thumbnail_component.rb +1 -9
  40. data/app/components/blacklight/document_component.html.erb +4 -0
  41. data/app/components/blacklight/document_component.rb +14 -53
  42. data/app/components/blacklight/document_metadata_component.html.erb +2 -4
  43. data/app/components/blacklight/document_metadata_component.rb +5 -10
  44. data/app/components/blacklight/document_title_component.rb +4 -1
  45. data/app/components/blacklight/facet_component.rb +1 -1
  46. data/app/components/blacklight/facet_field_checkboxes_component.html.erb +3 -3
  47. data/app/components/blacklight/facet_field_checkboxes_component.rb +1 -1
  48. data/app/components/blacklight/facet_field_component.html.erb +5 -5
  49. data/app/components/blacklight/facet_field_component.rb +9 -2
  50. data/app/components/blacklight/facet_field_list_component.html.erb +3 -3
  51. data/app/components/blacklight/facet_field_list_component.rb +37 -5
  52. data/app/components/blacklight/facet_field_no_layout_component.rb +0 -2
  53. data/app/components/blacklight/facet_item_component.rb +1 -43
  54. data/app/components/blacklight/facet_item_pivot_component.rb +21 -23
  55. data/app/components/blacklight/header_component.rb +1 -1
  56. data/app/components/blacklight/hidden_search_state_component.rb +1 -2
  57. data/app/components/blacklight/icons/legacy_icon_component.rb +30 -0
  58. data/app/components/blacklight/icons/list_component.rb +16 -0
  59. data/app/components/blacklight/icons/search_component.rb +16 -0
  60. data/app/components/blacklight/metadata_field_component.html.erb +2 -2
  61. data/app/components/blacklight/metadata_field_component.rb +24 -8
  62. data/app/components/blacklight/metadata_field_layout_component.rb +4 -25
  63. data/app/components/blacklight/response/facet_group_component.html.erb +3 -5
  64. data/app/components/blacklight/response/facet_group_component.rb +29 -8
  65. data/app/components/blacklight/response/pagination_component.html.erb +1 -1
  66. data/app/components/blacklight/response/pagination_component.rb +1 -5
  67. data/app/components/blacklight/response/sort_component.rb +1 -1
  68. data/app/components/blacklight/response/spellcheck_component.rb +17 -6
  69. data/app/components/blacklight/response/view_type_button_component.rb +2 -6
  70. data/app/components/blacklight/response/view_type_component.rb +3 -5
  71. data/app/components/blacklight/search/sidebar_component.html.erb +8 -0
  72. data/app/components/blacklight/search/sidebar_component.rb +17 -0
  73. data/app/components/blacklight/search_bar_component.html.erb +20 -15
  74. data/app/components/blacklight/search_bar_component.rb +2 -16
  75. data/app/components/blacklight/search_button_component.rb +3 -3
  76. data/app/components/blacklight/search_context_component.rb +43 -9
  77. data/app/components/blacklight/search_header_component.html.erb +2 -0
  78. data/app/components/blacklight/search_header_component.rb +6 -0
  79. data/app/components/blacklight/start_over_button_component.rb +5 -3
  80. data/app/components/blacklight/system/dropdown_component.rb +2 -2
  81. data/app/components/blacklight/system/flash_message_component.html.erb +3 -1
  82. data/app/components/blacklight/system/flash_message_component.rb +11 -2
  83. data/app/components/blacklight/system/modal_component.html.erb +1 -1
  84. data/app/components/blacklight/system/modal_component.rb +0 -2
  85. data/app/components/blacklight/top_navbar_component.html.erb +1 -1
  86. data/app/components/blacklight/top_navbar_component.rb +0 -4
  87. data/app/controllers/bookmarks_controller.rb +1 -0
  88. data/app/controllers/catalog_controller.rb +1 -0
  89. data/app/controllers/concerns/blacklight/bookmarks.rb +10 -5
  90. data/app/controllers/concerns/blacklight/catalog.rb +21 -75
  91. data/app/controllers/concerns/blacklight/controller.rb +3 -41
  92. data/app/controllers/concerns/blacklight/search_context.rb +25 -7
  93. data/app/controllers/concerns/blacklight/search_history.rb +2 -0
  94. data/app/controllers/concerns/blacklight/searchable.rb +12 -1
  95. data/app/controllers/concerns/blacklight/token_based_user.rb +1 -0
  96. data/app/controllers/search_history_controller.rb +1 -0
  97. data/app/helpers/blacklight/blacklight_helper_behavior.rb +12 -310
  98. data/app/helpers/blacklight/catalog_helper_behavior.rb +22 -137
  99. data/app/helpers/blacklight/component_helper_behavior.rb +2 -53
  100. data/app/helpers/blacklight/configuration_helper_behavior.rb +2 -117
  101. data/app/helpers/blacklight/facets_helper_behavior.rb +4 -321
  102. data/app/helpers/blacklight/icon_helper_behavior.rb +5 -4
  103. data/app/helpers/blacklight/layout_helper_behavior.rb +1 -0
  104. data/app/helpers/blacklight/render_partials_helper_behavior.rb +11 -31
  105. data/app/helpers/blacklight/url_helper_behavior.rb +13 -97
  106. data/app/helpers/blacklight_helper.rb +1 -0
  107. data/app/helpers/catalog_helper.rb +1 -0
  108. data/app/javascript/blacklight/bookmark_toggle.js +13 -19
  109. data/app/javascript/blacklight/button_focus.js +12 -10
  110. data/app/javascript/blacklight/checkbox_submit.js +68 -122
  111. data/app/javascript/blacklight/core.js +6 -5
  112. data/app/javascript/blacklight/index.js +13 -0
  113. data/app/javascript/blacklight/modal.js +99 -164
  114. data/app/javascript/blacklight/modalForm.js +60 -0
  115. data/app/javascript/blacklight/search_context.js +45 -55
  116. data/app/models/blacklight/facet_paginator.rb +3 -2
  117. data/app/models/blacklight/icon.rb +4 -2
  118. data/app/models/bookmark.rb +0 -2
  119. data/app/models/concerns/blacklight/configurable.rb +5 -4
  120. data/app/models/concerns/blacklight/document/active_model_shim.rb +1 -0
  121. data/app/models/concerns/blacklight/document/cache_key.rb +1 -0
  122. data/app/models/concerns/blacklight/document/dublin_core.rb +2 -1
  123. data/app/models/concerns/blacklight/document/email.rb +1 -0
  124. data/app/models/concerns/blacklight/document/export.rb +2 -1
  125. data/app/models/concerns/blacklight/document/extensions.rb +1 -0
  126. data/app/models/concerns/blacklight/document/schema_org.rb +1 -0
  127. data/app/models/concerns/blacklight/document/semantic_fields.rb +1 -0
  128. data/app/models/concerns/blacklight/document/sms.rb +1 -0
  129. data/app/models/concerns/blacklight/suggest/response.rb +1 -0
  130. data/app/models/concerns/blacklight/user.rb +17 -8
  131. data/app/models/record_mailer.rb +13 -12
  132. data/app/models/search.rb +0 -1
  133. data/app/models/solr_document.rb +1 -0
  134. data/app/presenters/blacklight/clause_presenter.rb +1 -1
  135. data/app/presenters/blacklight/document_presenter.rb +13 -21
  136. data/app/presenters/blacklight/facet_field_presenter.rb +39 -14
  137. data/app/presenters/blacklight/facet_grouped_item_presenter.rb +1 -5
  138. data/app/presenters/blacklight/facet_item_pivot_presenter.rb +60 -0
  139. data/app/presenters/blacklight/facet_item_presenter.rb +3 -9
  140. data/app/presenters/blacklight/field_presenter.rb +1 -0
  141. data/app/presenters/blacklight/index_presenter.rb +2 -40
  142. data/app/presenters/blacklight/json_presenter.rb +7 -5
  143. data/app/presenters/blacklight/rendering/link_to_facet.rb +2 -5
  144. data/app/presenters/blacklight/show_presenter.rb +1 -9
  145. data/app/presenters/blacklight/thumbnail_presenter.rb +1 -1
  146. data/app/services/blacklight/bookmarks_search_builder.rb +22 -0
  147. data/app/services/blacklight/field_retriever.rb +1 -8
  148. data/app/services/blacklight/search_service.rb +8 -7
  149. data/app/values/blacklight/types.rb +0 -4
  150. data/app/views/bookmarks/_clear_bookmarks_widget.html.erb +8 -1
  151. data/app/views/bookmarks/_tools.html.erb +7 -12
  152. data/app/views/catalog/_advanced_search_form.html.erb +0 -1
  153. data/app/views/catalog/_bookmark_control.html.erb +1 -1
  154. data/app/views/catalog/_constraints.html.erb +1 -14
  155. data/app/views/catalog/_document.atom.builder +12 -14
  156. data/app/views/catalog/_document.html.erb +5 -3
  157. data/app/views/catalog/_document.rss.builder +2 -4
  158. data/app/views/catalog/_facet_layout.html.erb +2 -2
  159. data/app/views/catalog/_facets.html.erb +5 -4
  160. data/app/views/catalog/_home_text.html.erb +2 -14
  161. data/app/views/catalog/_search_form.html.erb +2 -2
  162. data/app/views/catalog/_search_header.html.erb +1 -2
  163. data/app/views/catalog/_search_results.html.erb +2 -2
  164. data/app/views/catalog/_search_sidebar.html.erb +5 -1
  165. data/app/views/catalog/_show_main_content.html.erb +11 -16
  166. data/app/views/catalog/_show_sidebar.html.erb +2 -2
  167. data/app/views/catalog/_show_tools.html.erb +8 -14
  168. data/app/views/catalog/_view_type_group.html.erb +1 -1
  169. data/app/views/catalog/email_success.html.erb +5 -6
  170. data/app/views/catalog/facet.html.erb +7 -5
  171. data/app/views/catalog/index.atom.builder +12 -14
  172. data/app/views/catalog/index.html.erb +4 -1
  173. data/app/views/catalog/index.json.jbuilder +19 -19
  174. data/app/views/catalog/index.rss.builder +1 -1
  175. data/app/views/catalog/opensearch.xml.builder +1 -1
  176. data/app/views/catalog/sms_success.html.erb +5 -6
  177. data/app/views/catalog/suggest.html.erb +3 -0
  178. data/app/views/layouts/blacklight/base.html.erb +13 -2
  179. data/app/views/search_history/index.html.erb +6 -2
  180. data/app/views/shared/_modal.html.erb +3 -3
  181. data/blacklight.gemspec +8 -9
  182. data/config/importmap.rb +3 -0
  183. data/config/locales/blacklight.ar.yml +0 -1
  184. data/config/locales/blacklight.ca.yml +0 -1
  185. data/config/locales/blacklight.de.yml +0 -1
  186. data/config/locales/blacklight.en.yml +0 -2
  187. data/config/locales/blacklight.es.yml +0 -1
  188. data/config/locales/blacklight.fr.yml +0 -1
  189. data/config/locales/blacklight.hu.yml +0 -1
  190. data/config/locales/blacklight.it.yml +0 -1
  191. data/config/locales/blacklight.nl.yml +0 -1
  192. data/config/locales/blacklight.pt-BR.yml +0 -1
  193. data/config/locales/blacklight.sq.yml +0 -1
  194. data/config/locales/blacklight.zh.yml +0 -1
  195. data/config/routes.rb +3 -2
  196. data/db/migrate/20140202020201_create_searches.rb +1 -0
  197. data/db/migrate/20140202020202_create_bookmarks.rb +1 -0
  198. data/db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb +1 -0
  199. data/docker-compose.yml +0 -1
  200. data/lib/blacklight/abstract_repository.rb +1 -0
  201. data/lib/blacklight/configuration/context.rb +4 -4
  202. data/lib/blacklight/configuration/display_field.rb +7 -9
  203. data/lib/blacklight/configuration/facet_field.rb +17 -11
  204. data/lib/blacklight/configuration/field.rb +1 -0
  205. data/lib/blacklight/configuration/fields.rb +12 -15
  206. data/lib/blacklight/configuration/index_field.rb +1 -0
  207. data/lib/blacklight/configuration/null_display_field.rb +17 -0
  208. data/lib/blacklight/configuration/search_field.rb +1 -0
  209. data/lib/blacklight/configuration/show_field.rb +1 -0
  210. data/lib/blacklight/configuration/sort_field.rb +1 -0
  211. data/lib/blacklight/configuration/tool_config.rb +1 -0
  212. data/lib/blacklight/configuration/view_config.rb +16 -6
  213. data/lib/blacklight/configuration.rb +294 -358
  214. data/lib/blacklight/engine.rb +8 -13
  215. data/lib/blacklight/exceptions.rb +2 -2
  216. data/lib/blacklight/nested_open_struct_with_hash_access.rb +6 -12
  217. data/lib/blacklight/open_struct_with_hash_access.rb +19 -17
  218. data/lib/blacklight/parameters.rb +7 -21
  219. data/lib/blacklight/routes/exportable.rb +1 -0
  220. data/lib/blacklight/routes/searchable.rb +2 -1
  221. data/lib/blacklight/routes.rb +1 -0
  222. data/lib/blacklight/search_builder.rb +10 -10
  223. data/lib/blacklight/search_state/filter_field.rb +8 -25
  224. data/lib/blacklight/search_state/pivot_filter_field.rb +144 -0
  225. data/lib/blacklight/search_state.rb +23 -79
  226. data/lib/blacklight/solr/document.rb +1 -0
  227. data/lib/blacklight/solr/facet_paginator.rb +1 -0
  228. data/lib/blacklight/solr/repository.rb +3 -14
  229. data/lib/blacklight/solr/request.rb +1 -0
  230. data/lib/blacklight/solr/response/facets.rb +21 -5
  231. data/lib/blacklight/solr/response/group.rb +1 -0
  232. data/lib/blacklight/solr/response/group_response.rb +1 -0
  233. data/lib/blacklight/solr/response/more_like_this.rb +1 -0
  234. data/lib/blacklight/solr/response/pagination_methods.rb +4 -3
  235. data/lib/blacklight/solr/response/params.rb +5 -4
  236. data/lib/blacklight/solr/response/response.rb +1 -0
  237. data/lib/blacklight/solr/response/spelling.rb +1 -0
  238. data/lib/blacklight/solr/response.rb +4 -3
  239. data/lib/blacklight/solr/search_builder_behavior.rb +17 -34
  240. data/lib/blacklight/solr.rb +1 -0
  241. data/lib/blacklight/version.rb +1 -0
  242. data/lib/blacklight.rb +7 -10
  243. data/lib/generators/blacklight/assets/importmap_generator.rb +55 -0
  244. data/lib/generators/blacklight/assets/propshaft_generator.rb +25 -0
  245. data/lib/generators/blacklight/assets/sprockets_generator.rb +66 -0
  246. data/lib/generators/blacklight/assets_generator.rb +13 -89
  247. data/lib/generators/blacklight/controller_generator.rb +3 -2
  248. data/lib/generators/blacklight/document_generator.rb +1 -0
  249. data/lib/generators/blacklight/install_generator.rb +4 -3
  250. data/lib/generators/blacklight/models_generator.rb +1 -0
  251. data/lib/generators/blacklight/search_builder_generator.rb +1 -0
  252. data/lib/generators/blacklight/solr_generator.rb +1 -1
  253. data/lib/generators/blacklight/templates/catalog_controller.rb +34 -8
  254. data/lib/generators/blacklight/templates/solr/conf/solrconfig.xml +0 -69
  255. data/lib/generators/blacklight/test_support_generator.rb +4 -2
  256. data/lib/generators/blacklight/user_generator.rb +7 -9
  257. data/lib/railties/blacklight.rake +6 -7
  258. data/package.json +10 -13
  259. data/rollup.config.js +27 -0
  260. data/spec/components/blacklight/constraints_component_spec.rb +17 -13
  261. data/spec/components/blacklight/document_component_spec.rb +23 -82
  262. data/spec/components/blacklight/facet_component_spec.rb +2 -7
  263. data/spec/components/blacklight/facet_field_checkboxes_component_spec.rb +1 -2
  264. data/spec/components/blacklight/facet_field_list_component_spec.rb +7 -6
  265. data/spec/components/blacklight/facet_item_pivot_component_spec.rb +10 -9
  266. data/spec/components/blacklight/response/view_type_component_spec.rb +66 -0
  267. data/spec/components/blacklight/search_bar_component_spec.rb +1 -1
  268. data/spec/components/blacklight/search_context_component_spec.rb +40 -0
  269. data/spec/controllers/blacklight/catalog/component_configuration_spec.rb +1 -6
  270. data/spec/controllers/blacklight/{base_spec.rb → catalog_spec.rb} +2 -2
  271. data/spec/controllers/bookmarks_controller_spec.rb +2 -3
  272. data/spec/controllers/catalog_controller_spec.rb +13 -135
  273. data/spec/features/advanced_search_spec.rb +0 -56
  274. data/spec/features/autocomplete_spec.rb +1 -1
  275. data/spec/features/axe_spec.rb +1 -6
  276. data/spec/features/bookmarks_spec.rb +1 -1
  277. data/spec/features/facets_spec.rb +1 -1
  278. data/spec/features/search_context_spec.rb +4 -10
  279. data/spec/features/search_results_spec.rb +0 -33
  280. data/spec/features/sitelinks_search_box.rb +13 -0
  281. data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb +2 -138
  282. data/spec/helpers/blacklight/facets_helper_behavior_spec.rb +0 -387
  283. data/spec/helpers/blacklight/icon_helper_behavior_spec.rb +8 -0
  284. data/spec/helpers/blacklight/render_partials_helper_behavior_spec.rb +5 -7
  285. data/spec/helpers/blacklight/url_helper_behavior_spec.rb +9 -131
  286. data/spec/helpers/blacklight_helper_spec.rb +3 -242
  287. data/spec/helpers/catalog_helper_spec.rb +7 -118
  288. data/spec/i18n_spec.rb +1 -0
  289. data/spec/integration/generators/blacklight/solr_generator_spec.rb +1 -1
  290. data/spec/lib/blacklight/configuration/facet_field_spec.rb +27 -16
  291. data/spec/lib/blacklight/configuration/field_spec.rb +1 -1
  292. data/spec/lib/blacklight/configuration/view_config_spec.rb +1 -1
  293. data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb +2 -2
  294. data/spec/lib/blacklight/parameters_spec.rb +1 -4
  295. data/spec/lib/blacklight/search_state/filter_field_spec.rb +4 -4
  296. data/spec/lib/blacklight/search_state/pivot_filter_field_spec.rb +117 -0
  297. data/spec/lib/blacklight/search_state_spec.rb +80 -198
  298. data/spec/lib/tasks/blacklight_task_spec.rb +1 -0
  299. data/spec/models/blacklight/configuration_spec.rb +17 -51
  300. data/spec/models/blacklight/document/active_model_shim_spec.rb +2 -2
  301. data/spec/models/blacklight/icon_spec.rb +31 -15
  302. data/spec/models/blacklight/search_builder_spec.rb +9 -9
  303. data/spec/models/blacklight/solr/document_spec.rb +3 -3
  304. data/spec/models/blacklight/solr/repository_spec.rb +0 -27
  305. data/spec/models/blacklight/solr/response/facets_spec.rb +27 -27
  306. data/spec/models/blacklight/solr/response/group_response_spec.rb +1 -0
  307. data/spec/models/blacklight/solr/response/group_spec.rb +1 -0
  308. data/spec/models/blacklight/solr/response_spec.rb +9 -2
  309. data/spec/models/blacklight/solr/search_builder_spec.rb +24 -31
  310. data/spec/models/blacklight/user_spec.rb +22 -0
  311. data/spec/presenters/blacklight/clause_presenter_spec.rb +1 -0
  312. data/spec/presenters/blacklight/document_presenter_spec.rb +2 -2
  313. data/spec/presenters/blacklight/facet_field_presenter_spec.rb +85 -12
  314. data/spec/presenters/blacklight/facet_grouped_item_presenter_spec.rb +1 -0
  315. data/spec/presenters/blacklight/facet_item_presenter_spec.rb +14 -13
  316. data/spec/presenters/blacklight/field_presenter_spec.rb +0 -14
  317. data/spec/presenters/blacklight/index_presenter_spec.rb +2 -4
  318. data/spec/presenters/blacklight/json_presenter_spec.rb +1 -0
  319. data/spec/presenters/blacklight/link_alternate_presenter_spec.rb +3 -2
  320. data/spec/presenters/blacklight/show_presenter_spec.rb +20 -29
  321. data/spec/presenters/thumbnail_presenter_spec.rb +1 -1
  322. data/spec/requests/load_suggestions_spec.rb +16 -0
  323. data/spec/routing/catalog_routing_spec.rb +2 -1
  324. data/spec/services/blacklight/search_service_spec.rb +31 -68
  325. data/spec/spec_helper.rb +6 -4
  326. data/spec/support/controller_level_helpers.rb +1 -2
  327. data/spec/support/features/search_helpers.rb +39 -0
  328. data/spec/support/features/session_helpers.rb +1 -0
  329. data/spec/support/features.rb +3 -0
  330. data/spec/support/view_component_capybara_test_helpers.rb +8 -0
  331. data/spec/test_app_templates/lib/generators/test_app_generator.rb +9 -2
  332. data/spec/views/catalog/_document.html.erb_spec.rb +3 -34
  333. data/spec/views/catalog/_facet_index_navigation.html.erb_spec.rb +1 -1
  334. data/spec/views/catalog/_search_header.erb_spec.rb +1 -0
  335. data/spec/views/catalog/_show_sidebar.erb_spec.rb +1 -0
  336. data/spec/views/catalog/_show_tools.html.erb_spec.rb +5 -66
  337. data/spec/views/catalog/_view_type_group.html.erb_spec.rb +17 -9
  338. data/spec/views/catalog/email_success.html.erb_spec.rb +2 -2
  339. data/spec/views/catalog/facet.html.erb_spec.rb +6 -3
  340. data/spec/views/catalog/index.atom.builder_spec.rb +18 -11
  341. data/spec/views/catalog/index.html.erb_spec.rb +5 -6
  342. data/spec/views/catalog/index.json.jbuilder_spec.rb +2 -2
  343. data/spec/views/catalog/show.html.erb_spec.rb +3 -25
  344. data/spec/views/catalog/sms_success.html.erb_spec.rb +2 -2
  345. data/tasks/blacklight.rake +6 -4
  346. metadata +79 -126
  347. data/.babelrc +0 -11
  348. data/app/assets/images/blacklight/list.svg +0 -1
  349. data/app/assets/images/blacklight/search.svg +0 -1
  350. data/app/assets/stylesheets/blacklight/_twitter_typeahead.scss +0 -37
  351. data/app/components/blacklight/content_areas_shim.rb +0 -13
  352. data/app/controllers/concerns/blacklight/base.rb +0 -12
  353. data/app/controllers/concerns/blacklight/default_component_configuration.rb +0 -64
  354. data/app/controllers/concerns/blacklight/facet.rb +0 -69
  355. data/app/controllers/concerns/blacklight/search_fields.rb +0 -46
  356. data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb +0 -27
  357. data/app/helpers/blacklight/render_constraints_helper_behavior.rb +0 -188
  358. data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb +0 -97
  359. data/app/helpers/blacklight/suggest_helper_behavior.rb +0 -13
  360. data/app/javascript/blacklight/autocomplete.js +0 -36
  361. data/app/javascript/blacklight/facet_load.js +0 -22
  362. data/app/presenters/blacklight/search_bar_presenter.rb +0 -47
  363. data/app/views/catalog/_constraints_element.html.erb +0 -14
  364. data/app/views/catalog/_document_action.html.erb +0 -5
  365. data/app/views/catalog/_facet_group.html.erb +0 -5
  366. data/app/views/catalog/_facet_limit.html.erb +0 -3
  367. data/app/views/catalog/_index.html.erb +0 -1
  368. data/app/views/catalog/_index_header.html.erb +0 -22
  369. data/app/views/catalog/_previous_next_doc.html.erb +0 -2
  370. data/app/views/catalog/_show.html.erb +0 -6
  371. data/app/views/catalog/_show_header.html.erb +0 -2
  372. data/app/views/catalog/_thumbnail.html.erb +0 -1
  373. data/lib/blacklight/deprecations/engine_configuration.rb +0 -66
  374. data/lib/blacklight/deprecations/search_state_normalization.rb +0 -52
  375. data/spec/components/blacklight/header_component_spec.rb +0 -20
  376. data/spec/controllers/blacklight/facet_spec.rb +0 -33
  377. data/spec/controllers/blacklight/search_fields_spec.rb +0 -62
  378. data/spec/features/sitelinks_search_box_spec.rb +0 -13
  379. data/spec/helpers/blacklight/hash_as_hidden_fields_behavior_spec.rb +0 -26
  380. data/spec/helpers/blacklight/render_constraints_helper_behavior_spec.rb +0 -92
  381. data/spec/helpers/blacklight/search_history_constraints_helper_behavior_spec.rb +0 -101
  382. data/spec/helpers/blacklight/suggest_helper_behavior_spec.rb +0 -48
  383. data/spec/lib/blacklight/engine_spec.rb +0 -41
  384. data/spec/presenters/blacklight/search_bar_presenter_spec.rb +0 -94
  385. data/spec/support/view_component_test_helpers.rb +0 -35
  386. data/spec/views/catalog/_constraints.html.erb_spec.rb +0 -33
  387. data/spec/views/catalog/_facet_group.html.erb_spec.rb +0 -84
  388. data/spec/views/catalog/_facets.html.erb_spec.rb +0 -15
  389. data/spec/views/catalog/_index.html.erb_spec.rb +0 -62
  390. data/spec/views/catalog/_index_header.html.erb_spec.rb +0 -35
  391. data/spec/views/catalog/_previous_next_doc.html.erb_spec.rb +0 -22
  392. data/spec/views/catalog/_show.html.erb_spec.rb +0 -62
  393. data/spec/views/catalog/_thumbnail.html.erb_spec.rb +0 -38
@@ -1,19 +1,11 @@
1
1
  # frozen_string_literal: true
2
- require 'blacklight/deprecations/engine_configuration'
2
+
3
3
  require 'view_component'
4
4
 
5
5
  module Blacklight
6
6
  class Engine < Rails::Engine
7
7
  engine_name "blacklight"
8
8
 
9
- # BlacklightHelper is needed by all helpers, so we inject it
10
- # into action view base here.
11
- initializer 'blacklight.helpers' do
12
- config.after_initialize do
13
- ActionView::Base.include BlacklightHelper
14
- end
15
- end
16
-
17
9
  config.after_initialize do
18
10
  Blacklight::Configuration.initialize_default_configuration
19
11
  end
@@ -28,7 +20,9 @@ module Blacklight
28
20
  end
29
21
 
30
22
  initializer "blacklight.assets.precompile" do
31
- PRECOMPILE_ASSETS = %w(favicon.ico blacklight/blacklight.js blacklight/blacklight.js.map).freeze
23
+ # rubocop:disable Lint/ConstantDefinitionInBlock
24
+ PRECOMPILE_ASSETS = %w(favicon.ico blacklight/blacklight.js blacklight/blacklight.js.map blacklight/blacklight.esm.js blacklight/blacklight.esm.js.map).freeze
25
+ # rubocop:enable Lint/ConstantDefinitionInBlock
32
26
 
33
27
  # When Rails has been generated in API mode, it does not have sprockets available
34
28
  if Rails.application.config.respond_to?(:assets)
@@ -36,6 +30,10 @@ module Blacklight
36
30
  end
37
31
  end
38
32
 
33
+ initializer "blacklight.importmap", before: "importmap" do |app|
34
+ app.config.importmap.paths << Engine.root.join("config/importmap.rb") if app.config.respond_to?(:importmap)
35
+ end
36
+
39
37
  bl_global_config = OpenStructWithHashAccess.new
40
38
 
41
39
  bl_global_config.sms_mappings = {
@@ -70,9 +68,6 @@ module Blacklight
70
68
  # Blacklight specific stuff in this single struct:
71
69
  Blacklight::Engine.config.blacklight = bl_global_config
72
70
 
73
- # Deprecate top-level access to legacy engine configuration
74
- Blacklight::Deprecations::EngineConfiguration.deprecate_in(Blacklight::Engine.config)
75
-
76
71
  config.action_dispatch.rescue_responses["Blacklight::Exceptions::RecordNotFound"] = :not_found
77
72
  end
78
73
  end
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Blacklight
3
4
  module Exceptions
4
5
  class AccessDenied < StandardError
@@ -15,8 +16,7 @@ module Blacklight
15
16
 
16
17
  class ECONNREFUSED < ::Errno::ECONNREFUSED; end
17
18
 
18
- # NOTE: In Blacklight 8, the parent class will be Timeout::Error
19
- class RepositoryTimeout < InvalidRequest; end
19
+ class RepositoryTimeout < Timeout::Error; end
20
20
 
21
21
  class IconNotFound < StandardError
22
22
  end
@@ -1,13 +1,11 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  require 'ostruct'
3
4
  module Blacklight
4
5
  ##
5
6
  # An OpenStruct refinement that converts any hash-keys into
6
7
  # additional instances of NestedOpenStructWithHashAccess
7
8
  class NestedOpenStructWithHashAccess < OpenStructWithHashAccess
8
- extend Deprecation
9
- self.deprecation_horizon = 'blacklight 8.0'
10
-
11
9
  attr_reader :nested_class
12
10
 
13
11
  delegate :default_proc=, to: :to_h
@@ -66,8 +64,8 @@ module Blacklight
66
64
  self.class.new nested_class, @table.deep_dup
67
65
  end
68
66
 
69
- def select *args, &block
70
- self.class.new nested_class, to_h.select(*args, &block)
67
+ def select(...)
68
+ self.class.new nested_class, to_h.select(...)
71
69
  end
72
70
 
73
71
  ##
@@ -100,15 +98,11 @@ module Blacklight
100
98
  m = mid[0...-1].to_sym
101
99
  new_ostruct_member!(m)
102
100
  @table[m] = args.first
103
- elsif len.zero? && kwargs.blank? && !block
104
- Deprecation.warn(Blacklight::NestedOpenStructWithHashAccess,
105
- "Initializing a #{nested_class} implicitly (by calling #{mid}) is deprecated. Call it as #{mid}! or pass initialize arguments")
106
-
107
- new_ostruct_member!(mid)
108
- @table[mid]
109
- else
101
+ elsif len.positive? || kwargs.any? || block
110
102
  new_ostruct_member!(mid)
111
103
  @table[mid] = nested_class.new(key: mid, **(args.first || {}), **kwargs)
104
+ else
105
+ @table[mid]
112
106
  end
113
107
 
114
108
  block&.call(res)
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  require 'ostruct'
3
4
  module Blacklight
4
5
  ##
@@ -15,16 +16,16 @@ module Blacklight
15
16
  @table
16
17
  end
17
18
 
18
- def select *args, &block
19
- self.class.new to_h.select(*args, &block)
19
+ def select(...)
20
+ self.class.new to_h.select(...)
20
21
  end
21
22
 
22
- def sort_by *args, &block
23
- self.class.new Hash[to_h.sort_by(*args, &block)]
23
+ def sort_by(...)
24
+ self.class.new to_h.sort_by(...).to_h
24
25
  end
25
26
 
26
- def sort_by! *args, &block
27
- replace Hash[to_h.sort_by(*args, &block)]
27
+ def sort_by!(...)
28
+ replace to_h.sort_by(...).to_h
28
29
  self
29
30
  end
30
31
 
@@ -52,18 +53,19 @@ module Blacklight
52
53
  self.class.new @table.deep_dup
53
54
  end
54
55
 
55
- if Rails.version < '6'
56
- # Ported from Rails 6 to fix an incompatibility with ostruct
57
- def try(method_name = nil, *args, &block)
58
- if method_name.nil? && block_given?
59
- if b.arity.zero?
60
- instance_eval(&block)
61
- else
62
- yield self
63
- end
64
- elsif respond_to?(method_name)
65
- public_send(method_name, *args, &b)
56
+ def deep_transform_values(&method)
57
+ self.class.new @table.deep_transform_values(&method)
58
+ end
59
+
60
+ def try(method_name = nil, *args, &block)
61
+ if method_name.nil? && block_given?
62
+ if b.arity.zero?
63
+ instance_eval(&block)
64
+ else
65
+ yield self
66
66
  end
67
+ elsif respond_to?(method_name)
68
+ public_send(method_name, *args, &b)
67
69
  end
68
70
  end
69
71
  end
@@ -1,17 +1,13 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'hashdiff'
4
-
5
3
  module Blacklight
6
4
  class Parameters
7
- extend Deprecation
8
-
9
5
  ##
10
6
  # Sanitize the search parameters by removing unnecessary parameters
11
7
  # from the provided parameters.
12
8
  # @param [Hash] params parameters
13
9
  def self.sanitize params
14
- params.reject { |_k, v| v.nil? }
10
+ params.reject { |_k, v| v.nil? } # rubocop:disable Style/CollectionCompact not available in Rails 6.0
15
11
  .except(:action, :controller, :id, :commit, :utf8)
16
12
  end
17
13
 
@@ -30,7 +26,7 @@ module Blacklight
30
26
  complex_params_from_b, scalar_params_from_b = b.flatten.uniq.partition { |x| x.is_a? Hash }
31
27
  complex_params_from_b = complex_params_from_b.inject({}) { |tmp, h| _deep_merge_permitted_param_hashes(h, tmp) }
32
28
 
33
- (scalar_params_from_a + scalar_params_from_b + [_deep_merge_permitted_param_hashes(complex_params_from_a, complex_params_from_b)]).reject(&:blank?).uniq
29
+ (scalar_params_from_a + scalar_params_from_b + [_deep_merge_permitted_param_hashes(complex_params_from_a, complex_params_from_b)]).compact_blank.uniq
34
30
  end
35
31
 
36
32
  private_class_method def self._deep_merge_permitted_param_hashes(h1, h2)
@@ -74,33 +70,23 @@ module Blacklight
74
70
  if blacklight_config.filter_search_state_fields
75
71
  params.permit(*permitted_params)
76
72
  else
77
- warn_about_deprecated_parameter_handling(params, permitted_params)
78
73
  params.deep_dup.permit!
79
74
  end
80
75
  end
81
76
 
82
77
  private
83
78
 
84
- def warn_about_deprecated_parameter_handling(params, permitted_params)
85
- diff = Hashdiff.diff(params.to_unsafe_h, params.permit(*permitted_params).to_h)
86
- return if diff.empty?
87
-
88
- Deprecation.warn(Blacklight::Parameters, "Blacklight 8 will filter out non-search parameter, including: #{diff.map { |_op, key, *| key }.to_sentence}")
89
- end
90
-
91
79
  # Facebook's crawler turns array query parameters into a hash with numeric keys. Once we know
92
80
  # the expected parameter structure, we can unmangle those parameters to match our expected values.
93
81
  def deep_unmangle_params!(params, permitted_params)
94
82
  permitted_params.select { |p| p.is_a?(Hash) }.each do |permission|
95
83
  permission.each do |key, permitted_value|
96
- if params[key].is_a?(ActionController::Parameters) && permitted_value.is_a?(Hash)
84
+ next unless params[key].is_a?(ActionController::Parameters)
85
+
86
+ if permitted_value.is_a?(Hash)
97
87
  deep_unmangle_params!(params[key], [permitted_value])
98
- elsif permitted_value.is_a?(Array) && permitted_value.empty?
99
- if params[key].is_a?(ActionController::Parameters) && params[key]&.keys&.all? { |k| k.to_s =~ /\A\d+\z/ }
100
- params[key] = params[key].values
101
- elsif params[key].is_a?(String)
102
- params[key] = Array(params[key])
103
- end
88
+ elsif permitted_value.is_a?(Array) && permitted_value.empty? && params[key]&.keys&.all? { |k| k.to_s =~ /\A\d+\z/ }
89
+ params[key] = params[key].values
104
90
  end
105
91
  end
106
92
  end
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Blacklight
3
4
  module Routes
4
5
  class Exportable
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Blacklight
3
4
  module Routes
4
5
  class Searchable
@@ -14,7 +15,7 @@ module Blacklight
14
15
  mapper.get ":id/raw", action: 'raw', as: 'raw', defaults: { format: 'json' }
15
16
 
16
17
  mapper.get "opensearch"
17
- mapper.get 'suggest', as: 'suggest_index', defaults: { format: 'json' }
18
+ mapper.get 'suggest', as: 'suggest_index'
18
19
  mapper.get "facet/:id", action: 'facet', as: 'facet'
19
20
  end
20
21
  end
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Blacklight
3
4
  module Routes
4
5
  require 'blacklight/routes/exportable'
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Blacklight
3
4
  ##
4
5
  # Blacklight's SearchBuilder converts blacklight request parameters into
@@ -49,7 +50,6 @@ module Blacklight
49
50
  # @example
50
51
  # search_builder.where(id: [1,2,3]) # produces: q:"{!lucene}id:(1 OR 2 OR 3)"
51
52
  def where(conditions)
52
- Deprecation.warn(Blacklight::SearchBuilder, "SearchBuilder#where must be called with a hash, received #{conditions.inspect}.") unless conditions.is_a? Hash
53
53
  params_will_change!
54
54
  @search_state = @search_state.reset(@search_state.params.merge(q: conditions))
55
55
  @blacklight_params = @search_state.params
@@ -62,9 +62,9 @@ module Blacklight
62
62
  def append(*addl_processor_chain)
63
63
  params_will_change!
64
64
  builder = self.class.new(processor_chain + addl_processor_chain, scope)
65
- .with(search_state)
66
- .merge(@merged_params)
67
- .reverse_merge(@reverse_merged_params)
65
+ .with(search_state)
66
+ .merge(@merged_params)
67
+ .reverse_merge(@reverse_merged_params)
68
68
 
69
69
  builder.start = @start if @start
70
70
  builder.rows = @rows if @rows
@@ -82,9 +82,9 @@ module Blacklight
82
82
  # chain are ignored as no-ops, rather than raising.
83
83
  def except(*except_processor_chain)
84
84
  builder = self.class.new(processor_chain - except_processor_chain, scope)
85
- .with(search_state)
86
- .merge(@merged_params)
87
- .reverse_merge(@reverse_merged_params)
85
+ .with(search_state)
86
+ .merge(@merged_params)
87
+ .reverse_merge(@reverse_merged_params)
88
88
 
89
89
  builder.start = @start if @start
90
90
  builder.rows = @rows if @rows
@@ -121,9 +121,9 @@ module Blacklight
121
121
  return @params unless params_need_update?
122
122
 
123
123
  @params = processed_parameters
124
- .reverse_merge(@reverse_merged_params)
125
- .merge(@merged_params)
126
- .tap { clear_changes }
124
+ .reverse_merge(@reverse_merged_params)
125
+ .merge(@merged_params)
126
+ .tap { clear_changes }
127
127
  end
128
128
 
129
129
  alias_method :query, :to_hash
@@ -8,19 +8,13 @@ module Blacklight
8
8
 
9
9
  # @!attribute config
10
10
  # @return [Blacklight::Configuration::FacetField]
11
- attr_reader :config
12
-
13
11
  # @!attribute search_state
14
12
  # @return [Blacklight::SearchState]
15
- attr_reader :search_state
16
-
17
13
  # @!attribute param
18
14
  # @return [String,Symbol]
19
- attr_reader :filters_key
20
-
21
15
  # @!attribute inclusive_param
22
16
  # @return [String,Symbol]
23
- attr_reader :inclusive_filters_key
17
+ attr_reader :config, :search_state, :filters_key, :inclusive_filters_key
24
18
 
25
19
  # @return [String,Symbol]
26
20
  delegate :key, to: :config
@@ -47,9 +41,7 @@ module Blacklight
47
41
  end
48
42
  end
49
43
 
50
- if item.respond_to?(:field) && item.field != key
51
- return new_state.filter(item.field).add(item)
52
- end
44
+ return new_state.filter(item.field).add(item) if item.respond_to?(:field) && item.field != key
53
45
 
54
46
  url_key = key
55
47
  params = new_state.params
@@ -82,9 +74,8 @@ module Blacklight
82
74
  # @return [Blacklight::SearchState] new state
83
75
  def remove(item)
84
76
  new_state = search_state.reset_search
85
- if item.respond_to?(:field) && item.field != key
86
- return new_state.filter(item.field).remove(item)
87
- end
77
+
78
+ return new_state.filter(item.field).remove(item) if item.respond_to?(:field) && item.field != key
88
79
 
89
80
  url_key = config.key
90
81
  params = new_state.params
@@ -106,13 +97,6 @@ module Blacklight
106
97
  params[param][url_key] = (params[param][url_key] || []).dup
107
98
 
108
99
  collection = params[param][url_key]
109
- # collection should be an array, because we link to ?f[key][]=value,
110
- # however, Facebook (and maybe some other PHP tools) tranform that parameters
111
- # into ?f[key][0]=value, which Rails interprets as a Hash.
112
- if collection.is_a? Hash
113
- Deprecation.warn(self, 'Normalizing parameters in FilterField#remove is deprecated')
114
- collection = collection.values
115
- end
116
100
 
117
101
  params[param][url_key] = collection - Array(value)
118
102
  params[param].delete(url_key) if params[param][url_key].empty?
@@ -143,16 +127,15 @@ module Blacklight
143
127
  # @param [String,#value] item a filter to remove from the url
144
128
  # @return [Boolean] whether the provided filter is currently applied/selected
145
129
  def include?(item)
146
- if item.respond_to?(:field) && item.field != key
147
- return search_state.filter(item.field).selected?(item)
148
- end
130
+ return search_state.filter(item.field).selected?(item) if item.respond_to?(:field) && item.field != key
149
131
 
150
132
  value = as_url_parameter(item)
151
133
  params = search_state.params
152
134
 
153
- if value.is_a?(Array)
135
+ case value
136
+ when Array
154
137
  (params.dig(inclusive_filters_key, key) || []).to_set == value.to_set
155
- elsif value == Blacklight::SearchState::FilterField::MISSING
138
+ when Blacklight::SearchState::FilterField::MISSING
156
139
  (params.dig(filters_key, "-#{key}") || []).include?(Blacklight::Engine.config.blacklight.facet_missing_param)
157
140
  else
158
141
  (params.dig(filters_key, key) || []).include?(value)
@@ -0,0 +1,144 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Blacklight
4
+ class SearchState
5
+ # Modeling access to filter query parameters
6
+ class PivotFilterField < FilterField
7
+ STOP_VALUE = [:stop].freeze
8
+
9
+ # @return [Array]
10
+ delegate :pivot, to: :config
11
+
12
+ # @param [String,#value] item a filter item to add to the url
13
+ # @return [Blacklight::SearchState] new state
14
+ def add(item)
15
+ item = wrap_item(item)
16
+ new_state = search_state.reset_search
17
+ return new_state if include?(item)
18
+
19
+ pivot_values = pivot_fq(item).merge(pivot[0].to_sym => as_url_parameter(item))
20
+ pivot_values.inject(new_state) do |memo_state, entry|
21
+ url_key, value = entry
22
+ field_facade = FilterField.new(null_field(url_key), memo_state)
23
+ next memo_state if value.nil? || field_facade.include?(value)
24
+
25
+ field_facade.add(value)
26
+ end
27
+ end
28
+
29
+ # @param [String,#value] item a filter to remove from the url
30
+ # @return [Blacklight::SearchState] new state
31
+ def remove(item)
32
+ item = wrap_item(item)
33
+ new_state = search_state.reset_search
34
+ pivot_values = pivot_fq(item).merge(pivot[0].to_sym => as_url_parameter(item))
35
+ pivot_values.inject(new_state) do |memo_state, entry|
36
+ url_key, value = entry
37
+ next memo_state if value.nil?
38
+
39
+ FilterField.new(null_field(url_key), memo_state).remove(value)
40
+ end
41
+ end
42
+
43
+ # Matrix the values of the pivoted fields
44
+ # @return [Array] an array of applied filters
45
+ # rubocop:disable Lint/UnusedMethodArgument
46
+ def values(except: [])
47
+ return nil unless pivot.is_a?(Array) && pivot.present?
48
+
49
+ params = search_state.params
50
+ # values should have at most one terminal blank pivot
51
+ pivot_values = pivot.map { |k| Array(params.dig(:f, k)) || STOP_VALUE }
52
+ pivot_values = pivot_values[0..(pivot_values.index(STOP_VALUE) || -1)]
53
+ # put an explicit nil in for the matrix
54
+ pivot_values[-1] = [nil] if pivot_values.last == STOP_VALUE
55
+ top_level_values = pivot_values.shift
56
+ return [] if top_level_values.first.blank?
57
+
58
+ pivot_values.each { |pivot_value| pivot_value[0] ||= nil }
59
+ matrix_values = top_level_values.product(*pivot_values)
60
+ matrix_values.map do |vals|
61
+ PivotValue.new(value: vals.shift, fq: pivot[1..].map(&:to_sym).zip(vals).to_h)
62
+ end
63
+ end
64
+ # rubocop:enable Lint/UnusedMethodArgument
65
+
66
+ # @param [String, #value #fq] item a filter may represent in the url
67
+ # @return [Boolean] whether the provided filter is currently applied/selected
68
+ def include?(item)
69
+ return false unless pivot.is_a?(Array) && pivot.present?
70
+
71
+ params = search_state.params
72
+ item = wrap_item(item)
73
+ pivot_values = pivot_fq(item).merge(pivot[0].to_sym => as_url_parameter(item))
74
+ pivot_values.inject(true) do |m, entry|
75
+ k, v = entry
76
+ m && params.dig(:f, k)&.include?(as_url_parameter(v))
77
+ end
78
+ end
79
+
80
+ class PivotValue
81
+ attr_accessor :value, :fq
82
+
83
+ delegate :blank?, :present?, to: :value
84
+ alias empty? blank?
85
+
86
+ def initialize(value: nil, fq: {}, **_args) # rubocop:disable Naming/MethodParameterName
87
+ @value = value
88
+ @fq = fq
89
+ end
90
+ end
91
+
92
+ class QueryBuilder
93
+ # @return [Array] filter_query, subqueries
94
+ def self.call(search_builder, filter, solr_parameters)
95
+ existing = solr_parameters['fq']&.dup || []
96
+ queries = []
97
+ filter.values.compact_blank.each do |value|
98
+ queries << search_builder.send(:facet_value_to_fq_string, filter.pivot.first, value.value)
99
+ value.fq.each do |entry|
100
+ k, v = entry
101
+ queries << search_builder.send(:facet_value_to_fq_string, k, v) if v
102
+ end
103
+ queries.uniq!
104
+ end
105
+ [(queries - existing)]
106
+ end
107
+ end
108
+
109
+ private
110
+
111
+ def null_field(key)
112
+ Blacklight::Configuration::NullField.new(key: key)
113
+ end
114
+
115
+ def pivot_fq(item = nil)
116
+ fq_keys = pivot[1..].map(&:to_sym)
117
+ null_values = fq_keys.index_with(nil)
118
+ return null_values unless item.respond_to?(:fq)
119
+
120
+ item_fq = item.fq.to_h.symbolize_keys.slice(*fq_keys)
121
+ null_values.merge item_fq
122
+ end
123
+
124
+ def wrap_item(item)
125
+ item = invert_item(item) if item.respond_to?(:field) && item.field.to_sym != pivot.first.to_sym
126
+ return item if item.respond_to? :value
127
+ return PivotValue.new(**item) if item.is_a? Hash
128
+
129
+ PivotValue.new(value: item, fq: pivot_fq)
130
+ end
131
+
132
+ # the parsed Blacklight::Solr::Response::Facets::FacetItem objects are inverted -
133
+ # the subordinate value is at the top, and the other values are in fq - to permit
134
+ # easier value labeling in the UI. To manage the search links, they need to be
135
+ # reinverted.
136
+ def invert_item(item)
137
+ item_fq = item.fq.symbolize_keys
138
+ item_value = item_fq.delete(pivot[0].to_sym)
139
+ item_fq = item_fq.merge(item.field.to_sym => item.value).slice(*pivot.map(&:to_sym))
140
+ PivotValue.new(value: item_value, fq: item_fq)
141
+ end
142
+ end
143
+ end
144
+ end