sunspot 1.0.5 → 1.1.0

data/lib/sunspot/search/facet_row.rb

@@ -1,5 +1,5 @@
 module Sunspot
-  class Search
+  module Search
     class FacetRow
       attr_reader :value, :count
       attr_writer :instance #:nodoc:

data/lib/sunspot/search/field_facet.rb

@@ -1,5 +1,5 @@
 module Sunspot
-  class Search
+  module Search
     # 
     # A FieldFacet is a facet whose rows are all values for a certain field, in
     # contrast to a QueryFacet, whose rows represent arbitrary queries.

data/lib/sunspot/search/highlight.rb

@@ -1,5 +1,5 @@
 module Sunspot
-  class Search
+  module Search
     # 
     # A Highlight represents a single highlighted fragment of text from a
     # document. Depending on the highlighting parameters used for search, there

data/lib/sunspot/search/hit.rb

@@ -1,5 +1,5 @@
 module Sunspot
-  class Search
+  module Search
     # 
     # Hit objects represent the raw information returned by Solr for a single
     # document. As well as the primary key and class name, hit objects give

data/lib/sunspot/search/more_like_this_search.rb

@@ -0,0 +1,31 @@
+module Sunspot
+  # 
+  # This class encapsulates the results of a Solr MoreLikeThis search. It provides access
+  # to search results, total result count, and pagination information.
+  # Instances of MoreLikeThis are returned by the Sunspot.more_like_this and
+  # Sunspot.new_more_like_this methods.
+  #
+  module Search
+    class MoreLikeThisSearch < AbstractSearch
+      def execute
+        if @query.more_like_this.fields.empty?
+          @setup.all_more_like_this_fields.each do |field|
+            @query.more_like_this.add_field(field)
+          end
+        end
+        super
+      end
+
+      def request_handler
+        super || :mlt
+      end
+
+      private
+
+      # override
+      def dsl
+        DSL::MoreLikeThisQuery.new(self, @query, @setup)
+      end
+    end
+  end
+end

data/lib/sunspot/search/query_facet.rb

@@ -1,5 +1,5 @@
 module Sunspot
-  class Search
+  module Search
     class QueryFacet
       RequestedFacet = Struct.new(:label, :boolean_phrase) #:nodoc:
 

data/lib/sunspot/search/standard_search.rb

@@ -0,0 +1,21 @@
+module Sunspot
+  module Search
+    # 
+    # This class encapsulates the results of a Solr search. It provides access
+    # to search results, total result count, facets, and pagination information.
+    # Instances of Search are returned by the Sunspot.search and
+    # Sunspot.new_search methods.
+    #
+    class StandardSearch < AbstractSearch
+      def request_handler
+        super || :select
+      end
+  
+      private
+  
+      def dsl
+        DSL::Search.new(self, @setup)
+      end
+    end
+  end
+end

data/lib/sunspot/search.rb

@@ -1,294 +1,9 @@
-%w(query_facet field_facet date_facet facet_row hit
-   highlight).each do |file|
+%w(abstract_search standard_search more_like_this_search query_facet field_facet
+   date_facet facet_row hit highlight).each do |file|
   require File.join(File.dirname(__FILE__), 'search', file)
 end
 
 module Sunspot
-  # 
-  # This class encapsulates the results of a Solr search. It provides access
-  # to search results, total result count, facets, and pagination information.
-  # Instances of Search are returned by the Sunspot.search and
-  # Sunspot.new_search methods.
-  #
-  class Search
-    attr_reader :query #:nodoc:
-    # 
-    # Retrieve all facet objects defined for this search, in order they were
-    # defined. To retrieve an individual facet by name, use #facet()
-    #
-    attr_reader :facets
-
-    def initialize(connection, setup, query, configuration) #:nodoc:
-      @connection, @setup, @query = connection, setup, query
-      @query.paginate(1, configuration.pagination.default_per_page)
-      @facets = []
-      @facets_by_name = {}
-    end
-
-    #
-    # Execute the search on the Solr instance and store the results. If you
-    # use Sunspot#search() to construct your searches, there is no need to call
-    # this method as it has already been called. If you use
-    # Sunspot#new_search(), you will need to call this method after building the
-    # query.
-    #
-    def execute
-      reset
-      params = @query.to_params
-      @solr_result = @connection.select(params)
-      self
-    end
-    alias_method :execute!, :execute #:nodoc: deprecated
-
-    # 
-    # Get the collection of results as instantiated objects. If WillPaginate is
-    # available, the results will be a WillPaginate::Collection instance; if
-    # not, it will be a vanilla Array.
-    #
-    # If not all of the results referenced by the Solr hits actually exist in
-    # the data store, Sunspot will only return the results that do exist.
-    #
-    # ==== Returns
-    #
-    # WillPaginate::Collection or Array:: Instantiated result objects
-    #
-    def results
-      @results ||= maybe_will_paginate(verified_hits.map { |hit| hit.instance })
-    end
-
-    # 
-    # Access raw Solr result information. Returns a collection of Hit objects
-    # that contain the class name, primary key, keyword relevance score (if
-    # applicable), and any stored fields.
-    #
-    # ==== Options (options)
-    #
-    # :verify::
-    #   Only return hits that reference objects that actually exist in the data
-    #   store. This causes results to be eager-loaded from the data store,
-    #   unlike the normal behavior of this method, which only loads the
-    #   referenced results when Hit#result is first called.
-    #
-    # ==== Returns
-    #
-    # Array:: Ordered collection of Hit objects
-    #
-    def hits(options = {})
-      if options[:verify]
-        verified_hits
-      else
-        @hits ||=
-          maybe_will_paginate(
-            solr_response['docs'].map do |doc|
-              Hit.new(doc, highlights_for(doc), distance_for(doc), self)
-            end
-          )
-      end
-    end
-    alias_method :raw_results, :hits
-
-    #
-    # Convenience method to iterate over hit and result objects. Block is
-    # yielded a Sunspot::Server::Hit instance and a Sunspot::Server::Result
-    # instance.
-    #
-    # Note that this method iterates over verified hits (see #hits method
-    # for more information).
-    #
-    def each_hit_with_result
-      verified_hits.each do |hit|
-        yield(hit, hit.result)
-      end
-    end
-
-    # 
-    # The total number of documents matching the query parameters
-    #
-    # ==== Returns
-    #
-    # Integer:: Total matching documents
-    #
-    def total
-      @total ||= solr_response['numFound']
-    end
-
-    # 
-    # Get the facet object for the given name. `name` can either be the name
-    # given to a query facet, or the field name of a field facet. Returns a
-    # Sunspot::Facet object.
-    #
-    # ==== Parameters
-    #
-    # name<Symbol>::
-    #   Name of the field to return the facet for, or the name given to the
-    #   query facet when the search was constructed.
-    # dynamic_name<Symbol>::
-    #   If faceting on a dynamic field, this is the dynamic portion of the field
-    #   name.
-    #
-    # ==== Example:
-    #
-    #   search = Sunspot.search(Post) do
-    #     facet :category_ids
-    #     dynamic :custom do
-    #       facet :cuisine
-    #     end
-    #     facet :age do
-    #       row 'Less than a month' do
-    #         with(:published_at).greater_than(1.month.ago)
-    #       end
-    #       row 'Less than a year' do
-    #         with(:published_at, 1.year.ago..1.month.ago)
-    #       end
-    #       row 'More than a year' do
-    #         with(:published_at).less_than(1.year.ago)
-    #       end
-    #     end
-    #   end
-    #   search.facet(:category_ids)
-    #     #=> Facet for :category_ids field
-    #   search.facet(:custom, :cuisine)
-    #     #=> Facet for the dynamic field :cuisine in the :custom field definition
-    #   search.facet(:age)
-    #     #=> Facet for the query facet named :age
-    #
-    def facet(name, dynamic_name = nil)
-      if name
-        if dynamic_name
-          @facets_by_name[:"#{name}:#{dynamic_name}"]
-        else
-          @facets_by_name[name.to_sym]
-        end
-      end
-    end
-
-    # 
-    # Deprecated in favor of optional second argument to #facet
-    #
-    def dynamic_facet(base_name, dynamic_name) #:nodoc:
-      facet(base_name, dynamic_name)
-    end
-
-    # 
-    # Get the data accessor that will be used to load a particular class out of
-    # persistent storage. Data accessors can implement any methods that may be
-    # useful for refining how data is loaded out of storage. When building a
-    # search manually (e.g., using the Sunspot#new_search method), this should
-    # be used before calling #execute(). Use the
-    # Sunspot::DSL::Search#data_accessor_for method when building searches using
-    # the block DSL.
-    #
-    def data_accessor_for(clazz) #:nodoc:
-      (@data_accessors ||= {})[clazz.name.to_sym] ||=
-        Adapters::DataAccessor.create(clazz)
-    end
-
-    # 
-    # Build this search using a DSL block. This method can be called more than
-    # once on an unexecuted search (e.g., Sunspot.new_search) in order to build
-    # a search incrementally.
-    #
-    # === Example
-    #
-    #   search = Sunspot.new_search(Post)
-    #   search.build do
-    #     with(:published_at).less_than Time.now
-    #   end
-    #   search.execute!
-    #
-    def build(&block)
-      Util.instance_eval_or_call(dsl, &block)
-      self
-    end
-
-    # 
-    # Populate the Hit objects with their instances. This is invoked the first
-    # time any hit has its instance requested, and all hits are loaded as a
-    # batch.
-    #
-    def populate_hits #:nodoc:
-      id_hit_hash = Hash.new { |h, k| h[k] = {} }
-      hits.each do |hit|
-        id_hit_hash[hit.class_name][hit.primary_key] = hit
-      end
-      id_hit_hash.each_pair do |class_name, hits|
-        ids = hits.map { |id, hit| hit.primary_key }
-        data_accessor = data_accessor_for(Util.full_const_get(class_name))
-        hits_for_class = id_hit_hash[class_name]
-        data_accessor.load_all(ids).each do |result|
-          hit = hits_for_class.delete(Adapters::InstanceAdapter.adapt(result).id.to_s)
-          hit.result = result
-        end
-        hits_for_class.values.each { |hit| hit.result = nil }
-      end
-    end
-
-    def inspect #:nodoc:
-      "<Sunspot::Search:#{query.to_params.inspect}>"
-    end
-
-    def add_field_facet(field, options = {}) #:nodoc:
-      name = (options[:name] || field.name)
-      add_facet(name, FieldFacet.new(field, self, options))
-    end
-
-    def add_date_facet(field, options) #:nodoc:
-      name = (options[:name] || field.name)
-      add_facet(name, DateFacet.new(field, self, options))
-    end
-
-    def add_query_facet(name, options) #:nodoc:
-      add_facet(name, QueryFacet.new(name, self, options))
-    end
-
-    def facet_response #:nodoc:
-      @solr_result['facet_counts']
-    end
-
-    private
-
-    def solr_response
-      @solr_response ||= @solr_result['response']
-    end
-
-    def dsl
-      DSL::Search.new(self, @setup)
-    end
-
-    def highlights_for(doc)
-      if @solr_result['highlighting']
-        @solr_result['highlighting'][doc['id']]
-      end
-    end
-
-    def distance_for(doc)
-      if @solr_result['distances']
-        @solr_result['distances'][doc['id']]
-      end
-    end
-
-    def verified_hits
-      @verified_hits ||= maybe_will_paginate(hits.select { |hit| hit.instance })
-    end
-
-    def maybe_will_paginate(collection)
-      if defined?(WillPaginate::Collection)
-        WillPaginate::Collection.create(@query.page, @query.per_page, total) do |pager|
-          pager.replace(collection)
-        end
-      else
-        collection
-      end
-    end
-    
-    # Clear out all the cached ivars so the search can be called again.
-    def reset
-      @results = @hits = @verified_hits = @total = @solr_response = @doc_ids = nil
-    end
-
-    def add_facet(name, facet)
-      @facets << facet
-      @facets_by_name[name.to_sym] = facet
-    end
+  module Search
   end
 end

data/lib/sunspot/server.rb

@@ -17,7 +17,7 @@ module Sunspot
     LOG_LEVELS = Set['SEVERE', 'WARNING', 'INFO', 'CONFIG', 'FINE', 'FINER', 'FINEST']
 
     attr_accessor :min_memory, :max_memory, :port, :solr_data_dir, :solr_home, :log_file
-    attr_writer :pid_dir, :pid_file, :log_level, :solr_data_dir, :solr_home
+    attr_writer :pid_dir, :pid_file, :log_level, :solr_data_dir, :solr_home, :solr_jar
 
     #
     # Start the sunspot-solr server. Bootstrap solr_home first,
@@ -69,8 +69,8 @@ module Sunspot
       command << "-Dsolr.data.dir=#{solr_data_dir}" if solr_data_dir
       command << "-Dsolr.solr.home=#{solr_home}" if solr_home
       command << "-Djava.util.logging.config.file=#{logging_config_path}" if logging_config_path
-      command << '-jar' << File.basename(SOLR_START_JAR)
-      FileUtils.cd(File.dirname(SOLR_START_JAR)) do
+      command << '-jar' << File.basename(solr_jar)
+      FileUtils.cd(File.dirname(solr_jar)) do
         exec(Escape.shell_command(command))
       end
     end
@@ -125,7 +125,11 @@ module Sunspot
     end
 
     def solr_home
-      File.expand_path(@solr_home || File.join(File.dirname(SOLR_START_JAR), 'solr'))
+      File.expand_path(@solr_home || File.join(File.dirname(solr_jar), 'solr'))
+    end
+
+    def solr_jar
+      @solr_jar || SOLR_START_JAR
     end
 
     private

data/lib/sunspot/session.rb

@@ -41,7 +41,12 @@ module Sunspot
     #
     def new_search(*types, &block)
       types.flatten!
-      search = Search.new(connection, setup_for_types(types), Query::Query.new(types), @config)
+      search = Search::StandardSearch.new(
+        connection,
+        setup_for_types(types),
+        Query::StandardQuery.new(types),
+        @config
+      )
       search.build(&block) if block
       search
     end
@@ -51,7 +56,30 @@ module Sunspot
     #
     def search(*types, &block)
       search = new_search(*types, &block)
-      search.execute!
+      search.execute
+    end
+
+    # 
+    # See Sunspot.new_more_like_this
+    #
+    def new_more_like_this(object, *types, &block)
+      types[0] ||= object.class
+      mlt = Search::MoreLikeThisSearch.new(
+        connection,
+        setup_for_types(types),
+        Query::MoreLikeThisQuery.new(object, types),
+        @config
+      )
+      mlt.build(&block) if block
+      mlt
+    end
+
+    #
+    # See Sunspot.more_like_this
+    #
+    def more_like_this(object, *types, &block)
+      mlt = new_more_like_this(object, *types, &block)
+      mlt.execute
     end
 
     #

data/lib/sunspot/session_proxy/master_slave_session_proxy.rb

@@ -21,7 +21,7 @@ module Sunspot
                :config, :delete_dirty?, :dirty?, :index, :index!, :remove,
                :remove!, :remove_all, :remove_all!, :remove_by_id,
                :remove_by_id!, :to => :master_session
-      delegate :new_search, :search, :to => :slave_session
+      delegate :new_search, :search, :new_more_like_this, :more_like_this, :to => :slave_session
 
       def initialize(master_session, slave_session)
         @master_session, @slave_session = master_session, slave_session

data/lib/sunspot/session_proxy/sharding_session_proxy.rb

@@ -167,6 +167,15 @@ module Sunspot
         new_search(*types).execute
       end
 
+      def more_like_this(object, &block)
+        #FIXME should use shards
+        new_more_like_this(object, &block).execute
+      end
+
+      def new_more_like_this(object, &block)
+        @search_session.new_more_like_this(object, &block)
+      end
+
       # 
       # True if any shard session is dirty. Note that directly using the
       # #commit_if_dirty method is more efficient if that's what you're

data/lib/sunspot/session_proxy/thread_local_session_proxy.rb

@@ -1,3 +1,4 @@
+require 'monitor'
 require File.join(File.dirname(__FILE__), 'abstract_session_proxy')
 
 module Sunspot
@@ -8,10 +9,15 @@ module Sunspot
     # proxy.
     #
     class ThreadLocalSessionProxy < AbstractSessionProxy
+      FINALIZER = Proc.new do |object_id|
+        Thread.current[:"sunspot_session_#{object_id}"] = nil
+      end
+
       # The configuration with which the thread-local sessions are initialized.
       attr_reader :config
+      @@next_id = 0
 
-      delegate :batch, :commit, :commit_if_delete_dirty, :commit_if_dirty, :delete_dirty?, :dirty?, :index, :index!, :new_search, :remove, :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!, :search, :to => :session
+      delegate :batch, :commit, :commit_if_delete_dirty, :commit_if_dirty, :delete_dirty?, :dirty?, :index, :index!, :new_search, :remove, :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!, :search, :more_like_this, :new_more_like_this, :to => :session
 
       # 
       # Optionally pass an existing Sunspot::Configuration object. If none is
@@ -20,10 +26,11 @@ module Sunspot
       #
       def initialize(config = Sunspot::Configuration.new)
         @config = config
+        ObjectSpace.define_finalizer(self, FINALIZER)
       end
 
       def session #:nodoc:
-        Thread.current[:sunspot_session] ||= Session.new(config)
+        Thread.current[:"sunspot_session_#{object_id}"] ||= Session.new(config)
       end
     end
   end

data/lib/sunspot/setup.rb

@@ -12,6 +12,7 @@ module Sunspot
         @field_factories_cache, @text_field_factories_cache,
         @dynamic_field_factories_cache = *Array.new(6) { Hash.new }
       @stored_field_factories_cache = Hash.new { |h, k| h[k] = [] }
+      @more_like_this_field_factories_cache = Hash.new { |h, k| h[k] = [] }
       @dsl = DSL::Fields.new(self)
       add_field_factory(:class, Type::ClassType.instance)
     end
@@ -24,13 +25,16 @@ module Sunspot
     # Add field factory for scope/ordering
     #
     def add_field_factory(name, type, options = {}, &block)
-      stored = options[:stored]
+      stored, more_like_this = options[:stored], options[:more_like_this]
       field_factory = FieldFactory::Static.new(name, type, options, &block)
       @field_factories[field_factory.signature] = field_factory
       @field_factories_cache[field_factory.name] = field_factory
       if stored
         @stored_field_factories_cache[field_factory.name] << field_factory
       end
+      if more_like_this
+        @more_like_this_field_factories_cache[field_factory.name] << field_factory
+      end
     end
 
     # 
@@ -41,13 +45,16 @@ module Sunspot
     # field_factories<Array>:: Array of Sunspot::Field objects
     #
     def add_text_field_factory(name, options = {}, &block)
-      stored = options[:stored]
+      stored, more_like_this = options[:stored], options[:more_like_this]
       field_factory = FieldFactory::Static.new(name, Type::TextType.instance, options, &block)
       @text_field_factories[name] = field_factory
       @text_field_factories_cache[field_factory.name] = field_factory
       if stored
         @stored_field_factories_cache[field_factory.name] << field_factory
       end
+      if more_like_this
+        @more_like_this_field_factories_cache[field_factory.name] << field_factory
+      end
     end
 
     #
@@ -58,13 +65,16 @@ module Sunspot
     # field_factories<Array>:: Array of dynamic field objects
     # 
     def add_dynamic_field_factory(name, type, options = {}, &block)
-      stored = options[:stored]
+      stored, more_like_this = options[:stored], options[:more_like_this]
       field_factory = FieldFactory::Dynamic.new(name, type, options, &block)
       @dynamic_field_factories[field_factory.signature] = field_factory
       @dynamic_field_factories_cache[field_factory.name] = field_factory
       if stored
         @stored_field_factories_cache[field_factory.name] << field_factory
       end
+      if more_like_this
+        @more_like_this_field_factories_cache[field_factory.name] << field_factory
+      end
     end
 
     # 
@@ -147,6 +157,16 @@ module Sunspot
       end
     end
 
+    #
+    # Return one or more more_like_this fields (can be either attribute or text fields)
+    # for the given name.
+    #
+    def more_like_this_fields(field_name)
+      @more_like_this_field_factories_cache[field_name.to_sym].map do |field_factory|
+        field_factory.build
+      end
+    end
+
     # 
     # Return the DynamicFieldFactory with the given base name
     #
@@ -171,6 +191,15 @@ module Sunspot
       text_field_factories.map { |text_field_factory| text_field_factory.build }
     end
 
+    # 
+    # Return all more_like_this fields
+    #
+    def all_more_like_this_fields
+      @more_like_this_field_factories_cache.values.map do |field_factories| 
+        field_factories.map { |field_factory| field_factory.build }
+      end.flatten
+    end
+
     # 
     # Get the field_factories associated with this setup as well as all inherited field_factories
     #