blacklight 6.21.0 → 7.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (428) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.jshintrc +3 -1
  4. data/.npmignore +23 -0
  5. data/.rubocop.yml +40 -16
  6. data/.rubocop_todo.yml +478 -382
  7. data/.travis.yml +25 -28
  8. data/CONTRIBUTING.md +50 -0
  9. data/Gemfile +4 -3
  10. data/README.md +22 -5
  11. data/Rakefile +3 -2
  12. data/VERSION +1 -1
  13. data/Vagrantfile +2 -0
  14. data/app/assets/images/blacklight/list.svg +1 -0
  15. data/app/assets/images/blacklight/search.svg +1 -0
  16. data/app/assets/javascripts/blacklight/blacklight.js +495 -57
  17. data/app/assets/stylesheets/blacklight/_balanced_list.scss +7 -12
  18. data/app/assets/stylesheets/blacklight/_blacklight_base.scss +18 -15
  19. data/app/assets/stylesheets/blacklight/_bookmark.scss +1 -13
  20. data/app/assets/stylesheets/blacklight/_bootstrap_overrides.scss +31 -0
  21. data/app/assets/stylesheets/blacklight/_constraints.scss +17 -25
  22. data/app/assets/stylesheets/blacklight/_controls.scss +8 -16
  23. data/app/assets/stylesheets/blacklight/_facets.scss +66 -92
  24. data/app/assets/stylesheets/blacklight/_header.scss +60 -47
  25. data/app/assets/stylesheets/blacklight/_icons.scss +35 -0
  26. data/app/assets/stylesheets/blacklight/_layout.scss +0 -10
  27. data/app/assets/stylesheets/blacklight/_mixins.scss +15 -0
  28. data/app/assets/stylesheets/blacklight/_modal.scss +9 -17
  29. data/app/assets/stylesheets/blacklight/_pagination.scss +4 -13
  30. data/app/assets/stylesheets/blacklight/_search_form.scss +7 -0
  31. data/app/assets/stylesheets/blacklight/_search_history.scss +5 -13
  32. data/app/assets/stylesheets/blacklight/_search_results.scss +9 -8
  33. data/app/assets/stylesheets/blacklight/_twitter_typeahead.scss +1 -2
  34. data/app/assets/stylesheets/blacklight/blacklight.scss +1 -1
  35. data/app/builders/blacklight/action_builder.rb +57 -0
  36. data/app/controllers/bookmarks_controller.rb +2 -2
  37. data/app/controllers/catalog_controller.rb +2 -2
  38. data/app/controllers/concerns/blacklight/base.rb +0 -33
  39. data/app/controllers/concerns/blacklight/bookmarks.rb +20 -30
  40. data/app/controllers/concerns/blacklight/catalog.rb +256 -210
  41. data/app/controllers/concerns/blacklight/controller.rb +102 -124
  42. data/app/controllers/concerns/blacklight/default_component_configuration.rb +12 -43
  43. data/app/controllers/concerns/blacklight/facet.rb +22 -8
  44. data/app/controllers/concerns/blacklight/search_context.rb +11 -11
  45. data/app/controllers/concerns/blacklight/search_fields.rb +4 -14
  46. data/app/controllers/concerns/blacklight/search_history.rb +1 -6
  47. data/app/controllers/concerns/blacklight/searchable.rb +17 -0
  48. data/app/controllers/concerns/blacklight/token_based_user.rb +5 -7
  49. data/app/helpers/blacklight/blacklight_helper_behavior.rb +37 -119
  50. data/app/helpers/blacklight/catalog_helper_behavior.rb +103 -93
  51. data/app/helpers/blacklight/component_helper_behavior.rb +21 -21
  52. data/app/helpers/blacklight/configuration_helper_behavior.rb +30 -58
  53. data/app/helpers/blacklight/facets_helper_behavior.rb +79 -54
  54. data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb +9 -11
  55. data/app/helpers/blacklight/icon_helper_behavior.rb +18 -0
  56. data/app/helpers/blacklight/layout_helper_behavior.rb +3 -10
  57. data/app/helpers/blacklight/render_constraints_helper_behavior.rb +8 -6
  58. data/app/helpers/blacklight/render_partials_helper_behavior.rb +207 -0
  59. data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb +19 -11
  60. data/app/helpers/blacklight/suggest_helper_behavior.rb +1 -0
  61. data/app/helpers/blacklight/url_helper_behavior.rb +51 -42
  62. data/app/{assets/javascripts → javascript}/blacklight/autocomplete.js +3 -2
  63. data/app/javascript/blacklight/bookmark_toggle.js +25 -0
  64. data/app/javascript/blacklight/button_focus.js +9 -0
  65. data/app/javascript/blacklight/checkbox_submit.js +134 -0
  66. data/app/javascript/blacklight/core.js +41 -0
  67. data/app/javascript/blacklight/facet_load.js +22 -0
  68. data/app/{assets/javascripts/blacklight/ajax_modal.js → javascript/blacklight/modal.js} +62 -64
  69. data/app/javascript/blacklight/search_context.js +67 -0
  70. data/app/models/blacklight/facet_paginator.rb +3 -3
  71. data/app/models/blacklight/icon.rb +79 -0
  72. data/app/models/blacklight/suggest_search.rb +1 -1
  73. data/app/models/bookmark.rb +5 -10
  74. data/app/models/concerns/blacklight/configurable.rb +13 -13
  75. data/app/models/concerns/blacklight/document.rb +23 -39
  76. data/app/models/concerns/blacklight/document/active_model_shim.rb +8 -11
  77. data/app/models/concerns/blacklight/document/cache_key.rb +1 -1
  78. data/app/models/concerns/blacklight/document/dublin_core.rb +2 -2
  79. data/app/models/concerns/blacklight/document/email.rb +5 -5
  80. data/app/models/concerns/blacklight/document/extensions.rb +5 -5
  81. data/app/models/concerns/blacklight/document/semantic_fields.rb +9 -9
  82. data/app/models/concerns/blacklight/document/sms.rb +3 -3
  83. data/app/models/concerns/blacklight/user.rb +7 -6
  84. data/app/models/record_mailer.rb +8 -6
  85. data/app/models/search.rb +5 -7
  86. data/app/presenters/blacklight/document_presenter.rb +25 -140
  87. data/app/presenters/blacklight/field_presenter.rb +19 -14
  88. data/app/presenters/blacklight/index_presenter.rb +43 -71
  89. data/app/presenters/blacklight/json_presenter.rb +10 -14
  90. data/app/presenters/blacklight/link_alternate_presenter.rb +3 -1
  91. data/app/presenters/blacklight/rendering/abstract_step.rb +7 -5
  92. data/app/presenters/blacklight/rendering/helper_method.rb +10 -8
  93. data/app/presenters/blacklight/rendering/join.rb +5 -3
  94. data/app/presenters/blacklight/rendering/link_to_facet.rb +23 -19
  95. data/app/presenters/blacklight/rendering/microdata.rb +6 -3
  96. data/app/presenters/blacklight/rendering/pipeline.rb +27 -10
  97. data/app/presenters/blacklight/rendering/terminator.rb +2 -0
  98. data/app/presenters/blacklight/search_bar_presenter.rb +41 -0
  99. data/app/presenters/blacklight/show_presenter.rb +26 -72
  100. data/app/presenters/blacklight/thumbnail_presenter.rb +74 -0
  101. data/app/services/blacklight/document_factory.rb +13 -0
  102. data/app/services/blacklight/field_retriever.rb +26 -24
  103. data/app/services/blacklight/search_service.rb +153 -0
  104. data/app/values/blacklight/types.rb +31 -0
  105. data/app/views/blacklight/nav/_bookmark.html.erb +2 -2
  106. data/app/views/blacklight/nav/_search_history.html.erb +1 -1
  107. data/app/views/bookmarks/_tools.html.erb +2 -2
  108. data/app/views/bookmarks/index.html.erb +12 -13
  109. data/app/views/catalog/_bookmark_control.html.erb +27 -13
  110. data/app/views/catalog/_constraints.html.erb +6 -7
  111. data/app/views/catalog/_constraints_element.html.erb +6 -6
  112. data/app/views/catalog/_did_you_mean.html.erb +1 -1
  113. data/app/views/catalog/{_document_default.atom.builder → _document.atom.builder} +20 -19
  114. data/app/views/catalog/_document.html.erb +5 -3
  115. data/app/views/catalog/{_document_default.rss.builder → _document.rss.builder} +2 -0
  116. data/app/views/catalog/_document_action.html.erb +2 -1
  117. data/app/views/catalog/_email_form.html.erb +8 -4
  118. data/app/views/catalog/_facet_group.html.erb +19 -0
  119. data/app/views/catalog/_facet_index_navigation.html.erb +5 -4
  120. data/app/views/catalog/_facet_layout.html.erb +13 -8
  121. data/app/views/catalog/_facet_limit.html.erb +3 -2
  122. data/app/views/catalog/_facet_pagination.html.erb +8 -8
  123. data/app/views/catalog/_facet_pivot.html.erb +2 -2
  124. data/app/views/catalog/_facets.html.erb +3 -21
  125. data/app/views/catalog/_field.json.jbuilder +10 -0
  126. data/app/views/catalog/{_group_default.html.erb → _group.html.erb} +1 -1
  127. data/app/views/catalog/_home_text.html.erb +32 -36
  128. data/app/views/catalog/_index.html.erb +10 -0
  129. data/app/views/catalog/{_index_header_default.html.erb → _index_header.html.erb} +3 -3
  130. data/app/views/catalog/_per_page_widget.html.erb +7 -8
  131. data/app/views/catalog/_previous_next_doc.html.erb +6 -14
  132. data/app/views/catalog/_results_pagination.html.erb +2 -2
  133. data/app/views/catalog/_search_form.html.erb +12 -8
  134. data/app/views/catalog/_search_header.html.erb +0 -3
  135. data/app/views/catalog/_search_results.html.erb +10 -2
  136. data/app/views/catalog/_show.html.erb +8 -0
  137. data/app/views/catalog/{_show_header_default.html.erb → _show_header.html.erb} +0 -0
  138. data/app/views/catalog/_show_main_content.html.erb +4 -4
  139. data/app/views/catalog/_show_more_like_this.html.erb +1 -1
  140. data/app/views/catalog/_show_sidebar.html.erb +10 -8
  141. data/app/views/catalog/_show_tools.html.erb +10 -21
  142. data/app/views/catalog/_sms_form.html.erb +8 -4
  143. data/app/views/catalog/_sort_and_per_page.html.erb +3 -3
  144. data/app/views/catalog/_sort_widget.html.erb +8 -8
  145. data/app/views/catalog/_thumbnail.html.erb +5 -0
  146. data/app/views/catalog/_view_type_group.html.erb +2 -2
  147. data/app/views/catalog/_zero_results.html.erb +1 -1
  148. data/app/views/catalog/email.html.erb +5 -3
  149. data/app/views/catalog/email_success.html.erb +12 -8
  150. data/app/views/catalog/facet.html.erb +10 -8
  151. data/app/views/catalog/facet.json.jbuilder +2 -0
  152. data/app/views/catalog/index.atom.builder +28 -30
  153. data/app/views/catalog/index.html.erb +9 -11
  154. data/app/views/catalog/index.json.jbuilder +84 -3
  155. data/app/views/catalog/index.rss.builder +8 -6
  156. data/app/views/catalog/opensearch.xml.builder +12 -10
  157. data/app/views/catalog/show.html.erb +11 -6
  158. data/app/views/catalog/show.json.jbuilder +21 -0
  159. data/app/views/catalog/sms.html.erb +3 -1
  160. data/app/views/catalog/sms_success.html.erb +12 -8
  161. data/app/views/kaminari/blacklight/_first_page.html.erb +2 -2
  162. data/app/views/kaminari/blacklight/_gap.html.erb +2 -2
  163. data/app/views/kaminari/blacklight/_last_page.html.erb +2 -2
  164. data/app/views/kaminari/blacklight/_next_page.html.erb +5 -5
  165. data/app/views/kaminari/blacklight/_page.html.erb +5 -3
  166. data/app/views/kaminari/blacklight/_prev_page.html.erb +4 -4
  167. data/app/views/kaminari/blacklight_compact/_paginator.html.erb +4 -4
  168. data/app/views/layouts/blacklight.html.erb +14 -41
  169. data/app/views/layouts/blacklight/base.html.erb +40 -0
  170. data/app/views/layouts/catalog_result.html.erb +11 -0
  171. data/app/views/record_mailer/email_record.text.erb +6 -5
  172. data/app/views/search_history/index.html.erb +16 -21
  173. data/app/views/{_flash_msg.html.erb → shared/_flash_msg.html.erb} +5 -3
  174. data/app/views/shared/_header_navbar.html.erb +8 -13
  175. data/app/views/shared/_modal.html.erb +6 -0
  176. data/app/views/shared/_user_util_links.html.erb +22 -0
  177. data/blacklight.gemspec +7 -11
  178. data/config/i18n-tasks.yml +17 -0
  179. data/config/locales/blacklight.de.yml +87 -83
  180. data/config/locales/blacklight.en.yml +32 -29
  181. data/config/locales/blacklight.es.yml +31 -28
  182. data/config/locales/blacklight.fr.yml +33 -35
  183. data/config/locales/blacklight.hu.yml +226 -0
  184. data/config/locales/blacklight.it.yml +32 -28
  185. data/config/locales/blacklight.nl.yml +226 -0
  186. data/config/locales/blacklight.pt-BR.yml +41 -31
  187. data/config/locales/blacklight.sq.yml +21 -30
  188. data/config/locales/blacklight.zh.yml +20 -28
  189. data/config/routes.rb +2 -10
  190. data/db/migrate/20140202020202_create_bookmarks.rb +0 -1
  191. data/db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb +1 -1
  192. data/lib/blacklight.rb +6 -4
  193. data/lib/blacklight/abstract_repository.rb +9 -9
  194. data/lib/blacklight/configuration.rb +106 -88
  195. data/lib/blacklight/configuration/context.rb +12 -1
  196. data/lib/blacklight/configuration/facet_field.rb +16 -9
  197. data/lib/blacklight/configuration/field.rb +32 -3
  198. data/lib/blacklight/configuration/fields.rb +15 -17
  199. data/lib/blacklight/configuration/null_field.rb +2 -0
  200. data/lib/blacklight/configuration/search_field.rb +2 -2
  201. data/lib/blacklight/configuration/sort_field.rb +2 -2
  202. data/lib/blacklight/configuration/view_config.rb +4 -0
  203. data/lib/blacklight/engine.rb +10 -10
  204. data/lib/blacklight/exceptions.rb +4 -7
  205. data/lib/blacklight/{utils.rb → nested_open_struct_with_hash_access.rb} +9 -81
  206. data/lib/blacklight/open_struct_with_hash_access.rb +49 -0
  207. data/lib/blacklight/parameters.rb +1 -1
  208. data/lib/blacklight/routes/exportable.rb +1 -3
  209. data/lib/blacklight/routes/searchable.rb +3 -3
  210. data/lib/blacklight/runtime_registry.rb +2 -0
  211. data/lib/blacklight/search_builder.rb +28 -35
  212. data/lib/blacklight/search_state.rb +10 -8
  213. data/lib/blacklight/solr.rb +2 -0
  214. data/{app/models/concerns → lib}/blacklight/solr/document.rb +8 -8
  215. data/{app/models → lib}/blacklight/solr/facet_paginator.rb +3 -3
  216. data/lib/blacklight/solr/repository.rb +4 -3
  217. data/lib/blacklight/solr/request.rb +1 -1
  218. data/lib/blacklight/solr/response.rb +29 -30
  219. data/lib/blacklight/solr/response/facets.rb +38 -31
  220. data/lib/blacklight/solr/response/group.rb +3 -3
  221. data/lib/blacklight/solr/response/group_response.rb +11 -1
  222. data/lib/blacklight/solr/response/more_like_this.rb +2 -2
  223. data/lib/blacklight/solr/response/pagination_methods.rb +12 -0
  224. data/lib/blacklight/solr/response/response.rb +2 -2
  225. data/lib/blacklight/solr/response/spelling.rb +4 -3
  226. data/lib/blacklight/solr/search_builder_behavior.rb +27 -31
  227. data/lib/blacklight/version.rb +1 -1
  228. data/lib/generators/blacklight/assets_generator.rb +28 -12
  229. data/lib/generators/blacklight/controller_generator.rb +4 -5
  230. data/lib/generators/blacklight/document_generator.rb +1 -1
  231. data/lib/generators/blacklight/install_generator.rb +15 -34
  232. data/lib/generators/blacklight/search_builder_generator.rb +1 -1
  233. data/lib/generators/blacklight/{solr5_generator.rb → solr_generator.rb} +12 -6
  234. data/{.solr_wrapper.yml → lib/generators/blacklight/templates/.solr_wrapper.yml} +0 -0
  235. data/lib/generators/blacklight/templates/alternate_controller.rb +4 -4
  236. data/lib/generators/blacklight/templates/blacklight.scss +0 -2
  237. data/lib/generators/blacklight/templates/catalog_controller.rb +57 -50
  238. data/lib/generators/blacklight/templates/config/blacklight.yml +1 -13
  239. data/{solr → lib/generators/blacklight/templates/solr}/conf/_rest_managed.json +0 -0
  240. data/{solr → lib/generators/blacklight/templates/solr}/conf/admin-extra.html +0 -0
  241. data/{solr → lib/generators/blacklight/templates/solr}/conf/elevate.xml +0 -0
  242. data/{solr → lib/generators/blacklight/templates/solr}/conf/mapping-ISOLatin1Accent.txt +0 -0
  243. data/{solr → lib/generators/blacklight/templates/solr}/conf/protwords.txt +0 -0
  244. data/lib/generators/blacklight/templates/solr/conf/schema.xml +388 -0
  245. data/{solr → lib/generators/blacklight/templates/solr}/conf/scripts.conf +0 -0
  246. data/lib/generators/blacklight/templates/solr/conf/solrconfig.xml +195 -0
  247. data/{solr → lib/generators/blacklight/templates/solr}/conf/spellings.txt +0 -0
  248. data/{solr → lib/generators/blacklight/templates/solr}/conf/stopwords.txt +0 -0
  249. data/{solr → lib/generators/blacklight/templates/solr}/conf/stopwords_en.txt +0 -0
  250. data/{solr → lib/generators/blacklight/templates/solr}/conf/synonyms.txt +0 -0
  251. data/{solr → lib/generators/blacklight/templates/solr}/conf/xslt/example.xsl +0 -0
  252. data/{solr → lib/generators/blacklight/templates/solr}/conf/xslt/example_atom.xsl +0 -0
  253. data/{solr → lib/generators/blacklight/templates/solr}/conf/xslt/example_rss.xsl +0 -0
  254. data/{solr → lib/generators/blacklight/templates/solr}/conf/xslt/luke.xsl +0 -0
  255. data/lib/generators/blacklight/test_support_generator.rb +10 -10
  256. data/lib/generators/blacklight/user_generator.rb +5 -6
  257. data/lib/railties/blacklight.rake +7 -6
  258. data/package-lock.json +2793 -0
  259. data/package.json +30 -0
  260. data/spec/controllers/alternate_controller_spec.rb +5 -4
  261. data/spec/controllers/application_controller_spec.rb +1 -5
  262. data/spec/controllers/blacklight/base_spec.rb +6 -3
  263. data/spec/controllers/blacklight/catalog/component_configuration_spec.rb +11 -7
  264. data/spec/controllers/blacklight/facet_spec.rb +1 -2
  265. data/spec/controllers/blacklight/search_fields_spec.rb +25 -34
  266. data/spec/controllers/bookmarks_controller_spec.rb +17 -13
  267. data/spec/controllers/catalog_controller_spec.rb +329 -161
  268. data/spec/controllers/search_history_controller_spec.rb +6 -6
  269. data/spec/features/alternate_controller_spec.rb +4 -4
  270. data/spec/features/autocomplete_spec.rb +4 -2
  271. data/spec/features/bookmarks_spec.rb +10 -10
  272. data/spec/features/did_you_mean_spec.rb +7 -12
  273. data/spec/features/facets_spec.rb +38 -17
  274. data/spec/features/record_view_spec.rb +12 -18
  275. data/spec/features/search_context_spec.rb +6 -7
  276. data/spec/features/search_crawler_spec.rb +3 -5
  277. data/spec/features/search_filters_spec.rb +100 -80
  278. data/spec/features/search_formats_spec.rb +4 -5
  279. data/spec/features/search_history_spec.rb +6 -29
  280. data/spec/features/search_pagination_spec.rb +4 -2
  281. data/spec/features/search_results_spec.rb +14 -12
  282. data/spec/features/search_sort_spec.rb +2 -2
  283. data/spec/features/search_spec.rb +7 -12
  284. data/spec/features/sitelinks_search_box.rb +4 -4
  285. data/{solr → spec/fixtures}/sample_solr_documents.yml +688 -688
  286. data/spec/helpers/{configuration_helper_spec.rb → blacklight/configuration_helper_behavior_spec.rb} +97 -98
  287. data/spec/helpers/{facets_helper_spec.rb → blacklight/facets_helper_behavior_spec.rb} +82 -73
  288. data/spec/helpers/{hash_as_hidden_fields_spec.rb → blacklight/hash_as_hidden_fields_behavior_spec.rb} +2 -2
  289. data/spec/helpers/blacklight/icon_helper_behavior_spec.rb +10 -0
  290. data/spec/helpers/{layout_helper_spec.rb → blacklight/layout_helper_behavior_spec.rb} +5 -15
  291. data/spec/helpers/{render_constraints_helper_spec.rb → blacklight/render_constraints_helper_behavior_spec.rb} +10 -6
  292. data/spec/helpers/blacklight/render_partials_helper_behavior_spec.rb +92 -0
  293. data/spec/helpers/{search_history_constraints_helper_spec.rb → blacklight/search_history_constraints_helper_behavior_spec.rb} +29 -30
  294. data/spec/helpers/{suggest_helper_spec.rb → blacklight/suggest_helper_behavior_spec.rb} +9 -2
  295. data/spec/helpers/{url_helper_spec.rb → blacklight/url_helper_behavior_spec.rb} +61 -54
  296. data/spec/helpers/blacklight_helper_spec.rb +104 -151
  297. data/spec/helpers/catalog_helper_spec.rb +89 -105
  298. data/spec/i18n_spec.rb +18 -0
  299. data/spec/integration/generators/blacklight/{solr5_generator_spec.rb → solr_generator_spec.rb} +21 -13
  300. data/spec/lib/blacklight/configuration/facet_field_spec.rb +13 -0
  301. data/spec/lib/blacklight/configuration/field_spec.rb +15 -0
  302. data/spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb +17 -0
  303. data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb +148 -0
  304. data/spec/lib/blacklight/parameters_spec.rb +4 -2
  305. data/spec/lib/blacklight/search_state_spec.rb +53 -36
  306. data/spec/lib/blacklight_spec.rb +14 -15
  307. data/spec/lib/tasks/blacklight_task_spec.rb +4 -6
  308. data/spec/models/blacklight/configurable_spec.rb +24 -27
  309. data/spec/models/blacklight/configuration/context_spec.rb +9 -10
  310. data/spec/models/blacklight/configuration_spec.rb +188 -165
  311. data/spec/models/blacklight/document/active_model_shim_spec.rb +15 -6
  312. data/spec/models/blacklight/document/cache_key_spec.rb +10 -3
  313. data/spec/models/blacklight/document/dublin_core_spec.rb +17 -20
  314. data/spec/models/blacklight/document/email_spec.rb +10 -10
  315. data/spec/models/blacklight/document/sms_spec.rb +10 -10
  316. data/spec/models/blacklight/document_spec.rb +10 -22
  317. data/spec/models/blacklight/facet_paginator_spec.rb +40 -30
  318. data/spec/models/blacklight/icon_spec.rb +82 -0
  319. data/spec/models/blacklight/search_builder_spec.rb +41 -26
  320. data/spec/models/blacklight/solr/document_spec.rb +224 -216
  321. data/spec/models/blacklight/solr/facet_paginator_spec.rb +6 -4
  322. data/spec/models/blacklight/solr/repository_spec.rb +50 -42
  323. data/spec/models/blacklight/solr/request_spec.rb +17 -18
  324. data/spec/models/blacklight/solr/response/facets_spec.rb +97 -60
  325. data/spec/models/blacklight/solr/response/group_response_spec.rb +29 -22
  326. data/spec/models/blacklight/solr/response/group_spec.rb +18 -25
  327. data/spec/models/blacklight/solr/response_spec.rb +72 -68
  328. data/spec/models/blacklight/solr/search_builder_spec.rb +150 -164
  329. data/spec/models/blacklight/suggest/response_spec.rb +2 -1
  330. data/spec/models/blacklight/suggest_search_spec.rb +4 -4
  331. data/spec/models/blacklight/user_spec.rb +9 -11
  332. data/spec/models/bookmark_spec.rb +7 -6
  333. data/spec/models/record_mailer_spec.rb +23 -21
  334. data/spec/models/search_spec.rb +19 -18
  335. data/spec/models/solr_document_spec.rb +33 -5
  336. data/spec/presenters/blacklight/document_presenter_spec.rb +86 -0
  337. data/spec/presenters/{index_presenter_spec.rb → blacklight/index_presenter_spec.rb} +25 -62
  338. data/spec/presenters/blacklight/json_presenter_spec.rb +59 -0
  339. data/spec/presenters/blacklight/link_alternate_presenter_spec.rb +3 -0
  340. data/spec/presenters/blacklight/search_bar_presenter_spec.rb +94 -0
  341. data/spec/presenters/{show_presenter_spec.rb → blacklight/show_presenter_spec.rb} +47 -62
  342. data/spec/presenters/pipeline_spec.rb +43 -16
  343. data/spec/presenters/thumbnail_presenter_spec.rb +174 -0
  344. data/spec/routing/catalog_routing_spec.rb +13 -31
  345. data/spec/services/blacklight/search_service_spec.rb +495 -0
  346. data/spec/spec_helper.rb +12 -14
  347. data/spec/support/features.rb +1 -1
  348. data/spec/support/features/session_helpers.rb +4 -4
  349. data/spec/test_app_templates/Gemfile.extra +2 -5
  350. data/spec/test_app_templates/lib/generators/test_app_generator.rb +12 -13
  351. data/spec/views/catalog/_constraints.html.erb_spec.rb +3 -6
  352. data/spec/views/catalog/_constraints_element.html.erb_spec.rb +17 -13
  353. data/spec/views/catalog/_document.html.erb_spec.rb +11 -11
  354. data/spec/views/catalog/_document_list.html.erb_spec.rb +2 -1
  355. data/spec/views/catalog/_facet_group.html.erb_spec.rb +82 -0
  356. data/spec/views/catalog/_facet_index_navigation.html.erb_spec.rb +5 -5
  357. data/spec/views/catalog/_facet_layout.html.erb_spec.rb +6 -6
  358. data/spec/views/catalog/_facets.html.erb_spec.rb +6 -46
  359. data/spec/views/catalog/{_index_default.erb_spec.rb → _index.html.erb_spec.rb} +14 -15
  360. data/spec/views/catalog/{_index_header_default.html.erb_spec.rb → _index_header.html.erb_spec.rb} +6 -9
  361. data/spec/views/catalog/_paginate_compact.html.erb_spec.rb +7 -30
  362. data/spec/views/catalog/_search_header.erb_spec.rb +1 -3
  363. data/spec/views/catalog/{_show_default.erb_spec.rb → _show.html.erb_spec.rb} +13 -14
  364. data/spec/views/catalog/_show_sidebar.erb_spec.rb +7 -10
  365. data/spec/views/catalog/_show_tools.html.erb_spec.rb +6 -6
  366. data/spec/views/catalog/_sort_and_per_page.html.erb_spec.rb +1 -2
  367. data/spec/views/catalog/_sort_widget.html.erb_spec.rb +3 -1
  368. data/spec/views/catalog/{_thumbnail_default.erb_spec.rb → _thumbnail.html.erb_spec.rb} +7 -9
  369. data/spec/views/catalog/_view_type_group.html.erb_spec.rb +12 -10
  370. data/spec/views/catalog/email_success.html.erb_spec.rb +8 -0
  371. data/spec/views/catalog/facet.html.erb_spec.rb +4 -3
  372. data/spec/views/catalog/facet.json.jbuilder_spec.rb +3 -2
  373. data/spec/views/catalog/index.atom.builder_spec.rb +11 -6
  374. data/spec/views/catalog/index.html.erb_spec.rb +6 -8
  375. data/spec/views/catalog/index.json.jbuilder_spec.rb +119 -26
  376. data/spec/views/catalog/opensearch.xml.builder_spec.rb +1 -1
  377. data/spec/views/catalog/show.html.erb_spec.rb +8 -8
  378. data/spec/views/catalog/show.json.jbuilder_spec.rb +40 -0
  379. data/spec/views/catalog/sms_success.html.erb_spec.rb +8 -0
  380. data/spec/views/{_user_util_links.html.erb_spec.rb → shared/_user_util_links.html.erb_spec.rb} +4 -7
  381. data/tasks/blacklight.rake +9 -12
  382. data/template.demo.rb +4 -12
  383. metadata +172 -211
  384. data/app/assets/javascripts/blacklight/autofocus.js +0 -16
  385. data/app/assets/javascripts/blacklight/bookmark_toggle.js +0 -23
  386. data/app/assets/javascripts/blacklight/checkbox_submit.js +0 -139
  387. data/app/assets/javascripts/blacklight/collapsable.js +0 -9
  388. data/app/assets/javascripts/blacklight/core.js +0 -30
  389. data/app/assets/javascripts/blacklight/facet_load.js +0 -23
  390. data/app/assets/javascripts/blacklight/search_context.js +0 -42
  391. data/app/controllers/concerns/blacklight/request_builders.rb +0 -77
  392. data/app/controllers/concerns/blacklight/saved_searches.rb +0 -70
  393. data/app/controllers/concerns/blacklight/search_helper.rb +0 -161
  394. data/app/controllers/concerns/blacklight/suggest.rb +0 -25
  395. data/app/controllers/saved_searches_controller.rb +0 -4
  396. data/app/controllers/suggest_controller.rb +0 -4
  397. data/app/helpers/blacklight/deprecated_url_helper_behavior.rb +0 -57
  398. data/app/helpers/blacklight/render_partials_helper.rb +0 -205
  399. data/app/helpers/blacklight_configuration_helper.rb +0 -4
  400. data/app/helpers/blacklight_url_helper.rb +0 -4
  401. data/app/helpers/component_helper.rb +0 -4
  402. data/app/helpers/facets_helper.rb +0 -4
  403. data/app/helpers/hash_as_hidden_fields_helper.rb +0 -4
  404. data/app/helpers/layout_helper.rb +0 -4
  405. data/app/helpers/render_constraints_helper.rb +0 -4
  406. data/app/helpers/search_history_constraints_helper.rb +0 -4
  407. data/app/helpers/suggest_helper.rb +0 -4
  408. data/app/models/concerns/blacklight/solr/document/more_like_this.rb +0 -6
  409. data/app/views/_user_util_links.html.erb +0 -26
  410. data/app/views/blacklight/nav/_saved_searches.html.erb +0 -1
  411. data/app/views/catalog/_index_default.html.erb +0 -12
  412. data/app/views/catalog/_show_default.html.erb +0 -10
  413. data/app/views/catalog/_thumbnail_default.html.erb +0 -5
  414. data/app/views/saved_searches/index.html.erb +0 -32
  415. data/app/views/shared/_ajax_modal.html.erb +0 -6
  416. data/lib/generators/blacklight/solr4_generator.rb +0 -31
  417. data/lib/generators/blacklight/templates/config/jetty.yml +0 -13
  418. data/solr/conf/schema.xml +0 -627
  419. data/solr/conf/solrconfig.xml +0 -411
  420. data/spec/controllers/blacklight/search_helper_spec.rb +0 -489
  421. data/spec/controllers/saved_searches_controller_spec.rb +0 -32
  422. data/spec/controllers/suggest_controller_spec.rb +0 -17
  423. data/spec/features/saved_searches_spec.rb +0 -47
  424. data/spec/helpers/deprecated_url_helper_behavior_spec.rb +0 -101
  425. data/spec/lib/blacklight/utils_spec.rb +0 -167
  426. data/spec/models/blacklight/solr/document/more_like_this_spec.rb +0 -18
  427. data/spec/presenters/document_presenter_spec.rb +0 -438
  428. data/spec/support/backport_test.rb +0 -14
@@ -3,7 +3,7 @@
3
3
  # fields, works with hash nested with other hashes and arrays, standard rails
4
4
  # serialization style. Oddly while Hash#to_query will do this for a URL
5
5
  # query parameters, there seems to be no built in way to do it to create
6
- # hidden form fields instead.
6
+ # hidden form fields instead.
7
7
  #
8
8
  # Code taken from http://marklunds.com/articles/one/314
9
9
  #
@@ -15,22 +15,21 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
15
15
  # representing a hash passed in using Rails-style request parameters
16
16
  # for hashes nested with arrays and other hashes.
17
17
  # @param [Hash] hash
18
- # @return [String]
18
+ # @return [String]
19
19
  def render_hash_as_hidden_fields(hash)
20
-
21
20
  hidden_fields = []
22
21
  flatten_hash(hash).each do |name, value|
23
22
  value = Array.wrap(value)
24
23
  value.each do |v|
25
- hidden_fields << hidden_field_tag(name, v.to_s, :id => nil)
24
+ hidden_fields << hidden_field_tag(name, v.to_s, id: nil)
26
25
  end
27
26
  end
28
-
27
+
29
28
  safe_join(hidden_fields, "\n")
30
29
  end
31
30
 
32
- protected
33
-
31
+ private
32
+
34
33
  def flatten_hash(hash = params, ancestor_names = [])
35
34
  flat_hash = {}
36
35
  hash.each do |k, v|
@@ -44,17 +43,16 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
44
43
  flat_hash[key] = v
45
44
  end
46
45
  end
47
-
46
+
48
47
  flat_hash
49
48
  end
50
-
49
+
51
50
  def flat_hash_key(names)
52
51
  names = Array.new(names)
53
- name = names.shift.to_s.dup
52
+ name = names.shift.to_s.dup
54
53
  names.each do |n|
55
54
  name << "[#{n}]"
56
55
  end
57
56
  name
58
57
  end
59
-
60
58
  end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ ##
4
+ # Module to help generate icon helpers for SVG images
5
+ module Blacklight::IconHelperBehavior
6
+ ##
7
+ # Returns the raw SVG (String) for a Blacklight Icon located in
8
+ # app/assets/images/blacklight/*.svg. Caches them so we don't have to look up
9
+ # the svg everytime.
10
+ # @param [String, Symbol] icon_name
11
+ # @return [String]
12
+ def blacklight_icon(icon_name, options = {})
13
+ Rails.cache.fetch([:blacklight_icons, icon_name, options]) do
14
+ icon = Blacklight::Icon.new(icon_name, options)
15
+ content_tag(:span, icon.svg.html_safe, icon.options)
16
+ end
17
+ end
18
+ end
@@ -11,13 +11,6 @@ module Blacklight
11
11
  "#{main_content_classes} show-document"
12
12
  end
13
13
 
14
- ##
15
- # Attributes to add to the <html> tag (e.g. lang and dir)
16
- # @return [Hash]
17
- def html_tag_attributes
18
- { lang: I18n.locale }
19
- end
20
-
21
14
  ##
22
15
  # Classes added to a document's sidebar div
23
16
  # @return [String]
@@ -29,20 +22,20 @@ module Blacklight
29
22
  # Classes used for sizing the main content of a Blacklight page
30
23
  # @return [String]
31
24
  def main_content_classes
32
- 'col-md-9 col-sm-8'
25
+ 'col-lg-9'
33
26
  end
34
27
 
35
28
  ##
36
29
  # Classes used for sizing the sidebar content of a Blacklight page
37
30
  # @return [String]
38
31
  def sidebar_classes
39
- 'col-md-3 col-sm-4'
32
+ 'page-sidebar col-lg-3'
40
33
  end
41
34
 
42
35
  ##
43
36
  # Class used for specifying main layout container classes. Can be
44
37
  # overwritten to return 'container-fluid' for Bootstrap full-width layout
45
- # @return [String]
38
+ # @return [String]
46
39
  def container_classes
47
40
  'container'
48
41
  end
@@ -12,7 +12,7 @@ module Blacklight::RenderConstraintsHelperBehavior
12
12
  # @param [Hash] localized_params query parameters
13
13
  # @return [Boolean]
14
14
  def query_has_constraints?(localized_params = params)
15
- !(localized_params[:q].blank? and localized_params[:f].blank?)
15
+ !(localized_params[:q].blank? && localized_params[:f].blank?)
16
16
  end
17
17
 
18
18
  ##
@@ -35,9 +35,9 @@ module Blacklight::RenderConstraintsHelperBehavior
35
35
  return "".html_safe if localized_params[:q].blank?
36
36
 
37
37
  render_constraint_element(constraint_query_label(localized_params),
38
- localized_params[:q],
39
- classes: ["query"],
40
- remove: remove_constraint_url(localized_params))
38
+ localized_params[:q],
39
+ classes: ["query"],
40
+ remove: remove_constraint_url(localized_params))
41
41
  end
42
42
 
43
43
  ##
@@ -65,9 +65,10 @@ module Blacklight::RenderConstraintsHelperBehavior
65
65
  # @return [String]
66
66
  def render_constraints_filters(localized_params = params)
67
67
  return "".html_safe unless localized_params[:f]
68
+
68
69
  path = controller.search_state_class.new(localized_params, blacklight_config, controller)
69
70
  content = []
70
- localized_params[:f].each_pair do |facet,values|
71
+ localized_params[:f].each_pair do |facet, values|
71
72
  content << render_filter_element(facet, values, path)
72
73
  end
73
74
 
@@ -85,6 +86,7 @@ module Blacklight::RenderConstraintsHelperBehavior
85
86
 
86
87
  safe_join(Array(values).map do |val|
87
88
  next if val.blank? # skip empty string
89
+
88
90
  render_constraint_element(facet_field_label(facet_config.key),
89
91
  facet_display_value(facet, val),
90
92
  remove: search_action_path(path.remove_facet_params(facet, val)),
@@ -107,6 +109,6 @@ module Blacklight::RenderConstraintsHelperBehavior
107
109
  # @option options [Array<String>] :classes an array of classes to add to container span for constraint.
108
110
  # @return [String]
109
111
  def render_constraint_element(label, value, options = {})
110
- render(:partial => "catalog/constraints_element", :locals => {:label => label, :value => value, :options => options})
112
+ render(partial: "catalog/constraints_element", locals: { label: label, value: value, options: options })
111
113
  end
112
114
  end
@@ -0,0 +1,207 @@
1
+ # frozen_string_literal: true
2
+ module Blacklight::RenderPartialsHelperBehavior
3
+ ##
4
+ # Render the document index view
5
+ #
6
+ # @param [Array<SolrDocument>] documents list of documents to render
7
+ # @param [Hash] locals to pass to the render call
8
+ # @return [String]
9
+ def render_document_index documents = nil, locals = {}
10
+ documents ||= @response.documents
11
+ render_document_index_with_view(document_index_view_type, documents, locals)
12
+ end
13
+
14
+ ##
15
+ # Render the document index for a grouped response
16
+ def render_grouped_document_index
17
+ render 'catalog/group'
18
+ end
19
+
20
+ ##
21
+ # Return the list of partials for a given solr document
22
+ # @param [SolrDocument] doc solr document to render partials for
23
+ # @param [Array<String>] partials list of partials to render
24
+ # @param [Hash] locals local variables to pass to the render call
25
+ # @return [String]
26
+ def render_document_partials(doc, partials = [], locals = {})
27
+ safe_join(partials.map do |action_name|
28
+ render_document_partial(doc, action_name, locals)
29
+ end, "\n")
30
+ end
31
+
32
+ ##
33
+ # Return the list of xml for a given solr document. Doesn't safely escape for HTML.
34
+ # @param [SolrDocument] doc solr document to render partials for
35
+ # @param [Array<String>] partials list of partials to render
36
+ # @param [Hash] locals local variables to pass to the render call
37
+ # @return [String]
38
+ def render_xml_partials(doc, partials = [], locals = {})
39
+ partials.map do |action_name|
40
+ render_document_partial(doc, action_name, locals)
41
+ end.join("\n")
42
+ end
43
+
44
+ ##
45
+ # Given a doc and a base name for a partial, this method will attempt to render
46
+ # an appropriate partial based on the document format and view type.
47
+ #
48
+ # If a partial that matches the document format is not found,
49
+ # render a default partial for the base name.
50
+ #
51
+ # @see #document_partial_path_templates
52
+ #
53
+ # @param [SolrDocument] doc
54
+ # @param [String] base_name base name for the partial
55
+ # @param [Hash] locals local variables to pass through to the partials
56
+ def render_document_partial(doc, base_name, locals = {})
57
+ format = document_partial_name(doc, base_name)
58
+
59
+ view_type = document_index_view_type
60
+ template = cached_view ['show', view_type, base_name, format].join('_') do
61
+ find_document_show_template_with_view(view_type, base_name, format, locals)
62
+ end
63
+ if template
64
+ template.render(self, locals.merge(document: doc))
65
+ else
66
+ ''
67
+ end
68
+ end
69
+
70
+ ##
71
+ # Render the document index for the given view type with the
72
+ # list of documents.
73
+ #
74
+ # This method will interpolate the list of templates with
75
+ # the current view, and gracefully handles missing templates.
76
+ #
77
+ # @see #document_index_path_templates
78
+ #
79
+ # @param [String] view type
80
+ # @param [Array<SolrDocument>] documents list of documents to render
81
+ # @param [Hash] locals to pass to the render call
82
+ # @return [String]
83
+ def render_document_index_with_view view, documents, locals = {}
84
+ template = cached_view ['index', view].join('_') do
85
+ find_document_index_template_with_view(view, locals)
86
+ end
87
+
88
+ if template
89
+ template.render(self, locals.merge(documents: documents))
90
+ else
91
+ ''
92
+ end
93
+ end
94
+
95
+ ##
96
+ # A list of document partial templates to attempt to render
97
+ #
98
+ # @see #render_document_index_with_view
99
+ # @return [Array<String>]
100
+ def document_index_path_templates
101
+ # first, the legacy template names for backwards compatbility
102
+ # followed by the new, inheritable style
103
+ # finally, a controller-specific path for non-catalog subclasses
104
+ @document_index_path_templates ||= [
105
+ "document_%{index_view_type}",
106
+ "catalog/document_%{index_view_type}",
107
+ "catalog/document_list"
108
+ ]
109
+ end
110
+
111
+ ##
112
+ # Return a normalized partial name for rendering a single document
113
+ #
114
+ # @param [SolrDocument] document
115
+ # @param [Symbol] base_name base name for the partial
116
+ # @return [String]
117
+ def document_partial_name(document, base_name = nil)
118
+ view_config = blacklight_config.view_config(:show)
119
+
120
+ display_type = if base_name && view_config.key?(:"#{base_name}_display_type_field")
121
+ document[view_config[:"#{base_name}_display_type_field"]]
122
+ end
123
+
124
+ display_type ||= document[view_config.display_type_field]
125
+
126
+ display_type ||= 'default'
127
+
128
+ type_field_to_partial_name(document, display_type)
129
+ end
130
+
131
+ private
132
+
133
+ ##
134
+ # Return a partial name for rendering a document
135
+ # this method can be overridden in order to transform the value
136
+ # (e.g. 'PdfBook' => 'pdf_book')
137
+ #
138
+ # @param [SolrDocument] document
139
+ # @param [String, Array] display_type a value suggestive of a partial
140
+ # @return [String] the name of the partial to render
141
+ # @example
142
+ # type_field_to_partial_name(['a book-article'])
143
+ # => 'a_book_article'
144
+ def type_field_to_partial_name(_document, display_type)
145
+ # using "_" as sep. to more closely follow the views file naming conventions
146
+ # parameterize uses "-" as the default sep. which throws errors
147
+ underscore = '_'
148
+ Array(display_type).join(' ').tr('-', underscore).parameterize(separator: underscore)
149
+ end
150
+
151
+ ##
152
+ # A list of document partial templates to try to render for a document
153
+ #
154
+ # The partial names will be interpolated with the following variables:
155
+ # - action_name: (e.g. index, show)
156
+ # - index_view_type: (the current view type, e.g. list, gallery)
157
+ # - format: the document's format (e.g. book)
158
+ #
159
+ # @see #render_document_partial
160
+ def document_partial_path_templates
161
+ # first, the legacy template names for backwards compatbility
162
+ # followed by the new, inheritable style
163
+ # finally, a controller-specific path for non-catalog subclasses
164
+ @partial_path_templates ||= [
165
+ "%{action_name}_%{index_view_type}_%{format}",
166
+ "%{action_name}_%{index_view_type}_default",
167
+ "%{action_name}_%{format}",
168
+ "%{action_name}_default",
169
+ "%{action_name}",
170
+ "catalog/%{action_name}_%{format}",
171
+ "catalog/_%{action_name}_partials/%{format}",
172
+ "catalog/_%{action_name}_partials/default"
173
+ ]
174
+ end
175
+
176
+ def find_document_show_template_with_view view_type, base_name, format, locals
177
+ document_partial_path_templates.each do |str|
178
+ partial = format(str, action_name: base_name, format: format, index_view_type: view_type)
179
+ logger.debug "Looking for document partial #{partial}"
180
+ template = lookup_context.find_all(partial, lookup_context.prefixes + [""], true, locals.keys + [:document], {}).first
181
+ return template if template
182
+ end
183
+ nil
184
+ end
185
+
186
+ def find_document_index_template_with_view view_type, locals
187
+ document_index_path_templates.each do |str|
188
+ partial = format(str, index_view_type: view_type)
189
+ logger.debug "Looking for document index partial #{partial}"
190
+ template = lookup_context.find_all(partial, lookup_context.prefixes + [""], true, locals.keys + [:documents], {}).first
191
+ return template if template
192
+ end
193
+ nil
194
+ end
195
+
196
+ ##
197
+ # @param key fetches or writes data to a cache, using the given key.
198
+ # @yield the block to evaluate (and cache) if there is a cache miss
199
+ def cached_view key
200
+ @view_cache ||= {}
201
+ if @view_cache.key?(key)
202
+ @view_cache[key]
203
+ else
204
+ @view_cache[key] = yield
205
+ end
206
+ end
207
+ end
@@ -8,8 +8,8 @@
8
8
  module Blacklight::SearchHistoryConstraintsHelperBehavior
9
9
  # Simpler textual version of constraints, used on Search History page.
10
10
  # Theoretically can may be DRY'd up with results page render_constraints,
11
- # maybe even using the very same HTML with different CSS?
12
- # But too tricky for now, too many changes to existing CSS. TODO.
11
+ # maybe even using the very same HTML with different CSS?
12
+ # But too tricky for now, too many changes to existing CSS. TODO.
13
13
  def render_search_to_s(params)
14
14
  render_search_to_s_q(params) +
15
15
  render_search_to_s_filters(params)
@@ -22,7 +22,7 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
22
22
 
23
23
  label = label_for_search_field(params[:search_field]) unless default_search_field && params[:search_field] == default_search_field[:key]
24
24
 
25
- render_search_to_s_element(label , render_filter_value(params['q']) )
25
+ render_search_to_s_element(label, render_filter_value(params['q']))
26
26
  end
27
27
 
28
28
  ##
@@ -32,24 +32,30 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
32
32
 
33
33
  safe_join(params[:f].collect do |facet_field, value_list|
34
34
  render_search_to_s_element(facet_field_label(facet_field),
35
- safe_join(value_list.collect do |value|
36
- render_filter_value(value, facet_field)
37
- end, content_tag(:span, " #{t('blacklight.and')} ", :class =>'filterSeparator')))
35
+ safe_join(value_list.collect do |value|
36
+ render_filter_value(value, facet_field)
37
+ end,
38
+ content_tag(:span, " #{t('blacklight.and')} ", class: 'filter-separator')))
38
39
  end, " \n ")
39
40
  end
40
41
 
41
42
  # value can be Array, in which case elements are joined with
42
43
  # 'and'. Pass in option :escape_value => false to pass in pre-rendered
43
- # html for value. key with escape_key if needed.
44
- def render_search_to_s_element(key, value, options = {})
45
- content_tag(:span, render_filter_name(key) + content_tag(:span, value, :class => 'filterValues'), :class => 'constraint')
44
+ # html for value. key with escape_key if needed.
45
+ def render_search_to_s_element(key, value, _options = {})
46
+ content_tag(:span,
47
+ render_filter_name(key) + content_tag(:span, value, class: 'filter-values'),
48
+ class: 'constraint')
46
49
  end
47
50
 
48
51
  ##
49
52
  # Render the name of the facet
50
53
  def render_filter_name name
51
54
  return "".html_safe if name.blank?
52
- content_tag(:span, t('blacklight.search.filters.label', :label => name), :class => 'filterName')
55
+
56
+ content_tag(:span,
57
+ t('blacklight.search.filters.label', label: name),
58
+ class: 'filter-name')
53
59
  end
54
60
 
55
61
  ##
@@ -57,6 +63,8 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
57
63
  def render_filter_value value, key = nil
58
64
  display_value = value
59
65
  display_value = facet_display_value(key, value) if key
60
- content_tag(:span, h(display_value), :class => 'filterValue')
66
+ content_tag(:span,
67
+ h(display_value),
68
+ class: 'filter-value')
61
69
  end
62
70
  end
@@ -7,5 +7,6 @@ module Blacklight
7
7
  blacklight_config.autocomplete_enabled.present? &&
8
8
  blacklight_config.autocomplete_path.present?
9
9
  end
10
+ deprecation_deprecate autocomplete_enabled?: "use SearchBarPresenter#autocomplete_enabled?"
10
11
  end
11
12
  end
@@ -2,53 +2,61 @@
2
2
  ##
3
3
  # URL helper methods
4
4
  module Blacklight::UrlHelperBehavior
5
- include Blacklight::DeprecatedUrlHelperBehavior
6
-
7
- ##
8
- # Extension point for downstream applications
9
- # to provide more interesting routing to
10
- # documents
11
5
  def url_for_document(doc, options = {})
12
6
  search_state.url_for_document(doc, options)
13
7
  end
14
8
 
15
- # link_to_document(doc, 'VIEW', :counter => 3)
16
- # Use the catalog_path RESTful route to create a link to the show page for a specific item.
9
+ # Uses the catalog_path route to create a link to the show page for an item.
17
10
  # catalog_path accepts a hash. The solr query params are stored in the session,
18
11
  # so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
19
12
  # TODO: move this to the IndexPresenter
20
- def link_to_document(doc, field_or_opts = nil, opts={:counter => nil})
21
- if field_or_opts.is_a? Hash
22
- opts = field_or_opts
23
- else
24
- field = field_or_opts
25
- end
13
+ # @param doc [SolrDocument] the document
14
+ # @param field_or_opts [Hash, String] either a string to render as the link text or options
15
+ # @param opts [Hash] the options to create the link with
16
+ # @option opts [Number] :counter (nil) the count to set in the session (for paging through a query result)
17
+ # @example Passing in an image
18
+ # link_to_document(doc, '<img src="thumbnail.png">', counter: 3) #=> "<a href=\"catalog/123\" data-tracker-href=\"/catalog/123/track?counter=3&search_id=999\"><img src="thumbnail.png"></a>
19
+ # @example With the default document link field
20
+ # link_to_document(doc, counter: 3) #=> "<a href=\"catalog/123\" data-tracker-href=\"/catalog/123/track?counter=3&search_id=999\">My Title</a>
21
+ def link_to_document(doc, field_or_opts = nil, opts = { counter: nil })
22
+ label = case field_or_opts
23
+ when NilClass
24
+ index_presenter(doc).label document_show_link_field(doc), opts
25
+ when Hash
26
+ opts = field_or_opts
27
+ index_presenter(doc).label document_show_link_field(doc), opts
28
+ when Proc, Symbol
29
+ Deprecation.warn(self, "passing a #{field_or_opts.class} to link_to_document is deprecated and will be removed in Blacklight 8")
30
+ Deprecation.silence(Blacklight::IndexPresenter) do
31
+ index_presenter(doc).label field_or_opts, opts
32
+ end
33
+ else # String
34
+ field_or_opts
35
+ end
26
36
 
27
- field ||= document_show_link_field(doc)
28
- label = index_presenter(doc).label field, opts
29
37
  link_to label, url_for_document(doc), document_link_params(doc, opts)
30
38
  end
31
39
 
32
40
  def document_link_params(doc, opts)
33
41
  session_tracking_params(doc, opts[:counter]).deep_merge(opts.except(:label, :counter))
34
42
  end
35
- protected :document_link_params
43
+ private :document_link_params
36
44
 
37
45
  ##
38
46
  # Link to the previous document in the current search context
39
47
  def link_to_previous_document(previous_document)
40
- link_opts = session_tracking_params(previous_document, search_session['counter'].to_i - 1).merge(:class => "previous", :rel => 'prev')
48
+ link_opts = session_tracking_params(previous_document, search_session['counter'].to_i - 1).merge(class: "previous", rel: 'prev')
41
49
  link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), link_opts do
42
- content_tag :span, raw(t('views.pagination.previous')), :class => 'previous'
50
+ content_tag :span, raw(t('views.pagination.previous')), class: 'previous'
43
51
  end
44
52
  end
45
53
 
46
54
  ##
47
55
  # Link to the next document in the current search context
48
56
  def link_to_next_document(next_document)
49
- link_opts = session_tracking_params(next_document, search_session['counter'].to_i + 1).merge(:class => "next", :rel => 'next')
57
+ link_opts = session_tracking_params(next_document, search_session['counter'].to_i + 1).merge(class: "next", rel: 'next')
50
58
  link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), link_opts do
51
- content_tag :span, raw(t('views.pagination.next')), :class => 'next'
59
+ content_tag :span, raw(t('views.pagination.next')), class: 'next'
52
60
  end
53
61
  end
54
62
 
@@ -58,7 +66,7 @@ module Blacklight::UrlHelperBehavior
58
66
  # @param [Integer] counter
59
67
  # @example
60
68
  # session_tracking_params(SolrDocument.new(id: 123), 7)
61
- # => { data: { :'tracker-href' => '/catalog/123/track?counter=7&search_id=999' } }
69
+ # => { data: { :'context-href' => '/catalog/123/track?counter=7&search_id=999' } }
62
70
  def session_tracking_params document, counter
63
71
  path = session_tracking_path(document, per_page: params.fetch(:per_page, search_session['per_page']), counter: counter, search_id: current_search_session.try(:id))
64
72
 
@@ -66,20 +74,21 @@ module Blacklight::UrlHelperBehavior
66
74
  return {}
67
75
  end
68
76
 
69
- { data: {:'context-href' => path } }
77
+ { data: { 'context-href': path } }
70
78
  end
71
- protected :session_tracking_params
79
+ private :session_tracking_params
72
80
 
73
81
  ##
74
82
  # Get the URL for tracking search sessions across pages using polymorphic routing
75
83
  def session_tracking_path document, params = {}
76
- return if document.nil?
84
+ return if document.nil? || !blacklight_config&.track_search_session
77
85
 
78
- if respond_to?(controller_tracking_method)
79
- send(controller_tracking_method, params.merge(id: document))
80
- else
81
- blacklight.track_search_context_path(params.merge(id: document))
86
+ if main_app.respond_to?(controller_tracking_method)
87
+ return main_app.public_send(controller_tracking_method, params.merge(id: document))
82
88
  end
89
+
90
+ raise "Unable to find #{controller_tracking_method} route helper. " \
91
+ "Did you add `concerns :searchable` routing mixin to your `config/routes.rb`?"
83
92
  end
84
93
 
85
94
  def controller_tracking_method
@@ -101,7 +110,7 @@ module Blacklight::UrlHelperBehavior
101
110
  # Get the path to the search action with any parameters (e.g. view type)
102
111
  # that should be persisted across search sessions.
103
112
  def start_over_path query_params = params
104
- h = { }
113
+ h = {}
105
114
  current_index_view_type = document_index_view_type(query_params)
106
115
  h[:view] = current_index_view_type unless current_index_view_type == default_document_index_view_type
107
116
 
@@ -112,23 +121,23 @@ module Blacklight::UrlHelperBehavior
112
121
  # @example
113
122
  # link_back_to_catalog(label: 'Back to Search')
114
123
  # link_back_to_catalog(label: 'Back to Search', route_set: my_engine)
115
- def link_back_to_catalog(opts={:label=>nil})
124
+ def link_back_to_catalog(opts = { label: nil })
116
125
  scope = opts.delete(:route_set) || self
117
126
  query_params = search_state.reset(current_search_session.try(:query_params)).to_hash
118
127
 
119
128
  if search_session['counter']
120
- per_page = (search_session['per_page'] || default_per_page).to_i
129
+ per_page = (search_session['per_page'] || blacklight_config.default_per_page).to_i
121
130
  counter = search_session['counter'].to_i
122
131
 
123
- query_params[:per_page] = per_page unless search_session['per_page'].to_i == default_per_page
124
- query_params[:page] = ((counter - 1)/ per_page) + 1
132
+ query_params[:per_page] = per_page unless search_session['per_page'].to_i == blacklight_config.default_per_page
133
+ query_params[:page] = ((counter - 1) / per_page) + 1
125
134
  end
126
135
 
127
136
  link_url = if query_params.empty?
128
- search_action_path(only_path: true)
129
- else
130
- scope.url_for(query_params)
131
- end
137
+ search_action_path(only_path: true)
138
+ else
139
+ scope.url_for(query_params)
140
+ end
132
141
  label = opts.delete(:label)
133
142
 
134
143
  if link_url =~ /bookmarks/
@@ -153,11 +162,11 @@ module Blacklight::UrlHelperBehavior
153
162
  search_state.add_facet_params_and_redirect(group.field, group.key)
154
163
  end
155
164
 
156
- # A URL to refworks export, with an embedded callback URL to this app.
157
- # the callback URL is to bookmarks#export, which delivers a list of
165
+ # A URL to refworks export, with an embedded callback URL to this app.
166
+ # the callback URL is to bookmarks#export, which delivers a list of
158
167
  # user's bookmarks in 'refworks marc txt' format -- we tell refworks
159
- # to expect that format.
168
+ # to expect that format.
160
169
  def bookmarks_export_url(format, params = {})
161
- bookmarks_url(params.merge(format: format, encrypted_user_id: encrypt_user_id(current_or_guest_user.id) ))
170
+ bookmarks_url(params.merge(format: format, encrypted_user_id: encrypt_user_id(current_or_guest_user.id)))
162
171
  end
163
172
  end