arclight 0.0.1 → 0.1.0

data/app/factories/blacklight_field_configuration_factory.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+##
+# A factory to return blacklight field configurations given a field key
+# that represents a field group (e.g. summary_fields, access_fields, etc)
+class BlacklightFieldConfigurationFactory
+  def self.for(config:, field:, field_group:)
+    new(config: config, field: field, field_group: field_group).field_config
+  end
+
+  def initialize(config:, field:, field_group:)
+    @config = config
+    @field = field
+    @field_group = field_group
+  end
+
+  def field_config
+    return null_field unless config.respond_to?(:"#{field_group}s")
+    config.send(:"#{field_group}s").fetch(field) { null_field }
+  end
+
+  private
+
+  attr_reader :config, :field, :field_group
+
+  def null_field
+    Blacklight::Configuration::NullField.new(field)
+  end
+end

data/app/helpers/arclight_helper.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+##
+# 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
+
+  def repository_collections_path(repository)
+    search_action_url(
+      f: {
+        repository_sim: [repository.name],
+        level_sim: ['Collection']
+      }
+    )
+  end
+
+  ##
+  # Classes used for customized show page in arclight
+  def custom_show_content_classes
+    'col-md-12 show-document'
+  end
+
+  def normalize_id(id)
+    Arclight::NormalizedId.new(id).to_s
+  end
+
+  def collection_active?
+    try(:search_state) && search_state.params_for_search.try(:[], 'f').try(:[], 'level_sim') == ['Collection']
+  end
+
+  def collection_active_class
+    'active' if collection_active?
+  end
+
+  def collection_count
+    facets_from_request.find { |f| f.name == 'collection_sim' }.try(:items).try(:count)
+  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)
+  end
+
+  def on_repositories_show?
+    controller_name == 'repositories' && action_name == 'show'
+  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
+
+  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'])
+      }
+    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")
+  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
+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
+    def initialize(id:, label:, eadid:)
+      @id = id
+      @label = label
+      @eadid = eadid
+    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}"
+    end
+  end
+end

data/app/models/arclight/parents.rb

@@ -0,0 +1,34 @@
+# 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, :labels
+    def initialize(ids:, labels:, eadid:)
+      @ids = ids
+      @labels = labels
+      @eadid = eadid
+    end
+
+    def eadid
+      Arclight::NormalizedId.new(@eadid).to_s
+    end
+
+    ##
+    # @return [Array[Arclight::Parent]]
+    def as_parents
+      Hash[ids.zip(labels)].map { |k, v| Arclight::Parent.new(id: k, label: v, eadid: eadid) }
+    end
+
+    ##
+    # @param [SolrDocument] document
+    def self.from_solr_document(document)
+      ids = document.parent_ids
+      labels = document.parent_labels
+      eadid = document.eadid
+      new(ids: ids, labels: labels, eadid: eadid)
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# 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 [Blacklight::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
+        document.repository_config.google_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(
+          document.repository_config.google_request_mappings
+        )
+      end
+
+      def title
+        presenter.heading
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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
+    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
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Customized Search Behavior for Arclight
+  module SearchBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.default_processor_chain += %i[
+        add_hierarchy_max_rows
+        add_hierarchy_sort
+        add_highlighting
+      ]
+    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
+    end
+
+    ##
+    # 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 blacklight_params[:view] == 'hierarchy'
+      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
+      solr_params
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Extends Blacklight::Solr::Document to provide Arclight specific behavior
+  module SolrDocument
+    extend Blacklight::Solr::Document
+
+    def repository_config
+      return unless repository
+      @repository_config ||= Arclight::Repository.find_by(name: repository)
+    end
+
+    def parent_ids
+      fetch('parent_ssm', [])
+    end
+
+    def parent_labels
+      fetch('parent_unittitles_ssm', [])
+    end
+
+    def eadid
+      fetch('ead_ssi', nil)
+    end
+
+    def unitid
+      first('unitid_ssm')
+    end
+
+    def repository
+      first('repository_ssm')
+    end
+
+    def repository_and_unitid
+      [repository, unitid].compact.join(': ')
+    end
+
+    def collection_name
+      first('collection_ssm')
+    end
+
+    def extent
+      first('extent_ssm')
+    end
+
+    def abstract_or_scope
+      first('abstract_ssm') || first('scopecontent_ssm')
+    end
+
+    def creator
+      first('creator_ssm')
+    end
+
+    def collection_creator
+      first('collection_creator_ssm')
+    end
+
+    def online_content?
+      first('has_online_content_ssim') == 'true'
+    end
+
+    def number_of_children
+      first('child_component_count_isim') || 0
+    end
+
+    def children?
+      number_of_children.positive?
+    end
+
+    def reference
+      first('ref_ssm')
+    end
+
+    def component_level
+      first('component_level_isim')
+    end
+
+    def level
+      first('level_ssm')
+    end
+
+    def digital_object_viewer
+      @digital_object_viewer ||= Arclight::Viewer.render(self)
+    end
+
+    def terms
+      first('userestrict_ssm')
+    end
+
+    # Restrictions for component sidebar
+    def parent_restrictions
+      first('parent_access_restrict_ssm')
+    end
+
+    # Terms for component sidebar
+    def parent_terms
+      first('parent_access_terms_ssm')
+    end
+
+    def digital_objects
+      digital_objects_field = fetch('digital_objects_ssm', [])
+      return [] if digital_objects_field.blank?
+
+      digital_objects_field.map do |object|
+        Arclight::DigitalObject.from_json(object)
+      end
+    end
+
+    def containers
+      # note that .titlecase strips punctuation, like hyphens, we want to keep
+      fetch('containers_ssim', []).map(&:capitalize)
+    end
+
+    def normalized_title
+      first('normalized_title_ssm')
+    end
+
+    def normalized_date
+      first('normalized_date_ssm')
+    end
+
+    # @return [Array<String>] with embedded highlights using <em>...</em>
+    def highlights
+      highlight_response = response[:highlighting]
+      return if highlight_response.blank? ||
+                highlight_response[id].blank? ||
+                highlight_response[id][:text].blank?
+      highlight_response[id][:text]
+    end
+  end
+end