blacklight 7.32.0 → 8.0.0.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (390) hide show
  1. checksums.yaml +4 -4
  2. data/.env +2 -2
  3. data/.github/workflows/ruby.yml +32 -107
  4. data/.rubocop.yml +243 -2
  5. data/.rubocop_todo.yml +214 -270
  6. data/Gemfile +7 -6
  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 +351 -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/_controls.scss +5 -12
  18. data/app/assets/stylesheets/blacklight/_facets.scss +96 -44
  19. data/app/assets/stylesheets/blacklight/_header.scss +0 -15
  20. data/app/assets/stylesheets/blacklight/_icons.scss +0 -14
  21. data/app/assets/stylesheets/blacklight/_mixins.scss +20 -0
  22. data/app/assets/stylesheets/blacklight/_modal.scss +8 -2
  23. data/app/assets/stylesheets/blacklight/_search_form.scss +30 -3
  24. data/app/assets/stylesheets/blacklight/_search_history.scss +10 -1
  25. data/app/assets/stylesheets/blacklight/_search_results.scss +6 -2
  26. data/app/assets/stylesheets/blacklight/blacklight_defaults.scss +4 -1
  27. data/app/builders/blacklight/action_builder.rb +18 -9
  28. data/app/components/blacklight/advanced_search_form_component.html.erb +1 -1
  29. data/app/components/blacklight/advanced_search_form_component.rb +4 -6
  30. data/app/components/blacklight/constraints_component.rb +27 -37
  31. data/app/components/blacklight/document/action_component.html.erb +2 -9
  32. data/app/components/blacklight/document/action_component.rb +26 -8
  33. data/app/components/blacklight/document/actions_component.rb +1 -1
  34. data/app/components/blacklight/document/bookmark_component.html.erb +9 -0
  35. data/app/components/blacklight/document/bookmark_component.rb +4 -2
  36. data/app/components/blacklight/document/citation_component.rb +5 -3
  37. data/app/components/blacklight/document/group_component.rb +7 -3
  38. data/app/components/blacklight/document/sidebar_component.html.erb +2 -0
  39. data/app/components/blacklight/document/sidebar_component.rb +16 -0
  40. data/app/components/blacklight/document/thumbnail_component.html.erb +2 -7
  41. data/app/components/blacklight/document/thumbnail_component.rb +1 -9
  42. data/app/components/blacklight/document_component.html.erb +4 -0
  43. data/app/components/blacklight/document_component.rb +7 -23
  44. data/app/components/blacklight/document_metadata_component.rb +5 -6
  45. data/app/components/blacklight/document_title_component.rb +4 -1
  46. data/app/components/blacklight/facet_component.rb +1 -1
  47. data/app/components/blacklight/facet_field_checkboxes_component.html.erb +1 -1
  48. data/app/components/blacklight/facet_field_checkboxes_component.rb +1 -1
  49. data/app/components/blacklight/facet_field_component.html.erb +5 -5
  50. data/app/components/blacklight/facet_field_component.rb +9 -2
  51. data/app/components/blacklight/facet_field_list_component.html.erb +1 -1
  52. data/app/components/blacklight/facet_field_list_component.rb +37 -5
  53. data/app/components/blacklight/facet_field_no_layout_component.rb +0 -2
  54. data/app/components/blacklight/facet_item_component.rb +1 -43
  55. data/app/components/blacklight/facet_item_pivot_component.rb +21 -23
  56. data/app/components/blacklight/header_component.html.erb +2 -0
  57. data/app/components/blacklight/header_component.rb +26 -0
  58. data/app/components/blacklight/hidden_search_state_component.rb +1 -2
  59. data/app/components/blacklight/icons/legacy_icon_component.rb +30 -0
  60. data/app/components/blacklight/icons/list_component.rb +16 -0
  61. data/app/components/blacklight/icons/search_component.rb +16 -0
  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 +2 -4
  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/flash_message_component.html.erb +3 -1
  82. data/app/components/blacklight/system/flash_message_component.rb +10 -1
  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 +12 -0
  86. data/app/components/blacklight/top_navbar_component.rb +13 -0
  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 +13 -10
  90. data/app/controllers/concerns/blacklight/catalog.rb +21 -72
  91. data/app/controllers/concerns/blacklight/controller.rb +6 -43
  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 +10 -308
  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 -30
  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/attributes.rb +50 -0
  122. data/app/models/concerns/blacklight/document/cache_key.rb +1 -0
  123. data/app/models/concerns/blacklight/document/dublin_core.rb +2 -1
  124. data/app/models/concerns/blacklight/document/email.rb +1 -0
  125. data/app/models/concerns/blacklight/document/export.rb +2 -1
  126. data/app/models/concerns/blacklight/document/extensions.rb +1 -0
  127. data/app/models/concerns/blacklight/document/schema_org.rb +1 -0
  128. data/app/models/concerns/blacklight/document/semantic_fields.rb +1 -0
  129. data/app/models/concerns/blacklight/document/sms.rb +1 -0
  130. data/app/models/concerns/blacklight/document.rb +12 -20
  131. data/app/models/concerns/blacklight/suggest/response.rb +1 -0
  132. data/app/models/concerns/blacklight/user.rb +17 -8
  133. data/app/models/record_mailer.rb +13 -12
  134. data/app/models/search.rb +0 -1
  135. data/app/models/solr_document.rb +1 -0
  136. data/app/presenters/blacklight/clause_presenter.rb +1 -1
  137. data/app/presenters/blacklight/document_presenter.rb +13 -21
  138. data/app/presenters/blacklight/facet_field_presenter.rb +39 -14
  139. data/app/presenters/blacklight/facet_grouped_item_presenter.rb +1 -5
  140. data/app/presenters/blacklight/facet_item_pivot_presenter.rb +60 -0
  141. data/app/presenters/blacklight/facet_item_presenter.rb +3 -9
  142. data/app/presenters/blacklight/field_presenter.rb +1 -0
  143. data/app/presenters/blacklight/index_presenter.rb +2 -40
  144. data/app/presenters/blacklight/json_presenter.rb +7 -5
  145. data/app/presenters/blacklight/rendering/join.rb +1 -1
  146. data/app/presenters/blacklight/rendering/link_to_facet.rb +2 -5
  147. data/app/presenters/blacklight/show_presenter.rb +1 -9
  148. data/app/presenters/blacklight/thumbnail_presenter.rb +1 -1
  149. data/app/services/blacklight/bookmarks_search_builder.rb +22 -0
  150. data/app/services/blacklight/field_retriever.rb +1 -8
  151. data/app/services/blacklight/search_service.rb +8 -7
  152. data/app/values/blacklight/types.rb +95 -11
  153. data/app/views/bookmarks/_clear_bookmarks_widget.html.erb +8 -1
  154. data/app/views/bookmarks/_tools.html.erb +7 -12
  155. data/app/views/catalog/_advanced_search_form.html.erb +0 -1
  156. data/app/views/catalog/_bookmark_control.html.erb +1 -1
  157. data/app/views/catalog/_constraints.html.erb +1 -14
  158. data/app/views/catalog/_document.atom.builder +12 -14
  159. data/app/views/catalog/_document.html.erb +5 -3
  160. data/app/views/catalog/_document.rss.builder +2 -4
  161. data/app/views/catalog/_facets.html.erb +5 -4
  162. data/app/views/catalog/_home_text.html.erb +2 -14
  163. data/app/views/catalog/_search_form.html.erb +3 -3
  164. data/app/views/catalog/_search_header.html.erb +1 -2
  165. data/app/views/catalog/_search_results.html.erb +2 -2
  166. data/app/views/catalog/_search_sidebar.html.erb +5 -1
  167. data/app/views/catalog/_show_main_content.html.erb +10 -15
  168. data/app/views/catalog/_show_sidebar.html.erb +2 -2
  169. data/app/views/catalog/_show_tools.html.erb +7 -12
  170. data/app/views/catalog/_view_type_group.html.erb +1 -1
  171. data/app/views/catalog/email_success.html.erb +5 -6
  172. data/app/views/catalog/facet.html.erb +4 -2
  173. data/app/views/catalog/index.atom.builder +12 -14
  174. data/app/views/catalog/index.html.erb +4 -1
  175. data/app/views/catalog/index.json.jbuilder +21 -19
  176. data/app/views/catalog/index.rss.builder +1 -1
  177. data/app/views/catalog/opensearch.xml.builder +1 -1
  178. data/app/views/catalog/show.json.jbuilder +2 -0
  179. data/app/views/catalog/sms_success.html.erb +5 -6
  180. data/app/views/catalog/suggest.html.erb +3 -0
  181. data/app/views/layouts/blacklight/base.html.erb +23 -9
  182. data/app/views/search_history/index.html.erb +6 -2
  183. data/app/views/shared/_header_navbar.html.erb +1 -22
  184. data/app/views/shared/_modal.html.erb +3 -3
  185. data/blacklight.gemspec +6 -8
  186. data/config/importmap.rb +3 -0
  187. data/config/locales/blacklight.ar.yml +0 -1
  188. data/config/locales/blacklight.ca.yml +0 -1
  189. data/config/locales/blacklight.de.yml +0 -1
  190. data/config/locales/blacklight.en.yml +0 -1
  191. data/config/locales/blacklight.es.yml +0 -1
  192. data/config/locales/blacklight.fr.yml +0 -1
  193. data/config/locales/blacklight.hu.yml +0 -1
  194. data/config/locales/blacklight.it.yml +0 -1
  195. data/config/locales/blacklight.nl.yml +0 -1
  196. data/config/locales/blacklight.pt-BR.yml +0 -1
  197. data/config/locales/blacklight.sq.yml +0 -1
  198. data/config/locales/blacklight.zh.yml +0 -1
  199. data/config/routes.rb +3 -2
  200. data/db/migrate/20140202020201_create_searches.rb +1 -0
  201. data/db/migrate/20140202020202_create_bookmarks.rb +1 -0
  202. data/db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb +1 -0
  203. data/lib/blacklight/abstract_repository.rb +1 -0
  204. data/lib/blacklight/configuration/context.rb +4 -4
  205. data/lib/blacklight/configuration/display_field.rb +7 -9
  206. data/lib/blacklight/configuration/facet_field.rb +17 -11
  207. data/lib/blacklight/configuration/field.rb +1 -0
  208. data/lib/blacklight/configuration/fields.rb +12 -15
  209. data/lib/blacklight/configuration/index_field.rb +1 -0
  210. data/lib/blacklight/configuration/null_display_field.rb +17 -0
  211. data/lib/blacklight/configuration/search_field.rb +1 -0
  212. data/lib/blacklight/configuration/show_field.rb +1 -0
  213. data/lib/blacklight/configuration/sort_field.rb +1 -0
  214. data/lib/blacklight/configuration/tool_config.rb +1 -0
  215. data/lib/blacklight/configuration/view_config.rb +16 -6
  216. data/lib/blacklight/configuration.rb +318 -341
  217. data/lib/blacklight/engine.rb +10 -11
  218. data/lib/blacklight/exceptions.rb +2 -2
  219. data/lib/blacklight/nested_open_struct_with_hash_access.rb +6 -12
  220. data/lib/blacklight/open_struct_with_hash_access.rb +19 -17
  221. data/lib/blacklight/parameters.rb +7 -21
  222. data/lib/blacklight/routes/exportable.rb +1 -0
  223. data/lib/blacklight/routes/searchable.rb +2 -1
  224. data/lib/blacklight/routes.rb +1 -0
  225. data/lib/blacklight/search_builder.rb +10 -10
  226. data/lib/blacklight/search_state/filter_field.rb +8 -25
  227. data/lib/blacklight/search_state/pivot_filter_field.rb +144 -0
  228. data/lib/blacklight/search_state.rb +23 -79
  229. data/lib/blacklight/solr/document.rb +1 -0
  230. data/lib/blacklight/solr/facet_paginator.rb +1 -0
  231. data/lib/blacklight/solr/repository.rb +1 -0
  232. data/lib/blacklight/solr/request.rb +3 -0
  233. data/lib/blacklight/solr/response/facets.rb +21 -5
  234. data/lib/blacklight/solr/response/group.rb +1 -0
  235. data/lib/blacklight/solr/response/group_response.rb +1 -0
  236. data/lib/blacklight/solr/response/more_like_this.rb +1 -0
  237. data/lib/blacklight/solr/response/pagination_methods.rb +4 -3
  238. data/lib/blacklight/solr/response/params.rb +5 -4
  239. data/lib/blacklight/solr/response/response.rb +1 -0
  240. data/lib/blacklight/solr/response/spelling.rb +1 -0
  241. data/lib/blacklight/solr/response.rb +4 -3
  242. data/lib/blacklight/solr/search_builder_behavior.rb +16 -32
  243. data/lib/blacklight/solr.rb +1 -0
  244. data/lib/blacklight/version.rb +1 -0
  245. data/lib/blacklight.rb +8 -11
  246. data/lib/generators/blacklight/assets/importmap_generator.rb +55 -0
  247. data/lib/generators/blacklight/assets/propshaft_generator.rb +25 -0
  248. data/lib/generators/blacklight/assets/sprockets_generator.rb +66 -0
  249. data/lib/generators/blacklight/assets_generator.rb +13 -89
  250. data/lib/generators/blacklight/controller_generator.rb +3 -2
  251. data/lib/generators/blacklight/document_generator.rb +1 -0
  252. data/lib/generators/blacklight/install_generator.rb +5 -4
  253. data/lib/generators/blacklight/models_generator.rb +1 -0
  254. data/lib/generators/blacklight/search_builder_generator.rb +1 -0
  255. data/lib/generators/blacklight/solr_generator.rb +1 -1
  256. data/lib/generators/blacklight/templates/catalog_controller.rb +37 -7
  257. data/lib/generators/blacklight/templates/solr_document.rb +1 -1
  258. data/lib/generators/blacklight/test_support_generator.rb +4 -2
  259. data/lib/generators/blacklight/user_generator.rb +7 -9
  260. data/lib/railties/blacklight.rake +2 -3
  261. data/package.json +9 -12
  262. data/rollup.config.js +27 -0
  263. data/spec/components/blacklight/constraints_component_spec.rb +17 -13
  264. data/spec/components/blacklight/document_component_spec.rb +12 -22
  265. data/spec/components/blacklight/facet_component_spec.rb +2 -7
  266. data/spec/components/blacklight/facet_field_checkboxes_component_spec.rb +1 -2
  267. data/spec/components/blacklight/facet_field_list_component_spec.rb +7 -6
  268. data/spec/components/blacklight/facet_item_pivot_component_spec.rb +9 -7
  269. data/spec/components/blacklight/response/view_type_component_spec.rb +66 -0
  270. data/spec/components/blacklight/search_context_component_spec.rb +40 -0
  271. data/spec/controllers/blacklight/catalog/component_configuration_spec.rb +1 -6
  272. data/spec/controllers/blacklight/{base_spec.rb → catalog_spec.rb} +2 -2
  273. data/spec/controllers/bookmarks_controller_spec.rb +2 -3
  274. data/spec/controllers/catalog_controller_spec.rb +15 -129
  275. data/spec/features/autocomplete_spec.rb +1 -1
  276. data/spec/features/axe_spec.rb +1 -1
  277. data/spec/features/bookmarks_spec.rb +9 -0
  278. data/spec/features/facets_spec.rb +1 -1
  279. data/spec/features/search_context_spec.rb +4 -10
  280. data/spec/features/search_results_spec.rb +0 -33
  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 +39 -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/response/facets_spec.rb +27 -27
  305. data/spec/models/blacklight/solr/response/group_response_spec.rb +1 -0
  306. data/spec/models/blacklight/solr/response/group_spec.rb +1 -0
  307. data/spec/models/blacklight/solr/response_spec.rb +9 -2
  308. data/spec/models/blacklight/solr/search_builder_spec.rb +32 -23
  309. data/spec/models/blacklight/user_spec.rb +22 -0
  310. data/spec/models/solr_document_spec.rb +21 -3
  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 +10 -25
  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 +3 -2
  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/test_app_templates/lib/generators/test_app_generator.rb +9 -2
  331. data/spec/views/catalog/_document.html.erb_spec.rb +3 -34
  332. data/spec/views/catalog/_facet_index_navigation.html.erb_spec.rb +1 -1
  333. data/spec/views/catalog/_search_header.erb_spec.rb +1 -0
  334. data/spec/views/catalog/_show_sidebar.erb_spec.rb +1 -0
  335. data/spec/views/catalog/_show_tools.html.erb_spec.rb +7 -54
  336. data/spec/views/catalog/_view_type_group.html.erb_spec.rb +17 -9
  337. data/spec/views/catalog/email_success.html.erb_spec.rb +2 -2
  338. data/spec/views/catalog/facet.html.erb_spec.rb +6 -3
  339. data/spec/views/catalog/index.atom.builder_spec.rb +18 -11
  340. data/spec/views/catalog/index.html.erb_spec.rb +5 -6
  341. data/spec/views/catalog/index.json.jbuilder_spec.rb +5 -19
  342. data/spec/views/catalog/show.html.erb_spec.rb +3 -25
  343. data/spec/views/catalog/show.json.jbuilder_spec.rb +2 -9
  344. data/spec/views/catalog/sms_success.html.erb_spec.rb +2 -2
  345. data/tasks/blacklight.rake +6 -4
  346. metadata +66 -112
  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 -7
  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/controllers/blacklight/facet_spec.rb +0 -33
  376. data/spec/controllers/blacklight/search_fields_spec.rb +0 -62
  377. data/spec/helpers/blacklight/hash_as_hidden_fields_behavior_spec.rb +0 -26
  378. data/spec/helpers/blacklight/render_constraints_helper_behavior_spec.rb +0 -92
  379. data/spec/helpers/blacklight/search_history_constraints_helper_behavior_spec.rb +0 -108
  380. data/spec/helpers/blacklight/suggest_helper_behavior_spec.rb +0 -48
  381. data/spec/lib/blacklight/engine_spec.rb +0 -41
  382. data/spec/presenters/blacklight/search_bar_presenter_spec.rb +0 -94
  383. data/spec/views/catalog/_constraints.html.erb_spec.rb +0 -33
  384. data/spec/views/catalog/_facet_group.html.erb_spec.rb +0 -84
  385. data/spec/views/catalog/_facets.html.erb_spec.rb +0 -15
  386. data/spec/views/catalog/_index.html.erb_spec.rb +0 -62
  387. data/spec/views/catalog/_index_header.html.erb_spec.rb +0 -35
  388. data/spec/views/catalog/_previous_next_doc.html.erb_spec.rb +0 -22
  389. data/spec/views/catalog/_show.html.erb_spec.rb +0 -62
  390. data/spec/views/catalog/_thumbnail.html.erb_spec.rb +0 -38
@@ -0,0 +1,66 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Blacklight
4
+ module Assets
5
+ class SprocketsGenerator < Rails::Generators::Base
6
+ class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.1'), desc: "Set the generated app's bootstrap version"
7
+
8
+ # This could be skipped if you want to use webpacker
9
+ def add_javascript_dependencies
10
+ gem 'bootstrap', options[:'bootstrap-version'].presence
11
+ gem 'jquery-rails' if bootstrap_4? # Bootstrap 4 has a dependency on jquery
12
+ end
13
+
14
+ ##
15
+ # Remove the empty generated app/assets/images directory. Without doing this,
16
+ # the default Sprockets 4 manifest will raise an exception.
17
+ def appease_sprockets4
18
+ return if Rails.version > '7' || Sprockets::VERSION < '4'
19
+
20
+ append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
21
+ empty_directory 'app/assets/images'
22
+ end
23
+
24
+ def assets
25
+ create_file 'app/assets/stylesheets/blacklight.scss' do
26
+ <<~CONTENT
27
+ @import 'bootstrap';
28
+ @import 'blacklight/blacklight';
29
+ CONTENT
30
+ end
31
+
32
+ gem "sassc-rails", "~> 2.1" if Rails.version > '7'
33
+
34
+ # Ensure this method is idempotent
35
+ return if has_blacklight_assets?
36
+
37
+ create_file 'app/assets/javascripts/application.js' do
38
+ <<~CONTENT
39
+ //= require rails-ujs
40
+ #{'//= require jquery3' if bootstrap_4?}
41
+
42
+ // Required by Blacklight
43
+ //= require popper
44
+ //= require bootstrap
45
+ CONTENT
46
+ end
47
+ end
48
+
49
+ private
50
+
51
+ def bootstrap_4?
52
+ options[:'bootstrap-version'].match?(/\A[^0-9]*4\./)
53
+ end
54
+
55
+ def has_blacklight_assets?
56
+ application_js.include?('blacklight/blacklight')
57
+ end
58
+
59
+ def application_js
60
+ path = File.expand_path("app/assets/javascripts/application.js", destination_root)
61
+
62
+ File.exist?(path) ? File.read(path) : ''
63
+ end
64
+ end
65
+ end
66
+ end
@@ -1,97 +1,21 @@
1
1
  # frozen_string_literal: true
2
- module Blacklight
3
- class Assets < Rails::Generators::Base
4
- source_root File.expand_path('../templates', __FILE__)
5
-
6
- class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 4.0'), desc: "Set the generated app's bootstrap version"
7
-
8
- # This could be skipped if you want to use webpacker
9
- def add_javascript_dependencies
10
- gem 'bootstrap', options[:'bootstrap-version']
11
- gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
12
- end
13
-
14
- def appease_rails7
15
- return unless Rails.version > '7'
16
-
17
- gem "sassc-rails", "~> 2.1"
18
- end
19
-
20
- # Add sprockets javascript if needed
21
- def create_sprockets_javascript
22
- # Rails 5 already has an application.js file
23
- return if Rails.version < '6'
24
-
25
- create_file 'app/assets/javascripts/application.js' do
26
- <<~CONTENT
27
- //= require jquery3
28
- //= require rails-ujs
29
- #{'//= require turbolinks' if Rails.version < '7'}
30
- CONTENT
31
- end
32
- end
33
-
34
- ##
35
- # Remove the empty generated app/assets/images directory. Without doing this,
36
- # the default Sprockets 4 manifest will raise an exception.
37
- def appease_sprockets4
38
- return if !defined?(Sprockets::VERSION) || Sprockets::VERSION < '4' || using_importmap?
39
-
40
- append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
41
- empty_directory 'app/assets/images'
42
- end
43
-
44
- def assets
45
- copy_file "blacklight.scss", "app/assets/stylesheets/blacklight.scss"
46
2
 
47
- # Ensure this method is idempotent
48
- return if has_blacklight_assets?
49
-
50
- gem 'jquery-rails'
51
- contents = "\n//\n// Required by Blacklight\n"
52
- contents += "//= require popper\n"
53
- contents += "// Twitter Typeahead for autocomplete\n"
54
- contents += "//= require twitter/typeahead\n"
55
- contents += "//= require bootstrap\n"
56
- contents += "//= require blacklight/blacklight\n"
57
-
58
- marker = if turbolinks?
59
- '//= require turbolinks'
60
- else
61
- '//= require rails-ujs'
62
- end
63
-
64
- insert_into_file "app/assets/javascripts/application.js", after: marker do
65
- contents
66
- end
67
-
68
- insert_into_file "app/assets/javascripts/application.js", before: '//= require rails-ujs' do
69
- "//= require jquery3\n"
70
- end
71
- end
72
-
73
- private
74
-
75
- def root
76
- @root ||= Pathname(destination_root)
77
- end
78
-
79
- def using_importmap?
80
- @using_importmap ||= root.join('config/importmap.rb').exist?
81
- end
82
-
83
- def turbolinks?
84
- @turbolinks ||= application_js.include?('turbolinks')
85
- end
3
+ module Blacklight
4
+ class AssetsGenerator < Rails::Generators::Base
5
+ class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.1'), desc: "Set the generated app's bootstrap version"
86
6
 
87
- def has_blacklight_assets?
88
- application_js.include?('blacklight/blacklight')
89
- end
7
+ def run_asset_pipeline_specific_generator
8
+ generated_options = "--bootstrap-version='#{options[:'bootstrap-version']}'" if options[:'bootstrap-version']
90
9
 
91
- def application_js
92
- path = File.expand_path("app/assets/javascripts/application.js", destination_root)
10
+ generator = if defined?(Propshaft)
11
+ 'blacklight:assets:propshaft'
12
+ elsif defined?(Importmap)
13
+ 'blacklight:assets:importmap'
14
+ elsif defined?(Sprockets)
15
+ 'blacklight:assets:sprockets'
16
+ end
93
17
 
94
- File.exist?(path) ? File.read(path) : ''
18
+ generate generator, generated_options if generator
95
19
  end
96
20
  end
97
21
  end
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Blacklight
3
4
  class ControllerGenerator < Rails::Generators::Base
4
5
  source_root File.expand_path('../templates', __FILE__)
@@ -16,8 +17,8 @@ module Blacklight
16
17
  def inject_blacklight_controller_behavior
17
18
  inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
18
19
  " # Adds a few additional behaviors into the application controller\n" \
19
- " include Blacklight::Controller\n" \
20
- " layout :determine_layout if respond_to? :layout\n\n"
20
+ " include Blacklight::Controller\n" \
21
+ " layout :determine_layout if respond_to? :layout\n\n"
21
22
  end
22
23
  end
23
24
 
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  require 'rails/generators'
3
4
 
4
5
  module Blacklight
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Blacklight
3
4
  class Install < Rails::Generators::Base
4
5
  source_root File.expand_path('../templates', __FILE__)
@@ -11,7 +12,7 @@ module Blacklight
11
12
  class_option :devise, type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
12
13
  class_option :marc, type: :boolean, default: false, aliases: "-m", desc: "Generate MARC-based demo."
13
14
  class_option :'bootstrap-version', type: :string, default: nil, desc: "Set the generated app's bootstrap version"
14
- class_option :'skip-assets', type: :boolean, default: !defined?(Sprockets), desc: "Skip generating javascript and css assets into the application"
15
+ class_option :'skip-assets', type: :boolean, default: false, desc: "Skip generating javascript and css assets into the application"
15
16
  class_option :'skip-solr', type: :boolean, default: false, desc: "Skip generating solr configurations."
16
17
 
17
18
  desc <<-EOS
@@ -34,14 +35,14 @@ module Blacklight
34
35
  # Call external generator in AssetsGenerator, so we can
35
36
  # leave that callable seperately too.
36
37
  def copy_public_assets
37
- generated_options = "--bootstrap-version #{options[:'bootstrap-version']}" if options[:'bootstrap-version']
38
+ generated_options = "--bootstrap-version='#{options[:'bootstrap-version']}'" if options[:'bootstrap-version']
38
39
 
39
40
  generate "blacklight:assets", generated_options unless options[:'skip-assets']
40
41
  end
41
42
 
42
43
  def bundle_install
43
44
  inside destination_root do
44
- Bundler.with_clean_env do
45
+ Bundler.with_unbundled_env do
45
46
  run "bundle install"
46
47
  end
47
48
  end
@@ -84,7 +85,7 @@ module Blacklight
84
85
  return unless options[:marc]
85
86
 
86
87
  blacklight_marc = String.new('blacklight-marc')
87
- gem blacklight_marc, '>= 7.0.0.rc1', '< 8'
88
+ gem blacklight_marc, '~> 8.0'
88
89
 
89
90
  bundle_install
90
91
 
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  require 'rails/generators'
3
4
  require 'rails/generators/migration'
4
5
  require 'blacklight/version'
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  require 'rails/generators'
3
4
 
4
5
  module Blacklight
@@ -36,7 +36,7 @@ module Blacklight
36
36
 
37
37
  def bundle_install
38
38
  inside destination_root do
39
- Bundler.with_clean_env do
39
+ Bundler.with_unbundled_env do
40
40
  run "bundle install"
41
41
  end
42
42
  end
@@ -5,7 +5,16 @@ class <%= controller_name.classify %>Controller < ApplicationController
5
5
 
6
6
  include Blacklight::Catalog
7
7
 
8
+ # If you'd like to handle errors returned by Solr in a certain way,
9
+ # you can use Rails rescue_from with a method you define in this controller,
10
+ # uncomment:
11
+ #
12
+ # rescue_from Blacklight::Exceptions::InvalidRequest, with: :my_handling_method
13
+
8
14
  configure_blacklight do |config|
15
+ ## Specify the style of markup to be generated (may be 4 or 5)
16
+ # config.bootstrap_version = 5
17
+ #
9
18
  ## Class for sending and receiving requests from a search index
10
19
  # config.repository_class = Blacklight::Solr::Repository
11
20
  #
@@ -15,6 +24,9 @@ class <%= controller_name.classify %>Controller < ApplicationController
15
24
  ## Model that maps search index responses to the blacklight response model
16
25
  # config.response_model = Blacklight::Solr::Response
17
26
  #
27
+ ## The destination for the link around the logo in the header
28
+ # config.logo_link = root_path
29
+ #
18
30
  ## Should the raw solr document endpoint (e.g. /catalog/:id/raw) be enabled
19
31
  # config.raw_endpoint.enabled = false
20
32
 
@@ -32,16 +44,26 @@ class <%= controller_name.classify %>Controller < ApplicationController
32
44
 
33
45
  # solr field configuration for search results/index views
34
46
  config.index.title_field = 'title_tsim'
35
- #config.index.display_type_field = 'format'
36
- #config.index.thumbnail_field = 'thumbnail_path_ss'
47
+ # config.index.display_type_field = 'format'
48
+ # config.index.thumbnail_field = 'thumbnail_path_ss'
49
+
50
+ # The presenter is the view-model class for the page
51
+ # config.index.document_presenter_class = MyApp::IndexPresenter
37
52
 
38
- config.add_results_document_tool(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
53
+ # Some components can be configured
54
+ # config.index.document_component = MyApp::SearchResultComponent
55
+ # config.index.constraints_component = MyApp::ConstraintsComponent
56
+ # config.index.search_bar_component = MyApp::SearchBarComponent
57
+ # config.index.search_header_component = MyApp::SearchHeaderComponent
58
+ # config.index.document_actions.delete(:bookmark)
59
+
60
+ config.add_results_document_tool(:bookmark, component: Blacklight::Document::BookmarkComponent, if: :render_bookmarks_control?)
39
61
 
40
62
  config.add_results_collection_tool(:sort_widget)
41
63
  config.add_results_collection_tool(:per_page_widget)
42
64
  config.add_results_collection_tool(:view_type_group)
43
65
 
44
- config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
66
+ config.add_show_tools_partial(:bookmark, component: Blacklight::Document::BookmarkComponent, if: :render_bookmarks_control?)
45
67
  config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
46
68
  config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
47
69
  config.add_show_tools_partial(:citation)
@@ -50,9 +72,17 @@ class <%= controller_name.classify %>Controller < ApplicationController
50
72
  config.add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
51
73
 
52
74
  # solr field configuration for document/show views
53
- #config.show.title_field = 'title_tsim'
54
- #config.show.display_type_field = 'format'
55
- #config.show.thumbnail_field = 'thumbnail_path_ss'
75
+ # config.show.title_field = 'title_tsim'
76
+ # config.show.display_type_field = 'format'
77
+ # config.show.thumbnail_field = 'thumbnail_path_ss'
78
+ #
79
+ # The presenter is a view-model class for the page
80
+ # config.show.document_presenter_class = MyApp::ShowPresenter
81
+ #
82
+ # These components can be configured
83
+ # config.show.document_component = MyApp::DocumentComponent
84
+ # config.show.sidebar_component = MyApp::SidebarComponent
85
+ # config.show.embed_component = MyApp::EmbedComponent
56
86
 
57
87
  # solr fields that will be treated as facets by the blacklight application
58
88
  # The ordering of the field names is the order of the display
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Represent a single document returned from Solr
3
+ # Represents a single document returned from Solr
4
4
  class <%= model_name.classify %>
5
5
  include Blacklight::Solr::Document
6
6
 
@@ -1,4 +1,5 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  # Copy Blacklight test support material in place
3
4
 
4
5
  # Need the requires here so we can call the generator from environment.rb
@@ -41,9 +42,10 @@ module Blacklight
41
42
  end
42
43
 
43
44
  def configure_action_mailer
44
- insert_into_file "config/environments/test.rb", after: "config.action_mailer.delivery_method = :test\n" do <<-EOF
45
+ insert_into_file "config/environments/test.rb", after: "config.action_mailer.delivery_method = :test\n" do
46
+ <<-EOF
45
47
  config.action_mailer.default_options = {from: 'no-reply@example.org'}
46
- EOF
48
+ EOF
47
49
  end
48
50
  end
49
51
  end
@@ -25,7 +25,7 @@ module Blacklight
25
25
  gem "devise-guests", "~> 0.8"
26
26
 
27
27
  inside destination_root do
28
- Bundler.with_clean_env do
28
+ Bundler.with_unbundled_env do
29
29
  run "bundle install"
30
30
  end
31
31
  end
@@ -36,12 +36,10 @@ module Blacklight
36
36
 
37
37
  # add the #to_s to the model.
38
38
  insert_into_file("app/models/#{model_name}.rb", before: /end(\n| )*$/) do
39
- "\n # Method added by Blacklight; Blacklight uses #to_s on your\n" \
40
- " # user class to get a user-displayable login/identifier for\n" \
41
- " # the account.\n" \
42
- " def to_s\n" \
43
- " email\n" \
44
- " end\n"
39
+ "\n # Configuration added by Blacklight; Blacklight::User uses a method key on your\n" \
40
+ " # user class to get a user-displayable login/identifier for\n" \
41
+ " # the account.\n" \
42
+ " self.string_display_key ||= :email\n"
45
43
  end
46
44
  gsub_file("config/initializers/devise.rb", "config.sign_out_via = :delete", "config.sign_out_via = :get")
47
45
  end
@@ -52,10 +50,10 @@ module Blacklight
52
50
  if File.exist?(File.expand_path(file_path, destination_root))
53
51
  inject_into_class file_path, model_name.classify do
54
52
  "\n # Connects this user object to Blacklights Bookmarks." \
55
- "\n include Blacklight::User\n"
53
+ "\n include Blacklight::User\n"
56
54
  end
57
55
  else
58
- say_status "warning", <<-EOS.strip_heredoc, :yellow
56
+ say_status "warning", <<~EOS, :yellow
59
57
  Blacklight authenticated user functionality not installed, as a user model
60
58
  could not be found at /app/models/user.rb. If you used a different name,
61
59
  please re-run the migration and provide that name as an argument. E.g.:
@@ -19,9 +19,8 @@ namespace :blacklight do
19
19
  task seed: [:environment] do
20
20
  require 'yaml'
21
21
 
22
- app_file = Rails.root && Rails.root + 'spec/fixtures/sample_solr_documents.yml'
23
- file = ENV['FILE'] ||
24
- (app_file && File.exist?(app_file) && app_file) ||
22
+ app_file = Rails.root && "#{Rails.root}spec/fixtures/sample_solr_documents.yml"
23
+ file = ENV.fetch('FILE') { (app_file && File.exist?(app_file) && app_file) } ||
25
24
  File.join(Blacklight.root, 'spec', 'fixtures', 'sample_solr_documents.yml')
26
25
  docs = YAML.safe_load(File.open(file))
27
26
  conn = Blacklight.default_index.connection
data/package.json CHANGED
@@ -1,18 +1,17 @@
1
1
  {
2
2
  "name": "blacklight-frontend",
3
- "version": "7.25.0",
3
+ "version": "8.0.0-beta.1",
4
4
  "description": "[![Build Status](https://travis-ci.com/projectblacklight/blacklight.png?branch=main)](https://travis-ci.com/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=main)](https://coveralls.io/github/projectblacklight/blacklight?branch=main)",
5
5
  "main": "app/assets/javascripts/blacklight",
6
6
  "scripts": {
7
- "js-compile-bundle": "shx cat app/javascript/blacklight/core.js app/javascript/blacklight/autocomplete.js app/javascript/blacklight/bookmark_toggle.js app/javascript/blacklight/button_focus.js app/javascript/blacklight/checkbox_submit.js app/javascript/blacklight/facet_load.js app/javascript/blacklight/modal.js app/javascript/blacklight/search_context.js | shx sed \"s/^(import|export).*//\" | babel --filename app/javascript/blacklight/blacklight.js > app/assets/javascripts/blacklight/blacklight.js"
7
+ "js-compile-bundle": "rollup --config rollup.config.js --sourcemap && ESM=true rollup --config rollup.config.js --sourcemap"
8
8
  },
9
9
  "repository": {
10
10
  "type": "git",
11
11
  "url": "git+https://github.com/projectblacklight/blacklight.git"
12
12
  },
13
13
  "files": [
14
- "app/assets",
15
- "app/javascript"
14
+ "app/assets"
16
15
  ],
17
16
  "author": "",
18
17
  "license": "Apache-2.0",
@@ -21,15 +20,13 @@
21
20
  },
22
21
  "homepage": "https://github.com/projectblacklight/blacklight#readme",
23
22
  "devDependencies": {
24
- "@babel/cli": "^7.2.3",
25
- "@babel/core": "^7.2.3",
26
- "@babel/preset-env": "^7.16.0",
27
- "shx": "^0.3.2"
23
+ "rollup": "^2.60.0"
28
24
  },
29
- "browserslist": "> 0.25%, not dead",
25
+ "browserslist": [
26
+ "defaults",
27
+ "not IE 11"
28
+ ],
30
29
  "dependencies": {
31
- "bootstrap": ">=4.3.1 <6.0.0",
32
- "jquery": "^3.5.1",
33
- "typeahead.js": "^0.11.1"
30
+ "bootstrap": ">=4.3.1 <6.0.0"
34
31
  }
35
32
  }
data/rollup.config.js ADDED
@@ -0,0 +1,27 @@
1
+ 'use strict'
2
+
3
+ const path = require('path')
4
+
5
+ const BUNDLE = process.env.BUNDLE === 'true'
6
+ const ESM = process.env.ESM === 'true'
7
+
8
+ const fileDest = `blacklight${ESM ? '.esm' : ''}`
9
+ const external = []
10
+ const globals = {}
11
+
12
+ const rollupConfig = {
13
+ input: path.resolve(__dirname, `app/javascript/blacklight/index.js`),
14
+ output: {
15
+ file: path.resolve(__dirname, `app/assets/javascripts/blacklight/${fileDest}.js`),
16
+ format: ESM ? 'esm' : 'umd',
17
+ globals,
18
+ generatedCode: 'es2015'
19
+ },
20
+ external
21
+ }
22
+
23
+ if (!ESM) {
24
+ rollupConfig.output.name = 'Blacklight'
25
+ }
26
+
27
+ module.exports = rollupConfig
@@ -13,13 +13,21 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
13
13
 
14
14
  let(:blacklight_config) do
15
15
  Blacklight::Configuration.new.configure do |config|
16
- config.add_facet_field 'some_facet'
16
+ config.add_facet_field :some_facet
17
17
  end
18
18
  end
19
19
 
20
20
  let(:search_state) { Blacklight::SearchState.new(query_params.with_indifferent_access, blacklight_config) }
21
21
  let(:query_params) { {} }
22
22
 
23
+ context 'with no constraints' do
24
+ describe '#render?' do
25
+ it 'is false' do
26
+ expect(component.render?).to be false
27
+ end
28
+ end
29
+ end
30
+
23
31
  context 'with a query' do
24
32
  let(:query_params) { { q: 'some query' } }
25
33
 
@@ -43,21 +51,17 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
43
51
  context 'with a facet' do
44
52
  let(:query_params) { { f: { some_facet: ['some value'] } } }
45
53
 
46
- before do
47
- controller.blacklight_config.configure do |config|
48
- config.add_facet_field :some_facet
49
- end
54
+ it 'renders the query' do
55
+ expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
50
56
  end
51
57
 
52
- # this has to be cleaned up to prevent leaking class configuration
53
- after do
54
- controller.blacklight_config.configure do |config|
55
- config['facet_fields'].delete('some_facet')
56
- end
57
- end
58
+ context 'that is not configured' do
59
+ let(:query_params) { { f: { some_facet: ['some value'], missing: ['another value'] } } }
58
60
 
59
- it 'renders the query' do
60
- expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
61
+ it 'renders only the configured constraints' do
62
+ expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
63
+ expect(rendered).not_to have_selector('.constraint-value > .filter-name', text: 'Missing')
64
+ end
61
65
  end
62
66
  end
63
67
 
@@ -43,11 +43,11 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
43
43
  end
44
44
 
45
45
  it 'has some defined content areas' do
46
- component.with(:title, 'Title')
47
- component.with(:embed, 'Embed')
48
- component.with(:metadata, 'Metadata')
49
- component.with(:thumbnail, 'Thumbnail')
50
- component.with(:actions) { 'Actions' }
46
+ component.set_slot(:title) { 'Title' }
47
+ component.set_slot(:embed, nil, 'Embed')
48
+ component.set_slot(:metadata, nil, 'Metadata')
49
+ component.set_slot(:thumbnail, nil, 'Thumbnail')
50
+ component.set_slot(:actions) { 'Actions' }
51
51
 
52
52
  expect(rendered).to have_content 'Title'
53
53
  expect(rendered).to have_content 'Embed'
@@ -57,7 +57,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
57
57
  end
58
58
 
59
59
  it 'has schema.org properties' do
60
- component.with(:body, '-')
60
+ component.set_slot(:body) { '-' }
61
61
 
62
62
  expect(rendered).to have_selector 'article[@itemtype="http://schema.org/Thing"]'
63
63
  expect(rendered).to have_selector 'article[@itemscope]'
@@ -65,7 +65,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
65
65
 
66
66
  context 'with a provided body' do
67
67
  it 'opts-out of normal component content' do
68
- component.with(:body) { 'Body content' }
68
+ component.set_slot(:body) { 'Body content' }
69
69
 
70
70
  expect(rendered).to have_content 'Body content'
71
71
  expect(rendered).not_to have_selector 'header'
@@ -77,7 +77,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
77
77
  let(:attr) { { counter: 5 } }
78
78
 
79
79
  it 'has data properties' do
80
- component.with(:body, '-')
80
+ component.set_slot(:body) { '-' }
81
81
 
82
82
  expect(rendered).to have_selector 'article[@data-document-id="x"]'
83
83
  expect(rendered).to have_selector 'article[@data-document-counter="5"]'
@@ -116,7 +116,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
116
116
  end
117
117
 
118
118
  it 'renders with an id' do
119
- component.with(:body, '-')
119
+ component.set_slot(:body) { '-' }
120
120
 
121
121
  expect(rendered).to have_selector 'article#document'
122
122
  end
@@ -152,19 +152,9 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
152
152
  expect(rendered).not_to have_selector 'dt', text: 'ISBN:'
153
153
  end
154
154
 
155
- context 'with a thumbnail component' do
156
- let(:attr) { { thumbnail_component: thumbnail_component_class } }
157
- let(:thumbnail_component_class) do
158
- Class.new(ViewComponent::Base) do
159
- def render_in(view_context)
160
- view_context.capture { 'Thumb!' }
161
- end
162
- end
163
- end
164
-
165
- it 'uses the provided thumbnail component' do
166
- expect(rendered).to have_content 'Thumb!'
167
- end
155
+ it 'renders partials' do
156
+ component.partial { 'Partials' }
157
+ expect(rendered).to have_content 'Partials'
168
158
  end
169
159
 
170
160
  context 'with before_title' do
@@ -15,12 +15,7 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
15
15
  instance_double(Blacklight::Solr::Response::Facets::FacetField, name: 'field', items: items, limit: nil, sort: :index, offset: 0, prefix: nil)
16
16
  end
17
17
 
18
- let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'field', component: Blacklight::FacetFieldListComponent).normalize! }
19
-
20
- before do
21
- allow(controller).to receive(:view_context).and_return(controller.view_context)
22
- allow(controller.view_context).to receive(:facet_limit_for).and_return(20)
23
- end
18
+ let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'field').normalize! }
24
19
 
25
20
  it 'delegates to the configured component to render something' do
26
21
  expect(rendered).to have_selector 'ul.facet-values'
@@ -75,7 +70,7 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
75
70
  end
76
71
 
77
72
  context 'when the field is not in the response' do
78
- let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'some_other_field', component: Blacklight::FacetFieldListComponent).normalize! }
73
+ let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'some_other_field').normalize! }
79
74
 
80
75
  it 'uses a null field to pass through the response information anyway' do
81
76
  allow(facet_config.component).to receive(:new).and_call_original