blacklight 6.20.0 → 7.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/.jshintrc +3 -1
- data/.npmignore +23 -0
- data/.rubocop.yml +40 -16
- data/.rubocop_todo.yml +478 -382
- data/.travis.yml +28 -31
- data/CONTRIBUTING.md +50 -0
- data/Gemfile +5 -2
- data/README.md +22 -5
- data/Rakefile +3 -2
- data/VERSION +1 -1
- data/Vagrantfile +2 -0
- data/app/assets/images/blacklight/list.svg +1 -0
- data/app/assets/images/blacklight/search.svg +1 -0
- data/app/assets/javascripts/blacklight/blacklight.js +495 -57
- data/app/assets/stylesheets/blacklight/_balanced_list.scss +7 -12
- data/app/assets/stylesheets/blacklight/_blacklight_base.scss +18 -15
- data/app/assets/stylesheets/blacklight/_bookmark.scss +1 -13
- data/app/assets/stylesheets/blacklight/_bootstrap_overrides.scss +31 -0
- data/app/assets/stylesheets/blacklight/_constraints.scss +17 -25
- data/app/assets/stylesheets/blacklight/_controls.scss +8 -16
- data/app/assets/stylesheets/blacklight/_facets.scss +66 -92
- data/app/assets/stylesheets/blacklight/_header.scss +60 -47
- data/app/assets/stylesheets/blacklight/_icons.scss +35 -0
- data/app/assets/stylesheets/blacklight/_layout.scss +0 -10
- data/app/assets/stylesheets/blacklight/_mixins.scss +15 -0
- data/app/assets/stylesheets/blacklight/_modal.scss +9 -17
- data/app/assets/stylesheets/blacklight/_pagination.scss +4 -13
- data/app/assets/stylesheets/blacklight/_search_form.scss +7 -0
- data/app/assets/stylesheets/blacklight/_search_history.scss +5 -13
- data/app/assets/stylesheets/blacklight/_search_results.scss +9 -8
- data/app/assets/stylesheets/blacklight/_twitter_typeahead.scss +1 -2
- data/app/assets/stylesheets/blacklight/blacklight.scss +1 -1
- data/app/builders/blacklight/action_builder.rb +57 -0
- data/app/controllers/bookmarks_controller.rb +2 -2
- data/app/controllers/catalog_controller.rb +2 -2
- data/app/controllers/concerns/blacklight/base.rb +0 -33
- data/app/controllers/concerns/blacklight/bookmarks.rb +20 -30
- data/app/controllers/concerns/blacklight/catalog.rb +256 -210
- data/app/controllers/concerns/blacklight/controller.rb +102 -124
- data/app/controllers/concerns/blacklight/default_component_configuration.rb +12 -43
- data/app/controllers/concerns/blacklight/facet.rb +22 -8
- data/app/controllers/concerns/blacklight/search_context.rb +11 -11
- data/app/controllers/concerns/blacklight/search_fields.rb +4 -14
- data/app/controllers/concerns/blacklight/search_history.rb +1 -6
- data/app/controllers/concerns/blacklight/searchable.rb +17 -0
- data/app/controllers/concerns/blacklight/token_based_user.rb +5 -7
- data/app/helpers/blacklight/blacklight_helper_behavior.rb +37 -119
- data/app/helpers/blacklight/catalog_helper_behavior.rb +103 -93
- data/app/helpers/blacklight/component_helper_behavior.rb +21 -21
- data/app/helpers/blacklight/configuration_helper_behavior.rb +30 -58
- data/app/helpers/blacklight/facets_helper_behavior.rb +79 -54
- data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb +9 -11
- data/app/helpers/blacklight/icon_helper_behavior.rb +18 -0
- data/app/helpers/blacklight/layout_helper_behavior.rb +3 -3
- data/app/helpers/blacklight/render_constraints_helper_behavior.rb +8 -6
- data/app/helpers/blacklight/render_partials_helper_behavior.rb +207 -0
- data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb +19 -11
- data/app/helpers/blacklight/suggest_helper_behavior.rb +1 -0
- data/app/helpers/blacklight/url_helper_behavior.rb +51 -42
- data/app/{assets/javascripts → javascript}/blacklight/autocomplete.js +3 -2
- data/app/javascript/blacklight/bookmark_toggle.js +25 -0
- data/app/javascript/blacklight/button_focus.js +9 -0
- data/app/javascript/blacklight/checkbox_submit.js +134 -0
- data/app/javascript/blacklight/core.js +41 -0
- data/app/javascript/blacklight/facet_load.js +22 -0
- data/app/{assets/javascripts/blacklight/ajax_modal.js → javascript/blacklight/modal.js} +62 -64
- data/app/javascript/blacklight/search_context.js +67 -0
- data/app/models/blacklight/facet_paginator.rb +3 -3
- data/app/models/blacklight/icon.rb +79 -0
- data/app/models/blacklight/suggest_search.rb +1 -1
- data/app/models/bookmark.rb +5 -10
- data/app/models/concerns/blacklight/configurable.rb +13 -13
- data/app/models/concerns/blacklight/document.rb +23 -39
- data/app/models/concerns/blacklight/document/active_model_shim.rb +8 -11
- data/app/models/concerns/blacklight/document/cache_key.rb +1 -1
- data/app/models/concerns/blacklight/document/dublin_core.rb +2 -2
- data/app/models/concerns/blacklight/document/email.rb +5 -5
- data/app/models/concerns/blacklight/document/extensions.rb +5 -5
- data/app/models/concerns/blacklight/document/semantic_fields.rb +9 -9
- data/app/models/concerns/blacklight/document/sms.rb +3 -3
- data/app/models/concerns/blacklight/user.rb +7 -6
- data/app/models/record_mailer.rb +8 -6
- data/app/models/search.rb +5 -7
- data/app/presenters/blacklight/document_presenter.rb +25 -140
- data/app/presenters/blacklight/field_presenter.rb +19 -14
- data/app/presenters/blacklight/index_presenter.rb +43 -71
- data/app/presenters/blacklight/json_presenter.rb +10 -14
- data/app/presenters/blacklight/link_alternate_presenter.rb +3 -1
- data/app/presenters/blacklight/rendering/abstract_step.rb +7 -5
- data/app/presenters/blacklight/rendering/helper_method.rb +10 -8
- data/app/presenters/blacklight/rendering/join.rb +5 -3
- data/app/presenters/blacklight/rendering/link_to_facet.rb +23 -19
- data/app/presenters/blacklight/rendering/microdata.rb +6 -3
- data/app/presenters/blacklight/rendering/pipeline.rb +27 -10
- data/app/presenters/blacklight/rendering/terminator.rb +2 -0
- data/app/presenters/blacklight/search_bar_presenter.rb +41 -0
- data/app/presenters/blacklight/show_presenter.rb +26 -72
- data/app/presenters/blacklight/thumbnail_presenter.rb +74 -0
- data/app/services/blacklight/document_factory.rb +13 -0
- data/app/services/blacklight/field_retriever.rb +26 -24
- data/app/services/blacklight/search_service.rb +153 -0
- data/app/values/blacklight/types.rb +31 -0
- data/app/views/blacklight/nav/_bookmark.html.erb +2 -2
- data/app/views/blacklight/nav/_search_history.html.erb +1 -1
- data/app/views/bookmarks/_tools.html.erb +2 -2
- data/app/views/bookmarks/index.html.erb +12 -13
- data/app/views/catalog/_bookmark_control.html.erb +27 -13
- data/app/views/catalog/_constraints.html.erb +6 -7
- data/app/views/catalog/_constraints_element.html.erb +6 -6
- data/app/views/catalog/_did_you_mean.html.erb +1 -1
- data/app/views/catalog/{_document_default.atom.builder → _document.atom.builder} +20 -19
- data/app/views/catalog/_document.html.erb +5 -3
- data/app/views/catalog/{_document_default.rss.builder → _document.rss.builder} +2 -0
- data/app/views/catalog/_document_action.html.erb +2 -1
- data/app/views/catalog/_email_form.html.erb +8 -4
- data/app/views/catalog/_facet_group.html.erb +19 -0
- data/app/views/catalog/_facet_index_navigation.html.erb +5 -4
- data/app/views/catalog/_facet_layout.html.erb +13 -8
- data/app/views/catalog/_facet_limit.html.erb +3 -2
- data/app/views/catalog/_facet_pagination.html.erb +8 -8
- data/app/views/catalog/_facet_pivot.html.erb +2 -2
- data/app/views/catalog/_facets.html.erb +3 -21
- data/app/views/catalog/_field.json.jbuilder +10 -0
- data/app/views/catalog/{_group_default.html.erb → _group.html.erb} +1 -1
- data/app/views/catalog/_home_text.html.erb +32 -36
- data/app/views/catalog/_index.html.erb +10 -0
- data/app/views/catalog/{_index_header_default.html.erb → _index_header.html.erb} +3 -3
- data/app/views/catalog/_per_page_widget.html.erb +7 -8
- data/app/views/catalog/_previous_next_doc.html.erb +6 -14
- data/app/views/catalog/_results_pagination.html.erb +2 -2
- data/app/views/catalog/_search_form.html.erb +12 -8
- data/app/views/catalog/_search_header.html.erb +0 -3
- data/app/views/catalog/_search_results.html.erb +10 -2
- data/app/views/catalog/_show.html.erb +8 -0
- data/app/views/catalog/{_show_header_default.html.erb → _show_header.html.erb} +0 -0
- data/app/views/catalog/_show_main_content.html.erb +4 -4
- data/app/views/catalog/_show_more_like_this.html.erb +1 -1
- data/app/views/catalog/_show_sidebar.html.erb +10 -8
- data/app/views/catalog/_show_tools.html.erb +10 -21
- data/app/views/catalog/_sms_form.html.erb +8 -4
- data/app/views/catalog/_sort_and_per_page.html.erb +3 -3
- data/app/views/catalog/_sort_widget.html.erb +8 -8
- data/app/views/catalog/_thumbnail.html.erb +5 -0
- data/app/views/catalog/_view_type_group.html.erb +2 -2
- data/app/views/catalog/_zero_results.html.erb +1 -1
- data/app/views/catalog/email.html.erb +5 -3
- data/app/views/catalog/email_success.html.erb +12 -8
- data/app/views/catalog/facet.html.erb +10 -8
- data/app/views/catalog/facet.json.jbuilder +2 -0
- data/app/views/catalog/index.atom.builder +28 -30
- data/app/views/catalog/index.html.erb +9 -11
- data/app/views/catalog/index.json.jbuilder +84 -3
- data/app/views/catalog/index.rss.builder +8 -6
- data/app/views/catalog/opensearch.xml.builder +12 -10
- data/app/views/catalog/show.html.erb +11 -6
- data/app/views/catalog/show.json.jbuilder +21 -0
- data/app/views/catalog/sms.html.erb +3 -1
- data/app/views/catalog/sms_success.html.erb +12 -8
- data/app/views/kaminari/blacklight/_first_page.html.erb +2 -2
- data/app/views/kaminari/blacklight/_gap.html.erb +2 -2
- data/app/views/kaminari/blacklight/_last_page.html.erb +2 -2
- data/app/views/kaminari/blacklight/_next_page.html.erb +5 -5
- data/app/views/kaminari/blacklight/_page.html.erb +5 -3
- data/app/views/kaminari/blacklight/_prev_page.html.erb +4 -4
- data/app/views/kaminari/blacklight_compact/_paginator.html.erb +4 -4
- data/app/views/layouts/blacklight.html.erb +14 -41
- data/app/views/layouts/blacklight/base.html.erb +40 -0
- data/app/views/layouts/catalog_result.html.erb +11 -0
- data/app/views/record_mailer/email_record.text.erb +6 -5
- data/app/views/search_history/index.html.erb +16 -21
- data/app/views/{_flash_msg.html.erb → shared/_flash_msg.html.erb} +5 -3
- data/app/views/shared/_header_navbar.html.erb +8 -13
- data/app/views/shared/_modal.html.erb +6 -0
- data/app/views/shared/_user_util_links.html.erb +22 -0
- data/blacklight.gemspec +8 -12
- data/config/i18n-tasks.yml +17 -0
- data/config/locales/blacklight.de.yml +87 -83
- data/config/locales/blacklight.en.yml +32 -29
- data/config/locales/blacklight.es.yml +31 -28
- data/config/locales/blacklight.fr.yml +33 -35
- data/config/locales/blacklight.hu.yml +226 -0
- data/config/locales/blacklight.it.yml +32 -28
- data/config/locales/blacklight.nl.yml +226 -0
- data/config/locales/blacklight.pt-BR.yml +41 -31
- data/config/locales/blacklight.sq.yml +21 -30
- data/config/locales/blacklight.zh.yml +20 -28
- data/config/routes.rb +2 -10
- data/db/migrate/20140202020202_create_bookmarks.rb +0 -1
- data/db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb +1 -1
- data/lib/blacklight.rb +6 -4
- data/lib/blacklight/abstract_repository.rb +9 -9
- data/lib/blacklight/configuration.rb +106 -88
- data/lib/blacklight/configuration/context.rb +12 -1
- data/lib/blacklight/configuration/facet_field.rb +16 -9
- data/lib/blacklight/configuration/field.rb +32 -3
- data/lib/blacklight/configuration/fields.rb +15 -17
- data/lib/blacklight/configuration/null_field.rb +2 -0
- data/lib/blacklight/configuration/search_field.rb +2 -2
- data/lib/blacklight/configuration/sort_field.rb +2 -2
- data/lib/blacklight/configuration/view_config.rb +4 -0
- data/lib/blacklight/engine.rb +10 -10
- data/lib/blacklight/exceptions.rb +4 -7
- data/lib/blacklight/{utils.rb → nested_open_struct_with_hash_access.rb} +9 -81
- data/lib/blacklight/open_struct_with_hash_access.rb +49 -0
- data/lib/blacklight/parameters.rb +1 -1
- data/lib/blacklight/routes/exportable.rb +1 -3
- data/lib/blacklight/routes/searchable.rb +3 -3
- data/lib/blacklight/runtime_registry.rb +2 -0
- data/lib/blacklight/search_builder.rb +28 -35
- data/lib/blacklight/search_state.rb +10 -8
- data/lib/blacklight/solr.rb +2 -0
- data/{app/models/concerns → lib}/blacklight/solr/document.rb +8 -8
- data/{app/models → lib}/blacklight/solr/facet_paginator.rb +3 -3
- data/lib/blacklight/solr/repository.rb +4 -3
- data/lib/blacklight/solr/request.rb +1 -1
- data/lib/blacklight/solr/response.rb +29 -30
- data/lib/blacklight/solr/response/facets.rb +38 -31
- data/lib/blacklight/solr/response/group.rb +3 -3
- data/lib/blacklight/solr/response/group_response.rb +11 -1
- data/lib/blacklight/solr/response/more_like_this.rb +2 -2
- data/lib/blacklight/solr/response/pagination_methods.rb +12 -0
- data/lib/blacklight/solr/response/response.rb +2 -2
- data/lib/blacklight/solr/response/spelling.rb +4 -3
- data/lib/blacklight/solr/search_builder_behavior.rb +27 -31
- data/lib/blacklight/version.rb +1 -1
- data/lib/generators/blacklight/assets_generator.rb +28 -12
- data/lib/generators/blacklight/controller_generator.rb +4 -5
- data/lib/generators/blacklight/document_generator.rb +1 -1
- data/lib/generators/blacklight/install_generator.rb +15 -34
- data/lib/generators/blacklight/search_builder_generator.rb +1 -1
- data/lib/generators/blacklight/{solr5_generator.rb → solr_generator.rb} +12 -6
- data/{.solr_wrapper.yml → lib/generators/blacklight/templates/.solr_wrapper.yml} +0 -0
- data/lib/generators/blacklight/templates/alternate_controller.rb +4 -4
- data/lib/generators/blacklight/templates/blacklight.scss +0 -2
- data/lib/generators/blacklight/templates/catalog_controller.rb +57 -50
- data/lib/generators/blacklight/templates/config/blacklight.yml +1 -13
- data/{solr → lib/generators/blacklight/templates/solr}/conf/_rest_managed.json +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/admin-extra.html +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/elevate.xml +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/mapping-ISOLatin1Accent.txt +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/protwords.txt +0 -0
- data/lib/generators/blacklight/templates/solr/conf/schema.xml +388 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/scripts.conf +0 -0
- data/lib/generators/blacklight/templates/solr/conf/solrconfig.xml +195 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/spellings.txt +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/stopwords.txt +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/stopwords_en.txt +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/synonyms.txt +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/xslt/example.xsl +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/xslt/example_atom.xsl +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/xslt/example_rss.xsl +0 -0
- data/{solr → lib/generators/blacklight/templates/solr}/conf/xslt/luke.xsl +0 -0
- data/lib/generators/blacklight/test_support_generator.rb +10 -10
- data/lib/generators/blacklight/user_generator.rb +5 -6
- data/lib/railties/blacklight.rake +7 -6
- data/package-lock.json +2793 -0
- data/package.json +30 -0
- data/spec/controllers/alternate_controller_spec.rb +5 -4
- data/spec/controllers/application_controller_spec.rb +1 -5
- data/spec/controllers/blacklight/base_spec.rb +6 -3
- data/spec/controllers/blacklight/catalog/component_configuration_spec.rb +11 -7
- data/spec/controllers/blacklight/facet_spec.rb +1 -2
- data/spec/controllers/blacklight/search_fields_spec.rb +25 -34
- data/spec/controllers/bookmarks_controller_spec.rb +17 -13
- data/spec/controllers/catalog_controller_spec.rb +329 -161
- data/spec/controllers/search_history_controller_spec.rb +6 -6
- data/spec/features/alternate_controller_spec.rb +4 -4
- data/spec/features/autocomplete_spec.rb +4 -2
- data/spec/features/bookmarks_spec.rb +10 -10
- data/spec/features/did_you_mean_spec.rb +7 -12
- data/spec/features/facets_spec.rb +38 -17
- data/spec/features/record_view_spec.rb +12 -18
- data/spec/features/search_context_spec.rb +6 -7
- data/spec/features/search_crawler_spec.rb +3 -5
- data/spec/features/search_filters_spec.rb +100 -80
- data/spec/features/search_formats_spec.rb +4 -5
- data/spec/features/search_history_spec.rb +6 -29
- data/spec/features/search_pagination_spec.rb +4 -2
- data/spec/features/search_results_spec.rb +14 -12
- data/spec/features/search_sort_spec.rb +2 -2
- data/spec/features/search_spec.rb +8 -9
- data/spec/features/sitelinks_search_box.rb +4 -4
- data/{solr → spec/fixtures}/sample_solr_documents.yml +688 -688
- data/spec/helpers/{configuration_helper_spec.rb → blacklight/configuration_helper_behavior_spec.rb} +97 -98
- data/spec/helpers/{facets_helper_spec.rb → blacklight/facets_helper_behavior_spec.rb} +82 -73
- data/spec/helpers/{hash_as_hidden_fields_spec.rb → blacklight/hash_as_hidden_fields_behavior_spec.rb} +2 -2
- data/spec/helpers/blacklight/icon_helper_behavior_spec.rb +10 -0
- data/spec/helpers/{layout_helper_spec.rb → blacklight/layout_helper_behavior_spec.rb} +5 -5
- data/spec/helpers/{render_constraints_helper_spec.rb → blacklight/render_constraints_helper_behavior_spec.rb} +10 -6
- data/spec/helpers/blacklight/render_partials_helper_behavior_spec.rb +92 -0
- data/spec/helpers/{search_history_constraints_helper_spec.rb → blacklight/search_history_constraints_helper_behavior_spec.rb} +29 -30
- data/spec/helpers/{suggest_helper_spec.rb → blacklight/suggest_helper_behavior_spec.rb} +9 -2
- data/spec/helpers/{url_helper_spec.rb → blacklight/url_helper_behavior_spec.rb} +61 -54
- data/spec/helpers/blacklight_helper_spec.rb +104 -151
- data/spec/helpers/catalog_helper_spec.rb +89 -105
- data/spec/i18n_spec.rb +18 -0
- data/spec/integration/generators/blacklight/{solr5_generator_spec.rb → solr_generator_spec.rb} +21 -13
- data/spec/lib/blacklight/configuration/facet_field_spec.rb +13 -0
- data/spec/lib/blacklight/configuration/field_spec.rb +15 -0
- data/spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb +17 -0
- data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb +148 -0
- data/spec/lib/blacklight/parameters_spec.rb +4 -2
- data/spec/lib/blacklight/search_state_spec.rb +53 -36
- data/spec/lib/blacklight_spec.rb +14 -15
- data/spec/lib/tasks/blacklight_task_spec.rb +4 -6
- data/spec/models/blacklight/configurable_spec.rb +24 -27
- data/spec/models/blacklight/configuration/context_spec.rb +9 -10
- data/spec/models/blacklight/configuration_spec.rb +188 -165
- data/spec/models/blacklight/document/active_model_shim_spec.rb +15 -6
- data/spec/models/blacklight/document/cache_key_spec.rb +10 -3
- data/spec/models/blacklight/document/dublin_core_spec.rb +17 -20
- data/spec/models/blacklight/document/email_spec.rb +10 -10
- data/spec/models/blacklight/document/sms_spec.rb +10 -10
- data/spec/models/blacklight/document_spec.rb +10 -22
- data/spec/models/blacklight/facet_paginator_spec.rb +40 -30
- data/spec/models/blacklight/icon_spec.rb +82 -0
- data/spec/models/blacklight/search_builder_spec.rb +41 -26
- data/spec/models/blacklight/solr/document_spec.rb +224 -216
- data/spec/models/blacklight/solr/facet_paginator_spec.rb +6 -4
- data/spec/models/blacklight/solr/repository_spec.rb +50 -42
- data/spec/models/blacklight/solr/request_spec.rb +17 -18
- data/spec/models/blacklight/solr/response/facets_spec.rb +97 -60
- data/spec/models/blacklight/solr/response/group_response_spec.rb +29 -22
- data/spec/models/blacklight/solr/response/group_spec.rb +18 -25
- data/spec/models/blacklight/solr/response_spec.rb +72 -68
- data/spec/models/blacklight/solr/search_builder_spec.rb +150 -164
- data/spec/models/blacklight/suggest/response_spec.rb +2 -1
- data/spec/models/blacklight/suggest_search_spec.rb +4 -4
- data/spec/models/blacklight/user_spec.rb +9 -11
- data/spec/models/bookmark_spec.rb +7 -6
- data/spec/models/record_mailer_spec.rb +23 -21
- data/spec/models/search_spec.rb +19 -18
- data/spec/models/solr_document_spec.rb +33 -5
- data/spec/presenters/blacklight/document_presenter_spec.rb +86 -0
- data/spec/presenters/{index_presenter_spec.rb → blacklight/index_presenter_spec.rb} +25 -62
- data/spec/presenters/blacklight/json_presenter_spec.rb +59 -0
- data/spec/presenters/blacklight/link_alternate_presenter_spec.rb +3 -0
- data/spec/presenters/blacklight/search_bar_presenter_spec.rb +94 -0
- data/spec/presenters/{show_presenter_spec.rb → blacklight/show_presenter_spec.rb} +47 -62
- data/spec/presenters/pipeline_spec.rb +43 -16
- data/spec/presenters/thumbnail_presenter_spec.rb +174 -0
- data/spec/routing/catalog_routing_spec.rb +13 -31
- data/spec/services/blacklight/search_service_spec.rb +495 -0
- data/spec/spec_helper.rb +12 -24
- data/spec/support/features.rb +1 -1
- data/spec/support/features/session_helpers.rb +4 -4
- data/spec/test_app_templates/Gemfile.extra +2 -5
- data/spec/test_app_templates/lib/generators/test_app_generator.rb +12 -13
- data/spec/views/catalog/_constraints.html.erb_spec.rb +3 -6
- data/spec/views/catalog/_constraints_element.html.erb_spec.rb +17 -13
- data/spec/views/catalog/_document.html.erb_spec.rb +11 -11
- data/spec/views/catalog/_document_list.html.erb_spec.rb +2 -1
- data/spec/views/catalog/_facet_group.html.erb_spec.rb +82 -0
- data/spec/views/catalog/_facet_index_navigation.html.erb_spec.rb +5 -5
- data/spec/views/catalog/_facet_layout.html.erb_spec.rb +6 -6
- data/spec/views/catalog/_facets.html.erb_spec.rb +6 -46
- data/spec/views/catalog/{_index_default.erb_spec.rb → _index.html.erb_spec.rb} +14 -15
- data/spec/views/catalog/{_index_header_default.html.erb_spec.rb → _index_header.html.erb_spec.rb} +6 -9
- data/spec/views/catalog/_paginate_compact.html.erb_spec.rb +7 -30
- data/spec/views/catalog/_search_header.erb_spec.rb +1 -3
- data/spec/views/catalog/{_show_default.erb_spec.rb → _show.html.erb_spec.rb} +13 -14
- data/spec/views/catalog/_show_sidebar.erb_spec.rb +7 -10
- data/spec/views/catalog/_show_tools.html.erb_spec.rb +6 -6
- data/spec/views/catalog/_sort_and_per_page.html.erb_spec.rb +1 -2
- data/spec/views/catalog/_sort_widget.html.erb_spec.rb +3 -1
- data/spec/views/catalog/{_thumbnail_default.erb_spec.rb → _thumbnail.html.erb_spec.rb} +7 -9
- data/spec/views/catalog/_view_type_group.html.erb_spec.rb +12 -10
- data/spec/views/catalog/email_success.html.erb_spec.rb +8 -0
- data/spec/views/catalog/facet.html.erb_spec.rb +4 -3
- data/spec/views/catalog/facet.json.jbuilder_spec.rb +3 -2
- data/spec/views/catalog/index.atom.builder_spec.rb +11 -6
- data/spec/views/catalog/index.html.erb_spec.rb +6 -8
- data/spec/views/catalog/index.json.jbuilder_spec.rb +119 -26
- data/spec/views/catalog/opensearch.xml.builder_spec.rb +1 -1
- data/spec/views/catalog/show.html.erb_spec.rb +8 -8
- data/spec/views/catalog/show.json.jbuilder_spec.rb +40 -0
- data/spec/views/catalog/sms_success.html.erb_spec.rb +8 -0
- data/spec/views/{_user_util_links.html.erb_spec.rb → shared/_user_util_links.html.erb_spec.rb} +4 -7
- data/tasks/blacklight.rake +9 -12
- data/template.demo.rb +4 -12
- metadata +178 -218
- data/app/assets/javascripts/blacklight/autofocus.js +0 -16
- data/app/assets/javascripts/blacklight/bookmark_toggle.js +0 -23
- data/app/assets/javascripts/blacklight/checkbox_submit.js +0 -139
- data/app/assets/javascripts/blacklight/collapsable.js +0 -9
- data/app/assets/javascripts/blacklight/core.js +0 -30
- data/app/assets/javascripts/blacklight/facet_load.js +0 -23
- data/app/assets/javascripts/blacklight/search_context.js +0 -42
- data/app/controllers/concerns/blacklight/request_builders.rb +0 -77
- data/app/controllers/concerns/blacklight/saved_searches.rb +0 -70
- data/app/controllers/concerns/blacklight/search_helper.rb +0 -161
- data/app/controllers/concerns/blacklight/suggest.rb +0 -25
- data/app/controllers/saved_searches_controller.rb +0 -4
- data/app/controllers/suggest_controller.rb +0 -4
- data/app/helpers/blacklight/deprecated_url_helper_behavior.rb +0 -57
- data/app/helpers/blacklight/render_partials_helper.rb +0 -205
- data/app/helpers/blacklight_configuration_helper.rb +0 -4
- data/app/helpers/blacklight_url_helper.rb +0 -4
- data/app/helpers/component_helper.rb +0 -4
- data/app/helpers/facets_helper.rb +0 -4
- data/app/helpers/hash_as_hidden_fields_helper.rb +0 -4
- data/app/helpers/layout_helper.rb +0 -4
- data/app/helpers/render_constraints_helper.rb +0 -4
- data/app/helpers/search_history_constraints_helper.rb +0 -4
- data/app/helpers/suggest_helper.rb +0 -4
- data/app/models/concerns/blacklight/solr/document/more_like_this.rb +0 -6
- data/app/views/_user_util_links.html.erb +0 -26
- data/app/views/blacklight/nav/_saved_searches.html.erb +0 -1
- data/app/views/catalog/_index_default.html.erb +0 -12
- data/app/views/catalog/_show_default.html.erb +0 -10
- data/app/views/catalog/_thumbnail_default.html.erb +0 -5
- data/app/views/saved_searches/index.html.erb +0 -32
- data/app/views/shared/_ajax_modal.html.erb +0 -6
- data/lib/generators/blacklight/solr4_generator.rb +0 -31
- data/lib/generators/blacklight/templates/config/jetty.yml +0 -13
- data/solr/conf/schema.xml +0 -629
- data/solr/conf/solrconfig.xml +0 -411
- data/spec/controllers/blacklight/search_helper_spec.rb +0 -489
- data/spec/controllers/saved_searches_controller_spec.rb +0 -32
- data/spec/controllers/suggest_controller_spec.rb +0 -17
- data/spec/features/saved_searches_spec.rb +0 -47
- data/spec/helpers/deprecated_url_helper_behavior_spec.rb +0 -101
- data/spec/lib/blacklight/utils_spec.rb +0 -167
- data/spec/models/blacklight/solr/document/more_like_this_spec.rb +0 -18
- data/spec/presenters/document_presenter_spec.rb +0 -438
- data/spec/support/backport_test.rb +0 -14
@@ -7,7 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# = Search Field blacklight_configuration Hash =
|
9
9
|
# [:key]
|
10
|
-
# "title", required, unique key used in search URLs to specify search_field
|
10
|
+
# "title", required, unique key used in search URLs to specify search_field
|
11
11
|
# [:label]
|
12
12
|
# "Title", # user-displayable label, optional, if not supplied :key.titlecase will be used
|
13
13
|
# [:qt]
|
@@ -18,30 +18,20 @@
|
|
18
18
|
# { :qf => "$something" } # optional hash of additional parameters that will be passed using Solr LocalParams syntax, that can use dollar sign to reference other solr variables.
|
19
19
|
# [:include_in_simple_select]
|
20
20
|
# false. Defaults to true, but you can set to false to have a search field defined for deep-links or BL extensions, but not actually included in the HTML select for simple search choice.
|
21
|
-
#
|
21
|
+
#
|
22
22
|
# Optionally you can supply a :key, which is what Blacklight will use
|
23
23
|
# to identify this search field in HTTP query params. If no :key is
|
24
24
|
# supplied, one will be computed from the :label. If that will
|
25
|
-
# result in a collision of keys, you should supply one explicitly.
|
25
|
+
# result in a collision of keys, you should supply one explicitly.
|
26
26
|
#
|
27
27
|
##
|
28
28
|
module Blacklight::SearchFields
|
29
|
-
extend Deprecation
|
30
|
-
self.deprecation_horizon = 'blacklight 7.x'
|
31
|
-
|
32
29
|
# Looks up search field config list from blacklight_config[:search_fields], and
|
33
|
-
# 'normalizes' all field config hashes using normalize_config method.
|
30
|
+
# 'normalizes' all field config hashes using normalize_config method.
|
34
31
|
def search_field_list
|
35
32
|
blacklight_config.search_fields.values
|
36
33
|
end
|
37
34
|
|
38
|
-
# Looks up a search field blacklight_config hash from search_field_list having
|
39
|
-
# a certain supplied :key.
|
40
|
-
def search_field_def_for_key(key)
|
41
|
-
blacklight_config.search_fields[key]
|
42
|
-
end
|
43
|
-
deprecation_deprecate search_field_def_for_key: "Use blacklight_config.search_fields[key]"
|
44
|
-
|
45
35
|
# Returns default search field, used for simpler display in history, etc.
|
46
36
|
# if not set in blacklight_config, defaults to first field listed in #search_field_list
|
47
37
|
def default_search_field
|
@@ -21,12 +21,7 @@ module Blacklight
|
|
21
21
|
flash[:error] = I18n.t('blacklight.search_history.clear.failure')
|
22
22
|
end
|
23
23
|
|
24
|
-
|
25
|
-
redirect_back fallback_location: blacklight.search_history_path
|
26
|
-
else
|
27
|
-
# Deprecated in Rails 5.0
|
28
|
-
redirect_to :back
|
29
|
-
end
|
24
|
+
redirect_back fallback_location: blacklight.search_history_path
|
30
25
|
end
|
31
26
|
end
|
32
27
|
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
module Blacklight::Searchable
|
3
|
+
# @return [Blacklight::SearchService]
|
4
|
+
def search_service
|
5
|
+
search_service_class.new(config: blacklight_config, user_params: search_state.to_h, **search_service_context)
|
6
|
+
end
|
7
|
+
|
8
|
+
# @return [Hash] a hash of context information to pass through to the search service
|
9
|
+
def search_service_context
|
10
|
+
{}
|
11
|
+
end
|
12
|
+
|
13
|
+
# @return [Blacklight::SuggestSearch]
|
14
|
+
def suggestions_service
|
15
|
+
Blacklight::SuggestSearch.new(params, search_service.repository).suggestions
|
16
|
+
end
|
17
|
+
end
|
@@ -12,7 +12,7 @@ module Blacklight::TokenBasedUser
|
|
12
12
|
end
|
13
13
|
end
|
14
14
|
|
15
|
-
|
15
|
+
private
|
16
16
|
|
17
17
|
def token_or_current_or_guest_user
|
18
18
|
token_user || current_or_guest_user
|
@@ -20,9 +20,9 @@ module Blacklight::TokenBasedUser
|
|
20
20
|
|
21
21
|
def token_user
|
22
22
|
@token_user ||= if params[:encrypted_user_id]
|
23
|
-
|
24
|
-
|
25
|
-
|
23
|
+
user_id = decrypt_user_id params[:encrypted_user_id]
|
24
|
+
User.find(user_id)
|
25
|
+
end
|
26
26
|
end
|
27
27
|
|
28
28
|
# Used for #export action, with encrypted user_id.
|
@@ -66,14 +66,12 @@ module Blacklight::TokenBasedUser
|
|
66
66
|
ActiveSupport::MessageEncryptor.new(export_secret_token)
|
67
67
|
end
|
68
68
|
|
69
|
-
private
|
70
|
-
|
71
69
|
# Ruby 2.4 requires keys of very particular lengths
|
72
70
|
def key_len
|
73
71
|
if ActiveSupport::MessageEncryptor.respond_to? :key_len
|
74
72
|
ActiveSupport::MessageEncryptor.key_len
|
75
73
|
else
|
76
|
-
|
74
|
+
0
|
77
75
|
end
|
78
76
|
end
|
79
77
|
end
|
@@ -1,28 +1,24 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
# Methods added to this helper will be available to all templates in the hosting application
|
3
3
|
module Blacklight::BlacklightHelperBehavior
|
4
|
-
include
|
5
|
-
include
|
6
|
-
include
|
7
|
-
include
|
8
|
-
include RenderPartialsHelper
|
9
|
-
include FacetsHelper
|
10
|
-
extend Deprecation
|
11
|
-
self.deprecation_horizon = 'Blacklight version 7.0.0'
|
4
|
+
include Blacklight::UrlHelperBehavior
|
5
|
+
include Blacklight::HashAsHiddenFieldsHelperBehavior
|
6
|
+
include Blacklight::LayoutHelperBehavior
|
7
|
+
include Blacklight::IconHelperBehavior
|
12
8
|
|
13
9
|
##
|
14
|
-
# Get the name of this application
|
15
|
-
#
|
16
|
-
#
|
10
|
+
# Get the name of this application from an i18n string
|
11
|
+
# key: blacklight.application_name
|
12
|
+
# Try first in the current locale, then the default locale
|
17
13
|
#
|
18
14
|
# @return [String] the application name
|
19
15
|
def application_name
|
20
|
-
|
21
|
-
|
22
|
-
|
16
|
+
# It's important that we don't use ActionView::Helpers::CacheHelper#cache here
|
17
|
+
# because it returns nil.
|
18
|
+
Rails.cache.fetch 'blacklight/application_name' do
|
19
|
+
t('blacklight.application_name',
|
20
|
+
default: t('blacklight.application_name', locale: I18n.default_locale))
|
23
21
|
end
|
24
|
-
|
25
|
-
t('blacklight.application_name')
|
26
22
|
end
|
27
23
|
|
28
24
|
##
|
@@ -44,8 +40,9 @@ module Blacklight::BlacklightHelperBehavior
|
|
44
40
|
# @option options [Boolean] :unique ensures only one link is output for every
|
45
41
|
# content type, e.g. as required by atom
|
46
42
|
# @option options [Array<String>] :exclude array of format shortnames to not include in the output
|
47
|
-
def render_link_rel_alternates(document
|
43
|
+
def render_link_rel_alternates(document = @document, options = {})
|
48
44
|
return if document.nil?
|
45
|
+
|
49
46
|
presenter(document).link_rel_alternates(options)
|
50
47
|
end
|
51
48
|
|
@@ -53,7 +50,7 @@ module Blacklight::BlacklightHelperBehavior
|
|
53
50
|
# Render OpenSearch headers for this search
|
54
51
|
# @return [String]
|
55
52
|
def render_opensearch_response_metadata
|
56
|
-
render :
|
53
|
+
render partial: 'catalog/opensearch_response_metadata'
|
57
54
|
end
|
58
55
|
|
59
56
|
##
|
@@ -75,7 +72,11 @@ module Blacklight::BlacklightHelperBehavior
|
|
75
72
|
# Render the search navbar
|
76
73
|
# @return [String]
|
77
74
|
def render_search_bar
|
78
|
-
render
|
75
|
+
search_bar_presenter.render
|
76
|
+
end
|
77
|
+
|
78
|
+
def search_bar_presenter
|
79
|
+
@search_bar ||= search_bar_presenter_class.new(controller, blacklight_config)
|
79
80
|
end
|
80
81
|
|
81
82
|
##
|
@@ -85,6 +86,7 @@ module Blacklight::BlacklightHelperBehavior
|
|
85
86
|
# @param [Blacklight::Configuration::Field] field_config
|
86
87
|
# @return [Boolean]
|
87
88
|
def should_render_index_field? document, field_config
|
89
|
+
Deprecation.warn self, "should_render_index_field? is deprecated and will be removed in Blacklight 8. Use IndexPresenter#render_field? instead."
|
88
90
|
should_render_field?(field_config, document) && document_has_value?(document, field_config)
|
89
91
|
end
|
90
92
|
|
@@ -95,6 +97,7 @@ module Blacklight::BlacklightHelperBehavior
|
|
95
97
|
# @param [Blacklight::Configuration::Field] field_config
|
96
98
|
# @return [Boolean]
|
97
99
|
def should_render_show_field? document, field_config
|
100
|
+
Deprecation.warn self, "should_render_show_field? is deprecated and will be removed in Blacklight 8. Use ShowPresenter#render_field? instead."
|
98
101
|
should_render_field?(field_config, document) && document_has_value?(document, field_config)
|
99
102
|
end
|
100
103
|
|
@@ -105,6 +108,7 @@ module Blacklight::BlacklightHelperBehavior
|
|
105
108
|
# @param [Blacklight::Configuration::Field] field_config
|
106
109
|
# @return [Boolean]
|
107
110
|
def document_has_value? document, field_config
|
111
|
+
Deprecation.warn self, "document_has_value? is deprecated and will be removed in Blacklight 8. Use DocumentPresenter#has_value? instead."
|
108
112
|
document.has?(field_config.field) ||
|
109
113
|
(document.has_highlight_field? field_config.field if field_config.highlight) ||
|
110
114
|
field_config.accessor
|
@@ -116,6 +120,7 @@ module Blacklight::BlacklightHelperBehavior
|
|
116
120
|
# @param [Blacklight::Solr::Response] response
|
117
121
|
# @return [Boolean]
|
118
122
|
def should_show_spellcheck_suggestions? response
|
123
|
+
# The spelling response field may be missing from non solr repositories.
|
119
124
|
response.total <= spell_check_max &&
|
120
125
|
!response.spelling.nil? &&
|
121
126
|
response.spelling.words.any?
|
@@ -124,6 +129,9 @@ module Blacklight::BlacklightHelperBehavior
|
|
124
129
|
##
|
125
130
|
# Render the index field label for a document
|
126
131
|
#
|
132
|
+
# Translations for index field labels should go under blacklight.search.fields
|
133
|
+
# They are picked up from there by a value "%{label}" in blacklight.search.index.label
|
134
|
+
#
|
127
135
|
# @overload render_index_field_label(options)
|
128
136
|
# Use the default, document-agnostic configuration
|
129
137
|
# @param [Hash] opts
|
@@ -142,45 +150,6 @@ module Blacklight::BlacklightHelperBehavior
|
|
142
150
|
html_escape t(:"blacklight.search.index.#{document_index_view_type}.label", default: :'blacklight.search.index.label', label: index_field_label(document, field))
|
143
151
|
end
|
144
152
|
|
145
|
-
##
|
146
|
-
# Render the index field label for a document
|
147
|
-
#
|
148
|
-
# @overload render_index_field_value(options)
|
149
|
-
# Use the default, document-agnostic configuration
|
150
|
-
# @param [Hash] opts
|
151
|
-
# @option opts [String] :field
|
152
|
-
# @option opts [String] :value
|
153
|
-
# @option opts [String] :document
|
154
|
-
# @overload render_index_field_value(document, options)
|
155
|
-
# Allow an extention point where information in the document
|
156
|
-
# may drive the value of the field
|
157
|
-
# @param [SolrDocument] doc
|
158
|
-
# @param [Hash] opts
|
159
|
-
# @option opts [String] :field
|
160
|
-
# @option opts [String] :value
|
161
|
-
# @overload render_index_field_value(document, field, options)
|
162
|
-
# Allow an extention point where information in the document
|
163
|
-
# may drive the value of the field
|
164
|
-
# @param [SolrDocument] doc
|
165
|
-
# @param [String] field
|
166
|
-
# @param [Hash] opts
|
167
|
-
# @option opts [String] :value
|
168
|
-
# @deprecated use IndexPresenter#field_value
|
169
|
-
def render_index_field_value *args
|
170
|
-
render_field_value(*args)
|
171
|
-
end
|
172
|
-
deprecation_deprecate render_index_field_value: 'replaced by IndexPresenter#field_value'
|
173
|
-
|
174
|
-
# @deprecated use IndexPresenter#field_value
|
175
|
-
def render_field_value(*args)
|
176
|
-
options = args.extract_options!
|
177
|
-
document = args.shift || options[:document]
|
178
|
-
|
179
|
-
field = args.shift || options[:field]
|
180
|
-
presenter(document).field_value field, options.except(:document, :field)
|
181
|
-
end
|
182
|
-
deprecation_deprecate render_field_value: 'replaced by IndexPresenter#field_value'
|
183
|
-
|
184
153
|
##
|
185
154
|
# Render the show field label for a document
|
186
155
|
#
|
@@ -203,42 +172,13 @@ module Blacklight::BlacklightHelperBehavior
|
|
203
172
|
t(:'blacklight.search.show.label', label: document_show_field_label(document, field))
|
204
173
|
end
|
205
174
|
|
206
|
-
##
|
207
|
-
# Render the index field label for a document
|
208
|
-
#
|
209
|
-
# @overload render_document_show_field_value(options)
|
210
|
-
# Use the default, document-agnostic configuration
|
211
|
-
# @param [Hash] opts
|
212
|
-
# @option opts [String] :field
|
213
|
-
# @option opts [String] :value
|
214
|
-
# @option opts [String] :document
|
215
|
-
# @overload render_document_show_field_value(document, options)
|
216
|
-
# Allow an extention point where information in the document
|
217
|
-
# may drive the value of the field
|
218
|
-
# @param [SolrDocument] doc
|
219
|
-
# @param [Hash] opts
|
220
|
-
# @option opts [String] :field
|
221
|
-
# @option opts [String] :value
|
222
|
-
# @overload render_document_show_field_value(document, field, options)
|
223
|
-
# Allow an extention point where information in the document
|
224
|
-
# may drive the value of the field
|
225
|
-
# @param [SolrDocument] doc
|
226
|
-
# @param [String] field
|
227
|
-
# @param [Hash] opts
|
228
|
-
# @option opts [String] :value
|
229
|
-
# @deprecated use ShowPresenter#field_value
|
230
|
-
def render_document_show_field_value *args
|
231
|
-
render_field_value(*args)
|
232
|
-
end
|
233
|
-
deprecation_deprecate render_document_show_field_value: 'replaced by ShowPresenter#field_value'
|
234
|
-
|
235
175
|
##
|
236
176
|
# Get the value of the document's "title" field, or a placeholder
|
237
177
|
# value (if empty)
|
238
178
|
#
|
239
179
|
# @param [SolrDocument] document
|
240
180
|
# @return [String]
|
241
|
-
def document_heading document=nil
|
181
|
+
def document_heading document = nil
|
242
182
|
document ||= @document
|
243
183
|
presenter(document).heading
|
244
184
|
end
|
@@ -250,7 +190,7 @@ module Blacklight::BlacklightHelperBehavior
|
|
250
190
|
# @see #document_heading
|
251
191
|
# @param [SolrDocument] document
|
252
192
|
# @return [String]
|
253
|
-
def document_show_html_title document=nil
|
193
|
+
def document_show_html_title document = nil
|
254
194
|
document ||= @document
|
255
195
|
|
256
196
|
presenter(document).html_title
|
@@ -274,33 +214,15 @@ module Blacklight::BlacklightHelperBehavior
|
|
274
214
|
content_tag(tag, presenter(document).heading, itemprop: "name")
|
275
215
|
end
|
276
216
|
|
277
|
-
##
|
278
|
-
# Get the value for a document's field, and prepare to render it.
|
279
|
-
# - highlight_field
|
280
|
-
# - accessor
|
281
|
-
# - solr field
|
282
|
-
#
|
283
|
-
# Rendering:
|
284
|
-
# - helper_method
|
285
|
-
# - link_to_search
|
286
|
-
# @param [SolrDocument] document
|
287
|
-
# @param [String] _field name
|
288
|
-
# @param [Blacklight::Configuration::Field] field_config solr field configuration
|
289
|
-
# @param [Hash] options additional options to pass to the rendering helpers
|
290
|
-
def get_field_values document, _field, field_config, options = {}
|
291
|
-
presenter(document).field_values field_config, options
|
292
|
-
end
|
293
|
-
deprecation_deprecate :get_field_values
|
294
|
-
|
295
217
|
##
|
296
218
|
# Get the current "view type" (and ensure it is a valid type)
|
297
219
|
#
|
298
220
|
# @param [Hash] query_params the query parameters to check
|
299
221
|
# @return [Symbol]
|
300
|
-
def document_index_view_type query_params=params
|
222
|
+
def document_index_view_type query_params = params
|
301
223
|
view_param = query_params[:view]
|
302
224
|
view_param ||= session[:preferred_view]
|
303
|
-
if view_param
|
225
|
+
if view_param && document_index_views.key?(view_param.to_sym)
|
304
226
|
view_param.to_sym
|
305
227
|
else
|
306
228
|
default_document_index_view_type
|
@@ -316,7 +238,7 @@ module Blacklight::BlacklightHelperBehavior
|
|
316
238
|
#
|
317
239
|
# @param [String] format suffix
|
318
240
|
# @yield
|
319
|
-
def with_format(format
|
241
|
+
def with_format(format)
|
320
242
|
old_formats = formats
|
321
243
|
self.formats = [format]
|
322
244
|
yield
|
@@ -338,11 +260,8 @@ module Blacklight::BlacklightHelperBehavior
|
|
338
260
|
case action_name
|
339
261
|
when 'show', 'citation'
|
340
262
|
show_presenter(document)
|
341
|
-
when 'index'
|
342
|
-
index_presenter(document)
|
343
263
|
else
|
344
|
-
|
345
|
-
presenter_class.new(document, self)
|
264
|
+
index_presenter(document)
|
346
265
|
end
|
347
266
|
end
|
348
267
|
|
@@ -354,11 +273,6 @@ module Blacklight::BlacklightHelperBehavior
|
|
354
273
|
index_presenter_class(document).new(document, self)
|
355
274
|
end
|
356
275
|
|
357
|
-
def presenter_class
|
358
|
-
blacklight_config.document_presenter_class
|
359
|
-
end
|
360
|
-
deprecation_deprecate presenter_class: "replaced by show_presenter_class and index_presenter_class"
|
361
|
-
|
362
276
|
##
|
363
277
|
# Override this method if you want to use a different presenter class
|
364
278
|
def show_presenter_class(_document)
|
@@ -369,6 +283,10 @@ module Blacklight::BlacklightHelperBehavior
|
|
369
283
|
blacklight_config.index.document_presenter_class
|
370
284
|
end
|
371
285
|
|
286
|
+
def search_bar_presenter_class
|
287
|
+
blacklight_config.index.search_bar_presenter_class
|
288
|
+
end
|
289
|
+
|
372
290
|
##
|
373
291
|
# Open Search discovery tag for HTML <head> links
|
374
292
|
def opensearch_description_tag title, href
|
@@ -1,12 +1,23 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
module Blacklight::CatalogHelperBehavior
|
3
|
-
|
3
|
+
extend Deprecation
|
4
|
+
self.deprecation_horizon = 'blacklight 8.0'
|
5
|
+
|
6
|
+
include Blacklight::ConfigurationHelperBehavior
|
7
|
+
include Blacklight::ComponentHelperBehavior
|
8
|
+
include Blacklight::FacetsHelperBehavior
|
9
|
+
include Blacklight::RenderConstraintsHelperBehavior
|
10
|
+
include Blacklight::RenderPartialsHelperBehavior
|
11
|
+
include Blacklight::SearchHistoryConstraintsHelperBehavior
|
12
|
+
include Blacklight::SuggestHelperBehavior
|
13
|
+
|
14
|
+
# @param [Hash] options
|
4
15
|
# @option options :route_set the route scope to use when constructing the link
|
5
16
|
def rss_feed_link_tag(options = {})
|
6
17
|
auto_discovery_link_tag(:rss, feed_link_url('rss', options), title: t('blacklight.search.rss_feed'))
|
7
18
|
end
|
8
19
|
|
9
|
-
# @param [Hash] options
|
20
|
+
# @param [Hash] options
|
10
21
|
# @option options :route_set the route scope to use when constructing the link
|
11
22
|
def atom_feed_link_tag(options = {})
|
12
23
|
auto_discovery_link_tag(:atom, feed_link_url('atom', options), title: t('blacklight.search.atom_feed'))
|
@@ -20,52 +31,51 @@ module Blacklight::CatalogHelperBehavior
|
|
20
31
|
|
21
32
|
##
|
22
33
|
# Override the Kaminari page_entries_info helper with our own, blacklight-aware
|
23
|
-
# implementation.
|
24
|
-
#
|
34
|
+
# implementation. Why do we have to do this?
|
35
|
+
# - We need custom counting information for grouped results
|
36
|
+
# - We need to provide number_with_delimiter strings to i18n keys
|
37
|
+
# If we didn't have to do either one of these, we could get away with removing
|
38
|
+
# this entirely.
|
25
39
|
#
|
26
40
|
# @param [RSolr::Resource] collection (or other Kaminari-compatible objects)
|
27
41
|
# @return [String]
|
28
|
-
def page_entries_info(collection,
|
42
|
+
def page_entries_info(collection, entry_name: nil)
|
29
43
|
return unless show_pagination? collection
|
30
44
|
|
31
|
-
entry_name = if
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
collection.model_name.human.downcase
|
37
|
-
else
|
38
|
-
t('blacklight.entry_name.default')
|
39
|
-
end
|
45
|
+
entry_name = if entry_name
|
46
|
+
entry_name.pluralize(collection.size, I18n.locale)
|
47
|
+
else
|
48
|
+
collection.entry_name(count: collection.size).downcase
|
49
|
+
end
|
40
50
|
|
41
51
|
entry_name = entry_name.pluralize unless collection.total_count == 1
|
42
52
|
|
43
53
|
# grouped response objects need special handling
|
44
|
-
end_num = if collection.respond_to?
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
54
|
+
end_num = if collection.respond_to?(:groups) && render_grouped_response?(collection)
|
55
|
+
collection.groups.length
|
56
|
+
else
|
57
|
+
collection.limit_value
|
58
|
+
end
|
49
59
|
|
50
60
|
end_num = if collection.offset_value + end_num <= collection.total_count
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
61
|
+
collection.offset_value + end_num
|
62
|
+
else
|
63
|
+
collection.total_count
|
64
|
+
end
|
65
|
+
|
56
66
|
case collection.total_count
|
57
67
|
when 0
|
58
|
-
t('blacklight.search.pagination_info.no_items_found', :
|
68
|
+
t('blacklight.search.pagination_info.no_items_found', entry_name: entry_name).html_safe
|
59
69
|
when 1
|
60
|
-
t('blacklight.search.pagination_info.single_item_found', :
|
70
|
+
t('blacklight.search.pagination_info.single_item_found', entry_name: entry_name).html_safe
|
61
71
|
else
|
62
|
-
t('blacklight.search.pagination_info.pages', :
|
63
|
-
:
|
64
|
-
:
|
65
|
-
:
|
66
|
-
:
|
67
|
-
:
|
68
|
-
:
|
72
|
+
t('blacklight.search.pagination_info.pages', entry_name: entry_name,
|
73
|
+
current_page: collection.current_page,
|
74
|
+
num_pages: collection.total_pages,
|
75
|
+
start_num: number_with_delimiter(collection.offset_value + 1),
|
76
|
+
end_num: number_with_delimiter(end_num),
|
77
|
+
total_num: number_with_delimiter(collection.total_count),
|
78
|
+
count: collection.total_pages).html_safe
|
69
79
|
end
|
70
80
|
end
|
71
81
|
|
@@ -79,7 +89,7 @@ module Blacklight::CatalogHelperBehavior
|
|
79
89
|
offset ||= @response.start if @response
|
80
90
|
offset ||= 0
|
81
91
|
|
82
|
-
unless render_grouped_response?
|
92
|
+
unless render_grouped_response?
|
83
93
|
idx + 1 + offset
|
84
94
|
end
|
85
95
|
end
|
@@ -87,20 +97,20 @@ module Blacklight::CatalogHelperBehavior
|
|
87
97
|
##
|
88
98
|
# Like #page_entries_info above, but for an individual
|
89
99
|
# item show page. Displays "showing X of Y items" message.
|
90
|
-
#
|
100
|
+
#
|
91
101
|
# @see #page_entries_info
|
92
102
|
# @return [String]
|
93
103
|
def item_page_entry_info
|
94
|
-
t('blacklight.search.entry_pagination_info.other', :
|
95
|
-
:
|
96
|
-
:
|
104
|
+
t('blacklight.search.entry_pagination_info.other', current: number_with_delimiter(search_session['counter']),
|
105
|
+
total: number_with_delimiter(search_session['total']),
|
106
|
+
count: search_session['total'].to_i).html_safe
|
97
107
|
end
|
98
108
|
|
99
109
|
##
|
100
110
|
# Look up search field user-displayable label
|
101
111
|
# based on params[:qt] and blacklight_configuration.
|
102
112
|
def search_field_label(params)
|
103
|
-
h(
|
113
|
+
h(label_for_search_field(params[:search_field]))
|
104
114
|
end
|
105
115
|
|
106
116
|
##
|
@@ -108,20 +118,20 @@ module Blacklight::CatalogHelperBehavior
|
|
108
118
|
#
|
109
119
|
# @return [Blacklight::Configuration::SortField]
|
110
120
|
def current_sort_field
|
111
|
-
(blacklight_config.sort_fields.values.find {|f| f.sort == @response.sort} if @response
|
121
|
+
(blacklight_config.sort_fields.values.find { |f| f.sort == @response.sort } if @response && @response.sort.present?) || blacklight_config.sort_fields[params[:sort]] || default_sort_field
|
112
122
|
end
|
113
123
|
|
114
124
|
##
|
115
125
|
# Look up the current per page value, or the default if none if set
|
116
|
-
#
|
126
|
+
#
|
117
127
|
# @return [Integer]
|
118
128
|
def current_per_page
|
119
|
-
(@response.rows if @response
|
129
|
+
(@response.rows if @response && @response.rows > 0) || params.fetch(:per_page, blacklight_config.default_per_page).to_i
|
120
130
|
end
|
121
131
|
|
122
132
|
##
|
123
133
|
# Get the classes to add to a document's div
|
124
|
-
#
|
134
|
+
#
|
125
135
|
# @return [String]
|
126
136
|
def render_document_class(document = @document)
|
127
137
|
types = document[blacklight_config.view_config(document_index_view_type).display_type_field]
|
@@ -142,8 +152,13 @@ module Blacklight::CatalogHelperBehavior
|
|
142
152
|
#
|
143
153
|
# @param [SolrDocument] document
|
144
154
|
# @return [String]
|
145
|
-
def render_document_sidebar_partial(document =
|
146
|
-
|
155
|
+
def render_document_sidebar_partial(document = nil)
|
156
|
+
unless document
|
157
|
+
Deprecation.warn(self, 'render_document_sidebar_partial expects one argument ' /
|
158
|
+
'(@document) and you passed none. This behavior will be removed in version 8')
|
159
|
+
document = @document
|
160
|
+
end
|
161
|
+
render 'show_sidebar', document: document
|
147
162
|
end
|
148
163
|
|
149
164
|
##
|
@@ -151,13 +166,13 @@ module Blacklight::CatalogHelperBehavior
|
|
151
166
|
#
|
152
167
|
# @param [SolrDocument] document
|
153
168
|
# @return [String]
|
154
|
-
def render_document_main_content_partial(
|
169
|
+
def render_document_main_content_partial(_document = @document)
|
155
170
|
render partial: 'show_main_content'
|
156
171
|
end
|
157
172
|
|
158
173
|
##
|
159
174
|
# Should we display the sort and per page widget?
|
160
|
-
#
|
175
|
+
#
|
161
176
|
# @param [Blacklight::Solr::Response] response
|
162
177
|
# @return [Boolean]
|
163
178
|
def show_sort_and_per_page? response = nil
|
@@ -178,57 +193,41 @@ module Blacklight::CatalogHelperBehavior
|
|
178
193
|
##
|
179
194
|
# If no search parameters have been given, we should
|
180
195
|
# auto-focus the user's cursor into the searchbox
|
181
|
-
#
|
196
|
+
#
|
182
197
|
# @return [Boolean]
|
183
198
|
def should_autofocus_on_search_box?
|
184
|
-
controller.is_a?
|
185
|
-
action_name == "index"
|
199
|
+
controller.is_a?(Blacklight::Catalog) &&
|
200
|
+
action_name == "index" &&
|
186
201
|
!has_search_parameters?
|
187
202
|
end
|
203
|
+
deprecation_deprecate should_autofocus_on_search_box?: "use SearchBarPresenter#autofocus?"
|
188
204
|
|
189
205
|
##
|
190
206
|
# Does the document have a thumbnail to render?
|
191
|
-
#
|
207
|
+
#
|
192
208
|
# @param [SolrDocument] document
|
193
209
|
# @return [Boolean]
|
194
210
|
def has_thumbnail? document
|
195
|
-
|
196
|
-
blacklight_config.view_config(document_index_view_type).thumbnail_field && document.has?(blacklight_config.view_config(document_index_view_type).thumbnail_field)
|
211
|
+
index_presenter(document).thumbnail.exists?
|
197
212
|
end
|
213
|
+
deprecation_deprecate has_thumbnail?: "use IndexPresenter#thumbnail.exists?"
|
198
214
|
|
199
215
|
##
|
200
216
|
# Render the thumbnail, if available, for a document and
|
201
217
|
# link it to the document record.
|
202
|
-
#
|
218
|
+
#
|
203
219
|
# @param [SolrDocument] document
|
204
220
|
# @param [Hash] image_options to pass to the image tag
|
205
221
|
# @param [Hash] url_options to pass to #link_to_document
|
206
222
|
# @return [String]
|
207
223
|
def render_thumbnail_tag document, image_options = {}, url_options = {}
|
208
|
-
|
209
|
-
send(blacklight_config.view_config(document_index_view_type).thumbnail_method, document, image_options)
|
210
|
-
elsif blacklight_config.view_config(document_index_view_type).thumbnail_field
|
211
|
-
url = thumbnail_url(document)
|
212
|
-
|
213
|
-
image_tag url, image_options if url.present?
|
214
|
-
end
|
215
|
-
|
216
|
-
if value
|
217
|
-
if url_options == false
|
218
|
-
Deprecation.warn(self, "passing false as the second argument to render_thumbnail_tag is deprecated. Use suppress_link: true instead. This behavior will be removed in Blacklight 7")
|
219
|
-
url_options = { suppress_link: true }
|
220
|
-
end
|
221
|
-
if url_options[:suppress_link]
|
222
|
-
value
|
223
|
-
else
|
224
|
-
link_to_document document, value, url_options
|
225
|
-
end
|
226
|
-
end
|
224
|
+
index_presenter(document).thumbnail.thumbnail_tag(image_options, url_options)
|
227
225
|
end
|
226
|
+
deprecation_deprecate render_thumbnail_tag: "Use IndexPresenter#thumbnail.thumbnail_tag"
|
228
227
|
|
229
228
|
##
|
230
229
|
# Get the URL to a document's thumbnail image
|
231
|
-
#
|
230
|
+
#
|
232
231
|
# @param [SolrDocument] document
|
233
232
|
# @return [String]
|
234
233
|
def thumbnail_url document
|
@@ -236,14 +235,15 @@ module Blacklight::CatalogHelperBehavior
|
|
236
235
|
document.first(blacklight_config.view_config(document_index_view_type).thumbnail_field)
|
237
236
|
end
|
238
237
|
end
|
238
|
+
deprecation_deprecate thumbnail_url: "this method will be removed without replacement"
|
239
239
|
|
240
240
|
##
|
241
241
|
# Render the view type icon for the results view picker
|
242
|
-
#
|
242
|
+
#
|
243
243
|
# @param [String] view
|
244
244
|
# @return [String]
|
245
245
|
def render_view_type_group_icon view
|
246
|
-
|
246
|
+
blacklight_icon(view)
|
247
247
|
end
|
248
248
|
|
249
249
|
##
|
@@ -252,28 +252,38 @@ module Blacklight::CatalogHelperBehavior
|
|
252
252
|
# @param [String] view
|
253
253
|
# @return [String]
|
254
254
|
def default_view_type_group_icon_classes view
|
255
|
+
Deprecation.warn(Blacklight::CatalogHelperBehavior, 'This method has been deprecated, use blacklight_icons helper instead')
|
255
256
|
"glyphicon-#{view.to_s.parameterize} view-icon-#{view.to_s.parameterize}"
|
256
257
|
end
|
257
|
-
|
258
|
-
def current_bookmarks
|
259
|
-
|
260
|
-
|
258
|
+
|
259
|
+
def current_bookmarks documents_or_response = nil
|
260
|
+
documents = if documents_or_response.respond_to? :documents
|
261
|
+
Deprecation.warn(Blacklight::CatalogHelperBehavior, "Passing a response to #current_bookmarks is deprecated; pass response.documents instead")
|
262
|
+
documents_or_response.documents
|
263
|
+
else
|
264
|
+
documents_or_response
|
265
|
+
end
|
266
|
+
|
267
|
+
documents ||= [@document] if @document.present?
|
268
|
+
documents ||= @response.documents
|
269
|
+
|
270
|
+
@current_bookmarks ||= current_or_guest_user.bookmarks_for_documents(documents).to_a
|
261
271
|
end
|
262
272
|
|
263
273
|
##
|
264
274
|
# Check if the document is in the user's bookmarks
|
265
275
|
def bookmarked? document
|
266
|
-
current_bookmarks.any? { |x| x.document_id == document.id
|
276
|
+
current_bookmarks.any? { |x| x.document_id == document.id && x.document_type == document.class }
|
267
277
|
end
|
268
278
|
|
269
279
|
def render_search_to_page_title_filter(facet, values)
|
270
280
|
facet_config = facet_configuration_for_field(facet)
|
271
281
|
filter_label = facet_field_label(facet_config.key)
|
272
282
|
filter_value = if values.size < 3
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
283
|
+
values.map { |value| facet_display_value(facet, value) }.to_sentence
|
284
|
+
else
|
285
|
+
t('blacklight.search.page_title.many_constraint_values', values: values.size)
|
286
|
+
end
|
277
287
|
t('blacklight.search.page_title.constraint', label: filter_label, value: filter_value)
|
278
288
|
end
|
279
289
|
|
@@ -291,7 +301,7 @@ module Blacklight::CatalogHelperBehavior
|
|
291
301
|
end
|
292
302
|
|
293
303
|
if params['f'].present?
|
294
|
-
constraints += params['f'].to_unsafe_h.collect { |key, value| render_search_to_page_title_filter(key, value) }
|
304
|
+
constraints += params['f'].to_unsafe_h.collect { |key, value| render_search_to_page_title_filter(key, Array(value)) }
|
295
305
|
end
|
296
306
|
|
297
307
|
constraints.join(' / ')
|
@@ -299,11 +309,11 @@ module Blacklight::CatalogHelperBehavior
|
|
299
309
|
|
300
310
|
private
|
301
311
|
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
312
|
+
# @param [String] format
|
313
|
+
# @param [Hash] options
|
314
|
+
# @option options :route_set the route scope to use when constructing the link
|
315
|
+
def feed_link_url(format, options = {})
|
316
|
+
scope = options.delete(:route_set) || self
|
317
|
+
scope.url_for search_state.to_h.merge(format: format)
|
318
|
+
end
|
309
319
|
end
|