geoblacklight 0.12.1 → 1.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c48807e9e693272f01efe26dfe5f292c4d2260d
-  data.tar.gz: f84f1b102c444f450dd6f0c9bc6bff1498d0e677
+  metadata.gz: 5b0ad269f0ebd47db8d81ab0d4719f90fcbb8a17
+  data.tar.gz: 1ad6c33856e8f7ce2551b19674f534085f52965a
 SHA512:
-  metadata.gz: 48e1657b1cf33837a5c63fae09b70c0c79c0038df9b3e25734b071bb66825839ae53871e1103b88f6a40f4fb7cd58ece31d3ba1983d310c324c64cb6aa5eb34a
-  data.tar.gz: 2c269376fbd741b1546a9c8607bb23d7c8c8cad149406f9ff9a1d2130e48d48b21b57e3d9d26ff20013d2a34b5ef7bc27d9ba6cbad408d46096c7eede19c4ff0
+  metadata.gz: 42059f7dd06f6a17c25f0bbc55b40b50899bd8af109f1480faca73e8818bd429be250d90579a8905fdfd830e0177ae5c9b15f3aba23704acc2da1495e1a14e1d
+  data.tar.gz: 32743a287f05b96ca364713b6ad470b676fcb9822f5f285b38e7be9329302c4a980ef1676826c1b491f51e63a7156a8fc8952040f628747fece73ed3e7fd9e2a

data/.hound.yml

@@ -0,0 +1,8 @@
+javascript:
+  config_file: .jshintrc
+  ignore_file: .jshintignore
+scss:
+  exclude:
+    - 'vendor/assets/stylesheets/**'
+ruby:
+  config_file: .rubocop.yml

data/.jshintignore

@@ -0,0 +1,2 @@
+vendor/*
+app/assets/javascripts/vendor/*

data/.jshintrc

@@ -0,0 +1,67 @@
+{
+  /*
+   * ENVIRONMENTS
+   * =================
+   */
+
+  // Define globals exposed by modern browsers.
+  "browser": true,
+
+  // Define globals exposed by jQuery.
+  "jquery": true,
+
+  // Define globals exposed by Node.js.
+  "node": true,
+
+  // Allow ES6.
+  "esnext": true,
+
+  /*
+   * ENFORCING OPTIONS
+   * =================
+   */
+
+  // Force all variable names to use either camelCase style or UPPER_CASE
+  // with underscores.
+  "camelcase": true,
+
+  // Prohibit use of == and != in favor of === and !==.
+  "eqeqeq": true,
+
+  // Enforce tab width of 2 spaces.
+  "indent": 2,
+
+  // Prohibit use of a variable before it is defined.
+  "latedef": true,
+
+  // Enforce line length to 80 characters
+  "maxlen": 80,
+
+  // Require capitalized names for constructor functions.
+  "newcap": true,
+
+  // Enforce use of single quotation marks for strings.
+  "quotmark": "single",
+
+  // Enforce placing 'use strict' at the top function scope
+  "strict": true,
+
+  // Prohibit use of explicitly undeclared variables.
+  "undef": true,
+
+  // Warn when variables are defined but never used.
+  "unused": true,
+
+  /*
+   * RELAXING OPTIONS
+   * =================
+   */
+
+  // Suppress warnings about == null comparisons.
+  "eqnull": true,
+
+  // Custom predefined js stuff
+  "predef": [
+    "expect", "describe", "it", "xit", "spyOn", "fixture", "beforeEach", "afterEach", "L", "jasmine", "TestResponses"
+  ]
+}

data/.rubocop.yml

@@ -1,7 +1,7 @@
-require: rubocop-rspec
+Rails:
+  Enabled: true
 
 AllCops:
-  RunRailsCops: true
   DisplayCopNames: true
 
   Include:
@@ -42,4 +42,30 @@ RSpec/FilePath:
 # Rubocop bug causes view specs to fail.
 #  https://github.com/nevir/rubocop-rspec/issues/47
 RSpec/DescribeClass:
-  Enabled: false
+  Enabled: false
+
+# geoblacklight references in solr_document_spec are
+# difficult to mock because of the use of 'method_missing'.
+# https://relishapp.com/rspec/rspec-mocks/docs/verifying-doubles/dynamic-classes
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/models/concerns/geoblacklight/solr_document_spec.rb'
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: leading
+  SupportedStyles:
+  - leading
+  - trailing
+

data/Gemfile

@@ -3,25 +3,20 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in geoblacklight.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'
-
 group :development, :test do
   # Peg simplecov to < 0.8 until this is resolved:
   # https://github.com/colszowka/simplecov/issues/281
   gem 'simplecov', '~> 0.7.1', require: false
   gem 'coveralls', require: false
-  gem 'rubocop', '0.35.1', require: false
-  gem 'rubocop-rspec', '1.3.1', require: false
+  gem 'rubocop', '0.38.0', require: false
+  gem 'rubocop-rspec', '1.4.0', require: false
 end
 
 # BEGIN ENGINE_CART BLOCK
-# engine_cart: 0.8.0
-# engine_cart stanza: 0.8.0
+# engine_cart: 0.10.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__)))
+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
@@ -32,13 +27,22 @@ if File.exist?(file)
 else
   Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
 
-  gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+  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
 
-  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
-    gem 'responders', "~> 2.0"
-    gem 'sass-rails', ">= 5.0"
-  else
-    gem 'sass-rails', "< 5.0"
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+    gem 'coffee-rails', '~> 4.1.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
   end
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -1,6 +1,7 @@
 # Geoblacklight
 
 [![Build Status](https://travis-ci.org/geoblacklight/geoblacklight.svg?branch=master)](https://travis-ci.org/geoblacklight/geoblacklight) | [![Coverage Status](https://img.shields.io/coveralls/geoblacklight/geoblacklight.svg)](https://coveralls.io/r/geoblacklight/geoblacklight?branch=coveralls) | [![Gem Version](https://img.shields.io/gem/v/geoblacklight.svg)](https://github.com/geoblacklight/geoblacklight/releases)
+[![Stories in Ready](https://badge.waffle.io/geoblacklight/geoblacklight.png?label=ready&title=Ready)](https://waffle.io/geoblacklight/geoblacklight)
 
 GeoBlacklight is a world-class discovery platform for geospatial (GIS) holdings. It
 is an open collaborative project aiming to build off of the successes

data/Rakefile

@@ -5,8 +5,8 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-BLACKLIGHT_JETTY_VERSION = '4.10.3'
-ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v#{BLACKLIGHT_JETTY_VERSION}.zip"
+BLACKLIGHT_JETTY_VERSION = '4.10.3'.freeze
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v#{BLACKLIGHT_JETTY_VERSION}.zip".freeze
 APP_ROOT = File.dirname(__FILE__)
 
 require 'rspec/core/rake_task'
@@ -20,6 +20,7 @@ task default: :ci
 
 desc 'Run style checker'
 RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rspec'
   task.fail_on_error = true
 end
 

data/app/assets/javascripts/geoblacklight/basemaps.js

@@ -9,15 +9,6 @@ GeoBlacklight.Basemaps = {
       detectRetina: true
     }
   ),
-  mapquest: L.tileLayer(
-    'https://otile{s}-s.mqcdn.com/tiles/1.0.0/map/{z}/{x}/{y}.png', {
-      attribution: '&copy; <a href="http://openstreetmap.org">OpenStreetMap</a> contributors, Tiles Courtesy of <a href="http://www.mapquest.com/" target="_blank">MapQuest</a> <img src="//developer.mapquest.com/content/osm/mq_logo.png" alt="">',
-      maxZoom: 18,
-      worldCopyJump: true,
-      subdomains: '1234', // see http://developer.mapquest.com/web/products/open/map
-      detectRetina: true
-    }
-  ),
   positron: L.tileLayer(
     'https://cartodb-basemaps-{s}.global.ssl.fastly.net/light_all/{z}/{x}/{y}.png', {
       attribution: '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, &copy; <a href="http://cartodb.com/attributions">CartoDB</a>',

data/app/assets/javascripts/geoblacklight/controls.js

@@ -0,0 +1 @@
+//= require_tree ./controls

data/app/assets/javascripts/geoblacklight/controls/opacity.js

@@ -0,0 +1,8 @@
+/*global GeoBlacklight */
+
+'use strict';
+
+// Leaflet opacity control.
+GeoBlacklight.Controls.Opacity = function() {
+  this.map.addControl(new L.Control.LayerOpacity(this.overlay));
+};

data/app/assets/javascripts/geoblacklight/geoblacklight.js

@@ -20,7 +20,7 @@
 
   var GeoBlacklight = L.Class.extend({
     statics: {
-      __version__: '0.0.1',
+      __version__: '1.0.0.pre1',
 
       debounce: function(fn, delay) {
         var timeout = null;
@@ -35,6 +35,7 @@
     }
   });
 
+  // Hash for leaflet controls.
+  GeoBlacklight.Controls = {};
   global.GeoBlacklight = GeoBlacklight;
-
 }(this);

data/app/assets/javascripts/geoblacklight/viewers.js

@@ -1 +1 @@
-//= require_tree ./viewers
+//= require_tree ./viewers

data/app/assets/javascripts/geoblacklight/viewers/esri.js

@@ -31,9 +31,8 @@ GeoBlacklight.Viewer.Esri = GeoBlacklight.Viewer.Map.extend({
 
         // add layer to map
         if (_this.addPreviewLayer(layer)) {
-
-          // add control if layer is added
-          _this.addOpacityControl();
+          // add controls if layer is added
+          _this.loadControls();
         }
       }
     });

data/app/assets/javascripts/geoblacklight/viewers/esri/dynamic_map_layer.js

@@ -30,8 +30,8 @@ GeoBlacklight.Viewer.DynamicMapLayer = GeoBlacklight.Viewer.Esri.extend({
         // add layer to map
         if (_this.addPreviewLayer(layer)) {
 
-          // add control if layer is added
-          _this.addOpacityControl();
+          // add controls if layer is added
+          _this.loadControls();
         }
       }
     });

data/app/assets/javascripts/geoblacklight/viewers/esri/feature_layer.js

@@ -28,16 +28,12 @@ GeoBlacklight.Viewer.FeatureLayer = GeoBlacklight.Viewer.Esri.extend({
     return this.esriFeatureLayer;
   },
 
-  // override opacity control because feature layer is special
-  addOpacityControl: function() {
+  controlPreload: function() {
 
     // define setOpacity function that works for svg elements
     this.esriFeatureLayer.setOpacity = function(opacity) {
       $('.leaflet-clickable').css({ opacity: opacity });
     };
-
-    // add new opacity control
-    this.map.addControl(new L.Control.LayerOpacity(this.esriFeatureLayer));
   },
 
   getFeatureStyle: function() {

data/app/assets/javascripts/geoblacklight/viewers/iiif.js

@@ -9,7 +9,7 @@ GeoBlacklight.Viewer.Iiif = GeoBlacklight.Viewer.extend({
       crs: L.CRS.Simple,
       zoom: 0
     });
-
+    this.loadControls();
     this.iiifLayer = L.tileLayer.iiif(this.data.url)
       .addTo(this.map);
   },

data/app/assets/javascripts/geoblacklight/viewers/map.js

@@ -1,7 +1,6 @@
 //= require geoblacklight/viewers/viewer
 
 GeoBlacklight.Viewer.Map = GeoBlacklight.Viewer.extend({
-  
   options: {
     /**
     * Initial bounds of map
@@ -47,13 +46,6 @@ GeoBlacklight.Viewer.Map = GeoBlacklight.Viewer.extend({
     this.overlay.clearLayers();
   },
 
-  /**
-   * Add an opacity control to map.
-   */
-  addOpacityControl: function() {
-    this.map.addControl(new L.Control.LayerOpacity(this.overlay));
-  },
-
   /**
   * Selects basemap if specified in data options, if not return mapquest
   */
@@ -62,7 +54,7 @@ GeoBlacklight.Viewer.Map = GeoBlacklight.Viewer.extend({
     if (_this.data.basemap) {
       return GeoBlacklight.Basemaps[_this.data.basemap];
     } else {
-      return _this.basemap.mapquest;
+      return _this.basemap.positron;
     }
   }
 });

data/app/assets/javascripts/geoblacklight/viewers/viewer.js

@@ -1,3 +1,7 @@
+/*global GeoBlacklight */
+
+'use strict';
+
 // base viewer
 GeoBlacklight.Viewer = L.Class.extend({
   options: {},
@@ -8,7 +12,44 @@ GeoBlacklight.Viewer = L.Class.extend({
 
     L.Util.setOptions(this, options);
 
-    // trigger viewer load function
+    // trigger viewer load functions
     this.load();
+  },
+
+  /**
+  * Loads leaflet controls from controls directory.
+  **/
+  loadControls: function() {
+    var _this = this;
+    var protocol = this.data.protocol.toUpperCase();
+    var options = this.data.leafletOptions;
+
+    if (!options.VIEWERS) {
+      return;
+    }
+
+    var viewer = options.VIEWERS[protocol];
+    var controls = viewer && viewer.CONTROLS;
+
+    _this.controlPreload();
+
+    /**
+    * Loop though the GeoBlacklight.Controls hash, and for each control,
+    * check to see if it is included in the controls list for the current
+    * viewer. If it is, then pass in the viewer object and run the function
+    * that adds it to the map.
+    **/
+    $.each(GeoBlacklight.Controls, function(name, func) {
+      if (controls && controls.indexOf(name) > -1) {
+        func.call(_this);
+      }
+    });
+  },
+
+  /**
+  * Work to do before the controls are loaded.
+  **/
+  controlPreload: function() {
+    return;
   }
 });

data/app/assets/javascripts/geoblacklight/viewers/wms.js

@@ -10,7 +10,7 @@ GeoBlacklight.Viewer.Wms = GeoBlacklight.Viewer.Map.extend({
 
     if (this.data.available) {
       this.addPreviewLayer();
-      this.addOpacityControl();
+      this.loadControls();
     } else {
       this.addBoundsOverlay(this.options.bbox);
     }

data/app/assets/stylesheets/geoblacklight/modules/toolbar.scss

@@ -32,4 +32,8 @@
     text-align: center;
     width: 1.4em;
   }
+
+  .downloads {
+    padding-top: 15px;
+  }
 }

data/app/helpers/geoblacklight_helper.rb

@@ -15,16 +15,16 @@ module GeoblacklightHelper
     document_available? && @document.downloadable?
   end
 
-  def snippit(text)
-    if text
-      if text.length > 150
-        text.slice(0, 150) + '...'
-      else
-        text
-      end
-    else
-      ''
-    end
+  def iiif_jpg_url
+    @document.references.iiif.endpoint.sub! 'info.json', 'full/full/0/default.jpg'
+  end
+
+  ##
+  # Blacklight catalog controller helper method to truncate field value to 150 chars
+  # @param [SolrDocument] args
+  # @return [String]
+  def snippit(args)
+    truncate(Array(args[:value]).flatten.first, length: 150)
   end
 
   def render_facet_tags(facet)
@@ -50,7 +50,7 @@ module GeoblacklightHelper
   #
   def render_facet_links(facet, items)
     items.uniq.map do |item|
-      link_to item, catalog_index_path(f: { "#{facet}" => [item] })
+      link_to item, search_catalog_path(f: { facet => [item] })
     end.join(', ').html_safe
   end
 
@@ -98,7 +98,14 @@ module GeoblacklightHelper
   # Selects the basemap used for map displays
   # @return [String]
   def geoblacklight_basemap
-    blacklight_config.basemap_provider || 'mapquest'
+    blacklight_config.basemap_provider || 'positron'
+  end
+
+  ##
+  # Removes blank space from provider to accomodate CartoDB OneClick
+  #
+  def cartodb_provider
+    application_name.delete(' ')
   end
 
   ##
@@ -106,9 +113,9 @@ module GeoblacklightHelper
   # @param [String] file_link
   # @return [String]
   def cartodb_link(file_link)
-    params  = URI.encode_www_form(
+    params = URI.encode_www_form(
       file: file_link,
-      provider: application_name,
+      provider: cartodb_provider,
       logo: Settings.APPLICATION_LOGO_URL
     )
     Settings.CARTODB_ONECLICK_LINK + '?' + params
@@ -126,4 +133,11 @@ module GeoblacklightHelper
   rescue ActionView::MissingTemplate
     render partial: 'web_services_default', locals: { reference: reference }
   end
+
+  ##
+  # Returns a hash of the leaflet plugin settings to pass to the viewer.
+  # @return[Hash]
+  def leaflet_options
+    Settings.LEAFLET
+  end
 end