arclight 0.0.1 → 1.4.0

data/app/helpers/arclight_helper.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+##
+# Generic Helpers used in Arclight
+module ArclightHelper
+  include Arclight::EadFormatHelpers
+  include Arclight::FieldConfigHelpers
+  include Blacklight::DocumentHelperBehavior
+  include Blacklight::LayoutHelperBehavior
+
+  def repository_collections_path(repository)
+    search_action_url(
+      f: {
+        repository: [repository.name],
+        level: ['Collection']
+      }
+    )
+  end
+
+  # Returns the i18n-ed string to be used as the h1 in search results
+  def search_results_header_text
+    if (repo = repository_faceted_on).present?
+      t('arclight.search.repository_header', repository: repo.name)
+    elsif collection_active?
+      t('arclight.search.collections_header')
+    else
+      t('blacklight.search.header')
+    end
+  end
+
+  ##
+  # Classes used for customized show page in arclight
+  def show_content_classes
+    'col-12 col-lg-8 show-document order-2'
+  end
+
+  def show_sidebar_classes
+    'col-lg-4 order-1 collection-sidebar'
+  end
+
+  def collection_active?
+    search_state.filter('level').values == ['Collection']
+  end
+
+  def collection_active_class
+    'active' if collection_active?
+  end
+
+  def grouped?
+    respond_to?(:search_state) && search_state&.params_for_search&.dig('group') == 'true'
+  end
+
+  def search_with_group
+    search_state.params_for_search.merge('group' => 'true').except('page')
+  end
+
+  def search_without_group
+    search_state.params_for_search.except('group', 'page')
+  end
+
+  def on_repositories_index?
+    controller_name == 'repositories' && action_name == 'index'
+  end
+
+  # the Repositories menu item is only active on the Repositories index page
+  def repositories_active_class
+    'active' if on_repositories_index?
+  end
+
+  # If we have a facet on the repository, then return the Repository object for it
+  #
+  # @return [Repository]
+  def repository_faceted_on
+    repos = search_state.filter('repository').values
+    return unless repos.one?
+
+    Arclight::Repository.find_by(name: repos.first)
+  end
+
+  # determine which icon to show in search results header
+  # these icon names will need to be updated when the icons are determined
+  def document_or_parent_icon(document)
+    case document.level&.downcase
+    when 'collection'
+      'collection'
+    when 'file'
+      'file'
+    when 'series', 'subseries'
+      'folder'
+    else
+      'container'
+    end
+  end
+
+  ##
+  # Override of BL core https://github.com/projectblacklight/blacklight/blob/v8.1.0/app/helpers/blacklight/document_helper_behavior.rb#L55
+  # Remove document_type check. It isn't a method on arclight documents
+  # Check if the document is in the user's bookmarks
+  # @param [Blacklight::Document] document
+  # @return [Boolean]
+  def bookmarked?(document)
+    current_bookmarks.any? { |x| x.document_id == document.id }
+  end
+
+  def current_context_document
+    @document
+  end
+end

data/app/models/arclight/document_downloads.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Model the Download links that can be configured (via YAML) for a collection
+  # or container
+  class DocumentDownloads
+    attr_reader :document
+
+    def initialize(document, id = nil)
+      @document = document
+      @id = id
+    end
+
+    # Accessor for the ID
+    # @return [String]
+    def id
+      @id || document.unitid
+    end
+
+    # Factory method for the File objects
+    # @return [Array<Arclight::DocumentDownloads::File>]
+    def files
+      data = self.class.config[id] || self.class.config['default']
+      disabled = data.delete('disabled')
+      return [] if disabled
+
+      @files ||= data.map do |file_type, file_data|
+        self.class.file_class.new(type: file_type, data: file_data, document: document)
+      end.compact
+    end
+
+    class << self
+      def config
+        @config ||= begin
+          YAML.safe_load(::File.read(config_filename))
+        rescue Errno::ENOENT
+          {}
+        end
+      end
+
+      def config_filename
+        Rails.root.join('config/downloads.yml')
+      end
+
+      # Accessor for the File Class
+      # @return [Class]
+      def file_class
+        Arclight::DocumentDownloads::File
+      end
+    end
+
+    ##
+    # Model a single file configured in downloads.yml
+    class File
+      attr_reader :type, :document
+
+      def initialize(type:, data:, document:)
+        @type = type
+        @data = data
+        @document = document
+      end
+
+      def href
+        return data['href'] if data['href']
+
+        format_template
+      end
+
+      def size
+        return data['size'] if data['size']
+
+        document.public_send(data['size_accessor'].to_sym) if data['size_accessor']
+      end
+
+      private
+
+      attr_reader :data
+
+      def format_template
+        return unless template
+
+        template % template_interpolations
+      end
+
+      def template
+        data['template']
+      end
+
+      def template_interpolations
+        escaped_document_interpolations.merge(custom_interpolations).symbolize_keys
+      end
+
+      def custom_interpolations
+        { 'repository_id' => document.repository_config&.slug }
+      end
+
+      def template_variables
+        template.scan(Regexp.union(/%{(\w+)}/, /%<(\w+)>/)).flatten.compact.uniq
+      end
+
+      def escaped_document_interpolations
+        non_custom_template_variables.index_with do |method_name|
+          escape_non_url_doc_value(document.public_send(method_name))
+        end
+      end
+
+      def escape_non_url_doc_value(value)
+        value = Array.wrap(value).first || '' # Handle single values/arrays and nil
+        return value if value.start_with?(/https?:/)
+
+        CGI.escape(value)
+      end
+
+      def non_custom_template_variables
+        template_variables.reject do |v|
+          custom_interpolations.keys.include?(v)
+        end
+      end
+    end
+  end
+end

data/app/models/arclight/parent.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Logic containing information about Solr_Ead "Parent"
+  # https://github.com/awead/solr_ead/blob/8cf7ffaa66e0e4c9c0b12f5646d6c2e20984cd99/lib/solr_ead/behaviors.rb#L54-L57
+  class Parent
+    attr_reader :id, :label, :eadid, :level
+
+    alias global_id id
+    Arclight.deprecation.deprecate_methods(self, global_id: 'Call `id` instead')
+
+    def initialize(id:, label:, eadid:, level:)
+      @id = id
+      @label = label
+      @eadid = eadid
+      @level = level
+    end
+
+    def collection?
+      level == 'collection'
+    end
+  end
+end

data/app/models/arclight/parents.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Object for parsing and formalizing Solr_Ead "Parents"
+  # https://github.com/awead/solr_ead/blob/8cf7ffaa66e0e4c9c0b12f5646d6c2e20984cd99/lib/solr_ead/behaviors.rb#L54-L57
+  class Parents
+    attr_reader :ids, :legacy_ids, :labels, :levels
+
+    def initialize(ids:, legacy_ids:, labels:, eadid:, levels:)
+      @ids = ids
+      @legacy_ids = legacy_ids
+      @labels = labels
+      @eadid = eadid
+      @levels = levels
+    end
+
+    def eadid
+      Arclight::NormalizedId.new(@eadid).to_s
+    end
+
+    ##
+    # @return [Array[Arclight::Parent]]
+    def as_parents
+      (ids.presence || legacy_ids).map.with_index { |id, idx| Arclight::Parent.new(id: id, label: labels[idx], eadid: eadid, level: levels[idx]) }
+    end
+
+    ##
+    # @param [SolrDocument] document
+    def self.from_solr_document(document)
+      ids = document.parent_ids
+      legacy_ids = document.legacy_parent_ids.map { |legacy_id| document.collection_id == legacy_id ? legacy_id : "#{document.collection_id}#{legacy_id}" }
+      labels = document.parent_labels
+      eadid = document.eadid
+      levels = document.parent_levels
+      new(ids: ids, legacy_ids: legacy_ids, labels: labels, eadid: eadid, levels: levels)
+    end
+  end
+end

data/app/models/arclight/requests/aeon_external_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Requests
+    ##
+    # This class should be used to turn configuration into a URL and
+    # POST form specifically aimed at Aeon's external request
+    # endpoint (https://support.atlas-sys.com/hc/en-us/articles/360011820054-External-Request-Endpoint)
+    class AeonExternalRequest
+      def initialize(document, presenter)
+        @document = document
+        @presenter = presenter
+      end
+
+      def config
+        @config ||= @document.repository_config.request_config_for_type('aeon_external_request_endpoint')
+      end
+
+      def url
+        "#{config['request_url']}?#{url_params}"
+      end
+
+      def form_mapping
+        static_mappings.merge(dynamic_mappings)
+      end
+
+      def static_mappings
+        config['request_mappings']['static']
+      end
+
+      def dynamic_mappings
+        config['request_mappings']['accessor'].transform_values do |v|
+          @document.public_send(v.to_sym)
+        end
+      end
+
+      def url_params
+        config['request_mappings']['url_params'].to_query
+      end
+    end
+  end
+end

data/app/models/arclight/requests/aeon_web_ead.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Requests
+    ##
+    # This object relies on the ability to respond to attributes passed in as
+    # query parameters from the form mapping configuration
+    class AeonWebEad
+      attr_reader :document, :ead_url
+
+      ##
+      # @param [SolrDocument] document
+      # @param [String] ead_url
+      def initialize(document, ead_url)
+        @document = document
+        @ead_url = ead_url
+      end
+
+      ##
+      # Url target for Aeon request params
+      def request_url
+        request_config['request_url']
+      end
+
+      ##
+      # Constructed request URL
+      def url
+        "#{request_url}?#{form_mapping.to_query}"
+      end
+
+      ##
+      # Converts mappings as a query url param into a Hash used for sending
+      # messages
+      # If a defined method is provided as a value, that method will be invoked
+      # "collection_name=entry.123" => { "collection_name" => "entry.123" }
+      # @return [Hash]
+      def form_mapping
+        form_hash = Rack::Utils.parse_nested_query(
+          request_config['request_mappings']
+        )
+        form_hash.each do |key, value|
+          respond_to?(value) && form_hash[key] = send(value)
+        end
+        form_hash
+      end
+
+      def request_config
+        document.repository_config.request_config_for_type('aeon_web_ead')
+      end
+    end
+  end
+end

data/app/models/arclight/requests/google_form.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Requests
+    ##
+    # This object relies on the ability to respond to attributes passed in as
+    # query parameters from the form mapping configuratino
+    class GoogleForm
+      attr_reader :document, :presenter, :document_url
+
+      delegate :collection_name, :collection_creator, :eadid, :containers, to: :document
+
+      ##
+      # @param [SolrDocument] document
+      # @param [Arclight::ShowPresenter] presenter
+      # @param [String] document_url
+      def initialize(document, presenter, document_url)
+        @document = document
+        @presenter = presenter
+        @document_url = document_url
+      end
+
+      ##
+      # Url of form to fill
+      def url
+        request_config['request_url']
+      end
+
+      ##
+      # Converts mappings as a query url param into a Hash used for sending
+      # messages and providing pre-filled form fields
+      # "collection_name=entry.123" => { "collection_name" => "entry.123" }
+      # @return [Hash]
+      def form_mapping
+        Rack::Utils.parse_nested_query(
+          request_config['request_mappings']
+        )
+      end
+
+      def title
+        presenter.heading
+      end
+
+      def request_config
+        document.repository_config&.request_config_for_type('google_form')
+      end
+    end
+  end
+end

data/app/models/concerns/arclight/catalog.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Arclight specific methods for the Catalog
+  module Catalog
+    extend ActiveSupport::Concern
+
+    included do
+      before_action only: :index do
+        if (params.dig(:f, :collection) || []).any?(&:blank?)
+          params[:f][:collection].compact_blank!
+          params[:f].delete(:collection) if params[:f][:collection].blank?
+        end
+      end
+
+      before_action only: :hierarchy do
+        blacklight_config.search_state_fields += %i[id limit offset]
+      end
+
+      Blacklight::Configuration.define_field_access :summary_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :background_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :related_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :indexed_terms_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :in_person_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :cite_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :contact_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :component_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :component_indexed_terms_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :terms_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :component_terms_field, Blacklight::Configuration::ShowField
+      Blacklight::Configuration.define_field_access :group_header_field, Blacklight::Configuration::IndexField
+    end
+
+    def hierarchy
+      @response = search_service.search_results
+    end
+
+    # Overrides blacklight search state so we can exclude some parameters from being passed into the SearchState
+    def search_state
+      @search_state ||= search_state_class.new(params.except('hierarchy', 'nest_path'), blacklight_config, self)
+    end
+  end
+end

data/app/models/concerns/arclight/search_behavior.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Customized Search Behavior for Arclight
+  module SearchBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.default_processor_chain += %i[
+        add_highlighting
+        add_grouping
+        add_hierarchy_behavior
+      ]
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    def add_hierarchy_behavior(solr_parameters)
+      return unless search_state.controller&.action_name == 'hierarchy'
+
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << "_nest_parent_:#{blacklight_params[:id]}"
+      solr_parameters[:rows] = blacklight_params[:per_page]&.to_i || blacklight_params[:limit]&.to_i || 999_999_999
+      solr_parameters[:start] = blacklight_params[:offset] if blacklight_params[:offset]
+      solr_parameters[:sort] = 'sort_isi asc'
+      solr_parameters[:facet] = false
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+    ##
+    # Add highlighting
+    def add_highlighting(solr_params)
+      solr_params['hl'] = true
+      solr_params['hl.fl'] = CatalogController.blacklight_config.highlight_field
+      solr_params['hl.snippets'] = 3
+      solr_params
+    end
+
+    ##
+    # Adds grouping parameters for Solr if enabled
+    def add_grouping(solr_params)
+      solr_params.merge!(Arclight::Engine.config.catalog_controller_group_query_params) if blacklight_params[:group] == 'true'
+
+      solr_params
+    end
+  end
+end

data/app/models/concerns/arclight/solr_document.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Extends Blacklight::Solr::Document to provide Arclight specific behavior
+  module SolrDocument
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :collection_id, :string, '_root_'
+      attribute :parent_ids, :array, 'parent_ids_ssim'
+      attribute :legacy_parent_ids, :array, 'parent_ssim'
+      Arclight.deprecation.deprecate_methods(self, legacy_parent_ids: 'Use `parent_ids` instead')
+      attribute :parent_labels, :array, 'parent_unittitles_ssm'
+      attribute :parent_levels, :array, 'parent_levels_ssm'
+      attribute :unitid, :string, 'unitid_ssm'
+      attribute :extent, :array, 'extent_ssm'
+      attribute :abstract, :string, 'abstract_html_tesm'
+      attribute :scope, :string, 'scopecontent_html_tesm'
+      attribute :creator, :string, 'creator_ssm'
+      attribute :level, :string, 'level_ssm'
+      attribute :terms, :string, 'userestrict_html_tesm'
+      # Restrictions for component sidebar
+      attribute :parent_restrictions, :string, 'parent_access_restrict_tesm'
+      # Terms for component sidebar
+      attribute :parent_terms, :string, 'parent_access_terms_tesm'
+      attribute :reference, :string, 'ref_ssm'
+      attribute :normalized_title, :string, 'normalized_title_ssm'
+      attribute :normalized_date, :string, 'normalized_date_ssm'
+      attribute :total_component_count, :string, 'total_component_count_is'
+      attribute :online_item_count, :string, 'online_item_count_is'
+      attribute :last_indexed, :date, 'timestamp'
+    end
+
+    def repository_config
+      return unless repository
+
+      @repository_config ||= Arclight::Repository.find_by(name: repository)
+    end
+
+    def parents
+      @parents ||= Arclight::Parents.from_solr_document(self).as_parents
+    end
+
+    # Get this document's EAD ID, or fall back to the collection (especially
+    # for components that may not have their own.
+    def eadid
+      first('ead_ssi')&.strip || collection&.first('ead_ssi')&.strip
+    end
+
+    def normalized_eadid
+      Arclight::NormalizedId.new(eadid).to_s
+    end
+    Arclight.deprecation.deprecate_methods(self, normalized_eadid: 'Use `collection_id` instead')
+
+    def repository
+      first('repository_ssm') || collection&.first('repository_ssm')
+    end
+
+    def repository_and_unitid
+      [repository, unitid].compact.join(': ')
+    end
+
+    # @return [SolrDocument] a SolrDocument representing the EAD collection
+    #   that this document belongs to
+    def collection
+      return self if collection?
+
+      @collection ||= self.class.new(self['collection']&.dig('docs', 0), @response)
+    end
+
+    def collection_name
+      collection&.normalized_title
+    end
+
+    def collection_unitid
+      collection&.unitid
+    end
+
+    def abstract_or_scope
+      abstract || scope
+    end
+
+    def collection_creator
+      collection&.creator
+    end
+
+    def online_content?
+      first('has_online_content_ssim') == 'true'
+    end
+
+    def number_of_children
+      first('child_component_count_isi') || 0
+    end
+
+    def children?
+      number_of_children.positive?
+    end
+
+    def component_level
+      first('component_level_isim')
+    end
+
+    def collection?
+      level&.parameterize == 'collection'
+    end
+
+    def digital_objects
+      digital_objects_field = fetch('digital_objects_ssm', []).reject(&:empty?)
+      return [] if digital_objects_field.blank?
+
+      digital_objects_field.map do |object|
+        Arclight::DigitalObject.from_json(object)
+      end
+    end
+
+    def containers
+      # NOTE: Keep uppercase characters if present, but upcase the first if not already
+      containers_field = fetch('containers_ssim', []).reject(&:empty?)
+      return [] if containers_field.blank?
+
+      containers_field.map do |container|
+        container.dup.sub!(/\A./, &:upcase)
+      end
+    end
+
+    # @return [Array<String>] with embedded highlights using <em>...</em>
+    def highlights
+      highlight_field(CatalogController.blacklight_config.highlight_field)
+    end
+
+    # Factory method for constructing the Object modeling downloads
+    # @return [DocumentDownloads]
+    def downloads
+      @downloads ||= DocumentDownloads.new(self)
+    end
+
+    def ead_file
+      @ead_file ||= begin
+        files = Arclight::DocumentDownloads.new(self, collection_unitid).files
+        files.find do |file|
+          file.type == 'ead'
+        end
+      end
+    end
+
+    def nest_path
+      self['_nest_path_']
+    end
+
+    def root
+      self['_root_'] || self['id']
+    end
+
+    def requestable?
+      repository_config&.request_types&.any?
+    end
+  end
+end

data/app/presenters/arclight/index_presenter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Custom presentation methods for index partials
+  class IndexPresenter < Blacklight::IndexPresenter
+    def label(*)
+      document.normalized_title
+    end
+  end
+end