geoblacklight 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39929d92f69fc2ae2167f47e4d587f16f082ce35
-  data.tar.gz: 1b71af84ccfc5da591f39b072a35bf4180e07285
+  metadata.gz: d3c10c3715efdc9443e4deec764b0d3d7855fc11
+  data.tar.gz: cdce289bfb3b6427ed07c3b68a09f5626bd49298
 SHA512:
-  metadata.gz: 72578066955f12d215d6e0f1734d124d7affeeee831f2ac823d489b48af8b3e53bc32712aba80343db5043bdac9d94ab1106677c5ca653e4edf0db98f1c74aec
-  data.tar.gz: 72973c1fd525117a395aaf9ac5b3d81d05573346cabb4f1dfc337838918d5be52648e90d9e84aa606cec20bc04337f4f37dbfbe7996907bc017a42623da4bebb
+  metadata.gz: d7e11f1386470600bdb5052784c0edfadd4d4b82f18a866a2275499e9574fd536869c79e15f8c8f5f55cf01b24e19605e0e40d2b21c671717a6c247f3e91b3dc
+  data.tar.gz: ff81e343deba1e7cb2f76b11ec9a4a80e9e170e8ea025bf2958297bb73ecac62f69087a3e2d333fdbfa9372c5c51622508f8d8394647c2a3a9c63515dc8d5c70

data/.travis.yml

@@ -1,3 +1,6 @@
+dist: trusty
+addons:
+  chrome: stable
 language: ruby
 sudo: false
 
@@ -5,19 +8,20 @@ notifications:
   email: false
 
 rvm:
-  - 2.3.4
+  - 2.4.1
 
 matrix:
   include:
     - rvm: 2.3.4
-      env: "RAILS_VERSION=5.0.3"
+      env: "RAILS_VERSION=5.0.5"
 
 before_install:
   - gem update --system
   - gem install bundler
+  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
 
 env:
- - "RAILS_VERSION=5.0.3"
+ - "RAILS_VERSION=5.1.3"
 
 global_env:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/app/assets/javascripts/geoblacklight/geoblacklight.js

@@ -14,7 +14,7 @@
     if (bbox.length === 4) {
       return L.latLngBounds([[bbox[1], bbox[0]], [bbox[3], bbox[2]]]);
     } else {
-      return null;
+      throw "Invalid bounding box string";
     }
   };
 

data/app/assets/javascripts/geoblacklight/modules/metadata.js

@@ -0,0 +1,7 @@
+Blacklight.onLoad(function() {
+  $('#ajax-modal').on('loaded.blacklight.ajax-modal', function() {
+    $(this).find('.pill-metadata').each(function(i, element) {
+      GeoBlacklight.metadataDownloadButton(element);
+    });
+  });
+});

data/app/assets/javascripts/geoblacklight/modules/metadata_download_button.js

@@ -0,0 +1,58 @@
+//= require bootstrap/tab
+
+!(function(global) {
+
+  /** Download button for the metadata Bootstrap Modal dialog */
+  var MetadataDownloadButton = L.Class.extend({
+    options: {
+      target: '#btn-metadata-download'
+    },
+
+    /**
+     * Initialize with the DOM element
+     * @param {Element} el - <button>, <a>, or other jQuery selector
+     * @param {Object} options - Properties for the new instance
+     */
+    initialize: function initialize(el, options) {
+      L.Util.setOptions(this, options);
+      this.$el = $(el);
+      this.$download = $(this.target || this.$el.data('ref-download'));
+      this.setRefUrl();
+      this.configureHandler();
+    },
+
+    /**
+     * Bind Elements to DOM element event listeners using jQuery
+     */
+    configureHandler: function configureHandler() {
+      this.$el.on('click',this.onclick);
+      this.$el.on('click',L.Util.bind(this.setRefUrl, this));
+    },
+
+    /**
+     * Set the hyperlink URL using the metadata URI
+     */
+    setRefUrl: function setRefUrl() {
+      var refUrl = this.$el.data('ref-endpoint');
+      if(refUrl == null || refUrl.length === 0) {
+        this.$download.hide();
+      } else {
+        this.$download.show();
+        this.$download.attr('href', refUrl);
+      }
+    },
+
+    /**
+     *
+     */
+    onclick: function onclick(e) {
+      e.preventDefault();
+      $(this).tab('show');
+    }
+  });
+
+  global.GeoBlacklight.MetadataDownloadButton = MetadataDownloadButton;
+  global.GeoBlacklight.metadataDownloadButton = function metadataDownloadButton(el, options) {
+    return new MetadataDownloadButton(el, options);
+  };
+})(this);

data/app/assets/javascripts/geoblacklight/modules/results.js

@@ -11,29 +11,25 @@ Blacklight.onLoad(function() {
   $('[data-map="index"]').each(function() {
     var data = $(this).data(),
     opts = { baseUrl: data.catalogPath },
+    world = L.latLngBounds([[-90, -180], [90, 180]]),
     geoblacklight, bbox;
 
-    var lngRe = '(-?[0-9]{1,2}(\\.[0-9]+)?)';
-    var latRe = '(-?[0-9]{1,3}(\\.[0-9]+)?)';
-
-    var parseableBbox = new RegExp(
-      [lngRe,latRe,lngRe,latRe].join('\\s+')
-    );
-
     if (typeof data.mapBbox === 'string') {
       bbox = L.bboxToBounds(data.mapBbox);
     } else {
       $('.document [data-bbox]').each(function() {
-        var currentBbox = $(this).data().bbox;
-        if (parseableBbox.test(currentBbox)) {
+
+        try {
+          var currentBounds = L.bboxToBounds($(this).data().bbox);
+          if (!world.contains(currentBounds)) {
+            throw "Invalid bounds";
+          }
           if (typeof bbox === 'undefined') {
-            bbox = L.bboxToBounds(currentBbox);
+            bbox = currentBounds;
           } else {
-            bbox.extend(L.bboxToBounds(currentBbox));
+            bbox.extend(currentBounds);
           }
-        } else {
-          // bbox not parseable, use default value.
-          // [[-180, -90], [180, 90]];
+        } catch (e) {
           bbox = L.bboxToBounds("-180 -90 180 90");
         }
       });
@@ -80,5 +76,4 @@ Blacklight.onLoad(function() {
       }
     });
   }
-
 });

data/app/assets/stylesheets/geoblacklight/_geoblacklight.scss

@@ -11,10 +11,8 @@
  */
 @import 'leaflet';
 @import 'geoblacklight-icons-rails';
-
 @import 'font-awesome';
 @import 'geoblacklight/styles';
-@import 'modules/coderay';
 @import 'modules/facets';
 @import 'modules/mixins';
 @import 'modules/icon-customization';
@@ -22,6 +20,9 @@
 @import 'modules/item';
 @import 'modules/layer_opacity';
 @import 'modules/metadata';
+@import 'modules/metadata_content';
+@import 'modules/metadata_missing';
+@import 'modules/metadata_markup';
 @import 'modules/results';
 @import 'modules/geosearch';
 @import 'modules/search_widgets';

data/app/assets/stylesheets/geoblacklight/modules/metadata.scss

@@ -1,5 +1,29 @@
-.metadata-view {
-  pre {
-    @extend .pre-scrollable;
+/**
+ * Rules for the geospatial metadata Bootstrap Modal dialog
+ */
+.modal-dialog {
+  width: 1148px;
+}
+
+.modal-header {
+  .modal-title {
+    font-weight: 400;
+    font-size: 20px;
+  }
+}
+
+.modal-body {
+  overflow-y: scroll;
+  height: calc(100vh - 190px);
+
+  .metadata-view {
+    .nav-pills {
+      text-align: center;
+
+      li {
+        float: none;
+        display: inline-block;
+      }
+    }
   }
 }

data/app/assets/stylesheets/geoblacklight/modules/metadata_content.scss

@@ -0,0 +1,38 @@
+/*
+ * Rules for the geospatial metadata markup generated by GeoCombine
+ *
+ */
+#metadata-container {
+  height: 1024px;
+
+  ul {
+    margin-top: 0;
+    margin-bottom: 10px;
+    display: inline-block;
+    border: 1px solid black;
+    background-color: #f5f5f5;
+    padding-right: 40px;
+
+    li {
+      margin-top: 6px;
+      margin-bottom: 6px;
+      list-style-type: decimal;
+    }
+  }
+
+  div dl {
+    padding-right: 8px;
+    padding-left: 8px;
+
+    dt {
+      margin-top: 12px;
+    }
+  }
+
+  /*
+  * Highest level heading in the attribute tree
+  */
+  div > dl > dt {
+    font-size: 22px;
+  }
+}

data/app/assets/stylesheets/geoblacklight/modules/metadata_markup.scss

@@ -0,0 +1,9 @@
+/*
+ * Rules for untransformed geospatial metadata markup
+ *
+ */
+#metadata-markup-container {
+  .alert {
+    margin-top: 20px;
+  }
+}

data/app/assets/stylesheets/geoblacklight/modules/metadata_missing.scss

@@ -0,0 +1,7 @@
+/*
+ * Rules for missing geospatial metadata content
+ *
+ */
+#metadata-error-container {
+  text-align: center;
+}

data/app/helpers/geoblacklight_helper.rb

@@ -153,4 +153,28 @@ module GeoblacklightHelper
        .add_previous_sibling(geoblacklight_icon(item.value))
     doc.to_html.html_safe
   end
+
+  ##
+  # Renders the transformed metadata
+  # (Renders a partial when the metadata isn't available)
+  # @param [Geoblacklight::Metadata::Base] metadata the metadata object
+  # @return [String]
+  def render_transformed_metadata(metadata)
+    render partial: 'catalog/metadata/content', locals: { content: metadata.transform.html_safe }
+  rescue Geoblacklight::MetadataTransformer::TransformError => transform_err
+    Geoblacklight.logger.warn transform_err.message
+    render partial: 'catalog/metadata/markup', locals: { content: metadata.to_xml }
+  rescue => err
+    Geoblacklight.logger.warn err.message
+    render partial: 'catalog/metadata/missing'
+  end
+
+  ##
+  # Determines whether or not the metadata is the first within the array of References
+  # @param [SolrDocument] document the Solr Document for the item
+  # @param [Geoblacklight::Metadata::Base] metadata the object for the metadata resource
+  # @return [Boolean]
+  def first_metadata?(document, metadata)
+    document.references.shown_metadata.first.type == metadata.type
+  end
 end

data/app/presenters/geoblacklight/document_presenter.rb

@@ -2,6 +2,7 @@ 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
@@ -16,7 +17,7 @@ module Geoblacklight
           fields_values << val
         end
       end
-      fields_values.join(' ')
+      safe_join(fields_values, ' ')
     end
   end
 end

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

@@ -1,12 +1,27 @@
 <% document ||= @document %>
 
 <div class='metadata-view'>
-  <% document.references.refs.each do |ref| %>
-    <% if Settings.METADATA_SHOWN.include?(ref.type.to_s) %>
-      <div class='label label-default'>
-        <%= formatted_name_reference(ref.type) %>
+  <div class="container-fluid">
+    <ul class="nav nav-pills" role="tablist">
+      <% document.references.shown_metadata.each do |metadata| %>
+        <li role="presentation" class="<%= first_metadata?(document, metadata) ? 'active' : nil %>">
+          <a class="pill-metadata"
+             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>
-      <%= CodeRay.scan(Geoblacklight::Metadata.new(ref).metadata, :xml).div(css: :class, tab_width: 2).html_safe %>
     <% end %>
-  <% end %>
+  </div>
 </div>

data/app/views/catalog/metadata/_content.html.erb

@@ -0,0 +1,3 @@
+<div id="metadata-container" class="container-fluid">
+  <%= content %>
+</div>

data/app/views/catalog/metadata/_markup.html.erb

@@ -0,0 +1,8 @@
+<div id="metadata-markup-container" class="container-fluid">
+  <div class="alert alert-warning" role="alert">
+    <span class="glyphicon glyphicon-exclamation-sign" aria-hidden="true"></span>
+    <span class="sr-only">Error:</span>
+    <span>The metadata for this item cannot be transformed.</span>
+  </div>
+  <%= CodeRay.scan(content, :xml).div.html_safe %>
+</div>

data/app/views/catalog/metadata/_missing.html.erb

@@ -0,0 +1,6 @@
+<div id="metadata-error-container" class="container-fluid">
+  <div>
+    <h1>The metadata for this item doesn't exist.</h1>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</div>

data/app/views/catalog/metadata.js.erb

@@ -1,7 +1,11 @@
 <div class="modal-header">
   <button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
-  <h1 class="modal-title">Metadata</h1>
-  <div class="modal-body">
-    <%= render partial: 'metadata' %>
-  </div>
+  <h3 class="modal-title">View Metadata</h3>
+</div>
+<div class="modal-body">
+  <%= render partial: 'metadata' %>
+</div>
+<div class="modal-footer">
+  <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
+  <a href="#" target="_blank" rel="noopener noreferrer" id="btn-metadata-download" class="btn btn-primary">Download</a>
 </div>

data/config/locales/geoblacklight.en.yml

@@ -1,5 +1,6 @@
 en:
   geoblacklight:
+    bbox_label: 'Bounding Box'
     download:
       download: 'Download'
       success: 'Your file %{title} is ready for download'

data/geoblacklight.gemspec

@@ -25,16 +25,19 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'font-awesome-rails'
   spec.add_dependency 'config'
   spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
   spec.add_dependency 'coderay'
   spec.add_dependency 'geoblacklight-icons', '>= 0.2'
   spec.add_dependency 'deprecation'
+  spec.add_dependency 'geo_combine', '>= 0.3'
 
   spec.add_development_dependency 'solr_wrapper'
   spec.add_development_dependency 'rails-controller-testing'
   spec.add_development_dependency 'rspec-rails', '~> 3.1'
   spec.add_development_dependency 'engine_cart', '~> 1.0'
   spec.add_development_dependency 'capybara', '>= 2.5.0'
-  spec.add_development_dependency 'poltergeist'
+  spec.add_development_dependency 'selenium-webdriver'
+  spec.add_development_dependency 'chromedriver-helper'
   spec.add_development_dependency 'factory_girl_rails'
   spec.add_development_dependency 'database_cleaner', '~> 1.3'
 end

data/lib/generators/geoblacklight/templates/settings.yml

@@ -38,9 +38,9 @@ INSTITUTION: 'Stanford'
 
 # Metadata shown in tool panel
 METADATA_SHOWN:
+  - 'mods'
   - 'fgdc'
   - 'iso19139'
-  - 'mods'
 
 # (For external Download) timeout and open_timeout parameters for Faraday
 TIMEOUT_DOWNLOAD: 16
@@ -68,7 +68,7 @@ WMS_PARAMS:
   :EXCEPTIONS: 'application/json'
   :INFO_FORMAT: 'text/html'
 
-# Settings for leaflet 
+# Settings for leaflet
 OPACITY_CONTROL: &opacity_control
   CONTROLS:
     - 'Opacity'

data/lib/geoblacklight/engine.rb

@@ -1,10 +1,11 @@
 require 'blacklight'
 require 'leaflet-rails'
 require 'font-awesome-rails'
+require 'coderay'
 require 'config'
 require 'faraday'
+require 'faraday_middleware'
 require 'nokogiri'
-require 'coderay'
 require 'geoblacklight-icons'
 
 module Geoblacklight

data/lib/geoblacklight/metadata/base.rb

@@ -0,0 +1,88 @@
+module Geoblacklight
+  module Metadata
+    ##
+    # Abstract Class for metadata
+    class Base
+      attr_reader :reference
+      delegate :type, to: :reference
+      delegate :to_html, to: :metadata
+      delegate :transform, to: :transformer
+      delegate :to_xml, to: :document
+
+      ##
+      # Instantiates a Geoblacklight::Metadata object used for retrieving and
+      # formatting metadata
+      # @param reference [Geoblacklight::Reference] the reference object
+      def initialize(reference)
+        @reference = reference
+      end
+
+      ##
+      # Retrieves the XML Document for the metadata
+      # @return [Nokogiri::XML::Document]
+      def document
+        @document ||= metadata.metadata
+      end
+
+      ##
+      # Determines whether or not a metadata resources is empty
+      # @return [Boolean]
+      def blank?
+        document.nil? || document.children.empty?
+      end
+
+      ##
+      # Retrieves the URI for the reference resource (e. g. a service endpoint)
+      # @return [String, nil]
+      def endpoint
+        blank? ? nil : @reference.endpoint
+      end
+
+      private
+
+      ##
+      # Retrieves metadata from a url source
+      # @return [String, nil] metadata string or nil if there is a
+      # connection error
+      def retrieve_metadata
+        connection = Faraday.new(url: @reference.endpoint) do |conn|
+          conn.use FaradayMiddleware::FollowRedirects
+          conn.adapter Faraday.default_adapter
+        end
+        response = connection.get
+        return response.body unless response.nil? || response.status == 404
+        Geoblacklight.logger.error "Could not reach #{@reference.endpoint}"
+        ''
+      rescue Faraday::Error::ConnectionFailed => error
+        Geoblacklight.logger.error error.inspect
+        ''
+      rescue Faraday::Error::TimeoutError => error
+        Geoblacklight.logger.error error.inspect
+        ''
+      end
+
+      ##
+      # Retrieve the Class for the GeoCombine data model
+      # @return [GeoCombine::Metadata]
+      def metadata_class
+        GeoCombine::Metadata
+      end
+
+      ##
+      # Handles metadata and returns the retrieved metadata or an error message if
+      # something went wrong
+      # @return [String] returned metadata string
+      def metadata
+        response_body = retrieve_metadata
+        metadata_class.new(response_body)
+      end
+
+      ##
+      # Initialize the MetadataTransformer Object for the metadata
+      # @return [GeoBlacklight::MetadataTransformer] MetadataTransformer instance
+      def transformer
+        MetadataTransformer.instance(self)
+      end
+    end
+  end
+end

data/lib/geoblacklight/metadata/fgdc.rb

@@ -0,0 +1,14 @@
+module Geoblacklight
+  module Metadata
+    class Fgdc < Base
+      private
+
+      ##
+      # Retrieve the Class for the GeoCombine data model
+      # @return [GeoCombine::Fgdc]
+      def metadata_class
+        GeoCombine::Fgdc
+      end
+    end
+  end
+end

data/lib/geoblacklight/metadata/iso19139.rb

@@ -0,0 +1,14 @@
+module Geoblacklight
+  module Metadata
+    class Iso19139 < Base
+      private
+
+      ##
+      # Retrieve the Class for the GeoCombine data model
+      # @return [GeoCombine::Iso19139]
+      def metadata_class
+        GeoCombine::Iso19139
+      end
+    end
+  end
+end

data/lib/geoblacklight/metadata.rb

@@ -1,37 +1,18 @@
 module Geoblacklight
-  class Metadata
+  module Metadata
     ##
-    # Instantiates a Geoblacklight::Metadata object used for retrieving and
-    # formatting metadata
-    # @param reference [Geoblacklight::Reference] the reference object
-    def initialize(reference)
-      @reference = reference
-    end
+    # Initialize a new Metadata instance
+    # @param [Geoblacklight::Reference] reference the reference for the metadata resource
+    # @return [Geoblacklight::Metadata::Base]
+    def self.instance(reference)
+      begin
+        klass = "Geoblacklight::Metadata::#{reference.type.capitalize}".constantize
+      rescue
+        Geoblacklight.logger.warn "Metadata type #{reference.type} is not supported"
+        klass = Geoblacklight::Metadata::Base
+      end
 
-    ##
-    # Handles metadata and returns the retrieved metadata or an error message if
-    # something went wrong
-    # @return [String] returned metadata string
-    def metadata
-      response = retrieve_metadata
-      return response.body unless response.nil? || response.status == 404
-      Geoblacklight.logger.error "Could not reach #{@reference.endpoint}"
-      "Could not reach #{@reference.endpoint}"
-    end
-
-    ##
-    # Retrieves metadata from a url source
-    # @return [Faraday::Response, nil] Faraday::Response or nil if there is a
-    # connection error
-    def retrieve_metadata
-      conn = Faraday.new(url: @reference.endpoint)
-      conn.get
-    rescue Faraday::Error::ConnectionFailed => error
-      Geoblacklight.logger.error error.inspect
-      nil
-    rescue Faraday::Error::TimeoutError => error
-      Geoblacklight.logger.error error.inspect
-      nil
+      klass.new(reference)
     end
   end
 end