blacklight-maps 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cec8bdbdd2134f3c1f7f3762f61a91c387fcb39b
-  data.tar.gz: 02828cec807ece0e8564c74f6d424d3f787b9534
+  metadata.gz: b6bffe02f056bdbd0cddc8b63f3f30b1ff7d08d9
+  data.tar.gz: 99876fe750aebda63112736254ea34d893f4c294
 SHA512:
-  metadata.gz: 9c3cb7694eb528ca1ff0d6f45454bb196591ee9c22bed67a8b74d385ac01ec072b1dd35f48cfa01a8b1fa410338ed8579694ea01aa20f9554d4b1d72343f092c
-  data.tar.gz: 75f2982504e7cf96e7d369e365dc7ad371342f388b274e3ea486752be3cd2138ec225a629d161fd0a2c67955cc6cbe118e0e1668a70aaad6d9f2ead52c35008e
+  metadata.gz: e37de7d922821ede6726b35bd1b2139fc72ca804000940c8411f40b1ec8320d95de79e1bc41315ecb50f10b70020da6ee02fca4b73096022734567777602be95
+  data.tar.gz: e7ffbbb907a95830329d2cbbc004bb0320c6a842e1adf5d9da9a2646fc4cae0d3ea36dfc5c349671e87d4416fe67a1f9399b1f3db1688033f0b4550e8caded55

data/README.md

@@ -163,6 +163,23 @@ However, the catalog#show maplet widget must be included manually, via one of tw
   ...
   ```
 
+### Customization
+
+The ```blacklight_map_tag``` helper takes an options hash as one of its arguments that can be used to provide customization options for the Leaflet map functionality via data attributes. (See ```app/views/catalog/index_map``` for an example.) The available options include:
+
+- ```viewpoint``` = the center point of the map (```[lat,long]```)
+- ```searchcontrol``` = whether to display the search control on the map (```boolean```)
+- ```catalogpath``` = the search path for the search control (e.g. ```catalog_index_path```)
+- ```placenamefield``` =  the name of the Solr field containing the location names (e.g. ```"placename_field"```)
+- ```searchctrlcue``` = the hover text to display when the mouse hovers over the search control
+- ```singlemarkermode``` = whether locations should be clustered (```boolean```)
+- ```clustercount``` = whether clusters should display the location count or the number of hits (```"hits" || "locations"```)
+- ```maxzoom``` = the maxZoom [property of the map](http://leafletjs.com/reference.html#map-maxzoom)
+- ```tileurl``` = a [tileLayer url](http://leafletjs.com/reference.html#tilelayer-l.tilelayer) to change the basemap
+- ```mapattribution``` = an [attribution string](http://leafletjs.com/reference.html#tilelayer-attribution) to describe the basemap layer
+- ```nodata``` = a message to display in the Leaflet popup when the "popup" member is not present in the properties hash in the GeoJSON Feature for a location.
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/blacklight-maps/fork )

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

@@ -3,6 +3,24 @@
   $.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>',
+      viewpoint: [0,0],
+      initialzoom: 2,
+      singlemarkermode: true,
+      searchcontrol: false,
+      catalogpath: 'catalog',
+      searchctrlcue: 'Search for all items within the current map window',
+      placenamefield: 'placename_field',
+      nodata: 'Sorry, there is no data for this location.',
+      clustercount:'locations'
+    }, arg_opts );
+
+    // Extend options from data-attributes
+    $.extend(options, this.data());
+
     var mapped_items = '<span class="mapped-count"><span class="badge">' + geojson_docs.features.length + '</span> location' + (geojson_docs.features.length !== 1 ? 's' : '') + ' mapped</span>';
 
     var mapped_caveat = '<span class="mapped-caveat">Only items with location data are shown below</span>';
@@ -15,8 +33,12 @@
       var result_count = page_links.find('.page_entries').find('strong').last().html();
       page_links.html('<span class="page_entries"><strong>' + result_count + '</strong> items found</span>' + mapped_items + mapped_caveat);
       sortAndPerPage.find('.dropdown-toggle').hide();
+    } else { // catalog#show view
+      $(this.selector).before(mapped_items);
+    }
 
-      // clusters should show item result count in #index and #map views
+    // determine whether to use item location or result count in cluster icon display
+    if (options.clustercount == 'hits') {
       var clusterIconFunction = function (cluster) {
         var markers = cluster.getAllChildMarkers();
         var childCount = 0;
@@ -33,28 +55,10 @@
         }
         return new L.divIcon({ html: '<div><span>' + childCount + '</span></div>', className: 'marker-cluster' + c, iconSize: new L.Point(40, 40) });
       };
-    } else { // catalog#show view
-      $(this.selector).before(mapped_items);
+    } else {
       var clusterIconFunction = this._defaultIconCreateFunction;
     }
 
-    // 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>',
-      viewpoint: [0,0],
-      initialzoom: 2,
-      singlemarkermode: true,
-      searchcontrol: false,
-      catalogpath: 'catalog',
-      searchctrlcue: 'Search for all items within the current map window',
-      placenamefield: 'placename_field',
-      nodata: 'Sorry, there is no data for this location.'
-    }, arg_opts );
-
-    // Extend options from data-attributes
-    $.extend(options, this.data());
-
     // Display the map
     this.each(function() {
       options.id = this.id;

data/app/helpers/blacklight/blacklight_maps_helper_behavior.rb

@@ -88,10 +88,11 @@ module Blacklight::BlacklightMapsHelperBehavior
   end
 
   # pass the document or facet values to BlacklightMaps::GeojsonExport
-  def serialize_geojson(documents)
+  def serialize_geojson(documents, options={})
     export = BlacklightMaps::GeojsonExport.new(controller,
                                                controller.action_name,
-                                               documents)
+                                               documents,
+                                               options)
     export.to_geojson
   end
 

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

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

data/lib/blacklight/maps/export.rb

@@ -13,10 +13,12 @@ module BlacklightMaps
     # response_docs is passed by a helper, and is either:
     #  - index view, map view: an array of facet values
     #  - show view: the document object
-    def initialize(controller, action, response_docs)
+    # options is an optional hash of possible configuration options
+    def initialize(controller, action, response_docs, options={})
       @controller = controller
       @action = action
       @response_docs = response_docs
+      @options = options
     end
 
     # build the GeoJSON FeatureCollection

data/lib/blacklight/maps/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Maps
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

data/spec/lib/blacklight/maps/export_spec.rb

@@ -14,7 +14,7 @@ describe "BlacklightMaps::GeojsonExport" do
 
   # TODO: use @response.facet_by_field_name('geojson').items instead of @response
   #       then refactor build_geojson_features and to_geojson specs
-  subject {BlacklightMaps::GeojsonExport.new(@controller, @action, @response.docs)}
+  subject {BlacklightMaps::GeojsonExport.new(@controller, @action, @response.docs, {foo:'bar'})}
 
   it "should instantiate GeojsonExport" do
     expect(subject.class).to eq(::BlacklightMaps::GeojsonExport)
@@ -46,6 +46,10 @@ describe "BlacklightMaps::GeojsonExport" do
       expect(subject.send(:placename_property)).to eq('placename')
     end
 
+    it "should create an @options instance variable" do
+      expect(subject.instance_variable_get("@options")[:foo]).to eq('bar')
+    end
+
   end
 
   describe "build_feature_from_geojson" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-maps
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -256,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Maps for Blacklight