blacklight_highlight 0.0.1pre1

data/.gitignore

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,41 @@
+BlacklightHighlight: Blacklight plugin that exposes Solr's highlight field component
+
+= Description
+
+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. 
+
+= Requirements
+
+A Rails app using Blacklight >3.x.
+
+= Installation
+
+Add
+
+    gem "blacklight_highlight"
+
+to your Gemfile and run "bundle install".
+
+Then run "rails generate blacklight_highlight" to install the appropriate extensions into your CatalogController and SolrDocument classes. In you want to do customize the way this installs, instead you may:
+
+- add this to your Solr Document model:
+    
+    use_extension(BlacklightOaiProvider::SolrDocumentExtension)
+
+- add this to your Controler:
+
+
+= Configuration
+
+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. 
+
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rake'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -0,0 +1 @@
+0.0.1pre1

data/app/helpers/blacklight_highlight_helper.rb

@@ -0,0 +1,4 @@
+# Meant to be applied on top of Blacklight helpers
+module BlacklightHighlightHelper
+end
+

data/blacklight_highlight.gemspec

@@ -0,0 +1,25 @@
+ # -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "lib/blacklight_highlight/version")
+
+Gem::Specification.new do |s|
+  s.name = "blacklight_highlight"
+  s.version = BlacklightHighlight::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Chris Beer"]
+  s.email = ["chris_beer@wgbh.org"]
+  s.homepage    = "http://projectblacklight.org/"
+  s.summary = "Blacklight Solr Highlight plugin"
+
+  s.rubyforge_project = "blacklight"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+
+  s.add_dependency "rails", "~> 3.0"
+  s.add_dependency "blacklight"
+  s.add_dependency "rsolr"
+  s.add_dependency "rsolr-ext"
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+
+# We want to add a new collection action to Catalog, without over-writing
+# what's already there. This SEEMS to do it. 
+ActionController::Routing::Routes.draw do |map|  
+end
+

data/lib/blacklight_highlight/controller_extension.rb

@@ -0,0 +1,18 @@
+# Meant to be applied on top of a controller that implements
+# 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/engine.rb

@@ -0,0 +1,9 @@
+require 'blacklight'
+require 'blacklight_highlight'
+require 'rails'
+
+module BlacklightHighlight
+  class Engine < Rails::Engine
+  
+  end
+end

data/lib/blacklight_highlight/solr_document_extension.rb

@@ -0,0 +1,22 @@
+module BlacklightHighlight
+  module SolrDocumentExtension
+    def self.included some_class
+      some_class.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 highlight(key) unless highlight(key).blank?
+
+      super(key)
+    end
+
+    def highlight key=nil
+      return unless solr_response and solr_response.respond_to? :highlight
+      return if key == self.class.unique_key
+
+      solr_response.highlight(self, key)
+    end
+  end
+end

data/lib/blacklight_highlight/solr_helper_extension.rb

@@ -0,0 +1,11 @@
+# Meant to be applied on top of Blacklight helpers
+module BlacklightHighlight::SolrHelperExtension
+  def self.included some_class
+    some_class.solr_search_params_logic += [:solr_highlight_params]
+  end
+
+  def solr_highlight_params solr_parameters, user_parameters
+    solr_parameters[:hl] ||= true
+  end
+end
+

data/lib/blacklight_highlight/version.rb

@@ -0,0 +1,10 @@
+module BlacklightHighlight
+  unless BlacklightHighlight.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_highlight.rb

@@ -0,0 +1,12 @@
+# BlacklightHighlight
+require 'rsolr-ext/response/highlight'
+
+module BlacklightHighlight
+  autoload :ControllerExtension, 'blacklight_highlight/controller_extension'
+  autoload :SolrDocumentExtension, 'blacklight_highlight/solr_document_extension'
+  autoload :SolrHelperExtension, 'blacklight_highlight/solr_helper_extension'
+
+  require 'blacklight_highlight/version'
+  require 'blacklight_highlight/engine'
+
+end

data/lib/generators/blacklight_highlight/blacklight_highlight_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+
+class BlacklightHighlightGenerator < Rails::Generators::Base
+
+  argument :model_name, :type => :string, :default => "SolrDocument"
+  argument :controller_name, :type => :string, :default => "CatalogController"
+
+  def inject_solr_document_extension
+    file_path = "app/models/#{model_name.underscore}.rb"
+
+    if File.exists? file_path
+      inject_into_file file_path, :after => "include Blacklight::Solr::Document" do
+        "\n  include BlacklightHighlight::SolrDocumentExtension\n"
+      end
+    end
+  end
+
+  def inject_catalog_controller_extension
+    file_path = "app/controllers/#{controller_name.underscore}.rb"
+    if File.exists? file_path
+      inject_into_file file_path, :after => "include Blacklight::Catalog" do
+        "\n  include BlacklightHighlight::ControllerExtension\n"
+      end
+    end
+
+  end
+end

data/lib/rsolr-ext/response/highlight.rb

@@ -0,0 +1,22 @@
+module RSolr
+  module Ext
+    module Response
+      module Highlight
+        def highlight document, field = nil
+          doc_highlights = highlights[document.id]
+          doc_highlights ||= {}
+
+          return doc_highlights[field] if field
+
+          doc_highlights
+        end
+    
+        def highlights 
+          return {} unless self[:highlighting] 
+    
+          @highlights ||= self[:highlighting]
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: blacklight_highlight
+version: !ruby/object:Gem::Version 
+  hash: 1923831971
+  prerelease: 5
+  segments: 
+  - 0
+  - 0
+  - 1
+  - pre
+  - 1
+  version: 0.0.1pre1
+platform: ruby
+authors: 
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: blacklight
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rsolr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rsolr-ext
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: 
+email: 
+- chris_beer@wgbh.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/helpers/blacklight_highlight_helper.rb
+- blacklight_highlight.gemspec
+- config/routes.rb
+- lib/blacklight_highlight.rb
+- lib/blacklight_highlight/controller_extension.rb
+- lib/blacklight_highlight/engine.rb
+- lib/blacklight_highlight/solr_document_extension.rb
+- lib/blacklight_highlight/solr_helper_extension.rb
+- lib/blacklight_highlight/version.rb
+- lib/generators/blacklight_highlight/blacklight_highlight_generator.rb
+- lib/rsolr-ext/response/highlight.rb
+has_rdoc: true
+homepage: http://projectblacklight.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: blacklight
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Blacklight Solr Highlight plugin
+test_files: []
+