arclight 0.2.0 → 0.3.0

data/lib/arclight/traject/nokogiri_namespaceless_reader.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Traject
+    # Provides a Traject Reader for XML Documents which removes the namespaces
+    class NokogiriNamespacelessReader < ::Traject::NokogiriReader
+      # Overrides the #each method (which is used for iterating through each Document)
+      # @param args
+      # @see ::Traject::NokogiriReader#each
+      # @see Enumerable#each
+      def each(*args)
+        return to_enum(:each, *args) unless block_given?
+
+        super do |doc|
+          new_doc = doc.dup
+          new_doc.remove_namespaces!
+          yield new_doc
+        end
+      end
+    end
+  end
+end

data/lib/arclight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Arclight
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/arclight/viewers/oembed.rb

@@ -31,6 +31,7 @@ module Arclight
 
       def attributes_for(resource)
         return {} unless embeddable?(resource)
+
         { class: 'al-oembed-viewer', 'data-arclight-oembed': true, 'data-arclight-oembed-url': resource.href }
       end
 

data/lib/arclight/year_range.rb

@@ -25,12 +25,14 @@ module Arclight
     def to_s
       return if years.empty?
       return to_s_for_streak(years) unless gaps?
+
       to_s_with_gaps
     end
 
     # @param [Array<Integer>] `other` the set of years to add
     def <<(other)
       return self if other.blank?
+
       @years |= other # will remove duplicates
       @years.sort!
       self
@@ -40,10 +42,12 @@ module Arclight
     # @return [Array<Integer>] the set of years in the given range
     def parse_range(dates)
       return if dates.blank?
+
       start_year, end_year = dates.split('/').map { |date| to_year_from_iso8601(date) }
       return [start_year] if end_year.blank?
       raise ArgumentError, "Range is too large: #{dates}" if (end_year - start_year) > 1000
       raise ArgumentError, "Range is inverted: #{dates}" unless start_year <= end_year
+
       (start_year..end_year).to_a
     end
 
@@ -57,12 +61,14 @@ module Arclight
     #                        YYYY, YYYY-MM, YYYY-MM-DD, and YYYYMMDD
     def to_year_from_iso8601(date)
       return if date.blank?
+
       date.split('-').first[0..3].to_i # Time.parse doesn't work here
     end
 
     # @return [Boolean] are there gaps between the years, such as 1999, 2000, 2002?
     def gaps?
       return false if years.blank?
+
       (years.min..years.max).to_a != years
     end
 
@@ -73,6 +79,7 @@ module Arclight
     # @return [String] 1999-2000, 2002 for 1999, 2000, 2002
     def to_s_with_gaps # rubocop: disable Metrics/AbcSize, Metrics/MethodLength
       raise ArgumentError if years.blank? || years.length < 2
+
       results = []
       streak = [years[0]]
       i = streak.first
@@ -96,7 +103,8 @@ module Arclight
 
     def to_s_for_streak(streak)
       return streak.min.to_s if streak.min == streak.max
-      [streak.min, streak.max].map(&:to_s).join('-')
+
+      streak.minmax.map(&:to_s).join('-')
     end
   end
 end

data/lib/generators/arclight/install_generator.rb

@@ -6,7 +6,7 @@ module Arclight
   ##
   # Arclight install generator
   class Install < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     def create_blacklight_catalog
       remove_file 'app/controllers/catalog_controller.rb'
@@ -69,5 +69,9 @@ module Arclight
     def modify_blacklight_yml
       gsub_file 'config/locales/blacklight.en.yml', "application_name: 'Blacklight'", "application_name: 'Arclight'"
     end
+
+    def run_yarn
+      run 'yarn add @babel/core @babel/plugin-external-helpers @babel/plugin-transform-modules-umd @babel/preset-env'
+    end
   end
 end

data/lib/generators/arclight/templates/catalog_controller.rb

@@ -108,9 +108,9 @@ class CatalogController < ApplicationController
     config.add_index_field 'normalized_date_ssm', label: 'Date'
     config.add_index_field 'creator_ssm', label: 'Creator'
     config.add_index_field 'language_ssm', label: 'Language'
-    config.add_index_field 'scopecontent_ssm', label: 'Scope Content'
+    config.add_index_field 'scopecontent_ssm', label: 'Scope Content', helper_method: :render_html_tags
     config.add_index_field 'extent_ssm', label: 'Physical Description'
-    config.add_index_field 'accessrestrict_ssm', label: 'Conditions Governing Access'
+    config.add_index_field 'accessrestrict_ssm', label: 'Conditions Governing Access', helper_method: :render_html_tags
     config.add_index_field 'collection_ssm', label: 'Collection Title'
     config.add_index_field 'geogname_ssm', label: 'Place'
 
@@ -155,16 +155,32 @@ class CatalogController < ApplicationController
       field.qt = 'search' # default
     end
     config.add_search_field 'name', label: 'Name' do |field|
-      field.qt = 'name_search'
+      field.qt = 'search'
+      field.solr_parameters = {
+        qf:  '${qf_name}',
+        pf:  '${pf_name}'
+      }
     end
     config.add_search_field 'place', label: 'Place' do |field|
-      field.qt = 'place_search'
+      field.qt = 'search'
+      field.solr_parameters = {
+        qf:  '${qf_place}',
+        pf:  '${pf_place}'
+      }
     end
     config.add_search_field 'subject', label: 'Subject' do |field|
-      field.qt = 'subject_search'
+      field.qt = 'search'
+      field.solr_parameters = {
+        qf:  '${qf_subject}',
+        pf:  '${pf_subject}'
+      }
     end
     config.add_search_field 'title', label: 'Title' do |field|
-      field.qt = 'title_search'
+      field.qt = 'search'
+      field.solr_parameters = {
+        qf:  '${qf_title}',
+        pf:  '${pf_title}'
+      }
     end
 
     # "sort results by" select (pulldown)
@@ -192,11 +208,17 @@ class CatalogController < ApplicationController
 
     config.show.document_presenter_class = Arclight::ShowPresenter
     config.index.document_presenter_class = Arclight::IndexPresenter
+
     ##
     # Configuration for partials
-    config.index.partials.insert(0, :arclight_online_content_indicator)
-    config.index.partials.insert(0, :index_breadcrumb)
-    config.index.partials.insert(0, :arclight_document_index_header)
+    config.index.partials = %i[arclight_index_default]
+
+    ##
+    # Configuration for index actions
+    config.index.document_actions << :containers
+    config.index.document_actions << :online_content_label
+    config.add_results_document_tool :arclight_bookmark_control, partial: 'arclight_bookmark_control'
+    config.index.document_actions.delete(:bookmark)
 
     config.show.metadata_partials = %i[
       summary_field
@@ -206,10 +228,11 @@ class CatalogController < ApplicationController
       indexed_terms_field
     ]
 
-    config.show.context_sidebar_items = %i[
-      in_person_field
+    config.show.context_access_tab_items = %i[
       terms_field
       cite_field
+      in_person_field
+      contact_field
     ]
 
     config.show.component_metadata_partials = %i[
@@ -217,116 +240,129 @@ class CatalogController < ApplicationController
       component_indexed_terms_field
     ]
 
-    config.show.component_sidebar_items = %i[
-      in_person_field
+    config.show.component_access_tab_items = %i[
       component_terms_field
       cite_field
+      in_person_field
+      contact_field
     ]
 
-    # Component Show Page - Metadata Section
-    config.add_component_field 'containers', label: 'Containers', accessor: 'containers', separator_options: {
-      words_connector: ', ',
-      two_words_connector: ', ',
-      last_word_connector: ', '
-    }, if: lambda { |_context, _field_config, document|
-      document.containers.present?
-    }
-    config.add_component_field 'abstract_ssm', label: 'Abstract'
-    config.add_component_field 'extent_ssm', label: 'Extent'
-    config.add_component_field 'scopecontent_ssm', label: 'Scope and Content'
-    config.add_component_field 'accessrestrict_ssm', label: 'Restrictions'
-    config.add_component_field 'userestrict_ssm', label: 'Terms of Access'
-    config.add_component_field 'access_subjects_ssm', label: 'Subjects', separator_options: {
-      words_connector: '<br/>',
-      two_words_connector: '<br/>',
-      last_word_connector: '<br/>'
-    }
+    # ===========================
+    # COLLECTION SHOW PAGE FIELDS
+    # ===========================
+
+    # Collection Show Page - Summary Section
+    config.add_summary_field 'creators_ssim', label: 'Creator', link_to_facet: true
+    config.add_summary_field 'abstract_ssm', label: 'Abstract', helper_method: :render_html_tags
+    config.add_summary_field 'extent_ssm', label: 'Extent'
+    config.add_summary_field 'language_ssm', label: 'Language'
+    config.add_summary_field 'prefercite_ssm', label: 'Preferred citation', helper_method: :render_html_tags
+
+    # Collection Show Page - Background Section
+    config.add_background_field 'scopecontent_ssm', label: 'Scope and Content', helper_method: :render_html_tags
+    config.add_background_field 'bioghist_ssm', label: 'Biographical / Historical', helper_method: :render_html_tags
+    config.add_background_field 'acqinfo_ssim', label: 'Acquisition information', helper_method: :render_html_tags
+    config.add_background_field 'appraisal_ssm', label: 'Appraisal information', helper_method: :render_html_tags
+    config.add_background_field 'custodhist_ssm', label: 'Custodial history', helper_method: :render_html_tags
+    config.add_background_field 'processinfo_ssm', label: 'Processing information', helper_method: :render_html_tags
+    config.add_background_field 'arrangement_ssm', label: 'Arrangement', helper_method: :render_html_tags
+    config.add_background_field 'accruals_ssm', label: 'Accruals', helper_method: :render_html_tags
+    config.add_background_field 'phystech_ssm', label: 'Physical / technical requirements', helper_method: :render_html_tags
+    config.add_background_field 'physloc_ssm', label: 'Physical location', helper_method: :render_html_tags
+    config.add_background_field 'descrules_ssm', label: 'Rules or conventions', helper_method: :render_html_tags
+
+    # Collection Show Page - Related Section
+    config.add_related_field 'relatedmaterial_ssm', label: 'Related material', helper_method: :render_html_tags
+    config.add_related_field 'separatedmaterial_ssm', label: 'Separated material', helper_method: :render_html_tags
+    config.add_related_field 'otherfindaid_ssm', label: 'Other finding aids', helper_method: :render_html_tags
+    config.add_related_field 'altformavail_ssm', label: 'Alternative form available', helper_method: :render_html_tags
+    config.add_related_field 'originalsloc_ssm', label: 'Location of originals', helper_method: :render_html_tags
 
     # Collection Show Page - Indexed Terms Section
-    config.add_component_indexed_terms_field 'access_subjects_ssim', label: 'Subjects', link_to_facet: true, separator_options: {
+    config.add_indexed_terms_field 'access_subjects_ssim', label: 'Subjects', link_to_facet: true, separator_options: {
       words_connector: '<br/>',
       two_words_connector: '<br/>',
       last_word_connector: '<br/>'
     }
 
-    config.add_component_indexed_terms_field 'names_ssim', label: 'Names', separator_options: {
+    config.add_indexed_terms_field 'names_coll_ssim', label: 'Names', separator_options: {
       words_connector: '<br/>',
       two_words_connector: '<br/>',
       last_word_connector: '<br/>'
     }, helper_method: :link_to_name_facet
 
-    config.add_component_indexed_terms_field 'places_ssim', label: 'Places', link_to_facet: true, separator_options: {
+    config.add_indexed_terms_field 'places_ssim', label: 'Places', link_to_facet: true, separator_options: {
       words_connector: '<br/>',
       two_words_connector: '<br/>',
       last_word_connector: '<br/>'
     }
 
-    # Component Show Page Sidebar - Terms and Condition Section
-    config.add_component_terms_field 'parent_access_restrict_ssm', label: 'Restrictions'
-    config.add_component_terms_field 'parent_access_terms_ssm', label: 'Terms of Access'
+    # ==========================
+    # COMPONENT SHOW PAGE FIELDS
+    # ==========================
 
-    # Collection Show Page - Summary Section
-    config.add_summary_field 'creators_ssim', label: 'Creator', link_to_facet: true
-    config.add_summary_field 'abstract_ssm', label: 'Abstract'
-    config.add_summary_field 'extent_ssm', label: 'Extent'
-    config.add_summary_field 'language_ssm', label: 'Language'
-    config.add_summary_field 'prefercite_ssm', label: 'Preferred citation'
-
-    # Collection Show Page - In Person Section
-    config.add_in_person_field 'id', if: :before_you_visit_note_present, label: 'Before you visit', helper_method: :context_sidebar_visit_note # Using ID because we know it will always exist
-    config.add_in_person_field 'containers_ssim', if: :request_config_present, label: 'Request', helper_method: :context_sidebar_containers_request
-    config.add_in_person_field 'repository_ssm', if: :repository_config_present, label: 'Location of this collection', helper_method: :context_sidebar_repository
-
-    # Collection Show Page - Terms and Condition Section
-    config.add_terms_field 'accessrestrict_ssm', label: 'Restrictions'
-    config.add_terms_field 'userestrict_ssm', label: 'Terms of Access'
-
-    # Collection Show Page - How to Cite Section
-    config.add_cite_field 'prefercite_ssm', label: 'Preferred citation'
-
-    # Collection Show Page - Access Section
-    config.add_access_field 'accessrestrict_ssm', label: 'Conditions Governing Access', helper_method: :paragraph_separator
-    config.add_access_field 'userestrict_ssm', label: 'Terms Of Use', helper_method: :paragraph_separator
-
-    # Collection Show Page - Background Section
-    config.add_background_field 'scopecontent_ssm', label: 'Scope and Content', helper_method: :paragraph_separator
-    config.add_background_field 'bioghist_ssm', label: 'Biographical / Historical', helper_method: :paragraph_separator
-    config.add_background_field 'acqinfo_ssm', label: 'Acquisition information', helper_method: :paragraph_separator
-    config.add_background_field 'appraisal_ssm', label: 'Appraisal information', helper_method: :paragraph_separator
-    config.add_background_field 'custodhist_ssm', label: 'Custodial history', helper_method: :paragraph_separator
-    config.add_background_field 'processinfo_ssm', label: 'Processing information', helper_method: :paragraph_separator
-
-    # Collection Show Page - Related Section
-    config.add_related_field 'relatedmaterial_ssm', label: 'Related material', helper_method: :paragraph_separator
-    config.add_related_field 'separatedmaterial_ssm', label: 'Separated material', helper_method: :paragraph_separator
-    config.add_related_field 'otherfindaid_ssm', label: 'Other finding aids', helper_method: :paragraph_separator
-    config.add_related_field 'altformavail_ssm', label: 'Alternative form available', helper_method: :paragraph_separator
-    config.add_related_field 'originalsloc_ssm', label: 'Location of originals', helper_method: :paragraph_separator
-
-    # Collection Show Page - Indexed Terms Section
-    config.add_indexed_terms_field 'access_subjects_ssim', label: 'Subjects', link_to_facet: true, separator_options: {
+    # Component Show Page - Metadata Section
+    config.add_component_field 'containers', label: 'Containers', accessor: 'containers', separator_options: {
+      words_connector: ', ',
+      two_words_connector: ', ',
+      last_word_connector: ', '
+    }, if: lambda { |_context, _field_config, document|
+      document.containers.present?
+    }
+    config.add_component_field 'abstract_ssm', label: 'Abstract', helper_method: :render_html_tags
+    config.add_component_field 'extent_ssm', label: 'Extent'
+    config.add_component_field 'scopecontent_ssm', label: 'Scope and Content', helper_method: :render_html_tags
+    config.add_component_field 'acqinfo_ssim', label: 'Acquisition information', helper_method: :render_html_tags
+    config.add_component_field 'appraisal_ssm', label: 'Appraisal information', helper_method: :render_html_tags
+    config.add_component_field 'custodhist_ssm', label: 'Custodial history', helper_method: :render_html_tags
+    config.add_component_field 'processinfo_ssm', label: 'Processing information', helper_method: :render_html_tags
+    config.add_component_field 'arrangement_ssm', label: 'Arrangement', helper_method: :render_html_tags
+    config.add_component_field 'accruals_ssm', label: 'Accruals', helper_method: :render_html_tags
+    config.add_component_field 'phystech_ssm', label: 'Physical / technical requirements', helper_method: :render_html_tags
+    config.add_component_field 'physloc_ssm', label: 'Physical location', helper_method: :render_html_tags
+
+    # Component Show Page - Indexed Terms Section
+    config.add_component_indexed_terms_field 'access_subjects_ssim', label: 'Subjects', link_to_facet: true, separator_options: {
       words_connector: '<br/>',
       two_words_connector: '<br/>',
       last_word_connector: '<br/>'
     }
 
-    config.add_indexed_terms_field 'names_coll_ssim', label: 'Names', separator_options: {
+    config.add_component_indexed_terms_field 'names_ssim', label: 'Names', separator_options: {
       words_connector: '<br/>',
       two_words_connector: '<br/>',
       last_word_connector: '<br/>'
     }, helper_method: :link_to_name_facet
 
-    config.add_indexed_terms_field 'places_ssim', label: 'Places', link_to_facet: true, separator_options: {
+    config.add_component_indexed_terms_field 'places_ssim', label: 'Places', link_to_facet: true, separator_options: {
       words_connector: '<br/>',
       two_words_connector: '<br/>',
       last_word_connector: '<br/>'
     }
 
-    # Collection Show Page - Administrative Information Section
-    config.add_admin_info_field 'acqinfo_ssm', label: 'Acquisition information'
-    config.add_admin_info_field 'appraisal_ssm', label: 'Appraisal information'
-    config.add_admin_info_field 'custodhist_ssm', label: 'Custodial history'
-    config.add_admin_info_field 'processinfo_ssm', label: 'Processing information'
+    # =================
+    # ACCESS TAB FIELDS
+    # =================
+
+    # Collection Show Page Access Tab - Terms and Conditions Section
+    config.add_terms_field 'accessrestrict_ssm', label: 'Restrictions', helper_method: :render_html_tags
+    config.add_terms_field 'userestrict_ssm', label: 'Terms of Access', helper_method: :render_html_tags
+
+    # Component Show Page Access Tab - Terms and Condition Section
+    config.add_component_terms_field 'accessrestrict_ssm', label: 'Restrictions', helper_method: :render_html_tags
+    config.add_component_terms_field 'userestrict_ssm', label: 'Terms of Access', helper_method: :render_html_tags
+    config.add_component_terms_field 'parent_access_restrict_ssm', label: 'Parent Restrictions', helper_method: :render_html_tags
+    config.add_component_terms_field 'parent_access_terms_ssm', label: 'Parent Terms of Access', helper_method: :render_html_tags
+
+    # Collection and Component Show Page Access Tab - In Person Section
+    config.add_in_person_field 'repository_ssm', if: :repository_config_present, label: 'Location of this collection', helper_method: :context_access_tab_repository
+    config.add_in_person_field 'id', if: :before_you_visit_note_present, label: 'Before you visit', helper_method: :context_access_tab_visit_note # Using ID because we know it will always exist
+
+    # Collection and Component Show Page Access Tab - How to Cite Section
+    config.add_cite_field 'prefercite_ssm', label: 'Preferred citation', helper_method: :render_html_tags
+
+    # Collection and Component Show Page Access Tab - Contact Section
+    config.add_contact_field 'repository_ssm', if: :repository_config_present, label: 'Contact', helper_method: :access_repository_contact
 
     # Remove unused show document actions
     %i[citation email sms].each do |action|
@@ -338,28 +374,20 @@ class CatalogController < ApplicationController
     config.show.partials.unshift(:show_breadcrumbs)
     config.show.partials.delete(:show_header)
 
-
-    ##
-    # Hierarchy Index View
-    config.view.hierarchy
-    config.view.hierarchy.display_control = false
-    config.view.hierarchy.partials = config.index.partials.dup
-    config.view.hierarchy.partials.delete(:index_breadcrumb)
-    config.view.hierarchy.partials.delete(:arclight_online_content_indicator)
-
     ##
-    # Hierarchy Index View
+    # Online Contents Index View
     config.view.online_contents
     config.view.online_contents.display_control = false
-    config.view.online_contents.partials = config.view.hierarchy.partials.dup
 
-    # #
+    ##
+    # Collection Context
+    config.view.collection_context
+    config.view.collection_context.display_control = false
+    config.view.collection_context.partials = %i[index_collection_context]
+
+    ##
     # Compact index view
     config.view.compact
     config.view.compact.partials = %i[arclight_index_compact]
-
-    ##
-    # Extra actions
-    config.add_results_document_tool :google_form, partial: 'arclight/requests/google_form', if: :item_requestable?
   end
 end

data/lib/generators/arclight/templates/config/downloads.yml

@@ -3,6 +3,11 @@
 #                 provide the PDF and/or EAD (.xml) links. The
 #                 size value should be a String (shown as-is) or
 #                 the number of bytes in the download.
+#               - Pass a template key to use a formatted string
+#                 which interpolates document accessors into the
+#                 url using the %{accessor} syntax.
+#               - Pass a size_accessor key to pull the size of
+#                 the file from an accessor in the solr document
 #
 sample_unitid:
   pdf:
@@ -11,3 +16,10 @@ sample_unitid:
   ead:
     href: 'http://example.com/sample.xml'
     size: 123456
+    # size_accessor: 'level'
+default:
+  disabled: true
+  pdf:
+    template: 'http://example.com/%{unitid}.pdf'
+  ead:
+    template: 'http://example.com/%{unitid}.xml'