geoblacklight 2.3.0

data/app/models/concerns/geoblacklight/solr_document/finder.rb

@@ -0,0 +1,38 @@
+module Geoblacklight
+  module SolrDocument
+    ##
+    # Finder methods for SolrDocuments
+    # modeled after Spotlight's Finder module
+    # https://github.com/sul-dlss/spotlight/blob/master/app/models/concerns/spotlight/solr_document/finder.rb
+    module Finder
+      extend ActiveSupport::Concern
+      include Blacklight::Configurable
+
+      ##
+      # Class level finder methods for documents
+      module ClassMethods
+        ##
+        # Find a Solr Document from an index
+        # @param [String]
+        def find(id)
+          solr_response = index.find(id)
+          solr_response.documents.first
+        end
+
+        def index
+          @index ||= blacklight_config.repository_class.new(blacklight_config)
+        end
+
+        protected
+
+        def blacklight_config
+          @conf ||= copy_blacklight_config_from(CatalogController)
+        end
+      end
+
+      def blacklight_solr
+        self.class.index.connection
+      end
+    end
+  end
+end

data/app/models/concerns/geoblacklight/solr_document/inspection.rb

@@ -0,0 +1,15 @@
+module Geoblacklight
+  module SolrDocument
+    ##
+    # Module to provide inspection logic for solr document
+    module Inspection
+      ##
+      # Returns boolean about whether document viewer protocol is inspectable
+      # @return [Boolean]
+      def inspectable?
+        %w(wms feature_layer dynamic_map_layer tiled_map_layer)
+          .include? viewer_protocol
+      end
+    end
+  end
+end

data/app/models/concerns/geoblacklight/spatial_search_behavior.rb

@@ -0,0 +1,69 @@
+module Geoblacklight
+  module SpatialSearchBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.default_processor_chain += [:add_spatial_params, :hide_suppressed_records]
+    end
+
+    ##
+    # Adds spatial parameters to a Solr query if :bbox is present.
+    # @param [Blacklight::Solr::Request] solr_params :bbox should be in Solr
+    # :bbox should be passed in using Solr lat-lon rectangle format e.g.
+    # "minX minY maxX maxY"
+    # @return [Blacklight::Solr::Request]
+    def add_spatial_params(solr_params)
+      if blacklight_params[:bbox]
+        solr_params[:bq] ||= []
+        solr_params[:bq] << "#{Settings.FIELDS.GEOMETRY}:\"IsWithin(#{envelope_bounds})\"#{boost}"
+        solr_params[:fq] ||= []
+        solr_params[:fq] << "#{Settings.FIELDS.GEOMETRY}:\"Intersects(#{envelope_bounds})\""
+
+        if Settings.OVERLAP_RATIO_BOOST
+          solr_params[:overlap] =
+            "{!field uf=* defType=lucene f=solr_bboxtype score=overlapRatio}Intersects(#{envelope_bounds})"
+          solr_params[:bf] = "$overlap^#{Settings.OVERLAP_RATIO_BOOST}"
+        end
+      end
+      solr_params
+    rescue Geoblacklight::Exceptions::WrongBoundingBoxFormat
+      # TODO: Potentially delete bbox params here so that its not rendered as search param
+      solr_params
+    end
+
+    ##
+    # @return [String]
+    def envelope_bounds
+      bounding_box.to_envelope
+    end
+
+    ## Allow bq boost to be configured, default 10 for backwards compatibility
+    # @return [String]
+    def boost
+      "^#{Settings.BBOX_WITHIN_BOOST || '10'}"
+    end
+
+    ##
+    # Returns a Geoblacklight::BoundingBox built from the blacklight_params
+    # @return [Geoblacklight::BoundingBox]
+    def bounding_box
+      Geoblacklight::BoundingBox.from_rectangle(blacklight_params[:bbox])
+    end
+
+    ##
+    # Hide suppressed records in search
+    # @param [Blacklight::Solr::Request]
+    # @return [Blacklight::Solr::Request]
+    def hide_suppressed_records(solr_params)
+      # Show child records if searching for a specific source parent
+      return unless blacklight_params.fetch(:f, {})[Settings.FIELDS.SOURCE.to_sym].nil?
+
+      # Do not suppress action_documents method calls for individual documents
+      # ex. CatalogController#web_services (exportable views)
+      return if solr_params[:q]&.include?('{!lucene}layer_slug_s:')
+
+      solr_params[:fq] ||= []
+      solr_params[:fq] << '-suppressed_b: true'
+    end
+  end
+end

data/app/presenters/geoblacklight/document_presenter.rb

@@ -0,0 +1,23 @@
+module Geoblacklight
+  ##
+  # Adds custom functionality for Geoblacklight document presentation
+  class DocumentPresenter < Blacklight::IndexPresenter
+    include ActionView::Helpers::OutputSafetyHelper
+    ##
+    # Presents configured index fields in search results. Passes values through
+    # configured helper_method. Multivalued fields separated by presenter
+    # field_value_separator (default: comma). Fields separated by period.
+    # @return [String]
+    def index_fields_display
+      fields_values = []
+      @configuration.index_fields.each do |_field_name, field_config|
+        val = field_value(field_config)
+        unless val.blank?
+          val += '.' unless val.end_with?('.')
+          fields_values << val
+        end
+      end
+      safe_join(fields_values, ' ')
+    end
+  end
+end

data/app/views/catalog/_data_dictionary.html.erb

@@ -0,0 +1,6 @@
+<% if document.data_dictionary_download.present? %>
+    <%= link_to document.data_dictionary_download[:data_dictionary] do %>
+        <%= geoblacklight_icon('book') %>
+        <%= t('geoblacklight.references.data_dictionary') %>
+    <% end %>
+<% end %>

data/app/views/catalog/_document_action.html.erb

@@ -0,0 +1,6 @@
+<%= link_to document_action_path(document_action_config, (local_assigns.has_key?(:url_opts) ? url_opts : {}).merge(({id: document} if document) || {})),
+            id: document_action_config.fetch(:id, "#{document_action_config.key}Link"),
+            data: {}.merge(({blacklight_modal: "trigger"} if document_action_config.modal != false) || {}) do %>
+    <%= geoblacklight_icon(document_action_config.key) %>
+    <%= document_action_label(document_action_config.key, document_action_config) %>
+<% end %>

data/app/views/catalog/_document_split.html.erb

@@ -0,0 +1,6 @@
+<div class='row'>
+  <div id="documents" class="documents-list col-md-6">
+    <%= render documents, :as => :document %>
+  </div>
+  <%= content_tag :div, '', id: 'map', class: 'col-md-6', data: { map: 'index', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
+</div>

data/app/views/catalog/_download_generated_link.html.erb

@@ -0,0 +1,4 @@
+<li class="list-group-item export">
+  <div class="export-label"><%= download_body %></div>
+  <div class="export-link-container"><%= download_link %></div>
+</li>

data/app/views/catalog/_download_link.html.erb

@@ -0,0 +1,3 @@
+<li class="list-group-item download">
+  <div class="download-link-container"><%= download_link %></div>
+</li>

data/app/views/catalog/_downloads_generated.html.erb

@@ -0,0 +1,6 @@
+<%# Renders the secondary downloads displayed in the split dropdown %>
+<% document ||= @document %>
+
+<% document.download_types.each do |type| %>
+  <%= render partial: 'download_generated_link', locals: { download_body: download_generated_body(type.first), download_link: download_link_generated(type.first, document) } %>
+<% end %>

data/app/views/catalog/_downloads_primary.html.erb

@@ -0,0 +1,14 @@
+<%# Renders the primary download that is shown first %>
+<% document ||= @document %>
+
+<% if document.direct_download.present? %>
+  <%= render partial: 'download_link', locals: { download_link: download_link_direct(download_text(document.file_format), document) } %>
+<% end %>
+
+<% if document.hgl_download.present? %>
+  <%= render partial: 'download_link', locals: { download_link: download_link_hgl(download_text(document.download_types.first[0]), document) } %>
+<% end %>
+
+<% if document.iiif_download.present? %>
+  <%= render partial: 'download_link', locals: { download_link: download_link_iiif } %>
+<% end %>

data/app/views/catalog/_downloads_secondary.html.erb

@@ -0,0 +1,39 @@
+<%# Renders the secondary downloads displayed in the split dropdown %>
+<% document ||= @document %>
+
+<button type='button' class='btn btn-default dropdown-toggle download-dropdown-toggle' data-toggle='dropdown' aria-expanded='false'>
+  <span class='caret'></span>
+  <span class='sr-only'>Toggle Download Dropdown</span>
+</button>
+<ul class='dropdown-menu' role='menu'>
+  <% if document.hgl_download.present? %>
+    <li role="presentation" class="dropdown-header">Original</li>
+    <li>
+      <%= link_to(download_text(document.download_types.first[0]),
+      download_hgl_path(id: document), data: {blacklight_modal: 'trigger', download: 'trigger', download_type: 'harvard-hgl', download_id: document.id }) %>
+    </li>
+  <% else %>
+    <% if document.direct_download.present? %>
+      <li role="presentation" class="dropdown-header">Original</li>
+      <li>
+        <%= link_to(download_text(@document.file_format), document.direct_download[:download], 'contentUrl' => document.direct_download[:download], data: { download: 'trigger', download_type: 'direct', download_id: document.id }) %>
+      </li>
+    <% end %>
+    <% if document.download_types.present? || document.iiif_download.present? %>
+      <li role="presentation" class="dropdown-header">Generated</li>
+    <% end %>
+    <% if document.iiif_download.present? %>
+      <li>
+        <%= link_to "Download JPG", iiif_jpg_url, download: 'trigger' %>
+      </li>
+    <% end %>
+
+    <% if document.download_types.present? %>
+      <% document.download_types.each do |type| %>
+        <%= content_tag(:li) do %>
+          <% link_to(download_text(type[0]), '', data: { download_path: "#{download_path(document.id, type: type[0])}", download: 'trigger', download_type: type[0], download_id: document.id }) %>
+        <% end %>
+      <% end %>
+    <% end %>
+  <% end %>
+</ul>

data/app/views/catalog/_exports.html.erb

@@ -0,0 +1,3 @@
+<% document ||= @document %>
+<%= display_carto %>
+<%= display_arcgis %>

data/app/views/catalog/_facet_tag_item.html.erb

@@ -0,0 +1,3 @@
+<% display_facet.items.each do |item| %>
+  <%= link_to item.value, search_catalog_path({f: {"#{facet_field.field}" => [item.value]}}), class: 'home-facet-link' %><%= "," %>
+<% end %>

data/app/views/catalog/_facet_tag_layout.html.erb

@@ -0,0 +1,2 @@
+<%= yield %>
+<%= link_to t('blacklight.search.facets.more_html'), facet_catalog_path(display_facet.name), class: 'more_facets_link' %>

data/app/views/catalog/_header_icons.html.erb

@@ -0,0 +1,3 @@
+<%= geoblacklight_icon(document[Settings.FIELDS.GEOM_TYPE]) %>
+<%= geoblacklight_icon(document[Settings.FIELDS.PROVENANCE]) %>
+<%= geoblacklight_icon(document[Settings.FIELDS.RIGHTS]) %>

data/app/views/catalog/_home_text.html.erb

@@ -0,0 +1,43 @@
+<div class='container'>
+  <div class='row text-center'>
+    <div class='col-sm'>
+      <%= content_tag :h3, t('geoblacklight.home.category_heading') %>
+      <div class='row'>
+        <div class='category-block col-sm'>
+          <div class='category-icon'>
+            <%= geoblacklight_icon('home') %>
+          </div>
+          <%= content_tag :h4, t('geoblacklight.home.institution') %>
+          <%= render_facet_tags [Settings.FIELDS.PROVENANCE] %>
+        </div>
+        <div class='category-block col-sm'>
+          <div class='category-icon'>
+            <%= geoblacklight_icon('arrow-circle-down') %>
+          </div>
+          <%= content_tag :h4, t('geoblacklight.home.data_type') %>
+          <%= render_facet_tags [Settings.FIELDS.GEOM_TYPE] %>
+        </div>
+      </div>
+      <div class='row'>
+        <div class='category-block col-sm'>
+          <div class='category-icon'>
+            <%= geoblacklight_icon('globe') %>
+          </div>
+          <%= content_tag :h4, t('geoblacklight.home.placename') %>
+          <%= render_facet_tags [Settings.FIELDS.SPATIAL_COVERAGE] %>
+        </div>
+        <div class='category-block col-sm'>
+          <div class='category-icon'>
+            <%= geoblacklight_icon('tags') %>
+          </div>
+          <%= content_tag :h4, t('geoblacklight.home.subject') %>
+          <%= render_facet_tags [Settings.FIELDS.SUBJECT] %>
+        </div>
+      </div>
+    </div>
+    <div class='col-sm'>
+      <%= content_tag :h3, t('geoblacklight.home.map_heading') %>
+      <%= content_tag :div, '', id: 'map', data: { map: 'home', 'catalog-path'=> search_catalog_path , 'map-bbox' => params[:bbox], basemap: geoblacklight_basemap, leaflet_options: leaflet_options } %>
+    </div>
+  </div>
+</div>

data/app/views/catalog/_icon_facet.html.erb

@@ -0,0 +1,16 @@
+<ul class="facet-values list-unstyled">
+  <% paginator = facet_paginator(facet_field, display_facet) %>
+  <% paginator.items.each do |item| -%>
+    <li>
+      <%= render_facet_item_with_icon(field_name, item) %>
+    </li>
+  <% end %>
+  <% unless paginator.last_page? || params[:action] == "facet" %>
+    <li class="more_facets">
+      <%= link_to t("more_#{field_name}_html", scope: 'blacklight.search.facets', default: :more_html, field_name: facet_field.label), 
+        search_facet_path(id: facet_field.key),
+        data: { blacklight_modal: 'trigger' },
+        class: 'more_facets_link' %>
+    </li>
+  <% end %>
+</ul>

data/app/views/catalog/_index_split_default.html.erb

@@ -0,0 +1,22 @@
+<% # header bar for doc items in index view -%>
+<%= content_tag :div, class: 'documentHeader row', data: { layer_id: document.id, bbox: document.bounding_box_as_wsen } do %>
+  <div class='status-icons'>
+    <%= render partial: 'header_icons', locals: { document: document } %>
+  </div>
+  <h3 class="index_title col-sm-9s cosl-lg-10 text-span">
+    <span class='caret-toggle'></span>
+    <% counter = document_counter_with_offset(document_counter) %>
+    <span class="document-counter">
+      <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
+    </span>
+    <%= link_to_document document, counter: counter, title: document[blacklight_config.index.title_field] %>
+  </h3>
+
+  <div class='col-md-12 more-info-area'>
+    <div class='collapse' data-collapse-target="<%= document.id %>">
+      <small>
+        <%= geoblacklight_present(:index_fields_display, document) %>
+      </small>
+    </div>
+  </div>
+<% end %>

data/app/views/catalog/_metadata.html.erb

@@ -0,0 +1,27 @@
+<% document ||= @documents.first %>
+
+<div class='metadata-view'>
+  <div class="container-fluid">
+    <ul class="nav nav-pills" role="tablist">
+      <% document.references.shown_metadata.each do |metadata| %>
+        <li role="presentation" class="nav-item">
+          <a class="pill-metadata nav-link <%= first_metadata?(document, metadata) ? 'active' : nil %>"
+             href="#<%= metadata.type %>"
+             aria-controls="<%= metadata.type %>"
+             role="tab"
+             data-toggle="pill"
+             data-ref-endpoint="<%= metadata.endpoint %>"
+             data-ref-download="#btn-metadata-download"><%= formatted_name_reference(metadata.type) %></a>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+
+  <div class="tab-content">
+    <% document.references.shown_metadata.each do |metadata| %>
+      <div role="tabpanel" class="tab-pane<%= first_metadata?(document, metadata) ? ' active' : nil %>" id="<%= metadata.type %>">
+        <%= render_transformed_metadata(metadata) %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/catalog/_relations_container.html.erb

@@ -0,0 +1 @@
+<%= content_tag(:div, nil, data: {relations: true, url: solr_document_path(document.id)}) %>

data/app/views/catalog/_results_pagination.html.erb

@@ -0,0 +1,12 @@
+<%# An override of a Blacklight template to provide a stable point to replace pagination https://github.com/projectblacklight/blacklight/blob/8b9041544553ce0dd0d979f9f39f78d94b30b46d/app/views/catalog/_results_pagination.html.erb %>
+<div id="pagination">
+  <% if show_pagination? and @response.total_pages > 1 %>
+   <div class="row record-padding">
+    <div class="col-md-12">
+      <div class="pagination">
+        <%= paginate @response, :outer_window => 2, :theme => 'blacklight' %>
+      </div>
+    </div>
+   </div>
+  <% end %>
+</div>

data/app/views/catalog/_show_default_attribute_table.html.erb

@@ -0,0 +1,19 @@
+<% if show_attribute_table? %>
+  <div class='row'>
+    <div id='table-container' class='col-md-12'>
+      <table id="attribute-table" class="table table-hover table-condensed table-striped table-bordered col-md-12">
+        <thead>
+          <tr>
+            <th><%= t('geoblacklight.show.attribute') %></th>
+            <th><%= t('geoblacklight.show.value') %></th>
+          </tr>
+        </thead>
+        <tbody class='attribute-table-body'>
+          <tr>
+            <td class='default-text' colspan='2'><em><%= t('geoblacklight.show.click_map') %></em></td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+  </div>
+<% end %>

data/app/views/catalog/_show_default_viewer_container.html.erb

@@ -0,0 +1,12 @@
+<% document ||= @document %>
+<div class='row'>
+  <div id='viewer-container' class="col-md-12">
+
+    <% if show_help_text?('viewer_protocol', document.viewer_protocol) %>
+      <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
+    <% end %>
+
+    <%= content_tag :div, id: 'map', data: { map: 'item', protocol: document.viewer_protocol.camelize, url: document.viewer_endpoint, 'layer-id' => document.wxs_identifier, 'map-bbox' => document.bounding_box_as_wsen, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
+    <% end %>
+  </div>
+</div>

data/app/views/catalog/_show_default_viewer_information.html.erb

@@ -0,0 +1,4 @@
+<div class='row'>
+  <div class='viewer-information col-sm-12'>
+  </div>
+</div>

data/app/views/catalog/_show_downloads.html.erb

@@ -0,0 +1,34 @@
+<% document ||= @document %>
+
+<% if document_downloadable? %>
+  <% if document.direct_download.present? || document.hgl_download.present? || document.iiif_download.present? %>
+    <div class="card downloads">
+      <div class="card-header">
+        <h2><%= t('geoblacklight.download.download').pluralize %></h2>
+      </div>
+
+      <ul class="list-group list-group-flush js-download-list">
+        <%= render 'downloads_primary' %>
+      </ul>
+    </div>
+  <% end %>
+
+  <% if document.download_types.present? %>
+    <div class="card exports">
+      <div class="card-header">
+
+        <h2><%= t('geoblacklight.download.export_formats') %></h2>
+      </div>
+
+      <ul class="list-group list-group-flush">
+        <%= render 'downloads_generated' %>
+      </ul>
+    </div>
+  <% end %>
+<% elsif document.restricted? && document.same_institution? %>
+  <div class="card authentication">
+    <div class="card-header">
+      <%= link_to t('geoblacklight.tools.login_to_view'), new_user_session_path(referrer: request.original_url), class: ['btn', 'btn-default'] %>
+    </div>
+  </div>
+<% end %>