acts_as_indexed 0.6.7 → 0.7.0

data/CHANGELOG

@@ -1,7 +1,14 @@
+===0.7.0 [11th February 2011]
+ - Threadsafe support. Index files are now locked for changes, and atomically written.
+ - Configurable case-sensitivity.
+ - Improved performance of index builds.
+ - Now warns on old version of the index.
+ - Upgrade instructions added to README. [ionas - Florent Guilleux]
+
 ===0.6.7 [7th February 2011]
  - find_by_index and paginate_search are no longer deprecated.
- - Improved documentation
- - Storage is now it's own class to allow future development of locking and pluggable backends.
+ - Improved documentation.
+ - Storage is now its own class to allow future development of locking and pluggable backends.
 
 ===0.6.6 [31st August 2010]
  - Now Heroku compatible out of the box, index is created in tmp when root dir is non-writable. [parndt - Philip Arndt - Great suggestion]
@@ -86,15 +93,15 @@
 
 ===0.3.0 [18 September 2007]
 - Minor bug fixes.
-- min_word_size now works properly, with queries containing small words in 
+- min_word_size now works properly, with queries containing small words in
   quotes or being preceded by a '+' symbol are now searched on.
 
 ===0.2.2 [06 September 2007]
-- Search now caches query results within a session. Call the search twice in an 
+- Search now caches query results within a session. Call the search twice in an
   action? Only runs once!
 
 ===0.2.1 [05 September 2007]
-- AR find options can now be passed to the search to allow finer control of 
+- AR find options can now be passed to the search to allow finer control of
   returned Model Objects.
 
 ===0.2.0 [04 September 2007]

data/Gemfile

@@ -3,3 +3,5 @@ source "http://rubygems.org"
 gem "jeweler"
 gem "mocha"
 gem "sqlite3-ruby"
+gem "rcov"
+gem "gemcutter"

data/Gemfile.lock

@@ -1,19 +1,18 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    gemcutter (0.6.1)
     git (1.2.5)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
       git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json_pure (1.4.6)
-    mocha (0.9.8)
+      rake
+    mocha (0.9.11)
       rake
     rake (0.8.7)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
-    sqlite3-ruby (1.3.1)
+    rcov (0.9.9)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
 
 PLATFORMS
   ruby
@@ -21,4 +20,5 @@ PLATFORMS
 DEPENDENCIES
   jeweler
   mocha
+  rcov
   sqlite3-ruby

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007 - 2010 Douglas Shearer
+Copyright (c) 2007 - 2011 Douglas Shearer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -35,9 +35,14 @@ Gemfile (Rails 3.x.x).
 
 ==== No Git?
 
-If you don't have git installed, but still want the plugin, 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, but still want the plugin, 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.
+
+=== Upgrade
+
+When upgrading to a new version of acts_as_indexed it is recommended you
+delete the index directory and allow it to be rebuilt.
 
 
 == Usage
@@ -97,7 +102,7 @@ of any matching records.
 
   # Pass any of the ActiveRecord find options to the search.
   my_search_results = Post.find_with_index('my search query',{:limit => 10}) # return the first 10 matches.
-  
+
   # Returns array of IDs ordered by relevance.
   my_search_results = Post.find_with_index('my search query',{},{:ids_only => true}) # =>  [12,19,33...
 
@@ -128,7 +133,7 @@ The following query operators are supported:
 ==== With Relevance
 
 Pagination is supported via the +paginate_search+ method whose first argument is the search query, followed all the standard will_paginate arguments.
-  
+
   @images = Image.paginate_search('girl', :page => 1, :per_page => 5)
 
 ==== Without Relevance (Scope)
@@ -141,12 +146,11 @@ fashion.
 === Further Configuration
 
 A config block can be provided in your environment files or initializers.
-Example showing defaults:
+Example showing changing the min word size:
 
   ActsAsIndexed.configure do |config|
-    config.index_file = [Rails.root.to_s,'index'] 
-    config.index_file_depth = 3
     config.min_word_size = 3
+    # More config as required...
   end
 
 A full rundown of the available configuration options can be found in
@@ -188,5 +192,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 in the following Gist: 
+* UTF-8 support. See the current solution in the following Gist:
   https://gist.github.com/193903bb4e0d6e5debe1

data/Rakefile

@@ -47,5 +47,5 @@ begin
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-0.6.7
+0.7.0

data/acts_as_indexed.gemspec

@@ -1,60 +1,61 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_indexed}
-  s.version = "0.6.7"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Douglas F Shearer"]
-  s.date = %q{2011-02-07}
+  s.date = %q{2011-02-11}
   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 = [
     "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "CHANGELOG",
-     "Gemfile",
-     "Gemfile.lock",
-     "MIT-LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "acts_as_indexed.gemspec",
-     "lib/acts_as_indexed.rb",
-     "lib/acts_as_indexed/configuration.rb",
-     "lib/acts_as_indexed/search_atom.rb",
-     "lib/acts_as_indexed/search_index.rb",
-     "lib/acts_as_indexed/storage.rb",
-     "lib/will_paginate_search.rb",
-     "rails/init.rb",
-     "test/abstract_unit.rb",
-     "test/acts_as_indexed_test.rb",
-     "test/configuration_test.rb",
-     "test/database.yml",
-     "test/fixtures/post.rb",
-     "test/fixtures/posts.yml",
-     "test/schema.rb",
-     "test/search_atom_test.rb",
-     "test/search_index_test.rb"
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "acts_as_indexed.gemspec",
+    "lib/acts_as_indexed.rb",
+    "lib/acts_as_indexed/class_methods.rb",
+    "lib/acts_as_indexed/configuration.rb",
+    "lib/acts_as_indexed/instance_methods.rb",
+    "lib/acts_as_indexed/search_atom.rb",
+    "lib/acts_as_indexed/search_index.rb",
+    "lib/acts_as_indexed/singleton_methods.rb",
+    "lib/acts_as_indexed/storage.rb",
+    "lib/will_paginate_search.rb",
+    "rails/init.rb",
+    "test/abstract_unit.rb",
+    "test/acts_as_indexed_test.rb",
+    "test/configuration_test.rb",
+    "test/database.yml",
+    "test/fixtures/post.rb",
+    "test/fixtures/posts.yml",
+    "test/schema.rb",
+    "test/search_atom_test.rb",
+    "test/search_index_test.rb"
   ]
   s.homepage = %q{http://github.com/dougal/acts_as_indexed}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Acts As Indexed is a plugin which provides a pain-free way to add fulltext search to your Ruby on Rails app}
   s.test_files = [
     "test/abstract_unit.rb",
-     "test/acts_as_indexed_test.rb",
-     "test/configuration_test.rb",
-     "test/fixtures/post.rb",
-     "test/schema.rb",
-     "test/search_atom_test.rb",
-     "test/search_index_test.rb"
+    "test/acts_as_indexed_test.rb",
+    "test/configuration_test.rb",
+    "test/fixtures/post.rb",
+    "test/schema.rb",
+    "test/search_atom_test.rb",
+    "test/search_index_test.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/acts_as_indexed.rb

@@ -1,10 +1,13 @@
 # ActsAsIndexed
-# Copyright (c) 2007 - 2010 Douglas F Shearer.
+# Copyright (c) 2007 - 2011 Douglas F Shearer.
 # http://douglasfshearer.com
 # Distributed under the MIT license as included with this plugin.
 
 require 'active_record'
 
+require 'acts_as_indexed/class_methods'
+require 'acts_as_indexed/instance_methods'
+require 'acts_as_indexed/singleton_methods'
 require 'acts_as_indexed/configuration'
 require 'acts_as_indexed/search_index'
 require 'acts_as_indexed/search_atom'
@@ -12,6 +15,10 @@ require 'acts_as_indexed/storage'
 
 module ActsAsIndexed #:nodoc:
 
+  # This is the last version of the plugin where the index structure was
+  # changed in some manner. Is only changed when necessary, not every release.
+  INDEX_VERSION = '0.6.8'
+
   # Holds the default configuration for acts_as_indexed.
 
   @configuration = Configuration.new
@@ -40,190 +47,6 @@ module ActsAsIndexed #:nodoc:
     mod.extend(ClassMethods)
   end
 
-  module ClassMethods
-
-    # Declares a class as searchable.
-    #
-    # ====options:
-    # fields:: Names of fields to include in the index. Symbols pointing to
-    #          instance methods of your model may also be given here.
-    # index_file_depth:: Tuning value for the index partitioning. Larger
-    #                    values result in quicker searches, but slower
-    #                    indexing. Default is 3.
-    # 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
-    #              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]
-
-    def acts_as_indexed(options = {})
-      class_eval do
-        extend ActsAsIndexed::SingletonMethods
-      end
-      include ActsAsIndexed::InstanceMethods
-
-      after_create  :add_to_index
-      before_update :update_index
-      after_destroy :remove_from_index
-
-      # scope for Rails 3.x, named_scope for Rails 2.x.
-      if self.respond_to?(:where)
-        scope :with_query, lambda { |query| where("#{table_name}.id IN (?)", search_index(query, {}, {:ids_only => true})) }
-      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
-
-      # 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 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)
-      @query_cache = {}
-    end
-
-    # 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, aai_config.if_proc)
-      index.remove_record(record)
-      @query_cache = {}
-    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 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.update_record(record,find(record.id))
-      @query_cache = {}
-    end
-
-    # Finds instances matching the terms passed in +query+. Terms are ANDed by
-    # default. Returns an array of model instances or, if +ids_only+ is
-    # true, an array of integer IDs.
-    #
-    # Keeps a cache of matched IDs for the current session to speed up
-    # multiple identical searches.
-    #
-    # ====find_options
-    # Same as ActiveRecord#find options hash. An :order key will override
-    # the relevance ranking
-    #
-    # ====options
-    # ids_only:: Method returns an array of integer IDs when set to true.
-    # no_query_cache:: Turns off the query cache when set to true. Useful for testing.
-
-    def search_index(query, find_options={}, options={})
-      # Clear the query cache off  if the key is set.
-      @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 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{|r| r.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{|r| r.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
-         # Results come back in random order from SQL, so order again.
-         ranked_records = {}
-         records.each do |r|
-           ranked_records[r] = @query_cache[query][r.id]
-         end
-
-         ranked_records.to_a.sort_by{|a| a.last }.reverse.map{|r| r.first}
-       end
-      end
-
-    end
-
-    private
-
-    # Builds an index from scratch for the current model class.
-    def build_index
-      index = SearchIndex.new(aai_config.index_file, aai_config.index_file_depth, aai_fields, aai_config.min_word_size, aai_config.if_proc)
-      find_in_batches({ :batch_size => 500 }) do |records|
-        index.add_records(records)
-      end
-    end
-
-  end
-
-  # Adds model class singleton methods.
-  module SingletonMethods
-
-    # Finds instances matching the terms passed in +query+.
-    #
-    # See ActsAsIndexed::ClassMethods#search_index.
-    def find_with_index(query='', find_options = {}, options = {})
-      search_index(query, find_options, options)
-    end
-
-  end
-
-  # Adds model class instance methods.
-  # Methods are called automatically by ActiveRecord on +save+, +destroy+,
-  # and +update+ of model instances.
-  module InstanceMethods
-
-    # Adds the current model instance to index.
-    # Called by ActiveRecord on +save+.
-    def add_to_index
-      self.class.index_add(self)
-    end
-
-    # Removes the current model instance to index.
-    # Called by ActiveRecord on +destroy+.
-    def remove_from_index
-      self.class.index_remove(self)
-    end
-
-    # Updates current model instance index.
-    # Called by ActiveRecord on +update+.
-    def update_index
-      self.class.index_update(self)
-    end
-  end
-
 end
 
 # reopen ActiveRecord and include all the above to make

data/lib/acts_as_indexed/class_methods.rb

@@ -0,0 +1,160 @@
+# ActsAsIndexed
+# Copyright (c) 2007 - 2011 Douglas F Shearer.
+# http://douglasfshearer.com
+# Distributed under the MIT license as included with this plugin.
+
+module ActsAsIndexed
+
+  module ClassMethods
+
+    # Declares a class as searchable.
+    #
+    # ====options:
+    # fields:: Names of fields to include in the index. Symbols pointing to
+    #          instance methods of your model may also be given here.
+    # index_file_depth:: Tuning value for the index partitioning. Larger
+    #                    values result in quicker searches, but slower
+    #                    indexing. Default is 3.
+    # 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
+    #              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]
+
+    def acts_as_indexed(options = {})
+      class_eval do
+        extend ActsAsIndexed::SingletonMethods
+      end
+      include ActsAsIndexed::InstanceMethods
+
+      after_create  :add_to_index
+      before_update :update_index
+      after_destroy :remove_from_index
+
+      # scope for Rails 3.x, named_scope for Rails 2.x.
+      if self.respond_to?(:where)
+        scope :with_query, lambda { |query| where("#{table_name}.id IN (?)", search_index(query, {}, {:ids_only => true})) }
+      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
+
+      # 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 unless aai_config.index_file.directory?
+      index = new_index
+      index.add_record(record)
+      @query_cache = {}
+    end
+
+    # Removes the passed +record+ from the index. Clears the query cache.
+
+    def index_remove(record)
+      index = new_index
+      index.remove_record(record)
+      @query_cache = {}
+    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 unless aai_config.index_file.directory?
+      index = new_index
+      index.update_record(record,find(record.id))
+      @query_cache = {}
+    end
+
+    # Finds instances matching the terms passed in +query+. Terms are ANDed by
+    # default. Returns an array of model instances or, if +ids_only+ is
+    # true, an array of integer IDs.
+    #
+    # Keeps a cache of matched IDs for the current session to speed up
+    # multiple identical searches.
+    #
+    # ====find_options
+    # Same as ActiveRecord#find options hash. An :order key will override
+    # the relevance ranking
+    #
+    # ====options
+    # ids_only:: Method returns an array of integer IDs when set to true.
+    # no_query_cache:: Turns off the query cache when set to true. Useful for testing.
+
+    def search_index(query, find_options={}, options={})
+      # Clear the query cache off  if the key is set.
+      @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 unless aai_config.index_file.directory?
+        index = new_index
+        (@query_cache ||= {})[query] = index.search(query)
+      else
+        logger.debug('Query held in cache.')
+      end
+      return @query_cache[query].sort.reverse.map{|r| r.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{|r| r.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
+         # Results come back in random order from SQL, so order again.
+         ranked_records = {}
+         records.each do |r|
+           ranked_records[r] = @query_cache[query][r.id]
+         end
+
+         ranked_records.to_a.sort_by{|a| a.last }.reverse.map{|r| r.first}
+       end
+      end
+
+    end
+
+    private
+
+    def new_index
+      SearchIndex.new(aai_fields, aai_config)
+    end
+
+    # Builds an index from scratch for the current model class.
+    def build_index
+      index = new_index
+      find_in_batches({ :batch_size => 500 }) do |records|
+        index.add_records(records)
+      end
+    end
+
+  end
+
+end

data/lib/acts_as_indexed/configuration.rb

@@ -1,5 +1,5 @@
 # ActsAsIndexed
-# Copyright (c) 2007 - 2010 Douglas F Shearer.
+# Copyright (c) 2007 - 2011 Douglas F Shearer.
 # http://douglasfshearer.com
 # Distributed under the MIT license as included with this plugin.
 
@@ -22,24 +22,27 @@ module ActsAsIndexed
     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.
+    # Useful if you don't want an object to be placed in the index, such as a
+    # draft post.
     attr_accessor :if_proc
 
+    # Enable or disable case sensitivity.
+    # Set to true to enable.
+    # Default is false.
+    attr_accessor :case_sensitive
+
     def initialize
-      @index_file = nil
+      @index_file       = nil
       @index_file_depth = 3
-      @min_word_size = 3
-      @if_proc = if_proc
+      @min_word_size    = 3
+      @if_proc          = if_proc
+      @case_sensitive   = false
     end
 
     # Since we cannot expect Rails to be available on load, it is best to put
     # off setting the index_file attribute until as late as possible.
     def index_file
-      if @index_file.nil?
-        @index_file = default_index_file
-      end
-      @index_file
+      @index_file ||= default_index_file
     end
 
     def index_file=(file_path)
@@ -67,7 +70,7 @@ module ActsAsIndexed
     end
 
     private
-    
+
     def default_index_file
       if Rails.root.writable?
         Rails.root.join('index')

data/lib/acts_as_indexed/instance_methods.rb

@@ -0,0 +1,32 @@
+# ActsAsIndexed
+# Copyright (c) 2007 - 2011 Douglas F Shearer.
+# http://douglasfshearer.com
+# Distributed under the MIT license as included with this plugin.
+
+module ActsAsIndexed
+  
+  # Adds model class instance methods.
+  # Methods are called automatically by ActiveRecord on +save+, +destroy+,
+  # and +update+ of model instances.
+  module InstanceMethods
+
+    # Adds the current model instance to index.
+    # Called by ActiveRecord on +save+.
+    def add_to_index
+      self.class.index_add(self)
+    end
+
+    # Removes the current model instance to index.
+    # Called by ActiveRecord on +destroy+.
+    def remove_from_index
+      self.class.index_remove(self)
+    end
+
+    # Updates current model instance index.
+    # Called by ActiveRecord on +update+.
+    def update_index
+      self.class.index_update(self)
+    end
+  end
+  
+end

data/lib/acts_as_indexed/search_atom.rb

@@ -1,5 +1,5 @@
 # ActsAsIndexed
-# Copyright (c) 2007 - 2010 Douglas F Shearer.
+# Copyright (c) 2007 - 2011 Douglas F Shearer.
 # http://douglasfshearer.com
 # Distributed under the MIT license as included with this plugin.
 

data/lib/acts_as_indexed/search_index.rb

@@ -1,23 +1,21 @@
 # ActsAsIndexed
-# Copyright (c) 2007 - 2010 Douglas F Shearer.
+# Copyright (c) 2007 - 2011 Douglas F Shearer.
 # http://douglasfshearer.com
 # Distributed under the MIT license as included with this plugin.
 
 module ActsAsIndexed #:nodoc:
   class SearchIndex
 
-    # 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.
-    # 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})
-      @storage = Storage.new(Pathname.new(root.to_s), index_depth)
+    # config:: ActsAsIndexed::Configuration instance.
+    def initialize(fields, config)
+      @storage = Storage.new(Pathname.new(config.index_file.to_s), config.index_file_depth)
       @fields = fields
       @atoms = {}
-      @min_word_size = min_word_size
+      @min_word_size = config.min_word_size
       @records_size = @storage.record_count
-      @if_proc = if_proc
+      @case_sensitive = config.case_sensitive
+      @if_proc = config.if_proc
     end
 
     # Adds +record+ to the index.
@@ -25,23 +23,30 @@ module ActsAsIndexed #:nodoc:
       return unless @if_proc.call(record)
 
       condensed_record = condense_record(record)
-      atoms = add_occurences(condensed_record,record.id)
-      
+      atoms = add_occurences(condensed_record, record.id)
+
       @storage.add(atoms)
     end
 
     # Adds multiple records to the index. Accepts an array of +records+.
     def add_records(records)
+      atoms = {}
+
       records.each do |record|
-        add_record(record)
+        next unless @if_proc.call(record)
+
+        condensed_record = condense_record(record)
+        atoms = add_occurences(condensed_record, record.id, atoms)
       end
+
+      @storage.add(atoms)
     end
 
     # Removes +record+ from the index.
     def remove_record(record)
       condensed_record = condense_record(record)
       atoms = add_occurences(condensed_record,record.id)
-      
+
       @storage.remove(atoms)
     end
 
@@ -104,8 +109,7 @@ module ActsAsIndexed #:nodoc:
       r1.merge(r2) { |r_id,old_val,new_val| old_val + new_val}
     end
 
-    def add_occurences(condensed_record,record_id)
-      atoms = {}
+    def add_occurences(condensed_record, record_id, atoms={})
       condensed_record.each_with_index do |atom_name, i|
         atoms[atom_name] = SearchAtom.new unless atoms.include?(atom_name)
         atoms[atom_name].add_position(record_id, i)
@@ -248,7 +252,8 @@ module ActsAsIndexed #:nodoc:
 
 
     def cleanup_atoms(s, limit_size=false, min_size = @min_word_size || 3)
-      atoms = s.downcase.gsub(/\W/,' ').squeeze(' ').split
+      s = @case_sensitive ? s : s.downcase
+      atoms = s.gsub(/\W/,' ').squeeze(' ').split
       return atoms unless limit_size
       atoms.reject{|w| w.size < min_size}
     end

data/lib/acts_as_indexed/singleton_methods.rb

@@ -0,0 +1,20 @@
+# ActsAsIndexed
+# Copyright (c) 2007 - 2011 Douglas F Shearer.
+# http://douglasfshearer.com
+# Distributed under the MIT license as included with this plugin.
+
+module ActsAsIndexed
+
+  # Adds model class singleton methods.
+  module SingletonMethods
+
+    # Finds instances matching the terms passed in +query+.
+    #
+    # See ActsAsIndexed::ClassMethods#search_index.
+    def find_with_index(query='', find_options = {}, options = {})
+      search_index(query, find_options, options)
+    end
+
+  end
+
+end

data/lib/acts_as_indexed/storage.rb

@@ -1,13 +1,19 @@
 # ActsAsIndexed
-# Copyright (c) 2007 - 2010 Douglas F Shearer.
+# Copyright (c) 2007 - 2011 Douglas F Shearer.
 # http://douglasfshearer.com
 # Distributed under the MIT license as included with this plugin.
 
 module ActsAsIndexed #:nodoc:
   class Storage
 
+    class OldIndexVersion < Exception;end
+
+    INDEX_FILE_EXTENSION = '.ind'
+    TEMP_FILE_EXTENSION  = '.tmp'
+
     def initialize(path, prefix_size)
       @path = path
+      @size_path = path.join('size')
       @prefix_size = prefix_size
       prepare
     end
@@ -17,7 +23,6 @@ module ActsAsIndexed #:nodoc:
       operate(:+, atoms)
 
       update_record_count(1)
-
     end
 
     # Takes a hash of atoms and removes these from storage.
@@ -35,6 +40,7 @@ module ActsAsIndexed #:nodoc:
       atom_names.uniq.collect{|a| encoded_prefix(a) }.uniq.each do |prefix|
         pattern = @path.join(prefix.to_s).to_s
         pattern += '*' if start
+        pattern += INDEX_FILE_EXTENSION
 
         Pathname.glob(pattern).each do |atom_file|
           atom_file.open do |f|
@@ -48,13 +54,7 @@ module ActsAsIndexed #:nodoc:
 
     # Returns the number of records currently stored in this index.
     def record_count
-      # TODO: Record count is currently a marshaled integer. Why not store as
-      # string integer? Breaks compatibility, so leave until other changes
-      # need to be made to the index.
-
-      @path.join('size').open do |f|
-        Marshal.load(f)
-      end
+      @size_path.read.to_i
 
     # This is a bit horrible.
     rescue Errno::ENOENT
@@ -78,35 +78,56 @@ module ActsAsIndexed #:nodoc:
       end
 
       atoms_sorted.each do |e_p, atoms|
-        path = @path.join(e_p.to_s)
-
-        if path.exist?
-          from_file = path.open do |f|
-            Marshal.load(f)
+        path = @path.join(e_p.to_s + INDEX_FILE_EXTENSION)
+        
+        lock_file(path) do
+        
+          if path.exist?
+            from_file = path.open do |f|
+              Marshal.load(f)
+            end
+          else
+            from_file = {}
           end
-        else
-          from_file = {}
-        end
 
-        atoms = from_file.merge(atoms){ |k,o,n| o.send(operation, n) }
+          atoms = from_file.merge(atoms){ |k,o,n| o.send(operation, n) }
 
-        path.open("w+") do |f|
-          Marshal.dump(atoms,f)
-        end
+          write_file(path) do |f|
+            Marshal.dump(atoms,f)
+          end
+        end # end lock.
+        
       end
     end
 
     def update_record_count(delta)
-      new_count = self.record_count + delta
-      new_count = 0 if new_count < 0
+      lock_file(@size_path) do
+        new_count = self.record_count + delta
+        new_count = 0 if new_count < 0
 
-      @path.join('size').open('w+') do |f|
-        Marshal.dump(new_count,f)
+        write_file(@size_path) do |f|
+          f.write(new_count)
+        end
       end
     end
 
     def prepare
-      @path.mkpath unless @path.exist?
+      version_path = @path.join('version')
+
+      if @path.exist?
+        unless version_path.exist? && version_path.read == ActsAsIndexed::INDEX_VERSION
+          raise OldIndexVersion, "Index was created prior to version #{ActsAsIndexed::INDEX_VERSION}. Please delete it, it will be rebuilt automatically."
+        end
+
+      else
+        @path.mkpath
+        
+        # Do we need to lock for this? I don't think so as it is only ever making
+        # a creation, not a modification.
+        write_file(version_path) do |f|
+          f.write(ActsAsIndexed::INDEX_VERSION)
+        end
+      end
     end
 
     def encoded_prefix(atom)
@@ -132,5 +153,33 @@ module ActsAsIndexed #:nodoc:
       end
     end
 
+    def write_file(file_path)
+      new_file = file_path.to_s
+      tmp_file = new_file + TEMP_FILE_EXTENSION
+
+      File.open(tmp_file, 'w+') do |f|
+        yield(f)
+      end
+
+      FileUtils.mv(tmp_file, new_file)
+    end
+
+    # Borrowed from Rails' ActiveSupport FileStore. Also under MIT licence.
+    # Lock a file for a block so only one process can modify it at a time.
+    def lock_file(file_path, &block) # :nodoc:
+      if file_path.exist?
+        file_path.open('r') do |f|
+          begin
+            f.flock File::LOCK_EX
+            yield
+          ensure
+            f.flock File::LOCK_UN
+          end
+        end
+      else
+        yield
+      end
+    end
+
   end
 end

data/lib/will_paginate_search.rb

@@ -1,5 +1,5 @@
 # WillPaginateSearch
-# Copyright (c) 2007 - 2010 Douglas F Shearer.
+# Copyright (c) 2007 - 2011 Douglas F Shearer.
 # http://douglasfshearer.com
 
 module ActsAsIndexed

data/test/acts_as_indexed_test.rb

@@ -196,6 +196,17 @@ class ActsAsIndexedTest < ActiveSupport::TestCase
     assert_equal 1, Post.find_with_index('crane',{},{ :no_query_cache => true, :ids_only => true}).size
   end
 
+  def test_case_insensitive
+    Post.acts_as_indexed :fields => [:title, :body], :case_sensitive => true
+    destroy_index
+    
+    assert_equal 1, Post.find_with_index('Ellis', {}, { :no_query_cache => true, :ids_only => true}).size
+    assert_equal 0, Post.find_with_index('ellis', {}, { :no_query_cache => true, :ids_only => true}).size
+    
+    assert_equal 3, Post.find_with_index('The', {}, { :no_query_cache => true, :ids_only => true}).size
+    assert_equal 5, Post.find_with_index('the', {}, { :no_query_cache => true, :ids_only => true}).size
+  end
+
   private
   
   def result_ids(query)

data/test/search_index_test.rb

@@ -12,8 +12,8 @@ class SearchIndexTest < ActiveSupport::TestCase
   
   private
   
-  def build_search_index(root = index_loc, index_depth = 2, fields = [:title, :body], min_word_size = 3)
-    SearchIndex.new([root], index_depth, fields, min_word_size)
+  def build_search_index(fields, config)
+    SearchIndex.new(fields, config)
   end
   
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_indexed
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 0
-  - 6
   - 7
-  version: 0.6.7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Douglas F Shearer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 +00:00
+date: 2011-02-11 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -28,7 +28,6 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- .gitignore
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
@@ -38,9 +37,12 @@ files:
 - VERSION
 - acts_as_indexed.gemspec
 - lib/acts_as_indexed.rb
+- lib/acts_as_indexed/class_methods.rb
 - lib/acts_as_indexed/configuration.rb
+- lib/acts_as_indexed/instance_methods.rb
 - lib/acts_as_indexed/search_atom.rb
 - lib/acts_as_indexed/search_index.rb
+- lib/acts_as_indexed/singleton_methods.rb
 - lib/acts_as_indexed/storage.rb
 - lib/will_paginate_search.rb
 - rails/init.rb
@@ -58,8 +60,8 @@ homepage: http://github.com/dougal/acts_as_indexed
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -83,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Acts As Indexed is a plugin which provides a pain-free way to add fulltext search to your Ruby on Rails app

data/.gitignore

@@ -1,6 +0,0 @@
-rdoc
-test/test.log
-coverage
-index
-pkg
-.bundle