blacklight_cql 0.9.1 → 1.0.0pre1

data/lib/blacklight_cql/engine.rb

@@ -0,0 +1,40 @@
+require 'cql_ruby'
+
+require 'rails'
+require 'blacklight'
+require 'blacklight_cql'
+
+require 'blacklight_cql/solr_helper_extension'
+require 'blacklight_cql/template_helper_extension'
+
+
+module BlacklightCql
+  class Engine < Rails::Engine
+  
+    
+    # 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
+    end
+
+    
+    # Wrapping in Dispatcher.to_prepare will, theoretically, take care of things
+    # working properly even in development mode with cache_classes=false (per-request
+    # class reloading).
+    config.to_prepare do
+       #Check in  case CatalogController _hasn't_ really been re-loaded
+       unless (CatalogController.kind_of?( BlacklightCql::SolrHelperExtension ))
+         # Will over-ride #solr_params to deal with CQL
+         CatalogController.send(:include, BlacklightCql::SolrHelperExtension)
+         
+         # Will over-ride helper methods for search form select,  to ensure
+         # query is echo'd properly.
+         CatalogController.send(:helper, BlacklightCql::TemplateHelperExtension)
+       end
+    end
+
+    
+  end
+end

data/lib/blacklight_cql/solr_helper_extension.rb

@@ -7,9 +7,7 @@
 # alias_method_chain instead, thankfully we do not. 
 module BlacklightCql::SolrHelperExtension
     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", :display_label => "External Search (CQL)", :include_in_simple_select => false}
 
     # Over-ride solr_search_params to do special CQL-to-complex-solr-query
     # processing iff the "search_field" is our pseudo-search-field indicating

data/lib/blacklight_cql/version.rb

@@ -0,0 +1,9 @@
+module BlacklightCql
+  unless BlacklightCql.const_defined? :VERSION
+    def self.version
+      @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
+    end
+
+    VERSION = self.version
+  end
+end

data/lib/blacklight_cql.rb

@@ -2,6 +2,9 @@
 
 require 'blacklight_cql/blacklight_to_solr'
 
+require 'blacklight_cql/version'
+require 'blacklight_cql/engine'
+
 module BlacklightCql
 mattr_accessor :cql_search_field_key
   self.cql_search_field_key = "cql"

data/spec/{blacklight_to_solr_spec.rb → lib/blacklight_to_solr_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 
 describe "blacklight_to_solr" do

metadata

@@ -1,13 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: blacklight_cql
 version: !ruby/object:Gem::Version 
-  hash: 57
-  prerelease: 
+  hash: 1923831947
+  prerelease: 5
   segments: 
+  - 1
+  - 0
   - 0
-  - 9
+  - pre
   - 1
-  version: 0.9.1
+  version: 1.0.0pre1
 platform: ruby
 authors: 
 - Jonathan Rochkind
@@ -15,88 +17,99 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-19 00:00:00 -04:00
-default_executable: 
+date: 2011-06-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: cql-ruby
+  name: rails
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 61
+        hash: 7
         segments: 
+        - 3
         - 0
-        - 8
-        - 1
-        version: 0.8.1
+        version: "3.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: markup_validity
+  name: blacklight
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 1923832001
         segments: 
+        - 3
         - 0
-        version: "0"
-  type: :development
+        - 0
+        - pre
+        - 4
+        version: 3.0.0pre4
+  type: :runtime
   version_requirements: *id002
-description: May have parts that can be used outside a Blacklight app too with a big of refactoring, let me know if interested.
-email: rochkind@jhu.edu
+- !ruby/object:Gem::Dependency 
+  name: cql-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 8
+        - 1
+        version: 0.8.1
+  type: :runtime
+  version_requirements: *id003
+description: 
+email: 
+- blacklight-development@googlegroups.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- MIT-LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
+- lib/blacklight_cql/blacklight_to_solr.rb
+- lib/blacklight_cql/template_helper_extension.rb
+- lib/blacklight_cql/version.rb
+- lib/blacklight_cql/solr_helper_extension.rb
+- lib/blacklight_cql/engine.rb
+- lib/blacklight_cql.rb
 - app/controllers/blacklight_cql/explain_controller.rb
-- app/helpers/blacklight_cql/explain_helper.rb
 - app/views/blacklight_cql/explain/explain.xml.builder
+- app/helpers/blacklight_cql/explain_helper.rb
 - config/routes.rb
-- init.rb
-- install.rb
-- lib/blacklight_cql.rb
-- lib/blacklight_cql/blacklight_to_solr.rb
-- lib/blacklight_cql/solr_helper_extension.rb
-- lib/blacklight_cql/template_helper_extension.rb
-- rails/init.rb
-- spec/app_root/app/controllers/application_controller.rb
-- spec/app_root/config/boot.rb
-- spec/app_root/config/database.yml
-- spec/app_root/config/environment.rb
-- spec/app_root/config/environments/in_memory.rb
-- spec/app_root/config/environments/mysql.rb
-- spec/app_root/config/environments/postgresql.rb
-- spec/app_root/config/environments/sqlite.rb
-- spec/app_root/config/environments/sqlite3.rb
-- spec/app_root/config/routes.rb
-- spec/app_root/lib/blacklight/search_fields.rb
-- spec/app_root/lib/console_with_fixtures.rb
-- spec/blacklight_to_solr_spec.rb
-- spec/data/luke.yaml
+- spec/lib/blacklight_to_solr_spec.rb
+- spec/rcov.opts
 - spec/data/zeerex-2.0.xsd
+- spec/data/luke.yaml
+- spec/spec_helper.rb
 - spec/marc_data/chomsky.mrc
 - spec/marc_data/social_journal.mrc
-- spec/rcov.opts
 - spec/spec.opts
-- spec/spec_helper.rb
+- spec/app_root/app/controllers/application_controller.rb
+- spec/app_root/lib/console_with_fixtures.rb
+- spec/app_root/lib/blacklight/search_fields.rb
+- spec/app_root/config/environments/postgresql.rb
+- spec/app_root/config/environments/sqlite3.rb
+- spec/app_root/config/environments/sqlite.rb
+- spec/app_root/config/environments/in_memory.rb
+- spec/app_root/config/environments/mysql.rb
+- spec/app_root/config/environment.rb
+- spec/app_root/config/database.yml
+- spec/app_root/config/routes.rb
+- spec/app_root/config/boot.rb
 - spec/views/explain.xml.builder_spec.rb
-- tasks/blacklight_cql_tasks.rake
-- uninstall.rb
-has_rdoc: true
-homepage: http://github.com/projectblacklight/blacklight_cql
+homepage: http://projectblacklight.org/
 licenses: []
 
 post_install_message: 
@@ -116,18 +129,40 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.6.2
+rubyforge_project: blacklight
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: Add CQL query support to a Blacklight app
-test_files: []
-
+summary: Blacklight CQL plugin
+test_files: 
+- spec/lib/blacklight_to_solr_spec.rb
+- spec/rcov.opts
+- spec/data/zeerex-2.0.xsd
+- spec/data/luke.yaml
+- spec/spec_helper.rb
+- spec/marc_data/chomsky.mrc
+- spec/marc_data/social_journal.mrc
+- spec/spec.opts
+- spec/app_root/app/controllers/application_controller.rb
+- spec/app_root/lib/console_with_fixtures.rb
+- spec/app_root/lib/blacklight/search_fields.rb
+- spec/app_root/config/environments/postgresql.rb
+- spec/app_root/config/environments/sqlite3.rb
+- spec/app_root/config/environments/sqlite.rb
+- spec/app_root/config/environments/in_memory.rb
+- spec/app_root/config/environments/mysql.rb
+- spec/app_root/config/environment.rb
+- spec/app_root/config/database.yml
+- spec/app_root/config/routes.rb
+- spec/app_root/config/boot.rb
+- spec/views/explain.xml.builder_spec.rb

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2010 [name of plugin creator]
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,142 +0,0 @@
-= Blacklight-cql
-
-An extension for the Blacklight solr search front-end.  
-
-http://projectblacklight.org
-
-http://github.com/projectblacklight/blacklight
-
-Provides for CQL search queries that map to Solr and Blacklight fields.
-
-
-= Installation
-
-Add to your local app's environment.rb:
- config.gem "blacklight_cql"
-
-Run "rake gems:install".  That's it, you now have CQL support in your Blacklight.  
-
-See below for optional configuration to change default behavior.  
-
-= Use
-
- http://your.blacklight.com/catalog?search_field=cql&q=[uri-encoded cql query]
- 
-Or for an atom response for instance, 
-
- http://your.blacklight.com/catalog.atom?search_field=cql&q=[uri-encoded cql query]
-
-See http://www.loc.gov/standards/sru/specs/cql.html for more info on CQL syntax and semantics. 
- 
-Any search_field you have configured in Blacklight.config[:search_fields] (probably in your config/blacklight_config.rb) is available as a CQL index.  These search fields are only available with the custom "solr.dismax" CQL relation, taking a CQL expression as a value.
-
-  some_field solr.dismax "term +required -negate \"a phrase\" "
-  
-For dismax fields, the "=" server-choice relation means the same thing:
-
-  some_field = "term +required -negate \"a phrase\" "
-
-Any Solr indexed field is also available as a CQL index. A much greater range of CQL relations are supported when you specify a Solr indexed field directly.  
-
-  solr_field cql.adj "some phrase" AND solr_year within "1990 2000"
-  
-Solr indexed field CQL support is provided by the cql_ruby gem, for details on relations supported see: http://cql-ruby.rubyforge.org/svn/trunk/lib/cql_ruby/cql_to_solr.rb
-  
-If there is a direct solr indexed field with the same name as a Blacklight-configured dismax field, the BL field will take precedence. You can use explicit CQL "context set" prefixes to disambiguate.
-
-[lsolr.field]
-  "lsolr" prefix means a direct solr indexed field
-[local.some_field]
-  "local" prefix means a dismax field configured in Blacklight.config[:search_fields]
-
-These prefixes can be changed, see configuration below. 
-
-Raw solr fields and Blacklight config'ed fields CAN be mixed together in a single CQL query. 
-
-  (lsolr.title_t any "one two three" AND lsolr.author_t all "smith john") OR local.title = "my dismax title query"
-  
-CQL *does* need to be URL escaped in a URL, of course:
-
-  http://some.blacklight.com/catalog.atom?search_field=cql&q=%28lsolr.title_t+any+%22one+two+three%22+AND+lsolr.author_t+all+%22smith+john%22%29+OR+local.title+%3D+%22my+dismax+title+query%22
-
-For "solr.dismax" or "=" relations, the the cql.serverChoice index maps to your default blacklight-configed field and solr.dismax relation.  Otherwise, it maps to a direct solr field query with "adj", and the solr indexed field generally ends up being "text", although this depends on your configuration. 
-
-= SRU/ZeeRex Explain
-
-This plugin does *not* provide a full SRU server. However, a ZeeRex/SRU explain document is provided by the plugin to advertise, in machine-readable format, what CQL indexes (ie, search fields) are provided by the server, and what relations are supported on each search field. 
-
-The explain document can be found at /catalog/explain on your server. (This URL end-point is not presently configurable). 
-
-For solr fields themselves, the plugin finds them via a Solr luke request, looking for any field that is Indexed in solr,  and advertising it. (If you have configured lucene indexes directly not through solr, they will likely be erroneously included in the explain as well). 
-
-For Blacklight fields, Blacklight.config[:search_fields] is used to discover fields to put in the Explain.  
-
-Note that at present only the custom solr.dismax relation is supported on Blacklight fields. Most of the standard CQL relations are supported on raw solr fields. 
-
-
-= Configuration
-
-== URL cql key, and cql label
-
-A psuedo-blacklight-search-field is added by the Cql plugin to indicate a CQL search in the URL and BL processing.  You can change the definition of this psuedo-field however you want to change the URL search_field key, the label for a CQL search echoed back to the user in HTML, or even to add some additional Solr parameters for the top-level Solr query for CQL searches. The value is a hash with the same semantics as other Blacklight.config[:search_fields] elements.  
-
-In an initializer:
- BlacklightCql::SolrHelperExtension.psuedo_search_field = {
-  :key => "super_search", 
-  :display_label => "The Super Search",
-  :solr_parameters => { "mm" => "100%" }
- }
-
-== Dismax search field configuration
- 
-All fields configured in Blacklight.config[:search_fields] are available as CQL indexes. If you'd like to make more dismax-configured search fields available in CQL but not the standard HTML search select menu, simply add them with :show_in_simple_select = false, eg:
-
-  Blacklight.config[:search_fields] << {:key => "only_in_cql", :show_in_simple_select => false, :local_solr_parameters => { :qf => "$my_special_qf"}} 
-
-As in the example above, you may want to use :local_solr_parameters referencing dollar-sign parameters that will be defined in your solrconfig.xml and de-referenced by Solr. This will keep your CQL-generated Solr querries a lot more readable in your logs and debugging. However, this feature is not available in Blacklight 2.5 (edge, or future 2.6). 
-  
-Simply supplying literal values in :solr_paramaters is also supported and will work fine, it will just result in very long search querries in your solr query log.
-
-== CQL context set prefixes
-
-You can change the CQL "context set" prefix used for specifying a CQL index that is a direct solr field, or a Blacklight dismax configured field.  In a Rails initializer:
-
- CqlRuby.to_solr_defaults[:solr_field_prefix] = "my_solr"
- CqlRuby.to_solr_defaults[:blacklight_field_prefix] = "my_blacklight_fields"
-
-== Defaults from CqlRuby for direct solr indexed field querries. 
-
-For direct-solr-field operations, there are additional defaults that can be set, supported by CqlRuby. See: http://cql-ruby.rubyforge.org/svn/trunk/lib/cql_ruby/cql_to_solr.rb
-
-Eg:
-
-  CqlRuby.to_solr_defaults[:default_index] = "solr_index"
-  CqlRuby.to_solr_defaults[:all_index] = "solr_mega_index"
-  CqlRuby.to_solr_defaults[:default_relation] = "cql.any"
-  
-= TO DO
-
-* Support more CQL relations on blacklight dismax fields. Right now only dismax queries are supported. We could also support:
-  * cql.all (set mm to 100%)
-  * cql.adj (phrase search with qs set to 0)
-  * cql.any 
-  * range querries on dismax fields? Maybe. <, <=, >, >=, within
-  * <> on dismax fields, similar to how it works on raw solr. 
-* Is there a simple way to support CQL PROX boolean operator? Not sure. That's a weird operator in CQL, it makes it possible to specify things which make no sense, like onefield = val PROX anotherfield=val2 
-* Support CQL sortBy clauses mapped to Blacklight sort param. We can't tell which solr fields are available for sorting solely from luke, will need additional config to advertise in Explain. 
-* Add CQL relation modifiers on solr.dismax that let you specify arbitrary solr/dismax query parameters. (Add to solr context set too). 
-* Support relation modifier on cql.adj that maps to qs
-* support CQL context set 'fuzzy' modifier, to have some effect on mm, ps, qs, etc. 
-* *Big one*:  Figure out how to embed the explain and advertise the CQL in the BL OpenSearch description (including OpenSearch response in Atom).  Tricky from BL architecture to inject this into BL, also some dispute about the best way for the actual XML to look to support this. 
-
-= Use without Blacklight?
-
-Most of the code in this plugin was written to potentially be useful in other projects, not Blacklight, not neccesarily even Rails.  However, the gem initialization code assumes Blacklight in order to insert it's hooks into Blacklight properly. This can probably be refactored to make it easier to use this gem in a non-BL or even non-Rails app, let me know if you are someone who has an actual need/plan for this, and I can possibly help.  
-
-= Acknolwedgements
-
-Thanks to Chick Markley for writing the CqlRuby gem that provides the fundamental functionality here, and for making me a committer on the project. Thanks to Mike Taylor for writing the original Java CQL parser that Chick's work was based on. 
-
-
-
-Copyright 2010 Jonathan Rochkind/Johns Hopkins University, released under the MIT license

data/Rakefile

@@ -1,43 +0,0 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the blacklight_cql plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the blacklight_cql plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Blacklight-cql'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "blacklight_cql"
-    gemspec.summary = "Add CQL query support to a Blacklight app"
-    gemspec.description = "May have parts that can be used outside a Blacklight app too with a big of refactoring, let me know if interested."
-    gemspec.email = "rochkind@jhu.edu"
-    gemspec.homepage = "http://github.com/projectblacklight/blacklight_cql"
-    gemspec.authors = ["Jonathan Rochkind"]
-    
-    gemspec.add_dependency("cql-ruby", ">=0.8.1")
-    
-    gemspec.add_development_dependency("markup_validity")
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
-

data/VERSION

@@ -1 +0,0 @@
-0.9.1

data/init.rb

@@ -1 +0,0 @@
-File.dirname(__FILE__) + "/rails/init".

data/install.rb

@@ -1 +0,0 @@
-# Install hook code here

data/rails/init.rb

@@ -1,32 +0,0 @@
-# Include hook code here
-require 'cql_ruby'
-require 'blacklight_cql'
-require 'dispatcher'
-
-
-# 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
-end
-
-# Wrapping in Dispatcher.to_prepare will, theoretically, take care of things
-# working properly even in development mode with cache_classes=false (per-request
-# class reloading). 
-Dispatcher.to_prepare("blacklight_cql.setup") do 
-
-
-    #Check in  case CatalogController _hasn't_ really been re-loaded
-    unless (CatalogController.kind_of?( BlacklightCql::SolrHelperExtension ))
-        # Will over-ride #solr_params to deal with CQL
-        CatalogController.send(:include, BlacklightCql::SolrHelperExtension)
-
-        # Will over-ride helper methods for search form select,  to ensure
-        # query is echo'd properly. 
-        CatalogController.send(:helper, BlacklightCql::TemplateHelperExtension)
-    end
-        
-
-end
-

data/tasks/blacklight_cql_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :blacklight_cql do
-#   # Task goes here
-# end

data/uninstall.rb

@@ -1 +0,0 @@
-# Uninstall hook code here