acts_as_solr 1.0.0

data/test/models/book.rb

@@ -0,0 +1,10 @@
+# Table fields for 'books'
+# - id
+# - category_id
+# - name
+# - author
+
+class Book < ActiveRecord::Base
+  belongs_to :category
+  acts_as_solr :include => [:category]
+end

data/test/models/category.rb

@@ -0,0 +1,8 @@
+# Table fields for 'categories'
+# - id
+# - name
+
+class Category < ActiveRecord::Base
+  has_many :books
+  acts_as_solr :include => [:books]
+end

data/test/models/electronic.rb

@@ -0,0 +1,21 @@
+# Table fields for 'electronics'
+# - id
+# - name
+# - manufacturer
+# - features
+# - category
+# - price
+# - created_on
+
+class Electronic < ActiveRecord::Base
+  acts_as_solr :facets => [:category, :manufacturer],
+               :fields => [:name, :manufacturer, :features, :category, {:created_at => :date}, {:updated_at => :date}, {:price => {:type => :range_float, :boost => 10.0}}],
+               :boost  => 5.0, 
+               :exclude_fields => [:features]
+
+  # The following example would also convert the :price field type to :range_float
+  # 
+  # acts_as_solr :facets => [:category, :manufacturer],
+  #              :fields => [:name, :manufacturer, :features, :category, {:price => :range_float}],
+  #              :boost  => 5.0
+end

data/test/models/gadget.rb

@@ -0,0 +1,9 @@
+class Gadget < ActiveRecord::Base
+  cattr_accessor :search_disabled
+  
+  acts_as_solr :offline => proc {|record| Gadget.search_disabled?}, :format => :ids
+  
+  def self.search_disabled?
+    search_disabled
+  end
+end

data/test/models/movie.rb

@@ -0,0 +1,17 @@
+# Table fields for 'movies'
+# - id
+# - name
+# - description
+
+class Movie < ActiveRecord::Base
+  acts_as_solr :additional_fields => [:current_time, {:time_on_xml => :date}]
+  
+  def current_time
+    Time.now.to_s
+  end
+  
+  def time_on_xml
+    Time.now
+  end
+  
+end

data/test/models/novel.rb

@@ -0,0 +1,2 @@
+class Novel < Book
+end

data/test/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  acts_as_solr
+end

data/test/models/posting.rb

@@ -0,0 +1,11 @@
+# Table fields for 'movies'
+# - guid
+# - name
+# - description
+
+class Posting < ActiveRecord::Base
+
+  set_primary_key 'guid'
+  acts_as_solr({},{:primary_key_field => 'pk_s'})
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+
+begin
+  require 'active_support/test_case'
+rescue
+end
+
+RAILS_ROOT = File.dirname(__FILE__) unless defined? RAILS_ROOT
+RAILS_ENV  = 'test' unless defined? RAILS_ENV
+
+require File.dirname(__FILE__) + '/../lib/acts_as_solr'
+require File.dirname(__FILE__) + '/../config/solr_environment.rb'
+
+# Load Models
+models_dir = File.join(File.dirname( __FILE__ ), 'models')
+Dir[ models_dir + '/*.rb'].each { |m| require m }
+
+if defined?(ActiveSupport::TestCase)
+  class ActiveSupport::TestCase
+    include ActiveRecord::TestFixtures
+    self.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+  end unless ActiveSupport::TestCase.respond_to?(:fixture_path=)
+else
+  Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+end
+
+class Test::Unit::TestCase
+  def self.fixtures(*table_names)
+    fixture_path = defined?(ActiveSupport::TestCase) ? ActiveSupport::TestCase.fixture_path : Test::Unit::TestCase.fixture_path
+    if block_given?
+      Fixtures.create_fixtures(fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(fixture_path, table_names)
+    end
+    table_names.each do |table_name|
+      clear_from_solr(table_name)
+      klass = instance_eval table_name.to_s.capitalize.singularize
+      klass.find(:all).each{|content| content.solr_save}
+    end
+    
+    clear_from_solr(:novels)
+  end
+  
+  private
+  def self.clear_from_solr(table_name)
+    ActsAsSolr::Post.execute(Solr::Request::Delete.new(:query => "type_s:#{table_name.to_s.capitalize.singularize}"))
+  end
+end

data/test/unit/acts_methods_shoulda.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'acts_methods'
+require 'mocha'
+
+class ActsMethodsTest < Test::Unit::TestCase
+  class Model
+    attr_accessor :birthdate
+    
+    def initialize(birthdate)
+      @birthdate = birthdate
+    end
+    
+    def self.configuration
+      @configuration ||= {:solr_fields => {}}
+    end
+
+    def self.columns_hash=(columns_hash)
+      @columns_hash = columns_hash
+    end
+    
+    def self.columns_hash
+      @columns_hash
+    end
+    
+    def [](key)
+      @birthday
+    end
+    
+    self.extend ActsAsSolr::ActsMethods
+  end
+  
+  
+  context "when getting field values" do
+    setup do
+      Model.columns_hash = {"birthdate" => stub("column", :type => :date)}
+      Model.send(:get_field_value, :birthdate)
+    end
+    
+    should "define an accessor methods for a solr converted value" do
+      assert Model.instance_methods.include?("birthdate_for_solr")
+    end
+    
+    context "for date types" do
+      setup do
+        @model = Model.new(Date.today)
+      end
+      
+      should "return nil when field is nil" do
+        @model.birthdate = nil
+        assert_nil @model.birthdate_for_solr
+      end
+      
+      should "return the formatted date" do
+        assert_equal Date.today.strftime("%Y-%m-%dT%H:%M:%SZ"), @model.birthdate_for_solr
+      end
+    end
+    
+    context "for timestamp types" do
+      setup do
+        @now = Time.now
+        @model = Model.new(@now)
+      end
+      
+      should "return a formatted timestamp string for timestamps" do
+        assert_equal @now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"), @model.birthdate_for_solr
+      end
+    end
+  end
+  
+end

data/test/unit/class_methods_shoulda.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'class_methods'
+require 'search_results'
+require 'active_support'
+
+class User
+  attr_accessor :name, :id
+  def self.find(*args)
+    @paul ||= User.new
+    @paul.name = "Paul"
+    @paul.id = 1
+    @paul
+  end
+  
+  def self.find_by_id(id)
+    find
+  end
+  
+  def self.primary_key
+    "id"
+  end
+end
+
+class ClassMethodsTest < Test::Unit::TestCase
+  include ActsAsSolr::ClassMethods
+  
+  def solr_configuration
+    @solr_configuration ||= {:type_field => "type_t", :primary_key_field => "id"}
+  end
+  
+  context "when multi-searching" do
+    setup do
+      stubs(:name).returns("User")
+    end
+    
+    should "include the type field in the query" do
+      expects(:parse_query).with("name:paul", {:results_format => :objects}, "AND (type_t:User)")
+      multi_solr_search("name:paul")
+    end
+    
+    should "add all models in the query" do
+      expects(:parse_query).with("name:paul", {:results_format => :objects, :models => ["Movie", "DVD"]}, "AND (type_t:User OR type_t:Movie OR type_t:DVD)")
+      multi_solr_search("name:paul", :models => ["Movie", "DVD"])
+    end
+    
+    should "return an empty result set if no data was returned" do
+      stubs(:parse_query).returns(nil)
+      result = multi_solr_search("name:paul")
+      assert_equal 0, result.docs.size
+    end
+    
+    should "return an empty result set if no results were found" do
+      stubs(:parse_query).returns(stub(:total_hits => 0, :hits => []))
+      result = multi_solr_search("name:paul")
+      assert_equal 0, result.docs.size
+    end
+    
+    context "with results" do
+      should "find the objects in the database" do
+        stubs(:parse_query).returns(stub(:total_hits => 1, :hits => ["score" => 0.12956427, "id" => ["User:1"]]))
+        result = multi_solr_search("name:paul")
+        
+        assert_equal(User.find, result.docs.first)
+        assert_equal 1, result.docs.size
+      end
+      
+      context "when requesting ids" do
+        should "return only ids" do
+          loudly do
+            stubs(:parse_query).returns(stub(:total_hits => 1, :hits => ["score" => 0.12956427, "id" => ["User:1"]]))
+            result = multi_solr_search("name:paul", :results_format => :ids)
+            assert_equal "User:1", result.docs.first["id"]
+          end
+        end
+      end
+      
+      context "with scores" do
+        setup do
+          solr_configuration[:primary_key_field] = nil
+        end
+        
+        should "add an accessor with the solr score" do
+          stubs(:parse_query).returns(stub(:total_hits => 1, :hits => ["score" => 0.12956427, "id" => ["User:1"]]))
+          result = multi_solr_search("name:paul", :scores => true)
+          assert_equal 0.12956427, result.docs.first.solr_score
+        end
+      end
+    end
+  end
+end

data/test/unit/common_methods_shoulda.rb

@@ -0,0 +1,112 @@
+require 'test_helper'
+require 'common_methods'
+
+class CommonMethodsTest < Test::Unit::TestCase
+  include ActsAsSolr::CommonMethods
+  
+  class << self
+    def primary_key
+      "id"
+    end
+  end
+  
+  def id
+    10
+  end
+  
+  context "when determining the field type" do
+    setup do
+    end
+    
+    should "return i for an integer" do
+      assert_equal "i", get_solr_field_type(:integer)
+    end
+    
+    should "return f for a float" do
+      assert_equal "f", get_solr_field_type(:float)
+    end
+    
+    should "return b for a boolean" do
+      assert_equal "b", get_solr_field_type(:boolean)
+    end
+    
+    should "return s for a string" do
+      assert_equal "s", get_solr_field_type(:string)
+    end
+    
+    should "return t for a text" do
+      assert_equal "t", get_solr_field_type(:text)
+    end
+    
+    should "return d for a date" do
+      assert_equal "d", get_solr_field_type(:date)
+    end
+    
+    should "return ri for a range_integer" do
+      assert_equal "ri", get_solr_field_type(:range_integer)
+    end
+    
+    should "return rf for a range_float" do
+      assert_equal "rf", get_solr_field_type(:range_float)
+    end
+    
+    should "return facet for a facet field" do
+      assert_equal "facet", get_solr_field_type(:facet)
+    end
+    
+    should "return the string if one was given as an argument" do
+      assert_equal "string", get_solr_field_type("string")
+    end
+    
+    should "raise an error if invalid field type was specified" do
+      assert_raise(RuntimeError) {get_solr_field_type(:something)}
+    end
+    
+    should "raise an error if argument is not symbol or string" do
+      assert_raise(RuntimeError) {get_solr_field_type(123)}
+    end
+  end
+  
+  context "when determining a default value for a field when it's nil" do
+    should "return 0.00 for a float" do
+      assert_equal 0.00, set_value_if_nil("f")
+      assert_equal 0.00, set_value_if_nil(:float)
+      assert_equal 0.00, set_value_if_nil("rf")
+      assert_equal 0.00, set_value_if_nil(:range_float)
+    end
+    
+    should "return 0 for an integer" do
+      assert_equal 0, set_value_if_nil(:integer)
+      assert_equal 0, set_value_if_nil(:range_integer)
+      assert_equal 0, set_value_if_nil("i")
+      assert_equal 0, set_value_if_nil("ri")
+    end
+    
+    should "return false for a boolean" do
+      assert_equal "false", set_value_if_nil(:boolean)
+      assert_equal "false", set_value_if_nil("b") 
+    end
+    
+    should "return empty string for strings and text" do
+      assert_equal "", set_value_if_nil(:string)
+      assert_equal "", set_value_if_nil(:text)
+      assert_equal "", set_value_if_nil("t")
+      assert_equal "", set_value_if_nil("s")
+    end
+    
+    should "return an empty string for a date" do
+      assert_equal "", set_value_if_nil(:date)
+      assert_equal "", set_value_if_nil("d")
+    end
+    
+    should "return an empty string for everything else" do
+      assert_equal "", set_value_if_nil("something")
+    end
+  end
+  
+  context "when determining the record id" do
+    should "return the primary key value" do
+      assert_equal 10, record_id(self)
+    end
+  end
+end