sunspot 2.2.0 → 2.2.1

data/lib/sunspot/search/query_group.rb

@@ -0,0 +1,74 @@
+require 'sunspot/search/paginated_collection'
+
+module Sunspot
+  module Search
+    class QueryGroup
+      def initialize(queries, search) #:nodoc:
+        @queries, @search = queries, search
+      end
+
+      def groups
+        @groups ||=
+          if solr_response_for_first
+            groups = @queries.map { |query| Group.new(query.label, doclist_for(query), @search) }
+
+            paginate_collection(groups)
+          end
+      end
+
+      def matches
+        if solr_response_for_first
+          solr_response_for_first['matches'].to_i
+        end
+      end
+
+      def total
+        @queries.count
+      end
+
+      #
+      # It populates all grouped hits at once.
+      # Useful for eager loading fall grouped results at once.
+      #
+      def populate_all_hits
+        # Init a 2 dimension Hash that contains an array per key
+        id_hit_hash = Hash.new { |hash, key| hash[key] = Hash.new{ |h, k| h[k] = [] } }
+        groups.each do |g|
+          # Take all hits to being populated later on
+          g.hits.each do |hit|
+            id_hit_hash[hit.class_name][hit.primary_key] |= [hit]
+          end
+        end
+        # Go for each class and load the results' objects into each of the hits
+        id_hit_hash.each_pair do |class_name, many_hits|
+          ids = many_hits.keys
+          data_accessor = @search.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|
+            hits = hits_for_class.delete(Adapters::InstanceAdapter.adapt(result).id.to_s)
+            hits.each{ |hit| hit.result = result }
+          end
+          hits_for_class.values.each { |hits| hits.each{|hit| hit.result = nil } }
+        end
+      end
+
+      private
+
+      def doclist_for(query)
+        solr_response_for(query.to_boolean_phrase)['doclist']
+      end
+
+      def solr_response_for(query_string)
+        @search.group_response[query_string]
+      end
+
+      def solr_response_for_first
+        solr_response_for(@queries[0].to_boolean_phrase)
+      end
+
+      def paginate_collection(collection)
+        PaginatedCollection.new(collection, @search.query.page, @search.query.per_page, total)
+      end
+    end
+  end
+end

data/lib/sunspot/search/standard_search.rb

@@ -70,7 +70,7 @@ module Sunspot
           # If no query was given, or all terms are present in the index,
           # return Solr's suggested collation.
           if terms.length == 0
-            collation = solr_spellcheck['suggestions'][-1]
+            collation = solr_spellcheck['collations'][-1]
           end
 
           collation

data/lib/sunspot/search.rb

@@ -1,6 +1,6 @@
 %w(abstract_search standard_search more_like_this_search query_facet field_facet
    date_facet range_facet facet_row hit highlight field_group group hit_enumerable
-   stats_row field_stats stats_facet).each do |file|
+   stats_row field_stats stats_facet query_group).each do |file|
   require File.join(File.dirname(__FILE__), 'search', file)
 end
 

data/lib/sunspot/session.rb

@@ -99,6 +99,22 @@ module Sunspot
       commit
     end
 
+    #
+    # See Sunspot.atomic_update
+    #
+    def atomic_update(clazz, updates = {})
+      @adds += updates.keys.length
+      indexer.add_atomic_update(clazz, updates)
+    end
+
+    #
+    # See Sunspot.atomic_update!
+    #
+    def atomic_update!(clazz, updates = {})
+      atomic_update(clazz, updates)
+      commit
+    end
+
     #
     # See Sunspot.commit
     #

data/lib/sunspot/session_proxy/master_slave_session_proxy.rb

@@ -19,8 +19,8 @@ module Sunspot
 
       delegate :batch, :commit, :commit_if_delete_dirty, :commit_if_dirty,
                :config, :delete_dirty?, :dirty?, :index, :index!, :optimize, :remove,
-               :remove!, :remove_all, :remove_all!, :remove_by_id,
-               :remove_by_id!, :to => :master_session
+               :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!,
+               :atomic_update, :atomic_update!, :to => :master_session
       delegate :new_search, :search, :new_more_like_this, :more_like_this, :to => :slave_session
 
       def initialize(master_session, slave_session)

data/lib/sunspot/session_proxy/retry_5xx_session_proxy.rb

@@ -59,7 +59,7 @@ module Sunspot
 
       delegate :batch, :commit, :commit_if_dirty, :commit_if_delete_dirty,
         :dirty?, :index!, :index, :optimize, :remove!, :remove, :remove_all!,
-        :remove_all, :remove_by_id!, :remove_by_id,
+        :remove_all, :remove_by_id!, :remove_by_id, :atomic_update, :atomic_update!,
         :to => :retry_handler
 
     end

data/lib/sunspot/session_proxy/sharding_session_proxy.rb

@@ -27,9 +27,11 @@ module Sunspot
     # * remove_by_id!
     # * remove_all with an argument
     # * remove_all! with an argument
+    # * atomic_update with arguments
+    # * atomic_update! with arguments
     #
     class ShardingSessionProxy < AbstractSessionProxy
-      not_supported :batch, :config, :remove_by_id, :remove_by_id!
+      not_supported :batch, :config, :remove_by_id, :remove_by_id!, :atomic_update, :atomic_update!
 
       # 
       # +search_session+ is the session that should be used for searching.
@@ -70,7 +72,7 @@ module Sunspot
         using_sharded_session(objects) { |session, group| session.index!(group) }
       end
 
-      # 
+      #
       # See Sunspot.remove
       #
       def remove(*objects)

data/lib/sunspot/session_proxy/silent_fail_session_proxy.rb

@@ -22,7 +22,7 @@ module Sunspot
       SUPPORTED_METHODS = [
         :batch, :commit, :commit_if_dirty, :commit_if_delete_dirty, :dirty?,
         :index!, :index, :optimize, :remove!, :remove, :remove_all!, :remove_all,
-        :remove_by_id!, :remove_by_id
+        :remove_by_id!, :remove_by_id, :atomic_update, :atomic_update!
       ]
 
       SUPPORTED_METHODS.each do |method|

data/lib/sunspot/session_proxy/thread_local_session_proxy.rb

@@ -17,7 +17,9 @@ module Sunspot
       attr_reader :config
       @@next_id = 0
 
-      delegate :batch, :commit, :commit_if_delete_dirty, :commit_if_dirty, :delete_dirty?, :dirty?, :index, :index!, :new_search, :optimize, :remove, :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!, :search, :more_like_this, :new_more_like_this, :to => :session
+      delegate :batch, :commit, :commit_if_delete_dirty, :commit_if_dirty, :delete_dirty?, :dirty?, :index, :index!,
+               :new_search, :optimize, :remove, :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!,
+               :search, :more_like_this, :new_more_like_this, :atomic_update, :atomic_update!, :to => :session
 
       # 
       # Optionally pass an existing Sunspot::Configuration object. If none is

data/lib/sunspot/type.rb

@@ -375,6 +375,26 @@ module Sunspot
       end
     end
 
+    class DateRangeType < DateType
+      def indexed_name(name)
+        "#{name}_dr"
+      end
+
+      def to_indexed(value)
+        if value.respond_to?(:first) && value.respond_to?(:last)
+          "[#{super value.first} TO #{super value.last}]"
+        else
+          super value
+        end
+      end
+
+      def cast(value)
+        return super unless m = value.match(/^\[(?<start>.+) TO (?<end>.+)\]$/)
+        Range.new super(m[:start]), super(m[:end])
+      end
+    end
+    register DateRangeType, Range
+
     class ClassType < AbstractType
       def indexed_name(name) #:nodoc:
         'class_name'

data/lib/sunspot/version.rb

@@ -1,3 +1,3 @@
 module Sunspot
-  VERSION = '2.2.0'
+  VERSION = '2.2.1'
 end

data/lib/sunspot.rb

@@ -196,6 +196,40 @@ module Sunspot
       session.index!(*objects)
     end
 
+    # Atomic update object properties on the singleton session.
+    #
+    # ==== Parameters
+    #
+    # clazz<Class>:: the class of the objects to be updated
+    # updates<Hash>:: hash of updates where keys are model ids
+    #                 and values are hash with property name/values to be updated
+    #
+    # ==== Example
+    #
+    #   post1, post2 = new Array(2) { Post.create }
+    #   Sunspot.atomic_update(Post, post1.id => {title: 'New Title'}, post2.id => {description: 'new description'})
+    #
+    # Note that indexed objects won't be reflected in search until a commit is
+    # sent - see Sunspot.index! and Sunspot.commit
+    #
+    def atomic_update(clazz, updates = {})
+      session.atomic_update(clazz, updates)
+    end
+
+    # Atomic update object properties on the singleton session.
+    #
+    # See: Sunspot.atomic_update and Sunspot.commit
+    #
+    # ==== Parameters
+    #
+    # clazz<Class>:: the class of the objects to be updated
+    # updates<Hash>:: hash of updates where keys are model ids
+    #                 and values are hash with property name/values to be updated
+    #
+    def atomic_update!(clazz, updates = {})
+      session.atomic_update!(clazz, updates)
+    end
+
     # Commits (soft or hard) the singleton session
     #
     # When documents are added to or removed from Solr, the changes are
@@ -490,9 +524,9 @@ module Sunspot
     #
     #   Sunspot.batch do
     #     post = Post.new
-    #     Sunspot.add(post)
+    #     Sunspot.index(post)
     #     comment = Comment.new
-    #     Sunspot.add(comment)
+    #     Sunspot.index(comment)
     #   end
     #
     # Sunspot will send both the post and the comment in a single request.

data/spec/api/indexer/attributes_spec.rb

@@ -71,6 +71,11 @@ describe 'indexing attribute fields', :type => :indexer do
     connection.should have_add_with(:expire_date_d => '2009-07-13T00:00:00Z')
   end
 
+  it 'should correctly index a date range field' do
+    session.index(post(:featured_for => Date.new(2009, 07, 13)..Date.new(2009, 12, 25)))
+    connection.should have_add_with(:featured_for_dr => '[2009-07-13T00:00:00Z TO 2009-12-25T00:00:00Z]')
+  end
+
   it 'should correctly index a boolean field' do
     session.index(post(:featured => true))
     connection.should have_add_with(:featured_bs => 'true')

data/spec/api/query/function_spec.rb

@@ -102,5 +102,108 @@ describe 'function query' do
       end
     end.should raise_error(Sunspot::UnrecognizedFieldError)
   end
+
+  it "should send query to solr with multiplicative boost function" do
+    session.search Post do
+      keywords('pizza') do
+        multiplicative_boost(function { :average_rating })
+      end
+    end
+    connection.should have_last_search_including(:boost, 'average_rating_ft')
+  end
+
+  it "should send query to solr with multiplicative boost function and boost amount" do
+    session.search Post do
+      keywords('pizza') do
+        multiplicative_boost(function { :average_rating }^5)
+      end
+    end
+    connection.should have_last_search_including(:boost, 'average_rating_ft^5')
+  end
+
+  it "should handle multiplicative boost function with constant float" do
+    session.search Post do
+      keywords('pizza') do
+        multiplicative_boost(function { 10.5 })
+      end
+    end
+    connection.should have_last_search_including(:boost, '10.5')
+  end
+
+  it "should handle multiplicative boost function with constant float and boost amount" do
+    session.search Post do
+      keywords('pizza') do
+        multiplicative_boost(function { 10.5 }^5)
+      end
+    end
+    connection.should have_last_search_including(:boost, '10.5^5')
+  end
+
+  it "should handle multiplicative boost function with time literal" do
+    session.search Post do
+      keywords('pizza') do
+        multiplicative_boost(function { Time.parse('2010-03-25 14:13:00 EDT') })
+      end
+    end
+    connection.should have_last_search_including(:boost, '2010-03-25T18:13:00Z')
+  end
+ 
+  it "should handle arbitrary functions in a function query block" do
+    session.search Post do
+      keywords('pizza') do
+        multiplicative_boost(function { product(:average_rating, 10) })
+      end
+    end
+    connection.should have_last_search_including(:boost, 'product(average_rating_ft,10)')
+  end
+
+  it "should handle the sub function in a multiplicative boost function query block" do
+    session.search Post do
+      keywords('pizza') do
+        multiplicative_boost(function { sub(:average_rating, 10) })
+      end
+    end
+    connection.should have_last_search_including(:boost, 'sub(average_rating_ft,10)')
+  end
+
+  it "should handle boost amounts on multiplicative boost function query block" do
+    session.search Post do
+      keywords('pizza') do
+        multiplicative_boost(function { sub(:average_rating, 10)^5 })
+      end
+    end
+    connection.should have_last_search_including(:boost, 'sub(average_rating_ft,10)^5')
+  end
+ 
+  it "should handle nested functions in a multiplicative boost function query block" do
+    session.search Post do
+      keywords('pizza') do
+        multiplicative_boost(function { product(:average_rating, sum(:average_rating, 20)) })
+      end
+    end
+    connection.should have_last_search_including(:boost, 'product(average_rating_ft,sum(average_rating_ft,20))')
+  end
+
+  # TODO SOLR 1.5
+  it "should raise ArgumentError if string literal passed to multiplicative boost" do
+    lambda do
+      session.search Post do
+        keywords('pizza') do
+          multiplicative_boost(function { "hello world" })
+        end
+      end
+    end.should raise_error(ArgumentError)
+  end
+
+  it "should raise UnrecognizedFieldError if bogus field name passed to multiplicative boost" do
+    lambda do
+      session.search Post do
+        keywords('pizza') do
+          multiplicative_boost(function { :bogus })
+        end
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
 end
 

data/spec/api/query/group_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path('spec_helper', File.dirname(__FILE__))
 
-describe "field grouping" do
+describe "grouping" do
   it "sends grouping parameters to solr" do
     session.search Post do
       group :title
@@ -29,4 +29,26 @@ describe "field grouping" do
 
     connection.should have_last_search_including(:"group.sort", "average_rating_ft asc")
   end
+
+  it "sends grouping field parameters to solr" do
+    session.search Post do
+      group do
+        field :title
+      end
+    end
+
+    connection.should have_last_search_including(:"group.field", "title_ss")
+  end
+
+  it "sends grouping query parameters to solr" do
+    session.search Post do
+      group do
+        query 'category 1' do
+          with(:category_ids, 1)
+        end
+      end
+    end
+
+    connection.should have_last_search_including(:"group.query", "category_ids_im:1")
+  end
 end

data/spec/api/session_proxy/sharding_session_proxy_spec.rb

@@ -15,7 +15,7 @@ describe Sunspot::SessionProxy::ShardingSessionProxy do
     end
   end
 
-  [:remove_by_id, :remove_by_id!].each do |method|
+  [:remove_by_id, :remove_by_id!, :atomic_update, :atomic_update!].each do |method|
     it "should raise NotSupportedError when #{method} called" do
       lambda { @proxy.send(method, Post, 1) }.should raise_error(Sunspot::SessionProxy::NotSupportedError)
     end

data/spec/helpers/integration_helper.rb

@@ -5,4 +5,13 @@ module IntegrationHelper
       Sunspot.reset!(true)
     end
   end
+
+  def featured_for_posts(method, param, negated = false)
+    with_method = negated ? :without : :with
+    param = date_ranges[param] if param.is_a? String
+
+    Sunspot.search(Post) do
+      send(with_method, :featured_for).send(method, param)
+    end.results
+  end
 end

data/spec/integration/atomic_updates_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe 'atomic updates' do
+  before :all do
+    Sunspot.remove_all
+  end
+
+  def validate_hit(hit, title, featured)
+    hit.stored(:title).should == title
+    hit.stored(:featured).should == featured
+  end
+
+  def find_indexed_post(id)
+    hit = Sunspot.search(Post).hits.find{ |h| h.primary_key.to_i == id }
+    hit.should_not be_nil
+    hit
+  end
+
+  it 'should update single record fields one by one' do
+    post = Post.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+    
+    validate_hit(find_indexed_post(post.id), post.title, post.featured)
+
+    Sunspot.atomic_update!(Post, post.id => {title: 'A New Title'})
+    validate_hit(find_indexed_post(post.id), 'A New Title', true)
+
+    Sunspot.atomic_update!(Post, post.id => {featured: false})
+    validate_hit(find_indexed_post(post.id), 'A New Title', false)
+  end
+
+  it 'should update fields for multiple records' do
+    post1 = Post.new(title: 'A First Title', featured: true)
+    post2 = Post.new(title: 'A Second Title', featured: false)
+    Sunspot.index!(post1, post2)
+
+    validate_hit(find_indexed_post(post1.id), post1.title, post1.featured)
+    validate_hit(find_indexed_post(post2.id), post2.title, post2.featured)
+
+    Sunspot.atomic_update!(Post, post1.id => {title: 'A New Title'}, post2.id => {featured: true})
+    validate_hit(find_indexed_post(post1.id), 'A New Title', true)
+    validate_hit(find_indexed_post(post2.id), 'A Second Title', true)
+  end
+end

data/spec/integration/field_grouping_spec.rb

@@ -72,6 +72,19 @@ describe "field grouping" do
     title1_group.hits.first.primary_key.to_i.should == highest_ranked_post.id
   end
 
+  it "allows specification of an ordering function within groups" do
+    search = Sunspot.search(Post) do
+      group :title do
+        order_by_function(:product, :average_rating, -2, :asc)
+      end
+    end
+
+    highest_ranked_post = @posts.sort_by { |p| -p.ratings_average }.first
+
+    title1_group = search.group(:title).groups.detect { |g| g.value == "Title1" }
+    title1_group.hits.first.primary_key.to_i.should == highest_ranked_post.id
+  end
+
   it "allows pagination within groups" do
     search = Sunspot.search(Post) do
       group :title

data/spec/integration/scoped_search_spec.rb

@@ -127,6 +127,57 @@ describe 'scoped_search' do
   test_field_type 'Trie Time', :created_at, :created_at, Photo, *(['1970-01-01 00:00:00 UTC', '1983-07-08 04:00:00 UTC', '1983-07-08 02:00:00 -0500',
                                                                    '2005-11-05 10:00:00 UTC', Time.now.to_s].map { |t| Time.parse(t) })
 
+  describe 'Date range field type' do
+    let(:january) { Date.new(2015,1,1)..Date.new(2015,1,31) }
+    let(:february) { Date.new(2015,2,1)..Date.new(2015,2,28) }
+    let(:date_ranges) do
+      {
+        'December and January' => Date.new(2014,12,25)..Date.new(2015,1,10),
+        'January only' => Date.new(2015,1,5)..Date.new(2015,1,20),
+        'January and February' => Date.new(2015,1,25)..Date.new(2015,2,10),
+        'February only' => Date.new(2015,2,5)..Date.new(2015,2,20),
+        'December to February' => Date.new(2014,12,25)..Date.new(2015,2,10),
+        'January to March' => Date.new(2015,1,25)..Date.new(2015,3,10),
+        'December to March' => Date.new(2014,12,25)..Date.new(2015,3,20)
+      }
+    end
+
+    before :all do
+      Sunspot.remove_all
+      @posts = [Post.new(featured_for: january), Post.new(featured_for: february), Post.new]
+      Sunspot.index!(@posts)
+    end
+
+    it 'should filter by Contains' do
+      featured_for_posts(:containing, Date.new(2015,1,15) ).should == [@posts[0]]
+      featured_for_posts(:containing, 'December and January').should be_empty
+      featured_for_posts(:containing, 'January only').should == [@posts[0]]
+      featured_for_posts(:containing, 'January only', negated = true).should == @posts[1..-1]
+    end
+
+    it 'should filter by Intersects' do
+      featured_for_posts(:intersecting, Date.new(2015,1,15) ).should == [@posts[0]]
+      featured_for_posts(:intersecting, 'January only').should == [@posts[0]]
+      featured_for_posts(:intersecting, 'January and February').should == @posts[0..1]
+      featured_for_posts(:intersecting, 'January and February', negated = true).should == [@posts[2]]
+      featured_for_posts(:intersecting, 'February only').should == [@posts[1]]
+      featured_for_posts(:intersecting, 'February only', negated = true).should == [@posts[0], @posts[2]]
+    end
+
+    it 'should filter by Within' do
+      featured_for_posts(:within, Date.new(2015,1,15) ).should be_empty
+      (date_ranges.keys - date_ranges.keys.grep(/ to /)).each do |key|
+        featured_for_posts(:within, key).should be_empty
+      end
+      featured_for_posts(:within, 'December to February').should == [@posts[0]]
+      featured_for_posts(:within, 'December to February', negated = true).should == @posts[1..-1]
+      featured_for_posts(:within, 'January to March').should == [@posts[1]]
+      featured_for_posts(:within, 'January to March', negated = true).should == [@posts[0], @posts[2]]
+      featured_for_posts(:within, 'December to March').should == @posts[0..1]
+      featured_for_posts(:within, 'December to March', negated = true).should == [@posts[2]]
+    end
+  end
+
   describe 'Boolean field type' do
     before :all do
       Sunspot.remove_all

data/spec/mocks/post.rb

@@ -3,7 +3,8 @@ require File.join(File.dirname(__FILE__), 'super_class')
 
 class Post < SuperClass
   attr_accessor :title, :body, :blog_id, :published_at, :ratings_average,
-                :author_name, :featured, :expire_date, :coordinates, :tags
+                :author_name, :featured, :expire_date, :coordinates, :tags,
+                :featured_for
   alias_method :featured?, :featured
 
   def category_ids
@@ -43,6 +44,7 @@ Sunspot.setup(Post) do
   float :average_rating, :using => :ratings_average, :trie => true
   time :published_at, :trie => true
   date :expire_date
+  date_range :featured_for
   boolean :featured, :using => :featured?, :stored => true
   string :sort_title do
     title.downcase.sub(/^(a|an|the)\W+/, '') if title