bento_search 1.5.0 → 2.0.0.rc1

data/lib/bento_search.rb

@@ -2,7 +2,7 @@ require 'confstruct'
 
 module BentoSearch
   class Error < ::StandardError ; end
-end 
+end
 
 require "bento_search/engine"
 require 'bento_search/routes'
@@ -14,36 +14,51 @@ require File.dirname(__FILE__) + '/../app/models/bento_search/registrar'
 
 # Crazy workaround to the fact that some versions of Hashie::Mash,
 # when used with SafeAssignment as Confstruct does, don't let
-# you use :id as a key. 
+# you use :id as a key.
 # https://github.com/intridea/hashie/issues/290
 # We fix by removing the unused method with vary hacky meta programming
-# sorry. 
+# sorry.
 require 'hashie/mash'
 if Hashie::Mash.instance_methods(false).include?(:id)
   Hashie::Mash.send(:remove_method, :id)
 end
 
 
-module BentoSearch      
+module BentoSearch
   def self.global_registrar
     @@global_registrar ||= BentoSearch::Registrar.new
   end
-       
+
   # See BentoSearch::Registrar#register_engine, this is a
-  # default global registrar. 
+  # default global registrar.
   def self.register_engine(id, data = nil, &block)
-    global_registrar.register_engine(id, data, &block)    
+    global_registrar.register_engine(id, data, &block)
   end
-  
+
   def self.get_engine(id)
     global_registrar.get_engine(id)
   end
-      
+
   # Mostly just used for testing
   def self.reset_engine_registrations!
     global_registrar.reset_engine_registrations!
   end
 
+  # Avoid deprecation warnings in ruby 2.3.0
+  RubyTimeoutClass = (defined?(Timeout::Error) ? Timeout::Error : TimeoutError)
+
+  @@defaults = Confstruct::Configuration.new(
+    error_partial: 'bento_search/search_error',
+    item_partial: 'bento_search/std_item',
+    no_results_partial: 'bento_search/no_results',
+    ajax_loading_partial: 'bento_search/ajax_loading'
+  )
+  def self.set_defaults(hash)
+    @@defaults.merge!(hash)
+  end
+  def self.defaults
+    @@defaults
+  end
 end
 
 

data/lib/bento_search/engine.rb

@@ -1,5 +1,7 @@
 module BentoSearch
   class Engine < ::Rails::Engine
     #isolate_namespace BentoSearch
+
+    config.assets.precompile += %w( bento_search/large_loader.gif )
   end
 end

data/lib/bento_search/version.rb

@@ -1,3 +1,3 @@
 module BentoSearch
-  VERSION = "1.5.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/boot.rb

@@ -1,10 +1,5 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
-
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

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

@@ -7,23 +7,23 @@ module BentoSearch
         config.engine = "MockEngine"
         config.allow_routable_results = true
       end
-      
+
       BentoSearch.register_engine("failed_response") do |config|
         config.engine = "MockEngine"
         config.allow_routable_results = true
         config.error = {:message => "faked error"}
       end
-      
+
       BentoSearch.register_engine("not_routable") do |config|
         config.engine = "MockEngine"
         # no allow_routable_results
       end
-      
+
       BentoSearch.register_engine("with_layout_config") do |config|
         config.engine = "MockEngine"
-        
+
         config.allow_routable_results = true
-        
+
         config.for_display do |display|
           display.ajax do |ajax|
             ajax.wrapper_template = "bento_search/wrap_with_count"
@@ -31,119 +31,129 @@ module BentoSearch
         end
       end
     end
-    
-    def teardown     
+
+    def teardown
       BentoSearch.reset_engine_registrations!
     end
-    
-    
+
+
     test "search" do
-      get :search, {:engine_id => "mock", :query => "my search"}
+      get_search_with_params :engine_id => "mock", :query => "my search"
       assert_response :success
       assert_not_nil assigns(:results)
-      
+
       assert_template "bento_search/search/search"
-      
+
       # meta tag with count
       meta_tag = assert_select("meta[itemprop=total_items][content]", :count => 1 )
-      assert_match /^\d+$/, meta_tag.attribute("content").text
+      assert_match(/^\d+$/, meta_tag.attribute("content").text)
     end
-    
+
     test "failed search" do
-      get :search, {:engine_id => "failed_response", :query => "my search"}
-      
+      get_search_with_params :engine_id => "failed_response", :query => "my search"
+
       # should this really be a success? Yes, I think so, we don't
       # want to stop ajax from getting it, it'll just have an error
       # message in the HTML. Should it maybe have an html5 meta microdata
       # warning?
       assert_response :success
-      
+
       assert_template "bento_search/search/search"
       assert_template "bento_search/_search_error"
-      
+
       assert_select("meta[itemprop=total_items]", :count => 0)
     end
-    
-    
-    
-    
-    
+
+
+
+
+
     test "custom layout config" do
-      get :search, {:engine_id => "with_layout_config", :query => "my search"}
-      
+      get_search_with_params :engine_id => "with_layout_config", :query => "my search"
+
       assert_response :success
-      
+
       assert_not_nil assigns(:partial_wrapper)
-      
+
       assert_template "bento_search/_wrap_with_count"
       assert_template "bento_search/search/search"
     end
-    
+
     test "non-routable engine" do
-      get :search, {:engine_id => "not_routable", :query => "my search"}
-      
+      get_search_with_params :engine_id => "not_routable", :query => "my search"
+
       assert_response 403
     end
-    
+
     test "non-existent engine" do
-      get :search, {:engine_id => "not_existing", :query => "my search"}
-      
+      get_search_with_params :engine_id => "not_existing", :query => "my search"
+
       assert_response 404
     end
-    
-        
+
+
     test "respects public_settable_search_args" do
-      get :search, {:engine_id => "mock", 
-          'query' => "query", 'sort' => "sort", 'per_page' => "15", 
-      'page' => "6", 'search_field' => "title", 'not_allowed' => "not allowed"}
-      
-      
+      get_search_with_params :engine_id => "mock",
+          'query' => "query", 'sort' => "sort", 'per_page' => "15",
+          'page' => "6", 'search_field' => "title", 'not_allowed' => "not allowed"
+
+
       search_args = assigns[:engine].last_args
-      
+
       [:query, :sort, :per_page, :page, :search_field].each do |allowed_key|
         assert search_args.has_key?(allowed_key)
       end
       assert ! search_args.has_key?(:not_allowed)
       assert ! search_args.has_key?("not_allowed")
     end
-    
+
     test "custom before filter" do
       # Okay, we're going to do a weird thing with a custom controller subclass
-      # we can add a custom before filter like a local app might. 
+      # we can add a custom before filter like a local app might.
       #
-      # SUPER HACKY, but I dunno what else to do. 
-      
+      # 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
         end
       end
-      
 
-      
+
+
       orig_controller = @controller
-      
+
       begin
         Rails.application.routes.draw do
           get "/custom_search" => "bento_search/search_controller_test/custom_search#search"
         end
         @controller = CustomSearchController.new
-        
-        get :search, {:engine_id => "mock", :query => "my search"}
-        
+
+        get_search_with_params :engine_id => "mock", :query => "my search"
+
         assert_response 403
       ensure
         @controller = orig_controller
         Rails.application.reload_routes!
       end
-      
+
+    end
+
+
+    # Do rails4 or rails5
+    def get_search_with_params(params)
+      if Gem::Version.new(Rails.version) >= Gem::Version.new(5.0)
+        get :search, params: params
+      else
+        get :search, params
+      end
     end
-    
 
-    
-        
-    
   end
 end