blacklight_cql 1.0.1 → 1.1.0

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/app/controllers/blacklight_cql/explain_controller.rb

@@ -6,7 +6,7 @@ module BlacklightCql
     
     def index
        @luke_response = Blacklight.solr.luke
-       @field_config = Blacklight
+       @config = CatalogController.blacklight_config
        
        render "explain.xml.builder", :content_type => "application/xml"
     end

data/app/helpers/blacklight_cql/explain_helper.rb

@@ -21,13 +21,12 @@ module BlacklightCql::ExplainHelper
     end
   end
 
-  # Expects an object in @field_config that implements
-  # Blacklight::SearchFields to provide search field config.
-  # argument is a Builder object we can write to. 
+  # Expects @config to have a Blacklight::Configuration
+  # object. 
   def blacklight_config_to_explain_index(xml)
-    @field_config.search_field_list.each do |search_field|
+    @config.search_fields.values.each do |search_field|
       xml.index("search" => "true", "scan" => "false", "sort" => "false") do
-        xml.title search_field[:display_label]
+        xml.title search_field[:label]
         xml.map do
           xml.name(search_field[:key], "set" => CqlRuby.to_solr_defaults[:blacklight_field_prefix]) 
         end

data/lib/blacklight_cql/blacklight_to_solr.rb

@@ -49,7 +49,7 @@ module CqlRuby
         (index_prefix, index) = parse_index(@index, config)
                                                         
         if (index_prefix == CqlRuby.to_solr_defaults[:blacklight_field_prefix])                
-           field_def = config.search_field_def_for_key(index)
+           field_def = config.search_fields[index]
            
            # Merge together solr params and local ones; they're ALL
            # going to be provided as LocalParams in our nested query.
@@ -101,7 +101,7 @@ module CqlRuby
           end
           # If no prefix, we use local one if we can
           if ( index_prefix == nil)
-            if ( config.search_field_def_for_key(index) )
+            if ( config.search_fields[index] )
                 index_prefix = CqlRuby.to_solr_defaults[:blacklight_field_prefix]
             else
                 index_prefix = CqlRuby.to_solr_defaults[:solr_field_prefix]

data/lib/blacklight_cql/engine.rb

@@ -15,8 +15,11 @@ module BlacklightCql
     # Call in after_initialze to make sure the default search_fields are
     # already created, AND the local app has had the opportunity to customize
     # our placeholder search_field.
-    config.after_initialize do
-      Blacklight.config[:search_fields] << BlacklightCql::SolrHelperExtension.pseudo_search_field
+    config.after_initialize do      
+      CatalogController.blacklight_config.configure do |config|
+        hash = BlacklightCql::SolrHelperExtension.pseudo_search_field
+        config.add_search_field hash[:key], hash
+      end
     end
     
 

data/lib/blacklight_cql/solr_helper_extension.rb

@@ -6,21 +6,27 @@
 # itself, it would not, and we'd have to use some ugly monkey patching
 # alias_method_chain instead, thankfully we do not. 
 module BlacklightCql::SolrHelperExtension
+    extend ActiveSupport::Concern
+  
     mattr_accessor :pseudo_search_field
     # :advanced_parse_q => false, tells the AdvancedSearchPlugin not to try
     # to parse this for parens and booleans, we're taking care of it! 
-    self.pseudo_search_field = {:key => "cql", :display_label => "External Search (CQL)", :include_in_simple_select => false, :advanced_parse_q => false}
+    self.pseudo_search_field = {:key => "cql", :label => "External Search (CQL)", :include_in_simple_select => false, :advanced_parse_q => false}
 
+    included do
+      solr_search_params_logic << :cql_to_solr_search_params
+    end
+    
     # Over-ride solr_search_params to do special CQL-to-complex-solr-query
     # processing iff the "search_field" is our pseudo-search-field indicating
-    # a CQL query. 
-    def solr_search_params(extra_controller_params = {})
-      solr_params = super(extra_controller_params)
-    
-      if params["search_field"] == self.pseudo_search_field[:key] && ! params["q"].blank?
+    # a CQL query.
+    def cql_to_solr_search_params(solr_params ={}, user_params ={})
+      if user_params["search_field"] == self.pseudo_search_field[:key] && ! params["q"].blank?
         parser = CqlRuby::CqlParser.new
-        solr_params[:q] = "{!lucene} " + parser.parse( params["q"] ).to_bl_solr(Blacklight)     
+        solr_params[:q] = "{!lucene} " + parser.parse( params["q"] ).to_bl_solr(blacklight_config)     
       end
       return solr_params
     end
+    
+    
 end

data/lib/blacklight_cql/template_helper_extension.rb

@@ -11,7 +11,7 @@ module BlacklightCql::TemplateHelperExtension
     if params[:q].blank? || params[:search_field] != field[:key]
       super
     else      
-      super.clone.push([field[:display_label], field[:key]]).uniq
+      super.clone.push([field[:label], field[:key]]).uniq
     end
   end
   

data/spec/app_root/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/app_root/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/app_root/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/spec/app_root/app/controllers/application_controller.rb

@@ -1,2 +1,3 @@
 class ApplicationController < ActionController::Base
+  protect_from_forgery
 end

data/spec/app_root/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/app_root/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/app_root/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "blacklight_cql"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/app_root/config/boot.rb

@@ -1,115 +1,10 @@
-# Allow customization of the rails framework path
-RAILS_FRAMEWORK_ROOT = (ENV['RAILS_FRAMEWORK_ROOT'] || "#{File.dirname(__FILE__)}/../../../../../../vendor/rails") unless defined?(RAILS_FRAMEWORK_ROOT) 
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
 
-# Don't change this file!
-# Configure your app in config/environment.rb and config/environments/*.rb
-
-RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
-
-module Rails
-  class << self
-    def boot!
-      unless booted?
-        preinitialize
-        pick_boot.run
-      end
-    end
-
-    def booted?
-      defined? Rails::Initializer
-    end
-
-    def pick_boot
-      (vendor_rails? ? VendorBoot : GemBoot).new
-    end
-
-    def vendor_rails?
-      File.exist?(RAILS_FRAMEWORK_ROOT)
-    end
-
-    def preinitialize
-      load(preinitializer_path) if File.exist?(preinitializer_path)
-    end
-
-    def preinitializer_path
-      "#{RAILS_ROOT}/config/preinitializer.rb"
-    end
-  end
-
-  class Boot
-    def run
-      load_initializer
-      Rails::Initializer.run(:set_load_path)
-    end
-  end
-
-  class VendorBoot < Boot
-    def load_initializer
-      require "#{RAILS_FRAMEWORK_ROOT}/railties/lib/initializer"
-      Rails::Initializer.run(:install_gem_spec_stubs)
-      Rails::GemDependency.add_frozen_gem_path
-    end
-  end
-
-  class GemBoot < Boot
-    def load_initializer
-      self.class.load_rubygems
-      load_rails_gem
-      require 'initializer'
-    end
-
-    def load_rails_gem
-      if version = self.class.gem_version
-        gem 'rails', version
-      else
-        gem 'rails'
-      end
-    rescue Gem::LoadError => load_error
-      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
-      exit 1
-    end
-
-    class << self
-      def rubygems_version
-        Gem::RubyGemsVersion rescue nil
-      end
-
-      def gem_version
-        if defined? RAILS_GEM_VERSION
-          RAILS_GEM_VERSION
-        elsif ENV.include?('RAILS_GEM_VERSION')
-          ENV['RAILS_GEM_VERSION']
-        else
-          parse_gem_version(read_environment_rb)
-        end
-      end
-
-      def load_rubygems
-        require 'rubygems'
-        min_version = '1.3.1'
-        unless rubygems_version >= min_version
-          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
-          exit 1
-        end
- 
-      rescue LoadError
-        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
-        exit 1
-      end
-
-      def parse_gem_version(text)
-        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
-      end
-
-      private
-        def read_environment_rb
-          environment_rb = "#{RAILS_ROOT}/config/environment.rb"
-          environment_rb = "#{HELPER_RAILS_ROOT}/config/environment.rb" unless File.exists?(environment_rb)
-          File.read(environment_rb)
-        end
-    end
-  end
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
 end
 
-# All that for this:
-Rails.boot!
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/app_root/config/database.yml

@@ -1,31 +1,25 @@
-in_memory:
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
   adapter: sqlite3
-  database: ":memory:"
-  verbosity: quiet
+  database: db/development.sqlite3
   pool: 5
   timeout: 5000
-sqlite:
-  adapter: sqlite
-  dbfile: plugin_test.sqlite.db
-  pool: 5
-  timeout: 5000
-sqlite3:
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
   adapter: sqlite3
-  dbfile: plugin_test.sqlite3.db
+  database: db/test.sqlite3
   pool: 5
   timeout: 5000
-postgresql:
-  adapter: postgresql
-  username: postgres
-  password: postgres
-  database: plugin_test
-  pool: 5
-  timeout: 5000
-mysql:
-  adapter: mysql
-  host: localhost
-  username: root
-  password:
-  database: plugin_test
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
   pool: 5
   timeout: 5000

data/spec/app_root/config/environment.rb

@@ -1,30 +1,5 @@
-require File.join(File.dirname(__FILE__), 'boot')
+# Load the rails application
+require File.expand_path('../application', __FILE__)
 
-Rails::Initializer.run do |config|
-
-  config.cache_classes = false
-  config.whiny_nils = true
-  config.action_controller.session = {:key => 'rails_session', :secret => 'd229e4d22437432705ab3985d4d246'}
-  config.plugin_locators.unshift(
-    Class.new(Rails::Plugin::Locator) do
-      def plugins
-        [Rails::Plugin.new(File.expand_path('.'))]
-      end
-    end
-  ) unless defined?(PluginTestHelper::PluginLocator)
-
-  # jrochkind addition to plugin_test_helper generated rails stub. 
-  # Adds our plugin code itself to the Rails load path, so it will be
-  # auto-loaded.  Not entirely sure why plugin_test_helper doesn't do
-  # this itself.
-  config.load_paths << File.expand_path(File.dirname(__FILE__)+ "../../../../lib")
-  config.load_paths << File.expand_path(File.dirname(__FILE__)+ "../../../../app/helpers")
-  config.load_paths << File.expand_path(File.dirname(__FILE__)+ "../../../../app/models")
-
-  # We only get one view path, we want it to be our plugins, not the
-  # pseudo-app_root
-  config.view_path = File.expand_path(File.dirname(__FILE__)+ "../../../../app/views")
-
-  
-  
-end
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/app_root/config/environments/development.rb

@@ -0,0 +1,30 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/spec/app_root/config/environments/production.rb

@@ -0,0 +1,60 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to Rails.root.join("public/assets")
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/spec/app_root/config/environments/test.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/app_root/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/app_root/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/app_root/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/app_root/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# 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 = 'fa78fff0933bf4d06eaf0cc0c54daffc4b0d183652e28f8a98f6bd6593a061712932a0f759505add51ca3a8c8f9ec555a59709d353c07c57a60c681bffb4abe8'

data/spec/app_root/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/app_root/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters :format => [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/app_root/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"