arclight 0.2.0 → 1.6.2

data/app/helpers/arclight_helper.rb

@@ -3,58 +3,59 @@
 ##
 # Generic Helpers used in Arclight
 module ArclightHelper
-  ##
-  # @param [SolrDocument]
-  def parents_to_links(document)
-    safe_join(Arclight::Parents.from_solr_document(document).as_parents.map do |parent|
-      link_to parent.label, solr_document_path(parent.global_id)
-    end, t('arclight.breadcrumb_separator'))
-  end
+  include Arclight::EadFormatHelpers
+  include Arclight::FieldConfigHelpers
+  include Blacklight::DocumentHelperBehavior
+  include Blacklight::LayoutHelperBehavior
 
   def repository_collections_path(repository)
     search_action_url(
       f: {
-        repository_sim: [repository.name],
-        level_sim: ['Collection']
+        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 custom_show_content_classes
-    'col-md-12 show-document'
+  def show_content_classes
+    'col-12 col-lg-8 show-document order-2'
   end
 
-  def normalize_id(id)
-    Arclight::NormalizedId.new(id).to_s
+  def show_sidebar_classes
+    'col-lg-4 order-1 collection-sidebar'
   end
 
   def collection_active?
-    try(:search_state) && search_state.params_for_search.try(:[], 'f').try(:[], 'level_sim') == ['Collection']
+    search_state.filter('level').values == ['Collection']
   end
 
   def collection_active_class
     'active' if collection_active?
   end
 
-  def collection_count
-    @response.response['numFound']
+  def grouped?
+    respond_to?(:search_state) && search_state&.params_for_search&.dig('group') == 'true'
   end
 
-  ##
-  # Looks for `document.unitid` in the downloads configuration
-  # @param [SolrDocument] `document`
-  # @param [Hash] `config` metadata for downloadable files
-  # @return [Hash] with `:href` and `:size` keys
-  def collection_downloads(document, config = load_download_config)
-    config = config[document.unitid] if config.present?
-    return {} if config.blank?
-    parse_collection_downloads(config)
+  def search_with_group
+    search_state.params_for_search.merge('group' => 'true').except('page')
   end
 
-  def on_repositories_show?
-    controller_name == 'repositories' && action_name == 'show'
+  def search_without_group
+    search_state.params_for_search.except('group', 'page')
   end
 
   def on_repositories_index?
@@ -66,108 +67,42 @@ module ArclightHelper
     'active' if on_repositories_index?
   end
 
-  def fields_have_content?(document, field_accessor)
-    generic_document_fields(field_accessor).any? do |_, field|
-      generic_should_render_field?(field_accessor, document, field)
-    end
-  end
-
   # If we have a facet on the repository, then return the Repository object for it
   #
   # @return [Repository]
   def repository_faceted_on
-    return unless try(:search_state)
-    repos = facets_from_request.find { |f| f.name == 'repository_sim' }.try(:items)
-    faceted = repos && repos.length == 1 && repos.first.value
-    Arclight::Repository.find_by(name: repos.first.value) if faceted
-  end
-
-  def hierarchy_component_context?
-    params[:hierarchy_context] == 'component'
-  end
-
-  # @return [Hash] loaded from config/downloads.yml, or `{}` if missing file
-  def load_download_config(filename = Rails.root.join('config', 'downloads.yml'))
-    YAML.safe_load(File.read(filename))
-  rescue Errno::ENOENT
-    {}
-  end
-
-  # @return [Hash] the downloads for the given configuration using Hash symbols
-  # @example `{ pdf: { href: 'http://...', size: '123 KB' } }`
-  def parse_collection_downloads(config, results = {})
-    %w[pdf ead].each do |type|
-      next if config[type].blank?
-      results[type.to_sym] = {
-        href: config[type]['href'],
-        size: display_size(config[type]['size'])
-      }
+    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
-    results
-  end
-
-  # Show a human readable size, or if it's already a string, show that
-  # @return [String] human readable siz
-  def display_size(size)
-    size = number_to_human_size(size.to_i + 1) if size.is_a?(Numeric) || size =~ /^[0-9]+$/ # assumes bytes
-    size.to_s
   end
 
   ##
-  # Defines custom helpers used for creating unique metadata blocks to render
-  Arclight::Engine.config.catalog_controller_field_accessors.each do |config_field|
-    ##
-    # Mimics what document_show_fields from Blacklight does
-    # https://github.com/projectblacklight/blacklight/blob/dee8d794125306ec8d4ab834a6a45bcf9671c791/app/helpers/blacklight/configuration_helper_behavior.rb#L35-L38
-    define_method(:"document_#{config_field}s") do |_document = nil|
-      blacklight_config.send(:"#{config_field}s")
-    end
-
-    ##
-    # Mimics what render_document_show_field_label from Blacklight does
-    # https://github.com/projectblacklight/blacklight/blob/dee8d794125306ec8d4ab834a6a45bcf9671c791/app/helpers/blacklight/blacklight_helper_behavior.rb#L136-L156
-    define_method(:"render_document_#{config_field}_label") do |*args|
-      options = args.extract_options!
-      document = args.first
-
-      field = options[:field]
-
-      t(:'blacklight.search.show.label', label: send(:"document_#{config_field}_label", document, field))
-    end
-
-    ##
-    # Mimics what document_show_field_label from Blacklight does
-    # https://github.com/projectblacklight/blacklight/blob/dee8d794125306ec8d4ab834a6a45bcf9671c791/app/helpers/blacklight/configuration_helper_behavior.rb#L67-L74
-    define_method(:"document_#{config_field}_label") do |document, field|
-      field_config = send(:"document_#{config_field}s", document)[field]
-      field_config ||= Blacklight::Configuration::NullField.new(key: field)
-
-      field_config.display_label('show')
-    end
-
-    ##
-    # Mimics what should_render_show_field? from Blacklight does
-    # https://github.com/projectblacklight/blacklight/blob/dee8d794125306ec8d4ab834a6a45bcf9671c791/app/helpers/blacklight/blacklight_helper_behavior.rb#L84-L92
-    define_method(:"should_render_#{config_field}?") do |document, field_config|
-      should_render_field?(field_config, document) && document_has_value?(document, field_config)
-    end
-  end
-
-  ##
-  # Calls the method for a configured field
-  def generic_document_fields(config_field)
-    send(:"document_#{config_field}s")
+  # 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
 
-  ##
-  # Calls the method for a configured field
-  def generic_should_render_field?(config_field, document, field)
-    send(:"should_render_#{config_field}?", document, field)
-  end
-
-  ##
-  # Calls the method for a configured field
-  def generic_render_document_field_label(config_field, document, field: field_name)
-    send(:"render_document_#{config_field}_label", document, field: field)
+  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(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

@@ -5,20 +5,20 @@ 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
-    def initialize(id:, label:, eadid:)
+    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
 
-    ##
-    # Concatenates the eadid and the id, to return an "id" in the context of
-    # Blacklight and Solr
-    # @return [String]
-    def global_id
-      return id if eadid == id
-      "#{eadid}#{id}"
+    def collection?
+      level == 'collection'
     end
   end
 end

data/app/models/arclight/parents.rb

@@ -5,11 +5,14 @@ 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, :labels
-    def initialize(ids:, labels:, eadid:)
+    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
@@ -19,16 +22,18 @@ module Arclight
     ##
     # @return [Array[Arclight::Parent]]
     def as_parents
-      Hash[ids.zip(labels)].map { |k, v| Arclight::Parent.new(id: k, label: v, eadid: eadid) }
+      (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.root == legacy_id ? legacy_id : "#{document.root}#{legacy_id}" }
       labels = document.parent_labels
       eadid = document.eadid
-      new(ids: ids, labels: labels, eadid: 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

@@ -7,10 +7,11 @@ module Arclight
     # 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 [Blacklight::SolrDocument] document
+      # @param [SolrDocument] document
       # @param [Arclight::ShowPresenter] presenter
       # @param [String] document_url
       def initialize(document, presenter, document_url)
@@ -22,7 +23,7 @@ module Arclight
       ##
       # Url of form to fill
       def url
-        document.repository_config.google_request_url
+        request_config['request_url']
       end
 
       ##
@@ -32,13 +33,17 @@ module Arclight
       # @return [Hash]
       def form_mapping
         Rack::Utils.parse_nested_query(
-          document.repository_config.google_request_mappings
+          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

@@ -4,19 +4,41 @@ module Arclight
   ##
   # Arclight specific methods for the Catalog
   module Catalog
-    ##
-    # Overriding the Blacklight method so that the hierarchy view does not start
-    # a new search session
-    def start_new_search_session?
-      !%w[hierarchy online_contents].include?(params[:view]) && super
+    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
 
-    ##
-    # Overriding the Blacklight method so that hierarchy does not get stored as
-    # the preferred view
-    def store_preferred_view
-      return if %w[hierarchy online_contents].include?(params[:view])
-      super
+    # 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

@@ -8,38 +8,39 @@ module Arclight
 
     included do
       self.default_processor_chain += %i[
-        add_hierarchy_max_rows
-        add_hierarchy_sort
         add_highlighting
+        add_grouping
+        add_hierarchy_behavior
       ]
     end
 
-    ##
-    # For the hierarchy view, set a higher (unlimited) maximum document return
-    def add_hierarchy_max_rows(solr_params)
-      if blacklight_params[:view] == 'hierarchy'
-        solr_params[:rows] = 999_999_999
-      end
-      solr_params
+    # 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
 
     ##
-    # For the hierarchy view, set the sort order to preserve the order of components
-    def add_hierarchy_sort(solr_params)
-      solr_params[:sort] = 'sort_ii asc' if %w[hierarchy online_contents].include? blacklight_params[:view]
+    # 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
 
     ##
-    # Disable highlighting for hiearchy, and enable it for all other searches
-    def add_highlighting(solr_params)
-      if blacklight_params[:view] == 'hierarchy'
-        solr_params['hl'] = false
-      else
-        solr_params['hl'] = true
-        solr_params['hl.fl'] = 'text'
-        solr_params['hl.snippets'] = 3
-      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