arclight 0.5.0 → 1.0.0.beta1

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

data/app/helpers/arclight_helper.rb

@@ -3,94 +3,15 @@
 ##
 # Generic Helpers used in Arclight
 module ArclightHelper
-  def aria_hidden_breadcrumb_separator
-    safe_join(
-      [
-        '<span aria-hidden="true">'.html_safe,
-        t('arclight.breadcrumb_separator'),
-        '</span>'.html_safe
-      ]
-    )
-  end
-
-  ##
-  # @param [SolrDocument]
-  def parents_to_links(document)
-    breadcrumb_links = []
-
-    breadcrumb_links << build_repository_link(document)
-
-    breadcrumb_links << document_parents(document).map do |parent|
-      link_to parent.label, solr_document_path(parent.global_id)
-    end
-
-    safe_join(breadcrumb_links, aria_hidden_breadcrumb_separator)
-  end
-
-  ##
-  # For a non-grouped compact view, display the breadcrumbs with the following
-  # algorithm:
-  #  - Display only the first two parts of the item breadcrumb: the repository
-  #    and the collection.
-  #  - After the collection and the breadcrumb divider icon, show an ellipses as
-  #    shown in the mockup above. The repository and the collection parts are
-  #    linked as usual; the ellipses is not linked.
-  def regular_compact_breadcrumbs(document)
-    breadcrumb_links = [build_repository_link(document)]
-
-    parents = document_parents(document)
-    breadcrumb_links << parents[0, 1].map do |parent|
-      link_to parent.label, solr_document_path(parent.global_id)
-    end
-
-    breadcrumb_links << '&hellip;'.html_safe if parents.length > 1
-
-    safe_join(
-      breadcrumb_links,
-      aria_hidden_breadcrumb_separator
-    )
-  end
-
-  ##
-  # @param [SolrDocument]
-  def component_parents_to_links(document)
-    parents = document_parents(document)
-    return unless parents.length > 1
-
-    safe_join(parents.slice(1, 999).map do |parent|
-      link_to parent.label, solr_document_path(parent.global_id)
-    end, aria_hidden_breadcrumb_separator)
-  end
-
-  ##
-  # @param [SolrDocument]
-  def component_top_level_parent_to_links(document)
-    parents = document_parents(document)
-    return unless parents.length > 1
-
-    parent_link = link_to(parents[1].label, solr_document_path(parents[1].global_id))
-    return parent_link if parents.length == 2
-
-    safe_join(
-      [
-        parent_link,
-        aria_hidden_breadcrumb_separator,
-        '&hellip;'.html_safe
-      ]
-    )
-  end
-
-  ##
-  # @param [SolrDocument]
-  def document_parents(document)
-    Arclight::Parents.from_solr_document(document).as_parents
-  end
+  include Arclight::EadFormatHelpers
+  include Arclight::FieldConfigHelpers
+  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
@@ -108,26 +29,22 @@ module ArclightHelper
 
   ##
   # 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?
-    respond_to?(:search_state) && search_state&.params_for_search&.dig('f', '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']
-  end
-
   def grouped?
     respond_to?(:search_state) && search_state&.params_for_search&.dig('group') == 'true'
   end
@@ -140,14 +57,6 @@ module ArclightHelper
     search_state.params_for_search.except('group', 'page')
   end
 
-  def search_within_collection(collection_name, search)
-    search.merge(f: { collection_sim: [collection_name] })
-  end
-
-  def on_repositories_show?
-    controller_name == 'repositories' && action_name == 'show'
-  end
-
   def on_repositories_index?
     controller_name == 'repositories' && action_name == 'index'
   end
@@ -157,29 +66,14 @@ 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 respond_to?(:search_state) && search_state && facet_field_in_params?('repository_sim')
-
-    repos = Array(facet_params('repository_sim'))
-    faceted = repos && repos.length == 1 && repos.first
-    Arclight::Repository.find_by(name: repos.first) if faceted
-  end
+    repos = search_state.filter('repository').values
+    return unless repos.one?
 
-  def hierarchy_component_context?
-    params[:hierarchy_context] == 'component'
-  end
-
-  def online_contents_context?
-    params[:view] == 'online_contents'
+    Arclight::Repository.find_by(name: repos.first)
   end
 
   # determine which icon to show in search results header
@@ -197,139 +91,7 @@ module ArclightHelper
     end
   end
 
-  def render_grouped_documents(documents)
-    safe_join(
-      documents.each_with_index.map do |document, i|
-        render_document_partial(document, :arclight_index_group_document, document_counter: i)
-      end
-    )
-  end
-
-  def ead_files(document)
-    files = Arclight::DocumentDownloads.new(document, document.collection_unitid).files
-    files.find do |file|
-      file.type == 'ead'
-    end
-  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")
-  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)
-  end
-
-  def show_expanded?(document)
-    !original_document?(document) && within_original_tree?(document)
-  end
-
-  def within_original_tree?(document)
-    Array.wrap(params['original_parents']).map do |parent|
-      Arclight::Parent.new(id: parent, eadid: document.parent_ids.first, level: nil, label: nil).global_id
-    end.include?(document.id)
-  end
-
-  def original_document?(document)
-    document.id == params['original_document']
-  end
-
-  def generic_context_navigation(document, original_parents: document.parent_ids, component_level: 1)
-    content_tag(
-      :div,
-      '',
-      class: 'context-navigator',
-      data: {
-        collapse: I18n.t('arclight.views.show.collapse'),
-        expand: I18n.t('arclight.views.show.expand'),
-        arclight: {
-          level: component_level,
-          path: search_catalog_path(hierarchy_context: 'component'),
-          name: document.collection_name,
-          originalDocument: document.id,
-          originalParents: original_parents,
-          eadid: normalize_id(document.eadid)
-        }
-      }
-    )
-  end
-
-  ##
-  # Determine if the user is currently under a collection context
-  # This is any record view (because it is either the collection or a component w/i a collection)
-  # or in a result view where a collection facet has been selected
-  def within_collection_context?
-    return true if record_view?
-
-    results_view? && params.dig(:f, 'collection_sim')
-  end
-
-  def results_view?
-    controller_name == 'catalog' && action_name == 'index'
-  end
-
-  def record_view?
-    controller_name == 'catalog' && action_name == 'show'
-  end
-
-  private
-
-  def build_repository_link(document)
-    repository_path = document.repository_config&.slug
-    if repository_path.present?
-      link_to(document.repository, arclight_engine.repository_path(repository_path))
-    else
-      content_tag(:span, document.repository)
-    end
+  def current_context_document
+    @document
   end
 end

data/app/models/arclight/document_downloads.rb

@@ -30,27 +30,23 @@ module Arclight
       end.compact
     end
 
-    def to_partial_path
-      'catalog/document_downloads'
-    end
-
     class << self
       def config
         @config ||= begin
-                      YAML.safe_load(::File.read(config_filename))
-                    rescue Errno::ENOENT
-                      {}
-                    end
+          YAML.safe_load(::File.read(config_filename))
+        rescue Errno::ENOENT
+          {}
+        end
       end
 
       def config_filename
-        Rails.root.join('config', 'downloads.yml')
+        Rails.root.join('config/downloads.yml')
       end
 
       # Accessor for the File Class
       # @return [Class]
       def file_class
-        File
+        Arclight::DocumentDownloads::File
       end
     end
 
@@ -58,6 +54,7 @@ module Arclight
     # Model a single file configured in downloads.yml
     class File
       attr_reader :type, :document
+
       def initialize(type:, data:, document:)
         @type = type
         @data = data
@@ -73,7 +70,7 @@ module Arclight
       def size
         return data['size'] if data['size']
 
-        document.send(data['size_accessor'].to_sym) if data['size_accessor']
+        document.public_send(data['size_accessor'].to_sym) if data['size_accessor']
       end
 
       private
@@ -99,13 +96,13 @@ module Arclight
       end
 
       def template_variables
-        data['template'].scan(/%{(\w+)}/).flatten.uniq
+        template.scan(Regexp.union(/%{(\w+)}/, /%<(\w+)>/)).flatten.compact.uniq
       end
 
       def escaped_document_interpolations
-        non_custom_template_variables.map do |method_name|
-          [method_name, escape_non_url_doc_value(document.send(method_name))]
-        end.to_h
+        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)

data/app/models/arclight/parent.rb

@@ -6,6 +6,7 @@ module Arclight
   # https://github.com/awead/solr_ead/blob/8cf7ffaa66e0e4c9c0b12f5646d6c2e20984cd99/lib/solr_ead/behaviors.rb#L54-L57
   class Parent
     attr_reader :id, :label, :eadid, :level
+
     def initialize(id:, label:, eadid:, level:)
       @id = id
       @label = label
@@ -13,6 +14,10 @@ module Arclight
       @level = level
     end
 
+    def collection?
+      level == 'collection'
+    end
+
     ##
     # Concatenates the eadid and the id, to return an "id" in the context of
     # Blacklight and Solr

data/app/models/arclight/parents.rb

@@ -6,6 +6,7 @@ module Arclight
   # https://github.com/awead/solr_ead/blob/8cf7ffaa66e0e4c9c0b12f5646d6c2e20984cd99/lib/solr_ead/behaviors.rb#L54-L57
   class Parents
     attr_reader :ids, :labels, :levels
+
     def initialize(ids:, labels:, eadid:, levels:)
       @ids = ids
       @labels = labels
@@ -20,7 +21,7 @@ module Arclight
     ##
     # @return [Array[Arclight::Parent]]
     def as_parents
-      ids.map.with_index { |_id, idx| Arclight::Parent.new(id: ids[idx], label: labels[idx], eadid: eadid, level: levels[idx]) }
+      ids.map.with_index { |id, idx| Arclight::Parent.new(id: id, label: labels[idx], eadid: eadid, level: levels[idx]) }
     end
 
     ##

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

@@ -30,7 +30,7 @@ module Arclight
 
       def dynamic_mappings
         config['request_mappings']['accessor'].transform_values do |v|
-          @document.send(v.to_sym)
+          @document.public_send(v.to_sym)
         end
       end
 

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

@@ -7,8 +7,9 @@ module Arclight
     # query parameters from the form mapping configuration
     class AeonWebEad
       attr_reader :document, :ead_url
+
       ##
-      # @param [Blacklight::SolrDocument] document
+      # @param [SolrDocument] document
       # @param [String] ead_url
       def initialize(document, ead_url)
         @document = document
@@ -18,7 +19,7 @@ module Arclight
       ##
       # Url target for Aeon request params
       def request_url
-        document.repository_config.request_url_for_type('aeon_web_ead')
+        request_config['request_url']
       end
 
       ##
@@ -35,13 +36,17 @@ module Arclight
       # @return [Hash]
       def form_mapping
         form_hash = Rack::Utils.parse_nested_query(
-          document.repository_config.request_mappings_for_type('aeon_web_ead')
+          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&.request_url_for_type('google_form')
+        request_config['request_url']
       end
 
       ##
@@ -32,13 +33,17 @@ module Arclight
       # @return [Hash]
       def form_mapping
         Rack::Utils.parse_nested_query(
-          document.repository_config&.request_mappings_for_type('google_form')
+          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

@@ -8,27 +8,37 @@ module Arclight
 
     included do
       before_action only: :index do
-        if (params.dig(:f, :collection_sim) || []).any?(&:blank?)
-          params[:f][:collection_sim].delete_if(&:blank?)
-          params[:f].delete(:collection_sim) if params[:f][:collection_sim].blank?
+        if (params.dig(:f, :collection) || []).any?(&:blank?)
+          params[:f][:collection].compact_blank!
+          params[:f].delete(:collection) if params[:f][:collection].blank?
         end
       end
-    end
 
-    ##
-    # Overriding the Blacklight method so that the hierarchy view does not start
-    # a new search session
-    def start_new_search_session?
-      !%w[online_contents collection_context].include?(params[:view]) && super
+      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
 
-    ##
-    # Overriding the Blacklight method so that hierarchy does not get stored as
-    # the preferred view
-    def store_preferred_view
-      return if %w[online_contents collection_context].include?(params[:view])
+    def hierarchy
+      @response = search_service.search_results
+    end
 
-      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,44 +8,30 @@ module Arclight
 
     included do
       self.default_processor_chain += %i[
-        add_hierarchy_max_rows
-        add_hierarchy_sort
         add_highlighting
         add_grouping
+        add_hierarchy_behavior
       ]
     end
 
-    ##
-    # Override Blacklight's method so that some views don't add Solr facets into the request.
-    def add_facetting_to_solr(solr_params)
-      if %w[collection_context online_contents].include? blacklight_params[:view]
-        return solr_params
-      end
-
-      super(solr_params)
-    end
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    def add_hierarchy_behavior(solr_parameters)
+      return unless search_state.controller&.action_name == 'hierarchy'
 
-    ##
-    # For the collection_context views, set a higher (unlimited) maximum document return
-    def add_hierarchy_max_rows(solr_params)
-      if %w[collection_context].include? blacklight_params[:view]
-        solr_params[:rows] = 999_999_999
-      end
-      solr_params
-    end
-
-    ##
-    # For the asynch views, set the sort order to preserve the order of components
-    def add_hierarchy_sort(solr_params)
-      solr_params[:sort] = 'sort_ii asc' if %w[online_contents collection_context].include? blacklight_params[:view]
-      solr_params
+      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'] = 'text'
+      solr_params['hl.fl'] = CatalogController.blacklight_config.highlight_field
       solr_params['hl.snippets'] = 3
       solr_params
     end