geoblacklight 2.3.0

data/lib/generators/geoblacklight/install_generator.rb

@@ -0,0 +1,105 @@
+require 'rails/generators'
+
+module Geoblacklight
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'Install Geoblacklight'
+
+    def mount_geoblacklight_engine
+      inject_into_file 'config/routes.rb', "mount Geoblacklight::Engine => 'geoblacklight'\n", before: /^end/
+    end
+
+    def inject_geoblacklight_routes
+      routes = <<-"ROUTES"
+        concern :gbl_exportable, Geoblacklight::Routes::Exportable.new
+        resources :solr_documents, only: [:show], path: '/catalog', controller: 'catalog' do
+          concerns :gbl_exportable
+        end
+        concern :gbl_wms, Geoblacklight::Routes::Wms.new
+        namespace :wms do
+          concerns :gbl_wms
+        end
+        concern :gbl_downloadable, Geoblacklight::Routes::Downloadable.new
+        namespace :download do
+          concerns :gbl_downloadable
+        end
+        resources :download, only: [:show]
+      ROUTES
+
+      inject_into_file 'config/routes.rb', routes, before: /^end/
+    end
+
+    def assets
+      copy_file 'geoblacklight.scss', 'app/assets/stylesheets/geoblacklight.scss'
+      copy_file 'geoblacklight.js', 'app/assets/javascripts/geoblacklight.js'
+
+      append_to_file 'config/initializers/assets.rb',
+                     "\nRails.application.config.assets.precompile += %w( favicon.ico )\n"
+
+      append_to_file 'config/initializers/assets.rb',
+                     "\nRails.application.config.assets.paths << Rails.root.join('vendor', 'assets', 'images')\n"
+    end
+
+    def create_blacklight_catalog
+      remove_file 'app/controllers/catalog_controller.rb'
+      copy_file 'catalog_controller.rb', 'app/controllers/catalog_controller.rb'
+    end
+
+    def rails_config
+      copy_file 'settings.yml', 'config/settings.yml'
+    end
+
+    def solr_config
+      directory '../../../../solr', 'solr'
+    end
+
+    def include_geoblacklight_solrdocument
+      inject_into_file 'app/models/solr_document.rb', after: 'include Blacklight::Solr::Document' do
+        "\n include Geoblacklight::SolrDocument"
+      end
+    end
+
+    def add_unique_key
+      inject_into_file 'app/models/solr_document.rb', after: "# self.unique_key = 'id'" do
+        "\n  self.unique_key = 'layer_slug_s'"
+      end
+    end
+
+    def add_spatial_search_behavior
+      inject_into_file 'app/models/search_builder.rb', after: 'include Blacklight::Solr::SearchBuilderBehavior' do
+        "\n  include Geoblacklight::SpatialSearchBehavior"
+      end
+    end
+
+    # Turn off JQuery animations during testing
+    def inject_disable_jquery_animations
+      inject_into_file 'app/views/layouts/application.html.erb', before: '</head>' do
+        "  <%= javascript_tag '$.fx.off = true;' if Rails.env.test? %>\n"
+      end
+    end
+
+    def create_downloads_directory
+      FileUtils.mkdir_p('tmp/cache/downloads') unless File.directory?('tmp/cache/downloads')
+    end
+
+    def disable_turbolinks
+      gsub_file('app/assets/javascripts/application.js', %r{\/\/= require turbolinks}, '')
+    end
+
+    def update_application_name
+      gsub_file('config/locales/blacklight.en.yml', 'Blacklight', 'GeoBlacklight')
+    end
+
+    # Ensure that assets/images exists
+    def create_image_assets_directory
+      FileUtils.mkdir_p('app/assets/images') unless File.directory?('app/assets/images')
+    end
+
+    def bundle_install
+      Bundler.with_clean_env do
+        run 'bundle install'
+      end
+    end
+  end
+end

data/lib/generators/geoblacklight/templates/Procfile

@@ -0,0 +1,3 @@
+rails: bin/rails server --port=3000
+webpack: bin/webpack-dev-server
+

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

@@ -0,0 +1,272 @@
+# -*- encoding : utf-8 -*-
+require 'blacklight/catalog'
+
+class CatalogController < ApplicationController
+
+  include Blacklight::Catalog
+
+  configure_blacklight do |config|
+
+    # Ensures that JSON representations of Solr Documents can be retrieved using
+    # the path /catalog/:id/raw
+    # Please see https://github.com/projectblacklight/blacklight/pull/2006/
+    config.raw_endpoint.enabled = true
+
+    ## 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
+    config.default_solr_params = {
+      start: 0,
+      'q.alt' => '*:*'
+    }
+
+    ## Default rows returned from Solr
+    ## @see https://lucene.apache.org/solr/guide/6_6/common-query-parameters.html
+    config.default_per_page = 10
+
+    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SolrHelper#solr_doc_params) or
+    ## parameters included in the Blacklight-jetty document requestHandler.
+    #
+    config.default_document_solr_params = {
+     :qt => 'document',
+     :q => '{!raw f=layer_slug_s v=$id}'
+    }
+
+
+    # solr field configuration for search results/index views
+    # config.index.show_link = 'title_display'
+    # config.index.record_display_type = 'format'
+
+    config.index.title_field = Settings.FIELDS.TITLE
+
+    # solr field configuration for document/show views
+
+    config.show.display_type_field = 'format'
+    config.show.partials << 'show_default_viewer_container'
+    config.show.partials << 'show_default_attribute_table'
+    config.show.partials << 'show_default_viewer_information'
+
+    ##
+    # Configure the index document presenter.
+    config.index.document_presenter_class = Geoblacklight::DocumentPresenter
+
+    # solr fields that will be treated as facets by the blacklight application
+    #   The ordering of the field names is the order of the display
+    #
+    # Setting a limit will trigger Blacklight's 'more' facet values link.
+    # * If left unset, then all facet values returned by solr will be displayed.
+    # * If set to an integer, then "f.somefield.facet.limit" will be added to
+    # solr request, with actual solr request being +1 your configured limit --
+    # you configure the number of items you actually want _displayed_ in a page.
+    # * If set to 'true', then no additional parameters will be sent to solr,
+    # but any 'sniffed' request limit parameters will be used for paging, with
+    # paging at requested limit -1. Can sniff from facet.limit or
+    # f.specific_field.facet.limit solr request params. This 'true' config
+    # can be used if you set limits in :default_solr_params, or as defaults
+    # on the solr side in the request handler itself. Request handler defaults
+    # sniffing requires solr requests to be made with "echoParams=all", for
+    # app code to actually have it echo'd back to see it.
+    #
+    # :show may be set to false if you don't want the facet to be drawn in the
+    # facet bar
+    # config.add_facet_field 'format', :label => 'Format'
+    # config.add_facet_field 'pub_date', :label => 'Publication Year', :single => true
+    # config.add_facet_field 'subject_topic_facet', :label => 'Topic', :limit => 20
+    # config.add_facet_field 'language_facet', :label => 'Language', :limit => true
+    # config.add_facet_field 'lc_1letter_facet', :label => 'Call Number'
+    # config.add_facet_field 'subject_geo_facet', :label => 'Region'
+    # config.add_facet_field 'solr_bbox', :fq => "solr_bbox:IsWithin(-88,26,-79,36)", :label => 'Spatial'
+
+    # config.add_facet_field 'example_pivot_field', :label => 'Pivot Field', :pivot => ['format', 'language_facet']
+
+    # config.add_facet_field 'example_query_facet_field', :label => 'Publish Date', :query => {
+    #    :years_5 => { :label => 'within 5 Years', :fq => "pub_date:[#{Time.now.year - 5 } TO *]" },
+    #    :years_10 => { :label => 'within 10 Years', :fq => "pub_date:[#{Time.now.year - 10 } TO *]" },
+    #    :years_25 => { :label => 'within 25 Years', :fq => "pub_date:[#{Time.now.year - 25 } TO *]" }
+    # }
+
+    config.add_facet_field Settings.FIELDS.PROVENANCE, label: 'Institution', limit: 8, partial: "icon_facet"
+    config.add_facet_field Settings.FIELDS.CREATOR, :label => 'Author', :limit => 8
+    config.add_facet_field Settings.FIELDS.PUBLISHER, :label => 'Publisher', :limit => 8
+    config.add_facet_field Settings.FIELDS.SUBJECT, :label => 'Subject', :limit => 8
+    config.add_facet_field Settings.FIELDS.SPATIAL_COVERAGE, :label => 'Place', :limit => 8
+    config.add_facet_field Settings.FIELDS.PART_OF, :label => 'Collection', :limit => 8
+
+    config.add_facet_field Settings.FIELDS.YEAR, :label => 'Year', :limit => 10
+
+    config.add_facet_field Settings.FIELDS.RIGHTS, label: 'Access', limit: 8, partial: "icon_facet"
+    config.add_facet_field Settings.FIELDS.GEOM_TYPE, label: 'Data type', limit: 8, partial: "icon_facet"
+    config.add_facet_field Settings.FIELDS.FILE_FORMAT, :label => 'Format', :limit => 8
+
+    # 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
+    # handler defaults, or have no facets.
+    config.add_facet_fields_to_solr_request!
+
+    # 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 'title_display', :label => 'Title:'
+    # config.add_index_field 'title_vern_display', :label => 'Title:'
+    # config.add_index_field 'author_display', :label => 'Author:'
+    # config.add_index_field 'author_vern_display', :label => 'Author:'
+    # config.add_index_field 'format', :label => 'Format:'
+    # config.add_index_field 'language_facet', :label => 'Language:'
+    # config.add_index_field 'published_display', :label => 'Published:'
+    # config.add_index_field 'published_vern_display', :label => 'Published:'
+    # config.add_index_field 'lc_callnum_display', :label => 'Call number:'
+
+    # config.add_index_field 'dc_title_t', :label => 'Display Name:'
+    # config.add_index_field Settings.FIELDS.PROVENANCE, :label => 'Institution:'
+    # config.add_index_field Settings.FIELDS.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.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
+
+
+
+    # solr fields to be displayed in the show (single result) view
+    #  The ordering of the field names is the order of the display
+    #
+    # item_prop: [String] property given to span with Schema.org item property
+    # link_to_search: [Boolean] that can be passed to link to a facet search
+    # helper_method: [Symbol] method that can be used to render the value
+    config.add_show_field Settings.FIELDS.CREATOR, label: 'Author(s)', itemprop: 'author'
+    config.add_show_field Settings.FIELDS.DESCRIPTION, label: 'Description', itemprop: 'description', helper_method: :render_value_as_truncate_abstract
+    config.add_show_field Settings.FIELDS.PUBLISHER, label: 'Publisher', itemprop: 'publisher'
+    config.add_show_field Settings.FIELDS.PART_OF, label: 'Collection', itemprop: 'isPartOf'
+    config.add_show_field Settings.FIELDS.SPATIAL_COVERAGE, label: 'Place(s)', itemprop: 'spatial', link_to_facet: true
+    config.add_show_field Settings.FIELDS.SUBJECT, label: 'Subject(s)', itemprop: 'keywords', link_to_facet: true
+    config.add_show_field Settings.FIELDS.TEMPORAL, label: 'Year', itemprop: 'temporal'
+    config.add_show_field Settings.FIELDS.PROVENANCE, label: 'Held by', link_to_facet: true
+    config.add_show_field(
+      Settings.FIELDS.REFERENCES,
+      label: 'More details at',
+      accessor: [:external_url],
+      if: proc { |_, _, doc| doc.external_url },
+      helper_method: :render_references_url
+    )
+
+    # "fielded" search configuration. Used by pulldown among other places.
+    # For supported keys in hash, see rdoc for Blacklight::SearchFields
+    #
+    # Search fields will inherit the :qt solr request handler from
+    # config[:default_solr_parameters], OR can specify a different one
+    # with a :qt key/value. Below examples inherit, except for subject
+    # that specifies the same :qt as default for our own internal
+    # testing purposes.
+    #
+    # The :key is what will be used to identify this BL search field internally,
+    # as well as in URLs -- so changing it after deployment may break bookmarked
+    # urls.  A display label will be automatically calculated from the :key,
+    # or can be specified manually to be different.
+
+    # This one uses all the defaults set by the solr request handler. Which
+    # solr request handler? The one set in config[:default_solr_parameters][:qt],
+    # since we aren't specifying it otherwise.
+
+    config.add_search_field 'all_fields', :label => 'All Fields'
+    # config.add_search_field 'dc_title_ti', :label => 'Title'
+    # config.add_search_field 'dc_description_ti', :label => 'Description'
+
+    # Now we see how to over-ride Solr request handler defaults, in this
+    # case for a BL "search field", which is really a dismax aggregate
+    # of Solr search fields.
+
+    # config.add_search_field('title') do |field|
+    #   # solr_parameters hash are sent to Solr as ordinary url query params.
+    #   field.solr_parameters = { :'spellcheck.dictionary' => 'title' }
+
+    #   # :solr_local_parameters will be sent using Solr LocalParams
+    #   # syntax, as eg {! qf=$title_qf }. This is neccesary to use
+    #   # Solr parameter de-referencing like $title_qf.
+    #   # See: http://wiki.apache.org/solr/LocalParams
+    #   field.solr_local_parameters = {
+    #     :qf => '$title_qf',
+    #     :pf => '$title_pf'
+    #   }
+    # end
+
+    # config.add_search_field('author') do |field|
+    #   field.solr_parameters = { :'spellcheck.dictionary' => 'author' }
+    #   field.solr_local_parameters = {
+    #     :qf => '$author_qf',
+    #     :pf => '$author_pf'
+    #   }
+    # end
+
+    # # Specifying a :qt only to show it's possible, and so our internal automated
+    # # tests can test it. In this case it's the same as
+    # # config[:default_solr_parameters][:qt], so isn't actually neccesary.
+    # config.add_search_field('subject') do |field|
+    #   field.solr_parameters = { :'spellcheck.dictionary' => 'subject' }
+    #   field.qt = 'search'
+    #   field.solr_local_parameters = {
+    #     :qf => '$subject_qf',
+    #     :pf => '$subject_pf'
+    #   }
+    # end
+
+    #  config.add_search_field('Institution') do |field|
+    #   field.solr_parameters = { :'spellcheck.dictionary' => 'Institution' }
+    #   field.solr_local_parameters = {
+    #     :qf => '$Institution_qf',
+    #     :pf => '$Institution_pf'
+    #   }
+    # end
+
+    # "sort results by" select (pulldown)
+    # label in pulldown is followed by the name of the SOLR field to sort by and
+    # whether the sort is ascending or descending (it must be asc or desc
+    # except in the relevancy case).
+    config.add_sort_field 'score desc, dc_title_sort asc', :label => 'relevance'
+    config.add_sort_field "#{Settings.FIELDS.YEAR} desc, dc_title_sort asc", :label => 'year'
+    config.add_sort_field "#{Settings.FIELDS.PUBLISHER} asc, dc_title_sort asc", :label => 'publisher'
+    config.add_sort_field 'dc_title_sort asc', :label => 'title'
+
+    # If there are more than this many search results, no spelling ("did you
+    # mean") suggestion is offered.
+    config.spell_max = 5
+
+    # Nav actions from Blacklight
+    config.add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?)
+    config.add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
+
+    # Tools from Blacklight
+    config.add_results_collection_tool(:sort_widget)
+    config.add_results_collection_tool(:per_page_widget)
+    config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+    config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
+    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 :web_services, if: proc { |_context, _config, options| options[:document] && (Settings.WEBSERVICES_SHOWN & options[:document].references.refs.map(&:type).map(&:to_s)).any? }
+    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 :exports, partial: 'exports', if: proc { |_context, _config, options| options[:document] }
+    config.add_show_tools_partial :data_dictionary, partial: 'data_dictionary', if: proc { |_context, _config, options| options[:document] }
+
+    # Configure basemap provider for GeoBlacklight maps (uses https only basemap
+    # providers with open licenses)
+    # Valid basemaps include:
+    # 'positron'
+    # 'darkMatter'
+    # 'positronLite'
+    # 'worldAntique'
+    # 'worldEco'
+    # 'flatBlue'
+    # 'midnightCommander'
+    # 'openstreetmapHot'
+    # 'openstreetmapStandard'
+
+    config.basemap_provider = 'positron'
+
+    # Configuration for autocomplete suggestor
+    config.autocomplete_enabled = true
+    config.autocomplete_path = 'suggest'
+  end
+
+
+
+end

data/lib/generators/geoblacklight/templates/geoblacklight.js

@@ -0,0 +1,10 @@
+//= require handlebars.runtime
+//= require geoblacklight/geoblacklight
+//= require geoblacklight/basemaps
+//= require geoblacklight/controls
+//= require geoblacklight/viewers
+//= require geoblacklight/modules
+//= require geoblacklight/downloaders
+//= require leaflet-iiif
+//= require esri-leaflet
+//= require readmore

data/lib/generators/geoblacklight/templates/geoblacklight.scss

@@ -0,0 +1,4 @@
+/*
+*= require geoblacklight/application
+*= require leaflet-label
+*/

data/lib/generators/geoblacklight/templates/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "internal",
+  "private": true,
+  "dependencies": {
+    "@rails/webpacker": "https://github.com/rails/webpacker.git"
+  },
+  "devDependencies": {
+    "babel-plugin-syntax-dynamic-import": "^6.18.0",
+    "babel-plugin-transform-class-properties": "^6.24.1",
+    "babel-plugin-transform-object-rest-spread": "^6.26.0",
+    "babel-preset-env": "^1.7.0",
+    "webpack-dev-server": "^3.6.0"
+  }
+}

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

@@ -0,0 +1,127 @@
+# 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/'
+
+# Hide Carto export link
+# CARTO_HIDE: true
+
+# Hide ArcGIS export link
+# ARCGIS_HIDE: true
+
+# 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:
+  :FILE_FORMAT: 'dc_format_s'
+  :GEOMETRY: 'solr_geom'
+  :WXS_IDENTIFIER: 'layer_id_s'
+  :RIGHTS: 'dc_rights_s'
+  :PROVENANCE: 'dct_provenance_s'
+  :GEOM_TYPE: 'layer_geom_type_s'
+  :SPATIAL_COVERAGE: 'dct_spatial_sm'
+  :SUBJECT: 'dc_subject_sm'
+  :REFERENCES: 'dct_references_s'
+  :YEAR: 'solr_year_i'
+  :CREATOR: 'dc_creator_sm'
+  :DESCRIPTION: 'dc_description_s'
+  :PUBLISHER: 'dc_publisher_s'
+  :PART_OF: 'dct_isPartOf_sm'
+  :TEMPORAL: 'dct_temporal_sm'
+  :TITLE: 'dc_title_s'
+  :SOURCE: 'dc_source_sm'
+
+# 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
+
+# Web services shown in tool panel
+WEBSERVICES_SHOWN:
+  - 'wms'
+  - 'wfs'
+  - 'iiif'
+  - 'feature_layer'
+  - 'tiled_map_layer'
+  - 'dynamic_map_layer'
+  - 'image_map_layer'
+
+# 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'
+      - 'oembed'