From b6ea0cf36f52daf06c8b84e9acb938c1bc098228 Mon Sep 17 00:00:00 2001 From: Shana Moore Date: Mon, 21 Oct 2024 14:12:47 -0700 Subject: [PATCH 1/9] WIP --- app/controllers/catalog_controller.rb | 10 +++++----- app/helpers/shared_search_helper.rb | 2 +- app/views/catalog/_index_header_list_default.html.erb | 11 ++++++++++- 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/app/controllers/catalog_controller.rb b/app/controllers/catalog_controller.rb index fce3e9b09..e997923b1 100644 --- a/app/controllers/catalog_controller.rb +++ b/app/controllers/catalog_controller.rb @@ -41,7 +41,11 @@ def self.uploaded_field # IiifPrint index fields config.add_index_field 'all_text_timv' - config.add_index_field 'all_text_tsimv', label: "Item contents", highlight: true, helper_method: :render_ocr_snippets, if: :query_present? + config.add_index_field 'all_text_tsimv', + label: "Item contents", + highlight: true, + helper_method: :render_ocr_snippets, + values: ->(field_config, document, _context) { document.highlight_field(field_config.field).map(&:html_safe) if document.has_highlight_field? field_config.field } # configuration for Blacklight IIIF Content Search config.iiif_search = { @@ -638,9 +642,5 @@ def show def render_bookmarks_control? false end - - def query_present? - params[:q].present? - end end # rubocop:enable Metrics/ClassLength, Metrics/BlockLength diff --git a/app/helpers/shared_search_helper.rb b/app/helpers/shared_search_helper.rb index 0c5a6b370..e2131ba23 100644 --- a/app/helpers/shared_search_helper.rb +++ b/app/helpers/shared_search_helper.rb @@ -19,7 +19,7 @@ def generate_work_url(model, request) url = get_url(id:, request: request_params, account_cname:, base_route_name:) # pass search query params to work show page - params[:q].present? ? "#{url}?q=#{params[:q]}" : url + (params[:q].present? && params[:highlight]) ? "#{url}?q=#{params[:q]}" : url end private diff --git a/app/views/catalog/_index_header_list_default.html.erb b/app/views/catalog/_index_header_list_default.html.erb index 000176cd9..379c172e9 100644 --- a/app/views/catalog/_index_header_list_default.html.erb +++ b/app/views/catalog/_index_header_list_default.html.erb @@ -1,6 +1,15 @@ <%# OVERRIDE Hyrax v5.0.1 to collection badge and markdown of links %>
-

<%= link_to markdown(document.title_or_label), generate_work_url(document, request) %>

+

+ <% if params['q'].present? && document.any_highlighting_in_all_text_fields? %> + <%= link_to document.title_or_label, [document, { parent_query: params['q'], highlight: 'true' }] %>

+ <% elsif params['q'].present? %> + <%= link_to document.title_or_label, [document, { query: params['q'] }] %> + <% else %> + <%= link_to document.title_or_label, document %> + <% end %> + + <% if document.hydra_model == Hyrax.config.collection_class || document.hydra_model < Hyrax.config.collection_class %> <%= Hyrax::CollectionPresenter.new(document, current_ability).collection_type_badge %> <% end %> From e548cd22d7ac42fc8d11f334083519d04228cdac Mon Sep 17 00:00:00 2001 From: Shana Moore Date: Mon, 21 Oct 2024 15:48:51 -0700 Subject: [PATCH 2/9] :bug: Add check to prevent displaying blank metadata --- app/views/catalog/_index_list_default.html.erb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/app/views/catalog/_index_list_default.html.erb b/app/views/catalog/_index_list_default.html.erb index 39329f4be..dd935e223 100644 --- a/app/views/catalog/_index_list_default.html.erb +++ b/app/views/catalog/_index_list_default.html.erb @@ -1,12 +1,14 @@ <%# OVERRIDE Hyrax 5.0.1 to enable markdown for index field values in search results %> <%# OVERRIDE Hyrax 5.0.1 to handle search only accounts %> +<%# OVERRIDE Hyrax 5.0.1 display label only when a property has a value, to prevent blank metadata %>
<% doc_presenter = index_presenter(document) %> <% index_fields(document).each do |field_name, field| -%> - <% if should_render_index_field? document, field %> + <% field_value = doc_presenter.field_value(field) %> + <% if should_render_index_field?(document, field) && field_value.present? %>
<%= render_index_field_label document, field: field_name %>
<%= markdown(doc_presenter.field_value field) %>
From b2fe9446c86398a8e4ac5d732d8fb20b081fd7dc Mon Sep 17 00:00:00 2001 From: Shana Moore Date: Tue, 22 Oct 2024 11:48:25 -0700 Subject: [PATCH 3/9] =?UTF-8?q?=F0=9F=A7=B9=20Refactor=20generate=5Fwork?= =?UTF-8?q?=5Furl=20method=20and=20add=20YARD=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Refactored generate_work_url method by breaking it into smaller, modular helper methods for readability and maintainability. - Added YARD documentation to each method in SharedSearchHelper for better code clarity and generating documentation. --- app/helpers/shared_search_helper.rb | 71 ++++++++++++++++--- .../_index_header_list_default.html.erb | 8 +-- 2 files changed, 64 insertions(+), 15 deletions(-) diff --git a/app/helpers/shared_search_helper.rb b/app/helpers/shared_search_helper.rb index e2131ba23..94c99dba5 100644 --- a/app/helpers/shared_search_helper.rb +++ b/app/helpers/shared_search_helper.rb @@ -1,29 +1,84 @@ # frozen_string_literal: true +# A helper module that generates work URLs based on models and request parameters. module SharedSearchHelper - def generate_work_url(model, request) - # handle the various types of info we receive: + # Generates a URL for the given model with optional query parameters. + # + # @param model [Object] the model object, typically a work or collection + # @param request [ActionDispatch::Request] the current HTTP request object + # @param params [Hash] additional query parameters (e.g., search queries) + # @return [String] the generated URL with or without query parameters + def generate_work_url(model, request, params = {}) + id, base_route_name, account_cname = extract_model_info(model, request) + request_params = extract_request_params(request) + url = build_url(id, request_params, account_cname, base_route_name) + + append_query_params(url, model, params) + end + + private + + # Extracts the model ID, route name, and account cname from the model and request. + # + # @param model [Object] the model object (e.g., Hyrax::IiifAv::IiifFileSetPresenter or others) + # @param request [ActionDispatch::Request] the current HTTP request object + # @return [Array] a tuple containing the model's ID, route name, and account cname + def extract_model_info(model, request) if model.class == Hyrax::IiifAv::IiifFileSetPresenter base_route_name = model.model_name.plural id = model.id account_cname = request.server_name else model_hash = model.to_h.with_indifferent_access - base_route_name = model_hash["has_model_ssim"].first.constantize.model_name.plural id = model_hash["id"] account_cname = Array.wrap(model_hash["account_cname_tesim"]).first end + [id, base_route_name, account_cname] + end - request_params = %i[protocol host port].map { |method| ["request_#{method}".to_sym, request.send(method)] }.to_h - url = get_url(id:, request: request_params, account_cname:, base_route_name:) + # Extracts protocol, host, and port information from the request. + # + # @param request [ActionDispatch::Request] the current HTTP request object + # @return [Hash] a hash containing the protocol, host, and port extracted from the request + def extract_request_params(request) + %i[protocol host port].map { |method| ["request_#{method}".to_sym, request.send(method)] }.to_h + end - # pass search query params to work show page - (params[:q].present? && params[:highlight]) ? "#{url}?q=#{params[:q]}" : url + # Builds the base URL for the given model and request information. + # + # @param id [String] the model's ID + # @param request_params [Hash] the extracted request parameters (protocol, host, port) + # @param account_cname [String, nil] the account cname, if applicable + # @param base_route_name [String] the base route name (e.g., 'works', 'collections') + # @return [String] the constructed base URL + def build_url(id, request_params, account_cname, base_route_name) + get_url(id: id, request: request_params, account_cname: account_cname, base_route_name: base_route_name) end - private + # Appends the appropriate query parameters to the base URL based on the model and params. + # + # @param url [String] the base URL + # @param model [Object] the model object (e.g., work or collection) + # @param params [Hash] the query parameters, which may include search queries + # @return [String] the URL with appended query parameters, if applicable + def append_query_params(url, model, params) + if params[:q].present? && model.any_highlighting_in_all_text_fields? + "#{url}?parent_query=#{params[:q]}&highlight=true" + elsif params[:q].present? + "#{url}?q=#{params[:q]}" + else + url + end + end + # Constructs a URL with the given parameters. + # + # @param id [String] the model's ID + # @param request [Hash] the request parameters (protocol, host, port) + # @param account_cname [String, nil] the account cname, if applicable + # @param base_route_name [String] the base route name (e.g., 'works', 'collections') + # @return [String] the constructed URL def get_url(id:, request:, account_cname:, base_route_name:) new_url = "#{request[:request_protocol]}#{account_cname || request[:request_host]}" new_url += ":#{request[:request_port]}" if Rails.env.development? || Rails.env.test? diff --git a/app/views/catalog/_index_header_list_default.html.erb b/app/views/catalog/_index_header_list_default.html.erb index 379c172e9..0b74d2c06 100644 --- a/app/views/catalog/_index_header_list_default.html.erb +++ b/app/views/catalog/_index_header_list_default.html.erb @@ -1,13 +1,7 @@ <%# OVERRIDE Hyrax v5.0.1 to collection badge and markdown of links %>

- <% if params['q'].present? && document.any_highlighting_in_all_text_fields? %> - <%= link_to document.title_or_label, [document, { parent_query: params['q'], highlight: 'true' }] %>

- <% elsif params['q'].present? %> - <%= link_to document.title_or_label, [document, { query: params['q'] }] %> - <% else %> - <%= link_to document.title_or_label, document %> - <% end %> + <%= link_to document.title_or_label, generate_work_url(document, request, params) %> <% if document.hydra_model == Hyrax.config.collection_class || document.hydra_model < Hyrax.config.collection_class %> From cc7ea7162ee6eb8f4ef84999574bc647f5e895b8 Mon Sep 17 00:00:00 2001 From: LaRita Robinson Date: Tue, 22 Oct 2024 17:22:32 -0400 Subject: [PATCH 4/9] Add query parameters to link from thumbnail --- .../hyku/blacklight_helper_behavior.rb | 10 +++++++-- .../thumbnail_presenter_decorator.rb | 21 +++++++++++++++++++ .../catalog/_thumbnail_list_default.html.erb | 21 +++++++++++++++++++ 3 files changed, 50 insertions(+), 2 deletions(-) create mode 100644 app/presenters/blacklight/thumbnail_presenter_decorator.rb create mode 100644 app/views/catalog/_thumbnail_list_default.html.erb diff --git a/app/helpers/hyku/blacklight_helper_behavior.rb b/app/helpers/hyku/blacklight_helper_behavior.rb index 91be4cd8a..c60a2509f 100644 --- a/app/helpers/hyku/blacklight_helper_behavior.rb +++ b/app/helpers/hyku/blacklight_helper_behavior.rb @@ -44,7 +44,7 @@ def link_to_document(doc, field_or_opts = nil, opts = { counter: nil }) # pull solr_document from input if we don't already have a solr_document document = doc&.try(:solr_document) || doc Deprecation.silence(Blacklight::UrlHelperBehavior) do - link_to label, generate_work_url(document, request), document_link_params(document, opts) + link_to label, generate_work_url(document, request, universal_viewer_url_params(opts)), document_link_params(document, opts) end end # rubocop:enable Metrics/MethodLength @@ -56,7 +56,13 @@ def link_to_document(doc, field_or_opts = nil, opts = { counter: nil }) # method `session_tracking_params`so that instead of a path we have a URL # @private def document_link_params(_doc, opts) - opts.except(:label, :counter) + opts.except(:label, :counter, :q, :highlight) + end + private :document_link_params + + # options needed to carry the search into the universalviewer + def universal_viewer_url_params(opts) + opts.slice(:q, :highlight) end private :document_link_params end diff --git a/app/presenters/blacklight/thumbnail_presenter_decorator.rb b/app/presenters/blacklight/thumbnail_presenter_decorator.rb new file mode 100644 index 000000000..b9faf5f4d --- /dev/null +++ b/app/presenters/blacklight/thumbnail_presenter_decorator.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +# OVERRIDE Blacklight 7.35 to pass the query parameters to the UV via the thumbnail URL +module Blacklight + module ThumbnailPresenterDecorator + ## + # Render the thumbnail, if available, for a document and + # link it to the document record. + # + # @param [Hash] image_options to pass to the image tag + # @param [Hash] url_options to pass to #link_to_document + # @return [String] + def thumbnail_tag(image_options = {}, url_options = {}) + value = thumbnail_value(image_options) + return value if value.nil? || url_options[:suppress_link] + view_context.link_to_document document, value, url_options + end + end +end + +Blacklight::ThumbnailPresenter.prepend(Blacklight::ThumbnailPresenterDecorator) diff --git a/app/views/catalog/_thumbnail_list_default.html.erb b/app/views/catalog/_thumbnail_list_default.html.erb new file mode 100644 index 000000000..297bf680a --- /dev/null +++ b/app/views/catalog/_thumbnail_list_default.html.erb @@ -0,0 +1,21 @@ + +<% model = document.hydra_model %> + +<% if params['q'].present? && document.any_highlighting_in_all_text_fields? %> + <% additional_options = params.slice('q').merge( { :highlight=>'true' } ) %> +<% elsif params['q'].present? %> + <% additional_options = params.slice('q') %> +<% else %> + <% additional_options = {} %> +<% end %> + +
+ <% if model == Hyrax::PcdmCollection || model < Hyrax::PcdmCollection %> + <%= document_presenter(document)&.thumbnail&.thumbnail_tag({}, suppress_link: true) %> + <% else %> +
+ <%= document_presenter(document)&.thumbnail&.thumbnail_tag({}, additional_options ) %> +
+ <% end %> +
From 5b18c1d333c5f3dc8b5bc628b5927fcea6baea22 Mon Sep 17 00:00:00 2001 From: LaRita Robinson Date: Wed, 23 Oct 2024 14:12:44 -0400 Subject: [PATCH 5/9] Update IiifPrint to branch --- Gemfile | 2 +- Gemfile.lock | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Gemfile b/Gemfile index 68f8f7f6b..9c1a86143 100644 --- a/Gemfile +++ b/Gemfile @@ -58,7 +58,7 @@ gem 'hyrax-doi', github: 'samvera-labs/hyrax-doi', branch: 'rails_hyrax_upgrade' gem 'hyrax-iiif_av', github: 'samvera-labs/hyrax-iiif_av', branch: 'rails_hyrax_upgrade' gem 'i18n-debug', require: false, group: %i[development test] gem 'i18n-tasks', group: %i[development test] -gem 'iiif_print', github: 'scientist-softserv/iiif_print', branch: 'main' +gem 'iiif_print', github: 'scientist-softserv/iiif_print', branch: 'i769-snippets-rework' gem 'jbuilder', '~> 2.5' gem 'jquery-rails' # Use jquery as the JavaScript library gem 'openssl', '>= 3.2.0' diff --git a/Gemfile.lock b/Gemfile.lock index 5e98235a8..776e372fe 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -194,8 +194,8 @@ GIT GIT remote: https://github.com/scientist-softserv/iiif_print.git - revision: 02f68fc6d93b44b05d826b29645ef182534a51b5 - branch: main + revision: 6e2d7e93f00974be479b815b90d16db9b7ee7f60 + branch: i769-snippets-rework specs: iiif_print (3.0.1) blacklight_iiif_search (>= 1.0, < 3.0) From 02854855d56742b248b4c8fdfd75cedd472c35f5 Mon Sep 17 00:00:00 2001 From: LaRita Robinson Date: Thu, 24 Oct 2024 13:56:49 -0500 Subject: [PATCH 6/9] Fix search Not all items were being found. --- app/controllers/catalog_controller.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/controllers/catalog_controller.rb b/app/controllers/catalog_controller.rb index e997923b1..bd7c75080 100644 --- a/app/controllers/catalog_controller.rb +++ b/app/controllers/catalog_controller.rb @@ -233,7 +233,7 @@ def self.uploaded_field all_names = config.show_fields.values.map(&:field).join(" ") title_name = 'title_tesim' field.solr_parameters = { - qf: "#{all_names} file_format_tesim all_text_timv", + qf: "#{all_names} file_format_tesim all_text_tsimv all_text_tsimv", pf: title_name.to_s } end From 7414f697c7a17a65b45cf1d57a9e787ceec07024 Mon Sep 17 00:00:00 2001 From: LaRita Robinson Date: Thu, 24 Oct 2024 15:12:48 -0500 Subject: [PATCH 7/9] Fix spec --- app/helpers/shared_search_helper.rb | 5 ++--- spec/helpers/shared_search_helper_spec.rb | 23 ++++++++++++++++++++--- 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/app/helpers/shared_search_helper.rb b/app/helpers/shared_search_helper.rb index 94c99dba5..4f3dc5d92 100644 --- a/app/helpers/shared_search_helper.rb +++ b/app/helpers/shared_search_helper.rb @@ -63,12 +63,11 @@ def build_url(id, request_params, account_cname, base_route_name) # @param params [Hash] the query parameters, which may include search queries # @return [String] the URL with appended query parameters, if applicable def append_query_params(url, model, params) + return url if params[:q].blank? if params[:q].present? && model.any_highlighting_in_all_text_fields? "#{url}?parent_query=#{params[:q]}&highlight=true" - elsif params[:q].present? - "#{url}?q=#{params[:q]}" else - url + "#{url}?q=#{params[:q]}" end end diff --git a/spec/helpers/shared_search_helper_spec.rb b/spec/helpers/shared_search_helper_spec.rb index db03c0773..651b2d9df 100644 --- a/spec/helpers/shared_search_helper_spec.rb +++ b/spec/helpers/shared_search_helper_spec.rb @@ -9,7 +9,7 @@ let(:uuid) { SecureRandom.uuid } let(:request) { instance_double(ActionDispatch::Request, port: 3000, protocol: "https://", host: account.cname) } - let(:work_hash) { { id: uuid, 'has_model_ssim': ['GenericWork'], 'account_cname_tesim': account.cname } } + let(:work_hash) { SolrDocument.new(id: uuid, 'has_model_ssim': ['GenericWork'], 'account_cname_tesim': account.cname) } before do allow(helper).to receive(:current_account) { account } @@ -30,7 +30,15 @@ allow(params).to receive(:[]).with(:q).and_return('foo') url = "#{request.protocol}#{cname}/concern/generic_works/#{uuid}?q=foo" - expect(helper.generate_work_url(work_hash, request)).to eq(url) + expect(helper.generate_work_url(work_hash, request, params)).to eq(url) + end + + it 'returns #generate_work_url with a query and highlight true for UV' do + allow(params).to receive(:[]).with(:q).and_return('cat') + allow(work_hash).to receive(:any_highlighting_in_all_text_fields?).and_return(true) + + url = "#{request.protocol}#{cname}/concern/generic_works/#{uuid}?parent_query=cat&highlight=true" + expect(helper.generate_work_url(work_hash, request, params)).to eq(url) end end @@ -46,7 +54,16 @@ allow(params).to receive(:[]).with(:q).and_return('foo') url = "#{request.protocol}#{account.cname}:#{request.port}/concern/generic_works/#{uuid}?q=foo" - expect(helper.generate_work_url(work_hash, request)).to eq(url) + expect(helper.generate_work_url(work_hash, request, params)).to eq(url) + allow(work_hash).to receive(:any_highlighting_in_all_text_fields?).and_return(false) + end + + it 'returns #generate_work_url with a query and highlight true for UV' do + allow(params).to receive(:[]).with(:q).and_return('cat') + allow(work_hash).to receive(:any_highlighting_in_all_text_fields?).and_return(true) + + url = "#{request.protocol}#{account.cname}:#{request.port}/concern/generic_works/#{uuid}?parent_query=cat&highlight=true" + expect(helper.generate_work_url(work_hash, request, params)).to eq(url) end end end From 06ede4b693ef899a3a359263cfdd425ebff1cd8c Mon Sep 17 00:00:00 2001 From: LaRita Robinson Date: Thu, 24 Oct 2024 15:16:19 -0500 Subject: [PATCH 8/9] Revert to main branch of iiif_print --- Gemfile | 2 +- Gemfile.lock | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Gemfile b/Gemfile index 9c1a86143..68f8f7f6b 100644 --- a/Gemfile +++ b/Gemfile @@ -58,7 +58,7 @@ gem 'hyrax-doi', github: 'samvera-labs/hyrax-doi', branch: 'rails_hyrax_upgrade' gem 'hyrax-iiif_av', github: 'samvera-labs/hyrax-iiif_av', branch: 'rails_hyrax_upgrade' gem 'i18n-debug', require: false, group: %i[development test] gem 'i18n-tasks', group: %i[development test] -gem 'iiif_print', github: 'scientist-softserv/iiif_print', branch: 'i769-snippets-rework' +gem 'iiif_print', github: 'scientist-softserv/iiif_print', branch: 'main' gem 'jbuilder', '~> 2.5' gem 'jquery-rails' # Use jquery as the JavaScript library gem 'openssl', '>= 3.2.0' diff --git a/Gemfile.lock b/Gemfile.lock index 776e372fe..9ad7af90b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -194,8 +194,8 @@ GIT GIT remote: https://github.com/scientist-softserv/iiif_print.git - revision: 6e2d7e93f00974be479b815b90d16db9b7ee7f60 - branch: i769-snippets-rework + revision: 7f35ea9e5b4aedc55f2a6abd1dc5181bf9ed75ff + branch: main specs: iiif_print (3.0.1) blacklight_iiif_search (>= 1.0, < 3.0) From f40c3746be8d78466c73703d5e79d2b41dab5e65 Mon Sep 17 00:00:00 2001 From: LaRita Robinson Date: Thu, 24 Oct 2024 20:06:03 -0500 Subject: [PATCH 9/9] Restore markdown --- app/views/catalog/_index_header_list_default.html.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/catalog/_index_header_list_default.html.erb b/app/views/catalog/_index_header_list_default.html.erb index 0b74d2c06..82f035fe9 100644 --- a/app/views/catalog/_index_header_list_default.html.erb +++ b/app/views/catalog/_index_header_list_default.html.erb @@ -1,7 +1,7 @@ <%# OVERRIDE Hyrax v5.0.1 to collection badge and markdown of links %>

- <%= link_to document.title_or_label, generate_work_url(document, request, params) %> + <%= link_to markdown(document.title_or_label), generate_work_url(document, request, params) %>

<% if document.hydra_model == Hyrax.config.collection_class || document.hydra_model < Hyrax.config.collection_class %>