geoblacklight 3.3.0 → 4.0.0.pre.alpha.1

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

@@ -0,0 +1,195 @@
+#Solr field mappings for GeoBlacklight Metadata Schema version 1.0
+
+# Configurable Logo Used for CartoDB export
+APPLICATION_LOGO_URL: 'http://geoblacklight.org/images/geoblacklight-logo.png'
+
+# Carto OneClick Service https://carto.com/engine/open-in-carto/
+CARTO_ONECLICK_LINK: 'http://oneclick.carto.com/'
+
+# ArcGIS Online Base URL
+ARCGIS_BASE_URL: 'https://www.arcgis.com/home/webmap/viewer.html'
+
+# Download path can be configured using this setting
+#DOWNLOAD_PATH: "./tmp/cache/downloads"
+
+# DEPRECATED Main Solr geometry field used for spatial search and bounding box. Should be type 'rpt'
+GEOMETRY_FIELD: 'solr_geom'
+
+# The bq boost value for spatial search matches within a bounding box
+BBOX_WITHIN_BOOST: '10'
+
+# The bf boost value for overlap ratio
+OVERLAP_RATIO_BOOST: '2'
+
+# Solr field mappings
+FIELDS:
+  :ACCESS_RIGHTS: 'dc_rights_s'
+  #:ALTERNATIVE_TITLE: 'dct_alternative_sm'
+  #:CENTROID: 'dcat_centroid_ss'
+  :CREATOR: 'dc_creator_sm'
+  :DATE_ISSUED: 'dct_issued_s'
+  #:DATE_RANGE: 'gbl_dateRange_drsim'
+  :DESCRIPTION: 'dc_description_sm'
+  :FORMAT: 'dc_format_s'
+  #:FILE_SIZE: 'gbl_fileSize_s'
+  #:GEOREFERENCED: 'gbl_georeferenced_b'
+  :ID: 'layer_slug_s'
+  :IDENTIFIER: 'dc_identifier_s'
+  :INDEX_YEAR: 'solr_year_i'
+  #:IS_PART_OF: 'dct_isPartOf_sm'
+  #:IS_REPLACED_BY: 'dct_isReplacedBy_sm'
+  #:ISO_TOPIC_CATEGORY: 'dcat_theme_sm'
+  #:KEYWORD: 'dcat_keyword_sm'
+  :LANGUAGE: 'dc_language_sm'
+  #:LICENSE: 'dct_license_sm'
+  #:MEMBER_OF: 'pcdm_memberOf_sm'
+  :METADATA_VERSION: 'geoblacklight_version'
+  :MODIFIED: 'layer_modified_dt'
+  :OVERLAP_FIELD: 'solr_bboxtype'
+  :PUBLISHER: 'dc_publisher_s'
+  :PROVIDER: 'dct_provenance_s'
+  :REFERENCES: 'dct_references_s'
+  #:RELATION: 'dct_relation_sm'
+  #:REPLACES: 'dct_replaces_sm'
+  #:RESOURCE_CLASS: 'gbl_resourceClass_sm'
+  :RESOURCE_TYPE: 'layer_geom_type_s'
+  #:RIGHTS: 'dct_rights_sm'
+  #:RIGHTS_HOLDER: 'dct_rightsHolder_sm'
+  :SOURCE: 'dc_source_sm'
+  :SPATIAL_COVERAGE: 'dct_spatial_sm'
+  :SPATIAL_EXTENT: 'solr_geom'
+  :SUBJECT: 'dc_subject_sm'
+  :SUPPRESSED: 'suppressed_b'
+  :TEMPORAL_COVERAGE: 'dct_temporal_sm'
+  :TITLE: 'dc_title_s'
+  #:VERSION: 'dct_isVersionOf_sm'
+  :WXS_IDENTIFIER: 'layer_id_s'
+
+# Institution deployed at
+INSTITUTION: 'Stanford'
+
+# Metadata shown in tool panel
+METADATA_SHOWN:
+  - 'mods'
+  - 'fgdc'
+  - 'iso19139'
+  - 'html'
+
+# (For external Download) timeout and open_timeout parameters for Faraday
+TIMEOUT_DOWNLOAD: 16
+
+# (For WMS inspection) timeout and open_timeout parameters for Faraday
+TIMEOUT_WMS: 4
+
+# Use the geometry type for the data relations icon
+USE_GEOM_FOR_RELATIONS_ICON: false
+
+# Web services shown in tool panel
+WEBSERVICES_SHOWN:
+  - 'wms'
+  - 'tms'
+  - 'wfs'
+  - 'iiif'
+  - 'feature_layer'
+  - 'tiled_map_layer'
+  - 'dynamic_map_layer'
+  - 'image_map_layer'
+
+# Relationships to display
+RELATIONSHIPS_SHOWN:
+# MEMBER_OF:
+#    field: pcdm_memberOf_sm
+#    query_type: ancestors
+#    icon: nil
+#    label: geoblacklight.relations.member_of
+#  PART_OF:
+#    field: dct_isPartOf_sm
+#    query_type: ancestors
+#    icon: nil
+#    label: geoblacklight.relations.part_of
+#  RELATION:
+#    field: dct_relation_sm
+#    query_type: ancestors
+#    icon: nil
+#    label: geoblacklight.relations.relation
+#  REPLACES:
+#    field: dct_replaces_sm
+#    query_type: ancestors
+#    icon: nil
+#    label: geoblacklight.relations.replaces
+#  REPLACED_BY:
+#    field: dct_isReplacedBy_sm
+#    query_type: descendants
+#    icon: nil
+#    label: geoblacklight.relations.replaced_by
+  SOURCE_ANCESTORS:
+    field: dct_source_sm
+    query_type: ancestors
+    icon: pagelines-brands
+    label: geoblacklight.relations.ancestor
+  SOURCE_DESCENDANTS:
+    field: dct_source_sm
+    query_type: descendants
+    icon: leaf
+    label: geoblacklight.relations.descendant
+#  VERSION_OF:
+#    field: dct_isVersionOf_sm
+#    query_type: descendants
+#    icon: nil
+#    label: geoblacklight.relations.version_of
+
+# WMS Parameters
+WMS_PARAMS:
+  :SERVICE: 'WMS'
+  :VERSION: '1.1.1'
+  :REQUEST: 'GetFeatureInfo'
+  :STYLES: ''
+  :SRS: 'EPSG:4326'
+  :EXCEPTIONS: 'application/json'
+  :INFO_FORMAT: 'text/html'
+
+# Settings for leaflet
+OPACITY_CONTROL: &opacity_control
+  CONTROLS:
+    - 'Opacity'
+
+LEAFLET:
+  MAP:
+  LAYERS:
+    DETECT_RETINA: true
+    INDEX:
+      DEFAULT: &default
+        color: "#1eb300"
+        weight: "1"
+        radius: "4"
+      UNAVAILABLE:
+        <<: *default
+        color: "#b3001e"
+      SELECTED:
+        <<: *default
+        color: "#006bde"
+  VIEWERS:
+    WMS:
+      <<: *opacity_control
+    TILEDMAPLAYER:
+      <<: *opacity_control
+    FEATURELAYER:
+      <<: *opacity_control
+    DYNAMICMAPLAYER:
+      <<: *opacity_control
+    IMAGEMAPLAYER:
+      <<: *opacity_control
+
+# Toggle the help text feature that offers users context
+HELP_TEXT:
+  viewer_protocol:
+      - 'dynamic_map_layer'
+      - 'feature_layer'
+      - 'iiif'
+      - 'iiif_manifest'
+      - 'image_map_layer'
+      - 'index_map'
+      - 'tiled_map_layer'
+      - 'wms'
+      - 'tms'
+      - 'oembed'

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

@@ -19,33 +19,55 @@ BBOX_WITHIN_BOOST: '10'
 # The bf boost value for overlap ratio
 OVERLAP_RATIO_BOOST: '2'
 
+# Homepage Map Geometry
+# Leave null to default to entire world
+# Add a stringified GeoJSON object to scope initial render (example from UMass)
+HOMEPAGE_MAP_GEOM: null
+# HOMEPAGE_MAP_GEOM: '{"type":"Polygon","coordinates":[[[-73.58,42.93],[-73.58,41.20],[-69.90,41.20],[-69.90,42.93]]]}'
+
 # Solr field mappings
 FIELDS:
-  :CREATOR: 'dc_creator_sm'
-  :DESCRIPTION: 'dc_description_s'
-  :FILE_FORMAT: 'dc_format_s'
-  :GEOM_TYPE: 'layer_geom_type_s'
-  :GEOMETRY: 'solr_geom'
-  :IDENTIFIER: 'dc_identifier_s'
-  :ISSUED: 'dct_issued_s'
-  :LANGUAGE: 'dc_language_s'
-  :LAYER_MODIFIED: 'layer_modified_dt'
+  :ACCESS_RIGHTS: 'dct_accessRights_s'
+  :ALTERNATIVE_TITLE: 'dct_alternative_sm'
+  :CENTROID: 'dcat_centroid_ss'
+  :CREATOR: 'dct_creator_sm'
+  :DATE_ISSUED: 'dct_issued_s'
+  :DATE_RANGE: 'gbl_dateRange_drsim'
+  :DESCRIPTION: 'dct_description_sm'
+  :FORMAT: 'dct_format_s'
+  :FILE_SIZE: 'gbl_fileSize_s'
+  :GEOREFERENCED: 'gbl_georeferenced_b'
+  :ID: 'id'
+  :IDENTIFIER: 'dct_identifier_sm'
+  :INDEX_YEAR: 'gbl_indexYear_im'
+  :IS_PART_OF: 'dct_isPartOf_sm'
+  :IS_REPLACED_BY: 'dct_isReplacedBy_sm'
+  :ISO_TOPIC_CATEGORY: 'dcat_theme_sm'
+  :KEYWORD: 'dcat_keyword_sm'
+  :LANGUAGE: 'dct_language_sm'
+  :LICENSE: 'dct_license_sm'
+  :MEMBER_OF: 'pcdm_memberOf_sm'
+  :METADATA_VERSION: 'gbl_mdVersion_s'
+  :MODIFIED: 'gbl_mdModified_dt'
   :OVERLAP_FIELD: 'solr_bboxtype'
-  :PART_OF: 'dct_isPartOf_sm'
-  :PUBLISHER: 'dc_publisher_s'
-  :PROVENANCE: 'dct_provenance_s'
+  :PUBLISHER: 'dct_publisher_sm'
+  :PROVIDER: 'schema_provider_s'
   :REFERENCES: 'dct_references_s'
-  :RIGHTS: 'dc_rights_s'
+  :RELATION: 'dct_relation_sm'
+  :REPLACES: 'dct_replaces_sm'
+  :RESOURCE_CLASS: 'gbl_resourceClass_sm'
+  :RESOURCE_TYPE: 'gbl_resourceType_sm'
+  :RIGHTS: 'dct_rights_sm'
+  :RIGHTS_HOLDER: 'dct_rightsHolder_sm'
+  :SOURCE: 'dct_source_sm'
   :SPATIAL_COVERAGE: 'dct_spatial_sm'
-  :SUBJECT: 'dc_subject_sm'
-  :SOURCE: 'dc_source_sm'
-  :SUPPRESSED: 'suppressed_b'
-  :TEMPORAL: 'dct_temporal_sm'
-  :TITLE: 'dc_title_s'
-  :TYPE: 'dc_type_s'
-  :UNIQUE_KEY: 'layer_slug_s'
-  :WXS_IDENTIFIER: 'layer_id_s'
-  :YEAR: 'solr_year_i'
+  :SPATIAL_EXTENT: 'locn_geometry'
+  :SUBJECT: 'dct_subject_sm'
+  :SUPPRESSED: 'gbl_suppressed_b'
+  :TEMPORAL_COVERAGE: 'dct_temporal_sm'
+  :TITLE: 'dct_title_s'
+  :VERSION: 'dct_isVersionOf_sm'
+  :WXS_IDENTIFIER: 'gbl_wxsIdentifier_s'
 
 # Institution deployed at
 INSTITUTION: 'Stanford'
@@ -77,6 +99,49 @@ WEBSERVICES_SHOWN:
   - 'dynamic_map_layer'
   - 'image_map_layer'
 
+# Relationships to display
+RELATIONSHIPS_SHOWN:
+  MEMBER_OF:
+    field: pcdm_memberOf_sm
+    query_type: ancestors
+    icon: nil
+    label: geoblacklight.relations.member_of
+  PART_OF:
+    field: dct_isPartOf_sm
+    query_type: ancestors
+    icon: nil
+    label: geoblacklight.relations.part_of
+  RELATION:
+    field: dct_relation_sm
+    query_type: ancestors
+    icon: nil
+    label: geoblacklight.relations.relation
+  REPLACES:
+    field: dct_replaces_sm
+    query_type: ancestors
+    icon: nil
+    label: geoblacklight.relations.replaces
+  REPLACED_BY:
+    field: dct_isReplacedBy_sm
+    query_type: descendants
+    icon: nil
+    label: geoblacklight.relations.replaced_by
+  SOURCE_ANCESTORS:
+    field: dct_source_sm
+    query_type: ancestors
+    icon: pagelines-brands
+    label: geoblacklight.relations.ancestor
+  SOURCE_DESCENDANTS:
+    field: dct_source_sm
+    query_type: descendants
+    icon: leaf
+    label: geoblacklight.relations.descendant
+  VERSION_OF:
+    field: dct_isVersionOf_sm
+    query_type: descendants
+    icon: nil
+    label: geoblacklight.relations.version_of
+
 # WMS Parameters
 WMS_PARAMS:
   :SERVICE: 'WMS'

data/lib/geoblacklight/download/geojson_download.rb

@@ -10,7 +10,7 @@ module Geoblacklight
     }.freeze
 
     def initialize(document, options = {})
-      request_params = GEOJSON_DOWNLOAD_PARAMS.merge(typeName: document[:layer_id_s])
+      request_params = GEOJSON_DOWNLOAD_PARAMS.merge(typeName: document[Settings.FIELDS.WXS_IDENTIFIER])
       super(document, {
         type: 'geojson',
         extension: 'json',

data/lib/geoblacklight/download/geotiff_download.rb

@@ -7,7 +7,7 @@ module Geoblacklight
     }.freeze
 
     def initialize(document, options = {})
-      request_params = GEOTIFF_DOWNLOAD_PARAMS.merge(layers: document[:layer_id_s])
+      request_params = GEOTIFF_DOWNLOAD_PARAMS.merge(layers: document[Settings.FIELDS.WXS_IDENTIFIER])
       super(document, {
         type: 'geotiff',
         extension: 'tif',

data/lib/geoblacklight/download/hgl_download.rb

@@ -3,7 +3,7 @@ module Geoblacklight
   class HglDownload < Geoblacklight::Download
     def initialize(document, email, options = {})
       request_params = {
-        'LayerName' => document[:layer_id_s].sub(/^cite:/, ''),
+        'LayerName' => document[Settings.FIELDS.WXS_IDENTIFIER].sub(/^cite:/, ''),
         'UserEmail' => email
       }
       super(document, {

data/lib/geoblacklight/download/kmz_download.rb

@@ -10,7 +10,7 @@ module Geoblacklight
 
     def initialize(document, options = {})
       bbox_wsen = document.geometry.bounding_box
-      request_params = KMZ_DOWNLOAD_PARAMS.merge(layers: document[:layer_id_s], bbox: bbox_wsen)
+      request_params = KMZ_DOWNLOAD_PARAMS.merge(layers: document[Settings.FIELDS.WXS_IDENTIFIER], bbox: bbox_wsen)
       super(document, {
         type: 'kmz',
         extension: 'kmz',

data/lib/geoblacklight/download/shapefile_download.rb

@@ -8,7 +8,7 @@ module Geoblacklight
                                   outputformat: 'SHAPE-ZIP' }.freeze
 
     def initialize(document, options = {})
-      request_params = SHAPEFILE_DOWNLOAD_PARAMS.merge(typeName: document[:layer_id_s])
+      request_params = SHAPEFILE_DOWNLOAD_PARAMS.merge(typeName: document[Settings.FIELDS.WXS_IDENTIFIER])
       super(document, {
         type: 'shapefile',
         extension: 'zip',

data/lib/geoblacklight/engine.rb

@@ -11,8 +11,6 @@ require 'handlebars_assets'
 
 module Geoblacklight
   class Engine < ::Rails::Engine
-    Blacklight::Configuration.default_values[:view].split.partials = ['index']
-    Blacklight::Configuration.default_values[:view].delete_field('list')
     # GeoblacklightHelper is needed by all helpers, so we inject it
     # into action view base here.
     initializer 'geoblacklight.helpers' do

data/lib/geoblacklight/geometry.rb

@@ -17,8 +17,9 @@ module Geoblacklight
     def geojson
       obj = factory.parse_wkt(geometry_as_wkt)
       RGeo::GeoJSON.encode(obj).to_json
-    rescue RGeo::Error::ParseError
-      ''
+    rescue StandardError
+      Geoblacklight.logger.warn "Geometry is not valid: #{geom}"
+      default_extent
     end
 
     # Generate a wsen bounding box from the geometry
@@ -36,11 +37,25 @@ module Geoblacklight
       maxy = bbox.coordinates[0][2][1]
       "#{minx}, #{miny}, #{maxx}, #{maxy}"
     rescue RGeo::Error::ParseError
-      ''
+      Geoblacklight.logger.warn "Error parsing geometry: #{geom}"
+      default_extent
     end
 
     private
 
+    # Default extent as GeoJSON
+    # @return [String]
+    def default_extent
+      {
+        'type' => 'Polygon',
+        'coordinates' => [
+          [
+            [-180.0, 90.0], [-180.0, -90.0], [180.0, -90.0], [180.0, 90.0], [-180.0, 90.0]
+          ]
+        ]
+      }.to_json
+    end
+
     # Convert WKT ENVELOPE string to WKT POLYGON string
     # @return [String]
     def envelope_to_polygon

data/lib/geoblacklight/references.rb

@@ -30,7 +30,7 @@ module Geoblacklight
     # Accessor for a document's file format
     # @return [String] file format for the document
     def format
-      @document[Settings.FIELDS.FILE_FORMAT]
+      @document[Settings.FIELDS.FORMAT]
     end
 
     ##

data/lib/geoblacklight/relation/ancestors.rb

@@ -2,14 +2,15 @@
 module Geoblacklight
   module Relation
     class Ancestors
-      def initialize(id, repository)
+      def initialize(id, field, repository)
         @search_id = id
+        @field = field
         @repository = repository
       end
 
       def create_search_params
-        { fq: ["{!join from=#{Settings.FIELDS.SOURCE} to=#{Settings.FIELDS.UNIQUE_KEY}}#{Settings.FIELDS.UNIQUE_KEY}:#{@search_id}"],
-          fl: [Settings.FIELDS.TITLE, Settings.FIELDS.UNIQUE_KEY, Settings.FIELDS.GEOM_TYPE] }
+        { fq: ["{!join from=#{@field} to=#{Settings.FIELDS.ID}}#{Settings.FIELDS.ID}:#{@search_id}"],
+          fl: [Settings.FIELDS.TITLE, Settings.FIELDS.ID, Settings.FIELDS.RESOURCE_TYPE] }
       end
 
       def execute_query

data/lib/geoblacklight/relation/descendants.rb

@@ -2,14 +2,15 @@
 module Geoblacklight
   module Relation
     class Descendants
-      def initialize(id, repository)
+      def initialize(id, field, repository)
         @search_id = id
+        @field = field
         @repository = repository
       end
 
       def create_search_params
-        { fq: "#{Settings.FIELDS.SOURCE}:#{@search_id}",
-          fl: [Settings.FIELDS.TITLE, Settings.FIELDS.UNIQUE_KEY, Settings.FIELDS.GEOM_TYPE] }
+        { fq: "#{@field}:#{@search_id}",
+          fl: [Settings.FIELDS.TITLE, Settings.FIELDS.ID, Settings.FIELDS.RESOURCE_TYPE] }
       end
 
       def execute_query

data/lib/geoblacklight/relation/relation_response.rb

@@ -9,16 +9,31 @@ module Geoblacklight
         @repository = repository
       end
 
-      def ancestors
-        @ancestors ||= Geoblacklight::Relation::Ancestors.new(@search_id, @repository).results
+      def method_missing(method, *args, &block)
+        if Settings.RELATIONSHIPS_SHOWN.key?(method)
+          field = Settings.RELATIONSHIPS_SHOWN[method].field
+          query_type = query_type(Settings.RELATIONSHIPS_SHOWN[method])
+          @results = query_type.new(@search_id, field, @repository).results
+        else
+          super
+        end
       end
 
-      def descendants
-        @descendants ||= Geoblacklight::Relation::Descendants.new(@search_id, @repository).results
+      def respond_to_missing?(method_name, *args)
+        Settings.RELATIONSHIPS_SHOWN.key?(method_name) or super
       end
 
-      def empty?
-        !(ancestors['numFound'].positive? || descendants['numFound'].positive?)
+      private
+
+      def query_type(option)
+        case option.query_type
+        when 'ancestors'
+          Geoblacklight::Relation::Ancestors
+        when 'descendants'
+          Geoblacklight::Relation::Descendants
+        else
+          fail ArgumentError, "Bad RelationResponse query_type: #{option.query_type}. Only 'ancestors' or 'descendants' is allowed."
+        end
       end
     end
   end

data/lib/geoblacklight/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Geoblacklight
-  VERSION = '3.3.0'
+  VERSION = '4.0.0-alpha.1'
 end

data/lib/geoblacklight/view_helper_override.rb

@@ -27,7 +27,7 @@ module Geoblacklight
 
     def render_constraints_filters(localized_params = params)
       content = super(localized_params)
-      localized_params = localized_params.to_unsafe_h if localized_params.respond_to?(:to_unsafe_h)
+      localized_params = localized_params.to_h if localized_params.respond_to?(:to_h)
 
       if localized_params[:bbox]
         path = search_action_path(remove_spatial_filter_group(:bbox, localized_params))

data/lib/geoblacklight.rb

@@ -7,7 +7,6 @@ module Geoblacklight
   require 'geoblacklight/catalog_helper_override'
   require 'geoblacklight/constants'
   require 'geoblacklight/exceptions'
-  require 'geoblacklight/geoblacklight_helper_behavior'
   require 'geoblacklight/geometry'
   require 'geoblacklight/view_helper_override'
   require 'geoblacklight/item_viewer'

data/schema/{geoblacklight-schema.json → geoblacklight-schema-1.0.json}

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "Schema for GeoBlacklight. See https://github.com/geoblacklight/geoblacklight/wiki/Schema for more details.",
   "id": "http://geoblacklight.org/v1.0/schema",
-  "title": "GeoBlacklight Schema",
+  "title": "GeoBlacklight Schema - v1.0",
   "definitions": {
     "layer": {
       "title": "layer",