blacklight 3.8.2 → 4.0.0.pre6

data/lib/blacklight/solr/document/more_like_this.rb

@@ -0,0 +1,5 @@
+module Blacklight::Solr::Document::MoreLikeThis
+  def more_like_this
+    solr_response.more_like(self).map { |doc| SolrDocument.new(doc, solr_response) }
+  end
+end

data/lib/blacklight/solr_helper.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+require File.join(File.dirname(__FILE__), 'mash') unless defined?(Mash)
 # SolrHelper is a controller layer mixin. It is in the controller scope: request params, session etc.
 # 
 # NOTE: Be careful when creating variables here as they may be overriding something that already exists.
@@ -66,7 +67,7 @@ module Blacklight::SolrHelper
     # CatalogController.include ModuleDefiningNewMethod
     # CatalogController.solr_search_params_logic += [:new_method]
     # CatalogController.solr_search_params_logic.delete(:we_dont_want)
-    self.solr_search_params_logic = [:default_solr_parameters , :add_query_to_solr, :add_facet_fq_to_solr, :add_facetting_to_solr, :add_paging_to_solr, :add_sorting_to_solr ]
+    self.solr_search_params_logic = [:default_solr_parameters , :add_query_to_solr, :add_facet_fq_to_solr, :add_facetting_to_solr, :add_solr_fields_to_query, :add_paging_to_solr, :add_sorting_to_solr ]
   end
 
   def force_to_utf8(value)
@@ -82,8 +83,9 @@ module Blacklight::SolrHelper
   end
   
   def find(*args)
-    response = Blacklight.solr.find(*args)
-    force_to_utf8(response)
+    path = blacklight_config.solr_path
+    response = Blacklight.solr.get(path, :params=> args[1])
+    Blacklight::SolrResponse.new(force_to_utf8(response), args[1])
   rescue Errno::ECONNREFUSED => e
     raise Blacklight::Exceptions::ECONNREFUSED.new("Unable to connect to Solr instance using #{Blacklight.solr.inspect}")
   end
@@ -165,11 +167,7 @@ module Blacklight::SolrHelper
           raise Exception.new("To use pagination when no :per_page is supplied in the URL, :rows must be configured in blacklight_config default_solr_params")
         end
         
-        solr_params[:start] = solr_params[:rows].to_i * (user_params[:page].to_i - 1)
-        
-        # Solr throws error for negative start. Existing specs say
-        # we say start at 1 in this case. 
-        solr_params[:start] = 0 if solr_params[:start].to_i < 0
+        solr_params[:page] = user_params[:page]
       end
 
       # limit to MaxPerPage (100). Tests want this to be a string not an integer,
@@ -344,6 +342,17 @@ module Blacklight::SolrHelper
       end
     end
 
+    def add_solr_fields_to_query solr_parameters, user_parameters
+      return unless blacklight_config.add_field_configuration_to_solr_request
+      blacklight_config.index_fields.each do |field_name, field|
+        if field.highlight
+          solr_parameters[:hl] ||= true
+          solr_parameters[:'hl.fl'] ||= []
+          solr_parameters[:'hl.fl'] << field.field
+        end
+      end
+    end
+
 
   
   # a solr query method
@@ -353,17 +362,32 @@ module Blacklight::SolrHelper
   # Returns a two-element array (aka duple) with first the solr response object,
   # and second an array of SolrDocuments representing the response.docs
   def get_search_results(user_params = params || {}, extra_controller_params = {})
+    solr_response = query_solr(user_params, extra_controller_params)
+    document_list = solr_response.docs.collect {|doc| SolrDocument.new(doc, solr_response)} 
+    return [solr_response, document_list]
+  end
 
+  	
+  # a solr query method
+  # given a user query,
+  # Returns a solr response object
+  def query_solr(user_params = params || {}, extra_controller_params = {})
     # In later versions of Rails, the #benchmark method can do timing
     # better for us. 
     bench_start = Time.now
-
-    solr_response = find(blacklight_config.solr_request_handler, self.solr_search_params(user_params).merge(extra_controller_params))  
-    document_list = solr_response.docs.collect {|doc| SolrDocument.new(doc, solr_response)}  
+    params = self.solr_search_params(user_params).merge(extra_controller_params)
+    params[:qt] ||= blacklight_config.qt
+    path = blacklight_config.solr_path
+    raise "don't set start, use page and rows instead" if params['start'] || params[:start]
+    rows = params.delete(:rows) #only transmit rows once
+    res = Blacklight.solr.paginate(params[:page] || 1, rows, path, :params=>params)
+    solr_response = Blacklight::SolrResponse.new(force_to_utf8(res), params)
+    Rails.logger.debug("Solr query: #{params.inspect}") 
     Rails.logger.debug("Solr response: #{solr_response.inspect}") if defined?(::BLACKLIGHT_VERBOSE_LOGGING) and ::BLACKLIGHT_VERBOSE_LOGGING
-    Rails.logger.debug("Solr fetch: #{self.class}#get_search_results (#{'%.1f' % ((Time.now.to_f - bench_start.to_f)*1000)}ms)")
+    Rails.logger.debug("Solr fetch: #{self.class}#query_solr (#{'%.1f' % ((Time.now.to_f - bench_start.to_f)*1000)}ms)")
     
-    return [solr_response, document_list]
+
+    solr_response
   end
   
   # returns a params hash for finding a single solr document (CatalogController #show action)
@@ -384,7 +408,8 @@ module Blacklight::SolrHelper
   # a solr query method
   # retrieve a solr document, given the doc id
   def get_solr_response_for_doc_id(id=nil, extra_controller_params={})
-    solr_response = find((blacklight_config.document_solr_request_handler || blacklight_config.solr_request_handler), solr_doc_params(id).merge(extra_controller_params))
+    solr_params = solr_doc_params(id).merge(extra_controller_params)
+    solr_response = find((blacklight_config.document_solr_request_handler || blacklight_config.qt), solr_params)
     raise Blacklight::Exceptions::InvalidSolrID.new if solr_response.docs.empty?
     document = SolrDocument.new(solr_response.docs.first, solr_response)
     [solr_response, document]
@@ -415,7 +440,7 @@ module Blacklight::SolrHelper
       :spellcheck => 'false'
     }.merge(extra_solr_params)
     
-    solr_response = find(blacklight_config.solr_request_handler, self.solr_search_params().merge(solr_params) )
+    solr_response = find(blacklight_config.qt, self.solr_search_params().merge(solr_params) )
     document_list = solr_response.docs.collect{|doc| SolrDocument.new(doc, solr_response) }
     [solr_response,document_list]
   end
@@ -464,7 +489,7 @@ module Blacklight::SolrHelper
     solr_params = solr_facet_params(facet_field, user_params, extra_controller_params)
     
     # Make the solr call
-    response =find(blacklight_config.solr_request_handler, solr_params)
+    response =find(blacklight_config.qt, solr_params)
 
     limit = solr_params[:"f.#{facet_field}.facet.limit"] -1
         
@@ -490,7 +515,7 @@ module Blacklight::SolrHelper
     solr_params[:start] = (index - 1) # start at 0 to get 1st doc, 1 to get 2nd.    
     solr_params[:rows] = 1
     solr_params[:fl] = '*'
-    solr_response = find(blacklight_config.solr_request_handler, solr_params)
+    solr_response = find(blacklight_config.qt, solr_params)
     SolrDocument.new(solr_response.docs.first, solr_response) unless solr_response.docs.empty?
   end
     
@@ -513,7 +538,7 @@ module Blacklight::SolrHelper
   # where the field is the "field" argument passed in.
   def get_opensearch_response(field=nil, extra_controller_params={})
     solr_params = solr_opensearch_params().merge(extra_controller_params)
-    response = find(blacklight_config.solr_request_handler, solr_params)
+    response = find(blacklight_config.qt, solr_params)
     a = [solr_params[:q]]
     a << response.docs.map {|doc| doc[solr_params[:fl]].to_s }
   end

data/lib/blacklight/solr_response.rb

@@ -0,0 +1,60 @@
+class Blacklight::SolrResponse < Mash
+
+  autoload :Spelling, 'blacklight/solr_response/spelling'
+  autoload :Facets, 'blacklight/solr_response/facets'
+  autoload :MoreLikeThis, 'blacklight/solr_response/more_like_this'
+
+  attr_reader :request_params
+  def initialize(data, request_params)
+    super(data)
+    @request_params = request_params
+    extend Spelling
+    extend Facets
+    extend Response
+    extend MoreLikeThis
+  end
+
+  def header
+    self['responseHeader']
+  end
+  
+
+  def update(other_hash) 
+    other_hash.each_pair { |key, value| self[key] = value } 
+    self 
+  end 
+
+  def params
+      (header and header['params']) ? header['params'] : request_params
+  end
+
+  def rows
+      params[:rows].to_i
+  end
+
+  def docs
+    @docs ||= begin
+      response['docs']
+    end
+  end
+
+  def spelling
+    self['spelling']
+  end
+
+  module Response
+    def response
+      self[:response]
+    end
+    
+    # short cut to response['numFound']
+    def total
+      response[:numFound].to_s.to_i
+    end
+    
+    def start
+      response[:start].to_s.to_i
+    end
+    
+  end
+end

data/lib/blacklight/solr_response/facets.rb

@@ -0,0 +1,58 @@
+module Blacklight::SolrResponse::Facets
+  
+  # represents a facet value; which is a field value and its hit count
+  class FacetItem
+    attr_reader :value, :hits
+    def initialize value, hits
+      @value, @hits = value, hits
+    end
+  end
+  
+  # represents a facet; which is a field and its values
+  class FacetField
+    attr_reader :name, :items
+    def initialize name, items
+      @name, @items = name, items
+    end
+  end
+  
+  # @response.facets.each do |facet|
+  #   facet.name
+  #   facet.items
+  # end
+  # "caches" the result in the @facets instance var
+  def facets
+    @facets ||= (
+      facet_fields.map do |(facet_field_name,values_and_hits)|
+        items = []
+        values_and_hits.each_slice(2) do |k,v|
+          items << FacetItem.new(k, v)
+        end
+        FacetField.new(facet_field_name, items)
+      end
+    )
+  end
+  
+  # pass in a facet field name and get back a Facet instance
+  def facet_by_field_name(name)
+    @facets_by_field_name ||= {}
+    @facets_by_field_name[name] ||= (
+      facets.detect{|facet|facet.name.to_s == name.to_s}
+    )
+  end
+  
+  def facet_counts
+    @facet_counts ||= self['facet_counts'] || {}
+  end
+
+  # Returns the hash of all the facet_fields (ie: {'instock_b' => ['true', 123, 'false', 20]}
+  def facet_fields
+    @facet_fields ||= facet_counts['facet_fields'] || {}
+  end
+
+  # Returns all of the facet queries
+  def facet_queries
+    @facet_queries ||= facet_counts['facet_queries'] || {}
+  end
+  
+end # end Facets

data/lib/blacklight/solr_response/more_like_this.rb

@@ -0,0 +1,14 @@
+module Blacklight::SolrResponse::MoreLikeThis
+  def more_like document
+    mlt = more_like_this[document.id]
+    return [] unless mlt and mlt['docs']
+
+    mlt['docs']
+  end
+
+  def more_like_this
+    return {} unless self[:moreLikeThis]
+        
+    self[:moreLikeThis]
+  end
+end

data/lib/blacklight/solr_response/spelling.rb

@@ -0,0 +1,92 @@
+# A mixin for making access to the spellcheck component data easy.
+#
+# response.spelling.words
+#
+module Blacklight::SolrResponse::Spelling
+
+  def spelling
+    @spelling ||= Base.new(self)
+  end
+
+  class Base
+
+    attr :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    # returns an array of spelling suggestion for specific query words,
+    # as provided in the solr response.  Only includes words with higher
+    # frequency of occurrence than word in original query.
+    # can't do a full query suggestion because we only get info for each word;
+    # combination of words may not have results.
+    # Thanks to Naomi Dushay!
+    def words
+      @words ||= (
+        word_suggestions = []
+        spellcheck = self.response[:spellcheck]
+        if spellcheck && spellcheck[:suggestions]
+          suggestions = spellcheck[:suggestions]
+          unless suggestions.nil?
+            # suggestions is an array:
+            #    (query term)
+            #    (hash of term info and term suggestion)
+            #    ...
+            #    (query term)
+            #    (hash of term info and term suggestion)
+            #    'correctlySpelled'
+            #    true/false
+            #    collation
+            #    (suggestion for collation)
+            if suggestions.index("correctlySpelled") #if extended results
+              i_stop = suggestions.index("correctlySpelled")
+            elsif suggestions.index("collation")
+              i_stop = suggestions.index("collation")
+            else
+              i_stop = suggestions.length
+            end
+              # step through array in 2s to get info for each term
+              0.step(i_stop-1, 2) do |i|
+                term = suggestions[i]
+                term_info = suggestions[i+1]
+                # term_info is a hash:
+                #   numFound =>
+                #   startOffset =>
+                #   endOffset =>
+                #   origFreq =>
+                #   suggestion =>  [{ frequency =>, word => }] # for extended results
+                #   suggestion => ['word'] # for non-extended results
+                origFreq = term_info['origFreq']
+                if suggestions.index("correctlySpelled")
+                  word_suggestions << term_info['suggestion'].map do |suggestion|
+                    suggestion['word'] if suggestion['freq'] > origFreq
+                  end
+                else
+                  # only extended suggestions have frequency so we just return all suggestions
+                  word_suggestions << term_info['suggestion']
+                end
+              end
+          end
+        end
+        word_suggestions.flatten.compact.uniq
+      )
+    end
+
+    def collation
+      # FIXME: DRY up with words
+      spellcheck = self.response[:spellcheck]
+        if spellcheck && spellcheck[:suggestions]
+          suggestions = spellcheck[:suggestions]
+          unless suggestions.nil?
+            if suggestions.index("collation")
+              suggestions[suggestions.index("collation") + 1]
+            end
+          end
+        end
+    end
+
+  end
+
+end
+

data/lib/generators/blacklight/assets_generator.rb

@@ -17,26 +17,13 @@ module Blacklight
     source_root File.expand_path('../templates', __FILE__)
   
     def assets
-      unless IO.read("app/assets/stylesheets/application.css").include?("Blacklight")
-        copy_file('assets/standard.css.scss', 'app/assets/stylesheets/blacklight_themes/standard.css.scss')
-        insert_into_file "app/assets/stylesheets/application.css", :after => "/*" do
-  %q{
- * Required by Blacklight:
- *= require 'jquery/ui-lightness/jquery-ui-1.8.1.custom.css'
- *
- * This is the default theme. You can modify many of the settings 
- * by editing your local app/assets/stylesheets/blacklight_themes/standard.css
- *= require 'blacklight_themes/standard'         
- *}
-        end
-      end
+      copy_file "blacklight.css.scss", "app/assets/stylesheets/blacklight.css.scss"
 
       unless IO.read("app/assets/javascripts/application.js").include?('blacklight/blacklight')
         insert_into_file "app/assets/javascripts/application.js", :after => "//= require jquery_ujs" do
   %q{
 //
 // Required by Blacklight
-//= require jquery-ui
 //= require blacklight/blacklight}          
         end
       end

data/lib/generators/blacklight/blacklight_generator.rb

@@ -14,17 +14,16 @@ class BlacklightGenerator < Rails::Generators::Base
 This generator makes the following changes to your application:
  1. Creates several database migrations if they do not exist in /db/migrate
  2. Adds additional mime types to you application in the file '/config/initializers/mime_types.rb'
- 3. Creates config/initializers/blacklight_config.rb which you should then modify for your instance
- 4. Creates config/solr.yml with a default solr configuration that should work with standard marc records
- 5. Creates congig/SolrMarc/... with settings for SolrMarc
- 6. Creates a number of public assets, including images, stylesheets, and javascript
- 7. Adds a solr_marc.jar file to your lib/ directory 
- 9. Injects behavior into your user application_controller.rb
- 9. Injects behavior into your user model
-10. Creates a blacklight catalog controller in your /app/controllers directory
-11. Creates a blacklight document in your /app/models directory
-12. Adds Blacklight routes to your ./config/routes.rb
-13. Enables internationalization.
+ 3. Creates config/solr.yml with a default solr configuration that should work with standard marc records
+ 4. Creates congig/SolrMarc/... with settings for SolrMarc
+ 5. Creates a number of public assets, including images, stylesheets, and javascript
+ 6. Adds a solr_marc.jar file to your lib/ directory 
+ 7. Injects behavior into your user application_controller.rb
+ 8. Injects behavior into your user model
+ 9. Creates a blacklight catalog controller in your /app/controllers directory
+10. Creates a blacklight document in your /app/models directory
+11. Adds Blacklight routes to your ./config/routes.rb
+12. Enables internationalization.
 
 Thank you for Installing Blacklight.
        """ 
@@ -65,11 +64,15 @@ EOF
     end     
   end
 
+  def add_unicode_gem
+    gem "unicode", :platforms => [:mri_18, :mri_19] unless defined?(:RUBY_VERSION) and RUBY_VERSION == '2.0.0'
+  end
+
   # Install Devise? 
   def generate_devise_assets
     if options[:devise]
       gem "devise"
-      gem "devise-guests", "~> 0.3"
+      gem "devise-guests", "~> 0.2"
 
       Bundler.with_clean_env do
        run "bundle install"
@@ -77,7 +80,6 @@ EOF
       
       generate "devise:install"
       generate "devise", model_name.classify
-      generate "devise_guests", model_name.classify
       generate "devise:views"
       
       # add the #to_s to the model.      
@@ -97,8 +99,8 @@ EOF
 
   # Copy all files in templates/config directory to host config
   def create_configuration_files
-    copy_file "config/blacklight_config.rb", "config/initializers/blacklight_config.rb"
     copy_file "config/solr.yml", "config/solr.yml"
+    copy_file "config/jetty.yml", "config/jetty.yml"
     directory("config/SolrMarc")
   end
   
@@ -158,12 +160,6 @@ EOF
   end
 
   def add_sass_configuration
-    gem 'compass-rails', '~> 1.0.0', :group => :assets
-    gem 'compass-susy-plugin', '~> 0.9.0', :group => :assets
-    
-    Bundler.with_clean_env do
-     run "bundle install"
-    end
 
     insert_into_file "config/application.rb", :after => "config.assets.enabled = true" do <<EOF
     
@@ -173,9 +169,14 @@ EOF
 EOF
       end
 
-      copy_file "config/compass.rb", "config/compass.rb"
   end
 
+  def add_bootstrap_gem
+    # Don't need a version here, because we specify the version in blacklight.gemspec
+    gem 'bootstrap-sass'
+  end 
+
+
   private  
   
   def better_migration_template (file)