blacklight-maps 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e35e471feb601eeeec9355dc1cc7e31d158f03bb
+  data.tar.gz: 8be5024c30a03decfb0e15563f79117606be1fec
+SHA512:
+  metadata.gz: b019eae752da2b6cc576a759b09abb1d7799748c82603b0d13f20990f592e0ad51b35785abb6dda9370d5cbbd477c506ee26db9f73ae2cfa8aa7380ea584c707
+  data.tar.gz: a999abc043657b6f52ae34f1ce6d5479491b49812e2fa87b93257a3173de069a4e237d09e4cfb53869849d939803554842a918aec59e78c182d94be3d02f787b

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/internal
+jetty
+.DS_Store

data/.travis.yml

@@ -0,0 +1,18 @@
+notifications:
+  email: false
+
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+
+notifications:
+  irc: "irc.freenode.org#blacklight"
+  email:
+      - blacklight-commits@googlegroups.com
+
+env:
+  global:
+    - JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blacklight-maps.gemspec
+gemspec
+
+gem 'simplecov', require: false
+gem 'coveralls', require: false
+
+gem 'engine_cart', git: 'https://github.com/cbeer/engine_cart'
+
+
+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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2014 The Board of Trustees of the Leland Stanford Junior University.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,81 @@
+# Blacklight::Maps
+
+[![Build Status](https://travis-ci.org/sul-dlss/blacklight-maps.png?branch=master)](https://travis-ci.org/sul-dlss/blacklight-maps)
+
+Provides a map view for Blacklight search results.
+
+![Screen shot](docs/map-view.png)
+![Screen shot](docs/map-sidebar.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blacklight-maps'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blacklight-maps
+
+## Usage
+
+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.
+
+A document requires the following field:
+```  
+  placename_coords:
+    - 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.
+
+### Configuration
+
+#### Required
+Blacklight-Maps expects you to provide:
+
+- a field to map the placename coordinates (`placename_coords` in the example above)
+
+#### 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
+
+
+All of these options can easily be configured in `CatalogController.rb` in the `config` block.
+
+```
+...
+  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 = { 
+      :qt   => 'search',
+      :rows => 10,
+      :fl   => '*'
+    }
+
+    ## Default values
+    config.view.maps.placename_coords_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>'
+...
+
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/blacklight-maps/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,43 @@
+require "bundler/gem_tasks"
+
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.6.0.zip"
+APP_ROOT = File.dirname(__FILE__)
+
+require 'rspec/core/rake_task'
+require 'engine_cart/rake_task'
+
+require 'jettywrapper'
+
+task default: :ci
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Load fixtures"
+task :fixtures => ['engine_cart:generate'] do
+  EngineCart.within_test_app do
+    system "rake blacklight_maps:solr:seed RAILS_ENV=test"
+  end
+end
+
+desc "Execute Continuous Integration build"
+task :ci => ['engine_cart:generate', 'jetty:clean', 'blacklight_maps:configure_jetty'] do
+
+  require 'jettywrapper'
+  jetty_params = Jettywrapper.load_config('test')
+
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task['fixtures'].invoke
+    Rake::Task['spec'].invoke
+  end
+  raise "test failures: #{error}" if error
+end
+
+
+namespace :blacklight_maps do
+  desc "Copies the default SOLR config for the bundled Testing Server"
+  task :configure_jetty do
+    FileList['solr_conf/conf/*'].each do |f|  
+      cp("#{f}", 'jetty/solr/blacklight-core/conf/', :verbose => true)
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+// for Blacklight.onLoad:
+//= require blacklight/core
+
+//= require leaflet
+//= require leaflet.markercluster
+//= require L.Control.Sidebar
+
+//= require_tree './blacklight-maps'

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

@@ -0,0 +1,141 @@
+var map, sidebar;
+
+Blacklight.onLoad(function() {
+
+  // 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();
+        }
+        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 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();
+    }
+
+    //if map is at the lowest zoom level
+    if (map.getZoom() === Blacklight.mapOptions.maxzoom){
+
+      var placenames = generatePlacenamesObject(e.layer._markers);
+      
+
+      offsetMap(e);
+
+      //Update sidebar div with new html
+      $('#blacklight-map-sidebar').html(buildList(placenames));
+
+      //Show the sidebar!
+      sidebar.show();
+    }
+  });
+
+  //Add click listener to map
+  map.on('click', function(e){
+
+    //hide the sidebar if it is visible
+    if (sidebar.isVisible()){
+      sidebar.hide();
+    }
+  });
+
+  //drag listener on map
+  map.on('drag', function(e){
+
+    //hide the sidebar if it is visible
+    if (sidebar.isVisible()){
+      sidebar.hide();
+    }
+  });
+
+});
+
+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] = [];
+    }
+    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]);
+  }
+}

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

@@ -0,0 +1,4 @@
+/* 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. 
+ */

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

@@ -0,0 +1,24 @@
+/*
+*= require leaflet
+*= require leaflet.markercluster
+*= require leaflet.markercluster.default
+*= require L.Control.Sidebar.css
+*/
+
+.view-icon-maps {
+  &:before { content: "\e135"; } 
+}
+
+#blacklight-map{
+  height: 550px;
+}
+
+.sidebar-thumb{
+  height: 64px;
+  width: 64px;
+}
+
+.sidebar-list{
+  padding-left: 0;
+  list-style: none;
+}

data/app/helpers/blacklight_maps_helper.rb

@@ -0,0 +1,36 @@
+module BlacklightMapsHelper
+    
+    def show_map_div
+      data_attributes = {
+          :maxzoom => blacklight_config.view.maps.maxzoom,
+          :tileurl => blacklight_config.view.maps.tileurl
+          
+        }
+
+      content_tag(:div, "", id: "blacklight-map",
+        data: data_attributes
+      )
+    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

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

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

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

@@ -0,0 +1,9 @@
+<% # the way each document will be viewed in the sidebar list -%>
+<li class='media'>
+  <%= render_thumbnail_tag document, {class: 'sidebar-thumb media-object'}, {class: 'pull-left'} %>
+  <div class='media-body'>
+    <h4 class='media-heading'>
+      <%= link_to_document document, :label=>document_show_link_field(document) %>
+    </h4>
+  </div>
+</li>