blacklight_heatmaps 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb7c89ff10e6644af8ec6c7ac604b50f7b6e9322
+  data.tar.gz: a9b83bde4dcce36145deb45db7f3a523ae994010
+SHA512:
+  metadata.gz: 63b31f0cb11727db4067c3e0cdb4047b54e0b6126a9f2b32a398f228bfffdc63b0aba90efdb4f4956b57c8df55dd8abd1db912b232b1fbb5119d5566eb63763e
+  data.tar.gz: 1b11f4e59a9166fe570f7e93d3f2b1b7c2199b5a95093be250a1d5214506474766e58226937a26b5a324013ea7ee436dee97a171aeb75325fccc724287243596

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2016 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,56 @@
+# BlacklightHeatmaps
+[![Build Status](https://travis-ci.org/sul-dlss/blacklight_heatmaps.svg?branch=master)](https://travis-ci.org/sul-dlss/blacklight_heatmaps) | [![Coverage Status](https://coveralls.io/repos/github/sul-dlss/blacklight_heatmaps/badge.svg?branch=master)](https://coveralls.io/github/sul-dlss/blacklight_heatmaps?branch=master)
+
+![blacklight_heatmap](https://cloud.githubusercontent.com/assets/1656824/16598401/d0538fce-42cb-11e6-86f8-81fd37ab2abe.gif)
+
+## Features
+ - Configurable heatmaps of result sets
+    - Works with center points and bounding box data
+ - Show page map view
+ - Changeout the basemap to any tile layer
+ - _Really_ fast with large data sets
+    - Utilizes Solr's [facet heatmap](https://issues.apache.org/jira/browse/SOLR-7005) feature to provide snappy results. Tested with an index > 10,000,000 records.
+ - Customizable result view template
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blacklight_heatmaps'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Run the BlacklightMaps installer:
+
+```sh
+rails generate blacklight_heatmaps:install
+```
+
+## Getting started
+
+BlacklightHeatmaps expects your data to be indexed as a [Spatial Recursive Prefix Tree](https://cwiki.apache.org/confluence/display/solr/Spatial+Search#SpatialSearch-RPT) type. The plugin currently supports data indexed in formats:
+
+ - `x y` Syntax. example: "-121.631609 36.688128"
+ - CQL ENVELOPE Syntax (`minX, maxX, maxY, minY`). example: "ENVELOPE(122.934585571, 153.987060547, 45.522888184, 20.422889709)"
+
+Additional formats could be added by extending `BlacklightHeatmaps::GeometryParser`
+
+## Development
+
+Run Solr and Blacklight (with BlacklightMaps) for interactive development:
+
+```sh
+bundle exec rake blacklight_heatmaps:server
+```
+
+Run the test suite
+
+```sh
+bundle exec rake ci
+```

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+load 'tasks/blacklight_heatmaps.rake'
+
+require 'engine_cart/rake_task'
+
+task default: :spec

data/app/assets/javascripts/blacklight_heatmaps/blacklight_heatmaps.js

@@ -0,0 +1,10 @@
+!(function (global) {
+  'use strict';
+
+  var BlacklightHeatmaps = L.Class.extend({
+    statics: {
+      __version__: '0.1.0',
+    },
+  });
+  global.BlacklightHeatmaps = BlacklightHeatmaps;
+}(this));

data/app/assets/javascripts/blacklight_heatmaps/default.js

@@ -0,0 +1,6 @@
+//= require geostats
+//= require leaflet
+//= require L.Control.Sidebar
+//= require leaflet_solr_heatmap
+//= require blacklight_heatmaps/blacklight_heatmaps
+//= require_tree ./viewers

data/app/assets/javascripts/blacklight_heatmaps/viewers/index.js

@@ -0,0 +1,89 @@
+Blacklight.onLoad(function () {
+  'use strict';
+
+  $('[data-index-map]').each(function () {
+    BlacklightHeatmaps.indexView(this, {});
+  });
+});
+
+!(function (global) {
+  'use strict';
+
+  var IndexView = L.Class.extend({
+    options: {},
+
+    initialize: function (el, options) {
+      var _this = this;
+      var $el = $(el);
+      var requestUrl = $el.data().searchUrl + '&format=json';
+      var geometryField = $el.data().geometryField;
+      var template = $el.data().sidebarTemplate;
+      var colorRamp = $el.data().colorRamp;
+
+      var map = L.map($el[0].id).setView([0, 0], 1);
+      var basemap = L.tileLayer($el.data().basemap, {
+        attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://cartodb.com/attributions">CartoDB</a>',
+      }).addTo(map);
+
+      var solrLayer = L.solrHeatmap(requestUrl, {
+        field: geometryField,
+        maxSampleSize: 50,
+        colors: colorRamp,
+      }).addTo(map);
+
+      var sidebar = L.control.sidebar('index-map-sidebar', {
+        position: 'right',
+      });
+
+      map.addControl(sidebar);
+
+      solrLayer.on('click', function (e) {
+        if (!sidebar.isVisible()) {
+          map.setView(e.latlng);
+        } else {
+          var point = map.project(e.latlng);
+          var offset = sidebar.getOffset();
+          var newPoint = L.point(point.x - (offset / 2), point.y);
+          map.setView(map.unproject(newPoint));
+        }
+
+        sidebar.show();
+      });
+
+      solrLayer.on('dataAdded', function (e) {
+        if (e.response && e.response.docs) {
+          var html = '';
+          $.each(e.response.docs, function (i, value) {
+            html += L.Util.template(template, value);
+          });
+
+          sidebar.setContent(html);
+
+          var docCount = e.response.pages.total_count;
+          $('#sortAndPerPage .page_links').html(
+            parseInt(docCount).toLocaleString() + ' ' +
+            _this.pluralize(docCount, 'item') + ' found'
+          );
+        }
+      });
+
+      $(document).on('turbolinks:click', function (e) {
+        e.preventDefault();
+      });
+    },
+
+    pluralize: function (count, word) {
+      switch (count) {
+        case 1:
+          return word;
+        default:
+          return word + 's';
+      }
+    },
+  });
+
+  global.BlacklightHeatmaps.IndexView = IndexView;
+  global.BlacklightHeatmaps.indexView = function (el, options) {
+    return new IndexView(el, options);
+  };
+})(this);

data/app/assets/javascripts/blacklight_heatmaps/viewers/show.js

@@ -0,0 +1,34 @@
+Blacklight.onLoad(function () {
+  'use strict';
+
+  $('[data-show-map]').each(function () {
+    BlacklightHeatmaps.showView(this);
+  });
+});
+
+!(function (global) {
+  'use strict';
+
+  var ShowView = L.Class.extend({
+    options: {},
+
+    initialize: function (el, options) {
+      var $el = $(el);
+      var features = $el.data().features;
+
+      var map = L.map($el[0].id).setView([0, 0], 1);
+      var basemap = L.tileLayer($el.data().basemap, {
+        attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://cartodb.com/attributions">CartoDB</a>',
+      }).addTo(map);
+
+      var features = L.geoJson(features).addTo(map);
+
+      map.fitBounds(features.getBounds());
+    },
+  });
+
+  global.BlacklightHeatmaps.ShowView = ShowView;
+  global.BlacklightHeatmaps.showView = function (el, options) {
+    return new ShowView(el, options);
+  };
+})(this);

data/app/assets/stylesheets/blacklight_heatmaps/default.scss

@@ -0,0 +1,14 @@
+@import 'leaflet';
+@import 'L.Control.Sidebar';
+
+.blacklight-heatmaps-show-map {
+  height: 500px;
+}
+
+.blacklight-heatmaps-index-map {
+  height: 500px;
+}
+
+.view-icon-heatmaps {
+  &:before { content: "\e135"; } 
+}

data/app/controllers/blacklight_heatmaps/application_controller.rb

@@ -0,0 +1,5 @@
+module BlacklightHeatmaps
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/blacklight/maps_helper.rb

@@ -0,0 +1,59 @@
+module Blacklight
+  module MapsHelper
+    ##
+    # Creates a div with needed attributes, used to display the index map
+    # @return String
+    def index_map_div
+      content_tag(
+        :div,
+        nil,
+        class: 'blacklight-heatmaps-index-map',
+        id: 'index-map',
+        data: index_map_data_attributes
+      )
+    end
+
+    ##
+    # The Leaflet template used for constructing the sidebar documents.
+    # Variables from returned docs should be keys within curly braces
+    # e.g. {title_display}
+    # @return String
+    def sidebar_template
+      <<-HTMLTEMPLATE
+      <div class='media'>
+        <div class='media-body'>
+          <h3 class='media-heading'>
+            <a href=\"#{document_path}\"}>
+              {#{blacklight_config.index.title_field}}
+            </a>
+          </h3>
+        </div>
+      </div>
+      HTMLTEMPLATE
+    end
+
+    private
+
+    ##
+    # Document path used for creating client side links to documents from a
+    # template
+    # @return String
+    def document_path
+      "#{search_catalog_path}/{#{blacklight_config.document_unique_id_param}}"
+    end
+
+    ##
+    # Data attributes used in displaying the index map
+    # @return Hash
+    def index_map_data_attributes
+      {
+        index_map: true,
+        basemap: blacklight_config.basemap,
+        search_url: request.url,
+        geometry_field: blacklight_config.geometry_field,
+        sidebar_template: sidebar_template,
+        color_ramp: blacklight_config.view.heatmaps.color_ramp
+      }
+    end
+  end
+end

data/app/models/concerns/blacklight_heatmaps/bounding_box.rb

@@ -0,0 +1,50 @@
+module BlacklightHeatmaps
+  ##
+  # Used for creating and parsing bounding boxes from CQL Envelope syntax
+  class BoundingBox
+    ##
+    # @param [String, Integer, Float] west
+    # @param [String, Integer, Float] south
+    # @param [String, Integer, Float] east
+    # @param [String, Integer, Float] north
+    def initialize(west, south, east, north)
+      @west = west.to_f
+      @south = south.to_f
+      @east = east.to_f
+      @north = north.to_f
+    end
+
+    ##
+    # Returns a bounding box in ENVELOPE syntax
+    # @return [String]
+    def to_envelope
+      "ENVELOPE(#{west}, #{east}, #{north}, #{south})"
+    end
+
+    ##
+    # @return String
+    def to_geojson
+    {
+      type: 'Polygon',
+      coordinates: [
+        [
+          [west, south],
+          [west, north],
+          [east, north],
+          [east, south],
+          [west, south]
+        ]
+      ]
+    }.to_json
+    end
+
+    def self.from_envelope(envelope)
+      envelope = envelope[/.*ENVELOPE\(([^\)]*)/,1].split(',')
+      new(envelope[0], envelope[3], envelope[1], envelope[2])
+    end
+
+    private
+
+    attr_reader :west, :south, :east, :north
+  end
+end

data/app/models/concerns/blacklight_heatmaps/exceptions.rb

@@ -0,0 +1,10 @@
+module BlacklightHeatmaps
+  module Exceptions
+    class UnknownSpatialDataType < StandardError
+      def message
+        'BlacklightHeatmaps does not know how to parse that type of spatial data. '\
+        'Please try using the CQL ENVELOPE or X Y syntax.'
+      end
+    end
+  end
+end

data/app/models/concerns/blacklight_heatmaps/geometry_parser.rb

@@ -0,0 +1,21 @@
+module BlacklightHeatmaps
+  ##
+  # Parser that tries to understand the type of geospatial data stored in a
+  # String and sends that to the correct parsing class.
+  class GeometryParser
+    ##
+    # Utility method for determing the type of spatial data stored in a string
+    # field
+    # @param String
+    def self.parse(geometry)
+      case geometry
+      when /^ENVELOPE\(.*\)$/
+        BlacklightHeatmaps::BoundingBox.from_envelope(geometry)
+      when /^(\-?\d+(\.\d+)?) \w*(\-?\d+(\.\d+)?)$/
+        BlacklightHeatmaps::Point.from_lng_lat(geometry)
+      else
+        raise BlacklightHeatmaps::Exceptions::UnknownSpatialDataType
+      end
+    end
+  end
+end

data/app/models/concerns/blacklight_heatmaps/geometry_solr_document.rb

@@ -0,0 +1,11 @@
+module BlacklightHeatmaps
+  ##
+  # Provides methods to convert Solr geometry strings
+  module GeometrySolrDocument
+    def to_geojson(blacklight_config = nil)
+      return unless blacklight_config.try(:geometry_field) && fetch(blacklight_config.geometry_field, nil)
+      BlacklightHeatmaps::GeometryParser
+        .parse(fetch(blacklight_config.geometry_field)).to_geojson
+    end
+  end
+end

data/app/models/concerns/blacklight_heatmaps/point.rb

@@ -0,0 +1,31 @@
+module BlacklightHeatmaps
+  ##
+  # A geometry class to characterize points. Can be longitude and latitude.
+  class Point
+    def initialize(x, y)
+      @x = x.to_f
+      @y = y.to_f
+    end
+
+    ##
+    # @return String
+    def to_geojson
+      {
+        type: 'Point',
+        coordinates: [
+          x, y
+        ]
+      }.to_json
+    end
+
+    ##
+    # @param String
+    def self.from_lng_lat(lng_lat)
+      new(*lng_lat.split(' '))
+    end
+
+    private
+
+    attr_reader :x, :y
+  end
+end

data/app/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior.rb

@@ -0,0 +1,53 @@
+module BlacklightHeatmaps
+  ##
+  # Extends itself into a consuming application's SearchBuilder and adds
+  # relevancy, spatial search, and heatmap functionality.
+  module SolrFacetHeatmapBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.default_processor_chain += [:add_solr_facet_heatmap]
+    end
+
+    ##
+    # Add Solr spatial heatmap parameters to Solr request
+    def add_solr_facet_heatmap(solr_parameters = {})
+      if blacklight_params[:bbox]
+        solr_parameters['facet.heatmap'] = geometry_field
+        solr_parameters['facet.heatmap.geom'] = bbox_as_range
+        solr_parameters[:bq] ||= []
+        solr_parameters[:bq] << "#{geometry_field}:\"IsWithin(#{bbox_as_envelope})\""
+        solr_parameters[:fq] ||= []
+        solr_parameters[:fq] << "#{geometry_field}:\"Intersects(#{bbox_as_envelope})\""
+      end
+      solr_parameters
+    end
+
+    def geometry_field
+      blacklight_config.geometry_field
+    end
+
+    ##
+    # `bbox` parameter is in format "west,south,east,north"
+    # @return Array
+    def bbox
+      blacklight_params[:bbox].split(',')
+    end
+
+    ##
+    # Returned in CQL Envelope syntax
+    # https://cwiki.apache.org/confluence/display/solr/Spatial+Search
+    # @return String
+    def bbox_as_envelope
+      BlacklightHeatmaps::BoundingBox.new(*bbox).to_envelope
+    end
+
+    ##
+    # Returned in rectangle-range syntax ["-180 -90" TO "180 90"]
+    # https://cwiki.apache.org/confluence/display/solr/Spatial+Search
+    # @return String
+    def bbox_as_range
+      "[\"#{bbox[0]} #{bbox[1]}\" TO \"#{bbox[2]} #{bbox[3]}\"]"
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+<div class='blacklight-heatmaps-index-map-container'>
+  <%= index_map_div %>
+  <%= content_tag(:div, id: 'index-map-sidebar') do %>
+  <% end %>
+</div>

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

@@ -0,0 +1,5 @@
+<% features = document.to_geojson(blacklight_config) %>
+
+<% unless features.nil? %>
+  <%= content_tag(:div, nil, class: 'blacklight-heatmaps-show-map', id: "map-#{document.id}", data: {show_map: true, features: features, basemap: blacklight_config.basemap}) %>
+<% end %>

data/app/views/catalog/index.json.jbuilder

@@ -0,0 +1,10 @@
+##
+# Overrides default index.json.jbuilder from Blacklight by adding the
+# `facet_heatmaps` key/value
+
+json.response do
+  json.docs @presenter.documents
+  json.facets @presenter.search_facets_as_json
+  json.facet_heatmaps @response['facet_counts']['facet_heatmaps']
+  json.pages @presenter.pagination_info
+end

data/app/views/layouts/blacklight_heatmaps/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>BlacklightHeatmaps</title>
+  <%= stylesheet_link_tag    "blacklight_heatmaps/application", media: "all" %>
+  <%= javascript_include_tag "blacklight_heatmaps/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+BlacklightHeatmaps::Engine.routes.draw do
+end

data/lib/blacklight_heatmaps.rb

@@ -0,0 +1,7 @@
+require 'leaflet-rails'
+require 'leaflet-sidebar-rails'
+require 'blacklight'
+
+module BlacklightHeatmaps
+  require 'blacklight_heatmaps/engine'
+end

data/lib/blacklight_heatmaps/engine.rb

@@ -0,0 +1,8 @@
+module BlacklightHeatmaps
+  class Engine < ::Rails::Engine
+    isolate_namespace BlacklightHeatmaps
+    initializer 'blacklight-maps.helpers' do |app|
+      ActionView::Base.send :include, Blacklight::MapsHelper
+    end
+  end
+end

data/lib/blacklight_heatmaps/version.rb

@@ -0,0 +1,3 @@
+module BlacklightHeatmaps
+  VERSION = "0.0.1"
+end

data/lib/generators/blacklight_heatmaps/install_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators'
+
+module BlacklightHeatmaps
+  class Install < Rails::Generators::Base
+    def add_gems
+      gem 'blacklight_heatmaps'
+    end
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def assets
+      copy_file 'blacklight_heatmaps.scss', 'app/assets/stylesheets/blacklight_heatmaps.scss'
+      copy_file 'blacklight_heatmaps.js', 'app/assets/javascripts/blacklight_heatmaps.js'
+    end
+
+    def configuration
+      inject_into_file 'app/controllers/catalog_controller.rb', after: 'configure_blacklight do |config|' do
+        "\n    # BlacklightHeatmaps configuration values" \
+        "\n    config.geometry_field = :geo_srpt" \
+        "\n    config.basemap = 'http://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png'" \
+        "\n    config.show.partials.insert(1, :show_leaflet_map)" \
+        "\n    config.view.heatmaps.partials = []" \
+        "\n    #Heatmap color ramp. For best results, use http://colorbrewer2.org or http://tristen.ca/hcl-picker/#/hlc/5/1" \
+        "\n    config.view.heatmaps.color_ramp = ['#ffffcc', '#a1dab4', '#41b6c4', '#2c7fb8', '#253494']" \
+        "\n"
+      end
+    end
+
+    def add_model_mixin
+      inject_into_file 'app/models/solr_document.rb', after: 'include Blacklight::Solr::Document' do
+        "\n  include BlacklightHeatmaps::GeometrySolrDocument\n"
+      end
+    end
+
+    def inject_search_builder
+      inject_into_file 'app/models/search_builder.rb', after: /include Blacklight::Solr::SearchBuilderBehavior.*$/ do
+        "\n  include BlacklightHeatmaps::SolrFacetHeatmapBehavior\n"
+      end
+    end
+  end
+end

data/lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.js

@@ -0,0 +1 @@
+//= require blacklight_heatmaps/default

data/lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.scss

@@ -0,0 +1,3 @@
+/*
+ *= require blacklight_heatmaps/default
+ */

data/lib/tasks/blacklight_heatmaps_tasks.rake

@@ -0,0 +1,25 @@
+# Tasks shared with the consuming application
+namespace :blacklight_heatmaps do
+  namespace :index do
+    desc 'Put sample data into Solr'
+    task :seed, [:datafile] => [:environment] do |_t, args|
+      args.with_defaults(datafile: 'sample_solr_documents')
+      fn = File.join(BlacklightHeatmaps::Engine.root, 'solr', args[:datafile] + '.yml')
+      puts "Indexing sample data from #{fn}"
+      docs = YAML.load(File.open(fn))
+      conn = Blacklight.default_index.connection
+      conn.add docs
+      conn.commit
+    end
+
+    desc 'Fetch random data from WhosOnFirst gazetteer and index into Solr'
+    task :seed_random, [:n] => [:environment] do |_t, args|
+      args.with_defaults(n: 10)
+      puts "Indexing #{args[:n]} random data records"
+      docs = YAML.load(`bundle exec ruby #{File.join(BlacklightHeatmaps::Engine.root, 'scripts', 'sample_whosonfirst.rb')} #{args[:n]}`)
+      conn = Blacklight.default_index.connection
+      conn.add docs
+      conn.commit
+    end
+  end
+end

data/spec/features/index_page_map_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+feature 'Index page map', js: true do
+  it 'renders a leaflet map' do
+    visit search_catalog_path(q: 'strong', view: 'heatmaps')
+    expect(page).to have_css '.leaflet-map-pane'
+    # Zoomed to world
+    expect(page).to have_css 'img[src="http://a.basemaps.cartocdn.com/light_all/1/0/0.png"]'
+    expect(page).to have_css '#index-map-sidebar', visible: false
+    page.find('svg g path').click
+    expect(page).to have_css '#index-map-sidebar', visible: true
+    expect(page)
+      .to have_css 'h3.media-heading a', text: '"Strong Medicine speaks"'
+  end
+end

data/spec/features/show_page_map_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+feature 'Show map map', js: true do
+  it 'renders a leaflet map' do
+    visit solr_document_path '43037890'
+    expect(page).to have_css '.leaflet-map-pane'
+    # Zoomed to Kazakhstan
+    expect(page).to have_css 'img[src="http://b.basemaps.cartocdn.com/light_all/4/11/5.png"]'
+    expect(page).to have_css 'svg g path'
+  end
+  it 'renders a point type' do
+    visit solr_document_path '34860108'
+    expect(page).to have_css '.leaflet-marker-icon'
+  end
+end

data/spec/helpers/blacklight/maps_helper_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Blacklight::MapsHelper do
+  let(:blacklight_config) do
+    Blacklight::Configuration.new(
+      basemap: 'http://www.example.com/{z}/{x}/{y}.png',
+      geometry_field: 'geo_srpt',
+      index: Blacklight::OpenStructWithHashAccess.new(
+        title_field: 'title_display'
+      )
+    )
+  end
+  before do
+    allow(helper).to receive_messages(blacklight_config: blacklight_config)
+  end
+  describe '#index_map_div' do
+    it 'renders html with the required elements/attributes' do
+      expect(helper.index_map_div)
+        .to have_css '#index-map.blacklight-heatmaps-index-map'
+      expect(helper.index_map_div)
+        .to have_css '[data-index-map="true"]'
+      expect(helper.index_map_div)
+        .to have_css '[data-search-url="http://test.host"]'
+      expect(helper.index_map_div)
+        .to have_css '[data-geometry-field="geo_srpt"]'
+      expect(helper.index_map_div)
+        .to have_css '[data-basemap="http://www.example.com/{z}/{x}/{y}.png"]'
+      expect(helper.index_map_div).to have_css '[data-sidebar-template]'
+      expect(helper.index_map_div).to have_css '[data-color-ramp]'
+    end
+  end
+  describe '#sidebar_template' do
+    it 'renders html template used in sidebar' do
+      expect(helper.sidebar_template)
+        .to have_css '.media .media-body h3.media-heading a', text: '{title_display}'
+    end
+  end
+end

data/spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe BlacklightHeatmaps::BoundingBox do
+  describe '#initialize' do
+    it 'handles multiple input types as arguments' do
+      expect(described_class.new('1', '1', '1', '1')).to be_an described_class
+      expect(described_class.new(1, 2, 3, 3)).to be_an described_class
+      expect(described_class.new(1.1, 2.1, 3.1, 3.1)).to be_an described_class
+    end
+  end
+  describe '#to_envelope' do
+    let(:example_box) { described_class.new(-160, -80, 120, 70) }
+    it 'creates an envelope syntax version of the bounding box' do
+      expect(example_box.to_envelope).to eq 'ENVELOPE(-160.0, 120.0, 70.0, -80.0)'
+    end
+  end
+  describe '#to_geojson' do
+    let(:example_box) { described_class.new(-160, -80, 120, 70) }
+    it 'creates a geoJSON string' do
+      expect(example_box.to_geojson).to eq '{"type":"Polygon","coordinates":[[[-160.0,-80.0],[-160.0,70.0],[120.0,70.0],[120.0,-80.0],[-160.0,-80.0]]]}'
+    end
+  end
+  describe '#from_rectangle' do
+    let(:envelope) { 'ENVELOPE(-160.0, 120.0, 70.0, -80.0)' }
+    let(:example_box) { described_class.from_envelope(envelope) }
+    it 'parses and creates a Geoblacklight::BoundingBox from a Solr lat-lon' do
+      expect(example_box).to be_an described_class
+      expect(example_box.to_envelope).to eq envelope
+    end
+  end
+end

data/spec/models/concerns/blacklight_heatmaps/geometry_parser_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe BlacklightHeatmaps::GeometryParser do
+  describe '.parse' do
+    context 'when parsing a CQL ENVELOPE' do
+      it 'returns a BlacklightHeatmaps::BoundingBox' do
+        expect(described_class.parse('ENVELOPE(1,2,4,3)'))
+          .to be_an BlacklightHeatmaps::BoundingBox
+      end
+    end
+    context 'when parsing an X Y coordinate' do
+      it 'returns a BlacklightHeatmaps::Point' do
+        expect(described_class.parse('-180 90')).to be_an BlacklightHeatmaps::Point
+      end
+    end
+    context 'when parsing an unknown type' do
+      it 'raises an exception' do
+        expect do
+          described_class.parse('123,23 32,123')
+        end.to raise_error(BlacklightHeatmaps::Exceptions::UnknownSpatialDataType)
+      end
+    end
+  end
+end

data/spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe BlacklightHeatmaps::GeometrySolrDocument do
+  subject { SolrDocument.new(fields).to_geojson(blacklight_config) }
+
+  context 'when configured' do
+    let(:fields) { { some_field: 'ENVELOPE(1,2,4,3)' } }
+    let(:blacklight_config) { double('BlacklightConfig', geometry_field: :some_field) }
+    it 'returns the data from the document as geoJSON' do
+      expect(subject).to eq '{"type":"Polygon","coordinates":[[[1.0,3.0],[1.0,4.0],[2.0,4.0],[2.0,3.0],[1.0,3.0]]]}'
+    end
+  end
+  context 'when not configured' do
+    let(:fields) { { some_field: 'ENVELOPE(1,2,4,3)' } }
+    let(:blacklight_config) { double('BlacklightConfig') }
+    it 'returns nil' do
+      expect(subject).to be_nil
+    end
+  end
+  context 'when the document has the field' do
+    let(:fields) { { some_field: 'ENVELOPE(1,2,4,3)' } }
+    let(:blacklight_config) { double('BlacklightConfig', geometry_field: :some_field) }
+    it 'returns the data from the document as geoJSON' do
+      expect(subject).to eq '{"type":"Polygon","coordinates":[[[1.0,3.0],[1.0,4.0],[2.0,4.0],[2.0,3.0],[1.0,3.0]]]}'
+    end
+  end
+  context 'when the document does not have the field' do
+    let(:fields) { { some_other_field: 'ENVELOPE(1,2,4,3)' } }
+    let(:blacklight_config) { double('BlacklightConfig', geometry_field: :some_field) }
+    it 'returns nil' do
+      expect(subject).to be_nil
+    end
+  end
+end

data/spec/models/concerns/blacklight_heatmaps/point_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe BlacklightHeatmaps::Point do
+  describe '#to_geojson' do
+    it 'creates geojson from the point' do
+      expect(described_class.new(-180, 90).to_geojson)
+        .to eq '{"type":"Point","coordinates":[-180.0,90.0]}'
+    end
+  end
+  describe '.from_lng_lat' do
+    subject { described_class.from_lng_lat('-180 90') }
+    it 'instantiates an instance from a lng lat string' do
+      expect(subject).to be_an described_class
+      expect(subject.to_geojson)
+        .to eq '{"type":"Point","coordinates":[-180.0,90.0]}'
+    end
+  end
+end

data/spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe BlacklightHeatmaps::SolrFacetHeatmapBehavior do
+  let(:blacklight_config) { CatalogController.blacklight_config.deep_copy }
+  let(:context) { CatalogController.new }
+
+  before do
+    allow(context).to receive(:blacklight_config).and_return(blacklight_config)
+  end
+
+  let(:search_builder_class) do
+    Class.new(Blacklight::SearchBuilder) do
+      include Blacklight::Solr::SearchBuilderBehavior
+      include BlacklightHeatmaps::SolrFacetHeatmapBehavior
+    end
+  end
+
+  let(:search_builder) { search_builder_class.new(context) }
+
+  describe '#add_solr_facet_heatmap' do
+    let(:solr_params) { { fq: [filter: 'stuff'], bq: [boost: 'stuff'] } }
+    context 'when bbox is not present' do
+      subject { search_builder }
+      it 'does not modify the solr parameters' do
+        expect(subject.add_solr_facet_heatmap(solr_params)).to eq solr_params
+      end
+    end
+    context 'when a bbox is present' do
+      subject { search_builder.with(bbox: '1,2,4,3') }
+      it 'leaves solr params in place and adds new params' do
+        expect(subject.add_solr_facet_heatmap(solr_params)['facet.heatmap'])
+          .to eq :geo_srpt
+        expect(subject.add_solr_facet_heatmap(solr_params)['facet.heatmap.geom'])
+          .to eq '["1 2" TO "4 3"]'
+        expect(subject.add_solr_facet_heatmap(solr_params)[:bq])
+          .to include(boost: 'stuff')
+        expect(subject.add_solr_facet_heatmap(solr_params)[:bq])
+          .to include('geo_srpt:"IsWithin(ENVELOPE(1.0, 4.0, 3.0, 2.0))"')
+        expect(subject.add_solr_facet_heatmap(solr_params)[:fq])
+          .to include(filter: 'stuff')
+        expect(subject.add_solr_facet_heatmap(solr_params)[:fq])
+          .to include('geo_srpt:"Intersects(ENVELOPE(1.0, 4.0, 3.0, 2.0))"')
+      end
+    end
+  end
+
+  describe '#bbox' do
+    subject { search_builder.with(bbox: '1,2,4,3') }
+    it 'returns the bbox parameter split on ,' do
+      expect(subject.bbox).to match_array %w(1 2 4 3)
+    end
+  end
+
+  describe '#bbox_as_envelope' do
+    subject { search_builder.with(bbox: '1,2,4,3') }
+    it 'returns the bbox parameter in envelope syntax' do
+      expect(subject.bbox_as_envelope).to eq 'ENVELOPE(1.0, 4.0, 3.0, 2.0)'
+    end
+  end
+
+  describe '#bbox_as_range' do
+    subject { search_builder.with(bbox: '1,2,4,3') }
+    it 'returns the bbox parameter in rectangle-range syntax' do
+      expect(subject.bbox_as_range).to eq '["1 2" TO "4 3"]'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+if ENV['COVERAGE'] || ENV['CI']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'engine_cart'
+EngineCart.load_application!
+
+require 'rspec/rails'
+
+require 'capybara/poltergeist'
+Capybara.javascript_driver = :poltergeist
+
+require 'blacklight'
+require 'blacklight_heatmaps'
+
+RSpec.configure do |c|
+  c.infer_spec_type_from_file_location!
+end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root './spec/test_app_templates'
+
+  def add_gems
+    gem 'blacklight', '~> 6.0'
+
+    Bundler.with_clean_env do
+      run 'bundle install'
+    end
+  end
+
+  def run_blacklight_generator
+    say_status('warning', 'GENERATING BL', :yellow)
+
+    generate 'blacklight:install', '--devise'
+  end
+
+  # if you need to generate any additional configuration
+  # into the test app, this generator will be run immediately
+  # after setting up the application
+
+  def install_engine
+    generate 'blacklight_heatmaps:install'
+  end
+end

data/spec/views/catalog/_document_heatmaps.html.erb_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'catalog/_document_heatmaps.html.erb' do
+  let(:blacklight_config) { Blacklight::Configuration.new }
+  before do
+    allow(view).to receive(:index_map_div)
+      .and_return '<div id="index-map"></div>'.html_safe
+  end
+  it 'renders a div with needed elements' do
+    blacklight_config.configure do |config|
+      config.geometry_field = :geo_srpt
+    end
+    render partial: 'catalog/document_heatmaps',
+           locals: { blacklight_config: blacklight_config }
+    expect(rendered).to have_css '.blacklight-heatmaps-index-map-container'
+    expect(rendered).to have_css '#index-map'
+    expect(rendered).to have_css '#index-map-sidebar'
+  end
+end

data/spec/views/catalog/_show_leaflet_map_default.html.erb_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'catalog/_show_leaflet_map_default.html.erb' do
+  let(:document) do
+    SolrDocument.new(geo_srpt: 'ENVELOPE(1,2,4,3)', id: 'abc123')
+  end
+  let(:blacklight_config) { Blacklight::Configuration.new }
+  before do
+    allow(view).to receive(:document).and_return(document)
+  end
+  context 'when geojson is available' do
+    it 'should render the leaflet container' do
+      blacklight_config.configure do |config|
+        config.geometry_field = :geo_srpt
+      end
+      render partial: 'catalog/show_leaflet_map_default',
+             locals: { document: document, blacklight_config: blacklight_config }
+      expect(rendered).to have_css '.blacklight-heatmaps-show-map'
+      expect(rendered).to have_css '#map-abc123'
+      expect(rendered).to have_css '[data-basemap]'
+      expect(rendered).to have_css '[data-show-map]'
+      expect(rendered).to have_css '[data-features]'
+    end
+  end
+  context 'when geojson is not available' do
+    it 'renders nothing' do
+      render partial: 'catalog/show_leaflet_map_default',
+             locals: { document: document, blacklight_config: blacklight_config }
+      expect(rendered).to eq "\n"
+    end
+  end
+end

metadata

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification
+name: blacklight_heatmaps
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jack Reed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: leaflet-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: leaflet-sidebar-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: solr_wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Search and view Blacklight resources on a map.
+email:
+- phillipjreed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/blacklight_heatmaps/blacklight_heatmaps.js
+- app/assets/javascripts/blacklight_heatmaps/default.js
+- app/assets/javascripts/blacklight_heatmaps/viewers/index.js
+- app/assets/javascripts/blacklight_heatmaps/viewers/show.js
+- app/assets/stylesheets/blacklight_heatmaps/default.scss
+- app/controllers/blacklight_heatmaps/application_controller.rb
+- app/helpers/blacklight/maps_helper.rb
+- app/models/concerns/blacklight_heatmaps/bounding_box.rb
+- app/models/concerns/blacklight_heatmaps/exceptions.rb
+- app/models/concerns/blacklight_heatmaps/geometry_parser.rb
+- app/models/concerns/blacklight_heatmaps/geometry_solr_document.rb
+- app/models/concerns/blacklight_heatmaps/point.rb
+- app/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior.rb
+- app/views/catalog/_document_heatmaps.html.erb
+- app/views/catalog/_show_leaflet_map_default.html.erb
+- app/views/catalog/index.json.jbuilder
+- app/views/layouts/blacklight_heatmaps/application.html.erb
+- config/routes.rb
+- lib/blacklight_heatmaps.rb
+- lib/blacklight_heatmaps/engine.rb
+- lib/blacklight_heatmaps/version.rb
+- lib/generators/blacklight_heatmaps/install_generator.rb
+- lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.js
+- lib/generators/blacklight_heatmaps/templates/blacklight_heatmaps.scss
+- lib/tasks/blacklight_heatmaps_tasks.rake
+- spec/features/index_page_map_spec.rb
+- spec/features/show_page_map_spec.rb
+- spec/helpers/blacklight/maps_helper_spec.rb
+- spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb
+- spec/models/concerns/blacklight_heatmaps/geometry_parser_spec.rb
+- spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb
+- spec/models/concerns/blacklight_heatmaps/point_spec.rb
+- spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb
+- spec/spec_helper.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/views/catalog/_document_heatmaps.html.erb_spec.rb
+- spec/views/catalog/_show_leaflet_map_default.html.erb_spec.rb
+homepage: https://github.com/sul-dlss/blacklight_heatmaps
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Search and view Blacklight resources on a map.
+test_files:
+- spec/features/index_page_map_spec.rb
+- spec/features/show_page_map_spec.rb
+- spec/helpers/blacklight/maps_helper_spec.rb
+- spec/models/concerns/blacklight_heatmaps/bounding_box_spec.rb
+- spec/models/concerns/blacklight_heatmaps/geometry_parser_spec.rb
+- spec/models/concerns/blacklight_heatmaps/geometry_solr_document_spec.rb
+- spec/models/concerns/blacklight_heatmaps/point_spec.rb
+- spec/models/concerns/blacklight_heatmaps/solr_facet_heatmap_behavior_spec.rb
+- spec/spec_helper.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/views/catalog/_document_heatmaps.html.erb_spec.rb
+- spec/views/catalog/_show_leaflet_map_default.html.erb_spec.rb