honkster-acts_as_solr 0.1.0

data/test/db/migrate/006_create_postings.rb

@@ -0,0 +1,9 @@
+class CreatePostings < ActiveRecord::Migration
+  def self.up
+    execute "CREATE TABLE postings(`guid` varchar(20) NOT NULL PRIMARY KEY, `name` varchar(200), `description` text)"
+  end
+
+  def self.down
+    drop_table :postings
+  end
+end

data/test/db/migrate/007_create_posts.rb

@@ -0,0 +1,13 @@
+class CreatePosts < ActiveRecord::Migration
+  def self.up
+    create_table :posts, :force => true do |t|
+      t.column :name, :string
+      t.column :reply_counter, :integer
+      t.column :posted_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :posts
+  end
+end

data/test/db/migrate/008_create_gadgets.rb

@@ -0,0 +1,11 @@
+class CreateGadgets < ActiveRecord::Migration
+  def self.up
+    create_table :gadgets, :force => true do |t|
+      t.column :name, :string
+    end
+  end
+
+  def self.down
+    drop_table :gadgets
+  end
+end

data/test/fixtures/authors.yml

@@ -0,0 +1,9 @@
+tom_clancy:
+  id: 1
+  name: Tom Clancy
+  biography: Tom Clancy (born 1947) writes novels of adventure and espionage in the international military-industrial complex that have earned him enormous popularity in the 1980s as a creator of the "techno-thriller" genre.
+  
+stephen_king:
+  id: 2
+  name: Stephen King
+  biography: Stephen King (born 1947) is a prolific and immensely popular author of horror fiction. In his works, King blends elements of the traditional gothic tale with those of the modern psychological thriller, detective, and science fiction genres.

data/test/fixtures/books.yml

@@ -0,0 +1,13 @@
+splinter_cell:
+  id: 1
+  category_id: 1
+  name: Splinter Cell
+  author: Tom Clancy
+  published_on: <%= Date.today - 1.year %>
+  
+ruby:
+  id: 2
+  category_id: 2
+  name: Ruby for Dummies
+  author: Peter McPeterson
+  published_on: <%= Date.today - 2.years %>

data/test/fixtures/categories.yml

@@ -0,0 +1,7 @@
+thriller:
+  id: 1
+  name: Thriller/Novels
+  
+technical:
+  id: 2
+  name: Technical Books

data/test/fixtures/db_definitions/mysql.sql

@@ -0,0 +1,41 @@
+DROP DATABASE IF EXISTS `actsassolr_tests`;
+CREATE DATABASE IF NOT EXISTS `actsassolr_tests`;
+USE `actsassolr_tests`
+
+CREATE TABLE `books` (
+  `id` int(11) NOT NULL auto_increment,
+  `category_id` int(11),
+  `name` varchar(200) default NULL,
+  `author` varchar(200) default NULL,
+  PRIMARY KEY  (`id`)
+);
+
+CREATE TABLE `movies` (
+  `id` int(11) NOT NULL auto_increment,
+  `name` varchar(200) default NULL,
+  `description` varchar(255) default NULL,
+  PRIMARY KEY  (`id`)
+);
+
+CREATE TABLE `categories` (
+  `id` int(11) NOT NULL auto_increment,
+  `name` varchar(200) default NULL,
+  PRIMARY KEY  (`id`)
+);
+
+CREATE TABLE `electronics` (
+  `id` int(11) NOT NULL auto_increment,
+  `name` varchar(200) default NULL,
+  `manufacturer` varchar(255) default NULL,
+  `features` varchar(255) default NULL,
+  `category` varchar(255) default NULL, 
+  `price` varchar(20) default NULL,
+  PRIMARY KEY  (`id`)
+);
+
+CREATE TABLE `authors` (
+  `id` int(11) NOT NULL auto_increment,
+  `name` varchar(200) default NULL,
+  `biography` text default NULL,
+  PRIMARY KEY  (`id`)
+);

data/test/fixtures/electronics.yml

@@ -0,0 +1,49 @@
+ipod_video:
+  id: 1
+  name: Apple 60 GB Memory iPod with Video Playback Black
+  manufacturer: Apple Computer Inc.
+  features: iTunes, Podcasts, Audiobooks
+  category: Electronics
+  price: 599.00
+  created_at: <%= Date.today - 1.year %>
+  updated_at: <%= Date.today - 1.month %>
+  
+dell_monitor:
+  id: 2
+  name: Dell Widescreen UltraSharp 3007WFP
+  manufacturer: Dell, Inc
+  features: 30" TFT active matrix LCD, 2560 x 1600, .25mm dot pitch, 700:1 contrast
+  category: Electronics
+  price: 750.00
+  created_at: <%= Date.today - 1.year %>
+  updated_at: <%= Date.today - 1.month %>
+  
+samsung_hd:
+  id: 3
+  name: Samsung SpinPoint P120 SP2514N - hard drive - 250 GB of Memory Storage - ATA-133
+  manufacturer: Samsung Electronics Co. Ltd.
+  features: 7200RPM, 8MB cache, IDE Ultra ATA-133
+  category: Hard Drive
+  price: 319.00
+  created_at: <%= Date.today - 2.years %>
+  updated_at: <%= Date.today - 2.months %>
+  
+corsair_ram:
+  id: 4
+  name: CORSAIR XMS 2GB (2 x 1GB) 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) Dual Channel Kit System Memory - Retail
+  manufacturer: Corsair Microsystems Inc.
+  features: CAS latency 2,	2-3-3-6 timing, 2.75v, unbuffered, heat-spreader
+  category: Memory
+  price: 155.00
+  created_at: <%= Date.today - 6.years %>
+  updated_at: <%= Date.today - 3.months %>
+  
+a_data_ram:
+  id: 5
+  name: A-DATA V-Series 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - OEM
+  manufacturer: A-DATA Technology Inc.
+  features: CAS latency 3, 2.7v
+  category: Memory
+  price: 65.79
+  created_at: <%= Date.today - 9.years %>
+  updated_at: <%= Date.today - 4.months %>

data/test/fixtures/movies.yml

@@ -0,0 +1,9 @@
+napoleon_dynamite:
+  id: 1
+  name: Napoleon Dynamite
+  description: Cool movie about a goofy guy
+  
+office_space:
+  id: 2
+  name: Office Space
+  description: Hypnotized dude loves fishing but not working

data/test/fixtures/postings.yml

@@ -0,0 +1,10 @@
+first:
+  guid: ABC-123
+  name: Posting ABC
+  description: First posting testing primary key as string
+
+second:
+  guid: DEF-456
+  name: Posting DEF
+  description: Second posting testing primary key as string
+

data/test/functional/acts_as_solr_test.rb

@@ -0,0 +1,413 @@
+# encoding: utf-8
+require "#{File.dirname(File.expand_path(__FILE__))}/../test_helper"
+
+class ActsAsSolrTest < Test::Unit::TestCase
+  
+  fixtures :books, :movies, :electronics, :postings, :authors
+
+  # Inserting new data into Solr and making sure it's getting indexed
+  def test_insert_new_data
+    assert_equal 2, Book.count_by_solr('ruby OR splinter OR bob')
+    b = Book.create(:name => "Fuze in action", :author => "Bob Bobber", :category_id => 1)
+    assert b.valid?
+    assert_equal 3, Book.count_by_solr('ruby OR splinter OR bob')
+  end
+  
+  # Check the type column stored in the index isn't stemmed by SOLR.  If it is stemmed,
+  # then both Post and Posting will be stored as type:Post, so a query for Posts will
+  # return Postings and vice versa
+  
+  def test_insert_new_data_doesnt_stem_type
+    assert_equal 0, Post.count_by_solr('aardvark')
+    p = Posting.new :name => 'aardvark', :description => "An interesting animal"
+    p.guid = '12AB'
+    p.save!
+    assert_equal 0, Post.count_by_solr('aardvark')
+  end
+
+  def test_type_determined_from_database_if_not_explicitly_set
+    assert Post.configuration[:solr_fields][:posted_at][:type] == :date
+  end
+  
+  def test_search_includes_subclasses
+    Novel.create! :name => 'Wuthering Heights', :author => 'Emily Bronte'
+    Book.create! :name => 'Jane Eyre', :author => 'Charlotte Bronte'
+    assert_equal 1, Novel.find_by_solr('Bronte').total_hits
+    assert_equal 2, Book.find_by_solr('Bronte').total_hits
+  end
+
+  # Testing basic solr search:
+  #  Model.find_by_solr 'term'
+  # Note that you're able to mix free-search with fields and boolean operators
+  def test_find_by_solr_ruby
+    ['ruby', 'dummy', 'name:ruby', 'name:dummy', 'name:ruby AND author:peter', 
+      'author:peter AND ruby', 'peter dummy'].each do |term|
+      records = Book.find_by_solr term
+      assert_equal 1, records.total
+      assert_equal "Peter McPeterson", records.docs.first.author
+      assert_equal "Ruby for Dummies", records.docs.first.name
+      assert_equal ({"id" => 2, 
+                      "category_id" => 2, 
+                      "name" => "Ruby for Dummies", 
+                      "author" => "Peter McPeterson", "published_on" => (Date.today - 2.years), "type" => nil}), records.docs.first.attributes
+    end
+  end
+  
+  # Testing basic solr search:
+  #   Model.find_by_solr 'term'
+  # Note that you're able to mix free-search with fields and boolean operators
+  def test_find_by_solr_splinter
+    ['splinter', 'name:splinter', 'name:splinter AND author:clancy', 
+      'author:clancy AND splinter', 'cell tom'].each do |term|
+      records = Book.find_by_solr term
+      assert_equal 1, records.total
+      assert_equal "Splinter Cell", records.docs.first.name
+      assert_equal "Tom Clancy", records.docs.first.author
+      assert_equal ({"id" => 1, "category_id" => 1, "name" => "Splinter Cell", 
+                     "author" => "Tom Clancy", "published_on" => (Date.today - 1.year), "type" => nil}), records.docs.first.attributes
+    end
+  end
+  
+  # Testing basic solr search:
+  #   Model.find_by_solr 'term'
+  # Note that you're able to mix free-search with fields and boolean operators
+  def test_find_by_solr_ruby_or_splinter
+    ['ruby OR splinter', 'ruby OR author:tom', 'name:cell OR author:peter', 'dummy OR cell'].each do |term|
+      records = Book.find_by_solr term
+      assert_equal 2, records.total
+    end
+  end
+  
+  # Testing search in indexed field methods:
+  # 
+  # class Movie < ActiveRecord::Base
+  #   acts_as_solr :fields => [:name, :description, :current_time]
+  # 
+  #   def current_time
+  #     Time.now.to_s
+  #   end
+  # 
+  # end
+  # 
+  # The method current_time above gets indexed as being part of the
+  # Movie model and it's available for search as well
+  def test_find_with_dynamic_fields
+    date = Time.now.strftime('%b %d %Y')
+    ["dynamite AND #{date}", "description:goofy AND #{date}", "goofy napoleon #{date}", 
+      "goofiness #{date}"].each do |term|
+      records = Movie.find_by_solr term 
+      assert_equal 1, records.total
+      assert_equal ({"id" => 1, "name" => "Napoleon Dynamite", 
+                     "description" => "Cool movie about a goofy guy"}), records.docs.first.attributes
+    end
+  end
+  
+  # Testing basic solr search that returns just the ids instead of the objects:
+  #   Model.find_id_by_solr 'term'
+  # Note that you're able to mix free-search with fields and boolean operators
+  def test_find_id_by_solr_ruby
+    ['ruby', 'dummy', 'name:ruby', 'name:dummy', 'name:ruby AND author:peter', 
+      'author:peter AND ruby'].each do |term|
+      records = Book.find_id_by_solr term
+      assert_equal 1, records.docs.size
+      assert_equal [2], records.docs
+    end
+  end
+  
+  # Testing basic solr search that returns just the ids instead of the objects:
+  #   Model.find_id_by_solr 'term'
+  # Note that you're able to mix free-search with fields and boolean operators
+  def test_find_id_by_solr_splinter
+    ['splinter', 'name:splinter', 'name:splinter AND author:clancy', 
+      'author:clancy AND splinter'].each do |term|
+      records = Book.find_id_by_solr term
+      assert_equal 1, records.docs.size
+      assert_equal [1], records.docs
+    end
+  end
+  
+  # Testing basic solr search that returns just the ids instead of the objects:
+  #   Model.find_id_by_solr 'term'
+  # Note that you're able to mix free-search with fields and boolean operators
+  def test_find_id_by_solr_ruby_or_splinter
+    ['ruby OR splinter', 'ruby OR author:tom', 'name:cell OR author:peter', 
+      'dummy OR cell'].each do |term|
+      records = Book.find_id_by_solr term
+      assert_equal 2, records.docs.size
+      assert_equal [1,2], records.docs
+    end
+  end
+  
+  # Testing basic solr search that returns the total number of records found:
+  #   Model.find_count_by_solr 'term'
+  # Note that you're able to mix free-search with fields and boolean operators
+  def test_count_by_solr
+    ['ruby', 'dummy', 'name:ruby', 'name:dummy', 'name:ruby AND author:peter', 
+      'author:peter AND ruby'].each do |term|
+      assert_equal 1, Book.count_by_solr(term), "there should only be 1 result for search: #{term}"
+    end
+  end
+  
+  # Testing basic solr search that returns the total number of records found:
+  #   Model.find_count_by_solr 'term'
+  # Note that you're able to mix free-search with fields and boolean operators
+  def test_count_by_solr_splinter
+    ['splinter', 'name:splinter', 'name:splinter AND author:clancy', 
+      'author:clancy AND splinter', 'author:clancy cell'].each do |term|
+      assert_equal 1, Book.count_by_solr(term)
+    end
+  end
+  
+  # Testing basic solr search that returns the total number of records found:
+  #   Model.find_count_by_solr 'term'
+  # Note that you're able to mix free-search with fields and boolean operators
+  def test_count_by_solr_ruby_or_splinter
+    ['ruby OR splinter', 'ruby OR author:tom', 'name:cell OR author:peter', 'dummy OR cell'].each do |term|
+      assert_equal 2, Book.count_by_solr(term)
+    end
+  end
+    
+  # Testing basic solr search with additional options:
+  # Model.find_count_by_solr 'term', :limit => 10, :offset => 0
+  def test_find_with_options
+    [1,2].each do |count|
+      records = Book.find_by_solr 'ruby OR splinter', :limit => count
+      assert_equal count, records.docs.size
+    end
+  end
+  
+  # Testing self.rebuild_solr_index
+  # - It makes sure the index is rebuilt after a data has been lost
+  def test_rebuild_solr_index
+    assert_equal 1, Book.count_by_solr('splinter')
+    
+    Book.find(:first).solr_destroy
+    assert_equal 0, Book.count_by_solr('splinter')
+    
+    Book.rebuild_solr_index
+    assert_equal 1, Book.count_by_solr('splinter')
+  end
+  
+  # Testing instance methods:
+  # - solr_save
+  # - solr_destroy
+  def test_solr_save_and_solr_destroy
+    assert_equal 1, Book.count_by_solr('splinter')
+  
+    Book.find(:first).solr_destroy
+    assert_equal 0, Book.count_by_solr('splinter')
+    
+    Book.find(:first).solr_save
+    assert_equal 1, Book.count_by_solr('splinter')
+  end
+  
+  # Testing the order of results
+  def test_find_returns_records_in_order
+    records = Book.find_by_solr 'ruby^5 OR splinter'
+    # we boosted ruby so ruby should come first
+  
+    assert_equal 2, records.total
+    assert_equal 'Ruby for Dummies', records.docs.first.name
+    assert_equal 'Splinter Cell', records.docs.last.name    
+  end
+  
+  # Testing solr search with optional :order argument
+  def _test_with_order_option
+    records = Movie.find_by_solr 'office^5 OR goofiness'
+    assert_equal 'Hypnotized dude loves fishing but not working', records.docs.first.description
+    assert_equal 'Cool movie about a goofy guy', records.docs.last.description
+    
+    records = Movie.find_by_solr 'office^5 OR goofiness', :order => 'description asc'
+    assert_equal 'Cool movie about a goofy guy', records.docs.first.description
+    assert_equal 'Hypnotized dude loves fishing but not working', records.docs.last.description
+  end
+  
+  # Testing search with omitted :field_types should 
+  # return the same result set as if when we use it
+  def test_omit_field_types_in_search
+    records  = Electronic.find_by_solr "price:[200 TO 599.99]"
+    assert_match(/599/, records.docs.first.price)
+    assert_match(/319/, records.docs.last.price)
+    
+    records  = Electronic.find_by_solr "price:[200 TO 599.99]", :order => 'price asc'
+    assert_match(/319/, records.docs.first.price)
+    assert_match(/599/, records.docs.last.price)
+    
+  end
+  
+  # Test to make sure the result returned when no matches
+  # are found has the same structure when there are results
+  def test_returns_no_matches
+    records = Book.find_by_solr 'rubyist'
+    assert_equal [], records.docs
+    assert_equal 0, records.total
+    
+    records = Book.find_id_by_solr 'rubyist'
+    assert_equal [], records.docs
+    assert_equal 0, records.total
+    
+    records = Book.find_by_solr 'rubyist', :facets => {}
+    assert_equal [], records.docs
+    assert_equal 0, records.total
+    assert_equal({"facet_fields"=>[]}, records.facets)
+  end
+  
+  
+  # Testing the :exclude_fields option when set in the
+  # model to make sure it doesn't get indexed
+  def test_exclude_fields_option
+    records = Electronic.find_by_solr 'audiobooks OR latency'
+    assert records.docs.empty?
+    assert_equal 0, records.total
+  
+    assert_nothing_raised{
+      records = Electronic.find_by_solr 'features:audiobooks'
+      assert records.docs.empty?
+      assert_equal 0, records.total
+    }
+  end
+  
+  # Testing the :auto_commit option set to false in the model
+  # should not send the commit command to Solr
+  def test_auto_commit_turned_off
+    assert_equal 0, Author.count_by_solr('raymond chandler')
+    
+    original_count = Author.count
+    Author.create(:name => 'Raymond Chandler', :biography => 'Writes noirish detective stories')
+    
+    assert_equal original_count + 1, Author.count
+    assert_equal 0, Author.count_by_solr('raymond chandler')
+  end
+  
+  # Testing models that use a different key as the primary key
+  def test_search_on_model_with_string_id_field
+    records = Posting.find_by_solr 'first^5 OR second'
+    assert_equal 2, records.total
+    assert_equal 'ABC-123', records.docs.first.guid
+    assert_equal 'DEF-456', records.docs.last.guid
+  end
+  
+  # Making sure the result set is ordered correctly even on
+  # models that use a different key as the primary key
+  def test_records_in_order_on_model_with_string_id_field
+    records = Posting.find_by_solr 'first OR second^5'
+    assert_equal 2, records.total
+    assert_equal 'DEF-456', records.docs.first.guid
+    assert_equal 'ABC-123', records.docs.last.guid
+  end
+  
+  # Making sure the records are added when passing a batch size
+  # to rebuild_solr_index
+  def test_using_rebuild_solr_index_with_batch
+    assert_equal 2, Movie.count_by_solr('office OR napoleon')
+    Movie.find(:all).each(&:solr_destroy)
+    assert_equal 0, Movie.count_by_solr('office OR napoleon')
+    
+    Movie.rebuild_solr_index 100
+    assert_equal 2, Movie.count_by_solr('office OR napoleon')
+  end
+  
+  # Making sure find_by_solr with scores actually return the scores
+  # for each individual record
+  def test_find_by_solr_with_score
+    books = Book.find_by_solr 'ruby^10 OR splinter', :scores => true
+    assert_equal 2, books.total
+    assert_equal 0.41763234, books.max_score
+    
+    books.records.each { |book| assert_not_nil book.solr_score }
+    assert_equal 0.41763234, books.docs.first.solr_score
+    assert_equal 0.14354616, books.docs.last.solr_score
+  end
+  
+  # Making sure nothing breaks when html entities are inside
+  # the content to be indexed; and on the search as well.
+  def test_index_and_search_with_html_entities
+    description = "
+    inverted exclamation mark  	&iexcl;  	&#161;
+    ¤ 	currency 	&curren; 	&#164;
+    ¢ 	cent 	&cent; 	&#162;
+    £ 	pound 	&pound; 	&#163;
+    ¥ 	yen 	&yen; 	&#165;
+    ¦ 	broken vertical bar 	&brvbar; 	&#166;
+    § 	section 	&sect; 	&#167;
+    ¨ 	spacing diaeresis 	&uml; 	&#168;
+    © 	copyright 	&copy; 	&#169;
+    ª 	feminine ordinal indicator 	&ordf; 	&#170;
+    « 	angle quotation mark (left) 	&laquo; 	&#171;
+    ¬ 	negation 	&not; 	&#172;
+    ­ 	soft hyphen 	&shy; 	&#173;
+    ® 	registered trademark 	&reg; 	&#174;
+    ™ 	trademark 	&trade; 	&#8482;
+    ¯ 	spacing macron 	&macr; 	&#175;
+    ° 	degree 	&deg; 	&#176;
+    ± 	plus-or-minus  	&plusmn; 	&#177;
+    ² 	superscript 2 	&sup2; 	&#178;
+    ³ 	superscript 3 	&sup3; 	&#179;
+    ´ 	spacing acute 	&acute; 	&#180;
+    µ 	micro 	&micro; 	&#181;
+    ¶ 	paragraph 	&para; 	&#182;
+    · 	middle dot 	&middot; 	&#183;
+    ¸ 	spacing cedilla 	&cedil; 	&#184;
+    ¹ 	superscript 1 	&sup1; 	&#185;
+    º 	masculine ordinal indicator 	&ordm; 	&#186;
+    » 	angle quotation mark (right) 	&raquo; 	&#187;
+    ¼ 	fraction 1/4 	&frac14; 	&#188;
+    ½ 	fraction 1/2 	&frac12; 	&#189;
+    ¾ 	fraction 3/4 	&frac34; 	&#190;
+    ¿ 	inverted question mark 	&iquest; 	&#191;
+    × 	multiplication 	&times; 	&#215;
+    ÷ 	division 	&divide; 	&#247
+        &hearts; &diams; &clubs; &spades;"
+    
+    author = Author.create(:name => "Test in Action&trade; - Copyright &copy; Bob", :biography => description)
+    assert author.valid?
+    author.solr_commit
+
+    author = Author.find_by_solr 'trademark &copy &#190 &iexcl &#163'
+    assert_equal 1, author.total
+  end
+  
+  def test_operator_search_option
+    assert_nothing_raised {
+      books = Movie.find_by_solr "office napoleon", :operator => :or
+      assert_equal 2, books.total
+      
+      books = Movie.find_by_solr "office napoleon", :operator => :and
+      assert_equal 0, books.total
+    }
+    
+    assert_raise RuntimeError do
+      Movie.find_by_solr "office napoleon", :operator => :bad
+    end
+  end  
+  
+  # Making sure find_by_solr with scores actually return the scores
+  # for each individual record and orders them accordingly
+  def test_find_by_solr_order_by_score
+    books = Book.find_by_solr 'ruby^10 OR splinter', {:scores => true, :order => 'score asc' }
+    assert (books.docs.collect(&:solr_score).compact.size == books.docs.size), "Each book should have a score"
+    assert_equal 0.41763234, books.docs.last.solr_score
+    
+    books = Book.find_by_solr 'ruby^10 OR splinter', {:scores => true, :order => 'score desc' }
+    assert_equal 0.41763234, books.docs.first.solr_score
+    assert_equal 0.14354616, books.docs.last.solr_score
+  end
+  
+  # Search based on fields with the :date format
+  def test_indexed_date_field_format
+    movies = Movie.find_by_solr 'time_on_xml:[NOW-1DAY TO NOW]'
+    assert_equal 2, movies.total
+  end
+  
+  def test_query_time_is_returned
+    results = Book.find_by_solr('ruby')
+    assert_not_nil(results.query_time)
+    assert_equal(results.query_time.class,Fixnum)
+  end
+  
+  def test_should_not_index_the_record_when_offline_proc_returns_true
+    Gadget.search_disabled = true
+    gadget = Gadget.create(:name => "flipvideo mino")
+    assert_equal 0, Gadget.find_id_by_solr('flipvideo').total
+  end
+end