sunspot 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,9 @@
+== 1.0.2 2010-03-11
+* Restore Hit#distance for result geo distance
+* Remove :distance special sort
+* Quote reserved keywords in boolean queries
+* Add Search#facets accessor to retrieve all facets
+
 == 1.0.1 2010-03-05
 * Copy all needed config files when sunspot-installer run with force option
 

data/lib/sunspot/query/restriction.rb

@@ -40,6 +40,8 @@ module Sunspot
         include Filter
         include RSolr::Char
 
+        RESERVED_WORDS = Set['AND', 'OR', 'NOT']
+
         def initialize(field, value, negated = false)
           @field, @value, @negated = field, value, negated
         end
@@ -133,6 +135,11 @@ module Sunspot
         #
         def solr_value(value = @value)
           solr_value = escape(@field.to_indexed(value))
+          if RESERVED_WORDS.include?(solr_value)
+            %Q("#{solr_value}")
+          else
+            solr_value
+          end
         end
       end
 

data/lib/sunspot/query/sort.rb

@@ -90,16 +90,6 @@ module Sunspot
           "score #{direction_for_solr}"
         end
       end
-
-      # 
-      # A DistanceSort sorts by distance from the origin coordinates of a
-      # geographical distance search.
-      #
-      class DistanceSort < Abstract
-        def to_param
-          "geo_distance #{direction_for_solr}"
-        end
-      end
     end
   end
 end

data/lib/sunspot/search.rb

@@ -11,16 +11,18 @@ module Sunspot
   # Sunspot.new_search methods.
   #
   class Search
-    # Query information for this search. If you wish to build the query without
-    # using the search DSL, this method allows you to access the query API
-    # directly. See Sunspot#new_search for how to construct the search object
-    # in this case.
-    attr_reader :query 
+    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 = []
+      @facets_by_name = {}
     end
 
     #
@@ -78,7 +80,7 @@ module Sunspot
         @hits ||=
           maybe_will_paginate(
             solr_response['docs'].map do |doc|
-              Hit.new(doc, highlights_for(doc), self)
+              Hit.new(doc, highlights_for(doc), distance_for(doc), self)
             end
           )
       end
@@ -153,9 +155,9 @@ module Sunspot
     def facet(name, dynamic_name = nil)
       if name
         if dynamic_name
-          @facets[:"#{name}:#{dynamic_name}"]
+          @facets_by_name[:"#{name}:#{dynamic_name}"]
         else
-          @facets[name.to_sym]
+          @facets_by_name[name.to_sym]
         end
       end
     end
@@ -223,17 +225,17 @@ module Sunspot
     end
 
     def add_field_facet(field, options = {}) #:nodoc:
-      name = (options[:name] || field.name).to_sym
-      @facets[name] = FieldFacet.new(field, self, options)
+      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).to_sym
-      @facets[name] = DateFacet.new(field, self, options)
+      name = (options[:name] || field.name)
+      add_facet(name, DateFacet.new(field, self, options))
     end
 
     def add_query_facet(name, options) #:nodoc:
-      @facets[name] = QueryFacet.new(name, self, options)
+      add_facet(name, QueryFacet.new(name, self, options))
     end
 
     def facet_response #:nodoc:
@@ -256,6 +258,12 @@ module Sunspot
       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
@@ -274,5 +282,10 @@ module Sunspot
     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
   end
 end

data/lib/sunspot/search/hit.rb

@@ -30,10 +30,10 @@ module Sunspot
 
       attr_writer :result #:nodoc:
 
-      def initialize(raw_hit, highlights, search) #:nodoc:
+      def initialize(raw_hit, highlights, distance, search) #:nodoc:
         @class_name, @primary_key = *raw_hit['id'].match(/([^ ]+) (.+)/)[1..2]
         @score = raw_hit['score']
-        @distance = raw_hit['geo_distance'].to_f if raw_hit['geo_distance']
+        @distance = distance
         @search = search
         @stored_values = raw_hit
         @stored_cache = {}

data/lib/sunspot/server.rb

@@ -2,8 +2,8 @@ require 'escape'
 require 'set'
 require 'tempfile'
 
-module Sunspot #:nodoc:
-  class Server
+module Sunspot
+  class Server #:nodoc:
     # Raised if #stop is called but the server is not running
     ServerError = Class.new(RuntimeError)
     AlreadyRunningError = Class.new(ServerError)

data/lib/sunspot/util.rb

@@ -187,8 +187,8 @@ module Sunspot
       end
 
       def lat
-        if @coords.respond_to?(:[])
-          @coords[0]
+        if @coords.respond_to?(:first)
+          @coords.first
         elsif @coords.respond_to?(:lat)
           @coords.lat
         else
@@ -197,8 +197,8 @@ module Sunspot
       end
 
       def lng
-        if @coords.respond_to?(:[])
-          @coords[1]
+        if @coords.respond_to?(:last)
+          @coords.last
         elsif @coords.respond_to?(:lng)
           @coords.lng
         elsif @coords.respond_to?(:lon)

data/lib/sunspot/version.rb

@@ -1,3 +1,3 @@
 module Sunspot
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/api/query/ordering_pagination_spec.rb

@@ -71,6 +71,14 @@ describe 'ordering and pagination' do
     end.should raise_error(ArgumentError)
   end
 
+  it 'throws an UnrecognizedFieldError if :distance is given for sort' do
+    lambda do
+      session.search Post do
+        order_by :distance, :asc
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
   it 'does not allow ordering by multiple-value fields' do
     lambda do
       session.search Post do

data/spec/api/query/scope_spec.rb

@@ -15,6 +15,13 @@ describe 'scoped query', :type => :query do
     connection.should have_last_search_including(:fq, 'title_ss:My\ Pet\ Post')
   end
 
+  it 'scopes by exact match with a special string' do
+    session.search Post do
+      with :title, 'OR'
+    end
+    connection.should have_last_search_including(:fq, 'title_ss:"OR"')
+  end
+
   it 'scopes by exact match with time' do
     time = Time.parse('1983-07-08 05:00:00 -0400')
     session.search Post do

data/spec/api/search/faceting_spec.rb

@@ -17,6 +17,17 @@ describe 'faceting', :type => :search do
     result.facet('title').field_name.should == :title
   end
 
+  it 'returns all facets specified by search' do
+    stub_facet(:title_ss, { 'Author 1' => 1 })
+    stub_facet(:blog_id_i, { '1' => 3 })
+    result = session.search(Post) do
+      facet :title
+      facet :blog_id
+    end
+    result.facets.first.field_name.should == :title
+    result.facets.last.field_name.should == :blog_id
+  end
+
   it 'returns string facet' do
     stub_facet(:title_ss, 'Author 1' => 2, 'Author 2' => 1)
     result = session.search Post do

data/spec/api/search/hits_spec.rb

@@ -123,7 +123,11 @@ describe 'hits', :type => :search do
   end
 
   it 'should return geo distance' do
-    stub_full_results('instance' => Post.new, 'geo_distance' => '1.23')
+    post = Post.new
+    stub_results(post)
+    connection.response['distances'] = {
+      "Post #{post.id}" => 1.23
+    }
     session.search(Post).hits.first.distance.should == 1.23
   end
 

data/spec/integration/local_search_spec.rb

@@ -47,6 +47,14 @@ describe 'local search' do
     end
     search.results.should == [@posts[1]]
   end
+
+  it 'should perform a radial search with attribute scoping and distance sorting' do
+    search = Sunspot.search(Post) do |query|
+      query.near(ORIGIN, :sort => true)
+      query.with(:title, 'teacup')
+    end
+    search.results.should == [@posts[1], @posts[4]]
+  end
   
   it 'should order by arbitrary field' do
     search = Sunspot.search(Post) do |query|
@@ -71,4 +79,13 @@ describe 'local search' do
       end
     end.should_not raise_error
   end
+
+  it 'should return geographical distance from origin' do
+    search = Sunspot.search(Post) do |query|
+      query.near(ORIGIN, :sort => true)
+    end
+    search.hits.each do |hit|
+      hit.distance.should_not be_nil
+    end
+  end
 end

data/spec/integration/scoped_search_spec.rb

@@ -119,6 +119,15 @@ describe 'scoped_search' do
     end
   end
 
+  describe 'reserved words' do
+    %w(AND OR NOT TO).each do |word|
+      it "should successfully search for #{word.inspect}" do
+        Sunspot.index!(post = Post.new(:title => word))
+        Sunspot.search(Post) { with(:title, word) }.results.should == [post]
+      end
+    end
+  end
+
   describe 'passing nil value to equal' do
     before :all do
       Sunspot.remove_all

data/spec/mocks/connection.rb

@@ -23,7 +23,7 @@ module Mock
 
   class Connection
     attr_reader :adds, :commits, :searches, :message, :opts, :deletes_by_query
-    attr_writer :response
+    attr_accessor :response
 
     def initialize(opts = {})
       @opts = opts

data/tasks/rdoc.rake

@@ -20,7 +20,7 @@ namespace :doc do
   desc 'Generate rdoc and move into pages directory'
   task :publish => :redoc do
     doc_dir = File.join(File.dirname(__FILE__), '..', 'doc')
-    publish_dir = File.join(File.dirname(__FILE__), '..', 'pages', 'docs')
+    publish_dir = File.join(File.dirname(__FILE__), '..', '..', 'pages', 'docs')
     FileUtils.rm_rf(publish_dir) if File.exist?(publish_dir)
     FileUtils.cp_r(doc_dir, publish_dir)
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Mat Brown
@@ -24,7 +24,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-05 00:00:00 -05:00
+date: 2010-03-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -246,8 +246,8 @@ files:
 - solr/solr/conf/scripts.conf
 - solr/solr/conf/schema.xml
 - solr/solr/conf/stopwords.txt
+- solr/solr/lib/solr-spatial-light-0.0.4.jar
 - solr/solr/lib/lucene-spatial-2.9.1.jar
-- solr/solr/lib/solr-spatial-light-0.0.3.jar
 - solr/start.jar
 has_rdoc: true
 homepage: http://outoftime.github.com/sunspot