blacklight-maps 0.5.2 → 1.1.0

data/app/helpers/blacklight/blacklight_maps_helper_behavior.rb

@@ -1,101 +1,96 @@
-module Blacklight::BlacklightMapsHelperBehavior
+# frozen_string_literal: true
 
-  # @param [String] id the html id
-  # @param [Hash] tag_options options to put on the tag
-  def blacklight_map_tag id, tag_options = {}, &block
-    default_data = {
-        maxzoom: blacklight_config.view.maps.maxzoom,
-        tileurl: blacklight_config.view.maps.tileurl,
-        mapattribution: blacklight_config.view.maps.mapattribution
-    }
-
-    options = {id: id, data: default_data}.deep_merge(tag_options)
-    if block_given?
-      content_tag(:div, options, &block)
-    else
-      tag(:div, options)
+module Blacklight
+  module BlacklightMapsHelperBehavior
+    # @param id [String] the html element id
+    # @param tag_options [Hash] options to put on the tag
+    def blacklight_map_tag(id, tag_options = {}, &block)
+      maps_config = blacklight_config.view.maps
+      default_data = {
+        maxzoom: maps_config.maxzoom,
+        tileurl: maps_config.tileurl,
+        mapattribution: maps_config.mapattribution
+      }
+      options = { id: id, data: default_data }.deep_merge(tag_options)
+      block_given? ? content_tag(:div, options, &block) : tag(:div, options)
     end
-  end
 
-  # return the placename value to be used as a link
-  def placename_value(geojson_hash)
-    geojson_hash[:properties][blacklight_config.view.maps.placename_property.to_sym]
-  end
-
-  # create a link to a bbox spatial search
-  def link_to_bbox_search bbox_coordinates
-    coords_for_search = bbox_coordinates.map { |v| v.to_s }
-    link_to(t('blacklight.maps.interactions.bbox_search'),
-            search_catalog_path(spatial_search_type: "bbox",
-                               coordinates: "[#{coords_for_search[1]},#{coords_for_search[0]} TO #{coords_for_search[3]},#{coords_for_search[2]}]",
-                               view: default_document_index_view_type))
-  end
-
-  # create a link to a location name facet value
-  def link_to_placename_field field_value, field, displayvalue = nil
-    if params[:f] && params[:f][field] && params[:f][field].include?(field_value)
-      new_params = params
-    else
-      new_params = search_state.add_facet_params(field, field_value)
+    # return the placename value to be used as a link
+    # @param geojson_hash [Hash]
+    def placename_value(geojson_hash)
+      geojson_hash[:properties][blacklight_config.view.maps.placename_property.to_sym]
     end
-    new_params[:view] = default_document_index_view_type
-    link_to(displayvalue.presence || field_value,
-            search_catalog_path(new_params.except(:id, :spatial_search_type, :coordinates)))
-  end
 
-  # create a link to a spatial search for a set of point coordinates
-  def link_to_point_search point_coordinates
-    new_params = params.except(:controller, :action, :view, :id, :spatial_search_type, :coordinates)
-    new_params[:spatial_search_type] = "point"
-    new_params[:coordinates] = "#{point_coordinates[1]},#{point_coordinates[0]}"
-    new_params[:view] = default_document_index_view_type
-    link_to(t('blacklight.maps.interactions.point_search'), search_catalog_path(new_params))
-  end
+    # create a link to a bbox spatial search
+    # @param bbox [Array]
+    def link_to_bbox_search(bbox)
+      bbox_coords = bbox.map(&:to_s)
+      bbox_search_coords = "[#{bbox_coords[1]},#{bbox_coords[0]} TO #{bbox_coords[3]},#{bbox_coords[2]}]"
+      link_to(t('blacklight.maps.interactions.bbox_search'),
+              search_catalog_path(spatial_search_type: 'bbox',
+                                  coordinates: bbox_search_coords,
+                                  view: default_document_index_view_type))
+    end
 
-  # return the facet field containing geographic data
-  def map_facet_field
-    blacklight_config.view.maps.facet_mode == "coordinates" ?
-        blacklight_config.view.maps.coordinates_facet_field :
-        blacklight_config.view.maps.geojson_field
-  end
+    # create a link to a location name facet value
+    # @param field_value [String] Solr field value
+    # @param field [String] Solr field name
+    # @param display_value [String] value to display instead of field_value
+    def link_to_placename_field(field_value, field, display_value = nil)
+      new_params = if params[:f] && params[:f][field]&.include?(field_value)
+                     search_state.params
+                   else
+                     search_state.add_facet_params(field, field_value)
+                   end
+      new_params[:view] = default_document_index_view_type
+      new_params.except!(:id, :spatial_search_type, :coordinates, :controller, :action)
+      link_to(display_value.presence || field_value, search_catalog_path(new_params))
+    end
 
-  # return an array of Blacklight::SolrResponse::Facets::FacetItem items
-  def map_facet_values
-    if @response.aggregations[map_facet_field]
-      @response.aggregations[map_facet_field].items
-    else
-      []
+    # create a link to a spatial search for a set of point coordinates
+    # @param point_coords [Array]
+    def link_to_point_search(point_coords)
+      new_params = params.except(:controller, :action, :view, :id, :spatial_search_type, :coordinates)
+      new_params[:spatial_search_type] = 'point'
+      new_params[:coordinates] = "#{point_coords[1]},#{point_coords[0]}"
+      new_params[:view] = default_document_index_view_type
+      new_params.permit!
+      link_to(t('blacklight.maps.interactions.point_search'), search_catalog_path(new_params))
     end
-  end
 
-  # render the location name for the Leaflet popup
-  # separate from BlacklightMapsHelperBehavior#placename_value so
-  # location name display can be easily customized
-  def render_placename_heading(geojson_hash)
-    geojson_hash[:properties][blacklight_config.view.maps.placename_property.to_sym]
-  end
+    # render the location name for the Leaflet popup
+    # @param geojson_hash [Hash]
+    def render_placename_heading(geojson_hash)
+      geojson_hash[:properties][blacklight_config.view.maps.placename_property.to_sym]
+    end
 
-  # render the map for #index and #map views
-  def render_index_mapview
-    render :partial => 'catalog/index_mapview',
-           :locals => {:geojson_features => serialize_geojson(map_facet_values)}
-  end
+    # render the map for #index and #map views
+    def render_index_mapview
+      maps_config = blacklight_config.view.maps
+      map_facet_field = if maps_config.facet_mode == 'coordinates'
+                          maps_config.coordinates_facet_field
+                        else
+                          maps_config.geojson_field
+                        end
+      map_facet_values = @response.aggregations[map_facet_field]&.items || []
+      render partial: 'catalog/index_mapview',
+             locals: { geojson_features: serialize_geojson(map_facet_values) }
+    end
 
-  # determine the type of spatial search to use based on coordinates (bbox or point)
-  def render_spatial_search_link coordinates
-    if coordinates.length == 4
-      link_to_bbox_search(coordinates)
-    else
-      link_to_point_search(coordinates)
+    # determine the type of spatial search to use based on coordinates (bbox or point)
+    # @param coords [Array]
+    def render_spatial_search_link(coords)
+      coords.length == 4 ? link_to_bbox_search(coords) : link_to_point_search(coords)
     end
-  end
 
-  # pass the document or facet values to BlacklightMaps::GeojsonExport
-  def serialize_geojson(documents, options={})
-    export = BlacklightMaps::GeojsonExport.new(controller,
-                                               controller.action_name,
-                                               documents,
-                                               options)
-    export.to_geojson
+    # pass the document or facet values to BlacklightMaps::GeojsonExport
+    # @param documents [Array || SolrDocument]
+    def serialize_geojson(documents, options = {})
+      export = BlacklightMaps::GeojsonExport.new(controller,
+                                                 action_name.to_sym,
+                                                 documents,
+                                                 options)
+      export.to_geojson
+    end
   end
 end

data/app/helpers/blacklight_maps_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BlacklightMapsHelper
   include Blacklight::BlacklightMapsHelperBehavior
 end

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

@@ -1,10 +1,9 @@
 <% # map for catalog#show view %>
-<div id="blacklight-show-map-container">
-    <% if @document[blacklight_config.view.maps.geojson_field.to_sym] || @document[blacklight_config.view.maps.coordinates_field.to_sym] %>
-        <% geojson_features = serialize_geojson(@document) %>
-        <%= blacklight_map_tag('blacklight-show-map',
-                               {data:{initialzoom:blacklight_config.view.maps.show_initial_zoom,
-                                      singlemarkermode:false}}) %>
-        <%= javascript_tag "$('#blacklight-show-map').blacklight_leaflet_map(#{geojson_features});" %>
-    <% end %>
-</div>
+<% if @document[blacklight_config.view.maps.geojson_field.to_sym] || @document[blacklight_config.view.maps.coordinates_field.to_sym] %>
+  <div id="blacklight-show-map-container">
+    <%= blacklight_map_tag('blacklight-show-map',
+                           {data:{initialzoom:blacklight_config.view.maps.show_initial_zoom,
+                                  singlemarkermode:false}}) %>
+    <%= javascript_tag "$('#blacklight-show-map').blacklight_leaflet_map(#{serialize_geojson(@document)});" %>
+  </div>
+<% end %>

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

@@ -1,8 +1,8 @@
 <div id="content" class="col-md-12 col-sm-12">
   <h1><%= t('blacklight.maps.title') %></h1>
-  <div id="map_leader_text"><%= t('blacklight.maps.leader') %></div>
+  <div id="map_leader_text"><%= t('blacklight.maps.leader_html') %></div>
   <%= render 'search_results' %>
 </div>
 
 <%# have to put this at the end so it overrides 'catalog/search_results' %>
-<% @page_title = t('blacklight.maps.title', :application_name => application_name) %>
+<% @page_title = t('blacklight.maps.title', application_name: application_name) %>

data/blacklight-maps.gemspec

@@ -1,33 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'blacklight/maps/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "blacklight-maps"
-  spec.version       = Blacklight::Maps::VERSION
-  spec.authors       = ["Chris Beer", "Jack Reed", "Eben English"]
-  spec.email         = ["cabeer@stanford.edu", "pjreed@stanford.edu", "eenglish@bpl.org"]
-  spec.summary       = %q{Maps for Blacklight}
-  spec.homepage      = "https://github.com/projectblacklight/blacklight-maps"
-  spec.license       = "Apache-2.0"
+Gem::Specification.new do |s|
+  s.name          = 'blacklight-maps'
+  s.version       = Blacklight::Maps::VERSION
+  s.authors       = ['Chris Beer', 'Jack Reed', 'Eben English']
+  s.email         = %w[cabeer@stanford.edu pjreed@stanford.edu eenglish@bpl.org]
+  s.summary       = 'Maps for Blacklight'
+  s.description   = 'Blacklight plugin providing map views for records with geographic data.'
+  s.homepage      = 'https://github.com/projectblacklight/blacklight-maps'
+  s.license       = 'Apache-2.0'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
-  spec.add_dependency "rails", "< 6"
-  spec.add_dependency "blacklight", ">= 6.1.0", "< 7.0.0"
-  spec.add_dependency "bootstrap-sass", "~> 3.2"
-  spec.add_dependency "leaflet-rails", "0.7.7"
-  spec.add_dependency "leaflet-markercluster-rails"
+  s.add_dependency 'blacklight', '>= 7.8.0', '< 8'
+  s.add_dependency 'rails', '>= 5.1', '< 7'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec-rails", "~> 3.0"
-  spec.add_development_dependency "jettywrapper"
-  spec.add_development_dependency "engine_cart", "~> 0.4.0"
-  spec.add_development_dependency "capybara"
-  spec.add_development_dependency "poltergeist", ">= 1.5.0"
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'engine_cart', '~> 2.1'
+  s.add_development_dependency 'rspec-rails', '~> 3.0'
+  s.add_development_dependency 'rubocop', '~> 0.63.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.8'
+  s.add_development_dependency 'selenium-webdriver', '>= 3.13.1'
+  s.add_development_dependency 'solr_wrapper', '~> 2.0'
+  s.add_development_dependency 'webdrivers', '~> 3.0'
 end

data/config/locales/blacklight-maps-zh.yml

@@ -3,18 +3,18 @@ zh:
 
     maps:
       interactions:
-        bbox_search: 'View items that intersect with this bounding box'
-        placename_search: 'View items from this location'
+        bbox_search: '查看与此边界框相交的项目'
+        placename_search: '查看此位置的物品'
         item: '资料'
-        point_search: 'View items from this location'
-        search_ctrl_cue: 'Search for all items within the current map window'
+        point_search: '查看此位置的物品'
+        search_ctrl_cue: '在当前地图窗口中搜索所有项目'
       title: '地图'
-      leader: 'Click on a marker to search for items from that location.'
+      leader: '单击标记以从该位置搜索项目，或使用 🔍 按钮搜索当前地图窗口中的所有项目。'
 
     search:
       filters:
         coordinates:
-          bbox: 'Bounding Box'
-          point: 'Coordinates'
+          bbox: '边界框'
+          point: '座标'
       view:
         maps: '地图'

data/config/locales/blacklight-maps.ar.yml

@@ -0,0 +1,21 @@
+ar:
+  blacklight:
+
+    maps:
+      interactions:
+        bbox_search: 'عرض العناصر التي تتقاطع مع هذا المربع المحيط'
+        placename_search: 'عرض العناصر من هذا الموقع'
+        item: 'مادة'
+        point_search: 'عرض العناصر من هذا الموقع'
+        search_ctrl_cue: 'ابحث عن جميع العناصر داخل نافذة الخريطة الحالية'
+      title: 'خريطة'
+      leader_html: "انقر فوق علامة للبحث عن عناصر من هذا الموقع ، أو استخدم الزر للبحث عن جميع العناصر الموجودة في نافذة الخريطة الحالية."
+
+    search:
+      filters:
+        coordinates:
+          bbox: 'المربع المحيط'
+          point: 'إحداثيات'
+      view:
+        maps: 'خريطة'
+

data/config/locales/blacklight-maps.de.yml

@@ -0,0 +1,21 @@
+de:
+  blacklight:
+
+    maps:
+      interactions:
+        bbox_search: 'Zeigen Sie Elemente an, die sich mit diesem Begrenzungsrahmen überschneiden'
+        placename_search: 'Zeigen Sie Elemente von diesem Speicherort aus an'
+        item: 'Artikel'
+        point_search: 'Zeigen Sie Elemente von diesem Speicherort aus an'
+        search_ctrl_cue: 'Suchen Sie nach allen Elementen im aktuellen Kartenfenster'
+      title: 'Karte'
+      leader_html: "Klicken Sie auf eine Markierung, um nach Elementen von diesem Ort aus zu suchen, oder verwenden Sie die 🔍 Schaltfläche, um nach allen Elementen im aktuellen Kartenfenster zu suchen."
+
+    search:
+      filters:
+        coordinates:
+          bbox: 'Begrenzungsrahmen'
+          point: 'Koordinaten'
+      view:
+        maps: 'Karte'
+

data/config/locales/blacklight-maps.en.yml

@@ -9,7 +9,7 @@ en:
         point_search: 'View items from this location'
         search_ctrl_cue: 'Search for all items within the current map window'
       title: 'Map'
-      leader: 'Click on a marker to search for items from that location.'
+      leader_html: "Click on a marker to search for items from that location, or use the 🔍 button to search for all items within the current map window."
 
     search:
       filters:

data/config/locales/blacklight-maps.es.yml

@@ -0,0 +1,21 @@
+es:
+  blacklight:
+
+    maps:
+      interactions:
+        bbox_search: 'Ver elementos que se cruzan con este cuadro delimitador'
+        placename_search: 'Ver elementos desde esta ubicación'
+        item: 'articulo'
+        point_search: 'Ver elementos desde esta ubicación'
+        search_ctrl_cue: 'Buscar todos los elementos dentro de la ventana del mapa actual'
+      title: 'Mapa'
+      leader_html: "Haga clic en un marcador para buscar elementos desde esa ubicación, o use el 🔍 botón para buscar todos los elementos dentro de la ventana del mapa actual."
+
+    search:
+      filters:
+        coordinates:
+          bbox: 'Cuadro delimitador'
+          point: 'Coordenadas'
+      view:
+        maps: 'Mapa'
+

data/config/locales/blacklight-maps.fr.yml

@@ -3,18 +3,18 @@ fr:
 
     maps:
       interactions:
-        bbox_search: 'View items that intersect with this bounding box'
-        placename_search: 'View items from this location'
-        item: 'item'
-        point_search: 'View items from this location'
-        search_ctrl_cue: 'Search for all items within the current map window'
+        bbox_search: 'Afficher les éléments qui coupent avec ce cadre de sélection'
+        placename_search: 'Afficher les éléments de cet emplacement'
+        item: 'article'
+        point_search: 'Afficher les éléments de cet emplacement'
+        search_ctrl_cue: 'Rechercher tous les éléments dans la fenêtre de carte actuelle'
       title: 'Carte'
-      leader: 'Click on a marker to search for items from that location.'
+      leader: 'Cliquez sur un marqueur pour rechercher des éléments à partir de cet emplacement, ou utilisez le 🔍 pour rechercher tous les éléments dans la fenêtre de carte actuelle.'
 
     search:
       filters:
         coordinates:
-          bbox: 'Bounding Box'
-          point: 'Coordinates'
+          bbox: 'Boîte de délimitation'
+          point: 'Coordonnés'
       view:
         maps: 'Carte'

data/config/locales/blacklight-maps.hu.yml

@@ -0,0 +1,21 @@
+hu:
+  blacklight:
+
+    maps:
+      interactions:
+        bbox_search: 'Tekintse meg azokat az elemeket, amelyek keresztezik ezt a határolódobozt'
+        placename_search: 'Tekintse meg az ezen a helyen található elemeket'
+        item: 'tétel'
+        point_search: 'Tekintse meg az ezen a helyen található elemeket'
+        search_ctrl_cue: 'Az összes elem keresése az aktuális térkép ablakban'
+      title: 'Térkép'
+      leader_html: "Kattintson a jelölőre az adott helyről elemek kereséséhez, vagy használja a 🔍 gombot az összes elem kereséséhez az aktuális térkép ablakban."
+
+    search:
+      filters:
+        coordinates:
+          bbox: 'Határoló doboz'
+          point: 'Koordináták'
+      view:
+        maps: 'Térkép'
+

data/config/locales/blacklight-maps.it.yml

@@ -3,18 +3,18 @@ it:
 
     maps:
       interactions:
-        bbox_search: 'View items that intersect with this bounding box'
-        placename_search: 'View items from this location'
-        item: 'item'
-        point_search: 'View items from this location'
-        search_ctrl_cue: 'Search for all items within the current map window'
+        bbox_search: 'Visualizza gli elementi che si intersecano con questo rettangolo di selezione'
+        placename_search: 'Visualizza articoli da questa posizione'
+        item: 'articolo'
+        point_search: 'Visualizza articoli da questa posizione'
+        search_ctrl_cue: 'Cerca tutti gli elementi nella finestra della mappa corrente'
       title: 'Mappa'
-      leader: 'Click on a marker to search for items from that location.'
+      leader: 'Fai clic su un marcatore per cercare elementi da quella posizione oppure usa 🔍 per cercare tutti gli elementi nella finestra della mappa corrente.'
 
     search:
       filters:
         coordinates:
-          bbox: 'Bounding Box'
-          point: 'Coordinates'
+          bbox: 'Rettangolo di selezione'
+          point: 'Coordinate'
       view:
         maps: 'Mappa'