arclight 0.2.0 → 1.6.2

data/config/i18n-tasks.yml

@@ -53,16 +53,17 @@ data:
 # Find translate calls
 search:
   ## Paths or `File.find` patterns to search in:
-  # paths:
-  #  - app/
+  paths:
+   - app/
+   - config/breadcrumbs.rb
 
   ## Root directories for relative keys resolution.
-  # relative_roots:
-  #   - app/controllers
-  #   - app/helpers
-  #   - app/mailers
-  #   - app/presenters
-  #   - app/views
+  relative_roots:
+    - app/components
+    - app/controllers
+    - app/helpers
+    - app/presenters
+    - app/views
 
   ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
   ##   %w(*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
@@ -96,7 +97,8 @@ ignore_missing:
 - '{blacklight}.*'
 
 ## Consider these keys used:
-# ignore_unused:
+ignore_unused:
+  - '{blacklight}.*'
 # - 'activerecord.attributes.*'
 # - '{devise,kaminari,will_paginate}.*'
 # - 'simple_form.{yes,no}'

data/config/importmap.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+pin_all_from File.expand_path('../app/assets/javascript', __dir__)

data/config/locales/arclight.en.yml

@@ -1,14 +1,18 @@
 ---
 en:
   arclight:
-    breadcrumb_separator: " » "
-    date_range_histogram:
-      hide: Hide date distribution
-      show: Show date distribution
+    breadcrumbs:
+      aria_label: breadcrumb
+    collection_info_component:
+      collection_id: Collection ID
+      last_indexed: Last indexed
+      more_info: More info
+      online_items: Items available online
+      total_components: Total components
     hierarchy:
-      scope_and_contents: Scope and Contents
       view_all: View
-    masthead_heading: Archival Collections at Institution
+    masthead_heading_html: Archival Collections at Institution
+    repositories: Repositories
     request:
       container: Request
     routes:
@@ -16,51 +20,81 @@ en:
       home: Home
       repositories: Repositories
       search_results: Search results
+    search:
+      collections_header: Collections
+      repository_header: 'Collections : [%{repository}]'
+    show_breadcrumb_label: Repository
     truncation:
-      view_less: view less ▼
-      view_more: view more ▶
+      view_less: view less
+      view_more: view more
     views:
       index:
-        collection_search:
-          count: collection
-        number_of_children:
-          one: 1 child
-          other: "%{count} children"
-          zero: No children
-      online_content_indicator: online content
+        all_group_results: view all %{count}
+        all_results: All results
+        group_by_collection: Grouped by collection
+        group_results: Group results
+        group_results_count:
+          one: 1 result
+          other: "%{count} results"
+          zero: 0 results
+        number_of_components:
+          one: component
+          other: components
+        top_group_results:
+          one: Top %{count} result
+          other: Top %{count} results
       repositories:
         number_of_collections:
           one: 1 collection
           other: "%{count} collections"
           zero: No collections
+        show: "%{name} - Arclight"
+        title: Repositories - Arclight
         view_all_collections: View all of our collections
         view_more: View more
       show:
         collection_id: 'Collection ID: %{id}'
-        context_sidebar:
-          cite_field: How to cite this collection
-          component_terms_field: Terms & Conditions
-          in_person_field: In person
-          terms_field: Terms & Conditions
+        contents: Contents
+        context: Collection context
+        context_nav:
+          title: Collection overview
         download:
           default: Download
-          ead: Collection EAD (%{size})
-          pdf: Collection PDF (%{size})
-        navigation_sidebar:
-          title: Navigation overview
-        no_contents: No content inventory
-        no_online_content: No online content
-        online_content: Online content
+          multiple:
+            ead: EAD
+            pdf: Finding aid
+          single:
+            ead: Download EAD
+            pdf: Download finding aid
+        embedded_content: Online content
+        expand: Expand
+        has_content: Collection contents
+        online_content:
+          description: Some materials from this collection are available online.
+          link_text: Show only online content
+          title: Online content
         our_collections: Our Collections
-        overview: Overview
         sections:
-          access_field: Access and Use
-          admin_info_field: Administrative Information
+          access_field: Access and use
           background_field: Background
-          collection_context_field: Collection Context
+          collection_context_field: Collection context
           component_field: About this %{level}
-          component_indexed_terms_field: Indexed Terms
-          indexed_terms_field: Indexed Terms
+          component_indexed_terms_field: Indexed terms
+          indexed_terms_field: Indexed terms
           related_field: Related
-          scope_and_arrangement_field: Scope and Arrangement
+          scope_and_arrangement_field: Scope and arrangement
           summary_field: Summary
+        toggle_sidebar: Navigate the collection
+    within_collection_dropdown:
+      all_collections: all collections
+      label_html: Search<span class="sr-only visually-hidden"> within</span>
+      this_collection: this collection
+  blacklight:
+    entry_name:
+      grouped:
+        _root_: collections
+    search:
+      pagination_info:
+        pages:
+          one: "<strong>%{start_num}</strong> - <strong>%{end_num}</strong> of <strong>%{total_num} %{entry_name}</strong>"
+          other: "<strong>%{start_num}</strong> - <strong>%{end_num}</strong> of <strong>%{total_num} %{entry_name}</strong>"

data/config/routes.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 Arclight::Engine.routes.draw do
-  get 'collections' => 'catalog#index', defaults: { f: { level_sim: ['Collection'] } }, as: :collections
+  get 'collections' => 'catalog#index', defaults: { f: { level: ['Collection'] } }, as: :collections
   resources :repositories, only: %i[index show], controller: 'arclight/repositories'
 end

data/docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3.7"
+
+services:
+  solr:
+    image: solr:latest
+    volumes:
+      - $PWD/solr/conf:/opt/solr/conf
+    ports:
+      - 8983:8983
+    entrypoint:
+      - docker-entrypoint.sh
+      - solr-precreate
+      - blacklight-core
+      - /opt/solr/conf
+      - "-Xms256m"
+      - "-Xmx512m"

data/lib/arclight/digital_object.rb

@@ -5,8 +5,9 @@ module Arclight
   # Plain ruby class to model serializing/deserializing digital object data
   class DigitalObject
     attr_reader :label, :href
+
     def initialize(label:, href:)
-      @label = label.present? ? label : href
+      @label = label.presence || href
       @href = href
     end
 

data/lib/arclight/engine.rb

@@ -1,56 +1,47 @@
 # frozen_string_literal: true
 
 require 'blacklight'
-require 'solr_ead'
 require 'traject'
+require 'active_model'
 require 'arclight/exceptions'
 require 'arclight/normalized_date'
 require 'arclight/normalized_id'
 require 'arclight/normalized_title'
 require 'arclight/digital_object'
-require 'arclight/shared_indexing_behavior'
-require 'arclight/shared_terminology_behavior'
-require 'arclight/custom_document'
-require 'arclight/custom_component'
-require 'arclight/solr_ead_indexer_ext'
-require 'arclight/indexer'
-require 'arclight/viewer'
+require 'gretel'
 
 module Arclight
   ##
   # This is the defining class for the Arclight Rails Engine
   class Engine < ::Rails::Engine
-    config.viewer_class = Arclight::Viewers::OEmbed
     config.oembed_resource_exclude_patterns = [/\.pdf$/, /\.ppt$/]
 
-    Arclight::Engine.config.catalog_controller_field_accessors = %i[
-      summary_field
-      access_field
-      background_field
-      related_field
-      admin_info_field
-      terms_field
-      cite_field
-      indexed_terms_field
-      in_person_field
-      component_field
-      online_field
-      component_terms_field
-      component_indexed_terms_field
-    ]
+    Arclight::Engine.config.catalog_controller_group_query_params = {
+      group: true,
+      'group.field': '_root_',
+      'group.ngroups': true,
+      'group.limit': 3,
+      fl: '*,collection:[subquery]',
+      'collection.q': '{!terms f=id v=$row._root_}',
+      'collection.defType': 'lucene',
+      'collection.fl': '*',
+      'collection.rows': 1
+    }
 
-    initializer 'arclight.fields' do
-      Arclight::Engine.config.catalog_controller_field_accessors.each do |field|
-        Blacklight::Configuration.define_field_access field
+    initializer 'arclight.helpers' do
+      config.after_initialize do
+        ActiveSupport.on_load(:action_view) { include ArclightHelper }
       end
     end
 
-    initializer 'arclight.helpers' do
-      ActionView::Base.send :include, ArclightHelper
+    initializer 'arclight.assets', before: 'assets' do |app|
+      app.config.assets.precompile << 'arclight/arclight.js'
+      app.config.assets.precompile << 'arclight/oembed_controller.js'
+      app.config.assets.precompile << 'arclight/truncate_controller.js'
     end
 
-    initializer 'arclight.views' do
-      Blacklight::Configuration.default_values[:view].hierarchy
+    initializer 'arclight.importmap', before: 'importmap' do |app|
+      app.config.importmap.paths << Engine.root.join('config/importmap.rb') if app.config.respond_to?(:importmap)
     end
   end
 end

data/lib/arclight/exceptions.rb

@@ -8,6 +8,7 @@ module Arclight
         'id must be present for all documents and components'
       end
     end
+
     # Unittitle or unitdate must be present on all documents and components
     class TitleNotFound < StandardError
       def message

data/lib/arclight/hash_absolute_xpath.rb

@@ -17,24 +17,20 @@ module Arclight
       end
     end
 
-    COMPONENT_NODE_NAME_REGEX = /^c\d{,2}$/.freeze
+    COMPONENT_NODE_NAME_REGEX = /^c\d{,2}$/
     attr_reader :node
+
     def initialize(node)
       @node = node
     end
 
     def to_hexdigest
-      self.class.hash_algorithm.hexdigest(absolute_xpath)
+      self.class.hash_algorithm.hexdigest(absolute_xpath).prepend('al_')
     end
 
     def absolute_xpath
       ancestor_tree = node.ancestors.map do |ancestor|
-        if ancestor.name =~ COMPONENT_NODE_NAME_REGEX
-          index = component_siblings_for_node(ancestor).index(ancestor)
-          "#{ancestor.name}#{index}"
-        else
-          ancestor.name
-        end
+        ancestor_name_and_index(ancestor)
       end
 
       "#{[ancestor_tree.reverse, node.name].flatten.join('/')}#{current_index}"
@@ -53,5 +49,14 @@ module Arclight
     def siblings
       @siblings ||= component_siblings_for_node(node)
     end
+
+    def ancestor_name_and_index(ancestor)
+      if ancestor.name =~ COMPONENT_NODE_NAME_REGEX
+        index = component_siblings_for_node(ancestor).index(ancestor)
+        "#{ancestor.name}#{index}"
+      else
+        ancestor.name
+      end
+    end
   end
 end

data/lib/arclight/level_label.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # A utility class to return a human-readable label for an EAD @level code.
+  # Can use the value from @otherlevel if provided.
+  # Examples from @level: recordgrp = "Record Group"
+  #                       collection = "Collection"
+  #                       subseries = "Subseries"
+  #                       otherlevel = (text provided in @otherlevel)
+  class LevelLabel
+    # @param [String] `level` from the collection or component @level
+    # @param [String] `other_level` from the collection or component @otherlevel
+    def initialize(level, other_level = nil)
+      @level = level
+      @other_level = other_level if other_level.present?
+    end
+
+    # @return [String] the human-readable label
+    def to_s
+      human_readable_level
+    end
+
+    private
+
+    attr_reader :level, :other_level
+
+    CUSTOM_LEVEL_LABELS = {
+      recordgrp: 'Record Group',
+      subgrp: 'Subgroup'
+    }.freeze
+
+    def human_readable_level
+      if level == 'otherlevel'
+        alternative_level
+      elsif level.present?
+        CUSTOM_LEVEL_LABELS.fetch(level.to_sym, level.capitalize).to_s
+      end
+    end
+
+    def alternative_level
+      alternative_level = other_level if other_level
+      alternative_level.present? ? alternative_level.capitalize : 'Other'
+    end
+  end
+end

data/lib/arclight/normalized_date.rb

@@ -39,16 +39,11 @@ module Arclight
 
     # @see http://www2.archivists.org/standards/DACS/part_I/chapter_2/4_date for rules
     def normalize
-      if inclusive.present?
-        result = inclusive.to_s
-        result << ", bulk #{bulk}" if bulk.present?
-      elsif other.present?
-        result = other.to_s
-      else
-        result = nil
-      end
-      return if result.blank?
-      result.strip
+      result = []
+      result << inclusive if inclusive.present?
+      result << other if other.present?
+      result << "bulk #{bulk}" if bulk.present?
+      result.compact.map(&:strip).join(', ').presence
     end
   end
 end

data/lib/arclight/normalized_id.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require 'arclight/exceptions'
+
 module Arclight
   ##
   # A simple utility class to normalize identifiers
-  # to be used around the application for linking
   class NormalizedId
-    def initialize(id)
+    # Accepts unused kwargs from the ead2_config.rb id to_field directive
+    # (:title and :repository) so that applications can provide a custom
+    # id_normalizer class to traject to form the collection id from these attributes.
+    def initialize(id, **_kwargs)
       @id = id
     end
 
@@ -19,6 +23,7 @@ module Arclight
 
     def normalize
       raise Arclight::Exceptions::IDNotFound if id.blank?
+
       id.strip.tr('.', '-')
     end
   end

data/lib/arclight/normalized_title.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'arclight/exceptions'
+
 module Arclight
   ##
   # A utility class to normalize titles, typically by joining
@@ -24,6 +26,7 @@ module Arclight
     def normalize
       result = [title, date].compact.join(', ')
       raise Arclight::Exceptions::TitleNotFound if result.blank?
+
       result
     end
   end

data/lib/arclight/repository.rb

@@ -1,29 +1,69 @@
 # frozen_string_literal: true
 
+require 'active_model'
+require 'active_support'
+require 'active_support/core_ext/hash/indifferent_access'
+
 module Arclight
-  #
-  # Static information about a given repository identified by a unique `slug`
-  #
+  # Static information about a given repository identified by a unique `slug`.
+  # These data are loaded from config/repositories.yml
   class Repository
-    include ActiveModel::Conversion # for to_partial_path
+    include ActiveModel::Model
+    DEFAULTS = {
+      request_types: {},
+      contact_html: '',
+      location_html: '',
+      visit_note: nil
+    }.freeze
 
-    attr_accessor :slug, :collection_count
+    def initialize(attributes = {})
+      @attributes = DEFAULTS.merge(attributes).with_indifferent_access
+    end
 
-    # @param [String] `slug` the unique identifier for the repository
-    # @param [Hash] `data`
-    def initialize(slug, data = {})
-      @slug = slug
-      data.each do |field, value|
-        self.class.attr_accessor field.to_sym
-        send("#{field}=", value) if value.present?
-      end
+    attr_reader :attributes
+    attr_accessor :collection_count
+
+    def method_missing(field, *args, &block)
+      return attributes[field] if attributes.include?(field)
+
+      super
+    end
+
+    def respond_to_missing?(field, *args)
+      attributes.include?(field) || super
+    end
+
+    # rubocop:disable Rails/OutputSafety
+    def contact
+      contact_html.html_safe
+    end
+
+    def location
+      location_html.html_safe
+    end
+    # rubocop:enable Rails/OutputSafety
+
+    def request_config_present?
+      request_configs = request_types.values || []
+      request_configs.dig(0, 'request_url').present? &&
+        request_configs.dig(0, 'request_mappings').present?
+    end
+
+    def request_config_present_for_type?(type)
+      config = request_config_for_type(type)
+
+      config['request_url'].present? &&
+        config['request_mappings'].present?
     end
 
-    # @return [String] handles the formatting of "city, state zip, country"
-    def city_state_zip_country
-      state_zip = state
-      state_zip += " #{zip}" if zip
-      [city, state_zip, country].compact.join(', ')
+    def request_config_for_type(type)
+      request_types.fetch(type, {})
+    end
+
+    def available_request_types
+      return [] unless request_types.present?
+
+      request_types.keys
     end
 
     # Load repository information from a YAML file
@@ -32,9 +72,9 @@ module Arclight
     # @return [Hash<Slug,Repository>]
     def self.from_yaml(file)
       repos = {}
-      data = YAML.safe_load(File.read(file))
-      data.keys.each do |slug|
-        repos[slug] = new(slug, data[slug])
+      data = YAML.safe_load_file(file)
+      data.each_key do |slug|
+        repos[slug] = new(data[slug].merge(slug: slug))
       end
       repos
     end
@@ -42,19 +82,20 @@ module Arclight
     # Mimics ActiveRecord's `all` behavior
     #
     # @return [Array<Repository>]
-    def self.all
-      from_yaml(ENV['REPOSITORY_FILE'] || 'config/repositories.yml').values
+    def self.all(yaml_file = nil)
+      yaml_file = ENV['REPOSITORY_FILE'] || 'config/repositories.yml' if yaml_file.nil?
+      from_yaml(yaml_file).values
     end
 
     # Mimics ActiveRecord dynamic `find_by` behavior for the slug or name
     #
     # @param [String] `slug` or `name`
     # @return [Repository]
-    def self.find_by(slug: nil, name: nil)
+    def self.find_by(slug: nil, name: nil, yaml_file: nil)
       if slug
-        all.find { |repo| repo.slug == slug }
+        all(yaml_file).find { |repo| repo.slug == slug }
       elsif name
-        all.find { |repo| repo.name == name }
+        all(yaml_file).find { |repo| repo.name == name }
       else
         raise ArgumentError, 'Requires either slug or name parameters to find_by'
       end
@@ -65,9 +106,10 @@ module Arclight
     # @param [String] `slug` or `name` -- same as `find_by`
     # @return [Repository]
     # @raise [ActiveRecord::RecordNotFound] if cannot find repository
-    def self.find_by!(*args)
-      repository = find_by(*args)
+    def self.find_by!(**kwargs)
+      repository = find_by(**kwargs)
       raise ActiveRecord::RecordNotFound if repository.blank?
+
       repository
     end
   end

data/lib/arclight/routes/hierarchy.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Routes
+    # Inject a hierarchy route for displaying the
+    # components in the collection context
+    class Hierarchy
+      def initialize(defaults = {})
+        @defaults = defaults
+      end
+
+      def call(mapper, _options = {})
+        mapper.member do
+          mapper.get 'hierarchy'
+        end
+      end
+    end
+  end
+end

data/lib/arclight/routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Arclight
+  # Custom routes for Arclight
+  module Routes
+    require 'arclight/routes/hierarchy'
+  end
+end