geoblacklight 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 106c28b41125452b5d2c19d0d0c1fbeefaa6e631
-  data.tar.gz: 9ea22aed584240ada2cc9ccb162389e05c39cd28
+  metadata.gz: dfda49bfa6025f3416c022717d15dcd41c134703
+  data.tar.gz: 0423a836a4df4ae842fdc528ae74c22b0ecb9090
 SHA512:
-  metadata.gz: 468e4f97b1f872c0faba11f0d9c03681801b112a63096d4241b498270e8637a4de03f33eabd8093454e94f9c6ea7ba0cf82c667d98734dd75c1f77ac1093cad5
-  data.tar.gz: 7454480d52a43d167ec83b42bb9f072b8954f6d3c2bb5089d919e26a3194c3d2dd273844fded3edd565d5a7a2563e2809f88ec5701c6fc21d721435a867085c5
+  metadata.gz: a97618a0fd0ba4623f1e3d7c6cb78273c01b76da95eba0005fd471e65b87068e85ff0e23863b21571a5b3bb8c092f7ecd3ace080b5e116f5f42c9ab4f8cfd73d
+  data.tar.gz: 473b5f90e4a81b9e05714344b8d1d8878c43fa5de0b410316753aaca2b7bd52265fb250bf50e368aae9c818521c019f1bdea3a7ca93fe0c6786db3a7582514f8

data/.gitignore

@@ -15,5 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-spec/internal
 jetty
+.internal_test_app

data/.rubocop.yml

@@ -0,0 +1,45 @@
+require: rubocop-rspec
+
+AllCops:
+  RunRailsCops: true
+  DisplayCopNames: true
+
+  Include:
+  - '**/Rakefile'
+
+  Exclude:
+  - 'db/**/*'
+  - 'vendor/**/*'
+  - '.internal_test_app/**/*'
+  - 'lib/generators/geoblacklight/templates/**/*'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+  - 'spec/**/*'
+  - 'Rakefile'
+  - 'lib/generators/geoblacklight/install_generator.rb'
+
+# TODO: Refactor large methods.
+Metrics/AbcSize:
+  Max: 23
+
+Metrics/MethodLength:
+  Max: 15
+
+# TODO: Add top-level class and module documentation.
+Style/Documentation:
+  Enabled: false
+
+# Overrides method in blacklight. Must use method name.
+Style/PredicateName:
+  Exclude:
+    - 'lib/geoblacklight/view_helper_override.rb'
+
+RSpec/FilePath:
+  Enabled: false
+
+# Rubocop bug causes view specs to fail.
+#  https://github.com/nevir/rubocop-rspec/issues/47
+RSpec/DescribeClass:
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+## Contributing
+GeoBlacklight is a collaborative open source projects where contributions are welcome. This contributing guide is borrowed in part from the [Hydra Contributing Guide](https://github.com/projecthydra/hydra/blob/master/CONTRIBUTING.md) and the [Blacklight Contributing Wiki](https://github.com/projectblacklight/blacklight/wiki/Contributing-to-Blacklight).
+
+### Reporting issues
+Did you find a bug in GeoBlacklight or interested in a new feature? Make sure to add an issue for it in the [issue tracker](https://github.com/geoblacklight/geoblacklight/issues).
+
+ - Make sure you have a [GitHub account](https://github.com/signup/free)
+ - Submit a [Github issue](./issues) by:
+    - Clearly describing the issue
+    - Provide a descriptive summary
+    - Explain the expected behavior
+    - Explain the actual behavior
+    - Provide steps to reproduce the actual behavior
+
+
+### Contributing code or documentation
+GeoBlacklight welcomes code and documentation contributions. We follow the [pull request](https://help.github.com/articles/using-pull-requests/) model for contributing on GitHub.
+
+#### Pull request overview
+1. Fork it ( http://github.com/my-github-username/geoblacklight/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
+
+#### Merging Changes
+
+- It is considered "poor from" to merge your own request.
+- Please take the time to review the changes and get a sense of what is being changed. Things to consider:
+  - Does the commit message explain what is going on?
+  - Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
+  - Do all new methods, modules, and classes have comments? Do changed methods, modules, and classes have comments?
+  - Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
+  - Did the Travis tests complete successfully?
+- If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.
+- If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
+
+If you wish to ask questions or participate further, email the [GeoBlacklight Working Group](https://groups.google.com/forum/#!forum/geoblacklight-working-group) at [geoblacklight-working-group@googlegroups.com](mailto:geoblacklight-working-group@googlegroups.com).

data/Gemfile

@@ -8,16 +8,37 @@ gemspec
 # it'll want sprockets 2.11.0 and we'll have a conflict
 gem 'sprockets', '2.11.0'
 
-group :test do
+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
 end
 
-# load local rails test instance Gemfile
-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)
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 0.8.0
+# engine_cart stanza: 0.8.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"
+
+  gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+
+  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"
+  end
 end
+# END ENGINE_CART BLOCK

data/README.md

@@ -28,15 +28,8 @@ $ rake geoblacklight:configure_solr
 Or install with [Docker](https://github.com/geoblacklight/geoblacklight-docker)
 For more information see the [installation guide](https://github.com/geoblacklight/geoblacklight/wiki/Installation)
 
-###[Contributing](https://github.com/geoblacklight/geoblacklight/wiki/Contributing)
-
-1. Fork it ( http://github.com/my-github-username/geoblacklight/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
-
-Also, if you wish to ask questions or participate further, email the [GeoBlacklight Working Group](https://groups.google.com/forum/#!forum/geoblacklight-working-group) at [geoblacklight-working-group@googlegroups.com](mailto:geoblacklight-working-group@googlegroups.com).
+### Contributing
+Interested in contributing to GeoBlacklight? Please see our [contributing](CONTRIBUTING.md) guide.
 
 ###[Development](https://github.com/geoblacklight/geoblacklight/wiki/Development)
 

data/Rakefile

@@ -12,41 +12,50 @@ APP_ROOT = File.dirname(__FILE__)
 require 'rspec/core/rake_task'
 require 'engine_cart/rake_task'
 require 'jettywrapper'
+require 'rubocop/rake_task'
 
-Dir.glob('lib/tasks/configure_solr.rake').each { |r| load r}
+Dir.glob('lib/tasks/configure_solr.rake').each { |r| load r }
 
 task default: :ci
 
-RSpec::Core::RakeTask.new(:spec)
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
+
+desc 'Run test suite and style checker'
+task spec: :rubocop do
+  RSpec::Core::RakeTask.new(:spec)
+end
 
-desc "Load fixtures"
-task :fixtures => ['engine_cart:generate'] do
+desc 'Load fixtures'
+task fixtures: ['engine_cart:generate'] do
   EngineCart.within_test_app do
-    system "rake geoblacklight:solr:seed RAILS_ENV=test"
+    system 'rake geoblacklight:solr:seed RAILS_ENV=test'
     system 'rake geoblacklight:downloads:mkdir'
   end
 end
 
 desc 'Run Teaspoon JavaScript tests'
 task :teaspoon do
-  system("TEASPOON_RAILS_ENV='./spec/internal/config/environment' teaspoon --require=spec/internal/spec/teaspoon_env.rb")
+  system('teaspoon --require=.internal_test_app/spec/teaspoon_env.rb')
 end
 
-desc "Execute Continuous Integration build"
+desc 'Execute Continuous Integration build'
 task :ci do
   if Rails.env.test?
     Rake::Task['engine_cart:generate'].invoke
     Rake::Task['jetty:clean'].invoke
     Rake::Task['geoblacklight:configure_solr'].invoke
-    ENV['environment'] = "test"
+    ENV['environment'] = 'test'
     jetty_params = Jettywrapper.load_config
-    jetty_params[:startup_wait]= 60
+    jetty_params[:startup_wait] = 60
 
     Jettywrapper.wrap(jetty_params) do
-      Rake::Task["fixtures"].invoke
+      Rake::Task['fixtures'].invoke
 
       # run the tests
-      Rake::Task["spec"].invoke
+      Rake::Task['spec'].invoke
     end
     # Run JavaScript tests
     Rake::Task['teaspoon'].invoke

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

@@ -5,7 +5,8 @@ GeoBlacklight.Basemaps = {
     'https://cartodb-basemaps-{s}.global.ssl.fastly.net/dark_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>',
       maxZoom: 18,
-      worldCopyJump: true
+      worldCopyJump: true,
+      detectRetina: true
     }
   ),
   mapquest: L.tileLayer(
@@ -13,14 +14,16 @@ GeoBlacklight.Basemaps = {
       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
+      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>',
       maxZoom: 18,
-      worldCopyJump: true
+      worldCopyJump: true,
+      detectRetina: true
     }
   )
 };

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

@@ -4,11 +4,19 @@
   'use strict';
 
   L.Control.LayerOpacity = L.Control.extend({
-    initialize: function(layerGroup) {
-      var options = {
-        position: 'topleft',
-        layer: layerGroup.getLayers()[0]
-      };
+    initialize: function(layer) {
+      var options = { position: 'topleft' };
+
+      // check if layer is actually a layer group
+      if (typeof layer.getLayers !== 'undefined') {
+
+        // add first layer from layer group to options 
+        options.layer = layer.getLayers()[0];
+      } else {
+
+        // add layer to options
+        options.layer = layer;
+      }
 
       L.Util.setOptions(this, options);
     },

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

@@ -46,6 +46,13 @@ 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
   */

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

@@ -23,16 +23,13 @@ GeoBlacklight.Viewer.Wms = GeoBlacklight.Viewer.Map.extend({
       transparent: true,
       tiled: true,
       CRS: 'EPSG:900913',
-      opacity: 0.75
+      opacity: 0.75,
+      detectRetina: true
     });
     this.overlay.addLayer(wmsLayer);
     this.setupInspection();
   },
 
-  addOpacityControl: function() {
-    this.map.addControl(new L.Control.LayerOpacity(this.overlay));
-  },
-
   setupInspection: function() {
     var _this = this;
     this.map.on('click', function(e) {

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

@@ -2,7 +2,7 @@
   height: 440px;
 }
 
-[data-protocol="wms"][data-available="true"] {
+[data-inspect="true"][data-available="true"] {
   cursor: crosshair;
 }
 

data/app/controllers/download_controller.rb

@@ -59,7 +59,7 @@ class DownloadController < ApplicationController
   # Creates an error flash message with failed download url
   # @param [Geoblacklight::Exceptions::ExternalDownloadFailed] Download failed
   # exception
-  # @return [String] error message to display in flash 
+  # @return [String] error message to display in flash
   def flash_error_message(exception)
     if exception.url
       message = t('geoblacklight.download.error_with_url',
@@ -71,6 +71,7 @@ class DownloadController < ApplicationController
     else
       message = t('geoblacklight.download.error')
     end
+    message
   end
 
   private
@@ -81,26 +82,29 @@ class DownloadController < ApplicationController
 
   def check_type
     response = case params[:type]
-    when 'shapefile'
-      Geoblacklight::ShapefileDownload.new(@document).get
-    when 'kmz'
-      Geoblacklight::KmzDownload.new(@document).get
-    when 'geojson'
-      Geoblacklight::GeojsonDownload.new(@document).get
-    when 'geotiff'
-      Geoblacklight::GeotiffDownload.new(@document).get
-    end
+               when 'shapefile'
+                 Geoblacklight::ShapefileDownload.new(@document).get
+               when 'kmz'
+                 Geoblacklight::KmzDownload.new(@document).get
+               when 'geojson'
+                 Geoblacklight::GeojsonDownload.new(@document).get
+               when 'geotiff'
+                 Geoblacklight::GeotiffDownload.new(@document).get
+               end
+    response
   end
 
   def validate(response)
-    flash[:success] = view_context.link_to(t('geoblacklight.download.success', title: response), download_file_path(response), data: { download: 'trigger', download_id: params[:id], download_type: "generated-#{params[:type]}"})
+    flash[:success] = view_context.link_to(t('geoblacklight.download.success', title: response),
+                                           download_file_path(response),
+                                           data: { download: 'trigger',
+                                                   download_id: params[:id],
+                                                   download_type: "generated-#{params[:type]}" })
   end
 
   # Checks whether a document is public, if not require user to authenticate
   def restricted_should_authenticate
-    unless @document.public?
-      authenticate_user!
-    end
+    authenticate_user! unless @document.public?
   end
 
   def file_name_to_id(file_name)

data/app/controllers/wms_controller.rb

@@ -1,6 +1,6 @@
 class WmsController < ApplicationController
   def handle
-    response = Geoblacklight::WmsLayer.new(params).get_feature_info
+    response = Geoblacklight::WmsLayer.new(params).feature_info
 
     respond_to do |format|
       format.json { render json: response }

data/app/helpers/geoblacklight_helper.rb

@@ -1,11 +1,10 @@
 module GeoblacklightHelper
-
-  def sms_helper()
-    content_tag(:i, '', :class => 'fa fa-mobile fa-fw') + ' ' + t('blacklight.tools.sms')
+  def sms_helper
+    content_tag(:i, '', class: 'fa fa-mobile fa-fw') + ' ' + t('blacklight.tools.sms')
   end
 
   def email_helper
-    content_tag(:i, '', :class => 'fa fa-envelope fa-fw') + ' ' + t('blacklight.tools.email')
+    content_tag(:i, '', class: 'fa fa-envelope fa-fw') + ' ' + t('blacklight.tools.email')
   end
 
   def document_available?
@@ -17,9 +16,9 @@ module GeoblacklightHelper
   end
 
   def snippit(text)
-    if (text)
-      if (text.length > 150)
-        text.slice(0,150) + '...'
+    if text
+      if text.length > 150
+        text.slice(0, 150) + '...'
       else
         text
       end
@@ -29,11 +28,16 @@ module GeoblacklightHelper
   end
 
   def render_facet_tags(facet)
-    render_facet_limit(facets_from_request(facet).first, partial: 'facet_tag_item', layout: 'facet_tag_layout')
+    render_facet_limit(facets_from_request(facet).first,
+                       partial: 'facet_tag_item',
+                       layout: 'facet_tag_layout')
   end
 
   def geoblacklight_icon(name)
-    content_tag :span, '', class: "geoblacklight-icon geoblacklight-#{name.downcase.gsub(' ', '-')}", title: name
+    content_tag :span,
+                '',
+                class: "geoblacklight-icon geoblacklight-#{name.downcase.tr(' ', '-')}",
+                title: name
   end
 
   def render_search_form_no_navbar
@@ -45,7 +49,9 @@ module GeoblacklightHelper
   # passed in using the facet parameter
   #
   def render_facet_links(facet, items)
-    items.uniq.map { |item| link_to item, catalog_index_path(f: { "#{facet}" => [item] }) }.join(', ').html_safe
+    items.uniq.map do |item|
+      link_to item, catalog_index_path(f: { "#{facet}" => [item] })
+    end.join(', ').html_safe
   end
 
   ##
@@ -71,7 +77,7 @@ module GeoblacklightHelper
   end
 
   def show_attribute_table?
-    return true if document_available? && @document.viewer_protocol == 'wms'
+    document_available? && @document.inspectable?
   end
 
   ##