arclight 0.0.1 → 0.1.0

data/lib/arclight/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arclight
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/arclight/viewer.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'arclight/viewers/oembed'
+
+module Arclight
+  ##
+  # Arclight::Viewer provides the ability to render a configured viewer
+  # The viewer class is configured through the Arclight::Engine configuration
+  # which allows an application to implement their own viewer class.
+  # This class will receive a SolrDocument and must implement to_partial_path.
+  # See Arclight::Viewers::OEmbed for an example implementation of a viewer.
+  class Viewer
+    def self.render(document)
+      new(document).render
+    end
+
+    def initialize(document)
+      @document = document
+    end
+
+    def render
+      renderer.render(
+        viewer_instance.to_partial_path,
+        layout: false,
+        locals: { viewer: viewer_instance }
+      )
+    end
+
+    private
+
+    attr_reader :document
+
+    def viewer_instance
+      viewer_class.new(document)
+    end
+
+    def viewer_class
+      Arclight::Engine.config.viewer_class
+    end
+
+    def renderer
+      ApplicationController.renderer
+    end
+  end
+end

data/lib/arclight/viewers/oembed.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Viewers
+    ##
+    # A class to represent and render an oEmbed viewer.
+    # This defines a partial to be rendered and can
+    # apply any required logic to help map necessary
+    # document attributes for viewer instantiation
+    #
+    # This viewer assumes that the resource itself is requestable
+    # according the CORS policy of the site. This is because we
+    # fetch the resource and look for a link[rel="alternate"] with
+    # a type="application/json+oembed". Th oEmbed endpoint described
+    # with that link tag should be an oEmbed RICH type, and return
+    # the viewer HTML in the html key of the JSON response.
+    class OEmbed
+      attr_reader :document
+
+      def initialize(document)
+        @document = document
+      end
+
+      def resources
+        document.digital_objects
+      end
+
+      def embeddable?(resource)
+        resource == resources.first && embeddable_resources.include?(resource)
+      end
+
+      def attributes_for(resource)
+        return {} unless embeddable?(resource)
+        { class: 'al-oembed-viewer', 'data-arclight-oembed': true, 'data-arclight-oembed-url': resource.href }
+      end
+
+      def to_partial_path
+        'arclight/viewers/_oembed'
+      end
+
+      private
+
+      def exclude_patterns
+        Arclight::Engine.config.oembed_resource_exclude_patterns
+      end
+
+      def embeddable_resources
+        document.digital_objects.reject do |object|
+          exclude_patterns.any? do |pattern|
+            object.href =~ pattern
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arclight/year_range.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Arclight
+  # A range of years that handles gaps, such as [1999, 2000, 2002].
+  # Primary usage is:
+  # ```
+  # range = YearRange.new('1999/2004')
+  # range.years => [1999, 2000, 2001, 2002, 2003, 2004]
+  # range.to_s => '1999-2004'
+  # range << range.parse_ranges(['2010/2010'])
+  # range.years => [1999, 2000, 2001, 2002, 2003, 2004, 2010]
+  # range.to_s => '1999-2004, 2010'
+  # ```
+  class YearRange
+    attr_accessor :years
+
+    # @param [Array<String>] `dates` in the form YYYY/YYYY
+    def initialize(dates = nil)
+      @years = []
+      self << parse_ranges(dates) if dates.present?
+      self
+    end
+
+    # @return [String] a concise, human-readable version of the year range, including gaps
+    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
+    end
+
+    # @param [String] `dates` in the form YYYY/YYYY
+    # @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
+
+    # @param [Array<String>] `dates` in the form YYYY/YYYY
+    # @return [Array<Integer>] the set of years in the given range
+    def parse_ranges(dates)
+      dates.map { |date| parse_range(date) }.flatten.sort.uniq
+    end
+
+    # @param [String] `date` a date in one of these formats:
+    #                        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
+
+    private
+
+    # Deals with making a human-readable range for years with 1 or more gaps.
+    # It involves detection of streaks between the gaps.
+    # @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
+      years[1..-1].each do |j|
+        i += 1
+        if i == j
+          streak << j
+        else # we have a gap
+          results << if streak.length == 1
+                       streak.first.to_s
+                     else
+                       to_s_for_streak(streak)
+                     end
+          streak = [j]
+          i = j
+        end
+      end
+      results << to_s_for_streak(streak)
+      results.join(', ')
+    end
+
+    def to_s_for_streak(streak)
+      return streak.min.to_s if streak.min == streak.max
+      [streak.min, streak.max].map(&:to_s).join('-')
+    end
+  end
+end

data/lib/generators/arclight/install_generator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Arclight
+  ##
+  # Arclight install generator
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_blacklight_catalog
+      remove_file 'app/controllers/catalog_controller.rb'
+      copy_file 'catalog_controller.rb', 'app/controllers/catalog_controller.rb'
+    end
+
+    def include_arclight_solrdocument
+      inject_into_file 'app/models/solr_document.rb', after: 'include Blacklight::Solr::Document' do
+        "\n include Arclight::SolrDocument"
+      end
+    end
+
+    def install_blacklight_range_limit
+      generate 'blacklight_range_limit:install'
+    end
+
+    def add_custom_routes
+      inject_into_file 'config/routes.rb', after: "mount Blacklight::Engine => '/'" do
+        "\n    mount Arclight::Engine => '/'\n"
+      end
+    end
+
+    def assets
+      copy_file 'arclight.scss', 'app/assets/stylesheets/arclight.scss'
+      copy_file 'arclight.js', 'app/assets/javascripts/arclight.js'
+      inject_into_file 'app/assets/javascripts/application.js', after: '//= require blacklight/blacklight' do
+        "\n//= require bootstrap/scrollspy\n" \
+        "\n//= require bootstrap/tab\n"
+      end
+    end
+
+    def add_arclight_search_behavior
+      inject_into_file 'app/models/search_builder.rb', after: 'include Blacklight::Solr::SearchBuilderBehavior' do
+        "\n  include Arclight::SearchBehavior"
+      end
+    end
+
+    def solr_config
+      directory '../../../../solr', 'solr', force: true
+    end
+
+    def add_repository_config
+      copy_file 'config/repositories.yml' unless File.exist?('config/repositories.yml')
+    end
+
+    def add_download_config
+      copy_file 'config/downloads.yml' unless File.exist?('config/downloads.yml')
+    end
+
+    def modify_blacklight_yml
+      gsub_file 'config/locales/blacklight.en.yml', "application_name: 'Blacklight'", "application_name: 'Arclight'"
+    end
+  end
+end

data/lib/generators/arclight/templates/arclight.js

@@ -0,0 +1,2 @@
+//= require arclight/arclight
+//= require stickyfill

data/lib/generators/arclight/templates/arclight.scss

@@ -0,0 +1,3 @@
+/*
+*= require arclight/application
+*/

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

@@ -0,0 +1,347 @@
+# frozen_string_literal: true
+class CatalogController < ApplicationController
+
+  include Blacklight::Catalog
+  include Arclight::Catalog
+  include Arclight::FieldConfigHelpers
+
+  configure_blacklight do |config|
+    ## Class for sending and receiving requests from a search index
+    # config.repository_class = Blacklight::Solr::Repository
+    #
+    ## Class for converting Blacklight's url parameters to into request parameters for the search index
+    # config.search_builder_class = ::SearchBuilder
+    #
+    ## Model that maps search index responses to the blacklight response model
+    # config.response_model = Blacklight::Solr::Response
+
+    ## Default parameters to send to solr for all search-like requests. See also SearchBuilder#processed_parameters
+    config.default_solr_params = {
+      rows: 10
+    }
+
+    # solr path which will be added to solr base url before the other solr params.
+    #config.solr_path = 'select'
+
+    # items to show per page, each number in the array represent another option to choose from.
+    #config.per_page = [10,20,50,100]
+
+    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SearchHelper#solr_doc_params) or
+    ## parameters included in the Blacklight-jetty document requestHandler.
+    #
+    #config.default_document_solr_params = {
+    #  qt: 'document',
+    #  ## These are hard-coded in the blacklight 'document' requestHandler
+    #  # fl: '*',
+    #  # rows: 1,
+    #  # q: '{!term f=id v=$id}'
+    #}
+
+    # solr field configuration for search results/index views
+    config.index.title_field = 'normalized_title_ssm'
+    config.index.display_type_field = 'level_ssm'
+    #config.index.thumbnail_field = 'thumbnail_path_ss'
+
+    # solr field configuration for document/show views
+    #config.show.title_field = 'title_display'
+    #config.show.display_type_field = 'format'
+    #config.show.thumbnail_field = 'thumbnail_path_ss'
+
+    # solr fields that will be treated as facets by the blacklight application
+    #   The ordering of the field names is the order of the display
+    #
+    # Setting a limit will trigger Blacklight's 'more' facet values link.
+    # * If left unset, then all facet values returned by solr will be displayed.
+    # * If set to an integer, then "f.somefield.facet.limit" will be added to
+    # solr request, with actual solr request being +1 your configured limit --
+    # you configure the number of items you actually want _displayed_ in a page.
+    # * If set to 'true', then no additional parameters will be sent to solr,
+    # but any 'sniffed' request limit parameters will be used for paging, with
+    # paging at requested limit -1. Can sniff from facet.limit or
+    # f.specific_field.facet.limit solr request params. This 'true' config
+    # can be used if you set limits in :default_solr_params, or as defaults
+    # on the solr side in the request handler itself. Request handler defaults
+    # sniffing requires solr requests to be made with "echoParams=all", for
+    # app code to actually have it echo'd back to see it.
+    #
+    # :show may be set to false if you don't want the facet to be drawn in the
+    # facet bar
+    #
+    # set :index_range to true if you want the facet pagination view to have facet prefix-based navigation
+    #  (useful when user clicks "more" on a large facet and wants to navigate alphabetically across a large set of results)
+    # :index_range can be an array or range of prefixes that will be used to create the navigation (note: It is case sensitive when searching values)
+
+    config.add_facet_field 'collection_sim', label: 'Collection'
+    config.add_facet_field 'creator_ssim', label: 'Creator'
+    config.add_facet_field 'creators_ssim', label: 'Creator', show: false
+    config.add_facet_field 'date_range_sim', label: 'Date range', range: true
+    config.add_facet_field 'level_sim', label: 'Level'
+    config.add_facet_field 'names_ssim', label: 'Names'
+    config.add_facet_field 'repository_sim', label: 'Repository'
+    config.add_facet_field 'geogname_sim', label: 'Place'
+    config.add_facet_field 'places_ssim', label: 'Places', show:false
+    config.add_facet_field 'access_subjects_ssim', label: 'Subject'
+
+    # Have BL send all facet field names to Solr, which has been the default
+    # previously. Simply remove these lines if you'd rather use Solr request
+    # handler defaults, or have no facets.
+    config.add_facet_fields_to_solr_request!
+
+    # solr fields to be displayed in the index (search results) view
+    #   The ordering of the field names is the order of the display
+    config.add_index_field 'unitid_ssm', label: 'Unit ID'
+    config.add_index_field 'repository_ssm', label: 'Repository'
+    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 'extent_ssm', label: 'Physical Description'
+    config.add_index_field 'accessrestrict_ssm', label: 'Conditions Governing Access'
+    config.add_index_field 'collection_ssm', label: 'Collection Title'
+    config.add_index_field 'geogname_ssm', label: 'Place'
+
+    config.add_facet_field 'has_online_content_ssim', label: 'Access', query: {
+      online: { label: 'Online access', fq: 'has_online_content_ssim:true' }
+    }
+
+    # solr fields to be displayed in the show (single result) view
+    #   The ordering of the field names is the order of the display
+
+    # "fielded" search configuration. Used by pulldown among other places.
+    # For supported keys in hash, see rdoc for Blacklight::SearchFields
+    #
+    # Search fields will inherit the :qt solr request handler from
+    # config[:default_solr_parameters], OR can specify a different one
+    # with a :qt key/value. Below examples inherit, except for subject
+    # that specifies the same :qt as default for our own internal
+    # testing purposes.
+    #
+    # The :key is what will be used to identify this BL search field internally,
+    # as well as in URLs -- so changing it after deployment may break bookmarked
+    # urls.  A display label will be automatically calculated from the :key,
+    # or can be specified manually to be different.
+
+    # This one uses all the defaults set by the solr request handler. Which
+    # solr request handler? The one set in config[:default_solr_parameters][:qt],
+    # since we aren't specifying it otherwise.
+    config.add_search_field 'all_fields', label: 'All Fields' do |field|
+      field.include_in_simple_select = true
+    end
+
+    config.add_search_field 'within_collection' do |field|
+      field.include_in_simple_select = false
+      field.solr_parameters = {
+        fq: '-level_sim:Collection'
+      }
+    end
+
+    # Field-based searches. We have registered handlers in the Solr configuration
+    # so we have Blacklight use the `qt` parameter to invoke them
+    config.add_search_field 'keyword', label: 'Keyword' do |field|
+      field.qt = 'search' # default
+    end
+    config.add_search_field 'name', label: 'Name' do |field|
+      field.qt = 'name_search'
+    end
+    config.add_search_field 'place', label: 'Place' do |field|
+      field.qt = 'place_search'
+    end
+    config.add_search_field 'subject', label: 'Subject' do |field|
+      field.qt = 'subject_search'
+    end
+    config.add_search_field 'title', label: 'Title' do |field|
+      field.qt = 'title_search'
+    end
+
+    # "sort results by" select (pulldown)
+    # label in pulldown is followed by the name of the SOLR field to sort by and
+    # whether the sort is ascending or descending (it must be asc or desc
+    # except in the relevancy case).
+    config.add_sort_field 'score desc, title_sort asc', label: 'relevance'
+    config.add_sort_field 'date_sort asc', label: 'date (ascending)'
+    config.add_sort_field 'date_sort desc', label: 'date (descending)'
+    config.add_sort_field 'creator_sort asc', label: 'creator (A-Z)'
+    config.add_sort_field 'creator_sort desc', label: 'creator (Z-A)'
+    config.add_sort_field 'title_sort asc', label: 'title (A-Z)'
+    config.add_sort_field 'title_sort desc', label: 'title (Z-A)'
+
+    # If there are more than this many search results, no spelling ("did you
+    # mean") suggestion is offered.
+    config.spell_max = 5
+
+    # Configuration for autocomplete suggestor
+    config.autocomplete_enabled = true
+    config.autocomplete_path = 'suggest'
+
+    ##
+    # Arclight Configurations
+
+    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.show.metadata_partials = [
+      :summary_field,
+      :access_field,
+      :background_field,
+      :related_field,
+      :indexed_terms_field
+    ]
+
+    config.show.context_sidebar_items = [
+      :in_person_field,
+      :terms_field,
+      :cite_field
+    ]
+
+    config.show.component_metadata_partials = [
+      :component_field,
+      :component_indexed_terms_field
+    ]
+
+    config.show.component_sidebar_items = [
+      :in_person_field,
+      :component_terms_field,
+      :cite_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 - 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_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_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/>'
+    }
+
+    # 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'
+
+    # 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: {
+      words_connector: '<br/>',
+      two_words_connector: '<br/>',
+      last_word_connector: '<br/>'
+    }
+
+    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_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'
+
+    # Remove unused show document actions
+    %i[citation email sms].each do |action|
+      config.view_config(:show).document_actions.delete(action)
+    end
+
+    # Insert the breadcrumbs at the beginning
+    config.show.partials.unshift(:show_breadcrumbs)
+
+    ##
+    # 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)
+
+    ##
+    # Hierarchy Index View
+    config.view.online_contents
+    config.view.online_contents.display_control = false
+    config.view.online_contents.partials = config.view.hierarchy.partials.dup
+
+    # #
+    # 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