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
@@ -1,19 +1,45 @@
1
1
  # frozen_string_literal: true
2
- describe BlacklightHelper do
3
- before(:each) do
2
+ RSpec.describe BlacklightHelper do
3
+ before do
4
4
  allow(helper).to receive(:current_or_guest_user).and_return(User.new)
5
5
  allow(helper).to receive(:search_action_path) do |*args|
6
6
  search_catalog_url *args
7
7
  end
8
8
  end
9
9
 
10
- describe "#application_name", :test => true do
10
+ describe "#application_name" do
11
+ before do
12
+ allow(Rails).to receive(:cache).and_return(ActiveSupport::Cache::NullStore.new)
13
+ end
14
+
11
15
  it "defaults to 'Blacklight'" do
12
16
  expect(application_name).to eq "Blacklight"
13
17
  end
14
- it "uses the Rails application config application_name if available" do
15
- allow(Rails.application).to receive(:config).and_return(double(application_name: "asdf"))
16
- expect(application_name).to eq "asdf"
18
+
19
+ context "when the language is not english " do
20
+ around do |example|
21
+ I18n.locale = :de
22
+ example.run
23
+ I18n.locale = :en
24
+ end
25
+
26
+ context "and no translation exists for that language" do
27
+ it "defaults to 'Blacklight'" do
28
+ expect(application_name).to eq "Blacklight"
29
+ end
30
+ end
31
+
32
+ context "and a translation exists for that language" do
33
+ around do |example|
34
+ I18n.backend.store_translations(:de, 'blacklight' => { 'application_name' => 'Schwarzlicht' })
35
+ example.run
36
+ I18n.backend.reload!
37
+ end
38
+
39
+ it "uses the provided value" do
40
+ expect(application_name).to eq "Schwarzlicht"
41
+ end
42
+ end
17
43
  end
18
44
  end
19
45
 
@@ -34,10 +60,11 @@ describe BlacklightHelper do
34
60
  describe "render_link_rel_alternates" do
35
61
  let(:document) { instance_double(SolrDocument) }
36
62
  let(:result) { double }
37
- let(:presenter) { Blacklight::DocumentPresenter.new(document, self) }
63
+ let(:view_context) { double(blacklight_config: blacklight_config, document_index_view_type: 'index') }
64
+ let(:presenter) { Blacklight::IndexPresenter.new(document, view_context) }
38
65
  let(:blacklight_config) do
39
66
  Blacklight::Configuration.new.configure do |config|
40
- config.index.title_field = 'title_display'
67
+ config.index.title_field = 'title_tsim'
41
68
  config.index.display_type_field = 'format'
42
69
  end
43
70
  end
@@ -61,11 +88,11 @@ describe BlacklightHelper do
61
88
  describe "with a config" do
62
89
  let(:config) do
63
90
  Blacklight::Configuration.new.configure do |config|
64
- config.index.title_field = 'title_display'
91
+ config.index.title_field = 'title_tsim'
65
92
  config.index.display_type_field = 'format'
66
93
  end
67
94
  end
68
- let(:document) { SolrDocument.new('title_display' => "A Fake Document", 'id'=>'8') }
95
+ let(:document) { SolrDocument.new('title_tsim' => "A Fake Document", 'id' => '8') }
69
96
 
70
97
  before do
71
98
  config.add_show_tools_partial(:bookmark, partial: 'catalog/bookmark_control')
@@ -78,7 +105,7 @@ describe BlacklightHelper do
78
105
  describe "render_nav_actions" do
79
106
  it "renders partials" do
80
107
  buff = String.new
81
- helper.render_nav_actions { |config, item| buff << "<foo>#{item}</foo>" }
108
+ helper.render_nav_actions { |_config, item| buff << "<foo>#{item}</foo>" }
82
109
  expect(buff).to have_selector "foo a#bookmarks_nav[href=\"/bookmarks\"]"
83
110
  expect(buff).to have_selector "foo a span[data-role='bookmark-counter']", text: '0'
84
111
  end
@@ -88,7 +115,7 @@ describe BlacklightHelper do
88
115
  it "renders partials" do
89
116
  allow(controller).to receive(:render_bookmarks_control?).and_return(true)
90
117
  response = helper.render_index_doc_actions(document)
91
- expect(response).to have_selector(".bookmark_toggle")
118
+ expect(response).to have_selector(".bookmark-toggle")
92
119
  end
93
120
 
94
121
  it "is nil if no partials are renderable" do
@@ -106,7 +133,7 @@ describe BlacklightHelper do
106
133
  describe "render_show_doc_actions" do
107
134
  it "renders partials" do
108
135
  response = helper.render_show_doc_actions(document)
109
- expect(response).to have_selector(".bookmark_toggle")
136
+ expect(response).to have_selector(".bookmark-toggle")
110
137
  end
111
138
  end
112
139
  end
@@ -117,15 +144,18 @@ describe BlacklightHelper do
117
144
  end
118
145
 
119
146
  it "is true" do
147
+ expect(Deprecation).to receive(:warn)
120
148
  expect(helper.should_render_index_field?(double, double)).to be true
121
149
  end
122
150
 
123
151
  it "is false if the document doesn't have a value for the field" do
152
+ expect(Deprecation).to receive(:warn)
124
153
  allow(helper).to receive_messages(document_has_value?: false)
125
154
  expect(helper.should_render_index_field?(double, double)).to be false
126
155
  end
127
156
 
128
157
  it "is false if the configuration has the field disabled" do
158
+ expect(Deprecation).to receive(:warn)
129
159
  allow(helper).to receive_messages(should_render_field?: false)
130
160
  expect(helper.should_render_index_field?(double, double)).to be false
131
161
  end
@@ -137,81 +167,43 @@ describe BlacklightHelper do
137
167
  end
138
168
 
139
169
  it "is true" do
170
+ expect(Deprecation).to receive(:warn)
140
171
  expect(helper.should_render_show_field?(double, double)).to be true
141
172
  end
142
173
 
143
174
  it "is false if the document doesn't have a value for the field" do
175
+ expect(Deprecation).to receive(:warn)
144
176
  allow(helper).to receive_messages(document_has_value?: false)
145
177
  expect(helper.should_render_show_field?(double, double)).to be false
146
178
  end
147
179
 
148
180
  it "is false if the configuration has the field disabled" do
181
+ expect(Deprecation).to receive(:warn)
149
182
  allow(helper).to receive_messages(should_render_field?: false)
150
183
  expect(helper.should_render_show_field?(double, double)).to be false
151
184
  end
152
185
  end
153
186
 
154
- context "render methods" do
155
- let(:field) { "some_field" }
156
- let(:doc) { instance_double(SolrDocument) }
157
- let(:presenter) { instance_double(Blacklight::ShowPresenter) }
158
- before do
159
- allow(Deprecation).to receive(:warn) # TODO: purge Deprecations
160
- allow(helper).to receive(:presenter).with(doc).and_return(presenter)
161
- end
162
-
163
- describe "#render_index_field_value" do
164
- it "passes the document and field through to the presenter" do
165
- expect(presenter).to receive(:field_value).with(field, {})
166
- helper.render_index_field_value(doc, field)
167
- end
168
-
169
- it "allows the document and field to be passed as hash arguments" do
170
- expect(presenter).to receive(:field_value).with(field, {})
171
- helper.render_index_field_value(document: doc, field: field)
172
- end
173
-
174
- it "allows additional options to be passed to the presenter" do
175
- expect(presenter).to receive(:field_value).with(field, x: 1)
176
- helper.render_index_field_value(document: doc, field: field, x: 1)
177
- end
178
- end
179
-
180
- describe "#render_document_show_field_value" do
181
- it "passes the document and field through to the presenter" do
182
- expect(presenter).to receive(:field_value).with(field, {})
183
- helper.render_document_show_field_value(doc, field)
184
- end
185
-
186
- it "allows the document and field to be passed as hash arguments" do
187
- expect(presenter).to receive(:field_value).with(field, {})
188
- helper.render_document_show_field_value(document: doc, field: field)
189
- end
190
-
191
- it "allows additional options to be passed to the presenter" do
192
- expect(presenter).to receive(:field_value).with(field, x: 1)
193
- helper.render_document_show_field_value(document: doc, field: field, x: 1)
194
- end
195
- end
196
- end
197
-
198
187
  describe "#document_has_value?" do
199
188
  let(:doc) { double(SolrDocument) }
189
+
190
+ before { allow(Deprecation).to receive(:warn) }
191
+
200
192
  it "ifs the document has the field value" do
201
193
  allow(doc).to receive(:has?).with('asdf').and_return(true)
202
- field_config = double(:field => 'asdf')
194
+ field_config = double(field: 'asdf')
203
195
  expect(helper.document_has_value?(doc, field_config)).to eq true
204
196
  end
205
197
  it "ifs the document has a highlight field value" do
206
198
  allow(doc).to receive(:has?).with('asdf').and_return(false)
207
199
  allow(doc).to receive(:has_highlight_field?).with('asdf').and_return(true)
208
- field_config = double(:field => 'asdf', :highlight => true)
200
+ field_config = double(field: 'asdf', highlight: true)
209
201
  expect(helper.document_has_value?(doc, field_config)).to eq true
210
202
  end
211
203
  it "ifs the field has a model accessor" do
212
204
  allow(doc).to receive(:has?).with('asdf').and_return(false)
213
205
  allow(doc).to receive(:has_highlight_field?).with('asdf').and_return(false)
214
- field_config = double(:field => 'asdf', :highlight => true, :accessor => true)
206
+ field_config = double(field: 'asdf', highlight: true, accessor: true)
215
207
  expect(helper.document_has_value?(doc, field_config)).to eq true
216
208
  end
217
209
  end
@@ -236,99 +228,28 @@ describe BlacklightHelper do
236
228
  before do
237
229
  allow(helper).to receive_messages spell_check_max: 5
238
230
  end
231
+
239
232
  it "does not show suggestions if there are enough results" do
240
233
  response = double(total: 10)
241
- expect(helper.should_show_spellcheck_suggestions? response).to be false
234
+ expect(helper.should_show_spellcheck_suggestions?(response)).to be false
242
235
  end
243
236
  it "only shows suggestions if there are very few results" do
244
237
  response = double(total: 4, spelling: double(words: [1]))
245
- expect(helper.should_show_spellcheck_suggestions? response).to be true
238
+ expect(helper.should_show_spellcheck_suggestions?(response)).to be true
246
239
  end
247
240
  it "shows suggestions only if there are spelling suggestions available" do
248
241
  response = double(total: 4, spelling: double(words: []))
249
- expect(helper.should_show_spellcheck_suggestions? response).to be false
242
+ expect(helper.should_show_spellcheck_suggestions?(response)).to be false
250
243
  end
251
244
  it "does not show suggestions if spelling is not available" do
252
245
  response = double(total: 4, spelling: nil)
253
- expect(helper.should_show_spellcheck_suggestions? response).to be false
254
- end
255
- end
256
-
257
- describe "#render_document_partials" do
258
- let(:doc) { double }
259
- before do
260
- allow(helper).to receive_messages(document_partial_path_templates: [])
261
- allow(helper).to receive_messages(document_index_view_type: 'index_header')
262
- end
263
-
264
- it "gets the document format from document_partial_name" do
265
- allow(helper).to receive(:document_partial_name).with(doc, :xyz)
266
- helper.render_document_partial(doc, :xyz)
267
- end
268
- end
269
-
270
- describe "#document_partial_name" do
271
- let(:blacklight_config) { Blacklight::Configuration.new }
272
- before do
273
- allow(helper).to receive_messages(blacklight_config: blacklight_config)
274
- end
275
-
276
- context "with a solr document with empty fields" do
277
- let(:document) { SolrDocument.new }
278
- it "is the default value" do
279
- expect(helper.document_partial_name(document)).to eq 'default'
280
- end
281
- end
282
-
283
- context "with a solr document with the display type field set" do
284
- let(:document) { SolrDocument.new 'my_field' => 'xyz'}
285
- before do
286
- blacklight_config.show.display_type_field = 'my_field'
287
- end
288
-
289
- it "uses the value in the configured display type field" do
290
- expect(helper.document_partial_name(document)).to eq 'xyz'
291
- end
292
- it "uses the value in the configured display type field if the action-specific field is empty" do
293
- expect(helper.document_partial_name(document, :some_action)).to eq 'xyz'
294
- end
295
- end
296
-
297
- context "with a solr doucment with an action-specific field set" do
298
- let(:document) { SolrDocument.new 'my_field' => 'xyz', 'other_field' => 'abc' }
299
- before do
300
- blacklight_config.show.media_display_type_field = 'my_field'
301
- blacklight_config.show.metadata_display_type_field = 'other_field'
302
- end
303
- it "uses the value in the action-specific fields" do
304
- expect(helper.document_partial_name(document, :media)).to eq 'xyz'
305
- expect(helper.document_partial_name(document, :metadata)).to eq 'abc'
306
- end
307
- end
308
- end
309
-
310
- describe "#type_field_to_partial_name" do
311
- let(:document) { double }
312
- context "with default value" do
313
- subject { helper.type_field_to_partial_name(document, 'default') }
314
- it { should eq 'default' }
315
- end
316
- context "with spaces" do
317
- subject { helper.type_field_to_partial_name(document, 'one two three') }
318
- it { should eq 'one_two_three' }
319
- end
320
- context "with hyphens" do
321
- subject { helper.type_field_to_partial_name(document, 'one-two-three') }
322
- it { should eq 'one_two_three' }
323
- end
324
- context "an array" do
325
- subject { helper.type_field_to_partial_name(document, ['one', 'two', 'three']) }
326
- it { should eq 'one_two_three' }
246
+ expect(helper.should_show_spellcheck_suggestions?(response)).to be false
327
247
  end
328
248
  end
329
249
 
330
250
  describe "#opensearch_description_tag" do
331
251
  subject { helper.opensearch_description_tag 'title', 'href' }
252
+
332
253
  it "has a search rel" do
333
254
  expect(subject).to have_selector "link[rel='search']", visible: false
334
255
  end
@@ -353,6 +274,7 @@ describe BlacklightHelper do
353
274
 
354
275
  describe "#render_document_index_with_view" do
355
276
  let(:obj1) { SolrDocument.new }
277
+
356
278
  before do
357
279
  allow(helper).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
358
280
  assign(:response, instance_double(Blacklight::Solr::Response, grouped?: false, start: 0))
@@ -413,23 +335,11 @@ describe BlacklightHelper do
413
335
  context "related classes" do
414
336
  let(:presenter_class) { double }
415
337
  let(:blacklight_config) { Blacklight::Configuration.new }
338
+
416
339
  before do
417
340
  allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
418
341
  end
419
342
 
420
- describe "#presenter_class" do
421
- it "uses the value defined in the blacklight configuration" do
422
- expect(Deprecation).to receive(:warn).exactly(2).times
423
- blacklight_config.document_presenter_class = presenter_class
424
- expect(helper.presenter_class).to eq presenter_class
425
- end
426
-
427
- it "defaults to Blacklight::DocumentPresenter" do
428
- expect(Deprecation).to receive(:warn)
429
- expect(helper.presenter_class).to eq Blacklight::DocumentPresenter
430
- end
431
- end
432
-
433
343
  describe "#index_presenter_class" do
434
344
  it "uses the value defined in the blacklight configuration" do
435
345
  blacklight_config.index.document_presenter_class = presenter_class
@@ -455,6 +365,7 @@ describe BlacklightHelper do
455
365
 
456
366
  describe "#render_document_heading" do
457
367
  let(:document) { double }
368
+
458
369
  before do
459
370
  allow(helper).to receive(:presenter).and_return(double(heading: "Heading"))
460
371
  end
@@ -464,7 +375,7 @@ describe BlacklightHelper do
464
375
  end
465
376
 
466
377
  it "accepts the tag name as an option" do
467
- expect(helper.render_document_heading tag: "h1").to have_selector "h1", text: "Heading"
378
+ expect(helper.render_document_heading(tag: "h1")).to have_selector "h1", text: "Heading"
468
379
  end
469
380
 
470
381
  it "accepts an explicit document argument" do
@@ -477,4 +388,46 @@ describe BlacklightHelper do
477
388
  expect(helper.render_document_heading(document, tag: "h3")).to have_selector "h3", text: "Document Heading"
478
389
  end
479
390
  end
391
+
392
+ describe "#presenter" do
393
+ let(:document) { double }
394
+
395
+ before do
396
+ allow(helper).to receive(:index_presenter).and_return(:index_presenter)
397
+ allow(helper).to receive(:show_presenter).and_return(:show_presenter)
398
+ allow(helper).to receive(:action_name).and_return(action_name)
399
+ end
400
+
401
+ context "action is show" do
402
+ let(:action_name) { "show" }
403
+
404
+ it "uses the show presenter" do
405
+ expect(helper.presenter(document)).to eq(:show_presenter)
406
+ end
407
+ end
408
+
409
+ context "action is citation" do
410
+ let(:action_name) { "citation" }
411
+
412
+ it "uses the show presenter" do
413
+ expect(helper.presenter(document)).to eq(:show_presenter)
414
+ end
415
+ end
416
+
417
+ context "action is index" do
418
+ let(:action_name) { "index" }
419
+
420
+ it "uses the index presenter" do
421
+ expect(helper.presenter(document)).to eq(:index_presenter)
422
+ end
423
+ end
424
+
425
+ context "action is foo" do
426
+ let(:action_name) { "foo" }
427
+
428
+ it "uses the index presenter (by default)" do
429
+ expect(helper.presenter(document)).to eq(:index_presenter)
430
+ end
431
+ end
432
+ end
480
433
  end
@@ -1,8 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- describe CatalogHelper do
3
+ RSpec.describe CatalogHelper do
4
4
  include ERB::Util
5
- include CatalogHelper
5
+ include described_class
6
6
 
7
7
  def mock_response args
8
8
  current_page = args[:current_page] || 1
@@ -22,18 +22,17 @@ describe CatalogHelper do
22
22
  false
23
23
  end
24
24
 
25
-
26
25
  describe "page_entries_info" do
27
26
  it "with no results" do
28
- @response = mock_response :total => 0
27
+ @response = mock_response total: 0
29
28
 
30
- html = page_entries_info(@response, { :entry_name => 'entry_name' })
29
+ html = page_entries_info(@response, entry_name: 'entry_name')
31
30
  expect(html).to eq "No entry_names found"
32
31
  expect(html).to be_html_safe
33
32
  end
34
33
 
35
34
  it "with no results (and no entry_name provided)" do
36
- @response = mock_response :total => 0
35
+ @response = mock_response total: 0
37
36
 
38
37
  html = page_entries_info(@response)
39
38
  expect(html).to eq "No entries found"
@@ -49,81 +48,74 @@ describe CatalogHelper do
49
48
 
50
49
  describe "with a single result" do
51
50
  it "uses the provided entry name" do
52
- response = mock_response :total => 1
51
+ response = mock_response total: 1
53
52
 
54
- html = page_entries_info(response, { :entry_name => 'entry_name' })
53
+ html = page_entries_info(response, entry_name: 'entry_name')
55
54
  expect(html).to eq "<strong>1</strong> entry_name found"
56
55
  expect(html).to be_html_safe
57
56
  end
58
57
 
59
58
  it "infers a name" do
60
- response = mock_response :total => 1
59
+ response = mock_response total: 1
61
60
 
62
61
  html = page_entries_info(response)
63
62
  expect(html).to eq "<strong>1</strong> entry found"
64
63
  expect(html).to be_html_safe
65
64
  end
66
-
67
- it "uses the model_name from the response" do
68
- response = mock_response :total => 1
69
- allow(response).to receive(:model_name).and_return(double(:human => 'thingy'))
70
-
71
- html = page_entries_info(response)
72
- expect(html).to eq "<strong>1</strong> thingy found"
73
- expect(html).to be_html_safe
74
- end
75
65
  end
76
66
 
77
67
  it "with a single page of results" do
78
- response = mock_response :total => 7
68
+ response = mock_response total: 7
79
69
 
80
- html = page_entries_info(response, { :entry_name => 'entry_name' })
70
+ html = page_entries_info(response, entry_name: 'entry_name')
81
71
  expect(html).to eq "<strong>1</strong> - <strong>7</strong> of <strong>7</strong>"
82
72
  expect(html).to be_html_safe
83
73
  end
84
74
 
85
75
  it "on the first page of multiple pages of results" do
86
- @response = mock_response :total => 15, :per_page => 10
76
+ @response = mock_response total: 15, per_page: 10
87
77
 
88
- html = page_entries_info(@response, { :entry_name => 'entry_name' })
78
+ html = page_entries_info(@response, entry_name: 'entry_name')
89
79
  expect(html).to eq "<strong>1</strong> - <strong>10</strong> of <strong>15</strong>"
90
80
  expect(html).to be_html_safe
91
81
  end
92
82
 
93
83
  it "on the second page of multiple pages of results" do
94
- @response = mock_response :total => 47, :per_page => 10, :current_page => 2
84
+ @response = mock_response total: 47, per_page: 10, current_page: 2
95
85
 
96
- html = page_entries_info(@response, { :entry_name => 'entry_name' })
86
+ html = page_entries_info(@response, entry_name: 'entry_name')
97
87
  expect(html).to eq "<strong>11</strong> - <strong>20</strong> of <strong>47</strong>"
98
88
  expect(html).to be_html_safe
99
89
  end
100
90
 
101
91
  it "on the last page of results" do
102
- @response = mock_response :total => 47, :per_page => 10, :current_page => 5
92
+ @response = mock_response total: 47, per_page: 10, current_page: 5
103
93
 
104
- html = page_entries_info(@response, { :entry_name => 'entry_name' })
94
+ html = page_entries_info(@response, entry_name: 'entry_name')
105
95
  expect(html).to eq "<strong>41</strong> - <strong>47</strong> of <strong>47</strong>"
106
96
  expect(html).to be_html_safe
107
97
  end
108
98
  it "works with rows the same as per_page" do
109
- @response = mock_response :total => 47, :rows => 20, :current_page => 2
99
+ @response = mock_response total: 47, rows: 20, current_page: 2
110
100
 
111
- html = page_entries_info(@response, { :entry_name => 'entry_name' })
101
+ html = page_entries_info(@response, entry_name: 'entry_name')
112
102
  expect(html).to eq "<strong>21</strong> - <strong>40</strong> of <strong>47</strong>"
113
103
  expect(html).to be_html_safe
114
104
  end
115
105
 
116
106
  it "uses delimiters with large numbers" do
117
- @response = mock_response :total => 5000, :rows => 10, :current_page => 101
118
- html = page_entries_info(@response, { :entry_name => 'entry_name' })
107
+ @response = mock_response total: 5000, rows: 10, current_page: 101
108
+ html = page_entries_info(@response, entry_name: 'entry_name')
119
109
 
120
110
  expect(html).to eq "<strong>1,001</strong> - <strong>1,010</strong> of <strong>5,000</strong>"
121
111
  end
122
112
 
123
113
  context "with an ActiveRecord collection" do
114
+ subject { helper.page_entries_info(Bookmark.page(1).per(25)) }
115
+
124
116
  let(:user) { User.create! email: 'xyz@example.com', password: 'xyz12345' }
117
+
125
118
  before { 50.times { Bookmark.create!(user: user) } }
126
- subject { helper.page_entries_info(Bookmark.page(1).per(25)) }
127
119
 
128
120
  it { is_expected.to eq "<strong>1</strong> - <strong>25</strong> of <strong>50</strong>" }
129
121
  end
@@ -174,6 +166,10 @@ describe CatalogHelper do
174
166
  end
175
167
 
176
168
  describe "should_autofocus_on_search_box?" do
169
+ before do
170
+ expect(Deprecation).to receive(:warn)
171
+ end
172
+
177
173
  it "is focused if we're on a catalog-like index page without query or facet parameters" do
178
174
  allow(helper).to receive_messages(controller: CatalogController.new, action_name: "index", has_search_parameters?: false)
179
175
  expect(helper.should_autofocus_on_search_box?).to be true
@@ -196,102 +192,81 @@ describe CatalogHelper do
196
192
  end
197
193
 
198
194
  describe "has_thumbnail?" do
199
- let(:document) { instance_double(SolrDocument) }
195
+ before do
196
+ expect(Deprecation).to receive(:warn)
197
+ end
198
+
199
+ let(:document) { SolrDocument.new(data) }
200
+ let(:data) { {} }
201
+
200
202
  it "has a thumbnail if a thumbnail_method is configured" do
201
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
202
- expect(helper.has_thumbnail? document).to be true
203
+ allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_method: :xyz, document_presenter_class: Blacklight::IndexPresenter)))
204
+ expect(helper.has_thumbnail?(document)).to be true
203
205
  end
204
206
 
205
- it "has a thumbnail if a thumbnail_field is configured and it exists in the document" do
206
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
207
- allow(document).to receive_messages(has?: true)
208
- expect(helper.has_thumbnail? document).to be true
207
+ context "if a thumbnail_field is configured and it exists in the document" do
208
+ let(:data) { { xyz: 'abc' } }
209
+
210
+ it "has a thumbnail" do
211
+ allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz, document_presenter_class: Blacklight::IndexPresenter)))
212
+ expect(helper.has_thumbnail?(document)).to be true
213
+ end
209
214
  end
210
-
215
+
211
216
  it "does not have a thumbnail if the thumbnail_field is missing from the document" do
212
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
217
+ allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz, document_presenter_class: Blacklight::IndexPresenter)))
213
218
  allow(document).to receive_messages(has?: false)
214
- expect(helper.has_thumbnail? document).to be false
219
+ expect(helper.has_thumbnail?(document)).to be false
215
220
  end
216
221
 
217
222
  it "does not have a thumbnail if none of the fields are configured" do
218
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new() ))
219
- expect(helper.has_thumbnail? document).to be_falsey
223
+ allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(document_presenter_class: Blacklight::IndexPresenter)))
224
+ expect(helper).not_to have_thumbnail(document)
220
225
  end
221
226
  end
222
227
 
223
228
  describe "render_thumbnail_tag" do
224
- let(:document) { instance_double(SolrDocument) }
225
- it "calls the provided thumbnail method" do
226
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
227
- expect(helper).to receive_messages(:xyz => "some-thumbnail")
228
-
229
- allow(helper).to receive(:link_to_document).with(document, "some-thumbnail", {})
230
- helper.render_thumbnail_tag document
229
+ let(:index_presenter) do
230
+ instance_double(Blacklight::IndexPresenter, thumbnail: thumbnail_presenter)
231
231
  end
232
+ let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter) }
232
233
 
233
- it "creates an image tag from the given field" do
234
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
235
-
236
- allow(document).to receive(:has?).with(:xyz).and_return(true)
237
- allow(document).to receive(:first).with(:xyz).and_return("http://example.com/some.jpg")
238
-
239
- expect(helper).to receive(:link_to_document).with(document, image_tag("http://example.com/some.jpg"), {})
240
- helper.render_thumbnail_tag document
241
- end
242
-
243
- it "does not link to the document if the url options are false" do
244
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
245
- allow(helper).to receive_messages(:xyz => "some-thumbnail")
234
+ before do
246
235
  expect(Deprecation).to receive(:warn)
247
- result = helper.render_thumbnail_tag document, {}, false
248
- expect(result).to eq "some-thumbnail"
249
- end
250
-
251
- it "does not link to the document if the url options have :suppress_link" do
252
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
253
- allow(helper).to receive_messages(:xyz => "some-thumbnail")
254
-
255
- result = helper.render_thumbnail_tag document, {}, suppress_link: true
256
- expect(result).to eq "some-thumbnail"
236
+ allow(helper).to receive(:index_presenter).with(document).and_return(index_presenter)
257
237
  end
258
238
 
239
+ let(:document) { instance_double(SolrDocument) }
259
240
 
260
- it "returns nil if no thumbnail is available" do
261
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new() ))
262
- expect(helper.render_thumbnail_tag document).to be_nil
263
- end
264
-
265
- it "returns nil if no thumbnail is returned from the thumbnail method" do
266
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
267
- allow(helper).to receive_messages(:xyz => nil)
268
-
269
- expect(helper.render_thumbnail_tag document).to be_nil
241
+ it "calls thumbnail presenter with default values" do
242
+ expect(thumbnail_presenter).to receive(:thumbnail_tag).with({}, {})
243
+ helper.render_thumbnail_tag document
270
244
  end
271
245
 
272
- it "returns nil if no thumbnail is in the document" do
273
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
274
-
275
- allow(document).to receive(:has?).with(:xyz).and_return(false)
276
-
277
- expect(helper.render_thumbnail_tag document).to be_nil
246
+ it "calls thumbnail presenter with provided values" do
247
+ expect(thumbnail_presenter).to receive(:thumbnail_tag).with({}, suppress_link: true)
248
+ helper.render_thumbnail_tag document, {}, suppress_link: true
278
249
  end
279
250
  end
280
251
 
281
252
  describe "thumbnail_url" do
253
+ before do
254
+ expect(Deprecation).to receive(:warn)
255
+ end
256
+
282
257
  it "pulls the configured thumbnail field out of the document" do
283
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
258
+ allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz)))
284
259
  document = instance_double(SolrDocument)
285
260
  allow(document).to receive(:has?).with(:xyz).and_return(true)
286
261
  allow(document).to receive(:first).with(:xyz).and_return("asdf")
287
- expect(helper.thumbnail_url document).to eq("asdf")
262
+ expect(helper.thumbnail_url(document)).to eq("asdf")
288
263
  end
289
264
 
290
265
  it "returns nil if the thumbnail field doesn't exist" do
291
- allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
266
+ allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz)))
292
267
  document = instance_double(SolrDocument)
293
268
  allow(document).to receive(:has?).with(:xyz).and_return(false)
294
- expect(helper.thumbnail_url document).to be_nil
269
+ expect(helper.thumbnail_url(document)).to be_nil
295
270
  end
296
271
  end
297
272
 
@@ -325,38 +300,37 @@ describe CatalogHelper do
325
300
 
326
301
  it "pulls data out of a document's field" do
327
302
  blacklight_config.index.display_type_field = :type
328
- doc = { :type => 'book' }
303
+ doc = { type: 'book' }
329
304
  expect(helper.render_document_class(doc)).to eq "blacklight-book"
330
305
  end
331
306
 
332
307
  it "supports multivalued fields" do
333
308
  blacklight_config.index.display_type_field = :type
334
- doc = { :type => ['book', 'mss'] }
309
+ doc = { type: %w[book mss] }
335
310
  expect(helper.render_document_class(doc)).to eq "blacklight-book blacklight-mss"
336
311
  end
337
312
 
338
313
  it "supports empty fields" do
339
314
  blacklight_config.index.display_type_field = :type
340
- doc = { :type => [] }
315
+ doc = { type: [] }
341
316
  expect(helper.render_document_class(doc)).to be_blank
342
317
  end
343
318
 
344
319
  it "supports missing fields" do
345
320
  blacklight_config.index.display_type_field = :type
346
- doc = { }
321
+ doc = {}
347
322
  expect(helper.render_document_class(doc)).to be_blank
348
323
  end
349
324
 
350
325
  it "supports view-specific field configuration" do
351
326
  allow(helper).to receive(:document_index_view_type).and_return(:some_view_type)
352
327
  blacklight_config.view.some_view_type.display_type_field = :other_type
353
- doc = { other_type: "document"}
328
+ doc = { other_type: "document" }
354
329
  expect(helper.render_document_class(doc)).to eq "blacklight-document"
355
330
  end
356
331
  end
357
332
 
358
333
  describe "#bookmarked?" do
359
-
360
334
  let(:bookmark) { Bookmark.new document: bookmarked_document }
361
335
  let(:bookmarked_document) { SolrDocument.new(id: 'a') }
362
336
 
@@ -387,25 +361,35 @@ describe CatalogHelper do
387
361
  end
388
362
 
389
363
  it "renders a facet with two values" do
390
- expect(helper.render_search_to_page_title_filter('foo', ['bar', 'baz'])).to eq "Foo: bar and baz"
364
+ expect(helper.render_search_to_page_title_filter('foo', %w[bar baz])).to eq "Foo: bar and baz"
391
365
  end
392
366
 
393
367
  it "renders a facet with more than two values" do
394
- expect(helper.render_search_to_page_title_filter('foo', ['bar', 'baz', 'foobar'])).to eq "Foo: 3 selected"
368
+ expect(helper.render_search_to_page_title_filter('foo', %w[bar baz foobar])).to eq "Foo: 3 selected"
395
369
  end
396
370
  end
397
371
 
398
372
  describe "#render_search_to_page_title" do
373
+ subject { helper.render_search_to_page_title(params) }
374
+
399
375
  before do
400
376
  allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
401
- allow(helper).to receive(:default_search_field).and_return(Blacklight::Configuration::SearchField.new(:key => 'default_search_field', :display_label => 'Default'))
377
+ allow(helper).to receive(:default_search_field).and_return(Blacklight::Configuration::SearchField.new(key: 'default_search_field', display_label: 'Default'))
402
378
  allow(helper).to receive(:label_for_search_field).with(nil).and_return('')
403
379
  end
404
380
 
405
381
  let(:blacklight_config) { Blacklight::Configuration.new }
406
- let(:params) { ActionController::Parameters.new(q: 'foobar', f: { format: ["Book"] }) }
407
- subject { helper.render_search_to_page_title(params) }
408
382
 
409
- it { is_expected.to eq "foobar / Format: Book" }
383
+ context 'when the f param is an array' do
384
+ let(:params) { ActionController::Parameters.new(q: 'foobar', f: { format: ["Book"] }) }
385
+
386
+ it { is_expected.to eq "foobar / Format: Book" }
387
+ end
388
+
389
+ context 'when the f param is not an array' do
390
+ let(:params) { ActionController::Parameters.new(q: 'foobar', f: { format: 'Book' }) }
391
+
392
+ it { is_expected.to eq "foobar / Format: Book" }
393
+ end
410
394
  end
411
395
  end