arclight 0.4.0 → 1.6.2

data/config/breadcrumbs.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Root crumb
+crumb :root do
+  link t('arclight.routes.home'), root_path
+end
+
+crumb :repositories do
+  link t('arclight.routes.repositories'), arclight_engine.repositories_path
+end
+
+crumb :repository do |repository|
+  link repository.name, arclight_engine.repository_path(repository.slug)
+
+  parent :repositories
+end
+
+crumb :search_results do |search_state|
+  if search_state.filter('level').values == ['Collection']
+    link t('arclight.routes.collections')
+  else
+    link t('arclight.routes.search_results')
+  end
+end

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)

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,17 @@
 ---
 en:
   arclight:
-    breadcrumb_separator: " » "
     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
-      scope_note: 'Scope note: '
       view_all: View
-    masthead_heading: Archival Collections at Institution
+    masthead_heading_html: Archival Collections at Institution
     repositories: Repositories
     request:
       container: Request
@@ -22,11 +25,9 @@ en:
       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:
-      home:
-        title: Archival Collections at Institution - Arclight
       index:
         all_group_results: view all %{count}
         all_results: All results
@@ -52,46 +53,46 @@ en:
         view_all_collections: View all of our collections
         view_more: View more
       show:
-        access: Access
-        collapse: Collapse
         collection_id: 'Collection ID: %{id}'
+        contents: Contents
         context: Collection context
         context_nav:
-          title: Collection context navigation
+          title: Collection overview
         download:
           default: Download
-          ead: Download EAD
-          pdf: Download finding aid
-        download_with_size:
-          default: Download (%{size})
-          ead: Download EAD (%{size})
-          pdf: Download finding aid (%{size})
+          multiple:
+            ead: EAD
+            pdf: Finding aid
+          single:
+            ead: Download EAD
+            pdf: Download finding aid
+        embedded_content: Online content
         expand: Expand
-        has_content: Contents
-        no_contents: No content inventory
-        online_content: Online content
-        online_content_upper: ONLINE CONTENT
+        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
+          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
-        tablist_nav: Context
+        toggle_sidebar: Navigate the collection
     within_collection_dropdown:
       all_collections: all collections
-      label_html: Search<span class="sr-only"> within</span>
+      label_html: Search<span class="sr-only visually-hidden"> within</span>
       this_collection: this collection
   blacklight:
     entry_name:
       grouped:
-        collection_ssi: collection
+        _root_: collections
     search:
       pagination_info:
         pages:

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,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'sprockets/bumble_d'
 require 'blacklight'
 require 'traject'
 require 'active_model'
@@ -9,58 +8,40 @@ require 'arclight/normalized_date'
 require 'arclight/normalized_id'
 require 'arclight/normalized_title'
 require 'arclight/digital_object'
-require 'arclight/viewer'
+require 'gretel'
 
 module Arclight
   ##
   # This is the defining class for the Arclight Rails Engine
   class Engine < ::Rails::Engine
-    extend ::Sprockets::BumbleD::DSL
-
-    # We're not sure this is right, but we aren't doing module imports
-    # at the moment anyway
-    register_umd_globals :arclight,
-                         'blacklight' => 'Blacklight'
-
-    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
-      contact_field
-      background_field
-      related_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': 'collection_ssi',
+      'group.field': '_root_',
       'group.ngroups': true,
       'group.limit': 3,
-      fl: '*,parent:[subquery]',
-      'parent.fl': '*',
-      'parent.q': '{!term f=collection_sim v=$row.collection_ssi}',
-      'parent.fq': '{!term f=level_sim v="Collection"}',
-      'parent.defType': 'lucene'
+      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.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,8 +17,9 @@ 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

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
-
-      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
 

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

data/lib/arclight/repository.rb

@@ -1,74 +1,63 @@
 # 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
-
-    attr_accessor :slug, :collection_count
-
-    # @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
+    include ActiveModel::Model
+    DEFAULTS = {
+      request_types: {},
+      contact_html: '',
+      location_html: '',
+      visit_note: nil
+    }.freeze
+
+    def initialize(attributes = {})
+      @attributes = DEFAULTS.merge(attributes).with_indifferent_access
     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(', ')
-    end
+    attr_reader :attributes
+    attr_accessor :collection_count
 
-    # Why are we using self#respond_to? below?
-    #
-    # All the keys in the config hash from `repositories.yml` are
-    # on-the-fly added as attr_accessors up in #initialize. If the
-    # request_types key isn't present, the method won't be created.
-    #
-    # Since the original data is thrown away, this is the best way
-    # to see if that key was present.
-    def request_config_present?
-      return false unless respond_to? :request_types
-      return false if request_types.nil? || request_types.empty?
+    def method_missing(field, *args, &block)
+      return attributes[field] if attributes.include?(field)
 
-      request_configs = request_types.map { |_k, v| v }
-      request_configs[0]&.fetch('request_url').present? &&
-        request_configs[0]&.fetch('request_mappings').present?
+      super
     end
 
-    def request_config_present_for_type?(type)
-      return false unless type && request_config_present?
-
-      config = request_types[type]
-      config&.fetch('request_url').present? &&
-        config&.fetch('request_mappings').present?
+    def respond_to_missing?(field, *args)
+      attributes.include?(field) || super
     end
 
-    def request_config_for_type(type)
-      return nil unless type && request_config_present_for_type?(type)
+    # rubocop:disable Rails/OutputSafety
+    def contact
+      contact_html.html_safe
+    end
 
-      request_types[type]
+    def location
+      location_html.html_safe
     end
+    # rubocop:enable Rails/OutputSafety
 
-    def request_url_for_type(type)
-      return nil unless type && request_config_present_for_type?(type)
+    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.fetch('request_url')
-    end
 
-    def request_mappings_for_type(type)
-      return nil unless type && request_config_present_for_type?(type)
+      config['request_url'].present? &&
+        config['request_mappings'].present?
+    end
 
-      config = request_config_for_type(type)
-      config.fetch('request_mappings')
+    def request_config_for_type(type)
+      request_types.fetch(type, {})
     end
 
     def available_request_types
@@ -83,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
@@ -117,8 +106,8 @@ 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

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