onemorecloud-websolr-rails 1.1.1 → 1.3.3

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.3.3

data/config/solr_environment.rb

@@ -1,22 +1,22 @@
-ENV['RAILS_ENV']  = (ENV['RAILS_ENV'] || 'development').dup
-# RAILS_ROOT isn't defined yet, so figure it out.
-rails_root_dir = "#{File.dirname(File.expand_path(__FILE__))}/../../../../"
-SOLR_PATH = "#{File.dirname(File.expand_path(__FILE__))}/../solr" unless defined? SOLR_PATH
-
-SOLR_LOGS_PATH = "#{rails_root_dir}/log" unless defined? SOLR_LOGS_PATH
-SOLR_PIDS_PATH = "#{rails_root_dir}/tmp/pids" unless defined? SOLR_PIDS_PATH
-SOLR_DATA_PATH = "#{rails_root_dir}/solr/#{ENV['RAILS_ENV']}" unless defined? SOLR_DATA_PATH
-
-unless defined? SOLR_PORT
-  config = YAML::load_file(rails_root_dir+'/config/solr.yml')
-  
-  SOLR_PORT = ENV['PORT'] || URI.parse(config[ENV['RAILS_ENV']]['url']).port
-end
-
-SOLR_JVM_OPTIONS = config[ENV['RAILS_ENV']]['jvm_options'] unless defined? SOLR_JVM_OPTIONS
-
-if ENV['RAILS_ENV'] == 'test'
-  DB = (ENV['DB'] ? ENV['DB'] : 'mysql') unless defined?(DB)
-  MYSQL_USER = (ENV['MYSQL_USER'].nil? ? 'root' : ENV['MYSQL_USER']) unless defined? MYSQL_USER
-  require File.join(File.dirname(File.expand_path(__FILE__)), '..', 'test', 'db', 'connections', DB, 'connection.rb')
-end
+# ENV['RAILS_ENV']  = (ENV['RAILS_ENV'] || 'development').dup
+# # RAILS_ROOT isn't defined yet, so figure it out.
+# rails_root_dir = "."
+# SOLR_PATH = "#{File.dirname(File.expand_path(__FILE__))}/../solr" unless defined? SOLR_PATH
+# 
+# SOLR_LOGS_PATH = "#{rails_root_dir}/log" unless defined? SOLR_LOGS_PATH
+# SOLR_PIDS_PATH = "#{rails_root_dir}/tmp/pids" unless defined? SOLR_PIDS_PATH
+# SOLR_DATA_PATH = "#{rails_root_dir}/solr/#{ENV['RAILS_ENV']}" unless defined? SOLR_DATA_PATH
+# 
+# unless defined? SOLR_PORT
+#   config = YAML::load_file(rails_root_dir+'/config/solr.yml')
+#   
+#   SOLR_PORT = ENV['PORT'] || URI.parse(config[ENV['RAILS_ENV']]['url']).port
+# end
+# 
+# SOLR_JVM_OPTIONS = config[ENV['RAILS_ENV']]['jvm_options'] unless defined? SOLR_JVM_OPTIONS
+# 
+# if ENV['RAILS_ENV'] == 'test'
+#   DB = (ENV['DB'] ? ENV['DB'] : 'mysql') unless defined?(DB)
+#   MYSQL_USER = (ENV['MYSQL_USER'].nil? ? 'root' : ENV['MYSQL_USER']) unless defined? MYSQL_USER
+#   require File.join(File.dirname(File.expand_path(__FILE__)), '..', 'test', 'db', 'connections', DB, 'connection.rb')
+# end

data/generate_rdoc.sh

@@ -1,13 +1,13 @@
 #!/bin/sh
-git clone git@github.com:onemorecloud/websolr-rails.git /tmp/websolr-rails  
-rm -rf /tmp/websolr-rails-rdoc                                          
-rdoc --op /tmp/websolr-rails-rdoc --main README.rdoc README.rdoc lib    
-cd /tmp/websolr-rails                                                   
-git checkout origin/gh-pages                                            
-git checkout -b gh-pages                                                
-git checkout gh-pages                                                   
-mv /tmp/websolr-rails-rdoc/* .                                          
-git add .                                                               
-git add -u                                                              
-git commit -m "updating rdoc"                                           
+rm -rf /tmp/websolr-rails*
+git clone git@github.com:onemorecloud/websolr-rails.git /tmp/websolr-rails
+rdoc --op /tmp/websolr-rails-rdoc --main README.rdoc README.rdoc lib
+cd /tmp/websolr-rails
+git checkout origin/gh-pages
+git checkout -b gh-pages
+rm -rf /tmp/websolr-rails/*
+mv /tmp/websolr-rails-rdoc/* .
+git add .
+git add -u
+git commit -m "updating rdoc"
 git push origin gh-pages                                                

data/lib/acts_as_solr.rb

@@ -31,18 +31,22 @@ require File.dirname(__FILE__) + '/common_methods'
 require File.dirname(__FILE__) + '/deprecation'
 require File.dirname(__FILE__) + '/search_results'
 require File.dirname(__FILE__) + '/lazy_document'
+require File.dirname(__FILE__) + '/will_paginate_support'
 module ActsAsSolr
   
   class Post    
     def self.execute(request)
       begin
-        if File.exists?(RAILS_ROOT+'/config/solr.yml')
-          config = YAML::load_file(RAILS_ROOT+'/config/solr.yml')
-          url = config[RAILS_ENV]['url']
-          # for backwards compatibility
-          url ||= "http://#{config[RAILS_ENV]['host']}:#{config[RAILS_ENV]['port']}/#{config[RAILS_ENV]['servlet_path']}"
-        else
-          url = 'http://localhost:8982/solr'
+        # if File.exists?(RAILS_ROOT+'/config/solr.yml')
+        #   config = YAML::load_file(RAILS_ROOT+'/config/solr.yml')
+        #   url = config[RAILS_ENV]['url']
+        #   # for backwards compatibility
+        #   url ||= "http://#{config[RAILS_ENV]['host']}:#{config[RAILS_ENV]['port']}/#{config[RAILS_ENV]['servlet_path']}"
+        # else
+        #   url = 'http://localhost:8982/solr'
+        # end
+        unless url = ENV["WEBSOLR_URL"]
+          raise "WEBSOLR_URL was not defined.  Have you run websolr configure?"
         end
         connection = Solr::Connection.new(url)
         return connection.send(request)

data/lib/acts_methods.rb

@@ -205,6 +205,8 @@ module ActsAsSolr #:nodoc:
       if configuration[:include].respond_to?(:each)
         process_includes(configuration[:include])
       end
+      
+      alias_method_chain :method_missing, :solr_magic
     end
     
     private

data/lib/instance_methods.rb

@@ -6,6 +6,20 @@ module ActsAsSolr #:nodoc:
     def solr_id
       "#{self.class.name}:#{record_id(self)}"
     end
+    
+    def init_solr(data)
+      @solr_data = data
+    end
+    
+    def method_missing_with_solr_magic(method, *a, &b)
+      if method.to_s =~ /^highlighted_(.*)$/ && a.length == 0
+        original_field = $1
+        @solr_data && @solr_data[:highlights] && @solr_data[:highlights][id] && 
+          @solr_data[:highlights][id][original_field].join(" ") || send(original_field)
+      else
+        method_missing_without_solr_magic(method, *a, &b)
+      end
+    end
 
     # saves to the Solr index
     def solr_save

data/lib/parser_methods.rb

@@ -4,7 +4,7 @@ module ActsAsSolr #:nodoc:
     
     # Method used by mostly all the ClassMethods when doing a search
     def parse_query(query=nil, options={}, models=nil)
-      valid_options = [:offset, :limit, :facets, :models, :results_format, :order, :scores, :operator, :include, :lazy]
+      valid_options = [:offset, :limit, :facets, :models, :results_format, :order, :scores, :operator, :include, :lazy, :highlight]
       query_options = {}
 
       return nil if (query.nil? || query.strip == '')
@@ -15,6 +15,20 @@ module ActsAsSolr #:nodoc:
         query_options[:start] = options[:offset]
         query_options[:rows] = options[:limit]
         query_options[:operator] = options[:operator]
+
+        if options[:highlight] == true
+          options[:highlight] = {:fields => "*"}
+        end
+        
+        if options[:highlight]
+          query_options[:highlighting] = {}
+          query_options[:highlighting][:field_list] = []
+          query_options[:highlighting][:field_list] << options[:highlight][:fields].collect {|k| "#{k}_t"} if options[:highlight][:fields]
+          query_options[:highlighting][:require_field_match] =  options[:highlight][:require_field_match] if options[:highlight][:require_field_match]
+          query_options[:highlighting][:max_snippets] = options[:highlight][:max_snippets] if options[:highlight][:max_snippets]
+          query_options[:highlighting][:prefix] = options[:highlight][:prefix] if options[:highlight][:prefix]
+          query_options[:highlighting][:suffix] = options[:highlight][:suffix] if options[:highlight][:suffix]
+        end
         
         # first steps on the facet parameter processing
         if options[:facets]
@@ -29,7 +43,6 @@ module ActsAsSolr #:nodoc:
           query_options[:filter_queries] = replace_types([*options[:facets][:browse]].collect{|k| "#{k.sub!(/ *: */,"_facet:")}"}) if options[:facets][:browse]
           query_options[:facets][:queries] = replace_types(options[:facets][:query].collect{|k| "#{k.sub!(/ *: */,"_t:")}"}) if options[:facets][:query]
           
-          
           if options[:facets][:dates]
             query_options[:date_facets] = {}
             # if options[:facets][:dates][:fields] exists then :start, :end, and :gap must be there
@@ -112,9 +125,25 @@ module ActsAsSolr #:nodoc:
       
       add_scores(result, solr_data) if configuration[:format] == :objects && options[:scores]
       
+      highlighted = {}
+      solr_data.highlighting.map do |x,y| 
+        e={}
+        y1=y.map{|x1,y1| e[x1.gsub(/_[^_]*/,"")]=y1} unless y.nil?
+        highlighted[x.gsub(/[^:]*:/,"").to_i]=e
+      end unless solr_data.highlighting.nil?
+      
       results.update(:facets => solr_data.data['facet_counts']) if options[:facets]
       results.update({:docs => result, :total => solr_data.total_hits, :max_score => solr_data.max_score, :query_time => solr_data.data['responseHeader']['QTime']})
-      SearchResults.new(results)
+      results.update({:highlights=>highlighted})
+      
+      
+      sr = SearchResults.new(results)
+
+      sr.records.each do |model|
+        model.init_solr(results)
+      end
+      
+      sr
     end
     
     

data/lib/search_results.rb

@@ -58,6 +58,10 @@ module ActsAsSolr #:nodoc:
       @solr_data[:query_time]
     end
     
+    def highlights
+      @solr_data[:highlights]
+    end
+    
     alias docs results
     alias records results
     alias num_found total

data/lib/solr/response/standard.rb

@@ -51,6 +51,10 @@ class Solr::Response::Standard < Solr::Response::Ruby
     @data['highlighting'][id.to_s][field.to_s] rescue nil
   end
   
+  def highlighting
+    @data['highlighting']
+  end
+  
   # supports enumeration of hits
   # TODO revisit - should this iterate through *all* hits by re-requesting more?
   def each

data/lib/tasks/solr.rake

@@ -5,58 +5,58 @@ require 'active_record'
 
 namespace :solr do
 
-  desc 'Starts Solr. Options accepted: RAILS_ENV=your_env, PORT=XX. Defaults to development if none.'
-  task :start do
-    require "#{File.dirname(__FILE__)}/../../config/solr_environment.rb"
-    begin
-      n = Net::HTTP.new('127.0.0.1', SOLR_PORT)
-      n.request_head('/').value 
-
-    rescue Net::HTTPServerException #responding
-      puts "Port #{SOLR_PORT} in use" and return
-
-    rescue Errno::ECONNREFUSED #not responding
-      Dir.chdir(SOLR_PATH) do
-        pid = fork do
-          #STDERR.close
-          exec "java #{SOLR_JVM_OPTIONS} -Dsolr.data.dir=#{SOLR_DATA_PATH} -Djetty.logs=#{SOLR_LOGS_PATH} -Djetty.port=#{SOLR_PORT} -jar start.jar"
-        end
-        sleep(5)
-        File.open("#{SOLR_PIDS_PATH}/#{ENV['RAILS_ENV']}_pid", "w"){ |f| f << pid}
-        puts "#{ENV['RAILS_ENV']} Solr started successfully on #{SOLR_PORT}, pid: #{pid}."
-      end
-    end
-  end
+  # desc 'Starts Solr. Options accepted: RAILS_ENV=your_env, PORT=XX. Defaults to development if none.'
+  # task :start do
+  #   require "#{File.dirname(__FILE__)}/../../config/solr_environment.rb"
+  #   begin
+  #     n = Net::HTTP.new('127.0.0.1', SOLR_PORT)
+  #     n.request_head('/').value 
+  # 
+  #   rescue Net::HTTPServerException #responding
+  #     puts "Port #{SOLR_PORT} in use" and return
+  # 
+  #   rescue Errno::ECONNREFUSED #not responding
+  #     Dir.chdir(SOLR_PATH) do
+  #       pid = fork do
+  #         #STDERR.close
+  #         exec "java #{SOLR_JVM_OPTIONS} -Dsolr.data.dir=#{SOLR_DATA_PATH} -Djetty.logs=#{SOLR_LOGS_PATH} -Djetty.port=#{SOLR_PORT} -jar start.jar"
+  #       end
+  #       sleep(5)
+  #       File.open("#{SOLR_PIDS_PATH}/#{ENV['RAILS_ENV']}_pid", "w"){ |f| f << pid}
+  #       puts "#{ENV['RAILS_ENV']} Solr started successfully on #{SOLR_PORT}, pid: #{pid}."
+  #     end
+  #   end
+  # end
   
-  desc 'Stops Solr. Specify the environment by using: RAILS_ENV=your_env. Defaults to development if none.'
-  task :stop do
-    require "#{File.dirname(__FILE__)}/../../config/solr_environment.rb"
-    fork do
-      file_path = "#{SOLR_PIDS_PATH}/#{ENV['RAILS_ENV']}_pid"
-      if File.exists?(file_path)
-        File.open(file_path, "r") do |f| 
-          pid = f.readline
-          Process.kill('TERM', pid.to_i)
-        end
-        File.unlink(file_path)
-        Rake::Task["solr:destroy_index"].invoke if ENV['RAILS_ENV'] == 'test'
-        puts "Solr shutdown successfully."
-      else
-        puts "PID file not found at #{file_path}. Either Solr is not running or no PID file was written."
-      end
-    end
-  end
+  # desc 'Stops Solr. Specify the environment by using: RAILS_ENV=your_env. Defaults to development if none.'
+  # task :stop do
+  #   require "#{File.dirname(__FILE__)}/../../config/solr_environment.rb"
+  #   fork do
+  #     file_path = "#{SOLR_PIDS_PATH}/#{ENV['RAILS_ENV']}_pid"
+  #     if File.exists?(file_path)
+  #       File.open(file_path, "r") do |f| 
+  #         pid = f.readline
+  #         Process.kill('TERM', pid.to_i)
+  #       end
+  #       File.unlink(file_path)
+  #       Rake::Task["solr:destroy_index"].invoke if ENV['RAILS_ENV'] == 'test'
+  #       puts "Solr shutdown successfully."
+  #     else
+  #       puts "PID file not found at #{file_path}. Either Solr is not running or no PID file was written."
+  #     end
+  #   end
+  # end
   
-  desc 'Remove Solr index'
-  task :destroy_index do
-    require "#{File.dirname(__FILE__)}/../../config/solr_environment.rb"
-    raise "In production mode.  I'm not going to delete the index, sorry." if ENV['RAILS_ENV'] == "production"
-    if File.exists?("#{SOLR_DATA_PATH}")
-      Dir["#{SOLR_DATA_PATH}/index/*"].each{|f| File.unlink(f)}
-      Dir.rmdir("#{SOLR_DATA_PATH}/index")
-      puts "Index files removed under " + ENV['RAILS_ENV'] + " environment"
-    end
-  end
+  # desc 'Remove Solr index'
+  # task :destroy_index do
+  #   require "#{File.dirname(__FILE__)}/../../config/solr_environment.rb"
+  #   raise "In production mode.  I'm not going to delete the index, sorry." if ENV['RAILS_ENV'] == "production"
+  #   if File.exists?("#{SOLR_DATA_PATH}")
+  #     Dir["#{SOLR_DATA_PATH}/index/*"].each{|f| File.unlink(f)}
+  #     Dir.rmdir("#{SOLR_DATA_PATH}/index")
+  #     puts "Index files removed under " + ENV['RAILS_ENV'] + " environment"
+  #   end
+  # end
   
   # this task is by Henrik Nyh
   # http://henrik.nyh.se/2007/06/rake-task-to-reindex-models-for-acts_as_solr

data/lib/websolr_rails/tasks.rb

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-Dir[File.join(File.dirname(__FILE__), "..", "tasks", "*.rake"].each do |file|
+Dir[File.join(File.dirname(__FILE__), "..", "tasks", "*.rake")].each do |file|
   load file
 end

data/lib/will_paginate_support.rb

@@ -0,0 +1,12 @@
+module ActsAsSolr
+  module ClassMethods
+    def paginate_by_solr(query, options = {})
+      options[:total_entries] ||= count_by_solr(query)
+      method_missing :paginate_by_solr, query, options
+    end
+    
+    def find_all_by_solr(*args)
+      find_by_solr(*args).records
+    end
+  end
+end

data/websolr-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{websolr-rails}
-  s.version = "1.1.1"
+  s.version = "1.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kyle Maxwell"]
-  s.date = %q{2009-08-24}
+  s.date = %q{2009-08-26}
   s.default_executable = %q{websolr}
   s.description = %q{acts_as_solr compatible gem for websolr}
   s.email = %q{kyle@kylemaxwell.com}
@@ -94,6 +94,7 @@ Gem::Specification.new do |s|
      "lib/websolr_option_parser.rb",
      "lib/websolr_rails.rb",
      "lib/websolr_rails/tasks.rb",
+     "lib/will_paginate_support.rb",
      "solr/CHANGES.txt",
      "solr/LICENSE.txt",
      "solr/NOTICE.txt",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: onemorecloud-websolr-rails
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.3.3
 platform: ruby
 authors: 
 - Kyle Maxwell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-24 00:00:00 -07:00
+date: 2009-08-26 00:00:00 -07:00
 default_executable: websolr
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,6 +107,7 @@ files:
 - lib/websolr_option_parser.rb
 - lib/websolr_rails.rb
 - lib/websolr_rails/tasks.rb
+- lib/will_paginate_support.rb
 - solr/CHANGES.txt
 - solr/LICENSE.txt
 - solr/NOTICE.txt