blacklight_more_like_this 0.0.1

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,60 @@
+BlacklightMoreLikeThis: Blacklight plugin that exposes more-like-this information
+
+= Description
+
+The BlacklightMoreLikeThis plugin provides basic support for the Solr MoreLikeThis feature, which provides similar documents for a results set. The primary use case for this plugin is as an element in the document show view, but should be possible to work with it on the index view as well.
+
+= Requirements
+
+A Rails app using the Blacklight plugin (tested against post-version 2.5).
+
+= Installation
+
+This is a plugin, not a gem (because the structure was copied from existing plugins; in theory, it should be possible to make this a gem in the future).
+
+ A couple different ways to get the source into your vendor/plugins directory. 
+
+Go into your application directory, and run: 
+
+./script/plugin install git://github.com/cbeer/blacklight_more_like_this.git
+
+Later you can run ./script/plugin update blacklight_more_like_this if you like. 
+
+Requires git installed on your system. There are other ways to get the plugin in there too.
+
+OR
+cd $your_app/vendor/plugins
+git clone git://github.com/cbeer/blacklight_more_like_this.git 
+
+= Configuration
+
+You should configure solr to provide MoreLikeThis results directly (by editing the response handler <http://wiki.apache.org/solr/MoreLikeThis>), however some basic support is built into the plugin to provide the proper behaviors anyway, using config[:more_like_this] in your config/initializers/blacklight_config.rb.
+
+config[:more_like_this][:fields] = ["title", "description", "author"]
+config[:more_like_this][:count]  = 3
+
+
+== Injection
+
+This plugin assumes it is in a Blacklight Rails app, uses Blacklight methods, Rails methods, and standard ruby module includes to inject it's behaviors into the app.  
+
+You can turn off this injection if you like, although it will make the plugin less (or non-) functional unless you manually do similar injection. See lib/blacklight_more_like_this.rb#inject! to see exactly what's going on. 
+
+In any initializer, you can set:
+
+  BlacklightMoreLikeThis.omit_inject = true
+
+to turn off all injection. The plugin will be completely non-functional if you do this, of course. But perhaps you could try to re-use some of it's classes in a non-Blacklight, highly hacked Blacklight, or even non-Rails application this way. 
+
+You can also turn off injection of individual components, which could be more useful:
+   
+  BlacklightMoreLikeThis.omit_inject = {
+    :solrdocument_mixin => false,
+    :view_helpers => false
+  }
+
+= 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.1

data/app/helpers/blacklight_more_like_this_helper.rb

@@ -0,0 +1,6 @@
+# Meant to be applied on top of Blacklight helpers
+module BlacklightMoreLikeThisHelper
+  def render_more_like_this document = @document
+    render :partial => 'blacklight_more_like_this/more_like_this', :collection => document.more_like_this
+  end
+end

data/app/views/blacklight_more_like_this/_more_like_this.html.erb

@@ -0,0 +1,3 @@
+<div class="more_like_this">
+<%= link_to_document object %>
+</div>

data/blacklight_more_like_this.gemspec

@@ -0,0 +1,25 @@
+ # -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "lib/blacklight_more_like_this/version")
+
+Gem::Specification.new do |s|
+  s.name = "blacklight_more_like_this"
+  s.version = BlacklightMoreLikeThis::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 More-Like-This 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_more_like_this/controller_extension.rb

@@ -0,0 +1,17 @@
+# Meant to be applied on top of a controller that implements
+# Blacklight::SolrHelper. 
+module BlacklightMoreLikeThis::ControllerExtension
+  def self.included(some_class)
+    some_class.helper_method :more_like_this_config
+    some_class.helper BlacklightMoreLikeThisHelper
+    some_class.send(:include, BlacklightMoreLikeThis::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 more_like_this_config   
+    Blacklight.config[:more_like_this] || {}
+  end
+end

data/lib/blacklight_more_like_this/engine.rb

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

data/lib/blacklight_more_like_this/solr_document_extension.rb

@@ -0,0 +1,15 @@
+module BlacklightMoreLikeThis
+  module SolrDocumentExtension
+    def self.included some_class
+      some_class.after_initialize do
+        solr_response.send(:extend, RSolr::Ext::Response::MoreLikeThis) unless solr_response.is_a? RSolr::Ext::Response::MoreLikeThis
+      end
+    end
+
+    def more_like_this
+      return unless solr_response and solr_response.respond_to? :more_like
+
+      solr_response.more_like(self).map { |x| self.class.new(x, solr_response) }
+    end
+  end
+end

data/lib/blacklight_more_like_this/solr_helper_extension.rb

@@ -0,0 +1,34 @@
+# Meant to be applied on top of Blacklight helpers
+module BlacklightMoreLikeThis::SolrHelperExtension
+
+  def self.included some_class
+    some_class.solr_search_params_logic += [:add_solr_mlt_parameters]
+  end
+
+  def add_solr_mlt_parameters solr_parameters, user_parameters
+    config = more_like_this_config
+    config ||= {}
+
+    return unless config['enable_mlt_in_search_results'] or solr_parameters[:id]
+
+    solr_parameters[:mlt] = true
+    solr_parameters['mlt.count'] = 3
+    solr_parameters['mlt.mintf'] = 1
+
+    config.keys.select { |x| x.to_s =~ /mlt/ }.each do |k|
+      solr_parameters[k] = config[k]
+    end
+  end
+
+  def solr_doc_params(*args)
+    config = more_like_this_config
+    config ||= {}
+
+    solr_parameters = super(*args)
+
+    add_solr_mlt_parameters(solr_parameters, {})
+
+    solr_parameters
+  end  
+
+end

data/lib/blacklight_more_like_this/version.rb

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

@@ -0,0 +1,11 @@
+# BlacklightMoreLikeThis
+
+require 'rsolr-ext/response/more_like_this'
+
+module BlacklightMoreLikeThis
+  require 'blacklight_more_like_this/version'
+  require 'blacklight_more_like_this/engine'
+  autoload :ControllerExtension, 'blacklight_more_like_this/controller_extension'
+  autoload :SolrHelperExtension, 'blacklight_more_like_this/solr_helper_extension'
+  autoload :SolrDocumentExtension, 'blacklight_more_like_this/solr_document_extension'
+end

data/lib/generators/blacklight_more_like_this/blacklight_more_like_this_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+
+class BlacklightMoreLikeThisGenerator < 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 BlacklightMoreLikeThis::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 BlacklightMoreLikeThis::ControllerExtension\n"
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,20 @@
+module RSolr
+  module Ext
+    module Response
+      module MoreLikeThis
+        def more_like document
+          mlt = more_like_this[document.id]
+          return [] unless mlt and mlt['docs']
+
+          mlt['docs'].map { |x| x.extend RSolr::Ext::Doc }
+        end
+
+        def more_like_this
+          return {} unless self[:moreLikeThis]
+          
+          self[:moreLikeThis]
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: blacklight_more_like_this
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-26 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: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/helpers/blacklight_more_like_this_helper.rb
+- app/views/blacklight_more_like_this/_more_like_this.html.erb
+- blacklight_more_like_this.gemspec
+- config/routes.rb
+- lib/blacklight_more_like_this.rb
+- lib/blacklight_more_like_this/README.rdoc
+- lib/blacklight_more_like_this/controller_extension.rb
+- lib/blacklight_more_like_this/engine.rb
+- lib/blacklight_more_like_this/solr_document_extension.rb
+- lib/blacklight_more_like_this/solr_helper_extension.rb
+- lib/blacklight_more_like_this/version.rb
+- lib/generators/blacklight_more_like_this/blacklight_more_like_this_generator.rb
+- lib/rsolr-ext/response/more_like_this.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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: blacklight
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Blacklight Solr More-Like-This plugin
+test_files: []
+