837bc772-cf8b-4e12-a64f-c08713fcbba5

Committed 08 Jul 2025 03:25PM UTC coverage: 95.353% (-0.01%) from 95.366%

Build # 837bc772-cf8b-4e12-a64f-c08713fcbba5

Build Type

Pull #4962

circleci

Committed by

web-flow

Commit Message

Display format as a badge within search results (#4965)

* Update Readme - Development - pre-requisites section

* Add components for displaying format badges

* Use Format badge in place of format_icon helper method

---------

Co-authored-by: Christina Chortaria <actspatial@gmail.com>

Pull Request Pull Request #4962: Orangelight pos workcycle 07-07-2025

Run Details

81 of 85 new or added lines in 14 files covered. (95.29%)

1 existing line in 1 file now uncovered.

6032 of 6326 relevant lines covered (95.35%)

1515.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.94

/app/helpers/holdings_helper.rb

# frozen_string_literal: false

# rubocop:disable Metrics/ModuleLength
module HoldingsHelper
  # Generate the markup block for individual search result items containing holding information
  # @param document [SolrDocument] the Solr Document retrieved in the search result set
  # @return [String] the markup

  def holding_block_search(document)
    block = ''.html_safe
    holdings_hash = document.holdings_all_display
    @scsb_multiple = false

    holdings_hash.first(2).each do |id, holding|
      block << first_two_holdings_block(document, id, holding)
    end

    block << controller.view_context.render(Holdings::OnlineHoldingsComponent.new(document:))

    if @scsb_multiple == true || holdings_hash.length > 2
      block << view_record_for_full_avail_li(document)
    elsif !holdings_hash.empty?
      block << view_record_for_full_avail_li_two(document)
    end

    if block.empty?
      content_tag(:div, t('blacklight.holdings.search_missing'))
    else
      content_tag(:ul, block)
    end
  end

  # rubocop:disable Metrics/MethodLength
  # Currently having trouble breaking up this method further due to the "check_availability" variable
  def first_two_holdings_block(document, id, holding)
    location = holding_location(holding)
    check_availability = render_availability?
    accumulator = ''.html_safe
    if holding['library'] == 'Online'
      rendered_online_holdings_block = controller.view_context.render(Holdings::OnlineHoldingsComponent.new(document:))
      return rendered_online_holdings_block if rendered_online_holdings_block.present?

      check_availability = render_availability?
      accumulator << empty_link_online_holding_block

    else
      if holding['dspace'] || holding['location_code'] == 'rare$num'
        check_availability = false
        accumulator << dspace_or_numismatics_holding_block(location)
      elsif /^scsb.+/.match? location[:code]
        check_availability = false
        unless holding['items'].nil?
          @scsb_multiple = true unless holding['items'].one?
          accumulator << scsb_item_block(holding)
        end
      elsif holding['dspace'].nil?
        accumulator << dspace_not_defined_block(location)
      else
        check_availability = false
        accumulator << under_embargo_block
      end
      accumulator << library_location_div(holding, document, id)
    end
    holding_status_li(accumulator, document, check_availability, id, holding)
  end
  # rubocop:enable Metrics/MethodLength

  def empty_link_online_holding_block
    data = content_tag(
      :span,
      'Link Missing',
      class: 'availability-icon badge bg-secondary'
    )
    data << content_tag(
      :div,
      'Online access is not currently available.',
      class: 'library-location'
    )
  end

  def onsite_access_span
    content_tag(
      :span,
      'On-site access',
      class: 'availability-icon badge bg-success'
    )
  end

  def dspace_or_numismatics_holding_block(_location)
    onsite_access_span
  end

  def scsb_item_block(holding)
    scsb_supervised_items?(holding) ? scsb_supervised_item : scsb_unsupervised_item(holding)
  end

  def scsb_supervised_item
    onsite_access_span
  end

  def scsb_unsupervised_item(holding)
    content_tag(
      :span,
      '',
      class: 'availability-icon badge',
      data: {
        'scsb-availability': 'true',
        'scsb-barcode': holding['items'].first['barcode'].to_s
      }
    )
  end

  def dspace_not_defined_block(_location)
    content_tag(
      :span,
      'Loading...',
      class: 'availability-icon badge bg-secondary'
    )
  end

  def under_embargo_block
    content_tag(
      :span,
      'Unavailable',
      class: 'availability-icon badge bg-danger'
    )
  end

  def library_location_div(holding, document, id)
    content_tag(
      :div,
      search_location_display(holding),
      class: 'library-location',
      data: {
        location: true,
        record_id: document['id'],
        holding_id: id
      }
    )
  end

  def holding_status_li(accumulator, document, check_availability, id, holding)
    location = holding_location(holding)
    content_tag(
      :li,
      accumulator,
      class: 'holding-status',
      data: {
        availability_record: check_availability,
        record_id: document['id'],
        holding_id: id,
        temp_location_code: holding['temp_location_code'],
        aeon: aeon_location?(location),
        bound_with: document.bound_with?
      }.compact
    )
  end

  def view_record_for_full_avail_li(document)
    content_tag(
      :li,
      link_to(
        'View Record for Full Availability',
        solr_document_path(document['id']),
        class: 'availability-icon badge bg-secondary more-info'
      )
    )
  end

  def view_record_for_full_avail_li_two(document)
    content_tag(
      :li,
      link_to(
        '',
        solr_document_path(document['id']),
        class: 'availability-icon more-info'
      ),
      class: 'empty',
      data: { record_id: document['id'] }
    )
  end
end
# rubocop:enable Metrics/ModuleLength

1	# frozen_string_literal: false
2
3	# rubocop:disable Metrics/ModuleLength
4	module HoldingsHelper	3✔
5	# Generate the markup block for individual search result items containing holding information
6	# @param document [SolrDocument] the Solr Document retrieved in the search result set
7	# @return [String] the markup
8
9	def holding_block_search(document)	3✔
10	block = ''.html_safe	818✔
11	holdings_hash = document.holdings_all_display	818✔
12	@scsb_multiple = false	818✔
13
14	holdings_hash.first(2).each do \|id, holding\|	818✔
15	block << first_two_holdings_block(document, id, holding)	748✔
16	end
17
18	block << controller.view_context.render(Holdings::OnlineHoldingsComponent.new(document:))	818✔
19
20	if @scsb_multiple == true \|\| holdings_hash.length > 2	818✔
21	block << view_record_for_full_avail_li(document)	46✔
22	elsif !holdings_hash.empty?	772✔
23	block << view_record_for_full_avail_li_two(document)	637✔
24	end
25
26	if block.empty?	818✔
27	content_tag(:div, t('blacklight.holdings.search_missing'))	39✔
28	else
29	content_tag(:ul, block)	779✔
30	end
31	end
32
33	# rubocop:disable Metrics/MethodLength
34	# Currently having trouble breaking up this method further due to the "check_availability" variable
35	def first_two_holdings_block(document, id, holding)	3✔
36	location = holding_location(holding)	748✔
37	check_availability = render_availability?	748✔
38	accumulator = ''.html_safe	748✔
39	if holding['library'] == 'Online'	748✔
40	rendered_online_holdings_block = controller.view_context.render(Holdings::OnlineHoldingsComponent.new(document:))	×
NEW 41	return rendered_online_holdings_block if rendered_online_holdings_block.present?	×
42
43	check_availability = render_availability?	×
NEW 44	accumulator << empty_link_online_holding_block	×
45
46	else
47	if holding['dspace'] \|\| holding['location_code'] == 'rare$num'	748✔
48	check_availability = false	25✔
49	accumulator << dspace_or_numismatics_holding_block(location)	25✔
50	elsif /^scsb.+/.match? location[:code]	723✔
51	check_availability = false	9✔
52	unless holding['items'].nil?	9✔
53	@scsb_multiple = true unless holding['items'].one?	9✔
54	accumulator << scsb_item_block(holding)	9✔
55	end
56	elsif holding['dspace'].nil?	714✔
57	accumulator << dspace_not_defined_block(location)	714✔
58	else
59	check_availability = false	×
60	accumulator << under_embargo_block	×
61	end
62	accumulator << library_location_div(holding, document, id)	748✔
63	end
64	holding_status_li(accumulator, document, check_availability, id, holding)	748✔
65	end
66	# rubocop:enable Metrics/MethodLength
67
68	def empty_link_online_holding_block	3✔
69	data = content_tag(	×
70	:span,
71	'Link Missing',
72	class: 'availability-icon badge bg-secondary'
73	)
74	data << content_tag(	×
75	:div,
76	'Online access is not currently available.',
77	class: 'library-location'
78	)
79	end
80
81	def onsite_access_span	3✔
82	content_tag(	27✔
83	:span,
84	'On-site access',
85	class: 'availability-icon badge bg-success'
86	)
87	end
88
89	def dspace_or_numismatics_holding_block(_location)	3✔
90	onsite_access_span	25✔
91	end
92
93	def scsb_item_block(holding)	3✔
94	scsb_supervised_items?(holding) ? scsb_supervised_item : scsb_unsupervised_item(holding)	9✔
95	end
96
97	def scsb_supervised_item	3✔
98	onsite_access_span	2✔
99	end
100
101	def scsb_unsupervised_item(holding)	3✔
102	content_tag(	7✔
103	:span,
104	'',
105	class: 'availability-icon badge',
106	data: {
107	'scsb-availability': 'true',
108	'scsb-barcode': holding['items'].first['barcode'].to_s
109	}
110	)
111	end
112
113	def dspace_not_defined_block(_location)	3✔
114	content_tag(	714✔
115	:span,
116	'Loading...',
117	class: 'availability-icon badge bg-secondary'
118	)
119	end
120
121	def under_embargo_block	3✔
122	content_tag(	×
123	:span,
124	'Unavailable',
125	class: 'availability-icon badge bg-danger'
126	)
127	end
128
129	def library_location_div(holding, document, id)	3✔
130	content_tag(	748✔
131	:div,
132	search_location_display(holding),
133	class: 'library-location',
134	data: {
135	location: true,
136	record_id: document['id'],
137	holding_id: id
138	}
139	)
140	end
141
142	def holding_status_li(accumulator, document, check_availability, id, holding)	3✔
143	location = holding_location(holding)	748✔
144	content_tag(	748✔
145	:li,
146	accumulator,
147	class: 'holding-status',
148	data: {
149	availability_record: check_availability,
150	record_id: document['id'],
151	holding_id: id,
152	temp_location_code: holding['temp_location_code'],
153	aeon: aeon_location?(location),
154	bound_with: document.bound_with?
155	}.compact
156	)
157	end
158
159	def view_record_for_full_avail_li(document)	3✔
160	content_tag(	46✔
161	:li,
162	link_to(
163	'View Record for Full Availability',
164	solr_document_path(document['id']),
165	class: 'availability-icon badge bg-secondary more-info'
166	)
167	)
168	end
169
170	def view_record_for_full_avail_li_two(document)	3✔
171	content_tag(	637✔
172	:li,
173	link_to(
174	'',
175	solr_document_path(document['id']),
176	class: 'availability-icon more-info'
177	),
178	class: 'empty',
179	data: { record_id: document['id'] }
180	)
181	end
182	end
183	# rubocop:enable Metrics/ModuleLength

pulibrary / orangelight / 837bc772-cf8b-4e12-a64f-c08713fcbba5

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous