geoblacklight 2.3.0

data/spec/models/concerns/geoblacklight/spatial_search_behavior_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Geoblacklight::SpatialSearchBehavior do
+  subject { search_builder.with(user_params) }
+
+  let(:user_params) { Hash.new }
+  let(:solr_params) { Hash.new }
+  let(:blacklight_config) { CatalogController.blacklight_config.deep_copy }
+  let(:context) { CatalogController.new }
+  let(:search_builder_class) do
+    Class.new(Blacklight::SearchBuilder).tap do |klass|
+      include Blacklight::Solr::SearchBuilderBehavior
+      klass.include(described_class)
+    end
+  end
+  let(:search_builder) { search_builder_class.new(context) }
+
+  describe '#add_spatial_params' do
+    it 'returns the solr_params when no bbox is given' do
+      expect(subject.add_spatial_params(solr_params)).to eq solr_params
+    end
+
+    context 'when given a bounding box' do
+      let(:params) do
+        { bbox: '-180 -80 120 80' }
+      end
+
+      before do
+        subject.with(params)
+      end
+
+      it 'returns a spatial search if bbox is given' do
+        expect(subject.add_spatial_params(solr_params)[:fq].to_s).to include('Intersects')
+      end
+
+      it 'applies boost based on configured Settings.BBOX_WITHIN_BOOST' do
+        allow(Settings).to receive(:BBOX_WITHIN_BOOST).and_return 99
+        expect(subject.add_spatial_params(solr_params)[:bq].to_s).to include('^99')
+      end
+
+      it 'applies default boost of 10 when Settings.BBOX_WITHIN_BOOST not configured' do
+        allow(Settings).to receive(:BBOX_WITHIN_BOOST).and_return nil
+        expect(subject.add_spatial_params(solr_params)[:bq].to_s).to include('^10')
+      end
+
+      it 'applies overlapRatio when Settings.OVERLAP_RATIO_BOOST is configured' do
+        allow(Settings).to receive(:OVERLAP_RATIO_BOOST).and_return 2
+        expect(subject.add_spatial_params(solr_params)[:bf].to_s).to include('$overlap^2')
+      end
+
+      it 'does not apply overlapRatio when Settings.OVERLAP_RATIO_BOOST not configured' do
+        allow(Settings).to receive(:OVERLAP_RATIO_BOOST).and_return nil
+        expect(subject.add_spatial_params(solr_params)).not_to have_key(:overlap)
+      end
+
+      context 'when the wrong format for the bounding box is used' do
+        before do
+          allow(subject).to receive(:bounding_box).and_raise(Geoblacklight::Exceptions::WrongBoundingBoxFormat)
+        end
+
+        it 'returns the spatial search without the boost or filter queries' do
+          expect(subject.add_spatial_params(solr_params)).to eq(bq: [])
+        end
+      end
+    end
+  end
+  describe '#envelope_bounds' do
+    let(:bbox) { instance_double(Geoblacklight::BoundingBox) }
+    before do
+      allow(bbox).to receive(:to_envelope).and_return('test')
+    end
+    it 'calls to_envelope on the bounding box' do
+      expect(subject).to receive(:bounding_box).and_return bbox
+      expect(subject.envelope_bounds).to eq 'test'
+    end
+  end
+  describe '#bounding_box' do
+    it 'creates a bounding box from a Solr lat-lon rectangle format' do
+      params = { bbox: '-120 -80 120 80' }
+      subject.with(params)
+      expect(subject.bounding_box).to be_an Geoblacklight::BoundingBox
+    end
+  end
+end

data/spec/routing/catalog_routing_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'Catalog Routes', type: :routing do
+  # Test paths for custom routes
+  it "maps { :controller => 'catalog', :action => 'opensearch', :format => 'xml' } to /catalog/opensearch.xml" do
+    expect(get: '/catalog/opensearch.xml').to route_to(controller: 'catalog', action: 'opensearch', format: 'xml')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+)
+SimpleCov.start 'rails' do
+  add_filter 'lib/generators/geoblacklight/install_generator.rb'
+  add_filter 'lib/geoblacklight/version.rb'
+  add_filter 'lib/generators/geoblacklight/templates'
+  add_filter '/spec'
+  add_filter '.internal_test_app/'
+end
+
+require 'factory_bot'
+require 'database_cleaner'
+
+require 'engine_cart'
+EngineCart.load_application!
+
+require 'rails-controller-testing' if Rails::VERSION::MAJOR >= 5
+require 'rspec/rails'
+require 'capybara/rspec'
+require 'selenium-webdriver'
+
+Capybara.register_driver(:headless_chrome) do |app|
+  Capybara::Selenium::Driver.load_selenium
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    opts.args << '--headless'
+    opts.args << '--disable-gpu'
+    opts.args << '--window-size=1280,1024'
+  end
+  http_client = Selenium::WebDriver::Remote::Http::Default.new
+  http_client.read_timeout = 120
+  http_client.open_timeout = 120
+  Capybara::Selenium::Driver.new(app,
+                                 browser: :chrome,
+                                 http_client: http_client,
+                                 options: browser_options)
+end
+
+Capybara.javascript_driver = :headless_chrome
+Capybara.default_max_wait_time = 120
+
+require 'geoblacklight'
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
+FactoryBot.definition_file_paths = [File.expand_path('../factories', __FILE__)]
+FactoryBot.find_definitions
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.before :each do
+    DatabaseCleaner.strategy = if Capybara.current_driver == :rack_test
+                                 :transaction
+                               else
+                                 :truncation
+                               end
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+  if Rails::VERSION::MAJOR >= 5
+    config.include ::Rails.application.routes.url_helpers
+    config.include ::Rails.application.routes.mounted_helpers
+  else
+    config.include BackportTestHelpers, type: :controller
+  end
+
+  config.include Devise::Test::ControllerHelpers, type: :controller
+end

data/spec/support/backport_test_helpers.rb

@@ -0,0 +1,45 @@
+# Backport the Rails 5 controller test methods to Rails 4
+module BackportTestHelpers
+  def delete(*args)
+    (action, rest) = *args
+    rest ||= {}
+
+    @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest' if rest[:xhr]
+
+    super(action, rest[:params])
+  end
+
+  def get(*args)
+    (action, rest) = *args
+    rest ||= {}
+    @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest' if rest[:xhr]
+    super(action, rest[:params])
+  end
+
+  def post(*args)
+    (action, rest) = *args
+    rest ||= {}
+    body = rest[:body]
+    @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest' if rest[:xhr]
+
+    if body
+      super(action, body, rest.except(:params).merge(rest[:params]))
+    else
+      super(action, rest[:params])
+    end
+  end
+
+  def put(*args)
+    (action, rest) = *args
+    rest ||= {}
+    @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest' if rest[:xhr]
+    super(action, rest[:params])
+  end
+
+  def patch(*args)
+    (action, rest) = *args
+    rest ||= {}
+    @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest' if rest[:xhr]
+    super(action, rest[:params])
+  end
+end

data/spec/support/features.rb

@@ -0,0 +1,5 @@
+require File.expand_path('../features/session_helpers.rb', __FILE__)
+
+RSpec.configure do |config|
+  config.include Features::SessionHelpers, type: :feature
+end

data/spec/support/features/session_helpers.rb

@@ -0,0 +1,20 @@
+module Features
+  module SessionHelpers
+    def sign_up_with(email, password)
+      visit new_user_registration_path
+      fill_in 'Email', with: email
+      fill_in 'Password', with: password
+      click_button 'Sign up'
+    end
+
+    def sign_in
+      user = FactoryBot.create(:user)
+      user.save
+      visit new_user_session_path
+      fill_in 'user_email', with: user.email
+      fill_in 'user_password', with: user.password
+      click_button 'Log in'
+      expect(page).to have_content 'Signed in successfully.'
+    end
+  end
+end

data/spec/teaspoon_env.rb

@@ -0,0 +1,213 @@
+unless defined?(Rails)
+  ENV['RAILS_ROOT'] = File.expand_path('../../', __FILE__)
+  require File.expand_path('../../config/environment', __FILE__)
+end
+
+# Teaspoon doesn't allow you to pass client driver options to the Selenium WebDriver. This monkey patch
+# is a temporary fix until this PR is merged: https://github.com/jejacks0n/teaspoon/pull/519.
+require 'teaspoon/driver/selenium'
+
+Teaspoon::Driver::Selenium.class_eval do
+  def run_specs(runner, url)
+    driver = ::Selenium::WebDriver.for(
+      driver_options[:client_driver],
+      **driver_options[:selenium_options].to_hash.to_options
+    )
+    driver.navigate.to(url)
+
+    ::Selenium::WebDriver::Wait.new(driver_options).until do
+      done = driver.execute_script('return window.Teaspoon && window.Teaspoon.finished')
+      driver.execute_script('return window.Teaspoon && window.Teaspoon.getMessages() || []').each do |line|
+        runner.process("#{line}\n")
+      end
+      done
+    end
+  ensure
+    driver&.quit
+  end
+end
+
+Teaspoon.configure do |config|
+  # Determines where the Teaspoon routes will be mounted. Changing this to "/jasmine" would allow you to browse to
+  # `http://localhost:3000/jasmine` to run your tests.
+  config.mount_at = '/teaspoon'
+
+  # Specifies the root where Teaspoon will look for files. If you're testing an engine using a dummy application it can
+  # be useful to set this to your engines root (e.g. `Teaspoon::Engine.root`).
+  # Note: Defaults to `Rails.root` if nil.
+  config.root = Geoblacklight::Engine.root
+
+  # Paths that will be appended to the Rails assets paths
+  # Note: Relative to `config.root`.
+  config.asset_paths = ['spec/javascripts', 'spec/javascripts/stylesheets']
+
+  # Fixtures are rendered through a controller, which allows using HAML, RABL/JBuilder, etc. Files in these paths will
+  # be rendered as fixtures.
+  config.fixture_paths = ['spec/javascripts/fixtures']
+
+  # SUITES
+  #
+  # You can modify the default suite configuration and create new suites here. Suites are isolated from one another.
+  #
+  # When defining a suite you can provide a name and a block. If the name is left blank, :default is assumed. You can
+  # omit various directives and the ones defined in the default suite will be used.
+  #
+  # To run a specific suite
+  # - in the browser: http://localhost/teaspoon/[suite_name]
+  # - with the rake task: rake teaspoon suite=[suite_name]
+  # - with the cli: teaspoon --suite=[suite_name]
+  config.suite do |suite|
+    # Specify the framework you would like to use. This allows you to select versions, and will do some basic setup for
+    # you -- which you can override with the directives below. This should be specified first, as it can override other
+    # directives.
+    # Note: If no version is specified, the latest is assumed.
+    #
+    # Versions: 1.3.1, 2.0.3, 2.1.3, 2.2.0
+    suite.use_framework :jasmine, '2.2.0'
+
+    # Specify a file matcher as a regular expression and all matching files will be loaded when the suite is run. These
+    # files need to be within an asset path. You can add asset paths using the `config.asset_paths`.
+    suite.matcher = '{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}'
+
+    # Load additional JS files, but requiring them in your spec helper is the preferred way to do this.
+    # suite.javascripts = []
+
+    # You can include your own stylesheets if you want to change how Teaspoon looks.
+    # Note: Spec related CSS can and should be loaded using fixtures.
+    # suite.stylesheets = ["teaspoon"]
+
+    # This suites spec helper, which can require additional support files. This file is loaded before any of your test
+    # files are loaded.
+    suite.helper = 'spec_helper'
+
+    # Partial to be rendered in the head tag of the runner. You can use the provided ones or define your own by creating
+    # a `_boot.html.erb` in your fixtures path, and adjust the config to `"/boot"` for instance.
+    #
+    # Available: boot, boot_require_js
+    suite.boot_partial = 'boot'
+
+    # Partial to be rendered in the body tag of the runner. You can define your own to create a custom body structure.
+    suite.body_partial = 'body'
+
+    # Hooks allow you to use `Teaspoon.hook("fixtures")` before, after, or during your spec run. This will make a
+    # synchronous Ajax request to the server that will call all of the blocks you've defined for that hook name.
+    # suite.hook :fixtures, &proc{}
+
+    # Determine whether specs loaded into the test harness should be embedded as individual script tags or concatenated
+    # into a single file. Similar to Rails' asset `debug: true` and `config.assets.debug = true` options. By default,
+    # Teaspoon expands all assets to provide more valuable stack traces that reference individual source files.
+    # suite.expand_assets = true
+  end
+
+  # Example suite. Since we're just filtering to files already within the root test/javascripts, these files will also
+  # be run in the default suite -- but can be focused into a more specific suite.
+  # config.suite :targeted do |suite|
+  #  suite.matcher = "spec/javascripts/targeted/*_spec.{js,js.coffee,coffee}"
+  # end
+
+  # CONSOLE RUNNER SPECIFIC
+  #
+  # These configuration directives are applicable only when running via the rake task or command line interface. These
+  # directives can be overridden using the command line interface arguments or with ENV variables when using the rake
+  # task.
+  #
+  # Command Line Interface:
+  # teaspoon --driver=phantomjs --server-port=31337 --fail-fast=true --format=junit --suite=my_suite /spec/file_spec.js
+  #
+  # Rake:
+  # teaspoon DRIVER=phantomjs SERVER_PORT=31337 FAIL_FAST=true FORMATTERS=junit suite=my_suite
+
+  # Specify which headless driver to use. Supports PhantomJS and Selenium Webdriver.
+  #
+  # Available: :phantomjs, :selenium, :capybara_webkit
+  # PhantomJS: https://github.com/modeset/teaspoon/wiki/Using-PhantomJS
+  # Selenium Webdriver: https://github.com/modeset/teaspoon/wiki/Using-Selenium-WebDriver
+  # Capybara Webkit: https://github.com/modeset/teaspoon/wiki/Using-Capybara-Webkit
+  config.driver = :selenium
+  config.driver_options = {
+    client_driver: :chrome,
+    selenium_options: {
+      options: Selenium::WebDriver::Chrome::Options.new(args: ['headless', 'disable-gpu'])
+    }
+  }
+
+  # Specify additional options for the driver.
+  #
+  # PhantomJS: https://github.com/modeset/teaspoon/wiki/Using-PhantomJS
+  # Selenium Webdriver: https://github.com/modeset/teaspoon/wiki/Using-Selenium-WebDriver
+  # Capybara Webkit: https://github.com/modeset/teaspoon/wiki/Using-Capybara-Webkit
+  # config.driver_options = nil
+
+  # Specify the timeout for the driver. Specs are expected to complete within this time frame or the run will be
+  # considered a failure. This is to avoid issues that can arise where tests stall.
+  # config.driver_timeout = 180
+
+  # Specify a server to use with Rack (e.g. thin, mongrel). If nil is provided Rack::Server is used.
+  # config.server = nil
+
+  # Specify a port to run on a specific port, otherwise Teaspoon will use a random available port.
+  # config.server_port = nil
+
+  # Timeout for starting the server in seconds. If your server is slow to start you may have to bump this, or you may
+  # want to lower this if you know it shouldn't take long to start.
+  # config.server_timeout = 20
+
+  # Force Teaspoon to fail immediately after a failing suite. Can be useful to make Teaspoon fail early if you have
+  # several suites, but in environments like CI this may not be desirable.
+  # config.fail_fast = true
+
+  # Specify the formatters to use when outputting the results.
+  # Note: Output files can be specified by using `"junit>/path/to/output.xml"`.
+  #
+  # Available: :dot, :clean, :documentation, :json, :junit, :pride, :rspec_html, :snowday, :swayze_or_oprah, :tap, :tap_y, :teamcity
+  # config.formatters = [:dot]
+
+  # Specify if you want color output from the formatters.
+  # config.color = true
+
+  # Teaspoon pipes all console[log/debug/error] to $stdout. This is useful to catch places where you've forgotten to
+  # remove them, but in verbose applications this may not be desirable.
+  # config.suppress_log = false
+
+  # COVERAGE REPORTS / THRESHOLD ASSERTIONS
+  #
+  # Coverage reports requires Istanbul (https://github.com/gotwarlost/istanbul) to add instrumentation to your code and
+  # display coverage statistics.
+  #
+  # Coverage configurations are similar to suites. You can define several, and use different ones under different
+  # conditions.
+  #
+  # To run with a specific coverage configuration
+  # - with the rake task: rake teaspoon USE_COVERAGE=[coverage_name]
+  # - with the cli: teaspoon --coverage=[coverage_name]
+
+  # Specify that you always want a coverage configuration to be used. Otherwise, specify that you want coverage
+  # on the CLI.
+  # Set this to "true" or the name of your coverage config.
+  # config.use_coverage = nil
+
+  # You can have multiple coverage configs by passing a name to config.coverage.
+  # e.g. config.coverage :ci do |coverage|
+  # The default coverage config name is :default.
+  config.coverage do |coverage|
+    # Which coverage reports Istanbul should generate. Correlates directly to what Istanbul supports.
+    #
+    # Available: text-summary, text, html, lcov, lcovonly, cobertura, teamcity
+    # coverage.reports = ["text-summary", "html"]
+
+    # The path that the coverage should be written to - when there's an artifact to write to disk.
+    # Note: Relative to `config.root`.
+    # coverage.output_path = "coverage"
+
+    # Assets to be ignored when generating coverage reports. Accepts an array of filenames or regular expressions. The
+    # default excludes assets from vendor, gems and support libraries.
+    # coverage.ignore = [%r{/lib/ruby/gems/}, %r{/vendor/assets/}, %r{/support/}, %r{/(.+)_helper.}]
+
+    # Various thresholds requirements can be defined, and those thresholds will be checked at the end of a run. If any
+    # aren't met the run will fail with a message. Thresholds can be defined as a percentage (0-100), or nil.
+    # coverage.statements = nil
+    # coverage.functions = nil
+    # coverage.branches = nil
+    # coverage.lines = nil
+  end
+end