blacklight-maps 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e35e471feb601eeeec9355dc1cc7e31d158f03bb
-  data.tar.gz: 8be5024c30a03decfb0e15563f79117606be1fec
+  metadata.gz: f5cede804f84631bbe7ec2c80370c8f0cbf88c31
+  data.tar.gz: 853cd08e29850b439c5d7773c48118b835216d28
 SHA512:
-  metadata.gz: b019eae752da2b6cc576a759b09abb1d7799748c82603b0d13f20990f592e0ad51b35785abb6dda9370d5cbbd477c506ee26db9f73ae2cfa8aa7380ea584c707
-  data.tar.gz: a999abc043657b6f52ae34f1ce6d5479491b49812e2fa87b93257a3173de069a4e237d09e4cfb53869849d939803554842a918aec59e78c182d94be3d02f787b
+  metadata.gz: 4181770fa39430c201156ab3b9d83cffc0208a58c530e6209fea4d5f4ce56b3e52d04ee7a49059be6cd84ae65208589afdc00f6e80de51a082652b1f8d33cb9e
+  data.tar.gz: defd9c711b0f083449e952726548532d078b639c822fc606ab4fd3d79f3eaf3abeb5658a022a52041dca3981a2363eecfbb284dcaaa37f534e89d27b5057a0d7

data/.travis.yml

@@ -15,4 +15,8 @@ notifications:
 env:
   global:
     - JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode

data/Gemfile

@@ -6,11 +6,19 @@ gemspec
 gem 'simplecov', require: false
 gem 'coveralls', require: false
 
-gem 'engine_cart', git: 'https://github.com/cbeer/engine_cart'
+# If we don't specify 2.11.0 we'll end up with sprockets 2.12.0 in the main
+# Gemfile.lock but since sass-rails gets generated (rails new) into the test app
+# it'll want sprockets 2.11.0 and we'll have a conflict
+gem 'sprockets', '2.11.0'
+
+# # If we don't specify 3.2.15 we'll end up with sass 3.3.2 in the main
+# # Gemfile.lock but since sass-rails gets generated (rails new) into the test app
+# # it'll want sass 3.2.0 and we'll have a conflict
+gem 'sass', '~> 3.2.0'
 
 
 file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
 if File.exists?(file)
   puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
   instance_eval File.read(file)
-end
+end

data/README.md

@@ -25,14 +25,20 @@ Or install it yourself as:
 
 Blacklight-Maps adds a map view capability for a results set that contains geospatial coordinates (latitude/longitude).
 
-For now, Blacklight-Maps requires that your SOLR index includes a field containing placenames with latitude and longitude coordinates delimited by `|`.  This field can be multivalued.
+For now, Blacklight-Maps requires that your Solr index include one of the following two types of fields:
 
-A document requires the following field:
+1. A `location_rpt` field that contains a bounding box for the document.  For more on `location_rpt` see [Solr help](https://cwiki.apache.org/confluence/display/solr/Spatial+Search). This field can be multivalued.
+```
+  place_bbox: 44.0318907 25.0594286 63.3333366 39.7816755
+              # minX minY maxX maxY
+```
+
+2. A field containing placenames with latitude and longitude coordinates delimited by `-|-`. The delimiter can be configured in `app/controllers/catalog_controller.rb`.  This field can be multivalued.
 ```  
   placename_coords:
-    - China|35.86166|104.195397
-    - Tibet|29.646923|91.117212
-    - India|20.593684|78.96288
+    - China-|-35.86166-|-104.195397
+    - Tibet-|-29.646923-|-91.117212
+    - India-|-20.593684-|-78.96288
 ```
 
 Note: We are looking at implementing support for additional fields.
@@ -42,14 +48,15 @@ Note: We are looking at implementing support for additional fields.
 #### Required
 Blacklight-Maps expects you to provide:
 
-- a field to map the placename coordinates (`placename_coords` in the example above)
+- the type of location field you are using, `placename_coord` or `bbox` (`bbox` is default)
+- a field to map the placename coordinates or bbox field
 
 #### Optional
 
 - the maxZoom [property of the map](http://leafletjs.com/reference.html#map-maxzoom)
 - a [tileLayer url](http://leafletjs.com/reference.html#tilelayer-l.tilelayer) to change the basemap
 - an [attribution string](http://leafletjs.com/reference.html#tilelayer-attribution) to describe the basemap layer
-
+- a custom delimiter field (used to delimit placename_coord values)
 
 All of these options can easily be configured in `CatalogController.rb` in the `config` block.
 
@@ -57,16 +64,19 @@ All of these options can easily be configured in `CatalogController.rb` in the `
 ...
   configure_blacklight do |config|
     ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
-    config.default_solr_params = { 
+    config.default_solr_params = {
       :qt   => 'search',
       :rows => 10,
       :fl   => '*'
     }
 
     ## Default values
-    config.view.maps.placename_coords_field = "placename_coords"
+    config.view.maps.type = "bbox" # also accepts 'placename_coord' to use the placename coordinate type
+    config.view.maps.bbox_field = "place_bbox"
+    config.view.maps.placename_coord_field = "placename_coords"
     config.view.maps.tileurl = "http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
     config.view.maps.attribution = '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>'
+    config.view.maps.placename_coord_delimiter = '-|-'
 ...
 
 ```

data/app/assets/javascripts/blacklight-maps/blacklight-maps-browse.js

@@ -1,141 +1,152 @@
-var map, sidebar;
+;(function( $ ) {
+
+  $.fn.blacklight_leaflet_map = function(geojson_docs, arg_opts) {
+    var map, sidebar, markers, geoJsonLayer, currentLayer;
+
+    // Configure default options and those passed via the constructor options
+    var options = $.extend({
+      tileurl : 'http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
+      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>',
+      sidebar: 'blacklight-map-sidebar'
+    }, arg_opts );
+
+    // Extend options from data-attributes
+    $.extend(options, this.data());
+
+    // Display the map
+    this.each(function() {
+      options.id = this.id;
+
+      // Setup Leaflet map
+      map = L.map(this.id).setView([0,0], 2);
+      L.tileLayer(options.tileurl, {
+        attribution: options.mapattribution,
+        maxZoom: options.maxzoom
+      }).addTo(map);
+
+      // Initialize sidebar
+      sidebar = L.control.sidebar(options.sidebar, {
+        position: 'right',
+        autoPan: false
+      });
 
-Blacklight.onLoad(function() {
+      // Adds leaflet-sidebar control to map
+      map.addControl(sidebar);
 
-  // Stop doing stuff if the map div isn't there
-  if ($("#blacklight-map").length === 0){
-    return;
-  }
-  
-  // Get the configuration options from the data-attributes
-  $.extend(Blacklight.mapOptions, $("#blacklight-map").data());
-
-  map = L.map('blacklight-map').setView([0,0], 2);
-  L.tileLayer(Blacklight.mapOptions.tileurl, {
-    attribution: Blacklight.mapOptions.mapattribution,
-    maxZoom: Blacklight.mapOptions.maxzoom
-  }).addTo(map);
-
-  // Sets up leaflet-sidebar
-  sidebar = L.control.sidebar('blacklight-map-sidebar', {
-    position: 'right',
-    autoPan: false
-  });
-
-  // Adds leaflet-sidebar control to map (object)
-  map.addControl(sidebar);
-
-  // Create a marker cluster object and set options
-  markers = new L.MarkerClusterGroup({
-    showCoverageOnHover: false,
-    spiderfyOnMaxZoom: false,
-    singleMarkerMode: true,
-    animateAddingMarkers: true
-  });
-
-  geoJsonLayer = L.geoJson(geojson_docs, {
-    onEachFeature: function(feature, layer){
-      layer.defaultOptions.title = feature.properties.placename;
-      layer.on('click', function(e){
-        if (sidebar.isVisible()){
-            sidebar.hide();
+      // Create a marker cluster object and set options
+      markers = new L.MarkerClusterGroup({
+        showCoverageOnHover: false,
+        spiderfyOnMaxZoom: false,
+        singleMarkerMode: true,
+        animateAddingMarkers: true
+      });
+
+      geoJsonLayer = L.geoJson(geojson_docs, {
+        onEachFeature: function(feature, layer){
+          layer.defaultOptions.title = getMapTitle(options.type, feature.properties.name);
+          layer.on('click', function(e){
+            var placenames = {};
+            placenames[layer.defaultOptions.title] = [feature.properties.html];
+            setupSidebarDisplay(e,placenames);
+          });
         }
-        var placenames = {};
-        placenames[feature.properties.placename] = [feature.properties.html];
-        offsetMap(e);
-        $('#blacklight-map-sidebar').html(buildList(placenames));
-        sidebar.show();
       });
-    }
-  });
 
-  // Add GeoJSON layer to marker cluster object
-  markers.addLayer(geoJsonLayer);
+      // Add GeoJSON layer to marker cluster object
+      markers.addLayer(geoJsonLayer);
 
-  // Add marker cluster object to map
-  map.addLayer(markers);
+      // Add marker cluster object to map
+      map.addLayer(markers);
 
-  // Listeners for marker cluster clicks
-  markers.on('clusterclick', function(e){
-      
-    //hide sidebar if it is visible
-    if (sidebar.isVisible()){
-      sidebar.hide();
-    }
+      // Listeners for marker cluster clicks
+      markers.on('clusterclick', function(e){
+        hideSidebar();
 
-    //if map is at the lowest zoom level
-    if (map.getZoom() === Blacklight.mapOptions.maxzoom){
+        //if map is at the lowest zoom level
+        if (map.getZoom() === options.maxzoom){
 
-      var placenames = generatePlacenamesObject(e.layer._markers);
-      
+          var placenames = generatePlacenamesObject(e.layer.getAllChildMarkers());
+          setupSidebarDisplay(e,placenames);
+        }
+      });
+
+      //Add click listener to map
+      map.on('click drag', hideSidebar);
+
+    });
 
+    function setupSidebarDisplay(e, placenames){
+      hideSidebar();
       offsetMap(e);
+      if (currentLayer !== e.layer || !("layer" in e)){
+        // Update sidebar div with new html
+        $('#' + options.sidebar).html(buildList(placenames));
 
-      //Update sidebar div with new html
-      $('#blacklight-map-sidebar').html(buildList(placenames));
+        // Scroll sidebar div to top
+        $('#' + options.sidebar).scrollTop(0);
+        currentLayer = e.layer;
+      }
 
-      //Show the sidebar!
+      // Show the sidebar
       sidebar.show();
+
     }
-  });
 
-  //Add click listener to map
-  map.on('click', function(e){
+    // Hides sidebar if it is visible
+    function hideSidebar(){
+      if (sidebar.isVisible()){
+        sidebar.hide();
+      }
+    }
 
-    //hide the sidebar if it is visible
-    if (sidebar.isVisible()){
-      sidebar.hide();
+    // Build the list
+    function buildList(placenames){
+      var html = "";
+      $.each(placenames, function(i,val){
+        html += "<h2>" + i + "</h2>";
+        html += "<ul class='sidebar-list'>";
+        $.each(val, function(j, val2){
+          html += val2;
+        });
+        html += "</ul>";
+      });
+      return html;
     }
-  });
 
-  //drag listener on map
-  map.on('drag', function(e){
+    // Generates placenames object
+    function generatePlacenamesObject(markers){
+      var placenames = {};
+      $.each(markers, function(i,val){
+        if (!(val.defaultOptions.title in placenames)){
+          placenames[val.defaultOptions.title] = [];
+        }
+        placenames[val.defaultOptions.title].push(val.feature.properties.html);
+      });
+      return placenames;
+    }
 
-    //hide the sidebar if it is visible
-    if (sidebar.isVisible()){
-      sidebar.hide();
+    // Move the map so that it centers the clicked cluster TODO account for various size screens
+    function offsetMap(e){
+      var mapWidth = $('#' + options.id).width();
+      var mapHeight = $('#' + options.id).height();
+      if (!e.latlng.equals(map.getCenter())){
+        map.panBy([(e.originalEvent.layerX - (mapWidth/4)), (e.originalEvent.layerY - (mapHeight/2))]);
+      }else{
+        map.panBy([(mapWidth/4), 0]);
+      }
     }
-  });
-
-});
-
-Blacklight.mapOptions = {
-  tileurl : 'http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
-  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>'
-};
-
-function buildList(placenames){
-  var html = "";
-  $.each(placenames, function(i,val){
-    html += "<h2>" + i + "</h2>";
-    html += "<ul class='sidebar-list'>";
-    $.each(val, function(j, val2){
-      html += val2;
-    });
-    html += "</ul>";
-  });
-  return html;
-}
-
-// Generates placenames object 
-function generatePlacenamesObject(markers){
-  var placenames = {};
-  $.each(markers, function(i,val){
-    if (!(val.feature.properties.placename in placenames)){
-      placenames[val.feature.properties.placename] = [];
+
+  };
+
+  function getMapTitle(type, featureName){
+    switch(type){
+    case 'bbox':
+      return 'Results';
+    case 'placename_coord':
+      return featureName;
+    default:
+      return 'Results';
     }
-    placenames[val.feature.properties.placename].push(val.feature.properties.html);
-  });
-  return placenames;
-}
-
-// Move the map so that it centers the clicked cluster TODO account for various size screens
-function offsetMap(e){
-  mapWidth = $('#blacklight-map').width();
-  mapHeight = $('#blacklight-map').height();
-  if (!e.latlng.equals(map.getCenter())){
-    map.panBy([(e.originalEvent.layerX - (mapWidth/4)), (e.originalEvent.layerY - (mapHeight/2))]);
-  }else{
-    map.panBy([(mapWidth/4), 0]);
   }
-}
+
+}( jQuery ));

data/app/helpers/blacklight_maps_helper.rb

@@ -1,36 +1,26 @@
+# Helper methods used for Blacklight Maps
 module BlacklightMapsHelper
-    
-    def show_map_div
-      data_attributes = {
-          :maxzoom => blacklight_config.view.maps.maxzoom,
-          :tileurl => blacklight_config.view.maps.tileurl
-          
-        }
+  # @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
+    }
 
-      content_tag(:div, "", id: "blacklight-map",
-        data: data_attributes
-      )
+    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
-      geojson_docs = {type: "FeatureCollection", features: []}
-      @response.docs.each_with_index do |doc, counter|
-        if doc[blacklight_config.view.maps.placename_coord_field]
-          doc[blacklight_config.view.maps.placename_coord_field].each do |loc|
-            values = loc.split('|')
-            feature = {type: "Feature", geometry: {type: "Point",
-                        coordinates: [values[2].to_f, values[1].to_f]},
-                        properties: {placename: values[0],
-                          html: render_leaflet_sidebar_partial(doc)}}
-            geojson_docs[:features].push feature
-          end
-        end
-      end
-      return geojson_docs.to_json
-    end
-
-    def render_leaflet_sidebar_partial(doc)
-      render partial: 'catalog/index_maps', locals: {document: SolrDocument.new(doc)}
-    end
-
-end
+  def serialize_geojson
+    export = BlacklightMaps::GeojsonExport.new(controller,
+                                               @response.docs)
+    export.to_geojson
+  end
+end

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

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