geoblacklight 5.3.0 → 6.0.0.pre.alpha.2

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

@@ -1,23 +1,25 @@
 # ArcGIS Online Base URL
-ARCGIS_BASE_URL: 'https://www.arcgis.com/apps/mapviewer/index.html'
+arcgis_base_url: "https://www.arcgis.com/apps/mapviewer/index.html"
 
 # Download path can be configured using this setting
-#DOWNLOAD_PATH: "./tmp/cache/downloads"
+#download_path: "./tmp/cache/downloads"
 
 # The bq boost value for spatial search matches within a bounding box
-BBOX_WITHIN_BOOST: '10'
+bbox_within_boost: "10"
 
 # The bf boost value for overlap ratio
-OVERLAP_RATIO_BOOST: '2'
+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]]]}'
+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]]]}'
 
-# Non-search-field GeoBlacklight application permitted params
-GBL_PARAMS:
+# Non-search-field GeoBlacklight application permitted params.
+# Values are left mixed-case on purpose: the uppercase symbols are WMS/OGC
+# request parameter names (BBOX, WIDTH, etc.) and must match what clients send.
+gbl_params:
   - :bbox
   - :email
   - :file
@@ -36,88 +38,84 @@ GBL_PARAMS:
   - :Y
 
 # Solr field mappings
-FIELDS:
-  :ACCESS_RIGHTS: 'dct_accessRights_s'
-  :ALTERNATIVE_TITLE: 'dct_alternative_sm'
-  :CENTROID: 'dcat_centroid'
-  :CREATOR: 'dct_creator_sm'
-  :DATE_ISSUED: 'dct_issued_s'
-  :DATE_RANGE: 'gbl_dateRange_drsim'
-  :DESCRIPTION: 'dct_description_sm'
-  :DISPLAY_NOTE: 'gbl_displayNote_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'
-  :THEME: 'dcat_theme_sm'
-  :KEYWORD: 'dcat_keyword_sm'
-  :LANGUAGE: 'dct_language_sm'
-  :LAYER_MODIFIED: 'gbl_mdModified_dt'
-  :LICENSE: 'dct_license_sm'
-  :MEMBER_OF: 'pcdm_memberOf_sm'
-  :METADATA_VERSION: 'gbl_mdVersion_s'
-  :MODIFIED: 'gbl_mdModified_dt'
-  :OVERLAP_FIELD: 'solr_bboxtype'
-  :PUBLISHER: 'dct_publisher_sm'
-  :PROVIDER: 'schema_provider_s'
-  :REFERENCES: 'dct_references_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'
-  :GEOMETRY: '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'
+fields:
+  access_rights: "dct_accessRights_s"
+  alternative_title: "dct_alternative_sm"
+  centroid: "dcat_centroid"
+  creator: "dct_creator_sm"
+  date_issued: "dct_issued_s"
+  date_range: "gbl_dateRange_drsim"
+  description: "dct_description_sm"
+  display_note: "gbl_displayNote_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"
+  theme: "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"
+  publisher: "dct_publisher_sm"
+  provider: "schema_provider_s"
+  references: "dct_references_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"
+  geometry: "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'
+institution: "Stanford"
 
 # Metadata shown in tool panel
-METADATA_SHOWN:
-  - 'mods'
-  - 'fgdc'
-  - 'iso19139'
-  - 'html'
+metadata_shown:
+  - "mods"
+  - "fgdc"
+  - "iso19139"
+  - "html"
 
 # (For external Download) timeout and open_timeout parameters for Faraday
-TIMEOUT_DOWNLOAD: 180
+timeout_download: 180
 
 # (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
+timeout_wms: 4
 
 # Web services shown in tool panel
-WEBSERVICES_SHOWN:
-  - 'wms'
-  - 'tms'
-  - 'wfs'
-  - 'xyz'
-  - 'wmts'
-  - 'tilejson'
-  - 'iiif'
-  - 'feature_layer'
-  - 'tiled_map_layer'
-  - 'dynamic_map_layer'
-  - 'image_map_layer'
-  - 'cog'
-  - 'pmtiles'
+webservices_shown:
+  - "wms"
+  - "tms"
+  - "wfs"
+  - "xyz"
+  - "wmts"
+  - "tilejson"
+  - "iiif"
+  - "feature_layer"
+  - "tiled_map_layer"
+  - "dynamic_map_layer"
+  - "image_map_layer"
+  - "cog"
+  - "pmtiles"
 
 # Display Notes to display / Non-prefixed default bootstrap class is alert-secondary
-DISPLAY_NOTES_SHOWN:
+display_notes_shown:
   danger:
     bootstrap_alert_class: alert-danger
     icon: fire-solid
@@ -136,121 +134,125 @@ DISPLAY_NOTES_SHOWN:
     note_prefix: "Warning: "
 
 # Relationships to display
-RELATIONSHIPS_SHOWN:
-  MEMBER_OF_ANCESTORS:
+relationships_shown:
+  member_of_ancestors:
     field: pcdm_memberOf_sm
     icon: parent-item
-    inverse: :MEMBER_OF_DESCENDANTS
+    inverse: :member_of_descendants
     label: geoblacklight.relations.member_of_ancestors
     query_type: ancestors
-  MEMBER_OF_DESCENDANTS:
+  member_of_descendants:
     field: pcdm_memberOf_sm
     icon: child-item
-    inverse: :MEMBER_OF_ANCESTORS
+    inverse: :member_of_ancestors
     label: geoblacklight.relations.member_of_descendants
     query_type: descendants
-  PART_OF_ANCESTORS:
+  part_of_ancestors:
     field: dct_isPartOf_sm
     icon: parent-item
-    inverse: :PART_OF_DESCENDANTS
+    inverse: :part_of_descendants
     label: geoblacklight.relations.part_of_ancestors
     query_type: ancestors
-  PART_OF_DESCENDANTS:
+  part_of_descendants:
     field: dct_isPartOf_sm
     icon: child-item
-    inverse: :PART_OF_ANCESTORS
+    inverse: :part_of_ancestors
     label: geoblacklight.relations.part_of_descendants
     query_type: descendants
-  RELATION_ANCESTORS:
+  relation_ancestors:
     field: dct_relation_sm
     icon: nil
-    inverse: :RELATION_DESCENDANTS
+    inverse: :relation_descendants
     label: geoblacklight.relations.relation_ancestors
     query_type: ancestors
-  RELATION_DESCENDANTS:
+  relation_descendants:
     field: dct_relation_sm
     icon: nil
-    inverse: :RELATION_ANCESTORS
+    inverse: :relation_ancestors
     label: geoblacklight.relations.relation_descendants
     query_type: descendants
-  REPLACES_ANCESTORS:
+  replaces_ancestors:
     field: dct_replaces_sm
     icon: nil
-    inverse: :REPLACES_DESCENDANTS
+    inverse: :replaces_descendants
     label: geoblacklight.relations.replaces_ancestors
     query_type: ancestors
-  REPLACES_DESCENDANTS:
+  replaces_descendants:
     field: dct_replaces_sm
     icon: nil
-    inverse: :REPLACES_ANCESTORS
+    inverse: :replaces_ancestors
     label: geoblacklight.relations.replaces_descendants
     query_type: descendants
-  SOURCE_ANCESTORS:
+  source_ancestors:
     field: dct_source_sm
     icon: parent-item
-    inverse: :SOURCE_DESCENDANTS
+    inverse: :source_descendants
     label: geoblacklight.relations.source_ancestors
     query_type: ancestors
-  SOURCE_DESCENDANTS:
+  source_descendants:
     field: dct_source_sm
     icon: child-item
-    inverse: :SOURCE_ANCESTORS
+    inverse: :source_ancestors
     label: geoblacklight.relations.source_descendants
     query_type: descendants
-  VERSION_OF_ANCESTORS:
+  version_of_ancestors:
     field: dct_isVersionOf_sm
     icon: parent-item
-    inverse: :VERSION_OF_DESCENDANTS
+    inverse: :version_of_descendants
     label: geoblacklight.relations.version_of_ancestors
     query_type: ancestors
-  VERSION_OF_DESCENDANTS:
+  version_of_descendants:
     field: dct_isVersionOf_sm
     icon: child-item
-    inverse: :VERSION_OF_ANCESTORS
+    inverse: :version_of_ancestors
     label: geoblacklight.relations.version_of_descendants
     query_type: descendants
 
 # Vector data download formats to be displayed
-DOWNLOAD_FORMATS:
-  VECTOR:
-    - 'Shapefile'
-    - 'KMZ'
-    - 'GeoJSON'
-    - 'CSV'
+download_formats:
+  vector:
+    - "Shapefile"
+    - "KMZ"
+    - "GeoJSON"
+    - "CSV"
 
-# WMS Parameters
-WMS_PARAMS:
-  :SERVICE: 'WMS'
-  :VERSION: '1.1.1'
-  :REQUEST: 'GetFeatureInfo'
-  :STYLES: ''
-  :SRS: 'EPSG:4326'
-  :EXCEPTIONS: 'application/json'
-  :INFO_FORMAT: 'application/json'
+# WMS Parameters. Keys are OGC WMS request parameter names and are sent to
+# remote WMS servers, so they are intentionally left uppercase.
+wms_params:
+  SERVICE: "WMS"
+  VERSION: "1.1.1"
+  REQUEST: "GetFeatureInfo"
+  STYLES: ""
+  SRS: "EPSG:4326"
+  EXCEPTIONS: "application/json"
+  INFO_FORMAT: "application/json"
 
 # Settings for leaflet
-LEAFLET:
-  MAP:
-  BOUNDSOVERLAY:
+leaflet:
+  # Keys below are consumed by the JS viewer via the page value
+  # ("INDEX" / "SHOW" / "STATIC_MAP"), so they are intentionally left uppercase.
+  boundsoverlay:
     INDEX:
-      color: '#3388ff'
+      color: "#3388ff"
     SHOW:
-      color: '#3388ff'
+      color: "#3388ff"
     STATIC_MAP:
-      color: '#3388ff'
-  SELECTED_COLOR: "#2C7FB8"
-  SLEEP:
-    SLEEP: true # set to false to disable
-    MARGIN_DISTANCE: 100 # set to zero / false if you want to disable this check
-    SLEEPTIME: 750
-    WAKETIME: 750
-    HOVERTOWAKE: false
-    MESSAGE: 'Click to Wake'
-    BACKGROUND: 'rgba(214, 214, 214, .7)'
-  SIDEBAR: false # set to true to display attribute table as sidebar on map
-  LAYERS:
-    DETECT_RETINA: true
-    INDEX:
+      color: "#3388ff"
+  selected_color: "#2C7FB8"
+  sleep:
+    sleep: true # set to false to disable
+    margin_distance: 100 # set to zero / false if you want to disable this check
+    sleeptime: 750
+    waketime: 750
+    hovertowake: false
+    message: "Click to Wake"
+    background: "rgba(214, 214, 214, .7)"
+  sidebar: false # set to true to display attribute table as sidebar on map
+  layers:
+    detect_retina: true
+    index:
+      # DEFAULT / UNAVAILABLE / SELECTED are consumed by the JS viewer and the
+      # index-map legend, so they are intentionally left uppercase.
       DEFAULT: &default
         color: "#7FCDBB"
         weight: 1
@@ -266,41 +268,27 @@ LEAFLET:
         sr_color_name: "Blue"
 
 # Toggle the help text feature that offers users context
-HELP_TEXT:
+help_text:
   viewer_protocol:
-      - 'cog'
-      - 'dynamic_map_layer'
-      - 'feature_layer'
-      - 'iiif'
-      - 'iiif_manifest'
-      - 'image_map_layer'
-      - 'index_map'
-      - 'oembed'
-      - 'pmtiles'
-      - 'tiled_map_layer'
-      - 'tilejson'
-      - 'tms'
-      - 'wms'
-      - 'wmts'
-      - 'xyz'
+    - "cog"
+    - "dynamic_map_layer"
+    - "feature_layer"
+    - "iiif"
+    - "iiif_manifest"
+    - "image_map_layer"
+    - "index_map"
+    - "oembed"
+    - "pmtiles"
+    - "tiled_map_layer"
+    - "tilejson"
+    - "tms"
+    - "wms"
+    - "wmts"
+    - "xyz"
 
 # Enable catalog#show sidebar static map for items with the following viewer protocols
-SIDEBAR_STATIC_MAP:
-  - 'iiif'
-  - 'iiif_manifest'
-
-IIIF_DRAG_DROP_LINK: '@manifest?manifest=@manifest'
+sidebar_static_map:
+  - "iiif"
+  - "iiif_manifest"
 
-ICON_MAPPING:
-  chicago: university-of-chicago
-  illinois: university-of-illinois-urbana-champaign
-  iowa: university-of-iowa
-  maryland: university-of-maryland
-  michigan-state: michigan-state-university
-  michigan: university-of-michigan
-  minnesota: university-of-minnesota
-  nebraska: university-of-nebraska-lincoln
-  ohio-state: the-ohio-state-university
-  penn-state: pennsylvania-state-university
-  purdue: purdue-university
-  wisconsin: university-of-wisconsin-madison
+iiif_drag_drop_link: "@manifest?manifest=@manifest"

data/lib/geoblacklight/configuration/case_insensitive_settings.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class Configuration
+    # Wraps the global +Settings+ object so that its keys can be resolved
+    # case-insensitively. When a key exists in both lower- and uppercase forms
+    # the lowercase value wins. Nested hash values are wrapped recursively, so
+    # chained access (e.g. +settings.fields.access_rights+) resolves regardless
+    # of the case used in settings.yml. Missing keys return +nil+, mirroring the
+    # behavior of the underlying Config::Options object.
+    #
+    # When a +deprecation+ (e.g. an ActiveSupport::Deprecation) is provided, a
+    # deprecation warning is issued whenever an uppercase key has to be used
+    # because no lowercase equivalent is present.
+    class CaseInsensitiveSettings
+      def initialize(settings, deprecation: nil)
+        @hash = settings.to_h
+        @deprecation = deprecation
+      end
+
+      def [](key)
+        resolve(key)
+      end
+
+      def to_h
+        @hash
+      end
+
+      def method_missing(name, *) # rubocop:disable Style/MissingRespondToMissing, Style/MethodMissingSuper
+        resolve(name)
+      end
+
+      private
+
+      def resolve(name)
+        target = name.to_s.downcase
+        keys = @hash.keys.select { |key| key.to_s.downcase == target }
+        return nil if keys.empty?
+
+        key = keys.find { |candidate| candidate.to_s == candidate.to_s.downcase }
+        if key.nil?
+          key = keys.first
+          warn_deprecated(key)
+        end
+        value = @hash[key]
+        value.is_a?(Hash) ? self.class.new(value, deprecation: @deprecation) : value
+      end
+
+      def warn_deprecated(key)
+        return unless @deprecation
+
+        @deprecation.warn(
+          "GeoBlacklight settings.yml key #{key} is uppercase; rename it to #{key.to_s.downcase}. " \
+          "Uppercase keys are deprecated and support will be removed in a future version."
+        )
+      end
+    end
+  end
+end

data/lib/geoblacklight/configuration/default_settings_builder.rb

@@ -0,0 +1,18 @@
+module Geoblacklight
+  class Configuration
+    # Builds a configuration from default settings
+    class DefaultSettingsBuilder
+      def self.build
+        new.build
+      end
+
+      def initialize
+        @configuration = Configuration.new
+      end
+
+      def build
+        @configuration
+      end
+    end
+  end
+end

data/lib/geoblacklight/configuration/display_note_shown_config.rb

@@ -0,0 +1,13 @@
+module Geoblacklight
+  class Configuration
+    # Configuration for display note shown.
+    class DisplayNoteShownConfig
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+
+      attribute :bootstrap_alert_class, :string
+      attribute :icon, :string
+      attribute :note_prefix, :string
+    end
+  end
+end

data/lib/geoblacklight/configuration/fields_config.rb

@@ -0,0 +1,51 @@
+module Geoblacklight
+  class Configuration
+    # Configuration for fields used in GeoBlacklight search results and metadata display.
+    class FieldsConfig
+      include ActiveModel::Attributes
+
+      attribute :access_rights, :string, default: "dct_accessRights_s"
+      attribute :alternative_title, :string, default: "dct_alternative_sm"
+      attribute :centroid, :string, default: "dcat_centroid"
+      attribute :creator, :string, default: "dct_creator_sm"
+      attribute :date_issued, :string, default: "dct_issued_s"
+      attribute :date_range, :string, default: "gbl_dateRange_drsim"
+      attribute :description, :string, default: "dct_description_sm"
+      attribute :display_note, :string, default: "gbl_displayNote_sm"
+      attribute :format, :string, default: "dct_format_s"
+      attribute :file_size, :string, default: "gbl_fileSize_s"
+      attribute :georeferenced, :string, default: "gbl_georeferenced_b"
+      attribute :id, :string, default: "id"
+      attribute :identifier, :string, default: "dct_identifier_sm"
+      attribute :index_year, :string, default: "gbl_indexYear_im"
+      attribute :is_part_of, :string, default: "dct_isPartOf_sm"
+      attribute :is_replaced_by, :string, default: "dct_isReplacedBy_sm"
+      attribute :theme, :string, default: "dcat_theme_sm"
+      attribute :keyword, :string, default: "dcat_keyword_sm"
+      attribute :language, :string, default: "dct_language_sm"
+      attribute :license, :string, default: "dct_license_sm"
+      attribute :member_of, :string, default: "pcdm_memberOf_sm"
+      attribute :metadata_version, :string, default: "gbl_mdVersion_s"
+      attribute :modified, :string, default: "gbl_mdModified_dt"
+      attribute :overlap_field, :string, default: "solr_bboxtype"
+      attribute :publisher, :string, default: "dct_publisher_sm"
+      attribute :provider, :string, default: "schema_provider_s"
+      attribute :references, :string, default: "dct_references_s"
+      attribute :relation, :string, default: "dct_relation_sm"
+      attribute :replaces, :string, default: "dct_replaces_sm"
+      attribute :resource_class, :string, default: "gbl_resourceClass_sm"
+      attribute :resource_type, :string, default: "gbl_resourceType_sm"
+      attribute :rights, :string, default: "dct_rights_sm"
+      attribute :rights_holder, :string, default: "dct_rightsHolder_sm"
+      attribute :source, :string, default: "dct_source_sm"
+      attribute :spatial_coverage, :string, default: "dct_spatial_sm"
+      attribute :geometry, :string, default: "locn_geometry"
+      attribute :subject, :string, default: "dct_subject_sm"
+      attribute :suppressed, :string, default: "gbl_suppressed_b"
+      attribute :temporal_coverage, :string, default: "dct_temporal_sm"
+      attribute :title, :string, default: "dct_title_s"
+      attribute :version, :string, default: "dct_isVersionOf_sm"
+      attribute :wxs_identifier, :string, default: "gbl_wxsIdentifier_s"
+    end
+  end
+end

data/lib/geoblacklight/configuration/layer_config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Geoblacklight
+  class Configuration
+    # Configuration for Leaflet map layer styles.
+    class LayerConfig
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+
+      attribute :color, :string
+      attribute :weight, :integer, default: 1
+      attribute :radius, :integer, default: 4
+      attribute :sr_color_name, :string
+
+      # Supports Hash-like access for backward compatibility
+      # @param [Symbol, String] key
+      def [](key)
+        respond_to?(key) ? send(key) : nil
+      end
+
+      # Returns the attributes as a symbolized hash
+      # @return [Hash]
+      def to_h
+        attributes.symbolize_keys
+      end
+    end
+  end
+end