geoblacklight 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48c9e2e90c4bfabbb4748eb794be90c69a5781cb
-  data.tar.gz: 6df94d214fb1e14663bc20397d8618ba11443736
+  metadata.gz: b2b4e8cdd2abd133e663a53e4ffd289a4a3a985c
+  data.tar.gz: 5d78163437e30eb35a0ef6fa0a88ed8d8fe77a7c
 SHA512:
-  metadata.gz: dd18bfc6823fba943918ff5814b4240f9b8d6d7da4e8c1b57a0ecb50a00c4ce8b26b4c2420a74b2f14efbba8a1a1450092c86a8527c940648026012873507476
-  data.tar.gz: de73cdc4fe06a93e1f93ef87b7b4e70a043196c8521e19db2b8ecade2e98e28e6748068bf31e51693bbaa30c95d5631a2af2c0f2124f7553e330a17efd65ccf6
+  metadata.gz: 3516a9bcb20e42d49bad3ce0c4661a30a8b954da619f01372f36fe7e3ce8eb8b99bea0288a99fe2a13ddea48dad4cfa4cf5a42478589966e68b9f73fe093cc89
+  data.tar.gz: adf65bf73c7c7f56cfdca331beba85c47e71115e032177be4b8c7fe8858d468532778ecbe370f67095ed8aa573734f557c1eec7ebf2a53c65c67442a94176599

data/.gitignore

@@ -16,4 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 jetty
-.internal_test_app
+.internal_test_app

data/.solr_wrapper

@@ -0,0 +1,6 @@
+# Place any default configuration for solr_wrapper here
+# port: 8983
+collection:
+  dir: solr/conf/
+  name: blacklight-core
+ 

data/.travis.yml

@@ -1,12 +1,26 @@
-cache: bundler
 language: ruby
 sudo: false
+
 notifications:
   email: false
 
 rvm:
-  - 2.1
+  - 2.3.1
+
+matrix:
+  include:
+    - rvm: 2.3.1
+      env: "RAILS_VERSION=4.2.6"
+    - rvm: 2.2.5
+      env: "RAILS_VERSION=5.0.0"
+
+before_install:
+  - gem install bundler
 
 env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+ - "RAILS_VERSION=5.0.0"
+
+global_env:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+jdk: oraclejdk8

data/README.md

@@ -17,13 +17,11 @@ Creating a new GeoBlacklight application from the template
 $ rails new app-name -m https://raw.githubusercontent.com/geoblacklight/geoblacklight/master/template.rb
 ```
 
-To install Solr (with Jetty)
+To launch app:
 
 ```
 $ cd app-name
-$ rake jetty:download
-$ rake jetty:unzip
-$ rake geoblacklight:configure_solr
+$ rake geoblacklight:server
 ```
 
 Or install with [Docker](https://github.com/geoblacklight/geoblacklight-docker)

data/Rakefile

@@ -1,22 +1,18 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'rails'
 begin
-  require 'bundler/gem_tasks'
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-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'
+require 'solr_wrapper'
 require 'engine_cart/rake_task'
-require 'jettywrapper'
+require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
-Dir.glob('lib/tasks/configure_solr.rake').each { |r| load r }
-
-task default: :ci
+EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
 
 desc 'Run style checker'
 RuboCop::RakeTask.new(:rubocop) do |task|
@@ -29,38 +25,65 @@ task spec: :rubocop do
   RSpec::Core::RakeTask.new(:spec)
 end
 
-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:downloads:mkdir'
-  end
-end
-
 desc 'Run Teaspoon JavaScript tests'
 task :teaspoon do
   system('teaspoon --require=.internal_test_app/spec/teaspoon_env.rb')
 end
 
-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'
-    jetty_params = Jettywrapper.load_config
-    jetty_params[:startup_wait] = 60
+desc 'Run test suite'
+task ci: ['geoblacklight:generate'] do
+  SolrWrapper.wrap do |solr|
+    solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path('.', File.dirname(__FILE__)), 'solr', 'conf')) do
+      within_test_app do
+        system 'RAILS_ENV=test rake geoblacklight:index:seed'
+      end
+      Rake::Task['geoblacklight:coverage'].invoke
+    end
+  end
+  # Run JavaScript tests
+  Rake::Task['teaspoon'].invoke
+end
+
+namespace :geoblacklight do
+  desc 'Run tests with coverage'
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['spec'].invoke
+  end
+
+  desc 'Create the test rails app'
+  task generate: ['engine_cart:generate'] do
+  end
+
+  namespace :internal do
+    task seed: ['engine_cart:generate'] do
+      within_test_app do
+        system 'bundle exec rake geoblacklight:index:seed'
+        system 'bundle exec rake geoblacklight:downloads:mkdir'
+      end
+    end
+  end
 
-    Jettywrapper.wrap(jetty_params) do
-      Rake::Task['fixtures'].invoke
+  desc 'Run Solr and GeoBlacklight for interactive development'
+  task :server, [:rails_server_args] do |_t, args|
+    if File.exist? EngineCart.destination
+      within_test_app do
+        system 'bundle update'
+      end
+    else
+      Rake::Task['engine_cart:generate'].invoke
+    end
 
-      # run the tests
-      Rake::Task['spec'].invoke
+    SolrWrapper.wrap(port: '8983') do |solr|
+      solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path('.', File.dirname(__FILE__)), 'solr', 'conf')) do
+        Rake::Task['geoblacklight:internal:seed'].invoke
+
+        within_test_app do
+          system "bundle exec rails s #{args[:rails_server_args]}"
+        end
+      end
     end
-    # Run JavaScript tests
-    Rake::Task['teaspoon'].invoke
-  else
-    system('rake ci RAILS_ENV=test')
   end
 end
+
+task default: [:ci]

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

@@ -20,7 +20,7 @@
 
   var GeoBlacklight = L.Class.extend({
     statics: {
-      __version__: '1.0.3',
+      __version__: '1.1.0',
 
       debounce: function(fn, delay) {
         var timeout = null;

data/app/assets/stylesheets/geoblacklight/modules/icon-customization.scss

@@ -42,7 +42,11 @@
   @extend .fa, .fa-file-text-o;
 }
 
-.geoblacklight-cartodb {
+.geoblacklight-carto {
   @extend .fa, .fa-map-marker;
 }
 
+// DEPRECATED: Will be removed in GeoBlacklight v2.0
+.geoblacklight-cartodb {
+  @extend .geoblacklight-cartodb;
+}

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

@@ -33,6 +33,12 @@
     width: 1.4em;
   }
 
+  .geoblacklight-carto {
+    text-align: center;
+    width: 1.4em;
+  }
+
+  // DEPRECATED: Will be removed in GeoBlacklight v2.0
   .geoblacklight-cartodb {
     text-align: center;
     width: 1.4em;

data/app/helpers/carto_helper.rb

@@ -0,0 +1,36 @@
+module CartoHelper
+  ##
+  # Creates a Carto OneClick link link, using the configuration link
+  # @param [String] file_link
+  # @return [String]
+  def carto_link(file_link)
+    params = URI.encode_www_form(
+      file: file_link,
+      provider: carto_provider,
+      logo: Settings.APPLICATION_LOGO_URL
+    )
+    carto_oneclick_host + '?' + params
+  end
+
+  ##
+  # Removes blank space from provider to accomodate Carto OneClick
+  #
+  def carto_provider
+    application_name.delete(' ')
+  end
+
+  private
+
+  ##
+  # Method used to access setting and provide deprecation warnings to migrate
+  def carto_oneclick_host
+    if Settings.CARTODB_ONECLICK_LINK.present?
+      Deprecation.warn(
+        GeoblacklightHelper,
+        'Settings.CARTODB_ONECLICK_LINK is deprecated and will be removed in ' \
+        'Geoblacklight 2.0.0, use Settings.CARTO_ONECLICK_LINK instead'
+      )
+    end
+    Settings.CARTO_ONECLICK_LINK || Settings.CARTODB_ONECLICK_LINK
+  end
+end

data/app/helpers/geoblacklight_helper.rb

@@ -1,4 +1,7 @@
 module GeoblacklightHelper
+  extend Deprecation
+  self.deprecation_horizon = 'Geoblacklight 2.0.0'
+
   def sms_helper
     content_tag(:i, '', class: 'fa fa-mobile fa-fw') + ' ' + t('blacklight.tools.sms')
   end
@@ -103,23 +106,21 @@ module GeoblacklightHelper
 
   ##
   # Removes blank space from provider to accomodate CartoDB OneClick
-  #
+  # @deprecated Use {#carto_provider} instead.
   def cartodb_provider
-    application_name.delete(' ')
+    carto_provider
   end
+  deprecation_deprecate cartodb_provider: 'use GeoblacklightHelper#carto_provider instead'
 
   ##
-  # Creates a CartoDB OneClick link link, using the configuration link
+  # Creates a Carto OneClick link link, using the configuration link
   # @param [String] file_link
   # @return [String]
+  # @deprecated Use {#carto_link} instead.
   def cartodb_link(file_link)
-    params = URI.encode_www_form(
-      file: file_link,
-      provider: cartodb_provider,
-      logo: Settings.APPLICATION_LOGO_URL
-    )
-    Settings.CARTODB_ONECLICK_LINK + '?' + params
+    carto_link(file_link)
   end
+  deprecation_deprecate carto_link: 'use GeoblacklightHelper#carto_link instead'
 
   ##
   # Renders the partials for a Geoblacklight::Reference in the web services

data/app/models/concerns/geoblacklight/solr_document.rb

@@ -4,7 +4,7 @@ module Geoblacklight
     extend Blacklight::Solr::Document
 
     include Geoblacklight::SolrDocument::Finder
-    include Geoblacklight::SolrDocument::CartoDb
+    include Geoblacklight::SolrDocument::Carto
     include Geoblacklight::SolrDocument::Inspection
 
     delegate :download_types, to: :references

data/app/models/concerns/geoblacklight/solr_document/carto.rb

@@ -0,0 +1,28 @@
+module Geoblacklight
+  module SolrDocument
+    ##
+    # Module for providing external Carto download references for a document
+    module Carto
+      extend Deprecation
+      self.deprecation_horizon = 'Geoblacklight 2.0.0'
+      ##
+      # Returns a url to a file that should be used with CartoDB integration
+      # @return [String]
+      # @deprecated Use {#carto_reference} instead
+      def cartodb_reference
+        carto_reference
+      end
+      deprecation_deprecate(
+        cartodb_reference: 'use Geoblacklight::SolrDocument::Carto#carto_reference instead'
+      )
+
+      ##
+      # Returns a url to a file that should be used with CartoDB integration
+      # @return [String]
+      def carto_reference
+        return unless public? && download_types.try(:[], :geojson).present?
+        Geoblacklight::GeojsonDownload.new(self).url_with_params
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 <% document ||= @document %>
-<% if document.cartodb_reference.present? %>
-    <%= link_to(cartodb_link(document.cartodb_reference), target: '_blank') do %>
-    <span class='geoblacklight geoblacklight-cartodb'></span>Open in CartoDB
+<% if document.carto_reference.present? %>
+    <%= link_to(carto_link(document.carto_reference), target: '_blank') do %>
+    <span class='geoblacklight geoblacklight-carto'></span><%= t('geoblacklight.tools.open_carto') %>
     <% end %>
 <% end %>

data/config/initializers/rails_config.rb

@@ -1,3 +1,3 @@
-RailsConfig.setup do |config|
+Config.setup do |config|
   config.const_name = 'Settings'
 end

data/config/locales/geoblacklight.en.yml

@@ -13,6 +13,7 @@ en:
       map_heading: 'Find by location'
     tools:
       login_to_view: 'Login to view and download'
+      open_carto: 'Open in Carto'
     formats:
       arcgrid: 'ArcGRID'
       geojson: 'GeoJSON'

data/geoblacklight.gemspec

@@ -18,21 +18,22 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'rails', '>= 4.2.0', '< 6'
   spec.add_dependency 'blacklight', '~> 6.3'
   spec.add_dependency 'leaflet-rails', '~> 0.7.3'
   spec.add_dependency 'font-awesome-rails'
-  spec.add_dependency 'rails_config', '~> 0.4.2'
+  spec.add_dependency 'config'
   spec.add_dependency 'faraday'
   spec.add_dependency 'coderay'
   spec.add_dependency 'geoblacklight-icons', '>= 0.2'
+  spec.add_dependency 'deprecation'
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rake', '~> 11.0.1'
-  spec.add_development_dependency 'rspec-rails', '~> 3.4.2'
-  spec.add_development_dependency 'jettywrapper', '>= 2.0'
+  spec.add_development_dependency 'solr_wrapper'
+  spec.add_development_dependency 'rails-controller-testing'
+  spec.add_development_dependency 'rspec-rails', '~> 3.1'
   spec.add_development_dependency 'engine_cart', '~> 0.10'
-  spec.add_development_dependency 'capybara', '~> 2.3.0'
-  spec.add_development_dependency 'poltergeist', '~> 1.5'
+  spec.add_development_dependency 'capybara', '>= 2.5.0'
+  spec.add_development_dependency 'poltergeist'
   spec.add_development_dependency 'factory_girl_rails'
-  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'database_cleaner', '~> 1.3'
 end

data/lib/generators/geoblacklight/install_generator.rb

@@ -4,13 +4,12 @@ module Geoblacklight
   class Install < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
 
-    class_option :jettywrapper,
-                 type: :boolean,
-                 default: false,
-                 desc: 'Use jettywrapper to download and control Jetty'
-
     desc 'Install Geoblacklight'
 
+    def add_solr_wrapper
+      generate 'blacklight:solr5'
+    end
+
     def mount_geoblacklight_engine
       route "mount Geoblacklight::Engine => 'geoblacklight'"
     end
@@ -36,15 +35,6 @@ module Geoblacklight
       EOF
     end
 
-    def install_jettywrapper
-      return unless options[:jettywrapper]
-      copy_file 'config/jetty.yml'
-
-      append_to_file 'Rakefile',
-                     "\nZIP_URL = \"https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.3.zip\"\n" \
-                       "require 'jettywrapper'\n"
-    end
-
     def assets
       copy_file 'geoblacklight.scss', 'app/assets/stylesheets/geoblacklight.scss'
       copy_file 'geoblacklight.js', 'app/assets/javascripts/geoblacklight.js'
@@ -62,6 +52,10 @@ module Geoblacklight
       copy_file 'settings.yml', 'config/settings.yml'
     end
 
+    def solr_config
+      directory '../../../../solr', 'solr'
+    end
+
     def include_geoblacklight_solrdocument
       inject_into_file 'app/models/solr_document.rb', after: 'include Blacklight::Solr::Document' do
         "\n include Geoblacklight::SolrDocument"