acts_as_indexed 0.6.2 → 0.6.3

data/CHANGELOG

@@ -1,3 +1,9 @@
+===0.6.3 [5th July 2010]
+ - index file path can now be definited as a Pathname as well as an array. [parndt]
+ - Can now define which records are indexed and which are not via an :if proc. [madpilot]
+ - Lots of tidying up. [parndt]
+ - Rails 3 fixes. [myabc]
+
 ===0.6.2 [11th June 2010]
  - Now available as a Gem as well as the original plugin. [parndt - Thanks for doing most of the hard work.]
 

data/README.rdoc

@@ -1,16 +1,16 @@
 = acts_as_indexed
 
-If you find this plugin useful, please consider a donation to show your 
+If you find this plugin useful, please consider a donation to show your
 support!
 
 http://www.paypal.com/cgi-bin/webscr?cmd=_send-money
-  
+
 Paypal address: mailto:dougal.s@gmail.com
-  
+
 
 == Instructions
 
-This plugin allows boolean-queried fulltext search to be added to any Rails 
+This plugin allows boolean-queried fulltext search to be added to any Rails
 app with no dependencies and minimal setup.
 
 
@@ -25,19 +25,19 @@ app with no dependencies and minimal setup.
   rails plugin install git://github.com/dougal/acts_as_indexed.git
 
 === As a Gem
-Despite this being slightly against the the original ethos of the project, 
+Despite this being slightly against the the original ethos of the project,
 acts_as_indexed is now available as a Gem as several people have requested it.
-  
+
   gem install acts_as_indexed
-  
+
 Make sure to specify the Gem in your environment.rb file (Rails 2.x.x), or the Gemfile (Rails 3.x.x).
 
-If you don't have git installed, you can download the plugin from the GitHub 
-page (http://github.com/dougal/acts_as_indexed) and unpack it into the 
-<tt>vendor/plugins</tt> directory of your rails app. 
+If you don't have git installed, you can download the plugin from the GitHub
+page (http://github.com/dougal/acts_as_indexed) and unpack it into the
+<tt>vendor/plugins</tt> directory of your rails app.
 
-== Usage
 
+== Usage
 
 === Setup
 
@@ -46,7 +46,7 @@ list of the fields you wish to be indexed.
 
   class Post < ActiveRecord::Base
     acts_as_indexed :fields => [:title, :body]
-  
+
     ...
   end
 
@@ -62,22 +62,33 @@ the current model.
 
     ...
   end
-  
+
 Any of the configuration options in the Further Configuration section can be added as to the acts_as_indexed method call. These will override any defaults or global configuration.
 
+You can specify proc that needs to evaluate to true before the item gets indexed.
+This is useful if you only want items with a certain state to be included.
+The Proc is passed the current object's instance so you are able to test against that.
+
+For example, if you have a visible column that is false if the post is hidden, or true
+if it is visible, you can filter the index by doing:
+
+  class Post < ActiveRecord::Base
+    acts_as_indexed :fields => [:title, :body], :if => Proc.new { |post| post.visible? }
+    ...
+  end
 
 === Searching
 
-To search, call the +with_query+ named scope on your model, passing a query as 
+To search, call the +with_query+ named scope on your model, passing a query as
 an argument.
 
   # Returns array of Post objects.
   my_search_results = Post.with_query('my search query')
-  
+
   # Chain it with any number of ActiveRecord methods and named_scopes.
   my_search_results = Post.public.with_query('my search query').find(:all, :limit => 10) # return the first 10 matches which are public.
-  
-  
+
+
 === Query Options
 
 The following query operators are supported:
@@ -89,7 +100,7 @@ The following query operators are supported:
 
 === Pagination
 
-Since +with_query+ is a named scope, WillPaginate can be used in the normal 
+Since +with_query+ is a named scope, WillPaginate can be used in the normal
 fashion.
 
   @images = Image.with_query('girl').paginate(:page => 1, :per_page => 5)
@@ -108,15 +119,17 @@ Example showing defaults:
 A full rundown of the available configuration options can be found in
 <tt>lib/acts_as_indexed/configuration.rb</tt>
 
+
 == RDoc Documentation
 
 To generate the RDoc documentation, run the <tt>rake rdoc</tt> task in the
 acts_as_indexed plugin folder. Then point your web browser at
 <tt>vendor/plugins/acts_as_indexed/rdoc/index.html</tt>.
 
-Alternatively, you can view the rdoc documentation 
+Alternatively, you can view the rdoc documentation
 online[http://rdoc.info/projects/dougal/acts_as_indexed/].
 
+
 == Problems, Comments, Suggestions?
 
 All of the above are most welcome. mailto:dougal.s@gmail.com
@@ -133,5 +146,5 @@ Future releases will be looking to add the following features:
 * Optional html scrubbing during indexing.
 * Ranking affected by field weightings.
 * Support for DataMapper, Sequel and the various MongoDB ORMs.
-* UTF-8 support. See the current solution here: 
+* UTF-8 support. See the current solution here:
 https://gist.github.com/193903bb4e0d6e5debe1

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.3

data/acts_as_indexed.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_indexed}
-  s.version = "0.6.2"
+  s.version = "0.6.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Douglas F Shearer"]
-  s.date = %q{2010-06-11}
+  s.date = %q{2010-07-05}
   s.description = %q{Acts As Indexed is a plugin which provides a pain-free way to add fulltext search to your Ruby on Rails app}
   s.email = %q{dougal.s@gmail.com}
   s.extra_rdoc_files = [

data/lib/acts_as_indexed/configuration.rb

@@ -6,36 +6,56 @@
 module ActsAsIndexed
   # Used to set up and modify settings for acts_as_indexed.
   class Configuration
-    
+
     # Sets the location for the index. Specify as an array. Heroku, for
     # example would use RAILS_ROOT/tmp/index, which would be set as
     # [Rails.root,'tmp','index]
     attr_accessor :index_file
-    
+
     # Tuning value for the index partitioning. Larger values result in quicker
     # searches, but slower indexing. Default is 3.
     attr_reader :index_file_depth
-    
+
     # Sets the minimum length for a word in a query. Words shorter than this
     # value are ignored in searches unless preceded by the '+' operator.
     # Default is 3.
     attr_reader :min_word_size
-    
+
+    # Proc that allows you to turn on or off index for a record.
+    # Useful if you don't want the index to be updated if the target model is
+    # should not return up in results, such as a draft post.
+    attr_accessor :if_proc
+
     def initialize
-      @index_file = [Rails.root, 'index']
+      @index_file = Rails.root.join('index') if Rails.root
       @index_file_depth = 3
       @min_word_size = 3
+      @if_proc = if_proc
+    end
+
+    def index_file=(file_path)
+      # Under the old syntax this was an array of path parts.
+      # If this is still using the array then rewrite to a Pathname.
+      if file_path.is_a?(Pathname)
+        @index_file = file_path
+      else
+        @index_file = Pathname.new(file_path.collect{|part| part.to_s}.join(File::SEPARATOR))
+      end
     end
-    
+
     def index_file_depth=(val)
       raise(ArgumentError, 'index_file_depth cannot be less than one (1)') if val < 1
       @index_file_depth = val
     end
-    
+
     def min_word_size=(val)
       raise(ArgumentError, 'min_word_size cannot be less than one (1)') if val < 1
       @min_word_size = val
     end
-    
+
+    def if_proc
+      @if_proc ||= Proc.new{true}
+    end
+
   end
-end
+end

data/lib/acts_as_indexed/search_atom.rb

@@ -25,7 +25,7 @@ module ActsAsIndexed #:nodoc:
 
     # Adds +record_id+ to the stored records.
     def add_record(record_id)
-      @records[record_id] = [] if !include_record?(record_id)
+      @records[record_id] = [] unless include_record?(record_id)
     end
 
     # Adds +pos+ to the array of positions for +record_id+.
@@ -64,7 +64,7 @@ module ActsAsIndexed #:nodoc:
         pos.each do |p|
           # Check if previous position is in former.
           if former.include_position?(record_id,p-1)
-            matches.add_record(record_id) if !matches.include_record?(record_id)
+            matches.add_record(record_id) unless matches.include_record?(record_id)
             matches.add_position(record_id,p)
           end
         end

data/lib/acts_as_indexed/search_index.rb

@@ -6,21 +6,24 @@
 module ActsAsIndexed #:nodoc:
   class SearchIndex
 
-    # root:: Location of index on filesystem.
+    # root:: Location of index on filesystem as a Pathname.
     # index_depth:: Degree of index partitioning.
     # fields:: Fields or instance methods of ActiveRecord model to be indexed.
     # min_word_size:: Smallest query term that will be run through search.
-    def initialize(root, index_depth, fields, min_word_size)
-      @root = root
+    # if_proc:: A Proc. If the proc is true, the index gets added, if false if doesn't
+    def initialize(root, index_depth, fields, min_word_size, if_proc=Proc.new{true})
+      @root = Pathname.new(root.to_s)
       @fields = fields
       @index_depth = index_depth
       @atoms = {}
       @min_word_size = min_word_size
       @records_size = exists? ? load_record_size : 0
+      @if_proc = if_proc
     end
 
     # Adds +record+ to the index.
     def add_record(record)
+      return @records_size unless @if_proc.call(record)
       condensed_record = condense_record(record)
       load_atoms(condensed_record)
       add_occurences(condensed_record,record.id)
@@ -57,11 +60,13 @@ module ActsAsIndexed #:nodoc:
         @atoms[a].remove_record(record_new.id) if @atoms.has_key?(a)
       end
 
-      # Add the new version to the appropriate atoms.
-      load_atoms(new_atoms)
-      # TODO: Make a version of this method that takes the
-      # atomised version of the record.
-      add_occurences(new_atoms, record_new.id)
+      if @if_proc.call(record_new)
+        # Add the new version to the appropriate atoms.
+        load_atoms(new_atoms)
+        # TODO: Make a version of this method that takes the
+        # atomised version of the record.
+        add_occurences(new_atoms, record_new.id)
+      end
     end
 
     # Saves the current index partitions to the filesystem.
@@ -69,13 +74,11 @@ module ActsAsIndexed #:nodoc:
       prepare
       atoms_sorted = {}
       @atoms.each do |atom_name, records|
-        e_p = encoded_prefix(atom_name)
-        atoms_sorted[e_p] = {} if !atoms_sorted.has_key?(e_p)
-        atoms_sorted[e_p][atom_name] = records
+        (atoms_sorted[encoded_prefix(atom_name)] ||= {})[atom_name] = records
       end
       atoms_sorted.each do |e_p, atoms|
         #p "Saving #{e_p}."
-        File.open(File.join(@root + [e_p.to_s]),'w+') do |f|
+        @root.join(e_p.to_s).open("w+") do |f|
           Marshal.dump(atoms,f)
         end
       end
@@ -86,8 +89,7 @@ module ActsAsIndexed #:nodoc:
     #--
     # TODO: Write a public method that will delete all indexes.
     def destroy
-      FileUtils.rm_rf(@root)
-      true
+      @root.delete
     end
 
     # Returns an array of IDs for records matching +query+.
@@ -100,11 +102,11 @@ module ActsAsIndexed #:nodoc:
       negative = run_queries(queries[:negative])
       negative_quoted = run_quoted_queries(queries[:negative_quoted])
 
-      if !queries[:positive].empty? && !queries[:positive_quoted].empty?
-        p = positive.delete_if{ |r_id,w| !positive_quoted.include?(r_id) }
-        pq = positive_quoted.delete_if{ |r_id,w| !positive.include?(r_id) }
+      if queries[:positive_quoted].any? && queries[:positive].any?
+        p = positive.delete_if{ |r_id,w| positive_quoted.exclude?(r_id) }
+        pq = positive_quoted.delete_if{ |r_id,w| positive.exclude?(r_id) }
         results = p.merge(pq) { |r_id,old_val,new_val| old_val + new_val}
-      elsif !queries[:positive].empty?
+      elsif queries[:positive].any?
         results = positive
       else
         results = positive_quoted
@@ -120,21 +122,22 @@ module ActsAsIndexed #:nodoc:
     #--
     # TODO: Make a private method called 'root_exists?' which checks for the root directory.
     def exists?
-      File.exists?(File.join(@root + ['size']))
+      @root.join('size').exist?
     end
 
     private
 
     # Gets the size file from the index.
     def load_record_size
-      File.open(File.join(@root + ['size'])) do |f|
-        (Marshal.load(f))
+      #p "About to load #{@root.join('size')}"
+      @root.join('size').open do |f|
+        Marshal.load(f)
       end
     end
 
     # Saves the size to the size file.
     def save_record_size
-      File.open(File.join(@root + ['size']),'w+') do |f|
+      @root.join('size').open('w+') do |f|
         Marshal.dump(@records_size,f)
       end
     end
@@ -147,7 +150,7 @@ module ActsAsIndexed #:nodoc:
     # Returns true if all the given atoms are present.
     def include_atoms?(atoms_arr)
       atoms_arr.each do |a|
-        return false if !include_atom?(a)
+        return false unless include_atom?(a)
       end
       true
     end
@@ -160,7 +163,7 @@ module ActsAsIndexed #:nodoc:
     end
 
     def add_atom(atom)
-      @atoms[atom] = SearchAtom.new if !include_atom?(atom)
+      @atoms[atom] = SearchAtom.new unless include_atom?(atom)
     end
 
     def add_occurences(condensed_record,record_id)
@@ -173,10 +176,8 @@ module ActsAsIndexed #:nodoc:
 
     def encoded_prefix(atom)
       prefix = atom[0,@index_depth]
-      if !@prefix_cache || !@prefix_cache.has_key?(prefix)
-        @prefix_cache = {} if !@prefix_cache
-        len = atom.length
-        if len > 1
+      unless (@prefix_cache ||= {}).has_key?(prefix)
+        if atom.length > 1
           @prefix_cache[prefix] = prefix.split(//).map{|c| encode_character(c)}.join('_')
         else
           @prefix_cache[prefix] = encode_character(atom)
@@ -261,7 +262,7 @@ module ActsAsIndexed #:nodoc:
         #   return atom containing records + positions where current atom is preceded by following atom.
         # end
         # return records from final atom.
-        next if !include_atoms?(quoted_atom)
+        next unless include_atoms?(quoted_atom)
         matches = @atoms[quoted_atom.first]
         quoted_atom[1..-1].each do |atom_name|
           matches = @atoms[atom_name].preceded_by(matches)
@@ -290,8 +291,8 @@ module ActsAsIndexed #:nodoc:
       # Calculate prefixes.
       # Remove duplicate prefixes.
       atoms.uniq.reject{|a| include_atom?(a)}.collect{|a| encoded_prefix(a)}.uniq.each do |name|
-        if File.exists?(File.join(@root + [name.to_s]))
-          File.open(File.join(@root + [name.to_s])) do |f|
+        if (atom_file = @root.join(name.to_s)).exist?
+          atom_file.open do |f|
             @atoms.merge!(Marshal.load(f))
           end
         end
@@ -299,27 +300,25 @@ module ActsAsIndexed #:nodoc:
     end
 
     def prepare
-      # Makes the RAILS_ROOT/index directory
-      Dir.mkdir(File.join(@root[0,2])) if !File.exists?(File.join(@root[0,2]))
-      # Makes the RAILS_ROOT/index/ENVIRONMENT directory
-      Dir.mkdir(File.join(@root[0,3])) if !File.exists?(File.join(@root[0,3]))
-      # Makes the RAILS_ROOT/index/ENVIRONMENT/CLASS directory
-      Dir.mkdir(File.join(@root)) if !File.exists?(File.join(@root))
+      # Makes the RAILS_ROOT/index/ENVIRONMENT/CLASS directories
+      @root.mkpath
     end
 
     def cleanup_atoms(s, limit_size=false, min_size = @min_word_size || 3)
       atoms = s.downcase.gsub(/\W/,' ').squeeze(' ').split
-      return atoms if !limit_size
+      return atoms unless limit_size
       atoms.reject{|w| w.size < min_size}
     end
 
     def condense_record(record)
-      record_condensed = ''
+      condensed = []
       @fields.each do |f|
-        record_condensed += ' ' + record.send(f).to_s if record.send(f)
+        if (value = record.send(f)).present?
+          condensed << value.to_s
+        end
       end
-      cleanup_atoms(record_condensed)
+      cleanup_atoms(condensed.join(' '))
     end
 
   end
-end
+end

data/lib/acts_as_indexed.rb

@@ -10,13 +10,13 @@ require 'acts_as_indexed/search_index'
 require 'acts_as_indexed/search_atom'
 
 module ActsAsIndexed #:nodoc:
-  
+
   # Holds the default configuration for acts_as_indexed.
-  
+
   @configuration = Configuration.new
 
   # Returns the current configuration for acts_as_indexed.
-  
+
   def self.configuration
     @configuration
   end
@@ -29,7 +29,7 @@ module ActsAsIndexed #:nodoc:
   #     config.index_file_depth = 3
   #     config.min_word_size = 3
   #   end
-  
+
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
@@ -52,7 +52,7 @@ module ActsAsIndexed #:nodoc:
     # min_word_size:: Sets the minimum length for a word in a query. Words
     #                 shorter than this value are ignored in searches
     #                 unless preceded by the '+' operator. Default is 3.
-    # index_file:: Sets the location for the index. By default this is 
+    # index_file:: Sets the location for the index. By default this is
     #              RAILS_ROOT/index. Specify as an array. Heroku, for
     #              example would use RAILS_ROOT/tmp/index, which would be
     #              set as [Rails.root,'tmp','index]
@@ -64,7 +64,7 @@ module ActsAsIndexed #:nodoc:
       include ActsAsIndexed::InstanceMethods
 
       after_create  :add_to_index
-      before_update  :update_index
+      before_update :update_index
       after_destroy :remove_from_index
 
       # scope for Rails 3.x, named_scope for Rails 2.x.
@@ -73,24 +73,27 @@ module ActsAsIndexed #:nodoc:
       else
         named_scope :with_query, lambda { |query| { :conditions => ["#{table_name}.id IN (?)", search_index(query, {}, {:ids_only => true}) ] } }
       end
-            
+
       cattr_accessor :aai_config, :aai_fields
 
       self.aai_fields = options.delete(:fields)
       raise(ArgumentError, 'no fields specified') if self.aai_fields.nil? || self.aai_fields.empty?
-      
+
       self.aai_config = ActsAsIndexed.configuration.dup
+      self.aai_config.if_proc = options.delete(:if)
       options.each do |k, v|
         self.aai_config.send("#{k}=", v)
       end
-      self.aai_config.index_file += [Rails.env, self.name]
+
+      # Add the Rails environment and this model's name to the index file path.
+      self.aai_config.index_file = self.aai_config.index_file.join(Rails.env, self.name)
     end
 
     # Adds the passed +record+ to the index. Index is built if it does not already exist. Clears the query cache.
 
     def index_add(record)
-      build_index if !File.exists?(File.join(aai_config.index_file))
-      index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size)
+      build_index unless aai_config.index_file.directory?
+      index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size, aai_config.if_proc)
       index.add_record(record)
       index.save
       @query_cache = {}
@@ -100,22 +103,22 @@ module ActsAsIndexed #:nodoc:
     # Removes the passed +record+ from the index. Clears the query cache.
 
     def index_remove(record)
-      index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size)
+      index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size, aai_config.if_proc)
       # record won't be in index if it doesn't exist. Just return true.
-      return true if !index.exists?
+      return true unless index.exists?
       index.remove_record(record)
       index.save
       @query_cache = {}
       true
     end
-    
+
     # Updates the index.
     # 1. Removes the previous version of the record from the index
     # 2. Adds the new version to the index.
-    
+
     def index_update(record)
-      build_index if !File.exists?(File.join(aai_config.index_file))
-      index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size)
+      build_index unless aai_config.index_file.directory?
+      index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size, aai_config.if_proc)
       #index.remove_record(find(record.id))
       #index.add_record(record)
       index.update_record(record,find(record.id))
@@ -133,7 +136,7 @@ module ActsAsIndexed #:nodoc:
     #
     # ====find_options
     # Same as ActiveRecord#find options hash. An :order key will override
-    # the relevance ranking 
+    # the relevance ranking
     #
     # ====options
     # ids_only:: Method returns an array of integer IDs when set to true.
@@ -144,30 +147,29 @@ module ActsAsIndexed #:nodoc:
       @query_cache = {}  if (options.has_key?('no_query_cache') || options[:no_query_cache])
       if !@query_cache || !@query_cache[query]
         logger.debug('Query not in cache, running search.')
-        build_index if !File.exists?(File.join(aai_config.index_file))
-        index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size)
-        @query_cache = {} if !@query_cache
-        @query_cache[query] = index.search(query)
+        build_index unless aai_config.index_file.directory?
+        index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size, aai_config.if_proc)
+        (@query_cache ||= {})[query] = index.search(query)
       else
         logger.debug('Query held in cache.')
       end
       return @query_cache[query].sort.reverse.map(&:first) if options[:ids_only] || @query_cache[query].empty?
-      
+
       # slice up the results by offset and limit
       offset = find_options[:offset] || 0
       limit = find_options.include?(:limit) ? find_options[:limit] : @query_cache[query].size
       part_query = @query_cache[query].sort.reverse.slice(offset,limit).map(&:first)
-      
+
       # Set these to nil as we are dealing with the pagination by setting
       # exactly what records we want.
       find_options[:offset] = nil
       find_options[:limit] = nil
-      
+
       with_scope :find => find_options do
         # Doing the find like this eliminates the possibility of errors occuring
         # on either missing records (out-of-sync) or an empty results array.
         records = find(:all, :conditions => [ "#{table_name}.id IN (?)", part_query])
-        
+
         if find_options.include?(:order)
          records # Just return the records without ranking them.
        else
@@ -176,11 +178,11 @@ module ActsAsIndexed #:nodoc:
          records.each do |r|
            ranked_records[r] = @query_cache[query][r.id]
          end
-      
+
          ranked_records.to_a.sort_by{|a| a.last }.reverse.map(&:first)
        end
       end
-      
+
     end
 
     private
@@ -191,7 +193,7 @@ module ActsAsIndexed #:nodoc:
       offset = 0
       while (records = find(:all, :limit => increment, :offset => offset)).size > 0
         #p "offset is #{offset}, increment is #{increment}"
-        index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size)
+        index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size, aai_config.if_proc)
         offset += increment
         index.add_records(records)
         index.save
@@ -245,4 +247,4 @@ end
 
 ActiveRecord::Base.class_eval do
   include ActsAsIndexed
-end
+end

data/lib/will_paginate_search.rb

@@ -2,20 +2,20 @@
 # Copyright (c) 2007 - 2010 Douglas F Shearer.
 # http://douglasfshearer.com
 
-module WillPaginate
+module ActsAsIndexed
 
-  module Finder
+   module WillPaginate
 
-    module ClassMethods
+     module Search
 
       # DEPRECATED. Use chained pagination instead.
       def paginate_search(query, options)
         warn "[DEPRECATION] `paginate_search` is deprecated and will be removed in a later release. Use `with_query(query).paginate()` instead."
         page, per_page, total_entries = wp_parse_options(options)
-        
+
         total_entries ||= find_with_index(query,{},{:ids_only => true}).size
 
-        returning WillPaginate::Collection.new(page, per_page, total_entries) do |pager|
+        returning ::WillPaginate::Collection.new(page, per_page, total_entries) do |pager|
           options.update :offset => pager.offset, :limit => pager.per_page
 
           options = options.delete_if {|key, value| [:page, :per_page].include?(key) }
@@ -27,3 +27,7 @@ module WillPaginate
     end
   end
 end
+
+class ActiveRecord::Base
+  extend ActsAsIndexed::WillPaginate::Search
+end

data/test/abstract_unit.rb

@@ -9,44 +9,45 @@ require 'mocha'
 # Do this before requiring AAI.
 class Rails
   def self.root
-    Dir.pwd
+    Pathname.new(Dir.pwd)
   end
   def self.env
     'test'
   end
 end
 
-require File.dirname(__FILE__) + '/../lib/acts_as_indexed'
+test_path = Pathname.new(File.expand_path('../', __FILE__))
+require test_path.parent.join('lib', 'acts_as_indexed').to_s
 
-ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/test.log')
-ActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(test_path.join('test.log').to_s)
+ActiveRecord::Base.configurations = YAML::load(IO.read(test_path.join('database.yml').to_s))
 ActiveRecord::Base.establish_connection(ENV['DB'] || 'sqlite3')
 
 # Load Schema
-load(File.dirname(__FILE__) + '/schema.rb')
+load(test_path.join('schema.rb').to_s)
 
 # Load model.
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/fixtures/')
+$LOAD_PATH.unshift(test_path.join('fixtures').to_s)
 
 class ActiveSupport::TestCase #:nodoc:
   include ActiveRecord::TestFixtures
-  self.fixture_path = File.dirname(__FILE__) + '/fixtures/'
+  self.fixture_path = Pathname.new(File.expand_path('../', __FILE__)).join('fixtures').to_s
   self.use_transactional_fixtures = true
   self.use_instantiated_fixtures  = false
-  
+
   def destroy_index
     `rm -rdf #{index_loc}`
   end
-  
+
   def build_index
     # Makes a query to invoke the index build.
     assert_equal [], Post.find_with_index('badger')
-    assert File.exists?(index_loc)
+    assert index_loc.exist?
     true
   end
-  
+
   def index_loc
-    File.join(Rails.root,'index')
+    Rails.root.join('index')
   end
-  
+
 end

data/test/acts_as_indexed_test.rb

@@ -1,9 +1,11 @@
-require File.dirname(__FILE__) + '/abstract_unit'
+require File.expand_path("../abstract_unit", __FILE__)
 
 class ActsAsIndexedTest < ActiveSupport::TestCase
   fixtures :posts
 
   def teardown
+    # need to do this to work with the :if Proc tests.
+    Post.acts_as_indexed :fields => [:title, :body]
     destroy_index
   end
 
@@ -49,7 +51,7 @@ class ActsAsIndexedTest < ActiveSupport::TestCase
     p = Post.create(:title => 'A special title', :body => 'foo bar bla bla bla')
     assert Post.find_with_index('title',{},{:ids_only => true}).include?(p.id)
     p.update_attributes(:title => 'No longer special')
-    assert !Post.find_with_index('title',{},{:ids_only => true}).include?(p.id)
+    assert Post.find_with_index('title',{},{:ids_only => true}).exclude?(p.id)
   end
 
   def test_simple_queries
@@ -120,14 +122,76 @@ class ActsAsIndexedTest < ActiveSupport::TestCase
     assert_equal all_results[1], second_result.first.id
   end
 
-  # When a atom already in a record is duplicated, it removes 
+  # When a atom already in a record is duplicated, it removes
   # all records with that same atom from the index.
   def test_update_record_bug
-    assert_equal 2, Post.find_with_index('crane',{},{:ids_only => true}).size
     p = Post.find(6)
     assert p.update_attributes(:body => p.body + ' crane')
     assert_equal 2, Post.find_with_index('crane',{},{:ids_only => true}).size
     assert_equal 2, Post.find_with_index('ship',{},{:ids_only => true}).size
   end
-  
+
+  # If an if proc is supplied, the index should only be created if the proc evaluated true
+  def test_create_if
+    Post.acts_as_indexed :fields => [:title, :body], :if => Proc.new { |post| post.visible }
+
+    original_post_count = Post.count
+    assert_equal [], Post.find_with_index('badger')
+    p = Post.new(:title => 'badger', :body => 'thousands of them!', :visible => true)
+    assert p.save
+    assert_equal original_post_count + 1, Post.count
+    assert_equal [p.id], Post.find_with_index('badger', {}, { :no_query_cache => true, :ids_only => true})
+
+    original_post_count = Post.count
+    assert_equal [], Post.find_with_index('unicorns')
+    p = Post.new(:title => 'unicorns', :body => 'there are none', :visible => false)
+    assert p.save
+    assert_equal original_post_count + 1, Post.count
+    assert_equal [], Post.find_with_index('unicorns', {}, { :no_query_cache => true, :ids_only => true})
+  end
+
+  # If an index already exists, and an if proc is supplied, and the proc is true, it should still appear in the index
+  def test_update_if_update
+    Post.acts_as_indexed :fields => [:title, :body], :if => Proc.new { |post| post.visible }
+    destroy_index
+
+    assert_equal 1, Post.find_with_index('crane', {}, { :no_query_cache => true, :ids_only => true}).size
+    p = Post.find(6)
+    assert p.update_attributes(:visible => true)
+    assert_equal 1, Post.find_with_index('crane', {}, { :no_query_cache => true, :ids_only => true}).size
+  end
+
+  # If an index already exists, and an if proc is supplied, and the proc is false, it should no longer appear in the index
+  def test_update_if_remove
+    Post.acts_as_indexed :fields => [:title, :body], :if => Proc.new { |post| post.visible }
+    destroy_index
+
+    assert_equal 1, Post.find_with_index('crane', {}, { :no_query_cache => true, :ids_only => true}).size
+    p = Post.find(6)
+    assert p.update_attributes(:visible => false)
+    assert_equal 0, Post.find_with_index('crane',{},{ :no_query_cache => true, :ids_only => true}).size
+  end
+
+  # If an index doesn't exist, and an if proc is supplied, and the proc is true, it should appear in the index
+  def test_update_if_add
+    Post.acts_as_indexed :fields => [:title, :body], :if => Proc.new { |post| post.visible }
+    destroy_index
+
+    assert_equal 1, Post.find_with_index('crane', {}, { :no_query_cache => true, :ids_only => true}).size
+    p = Post.find(5)
+    assert p.update_attributes(:visible => true)
+    assert_equal 2, Post.find_with_index('crane',{},{ :no_query_cache => true, :ids_only => true}).size
+  end
+
+  # If an index doesn't exist, and an if proc is supplied, and the proc is false, then nothing happens
+  def test_update_if_not_in
+    Post.acts_as_indexed :fields => [:title, :body], :if => Proc.new { |post| post.visible }
+    destroy_index
+
+    assert_equal 1, Post.find_with_index('crane', {}, { :no_query_cache => true, :ids_only => true}).size
+    p = Post.find(5)
+    assert p.update_attributes(:visible => false)
+    assert_equal 1, Post.find_with_index('crane',{},{ :no_query_cache => true, :ids_only => true}).size
+  end
+
 end

data/test/configuration_test.rb

@@ -1,12 +1,12 @@
-require File.dirname(__FILE__) + '/abstract_unit'
+require File.expand_path("../abstract_unit", __FILE__)
 include ActsAsIndexed
 
-class ConfigurationTest < ActiveSupport::TestCase  
-  
+class ConfigurationTest < ActiveSupport::TestCase
+
   def test_default_index_file_should_be_set
-    assert_equal [Rails.root, 'index'], config.index_file
+    assert_equal Rails.root.join('index'), config.index_file
   end
-  
+
   def test_default_index_file_depth_should_be_set
     assert_equal 3, config.index_file_depth
   end
@@ -14,26 +14,26 @@ class ConfigurationTest < ActiveSupport::TestCase
   def test_default_min_word_size_should_be_set
     assert_equal 3, config.min_word_size
   end
-  
+
   def test_index_file_should_be_writeable
     config.index_file = [Rails.root, 'my_index']
-    assert_equal [Rails.root, 'my_index'], config.index_file
+    assert_equal Rails.root.join('my_index'), config.index_file
   end
-  
+
   def test_index_file_depth_should_be_writeable
     config.index_file_depth = 5
     assert_equal 5, config.index_file_depth
   end
-  
+
   def test_index_file_depth_should_raise_on_lower_than_1_value
     assert_nothing_raised(ArgumentError) {  config.index_file_depth = 1  }
-    
+
     e = assert_raise(ArgumentError) { config.index_file_depth = 0 }
     assert_equal 'index_file_depth cannot be less than one (1)', e.message
-    
+
     assert_raise(ArgumentError) { config.index_file_depth = -12 }
   end
-  
+
   def test_min_word_size_should_be_writeable
     config.min_word_size = 7
     assert_equal 7, config.min_word_size
@@ -47,11 +47,11 @@ class ConfigurationTest < ActiveSupport::TestCase
 
     assert_raise(ArgumentError) { config.min_word_size = -12 }
   end
-  
+
   private
-  
+
   def config
     @config ||=ActsAsIndexed::Configuration.new
   end
-  
+
 end

data/test/fixtures/posts.yml

@@ -4,28 +4,34 @@ wikipedia_article_1:
   id: 1
   title: Body Count (video game)
   body: Body Count is a 1994 First-person shooter for the Sega Mega Drive. It is one of the few games that make use of the Menacer light gun and the Mega Mouse. \n In the U.S. the game was released on the Sega Channel.
-  
+  visible: 1
+
 wikipedia_article_2:
   id: 2
   title: Julien Ellis
   body: Julien Ellis is a ice hockey goalie, born in Sorel, Quebec on January 27, 1986. He is currently 6'0" and weighs approximately 177 pounds. He wears number 34 and catches left. \n Julien played his entire junior hockey career in the QMJHL with the Shawinigan Cataractes. He was there from 2002 through the 2006 season, and played a total of 173 regular season games for them. During his time there, he recorded eight shutouts, as well as a career high .921 save percentage and 2.41 goals against average. \n Julien was chosen in round six of the 2004 NHL Entry Draft by the Vancouver Canucks, making him 189th overall pick and the 5th pick for Vancouver. \n His 2006-07 season was spent with the Victoria Salmon Kings of the ECHL, where he played 37 games and made 1,212 saves. Julien was called up the the Manitoba Moose of the AHL several times, where he played eight games.
+  visible: 1
   
 wikipedia_article_3:
   id: 3
   title: Tuen Mun River
   body: The Tuen Mun River is a river in Tuen Mun, New Territories, Hong Kong. It has many tributaries, with major ones coming from Lam Tei, Kau Keng Shan, Hung Shui Hang and Nai Wai. It flows south, splitting Tuen Mun into a west side and an east side. It eventually feeds into the Tuen Mun Typhoon Shelter, which is part of Castle Peak Bay.
+  visible: 0
   
 wikipedia_article_4:
   id: 4
   title: So Happily Unsatisfied
   body: So Happily Unsatisfied is an album that was recorded by the band Nine Days. It was intended to be the follow-up to their successful major-label debut, The Madding Crowd from 2000. The release date of the album was repeatedly delayed by Sony until the band was ultimately dropped. In the interim, the album had leaked onto the internet. The band has also put the whole album on their official website for the public to download.
+  visible: 1
   
 wikipedia_article_5:
   id: 5
   title: SS Cornhusker State (T-ACS-6)
   body: SS Cornhusker State (T-ACS-6) is a crane ship in ready reserve for the United States Navy. She is stationed at Cheatham Annex in Williamsburg, Virginia and is in ready reserve under the Military Sealift Command. The ship was named for the state of Nebraska, which is also known as the Cornhusker State. \n The ship was built by the Bath Iron Works. Her keel was laid on 27 November 1967, launched on 2 November 1968, and delivered 20 June 1969 as CV Stag Hound (MA 207). \n Stag Hound was acquired by the US Navy from the Maritime Administration in 1986 and was converted throughout 1987. She re-entered service as Cornhusker State on 12 March 1988, and has been in ready reserve since 1993.
+  visible: 0
   
 article_similar_to_5:
   id: 6
   title: An article I made up by myself!
-  body: crane crane big ship foo
+  body: crane crane big ship foo
+  visible: 1

data/test/schema.rb

@@ -2,5 +2,6 @@ ActiveRecord::Schema.define :version => 0 do
   create_table :posts, :force => true do |t|
     t.column :title, :string
     t.column :body, :text
+    t.column :visible, :boolean
   end
 end

data/test/search_atom_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/abstract_unit'
+require File.expand_path("../abstract_unit", __FILE__)
 include ActsAsIndexed
 
 class SearchAtomTest < ActiveSupport::TestCase  

data/test/search_index_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/abstract_unit'
+require File.expand_path("../abstract_unit", __FILE__)
 include ActsAsIndexed
 
 class SearchIndexTest < ActiveSupport::TestCase

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_indexed
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Douglas F Shearer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-11 00:00:00 +01:00
+date: 2010-07-05 00:00:00 +01:00
 default_executable: 
 dependencies: []