bento_search 1.5.0 → 2.0.0.rc1

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,131 +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)
-      @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
-

data/test/dummy/config/initializers/secret_token.rb

@@ -1,8 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Your secret key for verifying the integrity of signed cookies.
-# If you change this key, all old signed cookies will become invalid!
-# Make sure the secret is at least 30 characters and all random,
-# no regular words or you'll be exposed to dictionary attacks.
-Dummy::Application.config.secret_token = '78ee4771fe1d7704b7dd8f47b879db32af098e4cf67f9910e9cf7fe8de18353ff52dc3ccb48ed341745aaedbad9ba79f031867b0e37680f2fb5b66b76838db22'
-Dummy::Application.config.secret_key_base = '60f73d25f61301b1ea3119011efb9fd9a741fcc010757599341d45765fbda7676daf5d602fb17bb5085c3163a04e20c0750ad02562ee9cb7f03f813d1b62c639'

data/test/unit/multi_searcher_test.rb

@@ -1,49 +0,0 @@
-require 'test_helper'
-
-# Doesn't really test the concurrency, but basic smoke test with fake
-# searchers. 
-class MultiSearcherTest < ActiveSupport::TestCase
-  setup do
-    BentoSearch.register_engine("one") do |conf|
-      conf.engine = "MockEngine"      
-    end
-    BentoSearch.register_engine("two") do |conf|
-      conf.engine = "MockEngine"      
-    end
-    BentoSearch.register_engine("three") do |conf|
-      conf.engine = "MockEngine"      
-    end
-  end
-  
-  teardown do
-    BentoSearch.reset_engine_registrations!
-  end
-  
-  
-  def test_multisearch
-    searcher = BentoSearch::MultiSearcher.new(:one, :two, :three)
-    start_returnval = searcher.start("cancer")
-    
-    assert_same searcher, start_returnval
-    
-    results = searcher.results
-    
-    assert_kind_of Hash, results
-    assert_equal ["one", "two", "three"].sort, results.keys.sort
-    
-    ["one", "two", "three"].each do |key|
-      assert_kind_of BentoSearch::Results, results[key]
-    end
-    
-    # call results again, we get an empty hash, can only call
-    # results once per start. 
-    new_results = searcher.results
-    assert_kind_of Hash, new_results
-    assert_empty new_results
-    
-  end
-    
-  
-  
-  
-end