arclight 0.1.0 → 1.6.2

data/app/components/blacklight/icons/compact_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The compact icon
+    class CompactComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 24 24"><path d="M3,15H21V13H3Zm0,4H21V17H3Zm0-8H21V9H3ZM3,5V7H21V5Z"/></svg>
+      SVG
+    end
+  end
+end

data/app/components/blacklight/icons/container_component.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The container icon
+    class ContainerComponent < Blacklight::Icons::IconComponent
+      # Used unmodified from https://fontawesome.com
+      # CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 512 512"><path d="M464 128H272l-64-64H48C21.49 64 0 85.49 0 112v288c0 26.51 21.49 48 48 48h416c26.51 0 48-21.49 48-48V176c0-26.51-21.49-48-48-48z"/></svg>
+      SVG
+    end
+  end
+end

data/app/components/blacklight/icons/ead_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The ead icon
+    class EadComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 384 512"><path d="M149.9 349.1l-.2-.2-32.8-28.9 32.8-28.9c3.6-3.2 4-8.8.8-12.4l-.2-.2-17.4-18.6c-3.4-3.6-9-3.7-12.4-.4l-57.7 54.1c-3.7 3.5-3.7 9.4 0 12.8l57.7 54.1c1.6 1.5 3.8 2.4 6 2.4 2.4 0 4.8-1 6.4-2.8l17.4-18.6c3.3-3.5 3.1-9.1-.4-12.4zm220-251.2L286 14C277 5 264.8-.1 252.1-.1H48C21.5 0 0 21.5 0 48v416c0 26.5 21.5 48 48 48h288c26.5 0 48-21.5 48-48V131.9c0-12.7-5.1-25-14.1-34zM256 51.9l76.1 76.1H256zM336 464H48V48h160v104c0 13.3 10.7 24 24 24h104zM209.6 214c-4.7-1.4-9.5 1.3-10.9 6L144 408.1c-1.4 4.7 1.3 9.6 6 10.9l24.4 7.1c4.7 1.4 9.6-1.4 10.9-6L240 231.9c1.4-4.7-1.3-9.6-6-10.9zm24.5 76.9l.2.2 32.8 28.9-32.8 28.9c-3.6 3.2-4 8.8-.8 12.4l.2.2 17.4 18.6c3.3 3.5 8.9 3.7 12.4.4l57.7-54.1c3.7-3.5 3.7-9.4 0-12.8l-57.7-54.1c-3.5-3.3-9.1-3.2-12.4.4l-17.4 18.6c-3.3 3.5-3.1 9.1.4 12.4z"/></svg>
+      SVG
+    end
+  end
+end

data/app/components/blacklight/icons/file_component.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The file icon
+    class FileComponent < Blacklight::Icons::IconComponent
+      # Used unmodified from https://fontawesome.com
+      # CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 384 512"><path d="M224 136V0H24C10.7 0 0 10.7 0 24v464c0 13.3 10.7 24 24 24h336c13.3 0 24-10.7 24-24V160H248c-13.2 0-24-10.8-24-24zm160-14.1v6.1H256V0h6.1c6.4 0 12.5 2.5 17 7l97.9 98c4.5 4.5 7 10.6 7 16.9z"/></svg>
+      SVG
+    end
+  end
+end

data/app/components/blacklight/icons/folder_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The folder icon
+    class FolderComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 512 512"><path d="M464 128H272l-64-64H48C21.49 64 0 85.49 0 112v288c0 26.51 21.49 48 48 48h416c26.51 0 48-21.49 48-48V176c0-26.51-21.49-48-48-48z"/></svg>
+      SVG
+    end
+  end
+end

data/app/components/blacklight/icons/online_component.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The online icon
+    class OnlineComponent < Blacklight::Icons::IconComponent
+      # Used unmodified from https://fontawesome.com
+      # CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
+      self.svg = <<~SVG
+
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 640 512"><path d="M608 0H160a32 32 0 0 0-32 32v96h160V64h192v320h128a32 32 0 0 0 32-32V32a32 32 0 0 0-32-32zM232 103a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9V73a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm352 208a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9v-30a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm0-104a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9v-30a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm0-104a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9V73a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm-168 57H32a32 32 0 0 0-32 32v288a32 32 0 0 0 32 32h384a32 32 0 0 0 32-32V192a32 32 0 0 0-32-32zM96 224a32 32 0 1 1-32 32 32 32 0 0 1 32-32zm288 224H64v-32l64-64 32 32 128-128 96 96z"/></svg>
+      SVG
+    end
+  end
+end

data/app/components/blacklight/icons/pdf_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The pdf icon
+    class PdfComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 384 512"><path d="M369.9 97.9L286 14C277 5 264.8-.1 252.1-.1H48C21.5 0 0 21.5 0 48v416c0 26.5 21.5 48 48 48h288c26.5 0 48-21.5 48-48V131.9c0-12.7-5.1-25-14.1-34zM332.1 128H256V51.9l76.1 76.1zM48 464V48h160v104c0 13.3 10.7 24 24 24h104v288H48zm250.2-143.7c-12.2-12-47-8.7-64.4-6.5-17.2-10.5-28.7-25-36.8-46.3 3.9-16.1 10.1-40.6 5.4-56-4.2-26.2-37.8-23.6-42.6-5.9-4.4 16.1-.4 38.5 7 67.1-10 23.9-24.9 56-35.4 74.4-20 10.3-47 26.2-51 46.2-3.3 15.8 26 55.2 76.1-31.2 22.4-7.4 46.8-16.5 68.4-20.1 18.9 10.2 41 17 55.8 17 25.5 0 28-28.2 17.5-38.7zm-198.1 77.8c5.1-13.7 24.5-29.5 30.4-35-19 30.3-30.4 35.7-30.4 35zm81.6-190.6c7.4 0 6.7 32.1 1.8 40.8-4.4-13.9-4.3-40.8-1.8-40.8zm-24.4 136.6c9.7-16.9 18-37 24.7-54.7 8.3 15.1 18.9 27.2 30.1 35.5-20.8 4.3-38.9 13.1-54.8 19.2zm131.6-5s-5 6-37.3-7.8c35.1-2.6 40.9 5.4 37.3 7.8z"/></svg>
+      SVG
+    end
+  end
+end

data/app/components/blacklight/icons/repository_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # The repository icon
+    class RepositoryComponent < Blacklight::Icons::IconComponent
+      self.svg = <<~SVG
+        <svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0V0z"/><path d="M4 10v7h3v-7H4zm6 0v7h3v-7h-3zM2 22h19v-3H2v3zm14-12v7h3v-7h-3zm-4.5-9L2 6v2h19V6l-9.5-5z"/></svg>
+      SVG
+    end
+  end
+end

data/app/controllers/arclight/repositories_controller.rb

@@ -12,7 +12,7 @@ module Arclight
       @repository = Arclight::Repository.find_by!(slug: params[:id])
       search_service = Blacklight.repository_class.new(blacklight_config)
       @response = search_service.search(
-        q: "level_sim:Collection repository_sim:\"#{@repository.name}\"",
+        q: "level_ssim:Collection repository_ssim:\"#{@repository.name}\"",
         rows: 100
       )
       @collections = @response.documents
@@ -30,11 +30,11 @@ module Arclight
     def fetch_collection_counts
       search_service = Blacklight.repository_class.new(blacklight_config)
       results = search_service.search(
-        q: 'level_sim:Collection',
-        'facet.field': 'repository_sim',
+        q: 'level_ssim:Collection',
+        'facet.field': 'repository_ssim',
         rows: 0
       )
-      Hash[*results.facet_fields['repository_sim']]
+      Hash[*results.facet_fields['repository_ssim']]
     end
   end
 end

data/app/helpers/arclight/ead_format_helpers.rb

@@ -0,0 +1,309 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # A module to add EAD to HTML transformation rules for Arclight
+  module EadFormatHelpers # rubocop:disable Metrics/ModuleLength
+    extend ActiveSupport::Concern
+
+    def render_html_tags(args)
+      values = Array(args[:value])
+      values.map! do |value|
+        transform_ead_to_html(value)
+      end
+      values.map! { |value| wrap_in_paragraph(value) } if values.count > 1
+      safe_join(values.map(&:html_safe))
+    end
+
+    private
+
+    def transform_ead_to_html(value)
+      Loofah.xml_fragment(condense_whitespace(value))
+            .scrub!(ead_to_html_scrubber)
+            .scrub!(:strip).to_html
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def ead_to_html_scrubber
+      Loofah::Scrubber.new do |node|
+        format_render_attributes(node) if node.attr('render').present?
+        convert_to_span(node) if CONVERT_TO_SPAN_TAGS.include? node.name
+        convert_to_br(node) if CONVERT_TO_BR_TAG.include? node.name
+        format_links(node) if %w[extptr extref extrefloc ptr ref].include? node.name
+        format_lists(node) if %w[list chronlist].include? node.name
+        format_indexes(node) if node.name == 'index'
+        format_tables(node) if node.name == 'table'
+        node
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # Tags that should be converted to <span> tags because of formatting conflicts between XML and HTML
+    CONVERT_TO_SPAN_TAGS = ['title'].freeze
+
+    # Tags that should be converted to HTML <br/> tags
+    CONVERT_TO_BR_TAG = ['lb'].freeze
+
+    def convert_to_span(node)
+      node.name = 'span'
+    end
+
+    def convert_to_br(node)
+      node.name = 'br'
+    end
+
+    def condense_whitespace(str)
+      str.squish.strip.gsub(/>[\n\s]+</, '><')
+    end
+
+    def wrap_in_paragraph(value)
+      if value.start_with?('<')
+        value
+      else
+        content_tag(:p, value)
+      end
+    end
+
+    def format_render_attributes(node) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+      case node.attr('render')
+      when 'altrender'
+        node.name = 'span'
+        node['class'] = node['altrender']
+      when 'bold'
+        node.name = 'strong'
+      when 'bolddoublequote'
+        node.name = 'strong'
+        node.prepend_child '"'
+        node.add_child '"'
+      when 'bolditalic'
+        node.name = 'strong'
+        node.wrap('<em/>')
+      when 'boldsinglequote'
+        node.name = 'strong'
+        node.prepend_child '\''
+        node.add_child '\''
+      when 'boldsmcaps'
+        node.name = 'strong'
+        node.wrap('<small/>')
+        node['class'] = 'text-uppercase'
+      when 'boldunderline'
+        node.name = 'strong'
+        node['class'] = 'text-underline'
+      when 'doublequote'
+        node.name = 'span'
+        node.prepend_child '"'
+        node.add_child '"'
+      when 'italic', 'nonproport'
+        node.name = 'em'
+      when 'singlequote'
+        node.name = 'span'
+        node.prepend_child '\''
+        node.add_child '\''
+      when 'smcaps'
+        node.name = 'small'
+        node['class'] = 'text-uppercase'
+      when 'sub'
+        node.name = 'sub'
+      when 'super'
+        node.name = 'sup'
+      when 'underline'
+        node.name = 'span'
+        node['class'] = 'text-underline'
+      end
+    end
+
+    def format_links(node)
+      node.remove_attribute('target')
+      node.remove_attribute('type')
+      if %w[extptr extref extrefloc].include? node.name
+        node['target'] = '_blank'
+        node['class'] = 'external-link'
+      end
+      node.content = node['title'] if (%w[extptr ptr].include? node.name) && node['title'].present?
+      node.name = 'a' if node['href'].present?
+    end
+
+    def format_lists(node)
+      format_simple_lists(node) if node.name == 'list' && node['type'] != 'deflist'
+      format_deflists(node) if node.name == 'list' && node['type'] == 'deflist'
+      format_chronlists(node) if node.name == 'chronlist'
+    end
+
+    def format_simple_lists(node)
+      node.name = 'ul' if (%w[simple marked].include? node['type']) || node['type'].blank?
+      node.name = 'ol' if node['type'] == 'ordered'
+      node.remove_attribute('type')
+      head_node = node.at_css('head')
+      format_list_head(head_node) if head_node.present?
+      items = node.css('item')
+      items.each { |item_node| item_node.name = 'li' }
+    end
+
+    def format_list_head(node)
+      node['class'] = 'list-head'
+      node.name = 'div'
+      node.parent.previous = node # move it from within the list to above it
+    end
+
+    def format_deflists(node)
+      listhead_node = node.at_css('listhead')
+      labels = node.css('label')
+      items = node.css('item')
+      defitems = node.css('defitem')
+      node.remove_attribute('type')
+
+      if listhead_node.present?
+        format_deflist_as_table(node, labels, items, defitems)
+      else
+        format_deflist_as_dl(node, labels, items, defitems)
+      end
+    end
+
+    def format_deflist_as_table(node, labels, items, defitems)
+      node.name = 'table'
+      node['class'] = 'table deflist'
+      listhead_node = node.at_css('listhead')
+      format_deflist_table_head(listhead_node)
+      node.at_css('thead').next = '<tbody/>'
+      labels.each { |label_node| label_node.name = 'td' }
+      items.each { |item_node| item_node.name = 'td' }
+      defitems.each do |defitem_node|
+        defitem_node.name = 'tr'
+        defitem_node.parent = node.at_css('tbody')
+      end
+    end
+
+    def format_deflist_table_head(listhead_node)
+      listhead_node.at_css('head01').name = 'th'
+      listhead_node.at_css('head02').name = 'th'
+      listhead_node.name = 'tr'
+      listhead_node.wrap('<thead/>')
+    end
+
+    def format_deflist_as_dl(node, labels, items, defitems)
+      node.name = 'dl'
+      node['class'] = 'deflist'
+      labels.each { |label_node| label_node.name = 'dt' }
+      items.each { |item_node| item_node.name = 'dd' }
+      defitems.each { |defitem_node| defitem_node.swap(defitem_node.children) } # unwrap
+    end
+
+    def format_chronlists(node)
+      node.name = 'table'
+      node['class'] = 'table chronlist'
+      eventgrps = node.css('eventgrp')
+      single_events = node.css('chronitem > event')
+      multi_events = node.css('eventgrp > event')
+      format_chronlist_header(node)
+      node.at_css('thead').next = '<tbody/>'
+      format_chronlist_caption(node)
+      format_chronlist_chronitems(node)
+      format_chronlist_dates(node)
+      format_chronlist_events(eventgrps, single_events, multi_events)
+    end
+
+    def format_chronlist_header(node)
+      node.add_child('<thead><tr><th>Date</th><th>Event</th></tr></thead>')
+      table_head = node.at_css('thead')
+      node.children.first.add_previous_sibling(table_head)
+      listhead_node = node.at_css('listhead')
+      return if listhead_node.blank?
+
+      node.at_css('thead tr th:nth-of-type(1)').content = node.at_css('listhead/head01').content
+      node.at_css('thead tr th:nth-of-type(2)').content = node.at_css('listhead/head02').content
+      listhead_node.remove
+    end
+
+    def format_chronlist_caption(node)
+      head_node = node.at_css('head')
+      return if head_node.blank?
+
+      head_node.name = 'caption'
+      head_node['class'] = 'chronlist-head'
+      node.children.first.add_previous_sibling(head_node) # make the caption first
+    end
+
+    def format_chronlist_chronitems(node)
+      chronitems = node.css('chronitem')
+      chronitems.each do |chronitem_node|
+        chronitem_node.name = 'tr'
+        chronitem_node.parent = node.at_css('tbody')
+      end
+    end
+
+    def format_chronlist_dates(node)
+      dates = node.css('date')
+      dates.each do |date_node|
+        date_node.name = 'td'
+        date_node['class'] = 'chronlist-item-date'
+      end
+    end
+
+    def format_chronlist_events(eventgrps, single_events, multi_events)
+      eventgrps.each do |eventgrp_node|
+        eventgrp_node.name = 'td'
+        eventgrp_node['class'] = 'chronlist-item-event'
+      end
+      single_events.each do |event_node|
+        event_node.name = 'td'
+        event_node['class'] = 'chronlist-item-event'
+      end
+      multi_events.each { |event_node| event_node.name = 'div' }
+    end
+
+    # Format EAD <index> elements
+    def format_indexes(node)
+      index_head = node.at_css('head')
+      index_head&.name = 'h3'
+      index_head&.add_class('index-head')
+      index_head['id'] = ['index-', index_head.text].join.parameterize if index_head.present?
+      format_indexentries(node)
+      node.name = 'div'
+    end
+
+    # Grab all of the <indexentry> children as a nodeset, move them into
+    # a <table>, wrap each entry in a <tr> & each value in a <td>.
+    def format_indexentries(node)
+      indexentries = node.css('indexentry')
+      return if indexentries.blank?
+
+      indexentries.first.previous = '<table class="table indexentries" />'
+      indexentries.map do |i|
+        i.parent = node.at_css('table.table.indexentries')
+        i.wrap('<tr/>')
+        i.element_children.map { |c| c.wrap('<td/>') }
+        # Assuming two columns in an index, create a blank cell for entries
+        # with a missing value.
+        i.add_child('<td/>') if i.element_children.count == 1
+      end
+    end
+
+    # Format EAD <table> elements, converting <tgroup> to HTML <table>.
+    # Ignoring <colspec>, @colname, @colwidth complex rendering
+    # logic for now.
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def format_tables(node)
+      node.remove_attribute('frame')
+      node.name = 'div' if node.css('tgroup').present?
+      format_table_head(node)
+      tgroups = node.css('tgroup')
+      tgroups&.map do |t|
+        t.name = 'table'
+        t.remove_attribute('cols')
+        t.add_class('table')
+        t.css('row').map { |r| r.name = 'tr' }
+        t.css('thead entry').map { |e| e.name = 'th' }
+        t.css('tbody entry').map { |e| e.name = 'td' }
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def format_table_head(node)
+      table_head = node.at_css('head')
+      return if table_head.blank?
+
+      table_head.name = 'h3'
+      table_head.add_class('table-head')
+    end
+  end
+end

data/app/helpers/arclight/field_config_helpers.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # A module to add configuration helpers for certain fields used by Arclight
+  module FieldConfigHelpers
+    include Arclight::EadFormatHelpers
+
+    def item_requestable?(document)
+      document.requestable?
+    end
+    Arclight.deprecation.deprecate_methods(self, item_requestable?: 'Call e.g. `document.requestable?` instead')
+
+    def link_to_name_facet(args)
+      options = args[:config]&.separator_options || {}
+      values = args[:value] || []
+
+      values.map do |value|
+        link_to(
+          value,
+          search_action_path(f: { names: [value] })
+        )
+      end.to_sentence(options).html_safe
+    end
+  end
+end