geoblacklight 5.3.0 → 6.0.0.pre.alpha.2

data/lib/generators/geoblacklight/templates/catalog_controller.rb

@@ -7,6 +7,9 @@ class CatalogController < ApplicationController
     # Please see https://github.com/projectblacklight/blacklight/pull/2006/
     config.raw_endpoint.enabled = true
 
+    gbl_config = Geoblacklight.configuration
+    field_config = gbl_config.fields
+
     ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
     ## @see https://lucene.apache.org/solr/guide/6_6/common-query-parameters.html
     ## @see https://lucene.apache.org/solr/guide/6_6/the-dismax-query-parser.html#TheDisMaxQueryParser-Theq.altParameter
@@ -24,7 +27,7 @@ class CatalogController < ApplicationController
     #
     config.default_document_solr_params = {
       qt: "document",
-      q: "{!raw f=#{Settings.FIELDS.ID} v=$id}"
+      q: "{!raw f=#{field_config.id} v=$id}"
     }
 
     # GeoBlacklight Defaults
@@ -36,7 +39,7 @@ class CatalogController < ApplicationController
     # config.index.show_link = 'title_display'
     # config.index.record_display_type = 'format'
     config.index.document_component = Geoblacklight::SearchResultComponent
-    config.index.title_field = Settings.FIELDS.TITLE
+    config.index.title_field = field_config.title
 
     # solr field configuration for document/show views
     # This sets the metadata to display below the map viewer.
@@ -84,19 +87,18 @@ class CatalogController < ApplicationController
     # FACETS
 
     # DEFAULT FACETS
-    # to add additional facets, use the keys defined in the settings.yml file
-    config.add_facet_field Settings.FIELDS.INDEX_YEAR, label: "Year", limit: 10
-    config.add_facet_field Settings.FIELDS.SPATIAL_COVERAGE, label: "Place", limit: 8
-    config.add_facet_field Settings.FIELDS.ACCESS_RIGHTS, label: "Access", limit: 8, item_component: Geoblacklight::IconFacetItemComponent
-    config.add_facet_field Settings.FIELDS.RESOURCE_CLASS, label: "Resource Class", limit: 8
-    config.add_facet_field Settings.FIELDS.RESOURCE_TYPE, label: "Resource Type", limit: 8
-    config.add_facet_field Settings.FIELDS.FORMAT, label: "Format", limit: 8
-    config.add_facet_field Settings.FIELDS.SUBJECT, label: "Subject", limit: 8
-    config.add_facet_field Settings.FIELDS.THEME, label: "Theme", limit: 8
-    config.add_facet_field Settings.FIELDS.CREATOR, label: "Creator", limit: 8
-    config.add_facet_field Settings.FIELDS.PUBLISHER, label: "Publisher", limit: 8
-    config.add_facet_field Settings.FIELDS.PROVIDER, label: "Provider", limit: 8, item_component: Geoblacklight::IconFacetItemComponent
-    config.add_facet_field Settings.FIELDS.GEOREFERENCED, label: "Georeferenced", limit: 3
+    config.add_facet_field field_config.index_year, label: "Year", limit: 10
+    config.add_facet_field field_config.spatial_coverage, label: "Place", limit: 8
+    config.add_facet_field field_config.access_rights, label: "Access", limit: 8
+    config.add_facet_field field_config.resource_class, label: "Resource Class", limit: 8
+    config.add_facet_field field_config.resource_type, label: "Resource Type", limit: 8
+    config.add_facet_field field_config.format, label: "Format", limit: 8
+    config.add_facet_field field_config.subject, label: "Subject", limit: 8
+    config.add_facet_field field_config.theme, label: "Theme", limit: 8
+    config.add_facet_field field_config.creator, label: "Creator", limit: 8
+    config.add_facet_field field_config.publisher, label: "Publisher", limit: 8
+    config.add_facet_field field_config.provider, label: "Provider", limit: 8
+    config.add_facet_field field_config.georeferenced, label: "Georeferenced", limit: 3
 
     # GEOBLACKLIGHT APPLICATION FACETS
 
@@ -105,19 +107,25 @@ class CatalogController < ApplicationController
     # filter_query_builder - Defines the query generated for Solr
     # filter_class         - Defines how to add/remove facet from query
     # label                - Defines the label used in contstraints container
-    config.add_facet_field Settings.FIELDS.GEOMETRY, item_presenter: Geoblacklight::BboxItemPresenter, filter_class: Geoblacklight::BboxFilterField, filter_query_builder: Geoblacklight::BboxFilterQuery, within_boost: Settings.BBOX_WITHIN_BOOST, overlap_boost: Settings.OVERLAP_RATIO_BOOST, overlap_field: Settings.FIELDS.OVERLAP_FIELD, label: "Bounding Box"
+    config.add_facet_field field_config.geometry, item_presenter: Geoblacklight::BboxItemPresenter,
+      filter_class: Geoblacklight::BboxFilterField,
+      filter_query_builder: Geoblacklight::BboxFilterQuery,
+      within_boost: gbl_config.bbox_within_boost,
+      overlap_boost: gbl_config.overlap_ratio_boost,
+      overlap_field: field_config.overlap_field,
+      label: "Bounding Box"
 
     # Item Relationship Facets
     # * Not displayed to end user (show: false)
     # * Must be present for relationship "Browse all 4 records" links to work
     # * Label value becomes the search contraint filter name
-    config.add_facet_field Settings.FIELDS.MEMBER_OF, label: "Member Of", show: false
-    config.add_facet_field Settings.FIELDS.IS_PART_OF, label: "Is Part Of", show: false
-    config.add_facet_field Settings.FIELDS.RELATION, label: "Related", show: false
-    config.add_facet_field Settings.FIELDS.REPLACES, label: "Replaces", show: false
-    config.add_facet_field Settings.FIELDS.IS_REPLACED_BY, label: "Is Replaced By", show: false
-    config.add_facet_field Settings.FIELDS.SOURCE, label: "Source", show: false
-    config.add_facet_field Settings.FIELDS.VERSION, label: "Is Version Of", show: false
+    config.add_facet_field field_config.member_of, label: "Member Of", show: false
+    config.add_facet_field field_config.is_part_of, label: "Is Part Of", show: false
+    config.add_facet_field field_config.relation, label: "Related", show: false
+    config.add_facet_field field_config.replaces, label: "Replaces", show: false
+    config.add_facet_field field_config.is_replaced_by, label: "Is Replaced By", show: false
+    config.add_facet_field field_config.source, label: "Source", show: false
+    config.add_facet_field field_config.version, label: "Is Version Of", show: false
 
     # Have BL send all facet field names to Solr, which has been the default
     # previously. Simply remove these lines if you'd rather use Solr request
@@ -128,14 +136,14 @@ class CatalogController < ApplicationController
 
     # solr fields to be displayed in the index (search results) view
     #   The ordering of the field names is the order of the display
-    # config.add_index_field Settings.FIELDS.PROVIDER, :label => 'Institution:'
-    # config.add_index_field Settings.FIELDS.RIGHTS, :label => 'Access:'
+    # config.add_index_field field_config.provider, :label => 'Institution:'
+    # config.add_index_field field_config.rights, :label => 'Access:'
     # # config.add_index_field 'Area', :label => 'Area:'
-    # config.add_index_field Settings.FIELDS.SUBJECT, :label => 'Keywords:'
-    config.add_index_field Settings.FIELDS.INDEX_YEAR
-    config.add_index_field Settings.FIELDS.CREATOR
-    config.add_index_field Settings.FIELDS.DESCRIPTION, helper_method: :snippit
-    config.add_index_field Settings.FIELDS.PUBLISHER
+    # config.add_index_field field_config.subject, :label => 'Keywords:'
+    config.add_index_field field_config.index_year
+    config.add_index_field field_config.creator
+    config.add_index_field field_config.description, helper_method: :snippit
+    config.add_index_field field_config.publisher
 
     # ITEM VIEW FIELDS
 
@@ -149,27 +157,35 @@ class CatalogController < ApplicationController
     # The following fields all feature string values. If there is a value present in the metadata, they fields will show up on the item show page.
     # The labels and order can be customed. Comment out fields to hide them.
 
-    config.add_show_field Settings.FIELDS.ALTERNATIVE_TITLE, label: "Alternative Title", itemprop: "alt_title"
-    config.add_show_field Settings.FIELDS.DESCRIPTION, label: "Description", itemprop: "description", helper_method: :render_value_as_truncate_abstract
-    config.add_show_field Settings.FIELDS.CREATOR, label: "Creator", itemprop: "creator"
-    config.add_show_field Settings.FIELDS.PUBLISHER, label: "Publisher", itemprop: "publisher"
-    config.add_show_field Settings.FIELDS.PROVIDER, label: "Provider", link_to_facet: true
-    config.add_show_field Settings.FIELDS.RESOURCE_CLASS, label: "Resource Class", itemprop: "class"
-    config.add_show_field Settings.FIELDS.RESOURCE_TYPE, label: "Resource Type", itemprop: "type"
-    config.add_show_field Settings.FIELDS.SUBJECT, label: "Subject", itemprop: "keywords", link_to_facet: true
-    config.add_show_field Settings.FIELDS.THEME, label: "Theme", itemprop: "theme"
-    config.add_show_field Settings.FIELDS.TEMPORAL_COVERAGE, label: "Temporal Coverage", itemprop: "temporal"
-    config.add_show_field Settings.FIELDS.DATE_ISSUED, label: "Date Issued", itemprop: "issued"
-    config.add_show_field Settings.FIELDS.SPATIAL_COVERAGE, label: "Spatial Coverage", itemprop: "spatial", link_to_facet: true
-    config.add_show_field Settings.FIELDS.RIGHTS, label: "Rights", itemprop: "rights"
-    config.add_show_field Settings.FIELDS.RIGHTS_HOLDER, label: "Rights Holder", itemprop: "rights_holder"
-    config.add_show_field Settings.FIELDS.LICENSE, label: "License", itemprop: "license"
-    config.add_show_field Settings.FIELDS.ACCESS_RIGHTS, label: "Access Rights", itemprop: "access_rights"
-    config.add_show_field Settings.FIELDS.FORMAT, label: "Format", itemprop: "format"
-    config.add_show_field Settings.FIELDS.FILE_SIZE, label: "File Size", itemprop: "file_size"
-    config.add_show_field Settings.FIELDS.GEOREFERENCED, label: "Georeferenced", itemprop: "georeferenced"
+    config.add_show_field field_config.alternative_title, label: "Alternative Title",
+      itemprop: "alt_title"
+    config.add_show_field field_config.description, label: "Description", itemprop: "description",
+      helper_method: :render_value_as_truncate_abstract
+    config.add_show_field field_config.creator, label: "Creator", itemprop: "creator"
+    config.add_show_field field_config.publisher, label: "Publisher", itemprop: "publisher"
+    config.add_show_field field_config.provider, label: "Provider", link_to_facet: true
+    config.add_show_field field_config.resource_class, label: "Resource Class", itemprop: "class"
+    config.add_show_field field_config.resource_type, label: "Resource Type", itemprop: "type"
+    config.add_show_field field_config.subject, label: "Subject", itemprop: "keywords",
+      link_to_facet: true
+    config.add_show_field field_config.theme, label: "Theme", itemprop: "theme"
+    config.add_show_field field_config.temporal_coverage, label: "Temporal Coverage",
+      itemprop: "temporal"
+    config.add_show_field field_config.date_issued, label: "Date Issued", itemprop: "issued"
+    config.add_show_field field_config.spatial_coverage, label: "Spatial Coverage", itemprop: "spatial",
+      link_to_facet: true
+    config.add_show_field field_config.rights, label: "Rights", itemprop: "rights"
+    config.add_show_field field_config.rights_holder, label: "Rights Holder",
+      itemprop: "rights_holder"
+    config.add_show_field field_config.license, label: "License", itemprop: "license"
+    config.add_show_field field_config.access_rights, label: "Access Rights",
+      itemprop: "access_rights"
+    config.add_show_field field_config.format, label: "Format", itemprop: "format"
+    config.add_show_field field_config.file_size, label: "File Size", itemprop: "file_size"
+    config.add_show_field field_config.georeferenced, label: "Georeferenced",
+      itemprop: "georeferenced"
     config.add_show_field(
-      Settings.FIELDS.REFERENCES,
+      field_config.references,
       label: "More details at",
       accessor: [:external_url],
       if: proc { |_, _, doc| doc.external_url },
@@ -180,29 +196,29 @@ class CatalogController < ApplicationController
     # The following fields are not user friendly and are not set to appear on the item show page. They contain non-literal values, codes, URIs, or are otherwise designed to power features in the interface.
     # These values might need a translations to be readable by users.
 
-    # config.add_show_field Settings.FIELDS.LANGUAGE, label: 'Language', itemprop: 'language'
-    # config.add_show_field Settings.FIELDS.KEYWORD, label: 'Keyword(s)', itemprop: 'keyword'
+    # config.add_show_field field_config.language, label: 'Language', itemprop: 'language'
+    # config.add_show_field field_config.keyword, label: 'Keyword(s)', itemprop: 'keyword'
 
-    # config.add_show_field Settings.FIELDS.INDEX_YEAR, label: 'Year', itemprop: 'year'
-    # config.add_show_field Settings.FIELDS.DATE_RANGE, label: 'Date Range', itemprop: 'date_range'
+    # config.add_show_field field_config.index_year, label: 'Year', itemprop: 'year'
+    # config.add_show_field field_config.date_range, label: 'Date Range', itemprop: 'date_range'
 
-    # config.add_show_field Settings.FIELDS.CENTROID, label: 'Centroid', itemprop: 'centroid'
-    # config.add_show_field Settings.FIELDS.OVERLAP_FIELD, label: 'Overlap BBox', itemprop: 'overlap_field'
+    # config.add_show_field field_config.centroid, label: 'Centroid', itemprop: 'centroid'
+    # config.add_show_field field_config.overlap_field, label: 'Overlap BBox', itemprop: 'overlap_field'
 
-    # config.add_show_field Settings.FIELDS.RELATION, label: 'Relation', itemprop: 'relation'
-    # config.add_show_field Settings.FIELDS.MEMBER_OF, label: 'Member Of', itemprop: 'member_of'
-    # config.add_show_field Settings.FIELDS.IS_PART_OF, label: 'Is Part Of', itemprop: 'is_part_of'
-    # config.add_show_field Settings.FIELDS.VERSION, label: 'Version', itemprop: 'version'
-    # config.add_show_field Settings.FIELDS.REPLACES, label: 'Replaces', itemprop: 'replaces'
-    # config.add_show_field Settings.FIELDS.IS_REPLACED_BY, label: 'Is Replaced By', itemprop: 'is_replaced_by'
+    # config.add_show_field field_config.relation, label: 'Relation', itemprop: 'relation'
+    # config.add_show_field field_config.member_of, label: 'Member Of', itemprop: 'member_of'
+    # config.add_show_field field_config.is_part_of, label: 'Is Part Of', itemprop: 'is_part_of'
+    # config.add_show_field field_config.version, label: 'Version', itemprop: 'version'
+    # config.add_show_field field_config.replaces, label: 'Replaces', itemprop: 'replaces'
+    # config.add_show_field field_config.is_replaced_by, label: 'Is Replaced By', itemprop: 'is_replaced_by'
 
-    # config.add_show_field Settings.FIELDS.WXS_IDENTIFIER, label: 'Web Service Layer', itemprop: 'wxs_identifier'
-    # config.add_show_field Settings.FIELDS.ID, label: 'ID', itemprop: 'id'
-    # config.add_show_field Settings.FIELDS.IDENTIFIER, label: 'Identifier', itemprop: 'identifier'
+    # config.add_show_field field_config.wxs_identifier, label: 'Web Service Layer', itemprop: 'wxs_identifier'
+    # config.add_show_field field_config.id, label: 'ID', itemprop: 'id'
+    # config.add_show_field field_config.identifier, label: 'Identifier', itemprop: 'identifier'
 
-    # config.add_show_field Settings.FIELDS.MODIFIED, label: 'Date Modified', itemprop: 'modified'
-    # config.add_show_field Settings.FIELDS.METADATA_VERSION, label: 'Metadata Version', itemprop: 'metadata_version'
-    # config.add_show_field Settings.FIELDS.SUPPRESSED, label: 'Suppressed', itemprop: 'suppresed'
+    # config.add_show_field field_config.modified, label: 'Date Modified', itemprop: 'modified'
+    # config.add_show_field field_config.metadata_version, label: 'Metadata Version', itemprop: 'metadata_version'
+    # config.add_show_field field_config.suppressed, label: 'Suppressed', itemprop: 'suppresed'
 
     # "fielded" search configuration. Used by pulldown among other places.
     # For supported keys in hash, see rdoc for Blacklight::SearchFields
@@ -277,8 +293,10 @@ class CatalogController < ApplicationController
     # whether the sort is ascending or descending (it must be asc or desc
     # except in the relevancy case).
     config.add_sort_field "score desc, dct_title_sort asc", label: "Relevance"
-    config.add_sort_field "#{Settings.FIELDS.INDEX_YEAR} desc, dct_title_sort asc", label: "Year (Newest first)"
-    config.add_sort_field "#{Settings.FIELDS.INDEX_YEAR} asc, dct_title_sort asc", label: "Year (Oldest first)"
+    config.add_sort_field "#{field_config.index_year} desc, dct_title_sort asc",
+      label: "Year (Newest first)"
+    config.add_sort_field "#{field_config.index_year} asc, dct_title_sort asc",
+      label: "Year (Oldest first)"
     config.add_sort_field "dct_title_sort asc", label: "Title (A-Z)"
     config.add_sort_field "dct_title_sort desc", label: "Title (Z-A)"
 
@@ -299,9 +317,15 @@ class CatalogController < ApplicationController
     config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
 
     # Custom tools for GeoBlacklight
-    config.add_show_tools_partial :metadata, if: proc { |_context, _config, options| options[:document] && (Settings.METADATA_SHOWN & options[:document].references.refs.map(&:type).map(&:to_s)).any? }
-    config.add_show_tools_partial :arcgis, component: Geoblacklight::ArcgisComponent, if: proc { |_context, _config, options| options[:document] && options[:document].arcgis_urls.present? }
-    config.add_show_tools_partial :data_dictionary, component: Geoblacklight::DataDictionaryDownloadComponent, if: proc { |_context, _config, options| options[:document] && options[:document].data_dictionary_download.present? }
+    config.add_show_tools_partial :metadata, if: proc { |_context, _config, options|
+      options[:document] && (gbl_config.metadata_shown & options[:document].references.refs.map(&:type).map(&:to_s)).any?
+    }
+    config.add_show_tools_partial :arcgis, component: Geoblacklight::ArcgisComponent,
+      if: proc { |_context, _config, options| options[:document]&.arcgis_urls.present? }
+    config.add_show_tools_partial :data_dictionary, component: Geoblacklight::DataDictionaryDownloadComponent,
+      if: proc { |_context, _config, options| options[:document]&.data_dictionary_download.present? }
+    config.add_show_tools_partial :web_services, component: Geoblacklight::WebServicesLinkComponent,
+      if: proc { |_context, _config, options| options[:document] && (gbl_config.webservices_shown & options[:document].references.refs.map(&:type).map(&:to_s)).any? }
 
     # Configure basemap provider for GeoBlacklight maps (uses https only basemap
     # providers with open licenses)