blacklight-maps 0.3.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9a4c9d51a9b188233f983469e290609fead6e4f
-  data.tar.gz: 3d61ff5d65da2592b37515f3c62b773425f2fac0
+SHA256:
+  metadata.gz: b23c73a0ba75175cfe101746f9ff1ae0592a42556a34c9d1e4fe8cc2c42b8081
+  data.tar.gz: ce938a6f2884faccb3051985ab84fe0bf40505f1246fe56ca1d2621ca823b2a9
 SHA512:
-  metadata.gz: 2ba42a84d843b12148894593e41a705f0ac85d7dd5abc84eeb906ea4f9d28468a4d5d6b717a2be00d08662f0d1e476723969fb1451c9c08edfa2744cc90a00c7
-  data.tar.gz: 44d3a6067b0cc5465089318211b47fa2e00fdb9a241a8d87b309dab01afe8595baf0f58ec6a33086981ded5da4b24189c5cd525785589a9c85d9be1797849c78
+  metadata.gz: c83862d2c315629f8610d15978b386aa7f9e6d889a82fd70ef540870f6b7e80bb6c0cd2b507bbf06019f31b39a68f34970721d90bffb1bc747b86fec433c8607
+  data.tar.gz: e1de2250bbe1f18826ff9ab17f814ef3e2ce53e745fd0c66e3f19c2de7f45e13bff72224da8d042ca91ae0546ad87c673e93cd136fe84d3abb8927b98f374b2c

data/.gitignore

@@ -19,3 +19,5 @@ spec/internal
 jetty
 .DS_Store
 .idea/
+.rakeTasks
+.internal_test_app

data/.rubocop.yml

@@ -0,0 +1,99 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "lib/generators/blacklight_maps/templates/**/*"
+    - "blacklight-maps.gemspec"
+
+# engine_cart block includes conditional, not duplication
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
+# engine_cart block is following default Rails order
+Bundler/OrderedGems:
+  Exclude:
+    - 'Gemfile'
+
+Layout/IndentationConsistency:
+  EnforcedStyle: normal
+
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - 'lib/blacklight/maps/maps_search_builder.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/blacklight/maps/export.rb'
+
+Metrics/LineLength:
+  Max: 200
+  Exclude:
+    - 'lib/blacklight/maps/engine.rb'
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 15
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Rails:
+  Enabled: true
+
+Rails/OutputSafety:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/system/initial_view_spec.rb'
+
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/system/*'
+
+RSpec/FilePath:
+  Exclude:
+    - 'spec/lib/blacklight/maps/*'
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/MultipleExpectations:
+  Max: 4
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/PredicateMatcher:
+  Exclude:
+    - 'spec/lib/blacklight/maps/render_constraints_override_spec.rb'
+
+# https://github.com/rubocop-hq/rubocop/issues/6439
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'spec/lib/blacklight/maps/export_spec.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/SignalException:
+  Exclude:
+    - 'spec/**/*'

data/.solr_wrapper.yml

@@ -0,0 +1,7 @@
+# Place any default configuration for solr_wrapper here
+# you must first run 'rake engine_cart:generate' to create the test app
+# before running 'solr_wrapper' from project root
+# port: 8983
+collection:
+  dir: ./.internal_test_app/solr/conf/
+  name: blacklight-core

data/.travis.yml

@@ -1,25 +1,28 @@
-notifications:
-  email: false
 language: ruby
 sudo: false
-rvm:
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
+dist: bionic
 
-notifications:
-  irc: "irc.freenode.org#blacklight"
-  email:
-      - blacklight-commits@googlegroups.com
+addons:
+  chrome: stable
+
+before_install:
+  - google-chrome-stable --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 http://localhost &
 
 env:
   global:
-    - JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+    - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
 
 matrix:
-  allow_failures:
-    - rvm: jruby-19mode
-    - rvm: 1.9.3
+  include:
+    - rvm: 2.7.0
+      env: "RAILS_VERSION=6.0.2.2"
+    - rvm: 2.6.5
+      env: "RAILS_VERSION=6.0.2.2"
+    - rvm: 2.6.5
+      env: "RAILS_VERSION=5.2.4.2"
+    - rvm: 2.5.7
+      env: "RAILS_VERSION=5.2.4.2"
+  fast_finish: true
+
+jdk: openjdk11

data/Gemfile

@@ -1,26 +1,48 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in blacklight-maps.gemspec
 gemspec
 
-# 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'
-gem 'bootstrap-sass', ">= 3.1.1.1"
-
-group :test do
-  gem 'simplecov', require: false
+group :development, :test do
   gem 'coveralls', require: false
 end
 
-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)
+gem 'engine_cart'
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 1.2.0
+# engine_cart stanza: 0.10.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
+
+  case ENV['RAILS_VERSION']
+  when /^5.[12]/, /^6.0/
+    gem 'sass-rails', '~> 5.0'
+  when /^4.2/
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+    gem 'coffee-rails', '~> 4.1.0'
+    gem 'json', '~> 1.8'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
+  end
 end
+# END ENGINE_CART BLOCK

data/README.md

@@ -1,6 +1,6 @@
 # Blacklight::Maps
 
-[![Build Status](https://travis-ci.org/projectblacklight/blacklight-maps.png?branch=master)](https://travis-ci.org/sul-dlss/blacklight-maps) | [![Coverage Status](https://coveralls.io/repos/projectblacklight/blacklight-maps/badge.svg?branch=master)](https://coveralls.io/r/projectblacklight/blacklight-maps?branch=master)
+[![Build Status](https://travis-ci.org/projectblacklight/blacklight-maps.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight-maps) | [![Coverage Status](https://coveralls.io/repos/projectblacklight/blacklight-maps/badge.svg?branch=master)](https://coveralls.io/r/projectblacklight/blacklight-maps?branch=master)
 
 Provides map views for Blacklight for items with geospatial coordinate (latitude/longitude) metadata.
 
@@ -15,6 +15,8 @@ Maplet widget in item detail view:
 
 ## Installation
 
+(See [Blacklight Version Compatibility](#blacklight-compatibility) below to make sure you're using a version of the gem that works with the version of Blacklight you're using.)
+
 Add this line to your application's Gemfile:
 
     gem 'blacklight-maps'
@@ -51,11 +53,11 @@ Blacklight-Maps requires that your Solr index include at least one (but preferab
 
   ```
   # coordinates: lon lat or lat,lon
-  # bounding box: minX minY maxX maxY
-  coordinates_field: 
+  # bounding box: ENVELOPE(minX, maxX, maxY, minY)
+  coordinates_srpt: 
    - 78.96288 20.593684
    - 20.593684,78.96288
-   - 68.162386 6.7535159 97.395555 35.5044752       
+   - ENVELOPE(68.162386, 97.395555, 35.5044752, 6.7535159)
   ```
 
 2. An indexed, stored string field containing a properly-formatted [GeoJSON](http://geojson.org) feature object for a point or bounding box that includes the coordinates and (preferably) location name. This field can be multivalued.
@@ -72,7 +74,7 @@ Blacklight-Maps requires that your Solr index include at least one (but preferab
 3. An indexed, stored text or string field containing location names. This field can be multivalued.
 
   ```
-   placename_field: India
+   subject_geo_ssim: India
   ```
 
 ##### Why so complicated?
@@ -86,10 +88,10 @@ Blacklight-Maps can be used with either field type (#1 or #2), however to take a
 **Important:** If you are NOT using the geojson field (#2), you should create a `copyField` in your Solr schema.xml to copy the coordinates from the `location_rpt` field to a string field that is stored, indexed, and multivalued to allow for proper faceting of the coordinate values in the catalog#map and catalog#index views.
 
 ```
-  <!-- Solr4 location_rpt field for coordinates, shapes, etc. -->
-  <dynamicField name="geospatial" type="location_rpt" indexed="true" stored="true" multiValued="true" />
+  <!-- Solr location_rpt field for coordinates, shapes, etc. -->
+  <dynamicField name="*_srpt" type="location_rpt" indexed="true" stored="true" multiValued="true" />
   <!-- copy geospatial to string field for faceting -->
-  <copyField source="geospatial" dest="geospatial_facet" />
+  <copyField source="coordinates_srpt" dest="coordinates_ssim" />
 ```
 
 Support for additional field types may be added in the future.
@@ -110,9 +112,9 @@ Blacklight-Maps expects you to provide these configuration options:
     + `placename_field` = the name of the Solr field containing the location names
 + `coordinates_field` = the name of the Solr `location_rpt` type field containing geospatial coordinate data
 
-In addition, you must add the geospatial facet field to the list of facet fields:
+In addition, you must add the geospatial facet field to the list of facet fields in `app/controllers/catalog_controller.rb`, for example:
 ```ruby
-config.add_facet_field 'geojson_field', :limit => -2, :label => 'Coordinates', :show => false
+config.add_facet_field 'geojson_ssim', :limit => -2, :label => 'Coordinates', :show => false
 ```
 
 #### Optional
@@ -181,7 +183,7 @@ Option | Type | Default | Description
 `catalogpath` | String | `'catalog'` | the search path for the search control
 `placenamefield` | String | `'placename_field'` | the name of the Solr field containing the location names
 `searchctrlcue` | String | `'Search for all items within the current map window'` | the hover text to display when the mouse hovers over the ![search control](docs/blacklight-maps_search-control.png) search control
-`searchresultsview` | String | `'list'` | the view type for the search results on the catalog#index page after the ![search control](docs/blacklight-maps_search-control.png) search control is used
+`searchresultsview` | String | `'list'` | the view type for the search results on the catalog#index page after the map ![search control](docs/blacklight-maps_search-control.png) search control is used
 `singlemarkermode` | Boolean | `true` | whether locations should be clustered
 `clustercount` | String | `'locations'` | whether clusters should display the location count or the number of hits (`'hits'` or `'locations'`)
 `maxzoom` | Integer | 18 | the maxZoom [property of the map](http://leafletjs.com/reference.html#map-maxzoom)
@@ -189,6 +191,15 @@ Option | Type | Default | Description
 `mapattribution` | String | ``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>'` | an [attribution string](http://leafletjs.com/reference.html#tilelayer-attribution) to describe the basemap layer
 `nodata` | String | `'Sorry, there is no data for this location.'` | 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.
 
+### <a name="blacklight-compatibility"></a>Blacklight Version Compatibility
+The table below indicates which versions of Blacklight Maps are compatible with which versions of Blacklight.
+
+Blacklight Maps version | works with Blacklight version
+----------------------- | ---------------------
+1.1.* | >= 7.8.0, < 8
+0.5.* | >= 6.1.0, < 7
+0.4.* | >= 5.12.0, < 6.*
+<= 0.3.3 | >= 5.1, <= 5.11.2
 
 ## Contributing
 

data/Rakefile

@@ -1,43 +1,46 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-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'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 
-require 'jettywrapper'
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BlacklightMaps'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
 
-task default: :ci
+Bundler::GemHelper.install_tasks
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::Task.define_task(:environment)
 
-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
+load 'lib/railties/blacklight_maps.rake'
 
-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')
+task default: :ci
 
-  error = Jettywrapper.wrap(jetty_params) do
-    Rake::Task['fixtures'].invoke
-    Rake::Task['spec'].invoke
-  end
-  raise "test failures: #{error}" if error
-end
+require 'engine_cart/rake_task'
 
+require 'solr_wrapper'
 
-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)
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+desc 'Run test suite'
+task ci: [:rubocop, 'engine_cart:generate'] do
+  SolrWrapper.wrap do |solr|
+    solr.with_collection do
+      within_test_app do
+        system 'RAILS_ENV=test rake blacklight_maps:index:seed'
+      end
+      Rake::Task['spec'].invoke
     end
   end
-end
+end

data/app/assets/images/blacklight/maps.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M16,12a5.11,5.11,0,0,0,.8-1.6ZM8,12l-.8-1.6A4.72,4.72,0,0,0,8,12Z"/><path d="M12,4A5,5,0,0,0,7,9a4.71,4.71,0,0,0,.1,1c0,.13.06.26.1.39L8,12l4,8,4-8,.8-1.6L16.9,10A4.71,4.71,0,0,0,17,9,5,5,0,0,0,12,4Zm0,7a2,2,0,1,1,1.73-1A2,2,0,0,1,12,11Z"/><path d="M7.1,10c0,.13.06.26.1.39L7,10Z"/><path d="M17,10l-.19.39L16.9,10Z"/></svg>

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

@@ -1,7 +1,4 @@
-// for Blacklight.onLoad:
-//= require blacklight/core
-
 //= require leaflet
 //= require leaflet.markercluster
 
-//= require_tree .
+//= require_tree .

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

@@ -5,9 +5,9 @@
 
     // 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>',
-      initialZoom: 2,
+      tileurl : 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
+      mapattribution : 'Map data &copy; <a href="https://openstreetmap.org">OpenStreetMap</a> contributors, <a' + ' href="https://creativecommons.org/licenses/by-sa/4.0/">CC-BY-SA</a>',
+      initialzoom: 2,
       singlemarkermode: true,
       searchcontrol: false,
       catalogpath: 'catalog',
@@ -21,7 +21,7 @@
     // 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_items = '<span class="mapped-count"><span class="badge badge-secondary">' + 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>';
 
@@ -31,12 +31,12 @@
 
     // Update page links with number of mapped items, disable sort, per_page, pagination
     if (sortAndPerPage.length) { // catalog#index and #map view
-      var page_links = sortAndPerPage.find('.page_links');
-      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);
+      var page_links = sortAndPerPage.find('.page-links');
+      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);
+        $(this).before(mapped_items);
     }
 
     // determine whether to use item location or result count in cluster icon display
@@ -68,7 +68,6 @@
       // Setup Leaflet map
       map = L.map(this.id, {
         center: [0, 0],
-        zoom: options.initialZoom
       });
 
       L.tileLayer(options.tileurl, {
@@ -120,7 +119,6 @@
           var container = L.DomUtil.create('div', 'leaflet-bar leaflet-control');
           this.link = L.DomUtil.create('a', 'leaflet-bar-part search-control', container);
           this.link.title = options.searchctrlcue;
-          this.icon = L.DomUtil.create('i', 'glyphicon glyphicon-search', this.link);
 
           L.DomEvent.addListener(this.link, 'click', _search);
 
@@ -147,12 +145,18 @@
 
     /**
     * Sets the view of the map, based off of the map bounds
+    * options.initialzoom is invoked for catalog#show views (unless it would obscure features)
     */
     function setMapBounds() {
       map.fitBounds(mapBounds(), {
         padding: [10, 10],
         maxZoom: options.maxzoom
       });
+      if ($('#document').length) {
+        if (map.getZoom() > options.initialzoom) {
+          map.setZoom(options.initialzoom)
+        }
+      }
     }
 
     /**
@@ -182,7 +186,13 @@
     * Checks to see if there are any features in the markers MarkerClusterGroup
     */
     function hasAnyFeatures() {
-      return !$.isEmptyObject(markers._featureGroup._layers);
+      var has_features = false;
+      markers.eachLayer(function (layer) {
+        if (!$.isEmptyObject(layer)) {
+          has_features = true;
+        }
+      });
+      return has_features;
     }
 
     // remove stale params, add new params, and run a new search