blacklight_highlight 0.0.3 → 0.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'combustion'

data/Gemfile.lock

@@ -0,0 +1,180 @@
+PATH
+  remote: .
+  specs:
+    blacklight_highlight (0.0.2)
+      blacklight
+      rails (~> 3.0)
+      rsolr
+      rsolr-ext
+
+PATH
+  remote: ../blacklight
+  specs:
+    blacklight (3.2.0pre2)
+      compass (>= 0.12.alpha.2)
+      kaminari
+      marc (~> 0.4.3)
+      nokogiri (~> 1.5)
+      rails (~> 3.1.1)
+      rsolr (~> 1.0.6)
+      rsolr-ext (~> 1.0.3)
+      sass-rails (~> 3.1.1)
+      unicode
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.3)
+      actionpack (= 3.1.3)
+      mail (~> 2.3.0)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    chunky_png (1.2.5)
+    combustion (0.3.1)
+      rails (>= 3.1.0)
+      thor (>= 0.14.6)
+    compass (0.12.alpha.2)
+      chunky_png (~> 1.2)
+      fssm (>= 0.2.7)
+      sass (~> 3.1)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    fakeweb (1.3.0)
+    ffi (1.0.11)
+    fssm (0.2.7)
+    hike (1.2.1)
+    i18n (0.6.0)
+    json (1.6.3)
+    json_pure (1.6.1)
+    kaminari (0.13.0)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    marc (0.4.3)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    nokogiri (1.5.0)
+    polyglot (0.3.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.3)
+      actionmailer (= 3.1.3)
+      actionpack (= 3.1.3)
+      activerecord (= 3.1.3)
+      activeresource (= 3.1.3)
+      activesupport (= 3.1.3)
+      bundler (~> 1.0)
+      railties (= 3.1.3)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rsolr (1.0.6)
+      builder (>= 2.1.2)
+    rsolr-ext (1.0.3)
+      rsolr (>= 1.0.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    rspec-rails (2.7.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.7.0)
+    rubyzip (0.9.4)
+    sass (3.1.12)
+    sass-rails (3.1.5)
+      actionpack (~> 3.1.0)
+      railties (~> 3.1.0)
+      sass (~> 3.1.10)
+      tilt (~> 1.3.2)
+    selenium-webdriver (2.13.0)
+      childprocess (>= 0.2.1)
+      ffi (~> 1.0.9)
+      json_pure
+      rubyzip
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+    unicode (0.4.0)
+    vcr (1.11.3)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blacklight!
+  blacklight_highlight!
+  capybara
+  combustion
+  fakeweb
+  rspec
+  rspec-rails
+  sqlite3
+  vcr

data/README.rdoc

@@ -4,13 +4,11 @@ BlacklightHighlight: Blacklight plugin that exposes Solr's highlight field compo
 
 The BlacklightHighlight Field plugin provides basic support for the Solr Highlight component, which provides search term highlighting in text fields.
 
-This plugin will _replace_ the document field response with the highlighter field (if present). This means that if, for example, you have the field 'description_t' in your Blacklight.config[:index_fields], if 'description_t' is a 'highlighted' field, the result of SolrDocument#get('description_t') *will be* the highlighted version of this feel.
-
-Future versions of this plugin may allow you to selectively request highlighted fields. 
+This plugin overrides low-level methods from RSolr::Doc to provide easy access to the highlighting results. This means, however, that if you have a highlighted field, it may be difficult to access the un-highlighted version directly. It also provides a very basic configuration out-of-the-box, with the expectation that you will configure Solr to provide better highlighting results.
 
 = Requirements
 
-A Rails app using Blacklight >3.x.
+A Rails app using Blacklight >=3.2.
 
 = Installation
 
@@ -35,9 +33,6 @@ Then run "rails generate blacklight_highlight" to install the appropriate extens
 
 You should configure your Solr request handlers to provide the appropriate highlighting results (see <http://wiki.apache.org/solr/HighlightingParameters>). If you do not add any fields, the Solr default will be used (" the fields highlighted for the LuceneQParser are the defaultSearchField (or the df param if used) and for the DisMax parser the qf fields are used."). 
 
-
 = Tests
 
-There are none. This is bad I know, sorry. 
-
-
+Run `rspec`.

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/blacklight_highlight.gemspec

@@ -19,7 +19,14 @@ Gem::Specification.new do |s|
 
 
   s.add_dependency "rails", "~> 3.0"
-  s.add_dependency "blacklight"
+  s.add_dependency "blacklight", "~> 3.2"
   s.add_dependency "rsolr"
   s.add_dependency "rsolr-ext"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency 'fakeweb'
 end

data/config.ru

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler'
+
+require 'blacklight/engine'
+require 'rsolr'
+require 'rsolr-ext'
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/lib/blacklight_highlight/controller_extension.rb

@@ -2,17 +2,8 @@
 # Blacklight::SolrHelper. 
 module BlacklightHighlight::ControllerExtension
   def self.included(some_class)
-    some_class.helper_method :highlight_config
     some_class.helper BlacklightHighlightHelper
     some_class.send(:include, BlacklightHighlight::SolrHelperExtension)
   end
-
-  # Uses Blacklight.config, needs to be modified when
-  # that changes to be controller-based. This is the only method
-  # in this plugin that accesses Blacklight.config, single point
-  # of contact. 
-  def highlight_config
-    Blacklight.config[:highlight] || {}
-  end
 end
 

data/lib/blacklight_highlight/solr_document_extension.rb

@@ -1,29 +1,58 @@
 module BlacklightHighlight
   module SolrDocumentExtension
-    def self.included some_class
-      some_class.after_initialize do
+    extend ActiveSupport::Concern
+
+    included do 
+      after_initialize do
         solr_response.send(:extend, RSolr::Ext::Response::Highlight) unless solr_response.is_a? RSolr::Ext::Response::Highlight
       end
     end
 
-    def [] key
-      return super(key) if key == self.class.unique_key
-      return highlight(key) if highlight_fields.key?(key) and not highlight(key).blank?
+    module ClassMethods
+      ##
+      # Provide a class-level method to white-list highlighted fields
+      # By default, it will highlight every field for which there's a highlight result
+      def highlight
+        @highlight ||= []
+      end
+    end
 
+    ## 
+    # Override RSolr::Doc methods with highlighting equivalents
+    def [] key
+      return highlight(key) if highlight?(key)
       super(key)
     end
 
+    ## 
+    # Override RSolr::Doc methods with highlighting equivalents
     def key? key
-      return super(key) if key == self.class.unique_key
-      return true if highlight_fields.key?(key)
-    
+      return true if highlight?(key)
       super(key)
     end
 
-    def highlight key = nil
-      return if key == self.class.unique_key
+    ##
+    # Get the (html-safe) highlight values for a field
+    # @param [String] key
+    def highlight key
+      return unless highlight? key
       highlight_fields[key].map { |x| x.html_safe }
     end
+    
+    ##
+    # Does the field have highlighting values?
+    # @param [String] key
+    def highlight? key
+      return false if key.nil? or key == self.class.unique_key
+
+      if self.class.highlight.include? key.to_sym
+        return true
+      elsif !self.class.highlight.empty?
+        return false
+      end
+
+     !highlight_fields[key].blank?
+    end
 
     def highlight_fields
       @highlight_fields ||= begin

data/lib/blacklight_highlight/solr_helper_extension.rb

@@ -5,7 +5,12 @@ module BlacklightHighlight::SolrHelperExtension
   end
 
   def solr_highlight_params solr_parameters, user_parameters
-    solr_parameters[:hl] ||= true
+
+    if solr_parameters['q'] || solr_parameters['hl.q'] || solr_parameters[:q] || solr_parameters[:'hl.q']
+      solr_parameters[:hl] ||= true
+      solr_parameters[:'hl.fl'] ||= ''
+      solr_parameters[:'hl.fl'] += blacklight_config.index_fields.select { |key, config| config.highlight }.map { |key, config| config.field }.join(",")
+    end
   end
 end
 

data/spec/acceptance/blacklight_highlight_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'Blacklight highlighting' do
+  use_vcr_cassette "solr"
+  before do
+    CatalogController.configure_blacklight do |config|
+      config.index.show_link = 'title_display'
+      config.default_solr_params = {
+        :per_page => 10
+      }
+
+      config.add_index_field 'field'
+      config.add_index_field 'highlight_field', :highlight => true
+    end
+  end
+
+  it "" do
+    visit '/'
+    fill_in 'q', :with => 'ipsum lorem'
+    click_button 'search'
+
+    page.should_not have_content 'Lorem ipsum'
+    page.should have_content 'lorem et lorem'
+    page.should_not have_content '<em>lorem</em>'
+  end
+end

data/spec/integration/blacklight_highlight_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Blacklight Highlighing' do
+  it "should add :hl to the solr params" do
+    parameters = CatalogController.new.solr_search_params({:q => 'asdf'})
+    parameters[:hl].should == true
+  end
+
+  it "should not add :hl to the solr params if no :q param is given" do
+    parameters = CatalogController.new.solr_search_params({})
+    parameters[:hl].should_not == true
+  end
+end

data/spec/integration/blacklight_stub_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe 'Blacklight Test Application' do
+  it "should have a Blacklight module" do
+    Blacklight.should be_a_kind_of(Module)
+  end
+  it "should have a Catalog controller" do
+    CatalogController.blacklight_config.should be_a_kind_of(Blacklight::Configuration)
+  end
+end

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

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  include Blacklight::Controller
+
+end

data/spec/internal/app/models/solr_document.rb

@@ -0,0 +1,3 @@
+class SolrDocument
+  include Blacklight::Solr::Document
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  Blacklight.add_routes(self)
+
+  root :to => "catalog#index"
+  #
+end

data/spec/internal/config/solr.yml

@@ -0,0 +1,18 @@
+# = jetty_path key
+# each environment can have a jetty_path with absolute or relative
+# (to app root) path to a jetty/solr install. This is used
+# by the rake tasks that start up solr automatically for testing
+# and by rake solr:marc:index.  
+#
+# jetty_path is not used by a running Blacklight application
+# at all. In general you do NOT need to deploy solr in Jetty, you can deploy it
+# however you want.  
+# jetty_path is only required for rake tasks that need to know
+# how to start up solr, generally for automated testing. 
+
+development:
+  url: http://127.0.0.1:8983/solr
+test: &test
+  url: http://127.0.0.1:8983/solr
+cucumber:
+  <<: *test

data/spec/internal/db/schema.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20111123152341) do
+
+  create_table "bookmarks", :force => true do |t|
+    t.integer  "user_id",     :null => false
+    t.string   "document_id"
+    t.string   "title"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "user_type"
+  end
+
+  create_table "searches", :force => true do |t|
+    t.text     "query_params"
+    t.integer  "user_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "user_type"
+  end
+
+  add_index "searches", ["user_id"], :name => "index_searches_on_user_id"
+
+  create_table "users", :force => true do |t|
+    t.string   "email",                                 :default => "", :null => false
+    t.string   "encrypted_password",     :limit => 128, :default => "", :null => false
+    t.string   "reset_password_token"
+    t.datetime "reset_password_sent_at"
+    t.datetime "remember_created_at"
+    t.integer  "sign_in_count",                         :default => 0
+    t.datetime "current_sign_in_at"
+    t.datetime "last_sign_in_at"
+    t.string   "current_sign_in_ip"
+    t.string   "last_sign_in_ip"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "users", ["email"], :name => "index_users_on_email", :unique => true
+  add_index "users", ["reset_password_token"], :name => "index_users_on_reset_password_token", :unique => true
+
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/lib/solr_document_extension_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe BlacklightHighlight::SolrDocumentExtension do
+  subject { SolrDocument.new :field => 'value' }
+
+  describe "functional" do
+    before do
+      subject.stub(:highlight_fields => {
+        'field' => ['<em>value</em>'],
+        'other_field' => ['<em>ipsum</em> lorem']
+      })
+    end
+
+    describe '#get' do
+      it "should return the highlighted field" do
+        val = subject.get('field', :separator => nil)
+        val.should include('<em>value</em>')
+        val.first.should be_html_safe
+      end
+    end
+
+    describe "#key?" do
+      it "should be true when a highlighted field is available" do
+        subject.key?('other_field').should == true
+      end
+    end
+
+    describe "#highlight" do
+      it "should retrieve highlighted values from the solr response" do
+        subject.highlight('field').should include('<em>value</em>')
+      end
+
+      it "should not try to look up the unique key value for highlighting" do
+        subject.highlight('id').should be_nil
+      end
+    end
+  end
+
+  describe "#highlight_fields" do
+    it "should be empty if no solr response is provided" do
+      subject.highlight_fields.should be_a_kind_of(Hash)
+      subject.highlight_fields.should be_empty
+    end
+
+    it "should use the RSolr::Ext highlighting extension to get highlighted values" do
+      @mock_solr_response = mock()
+      @mock_solr_response.should_receive(:respond_to?).with(:highlight) { true }
+      @mock_solr_response.should_receive(:highlight)
+      subject.stub(:solr_response => @mock_solr_response)
+      subject.highlight_fields
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+require 'blacklight/engine'
+require 'rsolr'
+require 'rsolr-ext'
+require 'rsolr-ext/response'
+require 'capybara/rspec'
+Combustion.initialize!
+
+
+# Setup blacklight environment
+Blacklight.solr_config = { :url => 'http://127.0.0.1:8983/solr' }
+CatalogController.send(:include, BlacklightHighlight::ControllerExtension)
+
+class SolrDocument
+  include Blacklight::Solr::Document
+  include BlacklightHighlight::SolrDocumentExtension
+end
+
+require 'vcr'
+
+VCR.config do |config|
+  config.stub_with :fakeweb
+  config.cassette_library_dir = 'spec/vcr_cassettes'
+end
+
+require 'rspec/rails'
+require 'capybara/rails'
+
+RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
+
+end
+

data/spec/vcr_cassettes/solr.yml

@@ -0,0 +1,177 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://127.0.0.1:8983/solr/select?wt=ruby&rows=10
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/plain; charset=utf-8
+      server:
+      - Jetty(6.1.3)
+    body: ! '{''responseHeader''=>{''status''=>0,''QTime''=>31,''params''=>{''wt''=>''ruby'',''hl''=>''true'',''rows''=>''20''}},''response''=>{''numFound''=>30,''start''=>0,''maxScore''=>1.0,''docs''=>[{''author_display''=>''Ayaz,
+      Shaikh, 1923-1997'',''format''=>''Book'',''title_display''=>''Fikr-i Ayāz'',''id''=>''00282214'',''published_display''=>[''Karācī''],''lc_callnum_display''=>[''PK2788.9.A9
+      F55 1998''],''pub_date''=>[''1998''],''language_facet''=>[''Urdu''],''material_type_display''=>[''375
+      p.''],''score''=>1.0},{''author_display''=>''Ayaz, Shaikh, 1923-1997'',''format''=>''Book'',''title_display''=>''Sāhivāl
+      jail kī ḍāʼirī'',''id''=>''00282371'',''published_display''=>[''Karācī''],''lc_callnum_display''=>[''MLCME
+      2002/02660 (D)''],''pub_date''=>[''1986''],''language_facet''=>[''Urdu''],''material_type_display''=>[''232
+      p.''],''score''=>1.0},{''subtitle_display''=>''guft va gū-yi Akbar Ganjī bā
+      ʻAbd Allāh Nūrī : bih payvast-i matn-i istīz̤āḥ-i ʻAbd Allāh Nūrī dar
+      Majlis-i panjum'',''author_vern_display''=>''‏نورى، عبد الله'',''title_display''=>''Naqdī
+      barā-yi tamām-i fuṣūl'',''id''=>''00313831'',''author_display''=>''Nūrī,
+      ʻAbd Allāh, 1949-'',''title_vern_display''=>''‏نقدى براى تمام فصول :‏'',''format''=>''Book'',''subtitle_vern_display''=>''‏گفت
+      و گوى اکبر گنجى با عبد الله نورى : به پيوست  متن استيضاح عبد الله نورى در مجلس
+      پنجم'',''isbn_t''=>[''9645625963''],''published_display''=>[''Tihrān''],''lc_callnum_display''=>[''DS318.84.N87
+      N87 2000''],''subject_geo_facet''=>[''Iran''],''pub_date''=>[''2000''],''subject_topic_facet''=>[''Nūrī,
+      ʻAbd Allāh, 1949-'',''Iran. Vizārat-i Kishvar''],''published_vern_display''=>[''‏تهران
+      :‏''],''language_facet''=>[''Persian''],''material_type_display''=>[''245 p.''],''subject_era_facet''=>[''1997-''],''score''=>1.0},{''author_display''=>''Yoshida,
+      Hajime, 1934-'',''title_vern_display''=>''久保栄 「火山灰地」 を読む'',''format''=>''Book'',''author_vern_display''=>''吉田一,
+      1934-'',''title_display''=>''Kubo Sakae "Kazanbaichi" o yomu'',''id''=>''00314247'',''published_display''=>[''Tōkyō''],''subject_geo_facet''=>[''Japan''],''subject_topic_facet''=>[''Kubo,
+      Sakae, 1901-1958'',''Japanese drama'',''Political plays, Japanese'',''Theater''],''pub_date''=>[''1997''],''published_vern_display''=>[''東京''],''language_facet''=>[''Japanese''],''material_type_display''=>[''480
+      p.''],''subject_era_facet''=>[''20th century''],''score''=>1.0},{''author_display''=>''Vi︠a︡tkin,
+      M. P. (Mikhail Porfirʹevich), 1895-1967'',''format''=>''Book'',''title_display''=>''Ocherki
+      po istorii Kazakhskoĭ SSR'',''id''=>''43037890'',''published_display''=>[''Moskva''],''lc_callnum_display''=>[''DK861.K3
+      V5''],''subject_geo_facet''=>[''Kazakhstan''],''pub_date''=>[''1941''],''language_facet''=>[''Russian''],''material_type_display''=>[''v.''],''score''=>1.0},{''author_display''=>''Korea
+      (North)'',''format''=>''Book'',''title_display''=>''Konstitut︠s︡ii︠a︡ i osnovnye
+      zakonodatelʹnye akty Koreĭskoĭ Narodno-Demokraticheskoĭ Respubliki'',''id''=>''53029833'',''published_display''=>[''Moskva''],''lc_callnum_display''=>[''KPC13
+      1952''],''pub_date''=>[''1952''],''language_facet''=>[''Russian''],''material_type_display''=>[''396
+      p.''],''score''=>1.0},{''title_display''=>''Koryŏ inmul yŏlchŏn'',''id''=>''77826928'',''title_vern_display''=>''高麗
+      人物 列傅'',''format''=>''Book'',''published_display''=>[''Sŏul''],''lc_callnum_display''=>[''DS912.38
+      .K982 1976''],''subject_geo_facet''=>[''Korea''],''pub_date''=>[''1976''],''published_vern_display''=>[''서울''],''language_facet''=>[''Korean''],''material_type_display''=>[''255
+      p.''],''subject_era_facet''=>[''Koryŏ period, 935-1392''],''score''=>1.0},{''author_display''=>''Parikshit
+      Sharma, Ogeti, 1930-'',''format''=>''Book'',''title_display''=>''Yaśodharā-mahākāvyam'',''id''=>''78908283'',''published_display''=>[''Puṇyapattanam'',''Haidrābāda''],''lc_callnum_display''=>[''PK3799.P29
+      Y3''],''subject_topic_facet''=>[''Gautama Buddha'',''Yaśodharā (Wife of Gautama
+      Buddha)''],''pub_date''=>[''1976''],''language_facet''=>[''Sanskrit''],''material_type_display''=>[''24,
+      128, 2 p.''],''score''=>1.0},{''author_display''=>''Iṣlāḥī, Amīn Aḥsan,
+      1904-1997'',''format''=>''Book'',''title_display''=>''Pākistānī ʻaurat dorāhe
+      par'',''id''=>''79930185'',''published_display''=>[''Lāhaur''],''lc_callnum_display''=>[''HQ1745.5
+      .I83 1978''],''subject_geo_facet''=>[''Pakistan''],''subject_topic_facet''=>[''Women''],''pub_date''=>[''1978''],''language_facet''=>[''Urdu''],''material_type_display''=>[''8,
+      174 p.''],''score''=>1.0},{''author_display''=>''Nārāyaṇapaṇḍita, 17th
+      cent'',''format''=>''Book'',''title_display''=>''Āśleṣāśataka of Nārāyaṇa
+      Paṇḍita'',''id''=>''85910001'',''published_display''=>[''Trivandrum''],''lc_callnum_display''=>[''Microfiche
+      90/61328 (P)''],''pub_date''=>[''1946''],''language_facet''=>[''Sanskrit''],''material_type_display''=>[''xii,
+      24 p.''],''score''=>1.0},{''subtitle_display''=>''sipurim mafliʼim ha-mevusasim
+      ʻal ʻuvdot hisṭoriyot'',''author_vern_display''=>''‏פינקל, חיים יעקב'',''title_display''=>''Shodede-yam
+      Yehudiyim'',''id''=>''86207417'',''author_display''=>''Finkel, Chaim Jacob'',''title_vern_display''=>''‏שודדי־ים
+      יהודיים :‏'',''format''=>''Book'',''subtitle_vern_display''=>''‏ספורים מפליאים
+      המבוססים על עובדות היסטוריות /‏'',''isbn_t''=>[''9650101373''],''published_display''=>[''Yerushalayim''],''lc_callnum_display''=>[''G535
+      .F54 1984''],''pub_date''=>[''1984''],''subject_topic_facet''=>[''Jewish pirates'',''Jewish
+      criminals''],''published_vern_display''=>[''‏ירושלים :‏''],''language_facet''=>[''Hebrew''],''material_type_display''=>[''283
+      p.''],''score''=>1.0},{''author_vern_display''=>''‏موحد ابطحى، خجة'',''title_display''=>''Āshnāʼī
+      bā ḥawzahʹhā-yi ʻilmīyah-ʼi Shīʻah dar ṭūl-i tārīkh'',''id''=>''87931798'',''author_display''=>''Muvaḥḥid
+      Abṭaḥī, Ḥujjat'',''title_vern_display''=>''‏اشنائى با حوزه‌هاى علميۀ شيعه
+      در طول تاريخ /‏'',''format''=>''Book'',''published_display''=>[''Iṣfahān''],''lc_callnum_display''=>[''BP44
+      .M88 1986''],''subject_geo_facet''=>[''Islamic countries''],''pub_date''=>[''1986''],''subject_topic_facet''=>[''Religious
+      institutions'',''Shiites'',''Islamic universities and colleges''],''published_vern_display''=>[''‏اصفهان
+      :‏''],''language_facet''=>[''Persian''],''material_type_display''=>[''v. <1>''],''score''=>1.0},{''author_display''=>''Lomtʻatʻiże,
+      Čola, 1879-1915'',''subtitle_display''=>''tʻeoriul-metʻoduri narkvevi'',''format''=>''Book'',''title_display''=>''Mrecvelobis
+      mušakis cʻxovrebis cesi'',''id''=>''90142413'',''published_display''=>[''Tʻbilisi''],''lc_callnum_display''=>[''MLCSN
+      96/3906 (H)''],''subject_topic_facet''=>[''Industrial workers; life style''],''pub_date''=>[''1975''],''language_facet''=>[''Georgian''],''material_type_display''=>[''65
+      p.''],''score''=>1.0},{''title_display''=>''Pukhan pŏmnyŏngjip'',''id''=>''92117465'',''title_vern_display''=>''北韓　法令集　／'',''author_display''=>''Korea
+      (North)'',''format''=>''Book'',''published_display''=>[''Sŏul Tʻŭkpyŏlsi''],''lc_callnum_display''=>[''KPC13
+      .K67 1990''],''subject_geo_facet''=>[''Korea (North)''],''pub_date''=>[''1990''],''subject_topic_facet''=>[''Law''],''published_vern_display''=>[''서울　持別市　：''],''language_facet''=>[''Korean''],''material_type_display''=>[''5
+      v.''],''score''=>1.0},{''subtitle_display''=>''ṿe-hu perush yafeh u-menupeh
+      ʻal Shulḥan ʻarukh Oraḥ ḥayim asher ḥiber Yosef Ḳaro ... ʻim ḥidushe dinim
+      she-hishmiṭ ha-gaʼon ... ṿe-himtsiʼam ... Mosheh Iserlish'',''author_vern_display''=>''‏ישראל
+      מאיר,‏ ‏הכהן'',''title_display''=>''Sefer Mishnah berurah'',''id''=>''92828023'',''author_display''=>''Israel
+      Meir, ha-Kohen, 1838-1933'',''title_vern_display''=>''‏ספר משנה ברורה :‏'',''format''=>''Book'',''subtitle_vern_display''=>''‏והוא
+      פירוש יפה ומנפה על שלחן ערוך ארח חיים אשר חבר יוסף קארו ... עם חידושי דינים
+      שהשמיט הגאון ... והמציאם משה איסרליש /‏'',''published_display''=>[''Jerusalem?''],''lc_callnum_display''=>[''BM520.88.A53
+      I88 1992b''],''pub_date''=>[''1992''],''subject_topic_facet''=>[''Karo, Joseph
+      ben Ephraim, 1488-1575'',''Jewish law'',''Judaism''],''published_vern_display''=>[''‏[Jerusalem?
+      :‏''],''language_facet''=>[''Hebrew''],''material_type_display''=>[''v. <1-5>''],''score''=>1.0},{''subtitle_display''=>''kangnam
+      yŏin kwa sin pʻalbulchʻul : Kim Hong-sin setʻae rŭpʻo'',''author_vern_display''=>''김　홍신,
+      1947-'',''title_display''=>''Ajikto kŭrŏk chŏrŏk sasimnikka'',''id''=>''94120425'',''author_display''=>''Kim,
+      Hong-sin, 1947-'',''title_vern_display''=>''아직도　그럭　저럭　사십니까'',''format''=>''Book'',''subtitle_vern_display''=>''강남　여인　과　신　팔불출
+      : 金　洪信　세태　르포'',''published_display''=>[''Sŏul''],''lc_callnum_display''=>[''HQ1765.5
+      .K46 1990''],''subject_geo_facet''=>[''Seoul (Korea)'',''Korea (South)''],''pub_date''=>[''1990''],''subject_topic_facet''=>[''Women''],''published_vern_display''=>[''서울''],''language_facet''=>[''Korean''],''material_type_display''=>[''289
+      p.''],''score''=>1.0},{''subtitle_display''=>''dar khiradvarzī-i siyāsī va
+      huvīyat-i mā Īrānīyān'',''author_vern_display''=>''‏رجايى، فرهنگ .'',''title_display''=>''Maʻrakah-ʼi
+      jahānʹbīnīʹhā'',''id''=>''96933325'',''author_display''=>''Rajāyī, Farhang,
+      1952 or 3-'',''title_vern_display''=>''‏معركۀ جهان‌بينىها :‏'',''format''=>''Book'',''subtitle_vern_display''=>''‏در
+      خردورزى سياسى و هويت ما ايرانيان /‏'',''published_display''=>[''Tihrān''],''lc_callnum_display''=>[''DS274
+      .R327 1994''],''subject_geo_facet''=>[''Iran''],''pub_date''=>[''1994''],''subject_topic_facet''=>[''Political
+      science'',''Iranians''],''published_vern_display''=>[''‏تهران :‏''],''language_facet''=>[''Persian''],''material_type_display''=>[''323
+      p.''],''score''=>1.0},{''author_display''=>''Nārāyaṇa Paṇḍitācārya, 13th
+      cent'',''format''=>''Book'',''title_display''=>''Sumadhvavijayaḥ'',''id''=>''2001417245'',''published_display''=>[''Bangalore''],''lc_callnum_display''=>[''PK3798.N313
+      S87 2000''],''subject_topic_facet''=>[''Madhva, 13th cent''],''pub_date''=>[''2000''],''language_facet''=>[''Sanskrit''],''material_type_display''=>[''v.
+      <1   >''],''score''=>1.0},{''author_vern_display''=>''ولد مولاي الزين، سيد محمد
+      ولد سيد'',''title_display''=>''al-Ḥarb fī al-alfīyah al-thālithah'',''id''=>''2003546302'',''author_display''=>''Wuld
+      Mawlāy al-Zayn, Sayyid Muḥammad wuld Sayyid'',''title_vern_display''=>''الحرب
+      في الألفية الثالثة'',''format''=>''Book'',''published_display''=>[''Nuwākshūṭ''],''lc_callnum_display''=>[''U21.2
+      .W85 2003''],''pub_date''=>[''2003''],''subject_topic_facet''=>[''War'',''Military
+      art and science'',''Warfare, Conventional'',''Military weapons''],''published_vern_display''=>[''نواكشوط''],''language_facet''=>[''Arabic''],''material_type_display''=>[''128
+      p.''],''subject_era_facet''=>[''21st century''],''score''=>1.0},{''author_display''=>''Bstan-ʼdzin-mkhas-grub,
+      1967-'',''format''=>''Book'',''title_display''=>''Bon-brgyaʼi lo rgyus lugs
+      gñis gsal baʼi me loṅ źes bya ba bźugs so'',''id''=>''2004310986'',''published_display''=>[''Lha-sa''],''lc_callnum_display''=>[''DS797.82.B663
+      B75 2004''],''subject_geo_facet''=>[''Bon-brgya (China)''],''pub_date''=>[''2004''],''language_facet''=>[''Tibetan''],''material_type_display''=>[''149
+      p.''],''score''=>1.0}]},''facet_counts''=>{''facet_queries''=>{},''facet_fields''=>{''format''=>[''Book'',30],''lc_1letter_facet''=>[''B
+      - Philosophy, Psychology, Religion'',6,''D - World History'',6,''H - Social
+      Sciences'',4,''P - Language & Literature'',4,''M - Music'',3,''K - Law'',2,''E
+      - History of the Americas (General)'',1,''G - Geography, Anthropology, Recreation'',1,''U
+      - Military Science'',1],''lc_alpha_facet''=>[''DS'',5,''BQ'',3,''PK'',3,''BP'',2,''HQ'',2,''KPC'',2,''BM'',1,''DK'',1,''E'',1,''G'',1],''lc_b4cutter_facet''=>[''KPC13'',2,''BM520.88.A53'',1,''BP161.3'',1,''BP44'',1,''BQ4036'',1,''BQ5593.P3'',1,''BQ7684.4'',1,''DK861.K3'',1,''DS274'',1,''DS318.84.N87'',1],''language_facet''=>[''Tibetan'',6,''Hebrew'',3,''Korean'',3,''Persian'',3,''Sanskrit'',3,''Urdu'',3,''Arabic'',2,''English'',2,''Japanese'',2,''Russian'',2],''pub_date''=>[''2008'',4,''1976'',2,''1986'',2,''1990'',2,''1997'',2,''2000'',2,''1941'',1,''1946'',1,''1952'',1,''1962'',1],''subject_era_facet''=>[''20th
+      century'',3,''1997-'',2,''21st century'',2,''1990-'',1,''2005-2015'',1,''Koryŏ
+      period, 935-1392'',1],''subject_geo_facet''=>[''India'',2,''Iran'',2,''Japan'',2,''Bon-brgya
+      (China)'',1,''Bridgeton'',1,''China'',1,''Economic history'',1,''Hong Kong (China)'',1,''Islamic
+      countries'',1,''Israel'',1],''subject_topic_facet''=>[''Japanese drama'',2,''Kubo,
+      Sakae, 1901-1958'',2,''Political plays, Japanese'',2,''Theater'',2,''Women'',2,''Accident
+      insurance'',1,''Buddhism'',1,''Delaware Indians'',1,''Delaware women'',1,''Education
+      and state'',1]},''facet_dates''=>{},''facet_ranges''=>{}},''highlighting''=>{''00282214''=>{},''00282371''=>{},''00313831''=>{},''00314247''=>{},''43037890''=>{},''53029833''=>{},''77826928''=>{},''78908283''=>{},''79930185''=>{},''85910001''=>{},''86207417''=>{},''87931798''=>{},''90142413''=>{},''92117465''=>{},''92828023''=>{},''94120425''=>{},''96933325''=>{},''2001417245''=>{},''2003546302''=>{},''2004310986''=>{}}}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://127.0.0.1:8983/solr/select?wt=ruby&q=ipsum+lorem&spellcheck.q=ipsum+lorem&rows=10&hl=true&hl.fl=highlight_field
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/plain; charset=utf-8
+      server:
+      - Jetty(6.1.3)
+    body: |
+      {
+        'responseHeader'=>{
+          'status'=>0,
+            'QTime'=>10,
+            'params'=>{
+              'indent'=>'true',
+              'wt'=>'ruby',
+              'rows' => 10,
+              'q'=>'ipsum lorem'}},
+          'response'=>{'numFound'=>1,'start'=>0,'maxScore'=>1.0,'docs'=>[
+            { 'id' => 'a', 'title_display' => 'asdf', 'field' => 'ipsum lorem', 'highlight_field' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus iaculis, urna vel convallis ullamcorper, justo libero viverra arcu, ut iaculis metus lorem et lorem. Curabitur mi dui, molestie at molestie quis, sollicitudin at turpis. Integer nec enim quam, vel tincidunt arcu. Nulla mauris purus, semper eu varius eu, volutpat et eros. Nulla rutrum felis vitae enim porttitor vestibulum. Vestibulum tellus nunc, fermentum vel venenatis eu, auctor faucibus sem. Sed viverra enim ac turpis consectetur vel interdum elit laoreet.'}
+          ]
+          },
+          'facet_counts'=>{
+            'facet_queries'=>{},
+            'facet_fields'=>{
+              'format'=>[],
+              'lc_1letter_facet'=>[],
+              'lc_alpha_facet'=>[],
+              'lc_b4cutter_facet'=>[],
+              'language_facet'=>[],
+              'pub_date'=>[],
+              'subject_era_facet'=>[],
+              'subject_geo_facet'=>[],
+              'subject_topic_facet'=>[]},
+            'facet_dates'=>{},
+            'facet_ranges'=>{}},
+          'spellcheck'=>{
+            'suggestions'=>[
+              ]
+          },
+          'highlighting' => {
+           'a' => { 'highlight_field' => [ 'ut iaculis metus <em>lorem</em> et <em>lorem</em>. Curabitur mi dui'] }
+          }
+      }
+    http_version: '1.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_highlight
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-05 00:00:00.000000000 Z
+date: 2011-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2156284000 !ruby/object:Gem::Requirement
+  requirement: &70255968374120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,21 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156284000
+  version_requirements: *70255968374120
 - !ruby/object:Gem::Dependency
   name: blacklight
-  requirement: &2156281100 !ruby/object:Gem::Requirement
+  requirement: &70255968371740 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2156281100
+  version_requirements: *70255968371740
 - !ruby/object:Gem::Dependency
   name: rsolr
-  requirement: &2156280120 !ruby/object:Gem::Requirement
+  requirement: &70255968370120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156280120
+  version_requirements: *70255968370120
 - !ruby/object:Gem::Dependency
   name: rsolr-ext
-  requirement: &2156279160 !ruby/object:Gem::Requirement
+  requirement: &70255968369000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,73 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156279160
+  version_requirements: *70255968369000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70255968368080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255968368080
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70255968367540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255968367540
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70255968366900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255968366900
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70255968366120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255968366120
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70255968362160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255968362160
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70255968360920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255968360920
 description: 
 email:
 - chris_beer@wgbh.org
@@ -63,12 +129,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - app/helpers/blacklight_highlight_helper.rb
 - blacklight_highlight.gemspec
+- config.ru
 - config/routes.rb
 - lib/blacklight_highlight.rb
 - lib/blacklight_highlight/controller_extension.rb
@@ -78,6 +147,20 @@ files:
 - lib/blacklight_highlight/version.rb
 - lib/generators/blacklight_highlight/blacklight_highlight_generator.rb
 - lib/rsolr-ext/response/highlight.rb
+- spec/acceptance/blacklight_highlight_spec.rb
+- spec/integration/blacklight_highlight_spec.rb
+- spec/integration/blacklight_stub_spec.rb
+- spec/internal/app/controllers/application_controller.rb
+- spec/internal/app/models/solr_document.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/config/solr.yml
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/lib/solr_document_extension_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_cassettes/solr.yml
 homepage: http://projectblacklight.org/
 licenses: []
 post_install_message: 
@@ -102,4 +185,18 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Blacklight Solr Highlight plugin
-test_files: []
+test_files:
+- spec/acceptance/blacklight_highlight_spec.rb
+- spec/integration/blacklight_highlight_spec.rb
+- spec/integration/blacklight_stub_spec.rb
+- spec/internal/app/controllers/application_controller.rb
+- spec/internal/app/models/solr_document.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/config/solr.yml
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/lib/solr_document_extension_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_cassettes/solr.yml