acts_as_solr 1.0.0

data/lib/solr/response/select.rb

@@ -0,0 +1,17 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Response::Select < Solr::Response::Ruby
+  def initialize(ruby_code)
+    super
+  end
+end

data/lib/solr/response/spellcheck.rb

@@ -0,0 +1,20 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Response::Spellcheck < Solr::Response::Ruby
+  attr_reader :suggestions
+  
+  def initialize(ruby_code)
+    super
+    @suggestions = @data['suggestions']
+  end
+end

data/lib/solr/response/standard.rb

@@ -0,0 +1,64 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Response::Standard < Solr::Response::Ruby
+  FacetValue = Struct.new(:name, :value)
+  include Enumerable
+  
+  def initialize(ruby_code)
+    super
+    @response = @data['response']
+    raise "response section missing" unless @response.kind_of? Hash
+  end
+
+  def total_hits
+    @response['numFound']
+  end
+
+  def start
+    @response['start']
+  end
+
+  def hits
+    @response['docs']
+  end
+
+  def max_score
+    @response['maxScore']
+  end
+  
+  # TODO: consider the use of json.nl parameter
+  def field_facets(field)
+    facets = []
+    values = @data['facet_counts']['facet_fields'][field]
+    Solr::Util.paired_array_each(values) do |key, value|
+      facets << FacetValue.new(key, value)
+    end
+    
+    facets
+  end
+  
+  def highlighted(id, field)
+    @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
+    @response['docs'].each {|hit| yield hit}
+  end
+
+end

data/lib/solr/response/xml.rb

@@ -0,0 +1,42 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rexml/document'
+require 'solr/exception'
+
+class Solr::Response::Xml < Solr::Response::Base
+  attr_reader :doc, :status_code, :status_message
+
+  def initialize(xml)
+    super
+    # parse the xml
+    @doc = REXML::Document.new(xml)
+
+    # look for the result code and string 
+    # <?xml version="1.0" encoding="UTF-8"?>
+    # <response>
+    # <lst name="responseHeader"><int name="status">0</int><int name="QTime">2</int></lst>
+    # </response>
+    result = REXML::XPath.first(@doc, './response/lst[@name="responseHeader"]/int[@name="status"]')
+    if result
+      @status_code =  result.text
+      @status_message = result.text  # TODO: any need for a message?
+    end
+  rescue REXML::ParseException => e
+    raise Solr::Exception.new("invalid response xml: #{e}")
+  end
+
+  def ok?
+    return @status_code == '0'
+  end
+
+end

data/lib/solr/response.rb

@@ -0,0 +1,27 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Solr; module Response; end; end
+require 'solr/response/base'
+require 'solr/response/xml'
+require 'solr/response/ruby'
+require 'solr/response/ping'
+require 'solr/response/add_document'
+require 'solr/response/modify_document'
+require 'solr/response/standard'
+require 'solr/response/spellcheck'
+require 'solr/response/dismax'
+require 'solr/response/commit'
+require 'solr/response/delete'
+require 'solr/response/index_info'
+require 'solr/response/optimize'
+require 'solr/response/select'

data/lib/solr/solrtasks.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# TODO: fill out Solr tasks: start, stop, ping, optimize, etc.
+
+require 'rake'
+require 'rake/tasklib'
+
+module Solr
+  namespace :solr do
+    desc "Start Solr"
+    task :start do
+      # TODO: actually start it up!
+      puts "Starting..."
+    end
+  end
+end

data/lib/solr/util.rb

@@ -0,0 +1,32 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Util
+  # paired_array_each([key1,value1,key2,value2]) yields twice:
+  #     |key1,value1|  and |key2,value2|
+  def self.paired_array_each(a, &block)
+    0.upto(a.size / 2 - 1) do |i|
+      n = i * 2
+      yield(a[n], a[n+1])
+    end
+  end
+
+  # paired_array_to_hash([key1,value1,key2,value2]) => {key1 => value1, key2, value2}
+  def self.paired_array_to_hash(a)
+    Hash[*a]
+  end
+  
+  def self.query_parser_escape(string)
+    # backslash prefix everything that isn't a word character
+    string.gsub(/(\W)/,'\\\\\1')
+  end
+end

data/lib/solr/xml.rb

@@ -0,0 +1,44 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Solr::XML
+end
+
+begin
+  
+  # If we can load rubygems and libxml-ruby...
+  require 'rubygems'
+  require 'xml/libxml'
+  raise "acts_as_solr requires libxml-ruby 0.7 or greater" unless XML::Node.public_instance_methods.include?("attributes")
+
+  # then make a few modifications to XML::Node so it can stand in for REXML::Element
+  class XML::Node
+    # element.add_element(another_element) should work
+    alias_method :add_element, :<<
+
+
+    # element.text = "blah" should work
+    def text=(x)
+      self << x.to_s
+    end
+  end
+  
+  # And use XML::Node for our XML generation
+  Solr::XML::Element = XML::Node
+  
+rescue LoadError => e # If we can't load either rubygems or libxml-ruby
+  puts "Requiring REXML"
+  # Just use REXML.
+  require 'rexml/document'
+  Solr::XML::Element = REXML::Element
+  
+end

data/lib/solr.rb

@@ -0,0 +1,21 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Solr; end
+require 'solr/exception'
+require 'solr/request'
+require 'solr/connection'
+require 'solr/response'
+require 'solr/util'
+require 'solr/xml'
+require 'solr/importer'
+require 'solr/indexer'

data/lib/solr_fixtures.rb

@@ -0,0 +1,13 @@
+module ActsAsSolr
+
+  class SolrFixtures
+    def self.load(table_names)
+      [table_names].flatten.map { |n| n.to_s }.each do |table_name|
+        klass = instance_eval(File.split(table_name.to_s).last.to_s.gsub('_',' ').split(" ").collect{|w| w.capitalize}.to_s.singularize)
+        klass.rebuild_solr_index if klass.respond_to?(:rebuild_solr_index)
+      end
+      ActsAsSolr::Post.execute(Solr::Request::Commit.new)
+    end
+  end
+  
+end

data/lib/tasks/database.rake

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../solr_fixtures'
+
+namespace :db do
+  namespace :fixtures do
+    desc "Load fixtures into the current environment's database. Load specific fixtures using FIXTURES=x,y"
+    task :load => :environment do
+      begin
+        ActsAsSolr::Post.execute(Solr::Request::Delete.new(:query => "*:*"))
+        ActsAsSolr::Post.execute(Solr::Request::Commit.new)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'test', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|    
+          ActsAsSolr::SolrFixtures.load(File.basename(fixture_file, '.*'))
+        end 
+        puts "The fixtures loaded have been added to Solr"       
+      rescue
+      end
+    end
+  end
+end

data/lib/tasks/solr.rake

@@ -0,0 +1,137 @@
+require 'rubygems'
+require 'rake'
+require 'net/http'
+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 '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
+  
+  # this task is by Henrik Nyh
+  # http://henrik.nyh.se/2007/06/rake-task-to-reindex-models-for-acts_as_solr
+  desc %{Reindexes data for all acts_as_solr models. Clears index first to get rid of orphaned records and optimizes index afterwards. RAILS_ENV=your_env to set environment. ONLY=book,person,magazine to only reindex those models; EXCEPT=book,magazine to exclude those models. START_SERVER=true to solr:start before and solr:stop after. BATCH=123 to post/commit in batches of that size: default is 300. CLEAR=false to not clear the index first; OPTIMIZE=false to not optimize the index afterwards.}
+  task :reindex => :environment do
+    require "#{File.dirname(__FILE__)}/../../config/solr_environment.rb"
+
+    includes = env_array_to_constants('ONLY')
+    if includes.empty?
+      includes = Dir.glob("#{RAILS_ROOT}/app/models/*.rb").map { |path| File.basename(path, ".rb").camelize.constantize }
+    end
+    excludes = env_array_to_constants('EXCEPT')
+    includes -= excludes
+    
+    optimize            = env_to_bool('OPTIMIZE',     true)
+    start_server        = env_to_bool('START_SERVER', false)
+    clear_first         = env_to_bool('CLEAR',       true)
+    batch_size          = ENV['BATCH'].to_i.nonzero? || 300
+    debug_output        = env_to_bool("DEBUG", false)
+
+    RAILS_DEFAULT_LOGGER.level = ActiveSupport::BufferedLogger::INFO unless debug_output
+
+    if start_server
+      puts "Starting Solr server..."
+      Rake::Task["solr:start"].invoke 
+    end
+    
+    # Disable solr_optimize
+    module ActsAsSolr::CommonMethods
+      def blank() end
+      alias_method :deferred_solr_optimize, :solr_optimize
+      alias_method :solr_optimize, :blank
+    end
+    
+    models = includes.select { |m| m.respond_to?(:rebuild_solr_index) }    
+    models.each do |model|
+  
+      if clear_first
+        puts "Clearing index for #{model}..."
+        ActsAsSolr::Post.execute(Solr::Request::Delete.new(:query => "#{model.solr_configuration[:type_field]}:#{model}")) 
+        ActsAsSolr::Post.execute(Solr::Request::Commit.new)
+      end
+      
+      puts "Rebuilding index for #{model}..."
+      model.rebuild_solr_index(batch_size)
+
+    end 
+
+    if models.empty?
+      puts "There were no models to reindex."
+    elsif optimize
+      puts "Optimizing..."
+      models.last.deferred_solr_optimize
+    end
+
+    if start_server
+      puts "Shutting down Solr server..."
+      Rake::Task["solr:stop"].invoke 
+    end
+    
+  end
+  
+  def env_array_to_constants(env)
+    env = ENV[env] || ''
+    env.split(/\s*,\s*/).map { |m| m.singularize.camelize.constantize }.uniq
+  end
+  
+  def env_to_bool(env, default)
+    env = ENV[env] || ''
+    case env
+      when /^true$/i then true
+      when /^false$/i then false
+      else default
+    end
+  end
+
+end
+

data/lib/tasks/test.rake

@@ -0,0 +1,7 @@
+require 'active_record'
+
+namespace :test do
+  task :migrate do
+    ActiveRecord::Migrator.migrate("test/db/migrate/", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+  end
+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