bento_search 1.7.0 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 65bfa7da3d1e0896569d44cb7875931b92876186
-  data.tar.gz: 222147474c34a761bfc483abd5185a3b4712b6fa
+SHA256:
+  metadata.gz: ed755cb880b6d45bd02d53373d80c25161c6689ef59b7108106896c0a392fc4c
+  data.tar.gz: 4c9009a41299bc44b84274e93c5f0e7a9a5fda599e0de97f6e8972cd3519faf0
 SHA512:
-  metadata.gz: ee8d316144f84e0469c37d0784d894cda427dc8606ad736af9a0172223c5ace2a61db026fb3d44d2b586791894160dbf5fdce368ae1c5e510314b067ca66bbd0
-  data.tar.gz: 3b31f327569b5e9de6fce19da85b7d6f653dae97c9b3ace77139be4c0048a3dff992a3579b4da9b54a553870c23c4fcc681ce193f2dfe3465b7f5487be2ba3e2
+  metadata.gz: 07e2ba15ccd24b1dc1d1cfac642dd01d60700de90dcd2b63ce164830a4619e30203c728077461123ab39ce7e8da6390d3f5009f6afaba637ebc275f5977fd23e
+  data.tar.gz: 755df58770fa0f91fa9cd0fa8ef507815f762889203f4c63edd9931bd4f15270027a033213fca650334749add1be5d9ef0dc15a64b6b9bf92d75838137db01bc

data/README.md

@@ -1,11 +1,11 @@
 # BentoSearch
 
-[![Build Status](https://secure.travis-ci.org/jrochkind/bento_search.png)](http://travis-ci.org/jrochkind/bento_search)
+[![CI Build Status](https://github.com/jrochkind/bento_search/actions/workflows/ruby.yml/badge.svg)](https://github.com/jrochkind/bento_search/actions/workflows/ruby.yml)
 [![Gem Version](https://badge.fury.io/rb/bento_search.png)](http://badge.fury.io/rb/bento_search)
 
 bento_search provides an abstraction/normalization layer for querying and
 displaying results from external search engines, in Ruby on Rails. Works with
-Rails 3.x, 4.x, or 5.0. ruby 1.9.3+
+Rails 5.2 - 6.1, ruby 2.5 through 3.0.
 
 ### Goals: To help you
 
@@ -283,10 +283,6 @@ the ConcurrentSearcher's concurrency.
 
 For more info, see [BentoSearch::ConcurrentSearcher](./app/models/bento_search/concurrent_searcher.rb).
 
-The previous **MultiSearcher** class is now deprecated, ConcurrentSearcher
-is the replacement, and will likely work as a drop-in replacement.
-See [CHANGES](./CHANGES.md#17) for more info.
-
 
 
 

data/app/assets/javascripts/bento_search/ajax_load.js

@@ -14,11 +14,26 @@ var BentoSearch = BentoSearch || {}
 // You can set default success_callback function for all calls with:
 //
 //     BentoSearch.ajax_load.default_success_callback = function(div) { ...
-BentoSearch.ajax_load = function(node, success_callback) {
+//
+// optional beforeSend function.
+//
+// beforeSend: to be used by jQuery.ajax as the settings.beforeSend function.
+// this allows the outgoing request to modified, e.g. to add auth params
+// in the query param or in a header.
+// See https://api.jquery.com/jquery.ajax/#jQuery-ajax-settings
+//
+// You can set default beforeSend function for all calls with:
+//
+//     BentoSearch.ajax_load.default_beforeSend = function(xhr, settings) { ...
+BentoSearch.ajax_load = function(node, success_callback, beforeSend) {
   // default success_callback
   if (success_callback === undefined) {
     success_callback = BentoSearch.ajax_load.default_success_callback;
   }
+  // default beforeSend
+  if (beforeSend === undefined) {
+    beforeSend = BentoSearch.ajax_load.default_beforeSend;
+  }
 
   var div = $(node);
 
@@ -52,6 +67,7 @@ BentoSearch.ajax_load = function(node, success_callback) {
           div.replaceWith(response);
         }
       },
+      beforeSend: beforeSend,
       error: function(xhr, status, errorThrown) {
         var msg = "Sorry but there was an error: ";
         div.html(msg + xhr.status + " " + xhr.statusText + ", " + status);

data/app/controllers/bento_search/search_controller.rb

@@ -19,10 +19,10 @@ module BentoSearch
   # in their config will be served by this controller.
   #
   # If you need routable results on an engine which ALSO needs to
-  # be protected by auth, you can add your own Rails before_filter
+  # be protected by auth, you can add your own Rails before_action
   # to provide auth. Say, in an initializer in your app:
   #
-  #     SearchController.before_filter do |controller|
+  #     SearchController.before_action do |controller|
   #       unless controller.current_user
   #          raise BentoSearch::SearchController::AccessDenied
   #       end

data/app/models/bento_search/concurrent_searcher.rb

@@ -16,7 +16,7 @@ begin
   #
   # initialize with id's of registered engines:
   #
-  #     searcher = BentoBox::MultiSearcher.new(:gbs, :scopus)
+  #     searcher = BentoBox::ConcurrentSearcher.new(:gbs, :scopus)
   #
   # start the concurrent searches, params same as engine.search
   #
@@ -37,7 +37,7 @@ begin
   #
   # In Rails previous to Rails5, you may have to set config.cache_classes=true
   # even in development to avoid problems. In Rails 5.x, we take advantage of
-  # new api that should allow concurrency-save autoloading. But if you run into
+  # new api that should allow concurrency-safe autoloading. But if you run into
   # any weird problems (such as a deadlock), `cache_classes = true` and
   # `eager_load = true` should eliminate them, at the cost of dev-mode
   # auto-reloading.

data/app/models/bento_search/result_item.rb

@@ -157,7 +157,7 @@ module BentoSearch
     attr_writer :language_str
     def language_str
       (@language_str ||= nil) || language_code.try do |code|
-        LanguageList::LanguageInfo.find(code).try do |lang_obj|
+        LanguageList::LanguageInfo.find(code.dup).try do |lang_obj|
           lang_obj.name
         end
       end
@@ -167,7 +167,10 @@ module BentoSearch
     # if available, otherwise from direct language_str if available and
     # possible.
     def language_obj
-      @language_obj ||= LanguageList::LanguageInfo.find( self.language_code || self.language_str )
+      @language_obj ||= begin
+        lookup = self.language_code || self.language_str
+        LanguageList::LanguageInfo.find( lookup.dup ) if lookup
+      end
     end
 
     # Two letter ISO language code, or nil

data/app/views/bento_search/_item_title.html.erb

@@ -17,7 +17,7 @@
   # marker will be output after title, in class .bento_available_online
   #
   # %>
-  <h4 class="bento_item_title">
+  <h3 class="bento_item_title">
     <% if local_assigns[:index] %>
       <% id_attr = item.html_id(local_assigns[:id_prefix], index) %>
       <%= content_tag("span", :class => "bento_index", :id => (id_attr if id_attr)) do %>
@@ -39,6 +39,4 @@
     <% if item.display_configuration.try{|h| h[:indicate_fulltext]} && item.link_is_fulltext? %>
       <small class="bento_available_online">Online</small>
     <% end %>
-  </h4>
-
-
+  </h3>

data/lib/bento_search/version.rb

@@ -1,3 +1,3 @@
 module BentoSearch
-  VERSION = "1.7.0"
+  VERSION = "2.0.0.rc1"
 end

data/lib/generators/bento_search/install/ajax_load_js_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+module BentoSearch
+  module Install
+    class AjaxLoadJsGenerator < ::Rails::Generators::Base
+      source_root BentoSearch::Engine.root.to_s
+
+      desc "Copy ajax_load.js file to local .app/javascript/src/js/"
+
+      def generate
+        copy_file 'app/assets/javascripts/bento_search/ajax_load.js',
+        (Rails.root + "app/javascript/src/js/bento_search_ajax_load.js")
+      end
+    end
+  end
+end

data/test/decorator/standard_decorator_test.rb

@@ -4,74 +4,74 @@ require 'test_helper'
 
 class StandardDecoratorTest < ActionView::TestCase
   include BentoSearch
-  
-  def decorator(hash = {})    
+
+  def decorator(hash = {})
     StandardDecorator.new(
       ResultItem.new(hash), view
     )
   end
-  
-  
+
+
   test "author with first and last" do
     author = Author.new(:last => "Smith", :first => "John")
-    
+
     str = decorator.author_display(author)
-    
-    assert_equal "Smith, J", str    
+
+    assert_equal "Smith, J", str
   end
-  
+
   test "author with display form and just last" do
     author = Author.new(:last => "Smith", :display => "Display Form")
-    
+
     str = decorator.author_display(author)
-    
+
     assert_equal "Display Form", str
   end
-  
+
   test "Author with just last" do
     author = Author.new(:last => "Johnson")
-    
+
     str = decorator.author_display(author)
-    
+
     assert_equal "Johnson", str
-    
+
   end
-  
+
   test "Missing title" do
     assert_equal I18n.translate("bento_search.missing_title"), decorator.complete_title
   end
-  
+
   test "language label nil if default" do
     I18n.with_locale(:'en-GB') do
-      item = decorator(:language_code => 'en')      
+      item = decorator(:language_code => 'en')
       assert_nil item.display_language
-      
+
       item = decorator(:language_code => 'es')
-      assert_equal "Spanish", item.display_language      
+      assert_equal "Spanish", item.display_language
     end
   end
 
   test "display_language works with just langauge_str" do
-     item = decorator(:language_str => 'German')      
+     item = decorator(:language_str => 'German')
      assert_equal "German", item.display_language
   end
-  
+
   test "display_format with nil format" do
     item = decorator(:format => nil, :format_str => nil)
-    
+
     display_format = item.display_format
-    
-    assert_nil display_format  
+
+    assert_nil display_format
   end
-  
+
   test "display_date" do
-    item = decorator(:year => 1900)    
+    item = decorator(:year => 1900)
     assert_equal "1900", item.display_date
-    
+
     d = Date.new(2010, 5, 5)
     item = decorator(:publication_date => d)
     assert_equal I18n.l(d, :format => "%d %b %Y"), item.display_date
-    
+
     # if volume and issue, only prints out year
     item = decorator(:publication_date => d, :volume => "101", :issue => "2")
     assert_equal I18n.l(d, :format => "%Y"), item.display_date
@@ -112,7 +112,7 @@ class StandardDecoratorTest < ActionView::TestCase
     assert_equal "snippet", item.render_summary, "use snippet if that's all that's there, even when configured for abstract"
 
     item = decorator()
-    assert_equal nil, item.render_summary, "Okay with no snippet or abstract"
+    assert_nil item.render_summary, "Okay with no snippet or abstract"
   end
-  
+
 end

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+// See: https://github.com/rails/sprockets/blob/c4b191e70d89e9d70f19ade5faf0692054a3bd1b/UPGRADING.md
+//
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/config/application.rb

@@ -46,6 +46,13 @@ module Dummy
 
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
+
+    # Avoid Rails deprecation warning
+    if Gem::Version.new(Rails.version).release >= Gem::Version.new("5.2.0") && Gem::Version.new(Rails.version).release < Gem::Version.new("6.0.0")
+      config.active_record.sqlite3.represent_boolean_as_integer = true
+    end
+
+    config.secret_key_base = '60f73d25f61301b1ea3119011efb9fd9a741fcc010757599341d45765fbda7676daf5d602fb17bb5085c3163a04e20c0750ad02562ee9cb7f03f813d1b62c639'
   end
 end
 

data/test/dummy/config/environments/development.rb

@@ -27,4 +27,6 @@ Dummy::Application.configure do
 
   # Expands the lines which load the assets
   config.assets.debug = true
+
+  config.eager_load = false
 end

data/test/dummy/config/environments/production.rb

@@ -9,7 +9,11 @@ Dummy::Application.configure do
   config.action_controller.perform_caching = true
 
   # Disable Rails's static asset server (Apache or nginx will already do this)
-  config.serve_static_files = false
+  if Rails::VERSION::MAJOR < 5
+    config.serve_static_files = false
+  else
+    config.public_file_server.enabled = false
+  end
 
   # Compress JavaScripts and CSS
   config.assets.compress = true
@@ -60,4 +64,6 @@ Dummy::Application.configure do
 
   # Send deprecation notices to registered listeners
   config.active_support.deprecation = :notify
+
+  config.eager_load = true
 end

data/test/dummy/config/environments/test.rb

@@ -8,11 +8,16 @@ Dummy::Application.configure do
   config.cache_classes = true
 
   # Configure static asset server for tests with Cache-Control for performance
-  config.serve_static_files = true
-  config.static_cache_control = "public, max-age=3600"
+  if Rails::VERSION::MAJOR < 5
+    config.serve_static_files = true
+    config.static_cache_control = "public, max-age=3600"
+  else
+    config.public_file_server.enabled = true
+    config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
+  end
 
   config.eager_load = false
-  
+
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -32,4 +37,6 @@ Dummy::Application.configure do
   config.active_support.deprecation = :stderr
 
   config.active_support.test_order = :random
+
+  config.eager_load = false
 end

data/test/functional/bento_search/search_controller_test.rb

@@ -114,7 +114,11 @@ module BentoSearch
       # SUPER HACKY, but I dunno what else to do.
 
       class CustomSearchController < BentoSearch::SearchController
-        before_filter :deny_everyone
+        if respond_to?(:before_action)
+          before_action :deny_everyone
+        else
+          before_filter :deny_everyone
+        end
 
         def deny_everyone
           raise BentoSearch::SearchController::AccessDenied

data/test/search_engines/google_site_search_test.rb

@@ -7,123 +7,123 @@ require 'cgi'
 # ENV GOOGLE_SITE_SEARCH_KEY and GOOGLE_SITE_SEARCH_CX
 class GoogleSiteSearchTest < ActiveSupport::TestCase
   extend TestWithCassette
-  
+
   @@api_key = ENV["GOOGLE_SITE_SEARCH_KEY"] || "DUMMY_API_KEY"
   @@cx      = ENV["GOOGLE_SITE_SEARCH_CX"] || "DUMMY_CX"
-  
+
   VCR.configure do |c|
     c.filter_sensitive_data("DUMMY_API_KEY", :google_site) { @@api_key }
     c.filter_sensitive_data("DUMMY_CX", :google_site) { @@cx }
   end
-  
+
   setup do
     @config = {:api_key => @@api_key, :cx => @@cx}
     @engine = BentoSearch::GoogleSiteSearchEngine.new(@config)
   end
-  
+
   test("basic query construction") do
     url = @engine.send(:construct_query, {:query => "hours policies"})
-    
-    query_params = CGI.parse( URI.parse(url).query )    
+
+    query_params = CGI.parse( URI.parse(url).query )
 
     assert_equal ["hours policies"], query_params["q"]
   end
-  
-  test("pagination construction") do    
+
+  test("pagination construction") do
     url = @engine.send(:construct_query, {:query => "books", :per_page => 5, :start => 10})
-    
+
     query_params = CGI.parse( URI.parse(url).query )
-    
+
     assert_equal ["5"], query_params["num"]
     assert_equal ["11"], query_params["start"]
   end
-  
+
   test("silently refuses to paginate too far") do
     # google won't let you paginate past ~10 pages, (101 - num). We silently
     # refuse
-    
+
     url = @engine.send(:construct_query, {:query => "books", :start => 110})
-    
+
     query_params = CGI.parse( URI.parse(url).query )
-    
+
     assert_equal ["91"], query_params["start"]
   end
-  
+
   test_with_cassette("pagination object is correct for actual page when you ask for too far", :google_site) do
     results = @engine.search("books", :start => 1000)
-    
+
     pagination = results.pagination
-    
+
     assert_equal 10, pagination.current_page
-    assert_equal 91, pagination.start_record    
+    assert_equal 91, pagination.start_record
   end
-  
+
   test("sort query construction") do
     url = @engine.send(:construct_query, {:query => "books", :sort => "date_desc"})
-    
+
     query_params = CGI.parse( URI.parse(url).query )
-    
+
     assert_equal ["date"], query_params["sort"]
   end
-  
-  test_with_cassette("basic smoke test", :google_site) do    
+
+  test_with_cassette("basic smoke test", :google_site) do
     results = @engine.search("books")
-    
+
     assert_present results
     assert_present results.total_items
-    assert_kind_of Fixnum, results.total_items
-    
+    assert_kind_of 1.class, results.total_items
+
     first = results.first
-    
+
     assert_present first.title
     assert_present first.link
     assert_present first.abstract
-    assert_present first.journal_title # used as source_title for display url    
-    
+    assert_present first.journal_title # used as source_title for display url
+
     # no openurls for google, we decided
     assert_nil     BentoSearch::StandardDecorator.new(first, nil).to_openurl
   end
-  
+
   test_with_cassette("with highlighting", :google_site) do
     engine = BentoSearch::GoogleSiteSearchEngine.new(@config.merge(:highlighting => true))
-    
+
     results = engine.search("books")
-    
+
     first = results.first
 
-    assert first.title.html_safe?    
+    assert first.title.html_safe?
     assert first.abstract.html_safe?
-    assert first.journal_title.html_safe?    
+    assert first.journal_title.html_safe?
   end
-  
+
   test_with_cassette("without highlighting", :google_site) do
     engine = BentoSearch::GoogleSiteSearchEngine.new(@config.merge(:highlighting => false))
-    
+
     results = engine.search("books")
-    
+
     first = results.first
-    
-    assert ! first.title.html_safe?    
+
+    assert ! first.title.html_safe?
     assert ! first.abstract.html_safe?
-    assert ! first.journal_title.html_safe?        
+    assert ! first.journal_title.html_safe?
   end
-  
+
   test_with_cassette("empty result set", :google_site) do
     results = nil
     assert_nothing_raised { results = @engine.search('"adfa lakjdr xavier aldkfj 92323kjadf"') }
-    
+
     assert ! results.failed?
-    
-    assert results.empty?    
+
+    assert results.empty?
   end
-  
+
   test_with_cassette("gets format string", :google_site) do
     results = @engine.search("PDF")
 
     # assume at least one result had a PDF format, which it does
     # in our current VCR capture. For a new one, find a search where
-    # it does. 
-    assert_present(results.find_all {|i| i.format_str =~ /PDF/ }, "At least one result has PDF in format_str")    
+    # it does.
+    assert_present(results.find_all {|i| i.format_str =~ /PDF/ }, "At least one result has PDF in format_str")
   end
-  
+
 end