bento_search 1.7.0 → 2.0.0.rc1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bento_search
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - Jonathan Rochkind
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.3
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.3
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: confstruct
   requirement: !ruby/object:Gem::Requirement
@@ -166,44 +166,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
-- !ruby/object:Gem::Dependency
-  name: celluloid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email: 
+        version: '3.0'
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -212,23 +198,17 @@ files:
 - README.md
 - Rakefile
 - app/assets/images/bento_search/large_loader.gif
-- app/assets/javascripts/bento_search.js
 - app/assets/javascripts/bento_search/ajax_load.js
 - app/assets/stylesheets/bento_search/suggested_styles.css
 - app/controllers/bento_search/bento_search_controller.rb
 - app/controllers/bento_search/search_controller.rb
 - app/helpers/bento_search_helper.rb
 - app/item_decorators/bento_search/decorator_base.rb
-- app/item_decorators/bento_search/ebscohost/conditional_openurl_main_link.rb
 - app/item_decorators/bento_search/no_links.rb
-- app/item_decorators/bento_search/only_premade_openurl.rb
-- app/item_decorators/bento_search/openurl_add_other_link.rb
-- app/item_decorators/bento_search/openurl_main_link.rb
 - app/item_decorators/bento_search/standard_decorator.rb
 - app/models/bento_search/author.rb
 - app/models/bento_search/concurrent_searcher.rb
 - app/models/bento_search/link.rb
-- app/models/bento_search/multi_searcher.rb
 - app/models/bento_search/openurl_creator.rb
 - app/models/bento_search/registrar.rb
 - app/models/bento_search/result_item.rb
@@ -266,6 +246,7 @@ files:
 - lib/bento_search/routes.rb
 - lib/bento_search/util.rb
 - lib/bento_search/version.rb
+- lib/generators/bento_search/install/ajax_load_js_generator.rb
 - lib/generators/bento_search/pull_ebsco_dbs_generator.rb
 - lib/generators/bento_search/templates/ebsco_global_var.erb
 - lib/http_client_patch/include_client.rb
@@ -274,6 +255,7 @@ files:
 - test/decorator/standard_decorator_test.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
+- test/dummy/app/assets/config/manifest.js
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -291,12 +273,10 @@ files:
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/db/schema.rb
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -320,11 +300,11 @@ files:
 - test/search_engines/xerxes_engine_test.rb
 - test/support/atom.xsd.xml
 - test/support/test_with_cassette.rb
+- test/support/xml.xsd
 - test/test_helper.rb
 - test/unit/concurrent_searcher_test.rb
 - test/unit/handle_highlight_tags_test.rb
 - test/unit/item_decorators_test.rb
-- test/unit/multi_searcher_test.rb
 - test/unit/openurl_creator_test.rb
 - test/unit/pagination_test.rb
 - test/unit/register_engine_test.rb
@@ -410,7 +390,7 @@ files:
 homepage: http://github.com/jrochkind/bento_search
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -421,19 +401,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: An abstraction/normalization layer for querying and displaying results for
   external search engines, in Ruby on Rails.
 test_files:
 - test/decorator/decorator_base_test.rb
 - test/decorator/standard_decorator_test.rb
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
+- test/dummy/app/assets/config/manifest.js
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -450,19 +432,15 @@ test_files:
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
-- test/dummy/db/schema.rb
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
 - test/dummy/script/rails
 - test/functional/bento_search/search_controller_test.rb
 - test/helper/bento_search_helper_test.rb
@@ -482,11 +460,11 @@ test_files:
 - test/search_engines/xerxes_engine_test.rb
 - test/support/atom.xsd.xml
 - test/support/test_with_cassette.rb
+- test/support/xml.xsd
 - test/test_helper.rb
 - test/unit/concurrent_searcher_test.rb
 - test/unit/handle_highlight_tags_test.rb
 - test/unit/item_decorators_test.rb
-- test/unit/multi_searcher_test.rb
 - test/unit/openurl_creator_test.rb
 - test/unit/pagination_test.rb
 - test/unit/register_engine_test.rb
@@ -500,6 +478,7 @@ test_files:
 - test/vcr_cassettes/doaj_articles/live_get_identifier__raises_on_no_results.yml
 - test/vcr_cassettes/doaj_articles/multifield_author-title.yml
 - test/vcr_cassettes/doaj_articles/pagination.yml
+- test/vcr_cassettes/ebscohost/RILM_record_with_ISSN_in__jid__element.yml
 - test/vcr_cassettes/ebscohost/affiliation_search.yml
 - test/vcr_cassettes/ebscohost/another_dissertation.yml
 - test/vcr_cassettes/ebscohost/dissertation_example.yml
@@ -517,11 +496,10 @@ test_files:
 - test/vcr_cassettes/ebscohost/live_search_smoke_test.yml
 - test/vcr_cassettes/ebscohost/multi-field_author_title.yml
 - test/vcr_cassettes/ebscohost/multi-field_citation_numbers.yml
-- test/vcr_cassettes/ebscohost/RILM_record_with_ISSN_in__jid__element.yml
+- test/vcr_cassettes/eds/FullText_CustomLink.yml
 - test/vcr_cassettes/eds/basic_search_smoke_test.yml
 - test/vcr_cassettes/eds/catalog_ebook_query.yml
 - test/vcr_cassettes/eds/catalog_query.yml
-- test/vcr_cassettes/eds/FullText_CustomLink.yml
 - test/vcr_cassettes/eds/get_auth_token.yml
 - test/vcr_cassettes/eds/get_auth_token_failure.yml
 - test/vcr_cassettes/eds/get_with_auth.yml

data/app/assets/javascripts/bento_search.js

@@ -1,3 +0,0 @@
-// require all bento_search javascript. 
-//
-//= require_tree ./bento_search

data/app/item_decorators/bento_search/ebscohost/conditional_openurl_main_link.rb

@@ -1,36 +0,0 @@
-#  DEPRECATED. Just write the logic into a custom Decorator yourself.
-#  See wiki on decorators. 
-#
-#
-# For ebscohost connector, example of an Item Decorator that replaces the main 
-# 'link' with an openurl ONLY if there is NOT fulltext avail from EBSCO.  
-#
-# This example uses crazy metaprogramming to dynamically create
-# a module configured with your base url etc. You don't need to use
-# crazy method like that; just define your own local decorator doing
-# exactly what you need, it's meant to be simple. 
-#
-#  config.item_decorators = [ BentoSearch::Ebscohost::ConditionalOpenurlMainLink[:base_url => "http://resolve.somewhere.edu/foo", :extra_query => "&foo=bar"] ]
-#
-module BentoSearch::Ebscohost::ConditionalOpenurlMainLink
-  def self.[](options)
-    base_url = options[:base_url]
-    extra_query = options[:extra_query] || ""
-    Module.new do
-      
-      define_method :link do
-        if custom_data["fulltext_formats"]
-          super()
-        elsif (ou = to_openurl)
-          "#{base_url}?#{ou.kev}#{extra_query}"
-        else
-          nil
-        end
-      end
-      
-    end
-  end
-  
-  
-  
-end

data/app/item_decorators/bento_search/only_premade_openurl.rb

@@ -1,20 +0,0 @@
-#  DEPRECATED. Just write the logic into a custom Decorator yourself.
-#  See wiki on decorators. 
-
-
-require 'openurl'
-
-# A Decorator that will make #to_openurl refuse to construct
-# an openurl from individual elements, it'll use the #openurl_kev_co
-# or nothing. 
-module BentoSearch::OnlyPremadeOpenurl
-  
-  def to_openurl
-    if self.openurl_kev_co
-      return OpenURL::ContextObject.new_from_kev( self.openurl_kev_co )
-    else
-      return nil
-    end
-  end
-  
-end

data/app/item_decorators/bento_search/openurl_add_other_link.rb

@@ -1,39 +0,0 @@
-#  DEPRECATED. Just write the logic into a custom Decorator yourself.
-#  See wiki on decorators. 
-#
-#
-# Example of an Item Decorator that ADDs an 'other link' with an openurl. 
-#
-# This example uses crazy metaprogramming to dynamically create
-# a module configured with your base url etc. You don't need to use
-# crazy method like that; just define your own local decorator doing
-# exactly what you need, it's meant to be simple. 
-#
-#  config.item_decorators = [ BentoSearch::OpenurlAddOtherLink[:base_url => "http://resolve.somewhere.edu/foo", :extra_query => "&foo=bar"] ]
-#
-module BentoSearch::OpenurlAddOtherLink
-  def self.[](options)
-    base_url = options[:base_url]
-    extra_query = options[:extra_query] || ""
-    link_name = options[:link_name] || "Find It"
-    # overwrite: if true, overwrite previously existing other_links, if
-    # false add on to previously existing. 
-    overwrite = options.has_key?(:overwrite) ? options[:overwrite] : false    
-    
-    Module.new do
-      
-      define_method :other_links do
-        start = overwrite ? [] : super()
-        if (ou = to_openurl)
-          start + [BentoSearch::Link.new(:url => "#{base_url}?#{ou.kev}#{extra_query}", :label => link_name)]
-        else
-          start
-        end        
-      end
-      
-    end
-  end
-  
-  
-  
-end

data/app/item_decorators/bento_search/openurl_main_link.rb

@@ -1,34 +0,0 @@
-#  DEPRECATED. Just write the logic into a custom Decorator yourself.
-#  See wiki on decorators. 
-
-
-# Example of an Item Decorator that replaces the main 'link'
-# with an openurl. 
-#
-# This example uses crazy metaprogramming to dynamically create
-# a module configured with your base url etc. You don't need to use
-# crazy method like that; just define your own local decorator doing
-# exactly what you need, it's meant to be simple. 
-#
-#  config.item_decorators = [ BentoSearch::OpenurlMainLink[:base_url => "http://resolve.somewhere.edu/foo", :extra_query => "&foo=bar"] ]
-#
-module BentoSearch::OpenurlMainLink
-  def self.[](options)
-    base_url = options[:base_url]
-    extra_query = options[:extra_query] || ""
-    Module.new do
-      
-      define_method :link do
-        if (ou = to_openurl)
-          "#{base_url}?#{ou.kev}#{extra_query}"
-        else
-          nil
-        end
-      end
-      
-    end
-  end
-  
-  
-  
-end

data/app/models/bento_search/multi_searcher.rb

@@ -1,132 +0,0 @@
-begin
-  require 'celluloid'
-
-  # Based on Celluloid, concurrently runs multiple searches in
-  # seperate threads. You must include 'celluloid' gem dependency
-  # into your local app to use this class. Requires celluloid 0.12.0
-  # or above (for new preferred async syntax).
-  #
-  # Warning, if you don't have celluloid in your app, this class simply
-  # won't load. TODO: We should put this file in a different directory
-  # so it's never auto-loaded, and requires a "require 'bento_search/multi_searcher'",
-  # such that it will raise without celluloid only then, and we don't need this
-  # rescue LoadError stuff.
-  #
-  # I am not an expert at use of Celluloid, it's possible there's a better
-  # way to do this all, but seems to work.
-  #
-  # ## Usage
-  #
-  # initialize with id's of registered engines:
-  #     searcher = BentoBox::MultiSearcher.new(:gbs, :scopus)
-  #
-  # start the concurrent searches, params same as engine.search
-  #     searcher.search( query_params )
-  #
-  # retrieve results, blocking until each is completed:
-  #     searcher.results
-  #
-  # returns a Hash keyed by engine id, values BentoSearch::Results objects.
-  #
-  # Can only call #results once per #start, after that it'll return empty hash.
-  # (should we make it actually raise instead?). .
-  #
-  # important to call results at some point after calling start, in order
-  # to make sure Celluloid::Actors are properly terminated to avoid
-  # resource leakage. May want to do it in an ensure block.
-  #
-  # Note that celluloid uses multi-threading in such a way that you
-  # may have to set config.cache_classes=true even in development
-  # to avoid problems. Rails class reloading is not thread-safe.
-  #
-  #
-  # TODO: have a method that returns Futures instead of only supplying the blocking
-  # results method? Several tricks, including making sure to properly terminate actors.
-  class BentoSearch::MultiSearcher
-
-    def initialize(*engine_ids)
-      ActiveSupport::Deprecation.warn('BentoSearch::MultiSearcher is deprecated and will be removed in bento_search 2.0. Please use BentoSearch::ConcurrentSearcher instead.', caller.slice(1..-1))
-
-      @engines = []
-      @actors = []
-      engine_ids.each do |id|
-        add_engine( BentoSearch.get_engine id )
-      end
-    end
-
-    # Adds an instantiated engine directly, rather than by id from global
-    # registry.
-    def add_engine(engine)
-      @engines << engine
-    end
-
-    # Starts all searches, returns self so you can chain method calls if you like.
-    def search(*search_args)
-      @engines.each do |engine|
-        a = Actor.new(engine)
-        @actors << a
-        a.async.start *search_args
-      end
-      return self
-    end
-    alias_method :start, :search # backwards compat
-
-    # Call after #start. Blocks until each included engine is finished
-    # then returns a Hash keyed by engine registered id, value is a
-    # BentoSearch::Results object.
-    #
-    # Can only call _once_ per invocation of #start, after that it'll return
-    # an empty hash.
-    def results
-      results = {}
-
-      # we use #delete_if to get an iterator that deletes
-      # each item after iteration.
-      @actors.delete_if do |actor|
-        result_key = (actor.engine.configuration.id || actor.engine.class.name)
-        results[result_key] = actor.results
-        actor.terminate
-
-        true
-      end
-
-      return results
-    end
-
-
-    class Actor
-      include Celluloid
-
-      attr_accessor :engine
-
-      def initialize(a_engine)
-        self.engine = a_engine
-      end
-
-      # call as .async.start, to invoke async.
-      def start(*search_args)
-        begin
-          @results = self.engine.search(*search_args)
-        rescue StandardError => e
-          Rails.logger.error("\nBentoSearch:MultiSearcher caught exception: #{e}\n#{e.backtrace.join("   \n")}")
-          # Make a fake results with caught exception.
-          @results = BentoSearch::Results.new
-          self.engine.fill_in_search_metadata_for(@results, self.engine.normalized_search_arguments(search_args))
-
-          @results.error ||= {}
-          @results.error["exception"] = e
-        end
-      end
-
-      def results
-        @results
-      end
-
-    end
-  end
-
-rescue LoadError
-  # you can use bento_search without celluloid, just not
-  # this class.
-end
-