arclight 0.2.0 → 0.3.0

data/app/models/arclight/document_downloads.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Model the Download links that can be configured (via YAML) for a collection
+  # or container
+  class DocumentDownloads
+    attr_reader :document
+
+    def initialize(document, id = nil)
+      @document = document
+      @id = id
+    end
+
+    # Accessor for the ID
+    # @return [String]
+    def id
+      @id || document.unitid
+    end
+
+    # Factory method for the File objects
+    # @return [Array<Arclight::DocumentDownloads::File>]
+    def files
+      data = self.class.config[id] || self.class.config['default']
+      disabled = data.delete('disabled')
+      return [] if disabled
+
+      @files ||= data.map do |file_type, file_data|
+        self.class.file_class.new(type: file_type, data: file_data, document: document)
+      end.compact
+    end
+
+    def to_partial_path
+      'catalog/document_downloads'
+    end
+
+    class << self
+      def config
+        @config ||= begin
+                      YAML.safe_load(::File.read(config_filename))
+                    rescue Errno::ENOENT
+                      {}
+                    end
+      end
+
+      def config_filename
+        Rails.root.join('config', 'downloads.yml')
+      end
+
+      # Accessor for the File Class
+      # @return [Class]
+      def file_class
+        File
+      end
+    end
+
+    ##
+    # Model a single file configured in downloads.yml
+    class File
+      attr_reader :type, :document
+      def initialize(type:, data:, document:)
+        @type = type
+        @data = data
+        @document = document
+      end
+
+      def href
+        return data['href'] if data['href']
+
+        format_template
+      end
+
+      def size
+        return data['size'] if data['size']
+
+        document.send(data['size_accessor'].to_sym) if data['size_accessor']
+      end
+
+      private
+
+      attr_reader :data
+
+      def format_template
+        return unless template
+
+        template % template_interpolations
+      end
+
+      def template
+        data['template']
+      end
+
+      def template_interpolations
+        escaped_document_interpolations.merge(custom_interpolations).symbolize_keys
+      end
+
+      def custom_interpolations
+        { 'repository_id' => document.repository_config&.slug }
+      end
+
+      def template_variables
+        data['template'].scan(/%{(\w+)}/).flatten.uniq
+      end
+
+      def escaped_document_interpolations
+        non_custom_template_variables.map do |method_name|
+          [method_name, escape_non_url_doc_value(document.send(method_name))]
+        end.to_h
+      end
+
+      def escape_non_url_doc_value(value)
+        value = Array.wrap(value).first || '' # Handle single values/arrays and nil
+        return value if value.start_with?(/https?:/)
+
+        CGI.escape(value)
+      end
+
+      def non_custom_template_variables
+        template_variables.reject do |v|
+          custom_interpolations.keys.include?(v)
+        end
+      end
+    end
+  end
+end

data/app/models/arclight/parent.rb

@@ -5,11 +5,12 @@ 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:)
+    attr_reader :id, :label, :eadid, :level
+    def initialize(id:, label:, eadid:, level:)
       @id = id
       @label = label
       @eadid = eadid
+      @level = level
     end
 
     ##
@@ -18,6 +19,7 @@ module Arclight
     # @return [String]
     def global_id
       return id if eadid == id
+
       "#{eadid}#{id}"
     end
   end

data/app/models/arclight/parents.rb

@@ -5,11 +5,12 @@ 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:)
+    attr_reader :ids, :labels, :levels
+    def initialize(ids:, labels:, eadid:, levels:)
       @ids = ids
       @labels = labels
       @eadid = eadid
+      @levels = levels
     end
 
     def eadid
@@ -19,7 +20,7 @@ module Arclight
     ##
     # @return [Array[Arclight::Parent]]
     def as_parents
-      Hash[ids.zip(labels)].map { |k, v| Arclight::Parent.new(id: k, label: v, eadid: eadid) }
+      ids.map.with_index { |_id, idx| Arclight::Parent.new(id: ids[idx], label: labels[idx], eadid: eadid, level: levels[idx]) }
     end
 
     ##
@@ -28,7 +29,8 @@ module Arclight
       ids = document.parent_ids
       labels = document.parent_labels
       eadid = document.eadid
-      new(ids: ids, labels: labels, eadid: eadid)
+      levels = document.parent_levels
+      new(ids: ids, labels: labels, eadid: eadid, levels: levels)
     end
   end
 end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Requests
+    ##
+    # This class should be used to turn configuration into a URL and
+    # POST form specifically aimed at Aeon's external request
+    # endpoint (https://support.atlas-sys.com/hc/en-us/articles/360011820054-External-Request-Endpoint)
+    class AeonExternalRequest
+      def initialize(document, presenter)
+        @document = document
+        @presenter = presenter
+      end
+
+      def config
+        @config ||= @document.repository_config.request_config_for_type('aeon_external_request_endpoint')
+      end
+
+      def url
+        "#{config['request_url']}?#{url_params}"
+      end
+
+      def form_mapping
+        static_mappings.merge(dynamic_mappings)
+      end
+
+      def static_mappings
+        config['request_mappings']['static']
+      end
+
+      def dynamic_mappings
+        config['request_mappings']['accessor'].transform_values do |v|
+          @document.send(v.to_sym)
+        end
+      end
+
+      def url_params
+        config['request_mappings']['url_params'].to_query
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# 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 configuration
+    class AeonWebEad
+      attr_reader :document, :ead_url
+      ##
+      # @param [Blacklight::SolrDocument] document
+      # @param [String] ead_url
+      def initialize(document, ead_url)
+        @document = document
+        @ead_url = ead_url
+      end
+
+      ##
+      # Url target for Aeon request params
+      def request_url
+        document.repository_config.request_url_for_type('aeon_web_ead')
+      end
+
+      ##
+      # Constructed request URL
+      def url
+        "#{request_url}?#{form_mapping.to_query}"
+      end
+
+      ##
+      # Converts mappings as a query url param into a Hash used for sending
+      # messages
+      # If a defined method is provided as a value, that method will be invoked
+      # "collection_name=entry.123" => { "collection_name" => "entry.123" }
+      # @return [Hash]
+      def form_mapping
+        form_hash = Rack::Utils.parse_nested_query(
+          document.repository_config.request_mappings_for_type('aeon_web_ead')
+        )
+        form_hash.each do |key, value|
+          respond_to?(value) && form_hash[key] = send(value)
+        end
+        form_hash
+      end
+    end
+  end
+end

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

@@ -22,7 +22,7 @@ module Arclight
       ##
       # Url of form to fill
       def url
-        document.repository_config.google_request_url
+        document.repository_config&.request_url_for_type('google_form')
       end
 
       ##
@@ -32,7 +32,7 @@ module Arclight
       # @return [Hash]
       def form_mapping
         Rack::Utils.parse_nested_query(
-          document.repository_config.google_request_mappings
+          document.repository_config&.request_mappings_for_type('google_form')
         )
       end
 

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

@@ -4,18 +4,30 @@ module Arclight
   ##
   # Arclight specific methods for the Catalog
   module Catalog
+    extend ActiveSupport::Concern
+
+    included do
+      before_action only: :index do
+        if (params.dig(:f, :collection_sim) || []).any?(&:blank?)
+          params[:f][:collection_sim].delete_if(&:blank?)
+          params[:f].delete(:collection_sim) if params[:f][:collection_sim].blank?
+        end
+      end
+    end
+
     ##
     # 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
+      !%w[online_contents collection_context].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])
+      return if %w[online_contents collection_context].include?(params[:view])
+
       super
     end
   end

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

@@ -11,35 +11,50 @@ module Arclight
         add_hierarchy_max_rows
         add_hierarchy_sort
         add_highlighting
+        add_grouping
       ]
     end
 
     ##
-    # For the hierarchy view, set a higher (unlimited) maximum document return
+    # Override Blacklight's method so that some views don't add Solr facets into the request.
+    def add_facetting_to_solr(solr_params)
+      if %w[collection_context online_contents].include? blacklight_params[:view]
+        return solr_params
+      end
+
+      super(solr_params)
+    end
+
+    ##
+    # For the collection_context views, set a higher (unlimited) maximum document return
     def add_hierarchy_max_rows(solr_params)
-      if blacklight_params[:view] == 'hierarchy'
+      if %w[collection_context].include? blacklight_params[:view]
         solr_params[:rows] = 999_999_999
       end
       solr_params
     end
 
     ##
-    # For the hierarchy view, set the sort order to preserve the order of components
+    # For the asynch views, set the sort order to preserve the order of components
     def add_hierarchy_sort(solr_params)
-      solr_params[:sort] = 'sort_ii asc' if %w[hierarchy online_contents].include? blacklight_params[:view]
+      solr_params[:sort] = 'sort_ii asc' if %w[online_contents collection_context].include? blacklight_params[:view]
       solr_params
     end
 
     ##
-    # Disable highlighting for hiearchy, and enable it for all other searches
+    # Add highlighting
     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['hl'] = true
+      solr_params['hl.fl'] = 'text'
+      solr_params['hl.snippets'] = 3
+      solr_params
+    end
+
+    ##
+    # Adds grouping parameters for Solr if enabled
+    def add_grouping(solr_params)
+      solr_params.merge!(Arclight::Engine.config.catalog_controller_group_query_params) if blacklight_params[:group] == 'true'
+
       solr_params
     end
   end

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

@@ -5,22 +5,32 @@ module Arclight
   # Extends Blacklight::Solr::Document to provide Arclight specific behavior
   module SolrDocument
     extend Blacklight::Solr::Document
+    include Arclight::EadFormatHelpers
 
     def repository_config
       return unless repository
+
       @repository_config ||= Arclight::Repository.find_by(name: repository)
     end
 
     def parent_ids
-      fetch('parent_ssm', [])
+      fetch('parent_ssim', [])
     end
 
     def parent_labels
       fetch('parent_unittitles_ssm', [])
     end
 
+    def parent_levels
+      fetch('parent_levels_ssm', [])
+    end
+
+    def parent_document
+      self.class.new fetch('parent').fetch('docs', []).first
+    end
+
     def eadid
-      fetch('ead_ssi', nil)
+      fetch('ead_ssi', nil)&.strip
     end
 
     def unitid
@@ -39,12 +49,17 @@ module Arclight
       first('collection_ssm')
     end
 
+    def collection_unitid
+      first('collection_unitid_ssm')
+    end
+
     def extent
       first('extent_ssm')
     end
 
     def abstract_or_scope
-      first('abstract_ssm') || first('scopecontent_ssm')
+      value = first('abstract_ssm') || first('scopecontent_ssm')
+      render_html_tags(value: [value]) if value.present?
     end
 
     def creator
@@ -84,21 +99,21 @@ module Arclight
     end
 
     def terms
-      first('userestrict_ssm')
+      render_html_tags(value: [first('userestrict_ssm')])
     end
 
     # Restrictions for component sidebar
     def parent_restrictions
-      first('parent_access_restrict_ssm')
+      render_html_tags(value: [first('parent_access_restrict_ssm')])
     end
 
     # Terms for component sidebar
     def parent_terms
-      first('parent_access_terms_ssm')
+      render_html_tags(value: [first('parent_access_terms_ssm')])
     end
 
     def digital_objects
-      digital_objects_field = fetch('digital_objects_ssm', [])
+      digital_objects_field = fetch('digital_objects_ssm', []).reject(&:empty?)
       return [] if digital_objects_field.blank?
 
       digital_objects_field.map do |object|
@@ -125,7 +140,14 @@ module Arclight
       return if highlight_response.blank? ||
                 highlight_response[id].blank? ||
                 highlight_response[id][:text].blank?
+
       highlight_response[id][:text]
     end
+
+    # Factory method for constructing the Object modeling downloads
+    # @return [DocumentDownloads]
+    def downloads
+      @downloads ||= DocumentDownloads.new(self)
+    end
   end
 end