blacklight_cql 0.9.0

data/spec/app_root/config/database.yml

@@ -0,0 +1,31 @@
+in_memory:
+  adapter: sqlite3
+  database: ":memory:"
+  verbosity: quiet
+  pool: 5
+  timeout: 5000
+sqlite:
+  adapter: sqlite
+  dbfile: plugin_test.sqlite.db
+  pool: 5
+  timeout: 5000
+sqlite3:
+  adapter: sqlite3
+  dbfile: plugin_test.sqlite3.db
+  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
+  pool: 5
+  timeout: 5000

data/spec/app_root/config/environment.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), 'boot')
+
+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

data/spec/app_root/config/routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/spec/app_root/lib/blacklight/search_fields.rb

@@ -0,0 +1,97 @@
+##
+# Module to deal with accessing (and setting some defaults) in an array of
+# hashes that describe Blacklight search fields.  Requires the base class this
+# module is added to implements a #config method that returns a hash, where
+# config[:search_fields] will be an array of hashes describing search fields.
+#
+# = Search Field Configuration Hash =
+# [:display_label]
+#   "Title",  # user-displayable label
+# [:qt]
+#   "search", # Solr qt param, request handler, defaults to Blacklight.config[:default_qt] if left blank.
+# [:solr_parameters]
+#   {:qf => "something"} # optional hash of additional parameters to pass to solr for searches on this field.
+# [:solr_local_parameters]
+#   {:qf => "$something"} # optional hash of additional parameters that will be passed using Solr LocalParams syntax, that can use dollar sign to reference other solr variables.
+# [:include_in_simple_select]
+#   false.  Defaults to true, but you can set to false to have a search field defined for deep-links or BL extensions, but not actually included in the HTML select for simple search choice.
+# 
+# Optionally you can supply a :key, which is what Blacklight will use
+# to identify this search field in HTTP query params. If no :key is
+# supplied, one will be computed from the :display_label. If that will
+# result in a collision of keys, you should supply one explicitly. 
+#
+##
+module Blacklight::SearchFields
+  extend ActiveSupport::Memoizable
+
+  # Looks up search field config list from config[:search_fields], and
+  # 'normalizes' all field config hashes using normalize_config method. 
+  # Memoized for efficiency of normalization. 
+  def search_field_list
+    config[:search_fields].collect {|obj| normalize_config(obj)}
+  end
+  memoize :search_field_list
+
+  # Returns suitable argument to options_for_select method, to create
+  # an html select based on #search_field_list. Skips search_fields
+  # marked :include_in_simple_select => false
+  def search_field_options_for_select
+    search_field_list.collect do |field_def|
+      [field_def[:display_label],  field_def[:key]] unless field_def[:include_in_simple_select] == false
+    end.compact
+  end
+
+  # Looks up a search field config hash from search_field_list having
+  # a certain supplied :key. 
+  def search_field_def_for_key(key)
+    return nil if key.blank?
+    search_field_list.find {|c| c[:key] == key}
+  end
+
+  # Returns default search field, used for simpler display in history, etc.
+  # if not set in config, defaults to first field listed in #search_field_list
+  def default_search_field
+    config[:default_search_field] || search_field_list[0]
+  end
+  memoize :default_search_field
+
+  # Shortcut for commonly needed operation, look up display
+  # label for the key specified. Returns "Keyword" if a label
+  # can't be found. 
+  def label_for_search_field(key)
+    field_def = search_field_def_for_key(key)
+    if field_def && field_def[:display_label]
+       field_def[:display_label]
+    else
+       "Keyword"
+    end            
+  end
+
+  protected
+  # Fill in missing default values in a search_field config hash.
+  def normalize_config(field_hash)
+
+
+    # Accept legacy two-element array, if it's not a Hash, assume it's legacy.
+    # No great way to 'duck type' here. 
+    unless ( field_hash.kind_of?(Hash))      
+      # Consistent with legacy behavior where two fields can have the same label,
+      # as long as they have different qt's, we base the unique :key on :qt. 
+      field_hash = {:display_label => field_hash[0], :key => field_hash[1], :qt => field_hash[1]}
+    else
+      # Make a copy of passed in Hash so we don't alter original. 
+      field_hash = field_hash.clone
+    end
+    
+    # If no key was provided, turn the display label into one.      
+    field_hash[:key] ||= field_hash[:display_label].downcase.gsub(/[^a-z0-9]+/,'_')
+
+    # If no :qt was provided, take from config default
+    field_hash[:qt] ||= config[:default_qt]
+  
+    field_hash
+  end
+  
+  
+end

data/spec/app_root/lib/console_with_fixtures.rb

@@ -0,0 +1,4 @@
+# Loads fixtures into the database when running the test app via the console
+(ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(Rails.root, '../fixtures/*.{yml,csv}'))).each do |fixture_file|
+  Fixtures.create_fixtures(File.join(Rails.root, '../fixtures'), File.basename(fixture_file, '.*'))
+end

data/spec/blacklight_to_solr_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+describe "blacklight_to_solr" do
+  before do
+    @config = Class.new do
+      include Blacklight::SearchFields
+
+      def config
+        {
+          :search_fields => [
+            {
+              :display_label => "Title",
+              :key => "title",
+              :solr_parameters => {
+                :qf => "ti_something"
+              },
+              :solr_local_parameters => {
+                :pf => "$ti_something"
+              }
+            },
+            {
+              :display_label => "Author",
+              :key => "author",
+              :solr_parameters => {
+                :qf => "au_something^10 au_else^100"
+              }            
+            }
+          
+          ]
+        }
+      end
+      
+    end.new
+
+    @parser = CqlRuby::CqlParser.new
+  end
+
+  it "should convert to nested queries with local dismax param definitions" do
+    output = @parser.parse('title = "foo +bar" AND author = smith OR some_solr_field = frog').to_bl_solr(@config)
+
+    output.should == "( (  _query_:\"{!dismax qf=ti_something pf=$ti_something} foo +bar \"  AND  _query_:\"{!dismax qf='au_something^10 au_else^100'} smith \"  ) OR some_solr_field:frog )"
+  end
+
+  it "should use default BL config'd search for solr.dismax or '=' relation" do
+    output = @parser.parse("cql.serverChoice solr.dismax \"foo bar\"").to_bl_solr(@config)
+
+    output.should == " _query_:\"{!dismax qf=ti_something pf=$ti_something} foo bar \" "    
+  end
+end

data/spec/data/luke.yaml

@@ -0,0 +1,75 @@
+---  
+:fields:  
+  :subject_unstem_search:  
+    :schema: IT-M---------
+    :type: textNoStem
+    :dynamicBase: "*_unstem_search"
+  :url_suppl_display:  
+    :schema: --SM---------
+    :type: string
+    :dynamicBase: "*_display"
+  :timestamp:  
+    :schema: I-S----O----l
+    :type: date
+  :title_spell:  
+    :schema: IT-M---------
+    :type: textSpell
+    :dynamicBase: "*spell"
+  :format:  
+    :schema: I-SM---O----l
+    :type: string
+  :subtitle_unstem_search:  
+    :schema: IT-M---------
+    :type: textNoStem
+    :dynamicBase: "*_unstem_search"
+  :text:  
+    :schema: IT-M---------
+    :type: text
+  :author_facet:  
+    :schema: I--M---O----l
+    :type: string
+    :dynamicBase: "*_facet"
+  :material_type_display:  
+    :schema: --SM---------
+    :type: string
+    :dynamicBase: "*_display"
+  :isbn_t:  
+    :schema: ITSM---O-----
+    :type: isbn
+    :dynamicBase: "*_t"
+  :spell:  
+    :schema: IT-M---------
+    :type: textSpell
+    :dynamicBase: "*spell"
+  :url_fulltext_display:  
+    :schema: --SM---------
+    :type: string
+    :dynamicBase: "*_display"
+:info:  
+  :NOTE: Document Frequency (df) is not updated when a document is marked for deletion.  df values include deleted documents.
+  :key:  
+    :V: TermVector Stored
+    :L: Lazy
+    :l: Sort Missing Last
+    :M: Multivalued
+    :B: Binary
+    :C: Compressed
+    :o: Store Offset With TermVector
+    :O: Omit Norms
+    :p: Store Position With TermVector
+    :f: Sort Missing First
+    :S: Stored
+    :I: Indexed
+    :T: Tokenized
+:responseHeader:  
+  :status: 0
+  :QTime: 6
+:index:  
+  :hasDeletions: false
+  :directory: org.apache.lucene.store.:NIOFSDirectory:org.apache.lucene.store.NIOFSDirectory@/usr/share/jetty6/solr/dev/data/index
+  :lastModified: "2010-06-:15T14::23:37Z"
+  :current: true
+  :numDocs: 994
+  :version: 1265038861837
+  :optimized: true
+  :maxDoc: 994