blacklight-maps 0.2.0 → 0.3.0

data/app/assets/stylesheets/blacklight_maps/blacklight-maps.css.scss

@@ -1,4 +1,8 @@
 /* Master manifest file for engine, so local app can require
  * this one file, but get all our files -- and local app
  * require does not need to change if we change file list. 
- */
+ */
+
+@charset "UTF-8";
+
+@import 'default';

data/app/assets/stylesheets/blacklight_maps/default.css.scss

@@ -1,27 +1,89 @@
 @import 'leaflet';
 @import 'leaflet.markercluster';
 @import 'leaflet.markercluster.default';
-@import 'L.Control.Sidebar';
+
+body.blacklight-catalog-map {
+
+  #map_leader_text {
+    margin-bottom: 10px;
+  }
+
+  .view-type {
+    display:none;
+  }
+
+}
 
 .view-icon-maps {
   &:before { content: "\e135"; } 
 }
 
-#blacklight-map{
-  height: 550px;
+#sortAndPerPage {
+
+  .page_links {
+
+    .mapped-count {
+      margin-left: 7px;
+      color: dimgray;
+    }
+
+    .mapped-caveat {
+      margin-left: 7px;
+      font-size: 12px;
+      color: darkgray;
+    }
+
+  }
+
+}
+
+#documents {
+
+  #blacklight-index-map {
+    height: 550px;
+    margin: 10px 0;
+
+    & ~ div.record-padding {
+
+      div.pagination {
+        display: none;
+      }
+
+    }
+
+  }
+
+}
+
+#document #blacklight-show-map {
+  height: 300px;
 }
 
-.badge.mapped-count {
-  margin-left: 8px;
+.mapped-count .badge {
   vertical-align: text-bottom;
 }
 
-.sidebar-thumb{
-  height: 64px;
-  width: 64px;
+a.leaflet-bar-part.search-control {
+  cursor: pointer;
+}
+
+/* Portrait tablet to landscape and desktop */
+@media (min-width: 768px) and (max-width: 991px) {
+
+  #sortAndPerPage {
+
+    .page_links {
+      width: 75%;
+      padding: 0 12px 0 0;
+
+      .mapped-caveat {
+        margin-left: 0;
+        float: left;
+      }
+
+    }
+
+  }
+
 }
 
-.sidebar-list{
-  padding-left: 0;
-  list-style: none;
-}

data/app/helpers/blacklight/blacklight_maps_helper_behavior.rb

@@ -0,0 +1,125 @@
+module Blacklight::BlacklightMapsHelperBehavior
+
+  # @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)
+    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'),
+            catalog_index_path(spatial_search_type: "bbox",
+                               coordinates: "[#{coords_for_search[1]},#{coords_for_search[0]} TO #{coords_for_search[3]},#{coords_for_search[2]}]"))
+  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 = add_facet_params(field, field_value)
+    end
+    link_to(displayvalue.presence || field_value,
+            catalog_index_path(new_params.except(:view, :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]}"
+    link_to(t('blacklight.maps.interactions.point_search'), catalog_index_path(new_params))
+  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
+
+  # return an array of Blacklight::SolrResponse::Facets::FacetItem items
+  def map_facet_values
+    if @response.facet_by_field_name(map_facet_field)
+      @response.facet_by_field_name(map_facet_field).items
+    else
+      []
+    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 map for #index and #map views
+  def render_index_map
+    render :partial => 'catalog/index_map',
+           :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)
+    end
+  end
+
+  # pass the document or facet values to BlacklightMaps::GeojsonExport
+  def serialize_geojson(documents)
+    export = BlacklightMaps::GeojsonExport.new(controller,
+                                               controller.action_name,
+                                               documents)
+    export.to_geojson
+  end
+
+  # determine the best viewpoint for the map so all markers are visible
+  def set_viewpoint(geojson_features)
+    viewpoint = nil
+    geojson_docs = JSON.parse(geojson_features)["features"]
+    if !geojson_docs.blank?
+      if geojson_docs.length == 1
+        viewpoint = geojson_docs[0]["bbox"] ? nil : geojson_docs[0]["geometry"]["coordinates"].reverse
+      end
+      if geojson_docs.length > 1 || !viewpoint
+        longs, lats = [[],[]]
+        geojson_docs.each do |feature|
+          if feature["bbox"]
+            feature["bbox"].values_at(0,2).each {|long| longs << long }
+            feature["bbox"].values_at(1,3).each {|lat| lats << lat }
+          else
+            longs << feature["geometry"]["coordinates"][0]
+            lats << feature["geometry"]["coordinates"][1]
+          end
+        end
+        sorted_longs, sorted_lats = longs.sort, lats.sort
+        viewpoint = [[sorted_lats.first,sorted_longs.first],[sorted_lats.last,sorted_longs.last]]
+      end
+    end
+    viewpoint = [0,0] if !viewpoint
+    viewpoint
+  end
+
+end

data/app/helpers/blacklight_maps_helper.rb

@@ -1,26 +1,3 @@
-# Helper methods used for Blacklight Maps
 module BlacklightMapsHelper
-  # @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,
-      type: blacklight_config.view.maps.type,
-      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)
-    end
-  end
-
-  def serialize_geojson
-    export = BlacklightMaps::GeojsonExport.new(controller,
-                                               @response.docs)
-    export.to_geojson
-  end
+  include Blacklight::BlacklightMapsHelperBehavior
 end

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

@@ -1,6 +1,4 @@
 <% # container for all documents in map view -%>
 <div id="documents" class="map">
-  <%= blacklight_map_tag('blacklight-map') %>
-  <div id="blacklight-map-sidebar"></div>
-  <%= javascript_tag "$('#blacklight-map').blacklight_leaflet_map(#{serialize_geojson});" %>
+  <%= render_index_map %>
 </div>

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

@@ -0,0 +1,7 @@
+<%= blacklight_map_tag('blacklight-index-map',
+                       {data:{viewpoint: set_viewpoint(geojson_features),
+                              searchcontrol: true,
+                              catalogpath: catalog_index_path,
+                              placenamefield: blacklight_config.view.maps.placename_field
+                       }}) %>
+<%= javascript_tag "$('#blacklight-index-map').blacklight_leaflet_map(#{geojson_features});" %>

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

@@ -0,0 +1,8 @@
+<% # content for the popup for a point feature - run a new search for this location -%>
+<h5 class="geo_popup_heading">
+  <%= render_placename_heading(geojson_hash) %>
+  <%= content_tag(:small, pluralize(hits, t('blacklight.maps.interactions.item'))) if hits %>
+</h5>
+<%= link_to_placename_field(placename_value(geojson_hash),
+                            blacklight_config.view.maps.placename_field,
+                            t('blacklight.maps.interactions.placename_search')) %>

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

@@ -0,0 +1,6 @@
+<% # content for the popup for a point or bbox feature - run a new coordinate search for this location -%>
+<h5 class="geo_popup_heading">
+  <%= coordinates.length == 2 ? coordinates.reverse : coordinates %>
+  <%= content_tag(:small, pluralize(hits, t('blacklight.maps.interactions.item'))) if hits %>
+</h5>
+<%= render_spatial_search_link(coordinates) %>

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

@@ -0,0 +1,11 @@
+<% # 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:{viewpoint: set_viewpoint(geojson_features),
+                                      initialzoom:blacklight_config.view.maps.show_initial_zoom,
+                                      singlemarkermode:false}}) %>
+        <%= javascript_tag "$('#blacklight-show-map').blacklight_leaflet_map(#{geojson_features});" %>
+    <% end %>
+</div>

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

@@ -0,0 +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>
+  <%= 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) %>

data/blacklight-maps.gemspec

@@ -22,11 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bootstrap-sass", "~> 3.0"
   spec.add_dependency "leaflet-rails"
   spec.add_dependency "leaflet-markercluster-rails"
-  spec.add_dependency "leaflet-sidebar-rails", "~> 0.0.2"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec-rails", "~> 2.9"
+  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"

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

@@ -1,5 +1,21 @@
 en:
   blacklight:
+
+    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'
+      title: 'Map'
+      leader: 'Click on a marker to search for items from that location.'
+
     search:
+      filters:
+        coordinates:
+          bbox: 'Bounding Box'
+          point: 'Coordinates'
       view:
-        maps: "Map"
+        maps: 'Map'
+

data/config/routes.rb

@@ -1,4 +1,4 @@
-Blacklight::Maps::Engine.routes.draw do
-
+Rails.application.routes.draw do
+  get 'map', :to => 'catalog#map', :as => 'map'
 end
 

data/lib/blacklight/maps.rb

@@ -2,8 +2,24 @@ require "blacklight/maps/version"
 
 module Blacklight
   module Maps
+    require 'blacklight/maps/controller_override'
+    require 'blacklight/maps/render_constraints_override'
     require 'blacklight/maps/engine'
     require 'blacklight/maps/export'
     require 'blacklight/maps/geometry'
+
+    def self.inject!
+      CatalogController.send(:include, BlacklightMaps::ControllerOverride)
+      CatalogController.send(:include, BlacklightMaps::RenderConstraintsOverride)
+      CatalogController.send(:helper, BlacklightMaps::RenderConstraintsOverride) unless
+          CatalogController.helpers.is_a?(BlacklightMaps::RenderConstraintsOverride)
+
+      # inject into SearchHistory and SavedSearches so spatial queries display properly
+      SearchHistoryController.send(:helper, BlacklightMaps::RenderConstraintsOverride) unless
+          SearchHistoryController.helpers.is_a?(BlacklightMaps::RenderConstraintsOverride)
+      SavedSearchesController.send(:helper, BlacklightMaps::RenderConstraintsOverride) unless
+          SavedSearchesController.helpers.is_a?(BlacklightMaps::RenderConstraintsOverride)
+    end
+
   end
 end

data/lib/blacklight/maps/controller_override.rb

@@ -0,0 +1,33 @@
+module BlacklightMaps
+  module ControllerOverride
+    extend ActiveSupport::Concern
+    included do
+      solr_search_params_logic << :add_spatial_search_to_solr
+    end
+
+    def map
+      (@response, @document_list) = get_search_results
+      params[:view] = 'maps'
+      respond_to do |format|
+        format.html
+      end
+    end
+
+    # add spatial search params to solr
+    def add_spatial_search_to_solr(solr_parameters, user_parameters)
+      if user_parameters[:spatial_search_type] && user_parameters[:coordinates]
+        solr_parameters[:fq] ||= []
+        if user_parameters[:spatial_search_type] == 'bbox'
+          solr_parameters[:fq] << blacklight_config.view.maps.coordinates_field + ":" + user_parameters[:coordinates]
+        else
+          solr_parameters[:fq] << "{!geofilt sfield=#{blacklight_config.view.maps.coordinates_field}}"
+          solr_parameters[:pt] = user_parameters[:coordinates]
+          solr_parameters[:d] = blacklight_config.view.maps.spatial_query_dist
+        end
+      end
+      solr_parameters
+    end
+
+  end
+
+end

data/lib/blacklight/maps/engine.rb

@@ -1,25 +1,33 @@
 require 'blacklight'
 require 'leaflet-rails'
 require 'leaflet-markercluster-rails'
-require 'leaflet-sidebar-rails'
 
 module Blacklight
   module Maps
     class Engine < Rails::Engine
       # Set some default configurations
-      Blacklight::Configuration.default_values[:view].maps.type = 'bbox'
-      Blacklight::Configuration.default_values[:view].maps.bbox_field = 'place_bbox'
-      Blacklight::Configuration.default_values[:view].maps.placename_coord_field = 'placename_coords'
+      Blacklight::Configuration.default_values[:view].maps.geojson_field = "geojson"
+      Blacklight::Configuration.default_values[:view].maps.placename_property = "placename"
+      Blacklight::Configuration.default_values[:view].maps.coordinates_field = "coordinates"
+      Blacklight::Configuration.default_values[:view].maps.search_mode = "placename" # or 'coordinates'
+      Blacklight::Configuration.default_values[:view].maps.spatial_query_dist = 0.5
+      Blacklight::Configuration.default_values[:view].maps.placename_field = "placename_field"
+      Blacklight::Configuration.default_values[:view].maps.coordinates_facet_field = "coordinates_facet_field"
+      Blacklight::Configuration.default_values[:view].maps.facet_mode = "geojson" # or 'coordinates'
       Blacklight::Configuration.default_values[:view].maps.tileurl = "http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
       Blacklight::Configuration.default_values[:view].maps.mapattribution = 'Map data &copy; <a href="http://openstreetmap.org">OpenStreetMap</a> contributors, <a href="http://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>'
-      Blacklight::Configuration.default_values[:view].maps.maxzoom = 8
-      Blacklight::Configuration.default_values[:view].maps.placename_coord_delimiter = '-|-'
+      Blacklight::Configuration.default_values[:view].maps.maxzoom = 18
+      Blacklight::Configuration.default_values[:view].maps.show_initial_zoom = 5
 
       # Add our helpers
       initializer 'blacklight-maps.helpers' do |app|
         ActionView::Base.send :include, BlacklightMapsHelper
       end
 
+      config.to_prepare do
+        Blacklight::Maps.inject!
+      end
+
       # This makes our rake tasks visible.
       rake_tasks do
         Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))) do