outoftime-sunspot 0.8.9 → 0.9.0

data/spec/integration/keyword_search_spec.rb

@@ -1,42 +1,83 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe 'keyword search' do
-  before :all do
-    Sunspot.remove_all
-    @posts = []
-    @posts << Post.new(:title => 'The toast elects the insufficient spirit',
-                       :body => 'Does the wind write?')
-    @posts << Post.new(:title => 'A nail abbreviates the recovering insight outside the moron',
-                       :body => 'The interpreted strain scans the buffer around the upper temper')
-    @posts << Post.new(:title => 'The toast abbreviates the recovering spirit',
-                       :body => 'Does the wind interpret the buffer?')
-    Sunspot.index!(*@posts)
-    @comment = Namespaced::Comment.new(:body => 'Hey there where ya goin, not exactly knowin, who says you have to call just one place toast.')
-    Sunspot.index!(@comment)
-  end
+  describe 'generally' do
+    before :all do
+      Sunspot.remove_all
+      @posts = []
+      @posts << Post.new(:title => 'The toast elects the insufficient spirit',
+                         :body => 'Does the wind write?')
+      @posts << Post.new(:title => 'A nail abbreviates the recovering insight outside the moron',
+                         :body => 'The interpreted strain scans the buffer around the upper temper')
+      @posts << Post.new(:title => 'The toast abbreviates the recovering spirit',
+                         :body => 'Does the wind interpret the buffer, moron?')
+      Sunspot.index!(*@posts)
+      @comment = Namespaced::Comment.new(:body => 'Hey there where ya goin, not exactly knowin, who says you have to call just one place toast.')
+      Sunspot.index!(@comment)
+    end
 
-  it 'matches a single keyword out of a single field' do
-    results = Sunspot.search(Post) { keywords 'toast' }.results
-    [0, 2].each { |i| results.should include(@posts[i]) }
-    [1].each { |i| results.should_not include(@posts[i]) }
-  end
+    it 'matches a single keyword out of a single field' do
+      results = Sunspot.search(Post) { keywords 'toast' }.results
+      [0, 2].each { |i| results.should include(@posts[i]) }
+      [1].each { |i| results.should_not include(@posts[i]) }
+    end
+
+    it 'matches multiple words out of a single field' do
+      results = Sunspot.search(Post) { keywords 'elects toast' }.results
+      results.should == [@posts[0]]
+    end
+
+    it 'matches multiple words in multiple fields' do
+      results = Sunspot.search(Post) { keywords 'toast wind' }.results
+      [0, 2].each { |i| results.should include(@posts[i]) }
+      [1].each { |i| results.should_not include(@posts[i]) }
+    end
 
-  it 'matches multiple words out of a single field' do
-    results = Sunspot.search(Post) { keywords 'elects toast' }.results
-    results.should == [@posts[0]]
+    it 'matches multiple types' do
+      results = Sunspot.search(Post, Namespaced::Comment) do
+        keywords 'toast'
+      end.results
+      [@posts[0], @posts[2], @comment].each  { |obj| results.should include(obj) }
+      results.should_not include(@posts[1])
+    end
+
+    it 'matches keywords from only the fields specified' do
+      results = Sunspot.search(Post) do
+        keywords 'moron', :fields => [:title]
+      end.results
+      results.should == [@posts[1]]
+    end
   end
 
-  it 'matches multiple words in multiple fields' do
-    results = Sunspot.search(Post) { keywords 'toast wind' }.results
-    [0, 2].each { |i| results.should include(@posts[i]) }
-    [1].each { |i| results.should_not include(@posts[i]) }
+  describe 'with field boost' do
+    before :all do
+      Sunspot.remove_all
+      @posts = [:title, :body].map { |field| Post.new(field => 'rhinoceros') }
+      Sunspot.index!(*@posts)
+    end
+
+    it 'should assign a higher score to the result matching the higher-boosted field' do
+      search = Sunspot.search(Post) { keywords 'rhinoceros' }
+      search.hits.map { |hit| hit.primary_key }.should ==
+        @posts.map { |post| post.id.to_s }
+      search.hits.first.score.should > search.hits.last.score
+    end
   end
 
-  it 'matches multiple types' do
-    results = Sunspot.search(Post, Namespaced::Comment) do
-      keywords 'toast'
-    end.results
-    [@posts[0], @posts[2], @comment].each  { |obj| results.should include(obj) }
-    results.should_not include(@posts[1])
+  describe 'with document boost' do
+    before :all do
+      Sunspot.remove_all
+      @posts = [4.0, 2.0].map do |rating|
+        Post.new(:title => 'Test', :ratings_average => rating)
+      end
+      Sunspot.index!(*@posts)
+    end
+
+    it 'should assign a higher score to the higher-boosted document' do
+      search = Sunspot.search(Post) { keywords 'test' }
+      search.hits.map { |hit| hit.primary_key }.should == 
+        @posts.map { |post| post.id.to_s }
+      search.hits.first.score.should > search.hits.last.score
+    end
   end
 end

data/spec/integration/scoped_search_spec.rb

@@ -172,4 +172,17 @@ describe 'scoped_search' do
       search.results.should == @posts
     end
   end
+
+  describe 'ordering by random' do
+    it 'should order randomly (run this test again if it fails)' do
+      Sunspot.remove_all
+      Sunspot.index!(Array.new(100) { Post.new })
+      result_sets = Array.new(2) do
+        Sunspot.search(Post) { order_by_random }.results.map do |result|
+          result.id
+        end
+      end
+      result_sets[0].should_not == result_sets[1]
+    end
+  end
 end

data/spec/integration/stored_fields_spec.rb

@@ -0,0 +1,10 @@
+describe 'stored fields' do
+  before :all do
+    Sunspot.remove_all
+    Sunspot.index!(Post.new(:title => 'A Title'))
+  end
+
+  it 'should return stored fields' do
+    Sunspot.search(Post).hits.first.stored(:title).should == 'A Title'
+  end
+end

data/spec/mocks/blog.rb

@@ -0,0 +1,3 @@
+class Blog < MockRecord
+  attr_accessor :name
+end

data/spec/mocks/comment.rb

@@ -1,30 +1,19 @@
 module Namespaced
-  class Comment < BaseClass
-    @@id = 0
-    @@comments = [nil]
-
+  class Comment < MockRecord
     attr_reader :id
-    attr_accessor :author_name, :published_at, :body, :average_rating
-
-    def initialize(attrs = {})
-      @id = @@id += 1
-      @@comments << self
-      attrs.each_pair { |attribute, value| self.send("#{attribute}=", value) }
-    end
+    attr_accessor :author_name, :published_at, :body, :average_rating, :boost
 
-    def self.get(id)
-      @@comments[id]
-    end
-
-    def self.get_all(ids)
-      ids.map { |id| get(id) }.sort_by { |post| post.id } # this is so that results are not ordered by coincidence
+    def custom_string
+      @custom_string ||= {}
     end
   end
+end
 
-  Sunspot.setup(Comment) do
-    text :author_name, :body
-    string :author_name
-    time :published_at
-    integer :average_rating
-  end
+Sunspot.setup(Namespaced::Comment) do
+  text :body, :author_name
+  string :author_name
+  time :published_at
+  integer :average_rating
+  dynamic_string :custom_string
+  boost :boost
 end

data/spec/mocks/connection.rb

@@ -0,0 +1,84 @@
+module Mock
+  class ConnectionFactory
+    def new(adapter = nil, opts = nil)
+      if @instance
+        raise('Factory can only create an instance once!')
+      else
+        @instance = Connection.new(adapter, opts)
+      end
+    end
+
+    def instance
+      @instance ||= Connection.new
+    end
+  end
+
+  class Connection
+    attr_reader :adds, :commits, :searches
+    attr_accessor :adapter, :opts
+
+    def initialize(adapter = nil, opts = nil)
+      @adapter, @opts = adapter, opts
+      @adds, @deletes, @deletes_by_query, @commits, @searches = Array.new(5) { [] }
+    end
+
+    def add(documents)
+      @adds << Array(documents)
+    end
+
+    def delete_by_id(*ids)
+      @deletes << ids
+    end
+
+    def delete_by_query(query)
+      @deletes_by_query << query
+    end
+
+    def commit
+      @commits << Time.now
+    end
+
+    def select(params)
+      @searches << @last_search = params
+    end
+
+    def has_add_with?(*documents)
+      @adds.any? do |add|
+        documents.all? do |document|
+          add.any? do |added|
+            if document.is_a?(Hash)
+              document.all? do |field, value|
+                added.fields_by_name(field).map do |field|
+                  field.value
+                end == Array(value)
+              end
+            else
+              !added.fields_by_name(document).empty?
+            end
+          end
+        end
+      end
+    end
+
+    def has_delete?(*ids)
+      @deletes.any? do |delete|
+        delete & ids == ids
+      end
+    end
+
+    def has_delete_by_query?(query)
+      @deletes_by_query.include?(query)
+    end
+
+    def has_last_search_with?(params)
+      return unless @last_search
+      if params.respond_to?(:all?)
+        params.all? do |key, value|
+          @last_search.has_key?(key) && @last_search[key] == value
+        end
+      else
+        @last_search.has_key?(params)
+      end
+    end
+  end
+end

data/spec/mocks/mock_adapter.rb

@@ -13,10 +13,18 @@ module MockAdapter
     end
 
     def load_all(ids)
-      @clazz.get_all(ids.map { |id| id.to_i })
+      all = @clazz.get_all(ids.map { |id| id.to_i })
+      if @custom_title
+        all.each { |item| item.title = @custom_title }
+      end
+      all
+    end
+
+    def custom_title=(custom_title)
+      @custom_title = custom_title
     end
   end
 end
 
-Sunspot::Adapters::DataAccessor.register(MockAdapter::DataAccessor, BaseClass)
-Sunspot::Adapters::InstanceAdapter.register(MockAdapter::InstanceAdapter, BaseClass)
+Sunspot::Adapters::DataAccessor.register(MockAdapter::DataAccessor, MockRecord)
+Sunspot::Adapters::InstanceAdapter.register(MockAdapter::InstanceAdapter, MockRecord)

data/spec/mocks/mock_record.rb

@@ -0,0 +1,41 @@
+class MockRecord
+  IDS = Hash.new { |h, k| h[k] = 0 }
+  QUERY_COUNTS = Hash.new { |h, k| h[k] = 0 }
+  INSTANCES = Hash.new { |h, k| h[k] = {} }
+
+  attr_reader :id
+
+  def initialize(attrs = {})
+    attrs.each_pair do |name, value|
+      send(:"#{name}=", value)
+    end
+    @id = IDS[self.class.name.to_sym] += 1
+    INSTANCES[self.class.name.to_sym][@id] = self
+  end
+
+  def self.inherited(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def get(id)
+      QUERY_COUNTS[self.name.to_sym] += 1
+      get_instance(id)
+    end
+
+    def get_all(ids)
+      QUERY_COUNTS[self.name.to_sym] += 1
+      ids.map { |id| get_instance(id) }.sort_by { |instance| instance.id }
+    end
+
+    def query_count
+      QUERY_COUNTS[self.name.to_sym]
+    end
+
+    private
+
+    def get_instance(id)
+      INSTANCES[self.name.to_sym][id]
+    end
+  end
+end

data/spec/mocks/photo.rb

@@ -0,0 +1,8 @@
+class Photo < MockRecord
+  attr_accessor :caption
+end
+
+Sunspot.setup(Photo) do
+  text :caption
+  boost 0.75
+end

data/spec/mocks/post.rb

@@ -1,30 +1,14 @@
-class Post < BaseClass
-  @@id = 0
-  @@posts = [nil]
+require File.join(File.dirname(__FILE__), 'blog')
 
-  attr_reader :id
-  attr_accessor :title, :body, :blog_id, :published_at, :ratings_average, :author_name, :featured
+class Post < MockRecord
+  attr_accessor :title, :body, :blog_id, :published_at, :ratings_average,
+                :author_name, :featured, :expire_date
   alias_method :featured?, :featured
 
-
-  def initialize(attrs = {})
-    @id = @@id += 1
-    @@posts << self
-    attrs.each_pair { |attribute, value| self.send "#{attribute}=", value }
-  end
-
   def category_ids
     @category_ids ||= []
   end
 
-  def self.get(id)
-    @@posts[id]
-  end
-
-  def self.get_all(ids)
-    ids.map { |id| get(id) }.sort_by { |post| post.id } # this is so that results are not ordered by coincidence
-  end
-
   def custom_string
     @custom_string ||= {}
   end
@@ -46,15 +30,17 @@ class Post < BaseClass
 end
 
 Sunspot.setup(Post) do
-  text :title, :body
+  text :title, :boost => 2
+  text :body
   text :backwards_title do
     title.reverse if title
   end
-  string :title
-  integer :blog_id
+  string :title, :stored => true
+  integer :blog_id, :references => Blog
   integer :category_ids, :multiple => true
   float :average_rating, :using => :ratings_average
   time :published_at
+  date :expire_date
   boolean :featured, :using => :featured?
   string :sort_title do
     title.downcase.sub(/^(a|an|the)\W+/, '') if title
@@ -62,6 +48,9 @@ Sunspot.setup(Post) do
   integer :primary_category_id do |post|
     post.category_ids.first
   end
+  time :last_indexed_at, :stored => true do
+    Time.now
+  end
 
   dynamic_string :custom_string
   dynamic_float :custom_float, :multiple => true, :using => :custom_fl
@@ -72,4 +61,10 @@ Sunspot.setup(Post) do
   end
   dynamic_time :custom_time
   dynamic_boolean :custom_boolean
+
+  boost do
+    if ratings_average
+      1 + (ratings_average - 3.0) / 4.0
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,19 +1,32 @@
-require 'rubygems'
-gem 'mislav-will_paginate', '~> 2.3'
-gem 'rspec', '~> 1.1'
+using_gems = false
 begin
-  gem 'ruby-debug', '~>0.10'
-  require 'ruby-debug'
-rescue Gem::LoadError
-  module Kernel
-    def debugger
-      raise("debugger is not available")
+  require 'spec'
+  begin
+    require 'ruby-debug'
+  rescue LoadError => e
+    if using_gems
+      module Kernel
+        def debugger
+          STDERR.puts('Debugger is not available')
+        end
+      end
+    else
+      raise(e)
     end
   end
+  if ENV['USE_WILL_PAGINATE']
+    require 'will_paginate'
+    require 'will_paginate/collection'
+  end
+rescue LoadError => e
+  require 'rubygems'
+  if using_gems
+    raise(e)
+  else
+    using_gems = true
+    retry
+  end
 end
-require 'spec'
-require 'will_paginate'
-require 'will_paginate/collection'
 
 unless gem_name = ENV['SUNSPOT_TEST_GEM']
   $:.unshift(File.dirname(__FILE__) + '/../lib')
@@ -22,8 +35,10 @@ else
 end
 require 'sunspot'
 
-require File.join(File.dirname(__FILE__), 'mocks', 'base_class.rb')
-Dir.glob(File.join(File.dirname(__FILE__), 'mocks', '**', '*.rb')).each { |file| require file }
+require File.join(File.dirname(__FILE__), 'mocks', 'mock_record.rb')
+Dir.glob(File.join(File.dirname(__FILE__), 'mocks', '**', '*.rb')).each do |file|
+  require file unless File.basename(file) == 'mock_record.rb'
+end
 
 def without_class(clazz)
   Object.class_eval { remove_const(clazz.name.to_sym) }

data/tasks/gemspec.rake

@@ -9,15 +9,16 @@ begin
     s.homepage = 'http://github.com/outoftime/sunspot'
     s.description = 'Library for expressive, powerful interaction with the Solr search engine'
     s.authors = ['Mat Brown', 'Peer Allan', 'Dmitriy Dzema', 'Benjamin Krause']
-    s.files = FileList['[A-Z]*', '{bin,lib,spec,tasks}/**/*', 'solr/{etc,lib,webapps}/**/*', 'solr/solr/conf/*', 'solr/start.jar']
-    s.add_dependency 'solr-ruby', '>= 0.0.6'
+    s.files = FileList['[A-Z]*', '{bin,lib,spec,tasks,templates}/**/*', 'solr/{etc,lib,webapps}/**/*', 'solr/solr/conf/*', 'solr/start.jar']
+    s.add_dependency 'mwmichell-rsolr', '>= 0.8.9'
     s.add_dependency 'daemons', '~> 1.0'
     s.add_dependency 'optiflag', '~> 0.6.5'
+    s.add_dependency 'haml', '~> 2.2'
     s.add_development_dependency 'rspec', '~> 1.1'
     s.add_development_dependency 'ruby-debug', '~> 0.10'
     s.extra_rdoc_files = ['README.rdoc']
     s.rdoc_options << '--webcvs=http://github.com/outoftime/sunspot/tree/master/%s' <<
-                      '--title' << 'Sunspot - Pure-Ruby Solr Search and Indexing - API Documentation' <<
+                      '--title' << 'Sunspot - Solr-powered search for Ruby objects - API Documentation' <<
                       '--main' << 'README.rdoc'
 
   end

data/tasks/rdoc.rake

@@ -3,11 +3,11 @@ require 'hanna/rdoctask'
 
 Rake::RDocTask.new(:doc) do |rdoc|
   version = Jeweler::VersionHelper.new(File.join(File.dirname(__FILE__), '..')).to_s
-  rdoc.title = 'Sunspot - Pure-Ruby Solr Search and Indexing - API Documentation'
+  rdoc.title = "Sunspot #{version} - Solr-powered search for Ruby objects - API Documentation"
   rdoc.main = 'README.rdoc'
   rdoc.rdoc_files.include('README.rdoc', 'lib/sunspot.rb', 'lib/sunspot/**/*.rb')
   rdoc.rdoc_dir = 'doc'
-  rdoc.options << "--webcvs=http://github.com/outoftime/sunspot/tree/v#{version}/%s" << '--title' << 'Sunspot - Pure-Ruby Solr Search and Indexing - API Documentation'
+  rdoc.options << "--webcvs=http://github.com/outoftime/sunspot/tree/v#{version}/%s" << '--title' << 'Sunspot - Solr-powered search for Ruby objects - API Documentation'
 end
 
 namespace :doc do

data/tasks/schema.rake

@@ -0,0 +1,19 @@
+namespace :schema do
+  desc 'Compile schema from Haml template'
+  task :compile do
+    require File.join(File.dirname(__FILE__), '..', 'lib', 'sunspot', 'schema')
+    File.open(
+      File.join(
+        File.dirname(__FILE__),
+        '..',
+        'solr',
+        'solr',
+        'conf',
+        'schema.xml'
+    ),
+      'w'
+    ) do |file|
+      file << Sunspot::Schema.new.to_xml
+    end
+  end
+end

data/templates/schema.xml.haml

@@ -0,0 +1,24 @@
+!!! XML
+%schema{ :name => 'sunspot', :version => 0.9 }
+  %types
+    %fieldtype{ :name => 'text', :class => 'solr.TextField', :positionIncrementGap => 100 }
+      %analyzer
+        %tokenizer{ :class => schema.tokenizer }/
+        - for filter in schema.filters
+          %filter{ :class => filter }/
+    %fieldtype{ :name => 'rand', :class => 'solr.RandomSortField' }
+    - schema.types.each do |type|
+      %fieldtype{ :name => type.name, :class => "solr.#{type.class_name}Field", :omitNorms => 'true' }/
+  %fields
+    %field{ :name => 'id', :type => 'string', :indexed => 'true', :stored => 'true', :multiValued => 'false' }/
+    %field{ :name => 'type', :type => 'string', :indexed => 'true', :stored => 'false', :multiValued => 'true' }/
+    %field{ :name => 'class_name', :type => 'string', :indexed => 'true', :stored => 'false', :multiValued => 'false' }/
+    %field{ :name => 'text', :type => 'text', :indexed => 'true', :stored => 'false', :multiValued => 'true' }/
+    %dynamicField{ :name => '*_text', :type => 'text', :indexed => 'true', :stored => 'false', :multiValued => 'true' }/
+    %dynamicField{ :name => 'random_*', :type => 'rand', :indexed => 'true', :stored => 'false' }/
+    - for dynamic_field in schema.dynamic_fields
+      %dynamicField{ :name => dynamic_field.name, :type => dynamic_field.type, :indexed => 'true', :stored => dynamic_field.stored?, :multiValued => dynamic_field.multiValued? }/
+  %uniqueKey id
+  %defaultSearchField text
+  %solrQueryParser{ :defaultOperator => 'AND' }/
+  %copyField{ :source => '*_text', :dest => 'text' }/