arclight 0.5.0 → 1.0.0.beta2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (218) hide show
  1. checksums.yaml +4 -4
  2. data/.eslintrc +11 -4
  3. data/.github/workflows/ruby.yml +24 -11
  4. data/.rspec +0 -1
  5. data/.rubocop.yml +286 -2
  6. data/.rubocop_todo.yml +18 -195
  7. data/CONTRIBUTING.md +5 -5
  8. data/Gemfile +12 -12
  9. data/README.md +18 -12
  10. data/app/assets/javascripts/arclight/arclight.js +4 -8
  11. data/app/assets/javascripts/arclight/oembed_controller.js +64 -0
  12. data/app/assets/javascripts/arclight/truncate_controller.js +27 -0
  13. data/app/assets/stylesheets/arclight/application.scss +1 -5
  14. data/app/assets/stylesheets/arclight/modules/hierarchy_and_online_contents.scss +104 -130
  15. data/app/assets/stylesheets/arclight/modules/icons.scss +14 -3
  16. data/app/assets/stylesheets/arclight/modules/layout.scss +120 -100
  17. data/app/assets/stylesheets/arclight/modules/mastheads.scss +15 -57
  18. data/app/assets/stylesheets/arclight/modules/repositories.scss +2 -2
  19. data/app/assets/stylesheets/arclight/modules/repository_card.scss +4 -48
  20. data/app/assets/stylesheets/arclight/modules/search_results.scss +86 -35
  21. data/app/assets/stylesheets/arclight/modules/show_collection.scss +5 -32
  22. data/app/assets/stylesheets/arclight/modules/truncator.scss +56 -0
  23. data/app/assets/stylesheets/arclight/variables.scss +7 -4
  24. data/app/components/arclight/access_component.html.erb +14 -0
  25. data/app/components/arclight/access_component.rb +25 -0
  26. data/app/components/arclight/bookmark_component.html.erb +25 -0
  27. data/app/components/arclight/bookmark_component.rb +9 -0
  28. data/app/components/arclight/breadcrumb_component.rb +40 -0
  29. data/app/components/arclight/breadcrumbs_hierarchy_component.html.erb +34 -0
  30. data/app/components/arclight/breadcrumbs_hierarchy_component.rb +25 -0
  31. data/app/components/arclight/collection_context_component.html.erb +12 -0
  32. data/app/components/arclight/collection_context_component.rb +27 -0
  33. data/app/components/arclight/collection_info_component.html.erb +28 -0
  34. data/app/components/arclight/collection_info_component.rb +26 -0
  35. data/app/components/arclight/collection_sidebar_component.html.erb +15 -0
  36. data/app/components/arclight/collection_sidebar_component.rb +41 -0
  37. data/app/{views/catalog/_search_results_repository.html.erb → components/arclight/constraints_component.html.erb} +2 -1
  38. data/app/components/arclight/constraints_component.rb +17 -0
  39. data/app/components/arclight/document_collection_context_component.html.erb +29 -0
  40. data/app/components/arclight/document_collection_context_component.rb +28 -0
  41. data/app/components/arclight/document_collection_hierarchy_component.html.erb +46 -0
  42. data/app/components/arclight/document_collection_hierarchy_component.rb +62 -0
  43. data/app/components/arclight/document_component.html.erb +39 -0
  44. data/app/components/arclight/document_component.rb +49 -0
  45. data/app/components/arclight/document_components_hierarchy_component.html.erb +32 -0
  46. data/app/components/arclight/document_components_hierarchy_component.rb +28 -0
  47. data/app/components/arclight/document_download_component.html.erb +24 -0
  48. data/app/components/arclight/document_download_component.rb +71 -0
  49. data/app/components/arclight/embed_component.html.erb +10 -0
  50. data/app/components/arclight/embed_component.rb +43 -0
  51. data/app/components/arclight/group_component.html.erb +30 -0
  52. data/app/components/arclight/group_component.rb +23 -0
  53. data/app/components/arclight/header_component.html.erb +5 -0
  54. data/app/components/arclight/header_component.rb +10 -0
  55. data/app/components/arclight/index_metadata_field_component.html.erb +17 -0
  56. data/app/components/arclight/index_metadata_field_component.rb +20 -0
  57. data/app/components/arclight/masthead_component.html.erb +15 -0
  58. data/app/components/arclight/masthead_component.rb +10 -0
  59. data/app/components/arclight/metadata_section_component.html.erb +13 -0
  60. data/app/components/arclight/metadata_section_component.rb +22 -0
  61. data/app/components/arclight/oembed_viewer_component.html.erb +5 -0
  62. data/app/components/arclight/oembed_viewer_component.rb +16 -0
  63. data/app/components/arclight/online_content_filter_component.html.erb +15 -0
  64. data/app/components/arclight/online_content_filter_component.rb +19 -0
  65. data/app/components/arclight/online_status_indicator_component.rb +19 -0
  66. data/app/components/arclight/repository_breadcrumb_component.html.erb +10 -0
  67. data/app/components/arclight/repository_breadcrumb_component.rb +17 -0
  68. data/app/components/arclight/repository_location_component.html.erb +20 -0
  69. data/app/components/arclight/repository_location_component.rb +10 -0
  70. data/app/components/arclight/search_bar_component.html.erb +25 -0
  71. data/app/components/arclight/search_bar_component.rb +32 -0
  72. data/app/components/arclight/search_result_breadcrumbs_component.html.erb +3 -0
  73. data/app/components/arclight/search_result_breadcrumbs_component.rb +37 -0
  74. data/app/components/arclight/search_result_component.html.erb +20 -0
  75. data/app/components/arclight/search_result_component.rb +18 -0
  76. data/app/components/arclight/search_result_title_component.html.erb +13 -0
  77. data/app/components/arclight/search_result_title_component.rb +15 -0
  78. data/app/components/arclight/sidebar_component.html.erb +9 -0
  79. data/app/components/arclight/sidebar_component.rb +19 -0
  80. data/app/components/arclight/upper_metadata_layout_component.rb +10 -0
  81. data/app/components/blacklight/icons/bookmark_component.rb +12 -0
  82. data/app/components/blacklight/icons/collection_component.rb +14 -0
  83. data/app/components/blacklight/icons/compact_component.rb +12 -0
  84. data/app/components/blacklight/icons/container_component.rb +14 -0
  85. data/app/components/blacklight/icons/ead_component.rb +12 -0
  86. data/app/components/blacklight/icons/file_component.rb +14 -0
  87. data/app/components/blacklight/icons/folder_component.rb +12 -0
  88. data/app/components/blacklight/icons/online_component.rb +15 -0
  89. data/app/components/blacklight/icons/pdf_component.rb +12 -0
  90. data/app/components/blacklight/icons/repository_component.rb +12 -0
  91. data/app/controllers/arclight/repositories_controller.rb +4 -4
  92. data/app/{controllers/concerns → helpers}/arclight/ead_format_helpers.rb +4 -7
  93. data/app/helpers/arclight/field_config_helpers.rb +26 -0
  94. data/app/helpers/arclight_helper.rb +15 -253
  95. data/app/models/arclight/document_downloads.rb +12 -15
  96. data/app/models/arclight/parent.rb +5 -0
  97. data/app/models/arclight/parents.rb +2 -1
  98. data/app/models/arclight/requests/aeon_external_request.rb +1 -1
  99. data/app/models/arclight/requests/aeon_web_ead.rb +8 -3
  100. data/app/models/arclight/requests/google_form.rb +8 -3
  101. data/app/models/concerns/arclight/catalog.rb +25 -15
  102. data/app/models/concerns/arclight/search_behavior.rb +12 -26
  103. data/app/models/concerns/arclight/solr_document.rb +70 -73
  104. data/app/presenters/arclight/show_presenter.rb +34 -7
  105. data/app/views/arclight/_requests.html.erb +2 -2
  106. data/app/views/arclight/repositories/_repository.html.erb +21 -40
  107. data/app/views/arclight/repositories/index.html.erb +3 -1
  108. data/app/views/arclight/repositories/show.html.erb +4 -6
  109. data/app/views/arclight/requests/_aeon_external_request_endpoint.html.erb +4 -5
  110. data/app/views/arclight/requests/_aeon_web_ead.html.erb +2 -3
  111. data/app/views/arclight/requests/_google_form.html.erb +4 -6
  112. data/app/views/catalog/_group.html.erb +1 -18
  113. data/app/views/catalog/_group_toggle.html.erb +1 -1
  114. data/app/views/catalog/_search_results_header.html.erb +3 -0
  115. data/app/views/catalog/hierarchy.html.erb +19 -0
  116. data/app/views/catalog/index.html.erb +16 -7
  117. data/app/views/shared/_breadcrumbs.html.erb +2 -14
  118. data/app/views/shared/_main_menu_links.html.erb +1 -1
  119. data/arclight.gemspec +7 -6
  120. data/config/breadcrumbs.rb +24 -0
  121. data/config/i18n-tasks.yml +9 -8
  122. data/config/importmap.rb +3 -0
  123. data/config/locales/arclight.en.yml +31 -30
  124. data/config/routes.rb +1 -1
  125. data/docker-compose.yml +16 -0
  126. data/lib/arclight/digital_object.rb +2 -1
  127. data/lib/arclight/engine.rb +18 -31
  128. data/lib/arclight/exceptions.rb +1 -0
  129. data/lib/arclight/hash_absolute_xpath.rb +2 -1
  130. data/lib/arclight/normalized_id.rb +2 -0
  131. data/lib/arclight/normalized_title.rb +2 -0
  132. data/lib/arclight/repository.rb +43 -54
  133. data/lib/arclight/routes/hierarchy.rb +19 -0
  134. data/lib/arclight/routes.rb +8 -0
  135. data/lib/arclight/traject/ead2_component_config.rb +292 -0
  136. data/lib/arclight/traject/ead2_config.rb +66 -287
  137. data/lib/arclight/version.rb +1 -1
  138. data/lib/arclight/year_range.rb +4 -3
  139. data/lib/arclight.rb +6 -1
  140. data/lib/generators/arclight/install_generator.rb +57 -21
  141. data/lib/generators/arclight/templates/arclight.scss +5 -3
  142. data/lib/generators/arclight/templates/catalog_controller.rb +150 -169
  143. data/lib/generators/arclight/templates/config/locales/arclight.en.yml +53 -0
  144. data/lib/generators/arclight/templates/config/repositories.yml +20 -27
  145. data/lib/tasks/index.rake +14 -17
  146. data/package.json +11 -13
  147. data/solr/conf/schema.xml +40 -36
  148. data/solr/conf/solrconfig.xml +33 -31
  149. data/tasks/arclight.rake +8 -7
  150. data/template.rb +0 -1
  151. metadata +113 -106
  152. data/.babelrc +0 -3
  153. data/app/assets/javascripts/arclight/collection_navigation.js +0 -100
  154. data/app/assets/javascripts/arclight/collection_scrollspy.js +0 -6
  155. data/app/assets/javascripts/arclight/context_navigation.js +0 -351
  156. data/app/assets/javascripts/arclight/oembed_viewer.js +0 -46
  157. data/app/assets/javascripts/arclight/truncator.js.erb +0 -29
  158. data/app/assets/stylesheets/arclight/bootstrap_overrides.scss +0 -26
  159. data/app/assets/stylesheets/arclight/modules/context_navigation.scss +0 -75
  160. data/app/controllers/concerns/arclight/field_config_helpers.rb +0 -102
  161. data/app/factories/blacklight_field_configuration_factory.rb +0 -30
  162. data/app/views/arclight/repositories/_in_person_repository.html.erb +0 -19
  163. data/app/views/arclight/repositories/_repository_contact.html.erb +0 -9
  164. data/app/views/arclight/viewers/_oembed.html.erb +0 -8
  165. data/app/views/catalog/_access_contents.html.erb +0 -15
  166. data/app/views/catalog/_arclight_abstract_or_scope.html.erb +0 -5
  167. data/app/views/catalog/_arclight_bookmark_control.html.erb +0 -38
  168. data/app/views/catalog/_arclight_document_header_icon.html.erb +0 -1
  169. data/app/views/catalog/_arclight_document_index_header.html.erb +0 -13
  170. data/app/views/catalog/_arclight_document_index_header_hierarchy_default.html.erb +0 -0
  171. data/app/views/catalog/_arclight_document_index_header_online_contents_default.html.erb +0 -0
  172. data/app/views/catalog/_arclight_index_compact_default.html.erb +0 -22
  173. data/app/views/catalog/_arclight_index_default.html.erb +0 -45
  174. data/app/views/catalog/_arclight_index_group_document_compact_default.html.erb +0 -19
  175. data/app/views/catalog/_arclight_index_group_document_default.html.erb +0 -18
  176. data/app/views/catalog/_arclight_online_content_indicator.html.erb +0 -3
  177. data/app/views/catalog/_arclight_rangelimit.html.erb +0 -24
  178. data/app/views/catalog/_arclight_viewer_default.html.erb +0 -1
  179. data/app/views/catalog/_collection_contents.html.erb +0 -4
  180. data/app/views/catalog/_collection_context.html.erb +0 -15
  181. data/app/views/catalog/_collection_context_nav.html.erb +0 -12
  182. data/app/views/catalog/_collection_online_contents.html.erb +0 -17
  183. data/app/views/catalog/_component_context.html.erb +0 -5
  184. data/app/views/catalog/_containers.html.erb +0 -3
  185. data/app/views/catalog/_context_card.html.erb +0 -27
  186. data/app/views/catalog/_context_sidebar.html.erb +0 -8
  187. data/app/views/catalog/_custom_metadata.html.erb +0 -16
  188. data/app/views/catalog/_document_downloads.html.erb +0 -14
  189. data/app/views/catalog/_group_header_compact_default.html.erb +0 -15
  190. data/app/views/catalog/_group_header_default.html.erb +0 -20
  191. data/app/views/catalog/_home.html.erb +0 -1
  192. data/app/views/catalog/_index_breadcrumb_default.html.erb +0 -6
  193. data/app/views/catalog/_index_collection_context_default.html.erb +0 -53
  194. data/app/views/catalog/_index_default.html.erb +0 -17
  195. data/app/views/catalog/_index_header.html.erb +0 -7
  196. data/app/views/catalog/_index_header_online_contents_default.html.erb +0 -1
  197. data/app/views/catalog/_index_online_contents_default.html.erb +0 -6
  198. data/app/views/catalog/_online_content_label.html.erb +0 -5
  199. data/app/views/catalog/_search_form.html.erb +0 -38
  200. data/app/views/catalog/_search_results.html.erb +0 -28
  201. data/app/views/catalog/_show_actions_box_default.html.erb +0 -27
  202. data/app/views/catalog/_show_breadcrumbs_default.html.erb +0 -6
  203. data/app/views/catalog/_show_collection.html.erb +0 -66
  204. data/app/views/catalog/_show_default.html.erb +0 -70
  205. data/app/views/catalog/_show_upper_metadata_collection.html.erb +0 -1
  206. data/app/views/catalog/_show_upper_metadata_default.html.erb +0 -14
  207. data/app/views/catalog/_sort_and_per_page.html.erb +0 -8
  208. data/app/views/catalog/_within_collection_dropdown.html.erb +0 -26
  209. data/app/views/layouts/catalog_result.html.erb +0 -7
  210. data/app/views/shared/_context_sidebar.html.erb +0 -8
  211. data/app/views/shared/_header_navbar.html.erb +0 -61
  212. data/app/views/shared/_show_breadcrumbs.html.erb +0 -27
  213. data/lib/arclight/viewer.rb +0 -45
  214. data/lib/arclight/viewers/oembed.rb +0 -57
  215. data/solr/conf/scripts.conf +0 -24
  216. data/vendor/assets/javascripts/responsiveTruncator.js +0 -69
  217. data/vendor/assets/javascripts/stickyfill.js +0 -480
  218. /data/app/assets/images/{blacklight → arclight}/logo.png +0 -0
@@ -0,0 +1,41 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Draw the links to the collection info in the sidebar
5
+ class CollectionSidebarComponent < ViewComponent::Base
6
+ def initialize(document:, partials:, collection_presenter:)
7
+ super
8
+
9
+ @document = document
10
+ @partials = Array(partials)
11
+ @collection_presenter = collection_presenter
12
+ end
13
+
14
+ attr_reader :document, :partials, :collection_presenter
15
+
16
+ def has_section?(section)
17
+ # Access field data comes from repositories.yml not from solr, so handle it in a different way.
18
+ return true if section == :access_field
19
+
20
+ collection_presenter.with_field_group(section).fields_to_render.any?
21
+ end
22
+
23
+ def document_section_path(section)
24
+ [document_path, section_anchor(section)].join
25
+ end
26
+
27
+ def section_label(section)
28
+ t("arclight.views.show.sections.#{section}")
29
+ end
30
+
31
+ def document_path
32
+ @document_path ||= solr_document_path(normalized_eadid)
33
+ end
34
+
35
+ def section_anchor(section)
36
+ "##{t("arclight.views.show.sections.#{section}").parameterize}"
37
+ end
38
+
39
+ delegate :normalized_eadid, to: :document
40
+ end
41
+ end
@@ -1,6 +1,7 @@
1
- <% repository = repository_faceted_on %>
2
1
  <% if repository %>
3
2
  <div class="al-repository-card">
4
3
  <%= render repository %>
5
4
  </div>
6
5
  <% end %>
6
+
7
+ <%= render Blacklight::ConstraintsComponent.new(**@kwargs) %>
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Extend the upstream constraints with breadcrumbs and
5
+ # repository context information
6
+ class ConstraintsComponent < Blacklight::ConstraintsComponent
7
+ def initialize(**kwargs)
8
+ super
9
+
10
+ @kwargs = kwargs
11
+ end
12
+
13
+ def repository
14
+ @repository ||= helpers.repository_faceted_on
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,29 @@
1
+ <%= tag.tr(
2
+ id: @document.id,
3
+ data: {
4
+ 'document-id': @document.id.to_s.parameterize,
5
+ 'document-counter': @counter,
6
+ },
7
+ itemscope: true,
8
+ itemtype: @document.itemtype,
9
+ class: classes.join(' ')) do %>
10
+ <td data-document-id="<%= document.id %>">
11
+ <div class="index_title document-title-heading" data-turbo="false">
12
+ <%= helpers.link_to_document document, counter: @counter %>
13
+ <% if document.children? %>
14
+ <span class="badge badge-pill bg-secondary badge-secondary al-number-of-children-badge"><%= document.number_of_children %><span class="sr-only visually-hidden"><%= t(:'arclight.views.index.number_of_components', count: document.number_of_children) %></span></span>
15
+ <% end %>
16
+ </div>
17
+ </td>
18
+
19
+ <%= tag.td class: 'text-muted' do %>
20
+ <%= document.containers.join(', ') %>
21
+ <% end %>
22
+
23
+ <%= tag.td class: 'text-end' do %>
24
+ <%= helpers.render_index_doc_actions document, wrapping_class: 'd-inline-flex justify-content-end' %>
25
+ <% end %>
26
+ </div>
27
+
28
+ <%= render Arclight::IndexMetadataFieldComponent.with_collection(@presenter&.field_presenters.select { |field| field.field_config.collection_context }, classes: ['col pl-0 my-0']) %>
29
+ <% end %>
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Display a single document in the collection
5
+ class DocumentCollectionContextComponent < Arclight::SearchResultComponent
6
+ # @param [SolrDocument] document
7
+ def initialize(document: nil, blacklight_config: nil, **kwargs)
8
+ super(document: document, **kwargs)
9
+ @blacklight_config = blacklight_config
10
+ end
11
+
12
+ attr_reader :blacklight_config
13
+
14
+ def classes
15
+ (super - ['row'] + ['al-collection-context']).flatten
16
+ end
17
+
18
+ private
19
+
20
+ def online_status
21
+ render online_status_component.new(document: @document)
22
+ end
23
+
24
+ def online_status_component
25
+ blacklight_config.show.online_status_component || Arclight::OnlineStatusIndicatorComponent
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,46 @@
1
+ <%= content_tag :li,
2
+ id: @document.id,
3
+ data: {
4
+ 'document-id': @document.id.to_s.parameterize,
5
+ 'document-counter': @counter,
6
+ },
7
+ itemscope: true,
8
+ itemtype: @document.itemtype,
9
+ class: (classes.flatten + ['al-collection-context', ('al-hierarchy-highlight' if current_target?)].compact).join(' ') do %>
10
+ <div class="documentHeader" data-document-id="<%= document.id %>">
11
+ <% if document.children? %>
12
+ <%= link_to('',
13
+ "##{document.id}-collapsible-hierarchy",
14
+ class: "al-toggle-view-children#{ ' collapsed' unless show_expanded?}",
15
+ aria: {
16
+ label: t('arclight.hierarchy.view_all'),
17
+ expanded: show_expanded?
18
+ },
19
+ data: {
20
+ bs_toggle: 'collapse',
21
+ toggle: 'collapse'
22
+ }
23
+ )
24
+ %>
25
+ <% end %>
26
+ <div class="index_title document-title-heading" data-turbo="false">
27
+ <%= helpers.link_to_document document, counter: @counter %>
28
+ <% if document.children? %>
29
+ <span class="badge badge-pill bg-secondary badge-secondary al-number-of-children-badge"><%= document.number_of_children %><span class="sr-only visually-hidden"><%= t(:'arclight.views.index.number_of_components', count: document.number_of_children) %></span></span>
30
+ <% end %>
31
+ <%= online_status %>
32
+ </div>
33
+ <%= content_tag('div', class: 'al-document-container text-muted') do %>
34
+ <%= document.containers.join(', ') %>
35
+ <% end if document.containers.present? %>
36
+ </div>
37
+
38
+ <%= render Arclight::IndexMetadataFieldComponent.with_collection(@presenter&.field_presenters.select { |field| field.field_config.collection_context }, classes: ['col pl-0 my-0']) %>
39
+ <% if document.number_of_children > 0 %>
40
+ <%= content_tag(:div, id: "#{document.id}-collapsible-hierarchy",
41
+ class: "collapse al-collection-context-collapsible al-hierarchy-level-#{document.component_level} #{'show' if show_expanded?}"
42
+ ) do %>
43
+ <%= render Arclight::DocumentComponentsHierarchyComponent.new(document: @document, target_index: target_index) %>
44
+ <% end %>
45
+ <% end %>
46
+ <% end %>
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Display a single document in the collection hierarchy
5
+ class DocumentCollectionHierarchyComponent < Arclight::SearchResultComponent
6
+ # @param [Blacklight::DocumentPresenter] document
7
+ # @param [String] nest_path determines which element to highlight
8
+ def initialize(document: nil, nest_path: nil, blacklight_config: nil, **kwargs)
9
+ super(document: document, **kwargs)
10
+ @nest_path = nest_path
11
+ @blacklight_config = blacklight_config
12
+ end
13
+
14
+ attr_reader :blacklight_config
15
+
16
+ def classes
17
+ super - ['row']
18
+ end
19
+
20
+ # we want to eager-load this document's children if we're in the
21
+ # target document's component hierarchy
22
+ def show_expanded?
23
+ within_original_tree?
24
+ end
25
+
26
+ # Solr nest paths are constructed using the path name and an index, e.g.
27
+ # `/components#5/components#3`.
28
+ #
29
+ # @return [String] the targeted index for this level of the hierarchy
30
+ def target_index
31
+ return -1 unless within_original_tree?
32
+
33
+ remaining_path = nest_path.sub("#{@document.nest_path}/", '')
34
+ current_component, _rest = remaining_path.split('/', 2)
35
+ _name, index = current_component.split('#', 2)
36
+
37
+ index&.to_i
38
+ end
39
+
40
+ private
41
+
42
+ # We're in the targeted document's original tree if the target nest path
43
+ # includes this document's path.
44
+ def within_original_tree?
45
+ nest_path&.start_with? "#{@document.nest_path}/"
46
+ end
47
+
48
+ def current_target?
49
+ nest_path == @document.nest_path
50
+ end
51
+
52
+ def online_status
53
+ render online_status_component.new(document: @document)
54
+ end
55
+
56
+ def online_status_component
57
+ blacklight_config.show.online_status_component || Arclight::OnlineStatusIndicatorComponent
58
+ end
59
+
60
+ attr_reader :nest_path
61
+ end
62
+ end
@@ -0,0 +1,39 @@
1
+ <div class='d-md-flex justify-content-between al-show'>
2
+ <div class='al-show-breadcrumb'>
3
+ <nav aria-label="breadcrumb">
4
+ <%= render breadcrumb_component.new(presenter: presenter) %>
5
+ </nav>
6
+ </div>
7
+ </div>
8
+
9
+ <div class="title-container">
10
+ <%= content_tag :h1 do %>
11
+ <%= document.normalized_title %>
12
+ <% end %>
13
+ <%= render 'arclight/requests', document: document %>
14
+ <%= render Arclight::BookmarkComponent.new document: document, action: bookmark_config %>
15
+ <%= toggle_sidebar %>
16
+ <%= online_filter %>
17
+ </div>
18
+
19
+ <%= render Arclight::MetadataSectionComponent.with_collection(component_metadata_partials,
20
+ metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent },
21
+ presenter: presenter) unless document.collection? %>
22
+
23
+ <%= embed %>
24
+
25
+ <% if document.collection? %>
26
+ <div id="metadata">
27
+ <h2 class="sr-only visually-hidden"><%= t 'arclight.views.show.context' %></h2>
28
+ <%= render Arclight::MetadataSectionComponent.with_collection(metadata_partials,
29
+ metadata_attr: { layout: Arclight::UpperMetadataLayoutComponent },
30
+ presenter: presenter, heading: true) %>
31
+ </div>
32
+ <% elsif document.children? %>
33
+ <div id="contents">
34
+ <h2 class="al-show-sub-heading"><%= t 'arclight.views.show.contents' %></h2>
35
+ <%= helpers.turbo_frame_tag "al-hierarchy-#{document.id}", loading: 'lazy', src: helpers.hierarchy_solr_document_path(id: document.id, paginate: true, per_page: 50) %>
36
+ </div>
37
+ <% end %>
38
+
39
+ <%= access %>
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Render a single document
5
+ class DocumentComponent < Blacklight::DocumentComponent
6
+ attr_reader :document
7
+
8
+ def online_content?
9
+ document.online_content? && (document.collection? || document.children?)
10
+ end
11
+
12
+ def blacklight_config
13
+ presenter.configuration
14
+ end
15
+
16
+ # @return [Blacklight::Configuration::ToolConfig] the configuration for the bookmark
17
+ def bookmark_config
18
+ blacklight_config.index.document_actions.arclight_bookmark_control
19
+ end
20
+
21
+ def breadcrumb_component
22
+ blacklight_config.show.breadcrumb_component || Arclight::BreadcrumbsHierarchyComponent
23
+ end
24
+
25
+ def metadata_partials
26
+ blacklight_config.show.metadata_partials || []
27
+ end
28
+
29
+ def component_metadata_partials
30
+ blacklight_config.show.component_metadata_partials || []
31
+ end
32
+
33
+ def online_filter
34
+ render Arclight::OnlineContentFilterComponent.new(document: document)
35
+ end
36
+
37
+ def access
38
+ render (blacklight_config.show.access_component || Arclight::AccessComponent).new(presenter: presenter)
39
+ end
40
+
41
+ def toggle_sidebar
42
+ button_tag(t('arclight.views.show.toggle_sidebar'),
43
+ type: :button,
44
+ class: 'btn btn-sm btn-secondary d-lg-none sidebar-toggle',
45
+ data: { bs_toggle: 'offcanvas', bs_target: '#sidebar' },
46
+ aria: { controls: 'sidebar' })
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,32 @@
1
+ <% if paginate? && @target_index >= 0 && @target_index >= @maximum_left_gap %>
2
+ <%# render the hierarchy as: outer (left) window ... window ... because our current document hierarchy is so far down the list it'd be buried %>
3
+ <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}-left", loading: 'lazy', src: hierarchy_path(limit: @left_outer_window, key: '-left') %>
4
+ <%= tag.turbo_frame id: "al-hierarchy-#{@document.id}-gap" do %>
5
+ <ul>
6
+ <li>
7
+ <%= link_to t('arclight.views.show.expand'), hierarchy_path(offset: @left_outer_window, limit: @target_index - @left_outer_window - (@window / 2), key: '-gap'), class: 'btn btn-secondary btn-sm' %>
8
+ </li>
9
+ </ul>
10
+ <% end %>
11
+ <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}-window", src: hierarchy_path(offset: @target_index - (@window / 2), limit: @window, key: '-window') %>
12
+ <%= tag.turbo_frame id: "al-hierarchy-#{@document.id}-right" do %>
13
+ <ul>
14
+ <li>
15
+ <%= link_to t('arclight.views.show.expand'), hierarchy_path(offset: @target_index + (@window / 2), key: '-right'), class: 'btn btn-secondary btn-sm' %>
16
+ </li>
17
+ </ul>
18
+ <% end %>
19
+ <% elsif paginate? %>
20
+ <%# render the first N documents, and let the user expand the remaining if desired %>
21
+ <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}", loading: ('lazy' unless @target_index >= 0), src: hierarchy_path(limit: @maximum_left_gap) %>
22
+ <%= tag.turbo_frame id: "al-hierarchy-#{@document.id}-right" do %>
23
+ <ul>
24
+ <li>
25
+ <%= link_to t('arclight.views.show.expand'), hierarchy_path(offset: @maximum_left_gap, key: '-right'), class: 'btn btn-secondary btn-sm' %>
26
+ </li>
27
+ </ul>
28
+ <% end %>
29
+ <% else %>
30
+ <%# there aren't enough to bother paginating, so load them all at once %>
31
+ <%= helpers.turbo_frame_tag "al-hierarchy-#{@document.id}", loading: ('lazy' unless @target_index >= 0), src: hierarchy_path %>
32
+ <% end %>
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Display a document's constituent components with appropriate lazy-loading
5
+ # to keep the page load time reasonable.
6
+ class DocumentComponentsHierarchyComponent < ViewComponent::Base
7
+ # rubocop:disable Metrics/ParameterLists
8
+ def initialize(document: nil, target_index: -1, minimum_pagination_size: 20, left_outer_window: 3, maximum_left_gap: 10, window: 10)
9
+ super
10
+
11
+ @document = document
12
+ @target_index = target_index&.to_i || -1
13
+ @minimum_pagination_size = minimum_pagination_size
14
+ @left_outer_window = left_outer_window
15
+ @maximum_left_gap = maximum_left_gap
16
+ @window = window
17
+ end
18
+ # rubocop:enable Metrics/ParameterLists
19
+
20
+ def paginate?
21
+ @document.number_of_children > @minimum_pagination_size
22
+ end
23
+
24
+ def hierarchy_path(**kwargs)
25
+ helpers.hierarchy_solr_document_path(id: @document.id, hierarchy: true, nest_path: params[:nest_path], **kwargs)
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,24 @@
1
+ <div class="al-show-actions-box-downloads-container">
2
+ <% case files.size %>
3
+ <% when 2 %>
4
+ <div class="dropdown">
5
+ <button class="btn btn-secondary btn-sm dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
6
+ <%= t("arclight.views.show.download.default") %>
7
+ </button>
8
+ <ul class="dropdown-menu">
9
+ <% files.each do |file| %>
10
+ <li><%= link_to(file.href, class: "dropdown-item", **@link_options) do %>
11
+ <%= icon_for(file.type) %> <%= dropdown_label(file) %>
12
+ <% end %>
13
+ </li>
14
+ <% end %>
15
+ </ul>
16
+ </div>
17
+ <% when 1 %>
18
+ <% files.each do |file| %>
19
+ <%= link_to(file.href, class: "btn btn-secondary btn-sm", **@link_options) do %>
20
+ <%= download_icon %> <%= label(file) %>
21
+ <% end %>
22
+ <% end %>
23
+ <% end %>
24
+ </div>
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # ViewComponent for rendering a single document download link
5
+ class DocumentDownloadComponent < ViewComponent::Base
6
+ def initialize(downloads:, **kwargs)
7
+ super
8
+
9
+ @downloads = downloads
10
+ @link_options = kwargs
11
+ end
12
+
13
+ attr_reader :downloads
14
+
15
+ delegate :files, to: :downloads
16
+
17
+ def render?
18
+ files.present?
19
+ end
20
+
21
+ # i18n-tasks-use t('arclight.views.show.download.multiple.pdf')
22
+ # i18n-tasks-use t('arclight.views.show.download.multiple.ead')
23
+ def dropdown_label(file)
24
+ t(file.type, scope: 'arclight.views.show.download.multiple')
25
+ end
26
+
27
+ # i18n-tasks-use t('arclight.views.show.download.single.pdf')
28
+ # i18n-tasks-use t('arclight.views.show.download.single.ead')
29
+ def label(file)
30
+ t(file.type, scope: 'arclight.views.show.download.single')
31
+ end
32
+
33
+ # From https://icons.getbootstrap.com/icons/download/
34
+ def download_icon
35
+ icon = <<~HTML
36
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-download" viewBox="0 0 16 16">
37
+ <path d="M.5 9.9a.5.5 0 0 1 .5.5v2.5a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1v-2.5a.5.5 0 0 1 1 0v2.5a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2v-2.5a.5.5 0 0 1 .5-.5z"/>
38
+ <path d="M7.646 11.854a.5.5 0 0 0 .708 0l3-3a.5.5 0 0 0-.708-.708L8.5 10.293V1.5a.5.5 0 0 0-1 0v8.793L5.354 8.146a.5.5 0 1 0-.708.708l3 3z"/>
39
+ </svg>
40
+ HTML
41
+ icon.html_safe # rubocop:disable Rails/OutputSafety
42
+ end
43
+
44
+ # This is an extension point where one could configure a different icon per file type
45
+ def icon_for(type)
46
+ public_send("#{type}_icon")
47
+ end
48
+
49
+ # From https://icons.getbootstrap.com/icons/file-earmark-pdf/
50
+ def pdf_icon
51
+ icon = <<~HTML
52
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-file-earmark-pdf" viewBox="0 0 16 16">
53
+ <path d="M14 14V4.5L9.5 0H4a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h8a2 2 0 0 0 2-2zM9.5 3A1.5 1.5 0 0 0 11 4.5h2V14a1 1 0 0 1-1 1H4a1 1 0 0 1-1-1V2a1 1 0 0 1 1-1h5.5v2z"/>
54
+ <path d="M4.603 14.087a.81.81 0 0 1-.438-.42c-.195-.388-.13-.776.08-1.102.198-.307.526-.568.897-.787a7.68 7.68 0 0 1 1.482-.645 19.697 19.697 0 0 0 1.062-2.227 7.269 7.269 0 0 1-.43-1.295c-.086-.4-.119-.796-.046-1.136.075-.354.274-.672.65-.823.192-.077.4-.12.602-.077a.7.7 0 0 1 .477.365c.088.164.12.356.127.538.007.188-.012.396-.047.614-.084.51-.27 1.134-.52 1.794a10.954 10.954 0 0 0 .98 1.686 5.753 5.753 0 0 1 1.334.05c.364.066.734.195.96.465.12.144.193.32.2.518.007.192-.047.382-.138.563a1.04 1.04 0 0 1-.354.416.856.856 0 0 1-.51.138c-.331-.014-.654-.196-.933-.417a5.712 5.712 0 0 1-.911-.95 11.651 11.651 0 0 0-1.997.406 11.307 11.307 0 0 1-1.02 1.51c-.292.35-.609.656-.927.787a.793.793 0 0 1-.58.029zm1.379-1.901c-.166.076-.32.156-.459.238-.328.194-.541.383-.647.547-.094.145-.096.25-.04.361.01.022.02.036.026.044a.266.266 0 0 0 .035-.012c.137-.056.355-.235.635-.572a8.18 8.18 0 0 0 .45-.606zm1.64-1.33a12.71 12.71 0 0 1 1.01-.193 11.744 11.744 0 0 1-.51-.858 20.801 20.801 0 0 1-.5 1.05zm2.446.45c.15.163.296.3.435.41.24.19.407.253.498.256a.107.107 0 0 0 .07-.015.307.307 0 0 0 .094-.125.436.436 0 0 0 .059-.2.095.095 0 0 0-.026-.063c-.052-.062-.2-.152-.518-.209a3.876 3.876 0 0 0-.612-.053zM8.078 7.8a6.7 6.7 0 0 0 .2-.828c.031-.188.043-.343.038-.465a.613.613 0 0 0-.032-.198.517.517 0 0 0-.145.04c-.087.035-.158.106-.196.283-.04.192-.03.469.046.822.024.111.054.227.09.346z"/>
55
+ </svg>
56
+ HTML
57
+ icon.html_safe # rubocop:disable Rails/OutputSafety
58
+ end
59
+
60
+ # From https://icons.getbootstrap.com/icons/file-earmark-code/
61
+ def ead_icon
62
+ icon = <<~HTML
63
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-file-earmark-code" viewBox="0 0 16 16">
64
+ <path d="M14 4.5V14a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V2a2 2 0 0 1 2-2h5.5L14 4.5zm-3 0A1.5 1.5 0 0 1 9.5 3V1H4a1 1 0 0 0-1 1v12a1 1 0 0 0 1 1h8a1 1 0 0 0 1-1V4.5h-2z"/>
65
+ <path d="M8.646 6.646a.5.5 0 0 1 .708 0l2 2a.5.5 0 0 1 0 .708l-2 2a.5.5 0 0 1-.708-.708L10.293 9 8.646 7.354a.5.5 0 0 1 0-.708zm-1.292 0a.5.5 0 0 0-.708 0l-2 2a.5.5 0 0 0 0 .708l2 2a.5.5 0 0 0 .708-.708L5.707 9l1.647-1.646a.5.5 0 0 0 0-.708z"/>
66
+ </svg>
67
+ HTML
68
+ icon.html_safe # rubocop:disable Rails/OutputSafety
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,10 @@
1
+ <div id="embed" class="mb-2">
2
+ <h2 class="al-show-sub-heading"><%= t('arclight.views.show.embedded_content') %></h2>
3
+ <%= render Arclight::OembedViewerComponent.with_collection(embeddable_resources, document: @document) %>
4
+
5
+ <% linked_resources.each do |resource| %>
6
+ <div class="al-digital-object">
7
+ <%= link_to(resource.label, resource.href) %>
8
+ </div>
9
+ <% end %>
10
+ </div>
@@ -0,0 +1,43 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Render digital object links for a document
5
+ class EmbedComponent < ViewComponent::Base
6
+ def initialize(document:, presenter:, **kwargs)
7
+ super
8
+
9
+ @document = document
10
+ @presenter = presenter
11
+ end
12
+
13
+ def render?
14
+ resources.any?
15
+ end
16
+
17
+ def embeddable_resources
18
+ resources.first(1).select { |object| embeddable?(object) }
19
+ end
20
+
21
+ def linked_resources
22
+ resources - embeddable_resources
23
+ end
24
+
25
+ def resources
26
+ @resources ||= @document.digital_objects || []
27
+ end
28
+
29
+ def depth
30
+ @document.parents.length || 0
31
+ end
32
+
33
+ def embeddable?(object)
34
+ exclude_patterns.none? do |pattern|
35
+ object.href =~ pattern
36
+ end
37
+ end
38
+
39
+ def exclude_patterns
40
+ Arclight::Engine.config.oembed_resource_exclude_patterns
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,30 @@
1
+ <div class='al-grouped-title-bar'>
2
+ <div class='row'>
3
+ <div class='col-md-12'>
4
+ <% if document.repository_config.present? %>
5
+ <div class='al-grouped-repository breadcrumb-links'>
6
+ <%= link_to(document.repository_config.name, helpers.arclight_engine.repository_path(document.repository_config.slug)) %>
7
+ </div>
8
+ <% end %>
9
+ <h3><%= helpers.link_to_document document %></h3>
10
+ <%= tag.span(document.extent, class: 'al-document-extent badge') if document.extent %>
11
+ <%= render Arclight::IndexMetadataFieldComponent.with_collection(presenter.field_presenters.select { |field| !compact? || field.field_config.compact }) %>
12
+ </div>
13
+ </div>
14
+ </div>
15
+
16
+ <div class="grouped-documents">
17
+ <div class="al-grouped-more">
18
+ <% if @group.total > 3 %>
19
+ <%= t('arclight.views.index.top_group_results', count: 3) %>
20
+ <%= link_to(
21
+ t('arclight.views.index.all_group_results', count: @group.total),
22
+ search_within_collection_url)
23
+ %>
24
+ <% else %>
25
+ <%= t('arclight.views.index.group_results_count', count: @group.total) %>
26
+ <% end %>
27
+ </div>
28
+
29
+ <%= helpers.render_document_index @group.docs %>
30
+ </div>
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Render a collection document for a
5
+ # grouped search result view
6
+ class GroupComponent < Blacklight::Document::GroupComponent
7
+ def compact?
8
+ helpers.document_index_view_type.to_s == 'compact'
9
+ end
10
+
11
+ def document
12
+ @document ||= @group.docs.first.collection
13
+ end
14
+
15
+ def presenter
16
+ @presenter ||= Arclight::ShowPresenter.new(document, helpers).with_field_group('group_header_field')
17
+ end
18
+
19
+ def search_within_collection_url
20
+ search_catalog_path(helpers.search_without_group.merge(f: { collection: [document.collection_name] }))
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,5 @@
1
+ <header>
2
+ <%= top_bar %>
3
+ <%= masthead %>
4
+ <%= search_bar %>
5
+ </header>
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Provides a header with a masthead
5
+ class HeaderComponent < Blacklight::HeaderComponent
6
+ def masthead
7
+ render Arclight::MastheadComponent.new
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,17 @@
1
+ <div class="row">
2
+ <%= tag.dt @field.label, class: 'visually-hidden' %>
3
+ <% if truncate? %>
4
+ <%= tag.dd(class: @classes + ['truncator'], data: { controller: 'arclight-truncate' }) do %>
5
+ <%= tag.div @field.render, class: 'content', data: { arclight_truncate_target: 'content' } %>
6
+ <%= button_tag(type: :button, class: 'btn btn-sm btn-link px-0',
7
+ data: { action: 'click->arclight-truncate#trigger' },
8
+ aria: { hidden: true }) do %>
9
+ <%= tag.span t('arclight.truncation.view_more'), class: 'view-more' %>
10
+ <%= tag.span t('arclight.truncation.view_less'), class: 'view-less' %>
11
+ <%= tag.span(class: 'icon') %>
12
+ <% end %>
13
+ <% end %>
14
+ <% else %>
15
+ <%= tag.dd @field.render, class: @classes %>
16
+ <% end %>
17
+ </div>
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Arclight
4
+ # Render a simple metadata field (e.g. without labels) in a .row div
5
+ class IndexMetadataFieldComponent < Blacklight::MetadataFieldComponent
6
+ def initialize(field:, classes: ['col'], **kwargs)
7
+ super(field: field, **kwargs)
8
+
9
+ @classes = classes + ["al-document-#{@field.key.dasherize}"]
10
+ end
11
+
12
+ def render?
13
+ helpers.document_index_view_type != :compact || @field.field_config.compact
14
+ end
15
+
16
+ def truncate?
17
+ !!@field.field_config.truncate
18
+ end
19
+ end
20
+ end