blacklight 7.33.0 → 8.0.0.beta2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (392) hide show
  1. checksums.yaml +4 -4
  2. data/.env +3 -2
  3. data/.github/workflows/ruby.yml +38 -107
  4. data/.rubocop.yml +243 -2
  5. data/.rubocop_todo.yml +214 -270
  6. data/Gemfile +11 -6
  7. data/README.md +11 -3
  8. data/VERSION +1 -1
  9. data/app/assets/javascripts/blacklight/blacklight.esm.js +389 -0
  10. data/app/assets/javascripts/blacklight/blacklight.esm.js.map +1 -0
  11. data/app/assets/javascripts/blacklight/blacklight.js +356 -496
  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 +1 -1
  28. data/app/components/blacklight/advanced_search_form_component.rb +7 -9
  29. data/app/components/blacklight/constraints_component.rb +27 -37
  30. data/app/components/blacklight/document/action_component.html.erb +2 -9
  31. data/app/components/blacklight/document/action_component.rb +26 -8
  32. data/app/components/blacklight/document/actions_component.rb +2 -2
  33. data/app/components/blacklight/document/bookmark_component.html.erb +9 -0
  34. data/app/components/blacklight/document/bookmark_component.rb +4 -2
  35. data/app/components/blacklight/document/citation_component.rb +5 -3
  36. data/app/components/blacklight/document/group_component.rb +7 -3
  37. data/app/components/blacklight/document/sidebar_component.html.erb +2 -0
  38. data/app/components/blacklight/document/sidebar_component.rb +16 -0
  39. data/app/components/blacklight/document/thumbnail_component.html.erb +2 -7
  40. data/app/components/blacklight/document/thumbnail_component.rb +1 -9
  41. data/app/components/blacklight/document_component.html.erb +4 -0
  42. data/app/components/blacklight/document_component.rb +7 -23
  43. data/app/components/blacklight/document_metadata_component.rb +5 -6
  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.html.erb +2 -0
  56. data/app/components/blacklight/header_component.rb +26 -0
  57. data/app/components/blacklight/hidden_search_state_component.rb +1 -2
  58. data/app/components/blacklight/icons/legacy_icon_component.rb +30 -0
  59. data/app/components/blacklight/icons/list_component.rb +16 -0
  60. data/app/components/blacklight/icons/search_component.rb +16 -0
  61. data/app/components/blacklight/metadata_field_component.html.erb +2 -2
  62. data/app/components/blacklight/metadata_field_component.rb +24 -8
  63. data/app/components/blacklight/metadata_field_layout_component.rb +0 -18
  64. data/app/components/blacklight/response/facet_group_component.html.erb +3 -5
  65. data/app/components/blacklight/response/facet_group_component.rb +29 -8
  66. data/app/components/blacklight/response/sort_component.rb +1 -1
  67. data/app/components/blacklight/response/spellcheck_component.rb +17 -6
  68. data/app/components/blacklight/response/view_type_button_component.rb +2 -6
  69. data/app/components/blacklight/response/view_type_component.rb +3 -5
  70. data/app/components/blacklight/search/sidebar_component.html.erb +8 -0
  71. data/app/components/blacklight/search/sidebar_component.rb +17 -0
  72. data/app/components/blacklight/search_bar_component.html.erb +20 -15
  73. data/app/components/blacklight/search_bar_component.rb +2 -16
  74. data/app/components/blacklight/search_button_component.rb +3 -3
  75. data/app/components/blacklight/search_context_component.rb +43 -9
  76. data/app/components/blacklight/search_header_component.html.erb +2 -0
  77. data/app/components/blacklight/search_header_component.rb +6 -0
  78. data/app/components/blacklight/search_navbar_component.html.erb +5 -0
  79. data/app/components/blacklight/search_navbar_component.rb +34 -0
  80. data/app/components/blacklight/start_over_button_component.rb +5 -3
  81. data/app/components/blacklight/system/dropdown_component.rb +2 -2
  82. data/app/components/blacklight/system/flash_message_component.html.erb +3 -1
  83. data/app/components/blacklight/system/flash_message_component.rb +11 -2
  84. data/app/components/blacklight/system/modal_component.html.erb +1 -1
  85. data/app/components/blacklight/system/modal_component.rb +0 -2
  86. data/app/components/blacklight/top_navbar_component.html.erb +12 -0
  87. data/app/components/blacklight/top_navbar_component.rb +13 -0
  88. data/app/controllers/bookmarks_controller.rb +1 -0
  89. data/app/controllers/catalog_controller.rb +1 -0
  90. data/app/controllers/concerns/blacklight/bookmarks.rb +10 -5
  91. data/app/controllers/concerns/blacklight/catalog.rb +21 -72
  92. data/app/controllers/concerns/blacklight/controller.rb +6 -43
  93. data/app/controllers/concerns/blacklight/search_context.rb +25 -7
  94. data/app/controllers/concerns/blacklight/search_history.rb +2 -0
  95. data/app/controllers/concerns/blacklight/searchable.rb +12 -1
  96. data/app/controllers/concerns/blacklight/token_based_user.rb +1 -0
  97. data/app/controllers/search_history_controller.rb +1 -0
  98. data/app/helpers/blacklight/blacklight_helper_behavior.rb +10 -308
  99. data/app/helpers/blacklight/catalog_helper_behavior.rb +22 -137
  100. data/app/helpers/blacklight/component_helper_behavior.rb +2 -53
  101. data/app/helpers/blacklight/configuration_helper_behavior.rb +2 -117
  102. data/app/helpers/blacklight/facets_helper_behavior.rb +4 -321
  103. data/app/helpers/blacklight/icon_helper_behavior.rb +5 -4
  104. data/app/helpers/blacklight/layout_helper_behavior.rb +1 -0
  105. data/app/helpers/blacklight/render_partials_helper_behavior.rb +11 -30
  106. data/app/helpers/blacklight/url_helper_behavior.rb +13 -97
  107. data/app/helpers/blacklight_helper.rb +1 -0
  108. data/app/helpers/catalog_helper.rb +1 -0
  109. data/app/javascript/blacklight/bookmark_toggle.js +13 -19
  110. data/app/javascript/blacklight/button_focus.js +12 -10
  111. data/app/javascript/blacklight/checkbox_submit.js +68 -122
  112. data/app/javascript/blacklight/core.js +6 -5
  113. data/app/javascript/blacklight/index.js +13 -0
  114. data/app/javascript/blacklight/modal.js +104 -164
  115. data/app/javascript/blacklight/modalForm.js +60 -0
  116. data/app/javascript/blacklight/search_context.js +45 -55
  117. data/app/models/blacklight/facet_paginator.rb +3 -2
  118. data/app/models/blacklight/icon.rb +4 -2
  119. data/app/models/bookmark.rb +0 -2
  120. data/app/models/concerns/blacklight/configurable.rb +5 -4
  121. data/app/models/concerns/blacklight/document/active_model_shim.rb +1 -0
  122. data/app/models/concerns/blacklight/document/attributes.rb +50 -0
  123. data/app/models/concerns/blacklight/document/cache_key.rb +1 -0
  124. data/app/models/concerns/blacklight/document/dublin_core.rb +2 -1
  125. data/app/models/concerns/blacklight/document/email.rb +1 -0
  126. data/app/models/concerns/blacklight/document/export.rb +2 -1
  127. data/app/models/concerns/blacklight/document/extensions.rb +1 -0
  128. data/app/models/concerns/blacklight/document/schema_org.rb +1 -0
  129. data/app/models/concerns/blacklight/document/semantic_fields.rb +1 -0
  130. data/app/models/concerns/blacklight/document/sms.rb +1 -0
  131. data/app/models/concerns/blacklight/document.rb +12 -20
  132. data/app/models/concerns/blacklight/suggest/response.rb +1 -0
  133. data/app/models/concerns/blacklight/user.rb +17 -8
  134. data/app/models/record_mailer.rb +13 -12
  135. data/app/models/search.rb +0 -1
  136. data/app/models/solr_document.rb +1 -0
  137. data/app/presenters/blacklight/clause_presenter.rb +1 -1
  138. data/app/presenters/blacklight/document_presenter.rb +13 -21
  139. data/app/presenters/blacklight/facet_field_presenter.rb +39 -14
  140. data/app/presenters/blacklight/facet_grouped_item_presenter.rb +1 -5
  141. data/app/presenters/blacklight/facet_item_pivot_presenter.rb +60 -0
  142. data/app/presenters/blacklight/facet_item_presenter.rb +3 -9
  143. data/app/presenters/blacklight/field_presenter.rb +1 -0
  144. data/app/presenters/blacklight/index_presenter.rb +2 -40
  145. data/app/presenters/blacklight/json_presenter.rb +7 -5
  146. data/app/presenters/blacklight/rendering/join.rb +1 -1
  147. data/app/presenters/blacklight/rendering/link_to_facet.rb +2 -5
  148. data/app/presenters/blacklight/show_presenter.rb +1 -9
  149. data/app/presenters/blacklight/thumbnail_presenter.rb +1 -1
  150. data/app/services/blacklight/bookmarks_search_builder.rb +22 -0
  151. data/app/services/blacklight/field_retriever.rb +1 -8
  152. data/app/services/blacklight/search_service.rb +8 -7
  153. data/app/values/blacklight/types.rb +95 -11
  154. data/app/views/bookmarks/_clear_bookmarks_widget.html.erb +8 -1
  155. data/app/views/bookmarks/_tools.html.erb +7 -12
  156. data/app/views/catalog/_advanced_search_form.html.erb +0 -1
  157. data/app/views/catalog/_bookmark_control.html.erb +1 -1
  158. data/app/views/catalog/_constraints.html.erb +1 -14
  159. data/app/views/catalog/_document.atom.builder +12 -14
  160. data/app/views/catalog/_document.html.erb +5 -3
  161. data/app/views/catalog/_document.rss.builder +2 -4
  162. data/app/views/catalog/_facet_layout.html.erb +2 -2
  163. data/app/views/catalog/_facets.html.erb +5 -4
  164. data/app/views/catalog/_home_text.html.erb +2 -14
  165. data/app/views/catalog/_search_form.html.erb +3 -3
  166. data/app/views/catalog/_search_header.html.erb +1 -2
  167. data/app/views/catalog/_search_results.html.erb +2 -2
  168. data/app/views/catalog/_search_sidebar.html.erb +5 -1
  169. data/app/views/catalog/_show_main_content.html.erb +11 -16
  170. data/app/views/catalog/_show_sidebar.html.erb +2 -2
  171. data/app/views/catalog/_show_tools.html.erb +7 -12
  172. data/app/views/catalog/_view_type_group.html.erb +1 -1
  173. data/app/views/catalog/email_success.html.erb +5 -6
  174. data/app/views/catalog/facet.html.erb +7 -5
  175. data/app/views/catalog/index.atom.builder +12 -14
  176. data/app/views/catalog/index.html.erb +4 -1
  177. data/app/views/catalog/index.json.jbuilder +19 -19
  178. data/app/views/catalog/index.rss.builder +1 -1
  179. data/app/views/catalog/opensearch.xml.builder +1 -1
  180. data/app/views/catalog/sms_success.html.erb +5 -6
  181. data/app/views/catalog/suggest.html.erb +3 -0
  182. data/app/views/layouts/blacklight/base.html.erb +20 -9
  183. data/app/views/search_history/index.html.erb +6 -2
  184. data/app/views/shared/_header_navbar.html.erb +1 -22
  185. data/app/views/shared/_modal.html.erb +3 -3
  186. data/blacklight.gemspec +7 -9
  187. data/config/importmap.rb +3 -0
  188. data/config/locales/blacklight.ar.yml +0 -1
  189. data/config/locales/blacklight.ca.yml +0 -1
  190. data/config/locales/blacklight.de.yml +0 -1
  191. data/config/locales/blacklight.en.yml +0 -1
  192. data/config/locales/blacklight.es.yml +0 -1
  193. data/config/locales/blacklight.fr.yml +0 -1
  194. data/config/locales/blacklight.hu.yml +0 -1
  195. data/config/locales/blacklight.it.yml +0 -1
  196. data/config/locales/blacklight.nl.yml +0 -1
  197. data/config/locales/blacklight.pt-BR.yml +0 -1
  198. data/config/locales/blacklight.sq.yml +0 -1
  199. data/config/locales/blacklight.zh.yml +0 -1
  200. data/config/routes.rb +3 -2
  201. data/db/migrate/20140202020201_create_searches.rb +1 -0
  202. data/db/migrate/20140202020202_create_bookmarks.rb +1 -0
  203. data/db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb +1 -0
  204. data/docker-compose.yml +1 -0
  205. data/lib/blacklight/abstract_repository.rb +1 -0
  206. data/lib/blacklight/configuration/context.rb +4 -4
  207. data/lib/blacklight/configuration/display_field.rb +7 -9
  208. data/lib/blacklight/configuration/facet_field.rb +17 -11
  209. data/lib/blacklight/configuration/field.rb +1 -0
  210. data/lib/blacklight/configuration/fields.rb +12 -15
  211. data/lib/blacklight/configuration/index_field.rb +1 -0
  212. data/lib/blacklight/configuration/null_display_field.rb +17 -0
  213. data/lib/blacklight/configuration/search_field.rb +1 -0
  214. data/lib/blacklight/configuration/show_field.rb +1 -0
  215. data/lib/blacklight/configuration/sort_field.rb +1 -0
  216. data/lib/blacklight/configuration/tool_config.rb +1 -0
  217. data/lib/blacklight/configuration/view_config.rb +16 -6
  218. data/lib/blacklight/configuration.rb +318 -341
  219. data/lib/blacklight/engine.rb +10 -11
  220. data/lib/blacklight/exceptions.rb +2 -2
  221. data/lib/blacklight/nested_open_struct_with_hash_access.rb +6 -12
  222. data/lib/blacklight/open_struct_with_hash_access.rb +19 -17
  223. data/lib/blacklight/parameters.rb +7 -21
  224. data/lib/blacklight/routes/exportable.rb +1 -0
  225. data/lib/blacklight/routes/searchable.rb +2 -1
  226. data/lib/blacklight/routes.rb +1 -0
  227. data/lib/blacklight/search_builder.rb +10 -10
  228. data/lib/blacklight/search_state/filter_field.rb +8 -25
  229. data/lib/blacklight/search_state/pivot_filter_field.rb +144 -0
  230. data/lib/blacklight/search_state.rb +23 -79
  231. data/lib/blacklight/solr/document.rb +1 -0
  232. data/lib/blacklight/solr/facet_paginator.rb +1 -0
  233. data/lib/blacklight/solr/repository.rb +1 -0
  234. data/lib/blacklight/solr/request.rb +3 -0
  235. data/lib/blacklight/solr/response/facets.rb +21 -5
  236. data/lib/blacklight/solr/response/group.rb +1 -0
  237. data/lib/blacklight/solr/response/group_response.rb +1 -0
  238. data/lib/blacklight/solr/response/more_like_this.rb +1 -0
  239. data/lib/blacklight/solr/response/pagination_methods.rb +4 -3
  240. data/lib/blacklight/solr/response/params.rb +5 -4
  241. data/lib/blacklight/solr/response/response.rb +1 -0
  242. data/lib/blacklight/solr/response/spelling.rb +1 -0
  243. data/lib/blacklight/solr/response.rb +4 -3
  244. data/lib/blacklight/solr/search_builder_behavior.rb +16 -32
  245. data/lib/blacklight/solr.rb +1 -0
  246. data/lib/blacklight/version.rb +1 -0
  247. data/lib/blacklight.rb +8 -11
  248. data/lib/generators/blacklight/assets/importmap_generator.rb +55 -0
  249. data/lib/generators/blacklight/assets/propshaft_generator.rb +25 -0
  250. data/lib/generators/blacklight/assets/sprockets_generator.rb +66 -0
  251. data/lib/generators/blacklight/assets_generator.rb +13 -89
  252. data/lib/generators/blacklight/controller_generator.rb +3 -2
  253. data/lib/generators/blacklight/document_generator.rb +1 -0
  254. data/lib/generators/blacklight/install_generator.rb +5 -4
  255. data/lib/generators/blacklight/models_generator.rb +1 -0
  256. data/lib/generators/blacklight/search_builder_generator.rb +1 -0
  257. data/lib/generators/blacklight/solr_generator.rb +1 -1
  258. data/lib/generators/blacklight/templates/catalog_controller.rb +37 -7
  259. data/lib/generators/blacklight/templates/solr_document.rb +1 -1
  260. data/lib/generators/blacklight/test_support_generator.rb +4 -2
  261. data/lib/generators/blacklight/user_generator.rb +7 -9
  262. data/lib/railties/blacklight.rake +2 -3
  263. data/package.json +9 -12
  264. data/rollup.config.js +27 -0
  265. data/spec/components/blacklight/constraints_component_spec.rb +17 -13
  266. data/spec/components/blacklight/document_component_spec.rb +15 -25
  267. data/spec/components/blacklight/facet_component_spec.rb +2 -7
  268. data/spec/components/blacklight/facet_field_checkboxes_component_spec.rb +1 -2
  269. data/spec/components/blacklight/facet_field_list_component_spec.rb +7 -6
  270. data/spec/components/blacklight/facet_item_pivot_component_spec.rb +9 -7
  271. data/spec/components/blacklight/response/view_type_component_spec.rb +66 -0
  272. data/spec/components/blacklight/search_bar_component_spec.rb +1 -1
  273. data/spec/components/blacklight/search_context_component_spec.rb +40 -0
  274. data/spec/controllers/blacklight/catalog/component_configuration_spec.rb +1 -6
  275. data/spec/controllers/blacklight/{base_spec.rb → catalog_spec.rb} +2 -2
  276. data/spec/controllers/bookmarks_controller_spec.rb +2 -3
  277. data/spec/controllers/catalog_controller_spec.rb +13 -127
  278. data/spec/features/autocomplete_spec.rb +1 -1
  279. data/spec/features/axe_spec.rb +1 -1
  280. data/spec/features/bookmarks_spec.rb +1 -1
  281. data/spec/features/facets_spec.rb +1 -1
  282. data/spec/features/search_context_spec.rb +4 -10
  283. data/spec/features/search_results_spec.rb +0 -33
  284. data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb +2 -138
  285. data/spec/helpers/blacklight/facets_helper_behavior_spec.rb +0 -387
  286. data/spec/helpers/blacklight/icon_helper_behavior_spec.rb +8 -0
  287. data/spec/helpers/blacklight/render_partials_helper_behavior_spec.rb +5 -7
  288. data/spec/helpers/blacklight/url_helper_behavior_spec.rb +9 -131
  289. data/spec/helpers/blacklight_helper_spec.rb +3 -242
  290. data/spec/helpers/catalog_helper_spec.rb +7 -118
  291. data/spec/i18n_spec.rb +1 -0
  292. data/spec/integration/generators/blacklight/solr_generator_spec.rb +1 -1
  293. data/spec/lib/blacklight/configuration/facet_field_spec.rb +27 -16
  294. data/spec/lib/blacklight/configuration/field_spec.rb +1 -1
  295. data/spec/lib/blacklight/configuration/view_config_spec.rb +1 -1
  296. data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb +2 -2
  297. data/spec/lib/blacklight/parameters_spec.rb +1 -4
  298. data/spec/lib/blacklight/search_state/filter_field_spec.rb +4 -4
  299. data/spec/lib/blacklight/search_state/pivot_filter_field_spec.rb +117 -0
  300. data/spec/lib/blacklight/search_state_spec.rb +80 -198
  301. data/spec/lib/tasks/blacklight_task_spec.rb +1 -0
  302. data/spec/models/blacklight/configuration_spec.rb +39 -51
  303. data/spec/models/blacklight/document/active_model_shim_spec.rb +2 -2
  304. data/spec/models/blacklight/icon_spec.rb +31 -15
  305. data/spec/models/blacklight/search_builder_spec.rb +9 -9
  306. data/spec/models/blacklight/solr/document_spec.rb +3 -3
  307. data/spec/models/blacklight/solr/response/facets_spec.rb +27 -27
  308. data/spec/models/blacklight/solr/response/group_response_spec.rb +1 -0
  309. data/spec/models/blacklight/solr/response/group_spec.rb +1 -0
  310. data/spec/models/blacklight/solr/response_spec.rb +9 -2
  311. data/spec/models/blacklight/solr/search_builder_spec.rb +32 -23
  312. data/spec/models/blacklight/user_spec.rb +22 -0
  313. data/spec/models/solr_document_spec.rb +21 -3
  314. data/spec/presenters/blacklight/clause_presenter_spec.rb +1 -0
  315. data/spec/presenters/blacklight/document_presenter_spec.rb +2 -2
  316. data/spec/presenters/blacklight/facet_field_presenter_spec.rb +85 -12
  317. data/spec/presenters/blacklight/facet_grouped_item_presenter_spec.rb +1 -0
  318. data/spec/presenters/blacklight/facet_item_presenter_spec.rb +14 -13
  319. data/spec/presenters/blacklight/field_presenter_spec.rb +0 -14
  320. data/spec/presenters/blacklight/index_presenter_spec.rb +2 -4
  321. data/spec/presenters/blacklight/json_presenter_spec.rb +1 -0
  322. data/spec/presenters/blacklight/link_alternate_presenter_spec.rb +3 -2
  323. data/spec/presenters/blacklight/show_presenter_spec.rb +10 -25
  324. data/spec/presenters/thumbnail_presenter_spec.rb +1 -1
  325. data/spec/requests/load_suggestions_spec.rb +16 -0
  326. data/spec/routing/catalog_routing_spec.rb +2 -1
  327. data/spec/services/blacklight/search_service_spec.rb +31 -68
  328. data/spec/spec_helper.rb +3 -2
  329. data/spec/support/controller_level_helpers.rb +1 -2
  330. data/spec/support/features/search_helpers.rb +39 -0
  331. data/spec/support/features/session_helpers.rb +1 -0
  332. data/spec/support/features.rb +3 -0
  333. data/spec/test_app_templates/lib/generators/test_app_generator.rb +9 -2
  334. data/spec/views/catalog/_document.html.erb_spec.rb +3 -34
  335. data/spec/views/catalog/_facet_index_navigation.html.erb_spec.rb +1 -1
  336. data/spec/views/catalog/_search_header.erb_spec.rb +1 -0
  337. data/spec/views/catalog/_show_sidebar.erb_spec.rb +1 -0
  338. data/spec/views/catalog/_show_tools.html.erb_spec.rb +7 -54
  339. data/spec/views/catalog/_view_type_group.html.erb_spec.rb +17 -9
  340. data/spec/views/catalog/email_success.html.erb_spec.rb +2 -2
  341. data/spec/views/catalog/facet.html.erb_spec.rb +6 -3
  342. data/spec/views/catalog/index.atom.builder_spec.rb +18 -11
  343. data/spec/views/catalog/index.html.erb_spec.rb +5 -6
  344. data/spec/views/catalog/index.json.jbuilder_spec.rb +2 -2
  345. data/spec/views/catalog/show.html.erb_spec.rb +3 -25
  346. data/spec/views/catalog/sms_success.html.erb_spec.rb +2 -2
  347. data/tasks/blacklight.rake +6 -4
  348. metadata +73 -113
  349. data/.babelrc +0 -11
  350. data/app/assets/images/blacklight/list.svg +0 -1
  351. data/app/assets/images/blacklight/search.svg +0 -1
  352. data/app/assets/stylesheets/blacklight/_twitter_typeahead.scss +0 -37
  353. data/app/components/blacklight/content_areas_shim.rb +0 -13
  354. data/app/controllers/concerns/blacklight/base.rb +0 -7
  355. data/app/controllers/concerns/blacklight/default_component_configuration.rb +0 -64
  356. data/app/controllers/concerns/blacklight/facet.rb +0 -69
  357. data/app/controllers/concerns/blacklight/search_fields.rb +0 -46
  358. data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb +0 -27
  359. data/app/helpers/blacklight/render_constraints_helper_behavior.rb +0 -188
  360. data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb +0 -97
  361. data/app/helpers/blacklight/suggest_helper_behavior.rb +0 -13
  362. data/app/javascript/blacklight/autocomplete.js +0 -36
  363. data/app/javascript/blacklight/facet_load.js +0 -22
  364. data/app/presenters/blacklight/search_bar_presenter.rb +0 -47
  365. data/app/views/catalog/_constraints_element.html.erb +0 -14
  366. data/app/views/catalog/_document_action.html.erb +0 -5
  367. data/app/views/catalog/_facet_group.html.erb +0 -5
  368. data/app/views/catalog/_facet_limit.html.erb +0 -3
  369. data/app/views/catalog/_index.html.erb +0 -1
  370. data/app/views/catalog/_index_header.html.erb +0 -22
  371. data/app/views/catalog/_previous_next_doc.html.erb +0 -2
  372. data/app/views/catalog/_show.html.erb +0 -6
  373. data/app/views/catalog/_show_header.html.erb +0 -2
  374. data/app/views/catalog/_thumbnail.html.erb +0 -1
  375. data/lib/blacklight/deprecations/engine_configuration.rb +0 -66
  376. data/lib/blacklight/deprecations/search_state_normalization.rb +0 -52
  377. data/spec/controllers/blacklight/facet_spec.rb +0 -33
  378. data/spec/controllers/blacklight/search_fields_spec.rb +0 -62
  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 -108
  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/views/catalog/_constraints.html.erb_spec.rb +0 -33
  386. data/spec/views/catalog/_facet_group.html.erb_spec.rb +0 -84
  387. data/spec/views/catalog/_facets.html.erb_spec.rb +0 -15
  388. data/spec/views/catalog/_index.html.erb_spec.rb +0 -62
  389. data/spec/views/catalog/_index_header.html.erb_spec.rb +0 -35
  390. data/spec/views/catalog/_previous_next_doc.html.erb_spec.rb +0 -22
  391. data/spec/views/catalog/_show.html.erb_spec.rb +0 -62
  392. data/spec/views/catalog/_thumbnail.html.erb_spec.rb +0 -38
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Blacklight
4
- class SearchButtonComponent < ::ViewComponent::Base
4
+ class SearchButtonComponent < Blacklight::Component
5
5
  def initialize(text:, id:)
6
6
  @text = text
7
7
  @id = id
@@ -9,8 +9,8 @@ module Blacklight
9
9
 
10
10
  def call
11
11
  tag.button(class: 'btn btn-primary search-btn', type: 'submit', id: @id) do
12
- tag.span(@text, class: "submit-search-text") +
13
- blacklight_icon(:search, aria_hidden: true)
12
+ tag.span(@text, class: "visually-hidden-sm me-sm-1 submit-search-text") +
13
+ render(Blacklight::Icons::SearchComponent.new)
14
14
  end
15
15
  end
16
16
  end
@@ -13,22 +13,56 @@ module Blacklight
13
13
  @search_context.present? && (@search_context[:prev] || @search_context[:next])
14
14
  end
15
15
 
16
+ ##
17
+ # Displays "showing X of Y items" message.
18
+ #
19
+ # @return [String]
16
20
  def item_page_entry_info
17
- Deprecation.silence(Blacklight::CatalogHelperBehavior) do
18
- helpers.item_page_entry_info
19
- end
21
+ t('blacklight.search.entry_pagination_info.other', current: number_with_delimiter(count),
22
+ total: number_with_delimiter(total),
23
+ count: total).html_safe
20
24
  end
21
25
 
22
- def link_to_previous_document(document = nil, *args, **kwargs)
23
- Deprecation.silence(Blacklight::UrlHelperBehavior) do
24
- helpers.link_to_previous_document(document || @search_context[:prev], *args, **kwargs)
26
+ def link_to_previous_document(previous_document = nil, classes: 'previous', **link_opts)
27
+ previous_document ||= @search_context[:prev]
28
+ link_opts = session_tracking_params(previous_document, count - 1, per_page: per_page, search_id: search_id).merge(class: classes, rel: 'prev').merge(link_opts)
29
+ link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), link_opts do
30
+ tag.span raw(t('views.pagination.previous')), class: 'previous'
25
31
  end
26
32
  end
27
33
 
28
- def link_to_next_document(document = nil, *args, **kwargs)
29
- Deprecation.silence(Blacklight::UrlHelperBehavior) do
30
- helpers.link_to_next_document(document || @search_context[:next], *args, **kwargs)
34
+ def link_to_next_document(next_document = nil, classes: 'next', **link_opts)
35
+ next_document ||= @search_context[:next]
36
+ link_opts = session_tracking_params(next_document, count + 1, per_page: per_page, search_id: search_id).merge(class: classes, rel: 'next').merge(link_opts)
37
+ link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), link_opts do
38
+ tag.span raw(t('views.pagination.next')), class: 'next'
31
39
  end
32
40
  end
41
+
42
+ private
43
+
44
+ def count
45
+ @search_session['counter'].to_i
46
+ end
47
+
48
+ def per_page
49
+ @search_session['per_page']
50
+ end
51
+
52
+ def total
53
+ @search_session['total'].to_i
54
+ end
55
+
56
+ def search_id
57
+ controller.current_search_session&.id
58
+ end
59
+
60
+ def session_tracking_params(...)
61
+ helpers.session_tracking_params(...)
62
+ end
63
+
64
+ def url_for_document(...)
65
+ helpers.search_state.url_for_document(...)
66
+ end
33
67
  end
34
68
  end
@@ -0,0 +1,2 @@
1
+ <%= render 'did_you_mean' %>
2
+ <%= render 'sort_and_per_page' %>
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Blacklight
4
+ class SearchHeaderComponent < Blacklight::Component
5
+ end
6
+ end
@@ -0,0 +1,5 @@
1
+ <%= tag.div class: 'navbar-search navbar navbar-light bg-light', role: 'navigation', aria: { label: t('blacklight.search.header') } do %>
2
+ <div class="<%= container_classes %>">
3
+ <%= search_bar %>
4
+ </div>
5
+ <% end %>
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Blacklight
4
+ class SearchNavbarComponent < Blacklight::Component
5
+ def initialize(blacklight_config:)
6
+ @blacklight_config = blacklight_config
7
+ end
8
+
9
+ attr_reader :blacklight_config
10
+
11
+ delegate :container_classes, to: :helpers
12
+
13
+ def search_bar
14
+ render search_bar_component
15
+ end
16
+
17
+ def search_bar_component
18
+ search_bar_component_class.new(
19
+ url: helpers.search_action_url,
20
+ advanced_search_url: helpers.search_action_url(action: 'advanced_search'),
21
+ params: helpers.search_state.params_for_search.except(:qt),
22
+ autocomplete_path: suggest_index_catalog_path
23
+ )
24
+ end
25
+
26
+ def search_bar_component_class
27
+ view_config&.search_bar_component || Blacklight::SearchBarComponent
28
+ end
29
+
30
+ def view_config
31
+ blacklight_config&.view_config(helpers.document_index_view_type)
32
+ end
33
+ end
34
+ end
@@ -12,9 +12,11 @@ module Blacklight
12
12
  # Get the path to the search action with any parameters (e.g. view type)
13
13
  # that should be persisted across search sessions.
14
14
  def start_over_path query_params = params
15
- Deprecation.silence(Blacklight::UrlHelperBehavior) do
16
- helpers.start_over_path(query_params)
17
- end
15
+ h = {}
16
+ current_index_view_type = helpers.document_index_view_type(query_params)
17
+ h[:view] = current_index_view_type unless current_index_view_type == helpers.default_document_index_view_type
18
+
19
+ helpers.search_action_path(h)
18
20
  end
19
21
  end
20
22
  end
@@ -29,11 +29,11 @@ module Blacklight
29
29
  end
30
30
 
31
31
  def before_render
32
- button(classes: 'btn btn-outline-secondary dropdown-toggle', label: button_label) unless button
32
+ with_button(classes: 'btn btn-outline-secondary dropdown-toggle', label: button_label) unless button
33
33
 
34
34
  return if options.any?
35
35
 
36
- options(@choices.map do |option|
36
+ with_options(@choices.map do |option|
37
37
  text, value = option_text_and_value(option)
38
38
  { text: text, url: helpers.url_for(@search_state.params_for_search(@param => value)), selected: @selected == value }
39
39
  end)
@@ -1,4 +1,6 @@
1
1
  <div class="alert <%= @classes %>">
2
2
  <%= message %>
3
- <a class="btn-close close" data-dismiss="alert" data-bs-dismiss="alert" href="#">&times;</a>
3
+ <%= tag.button_tag button_contents, type: "button", class: "btn-close",
4
+ data: { dismiss: "alert", bs_dismiss: "alert" },
5
+ aria: { label: "Close" } %>
4
6
  </div>
@@ -7,13 +7,22 @@ module Blacklight
7
7
 
8
8
  with_collection_parameter :message
9
9
 
10
- def initialize(message: nil, type:)
10
+ def initialize(type:, message: nil)
11
11
  @message = message
12
12
  @classes = alert_class(type)
13
13
  end
14
14
 
15
15
  def before_render
16
- message { @message } if @message
16
+ with_message { @message } if @message
17
+ end
18
+
19
+ # Bootstrap 4 requires the span, but Bootstrap 5 should not have it.
20
+ # See https://getbootstrap.com/docs/4.6/components/alerts/#dismissing
21
+ # https://getbootstrap.com/docs/5.1/components/alerts/#dismissing
22
+ def button_contents
23
+ return if helpers.controller.blacklight_config.bootstrap_version == 5
24
+
25
+ tag.span '&times;'.html_safe, aria: { hidden: true }
17
26
  end
18
27
 
19
28
  def alert_class(type)
@@ -6,7 +6,7 @@
6
6
  <h1 class="modal-title"><%= title %></h1>
7
7
  <% end) %>
8
8
 
9
- <button type="button" class="blacklight-modal-close btn-close close" data-bs-dismiss="modal" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
9
+ <button type="button" class="blacklight-modal-close btn-close close" data-bl-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
10
10
  <span aria-hidden="true" class="visually-hidden">&times;</span>
11
11
  </button>
12
12
  </div>
@@ -3,8 +3,6 @@
3
3
  module Blacklight
4
4
  module System
5
5
  class ModalComponent < ViewComponent::Base
6
- include Blacklight::ContentAreasShim
7
-
8
6
  renders_one :prefix
9
7
  renders_one :header
10
8
  renders_one :title
@@ -0,0 +1,12 @@
1
+ <nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation">
2
+ <div class="<%= container_classes %>">
3
+ <%= link_to application_name, blacklight_config.logo_link, class: 'mb-0 navbar-brand navbar-logo' %>
4
+ <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-bs-toggle="collapse" data-target="#user-util-collapse" data-bs-target="#user-util-collapse" aria-controls="user-util-collapse" aria-expanded="false" aria-label="Toggle navigation">
5
+ <span class="navbar-toggler-icon"></span>
6
+ </button>
7
+
8
+ <div class="collapse navbar-collapse justify-content-md-end" id="user-util-collapse">
9
+ <%= render 'shared/user_util_links' %>
10
+ </div>
11
+ </div>
12
+ </nav>
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Blacklight
4
+ class TopNavbarComponent < Blacklight::Component
5
+ def initialize(blacklight_config:)
6
+ @blacklight_config = blacklight_config
7
+ end
8
+
9
+ attr_reader :blacklight_config
10
+
11
+ delegate :application_name, :container_classes, to: :helpers
12
+ end
13
+ end
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  class BookmarksController < CatalogController
3
4
  include Blacklight::Bookmarks
4
5
  end
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  class CatalogController < ApplicationController
3
4
  include Blacklight::Catalog
4
5
  end
@@ -1,5 +1,6 @@
1
1
  # frozen_string_literal: true
2
- # note that while this is mostly restful routing, the #update and #destroy actions
2
+
3
+ # NOTE: that while this is mostly restful routing, the #update and #destroy actions
3
4
  # take the Solr document ID as the :id, NOT the id of the actual Bookmark action.
4
5
  module Blacklight::Bookmarks
5
6
  extend ActiveSupport::Concern
@@ -20,6 +21,7 @@ module Blacklight::Bookmarks
20
21
 
21
22
  blacklight_config.show.document_actions[:bookmark].if = false if blacklight_config.show.document_actions[:bookmark]
22
23
  blacklight_config.show.document_actions[:sms].if = false if blacklight_config.show.document_actions[:sms]
24
+ blacklight_config.search_builder_class = Blacklight::BookmarksSearchBuilder
23
25
  end
24
26
 
25
27
  def action_documents
@@ -38,11 +40,14 @@ module Blacklight::Bookmarks
38
40
  search_catalog_url(*args)
39
41
  end
40
42
 
43
+ # @return [Hash] a hash of context information to pass through to the search service
44
+ def search_service_context
45
+ { bookmarks: @bookmarks }
46
+ end
47
+
41
48
  def index
42
49
  @bookmarks = token_or_current_or_guest_user.bookmarks
43
- bookmark_ids = @bookmarks.collect { |b| b.document_id.to_s }
44
- @response, deprecated_document_list = search_service.fetch(bookmark_ids)
45
- @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document_list, "The @document_list instance variable is now deprecated and will be removed in Blacklight 8.0")
50
+ @response = search_service.search_results
46
51
 
47
52
  respond_to do |format|
48
53
  format.html {}
@@ -115,7 +120,7 @@ module Blacklight::Bookmarks
115
120
  redirect_back fallback_location: bookmarks_path, notice: I18n.t('blacklight.bookmarks.remove.success')
116
121
  end
117
122
  elsif request.xhr?
118
- head 500 # ajaxy request needs no redirect and should not have flash set
123
+ head :internal_server_error # ajaxy request needs no redirect and should not have flash set
119
124
  else
120
125
  redirect_back fallback_location: bookmarks_path, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
121
126
  end
@@ -1,37 +1,29 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Blacklight::Catalog
3
4
  extend ActiveSupport::Concern
4
5
 
5
6
  # MimeResponds is part of ActionController::Base, but not ActionController::API
6
7
  include ActionController::MimeResponds
7
8
 
8
- include Blacklight::Base
9
- include Blacklight::Facet
9
+ include Blacklight::Configurable
10
+ include Blacklight::SearchContext
10
11
  include Blacklight::Searchable
11
12
 
12
- extend Deprecation
13
-
14
13
  # The following code is executed when someone includes blacklight::catalog in their
15
14
  # own controller.
16
15
  included do
17
16
  if respond_to? :helper_method
18
- helper_method :sms_mappings, :has_search_parameters?, :facet_limit_for
17
+ helper_method :sms_mappings, :has_search_parameters?
18
+ helper_method :search_facet_path
19
19
  end
20
20
 
21
- helper Blacklight::Facet if respond_to? :helper
22
-
23
- # The index action will more than likely throw this one.
24
- # Example: when the standard query parser is used, and a user submits a "bad" query.
25
- rescue_from Blacklight::Exceptions::InvalidRequest, with: :handle_request_error
26
-
27
21
  record_search_parameters
28
22
  end
29
23
 
30
24
  # get search results from the solr index
31
25
  def index
32
- (@response, deprecated_document_list) = search_service.search_results
33
-
34
- @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document_list, 'The @document_list instance variable is deprecated; use @response.documents instead.')
26
+ @response = search_service.search_results
35
27
 
36
28
  respond_to do |format|
37
29
  format.html { store_preferred_view }
@@ -49,8 +41,7 @@ module Blacklight::Catalog
49
41
  # get a single document from the index
50
42
  # to add responses for formats other than html or json see _Blacklight::Document::Export_
51
43
  def show
52
- deprecated_response, @document = search_service.fetch(params[:id])
53
- @response = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_response, 'The @response instance variable is deprecated; use @document.response instead.')
44
+ @document = search_service.fetch(params[:id])
54
45
 
55
46
  respond_to do |format|
56
47
  format.html { @search_context = setup_next_and_previous_documents }
@@ -67,7 +58,7 @@ module Blacklight::Catalog
67
58
  def raw
68
59
  raise(ActionController::RoutingError, 'Not Found') unless blacklight_config.raw_endpoint.enabled
69
60
 
70
- _, @document = search_service.fetch(params[:id])
61
+ @document = search_service.fetch(params[:id])
71
62
  render json: @document
72
63
  end
73
64
 
@@ -95,7 +86,7 @@ module Blacklight::Catalog
95
86
  @response = search_service.facet_field_response(@facet.key)
96
87
  @display_facet = @response.aggregations[@facet.field]
97
88
 
98
- @presenter = (@facet.presenter || Blacklight::FacetFieldPresenter).new(@facet, @display_facet, view_context)
89
+ @presenter = @facet.presenter.new(@facet, @display_facet, view_context)
99
90
  @pagination = @presenter.paginator
100
91
  respond_to do |format|
101
92
  format.html do
@@ -115,21 +106,19 @@ module Blacklight::Catalog
115
106
  end
116
107
  end
117
108
 
109
+ # Returns the dropdown list for autocomplete
118
110
  def suggest
119
- respond_to do |format|
120
- format.json do
121
- render json: suggestions_service.suggestions
122
- end
123
- end
111
+ @suggestions = suggestions_service.suggestions
112
+ render 'suggest', layout: false
124
113
  end
125
114
 
126
115
  # @return [Array] first value is a Blacklight::Solr::Response and the second
127
116
  # is a list of documents
128
117
  def action_documents
129
- deprecated_response, @documents = search_service.fetch(Array(params[:id]))
118
+ @documents = search_service.fetch(Array(params[:id]))
130
119
  raise Blacklight::Exceptions::RecordNotFound if @documents.blank?
131
120
 
132
- [deprecated_response, @documents]
121
+ @documents
133
122
  end
134
123
 
135
124
  def action_success_redirect_path
@@ -143,34 +132,14 @@ module Blacklight::Catalog
143
132
  params[:search_field].present? || search_state.has_constraints?
144
133
  end
145
134
 
146
- # TODO: deprecate this constant with #facet_limit_for
147
- DEFAULT_FACET_LIMIT = 10
148
-
149
- # Look up facet limit for given facet_field. Will look at config, and
150
- # if config is 'true' will look up from Solr @response if available. If
151
- # no limit is available, returns nil. Used from #add_facetting_to_solr
152
- # to supply f.fieldname.facet.limit values in solr request (no @response
153
- # available), and used in display (with @response available) to create
154
- # a facet paginator with the right limit.
155
- def facet_limit_for(facet_field)
156
- facet = blacklight_config.facet_fields[facet_field]
157
- return if facet.blank?
158
-
159
- if facet.limit && @response && @response.aggregations[facet.field]
160
- limit = @response.aggregations[facet.field].limit
161
-
162
- if limit.nil? # we didn't get or a set a limit, so infer one.
163
- facet.limit if facet.limit != true
164
- elsif limit == -1 # limit -1 is solr-speak for unlimited
165
- nil
166
- else
167
- limit.to_i - 1 # we added 1 to find out if we needed to paginate
168
- end
169
- elsif facet.limit
170
- facet.limit == true ? DEFAULT_FACET_LIMIT : facet.limit
171
- end
135
+ def search_facet_path(options = {})
136
+ opts = search_state
137
+ .to_h
138
+ .merge(action: "facet", only_path: true)
139
+ .merge(options)
140
+ .except(:page)
141
+ url_for opts
172
142
  end
173
- deprecation_deprecate facet_limit_for: 'moving to private logic in Blacklight::FacetFieldPresenter'
174
143
 
175
144
  private
176
145
 
@@ -314,26 +283,6 @@ module Blacklight::Catalog
314
283
  action_name == 'show' ? 'catalog_result' : super
315
284
  end
316
285
 
317
- # when a method throws a Blacklight::Exceptions::InvalidRequest, this method is executed.
318
- def handle_request_error(exception)
319
- # Rails own code will catch and give usual Rails error page with stack trace
320
- raise exception if Rails.env.development? || Rails.env.test?
321
-
322
- flash_notice = I18n.t('blacklight.search.errors.request_error')
323
-
324
- # If there are errors coming from the index page, we want to trap those sensibly
325
-
326
- if flash[:notice] == flash_notice
327
- logger&.error "Cowardly aborting rsolr_request_error exception handling, because we redirected to a page that raises another exception"
328
- raise exception
329
- end
330
-
331
- logger&.error exception
332
-
333
- flash[:notice] = flash_notice
334
- redirect_to search_action_url
335
- end
336
-
337
286
  def blacklight_advanced_search_form_search_service
338
287
  form_search_state = search_state_class.new(blacklight_advanced_search_form_params, blacklight_config, self)
339
288
 
@@ -1,14 +1,11 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  # Filters added to this controller apply to all controllers in the hosting application
3
4
  # as this module is mixed-in to the application controller in the hosting app on installation.
4
5
  module Blacklight::Controller
5
6
  extend ActiveSupport::Concern
6
- extend Deprecation
7
7
 
8
8
  included do
9
- include Blacklight::SearchFields
10
- helper Blacklight::SearchFields if respond_to? :helper
11
-
12
9
  include ActiveSupport::Callbacks
13
10
 
14
11
  # now in application.rb file under config.filter_parameters
@@ -16,6 +13,7 @@ module Blacklight::Controller
16
13
 
17
14
  # handle basic authorization exception with #access_denied
18
15
  rescue_from Blacklight::Exceptions::AccessDenied, with: :access_denied
16
+ helper BlacklightHelper
19
17
 
20
18
  if respond_to? :helper_method
21
19
  helper_method :current_user_session, :current_user, :current_or_guest_user
@@ -24,8 +22,7 @@ module Blacklight::Controller
24
22
  helper_method :has_user_authentication_provider?
25
23
  helper_method :blacklight_config, :blacklight_configuration_context # move to Catalog
26
24
  helper_method :search_action_url, :search_action_path
27
- helper_method :search_facet_path # move to catalog? deprecate?
28
- helper_method :search_state # move to catalog?
25
+ helper_method :search_state
29
26
  end
30
27
 
31
28
  # Which class to use for the search state. You can subclass SearchState if you
@@ -33,12 +30,6 @@ module Blacklight::Controller
33
30
  # TODO: move to Searchable
34
31
  class_attribute :search_state_class
35
32
  self.search_state_class = Blacklight::SearchState
36
-
37
- # Which class to use for the search service. You can subclass SearchService if you
38
- # want to override any of the methods (e.g. SearchService#fetch)
39
- # TODO: move to Searchable
40
- class_attribute :search_service_class
41
- self.search_service_class = Blacklight::SearchService
42
33
  end
43
34
 
44
35
  # @private
@@ -64,8 +55,9 @@ module Blacklight::Controller
64
55
  has_user_authentication_provider? && current_or_guest_user.present?
65
56
  end
66
57
 
58
+ # This must be on every controller that uses the layout, because it is used in
59
+ # the header to draw Blacklight::SearchNavbarComponent (via the shared/header_navbar template)
67
60
  # @return [Blacklight::SearchState] a memoized instance of the parameter state.
68
- # TODO: move to catalog?
69
61
  def search_state
70
62
  @search_state ||= search_state_class.new(params, blacklight_config, self)
71
63
  end
@@ -75,7 +67,7 @@ module Blacklight::Controller
75
67
  # which action the search form should use
76
68
  def search_action_url options = {}
77
69
  # Rails 4.2 deprecated url helpers accepting string keys for 'controller' or 'action'
78
- search_catalog_url(options.except(:controller, :action))
70
+ search_catalog_url(options.to_h.except(:controller, :action))
79
71
  end
80
72
 
81
73
  def search_action_path *args
@@ -86,22 +78,6 @@ module Blacklight::Controller
86
78
  search_action_url(*args)
87
79
  end
88
80
 
89
- # TODO: move to catalog? deprecate?
90
- def search_facet_path(options = {})
91
- opts = search_state
92
- .to_h
93
- .merge(action: "facet", only_path: true)
94
- .merge(options)
95
- .except(:page)
96
- url_for opts
97
- end
98
-
99
- # Returns a list of Searches from the ids in the user's history.
100
- # TODO: move to catalog? SearchHistory?
101
- def searches_from_history
102
- session[:history].blank? ? ::Search.none : ::Search.where(id: session[:history]).order("updated_at desc")
103
- end
104
-
105
81
  # Should be provided by authentication provider
106
82
  # def current_user
107
83
  # end
@@ -125,21 +101,9 @@ module Blacklight::Controller
125
101
  respond_to? :current_user
126
102
  end
127
103
 
128
- def require_user_authentication_provider
129
- raise ActionController::RoutingError, 'Not Found' unless has_user_authentication_provider?
130
- end
131
- deprecation_deprecate require_user_authentication_provider: 'removed without replacement'
132
-
133
104
  ##
134
105
  # When a user logs in, transfer any saved searches or bookmarks to the current_user
135
106
  def transfer_guest_to_user
136
- Deprecation.silence(Blacklight::Controller) do
137
- transfer_guest_user_actions_to_current_user
138
- end
139
- end
140
-
141
- # @deprecated use canonical `transfer_guest_to_user` method instead
142
- def transfer_guest_user_actions_to_current_user
143
107
  return unless respond_to?(:current_user) && respond_to?(:guest_user) && current_user && guest_user
144
108
 
145
109
  current_user_searches = current_user.searches.pluck(:query_params)
@@ -158,7 +122,6 @@ module Blacklight::Controller
158
122
  # let guest_user know we've moved some bookmarks from under it
159
123
  guest_user.reload if guest_user.persisted?
160
124
  end
161
- deprecation_deprecate :transfer_guest_user_actions_to_current_user
162
125
 
163
126
  ##
164
127
  # To handle failed authorization attempts, redirect the user to the
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Blacklight::SearchContext
3
4
  extend ActiveSupport::Concern
4
5
 
@@ -17,6 +18,16 @@ module Blacklight::SearchContext
17
18
  end
18
19
  end
19
20
 
21
+ # The current search session
22
+ def current_search_session
23
+ @current_search_session ||= find_search_session
24
+ end
25
+
26
+ # Returns a list of Searches from the ids in the user's history.
27
+ def searches_from_history
28
+ session[:history].blank? ? ::Search.none : ::Search.where(id: session[:history]).order("updated_at desc")
29
+ end
30
+
20
31
  private
21
32
 
22
33
  # sets up the session[:search] hash if it doesn't already exist
@@ -27,11 +38,6 @@ module Blacklight::SearchContext
27
38
  session[:search]
28
39
  end
29
40
 
30
- # The current search session
31
- def current_search_session
32
- @current_search_session ||= find_search_session
33
- end
34
-
35
41
  # Persist the current search session id to the user's session
36
42
  def set_current_search_session
37
43
  search_session['id'] = current_search_session.id if current_search_session
@@ -79,7 +85,7 @@ module Blacklight::SearchContext
79
85
  end
80
86
 
81
87
  def find_or_initialize_search_session_from_params params
82
- params_copy = params.reject { |k, v| blacklisted_search_session_params.include?(k.to_sym) || v.blank? }
88
+ params_copy = params.reject { |k, v| nonpersisted_search_session_params.include?(k.to_sym) || v.blank? }
83
89
 
84
90
  return if params_copy.reject { |k, _v| [:action, :controller].include? k.to_sym }.blank?
85
91
 
@@ -102,10 +108,22 @@ module Blacklight::SearchContext
102
108
  end
103
109
 
104
110
  # A list of query parameters that should not be persisted for a search
105
- def blacklisted_search_session_params
111
+ def nonpersisted_search_session_params
112
+ unless method(:blacklisted_search_session_params).source_location.first.end_with?('deprecation/method_wrappers.rb')
113
+ # The blacklisted_search_session_params was overridden, so call it.
114
+ Blacklight.deprecation.warn(self, "blacklisted_search_session_params was overriden in your app, " \
115
+ "but that method should be renamed to `nonpersisted_search_session_params'. " \
116
+ "The original behavior will be removed in the next major release.")
117
+ return blacklisted_search_session_params
118
+ end
106
119
  [:commit, :counter, :total, :search_id, :page, :per_page]
107
120
  end
108
121
 
122
+ def blacklisted_search_session_params
123
+ nonpersisted_search_session_params
124
+ end
125
+ Blacklight.deprecation.deprecate_methods(self, blacklisted_search_session_params: 'use nonpersisted_search_session_params instead')
126
+
109
127
  # calls setup_previous_document then setup_next_document.
110
128
  # used in the show action for single view pagination.
111
129
  def setup_next_and_previous_documents