acts_as_ferret 0.5.1 → 0.5.2

data/README

@@ -6,10 +6,17 @@ It is heavily based on the original acts_as_ferret plugin done by
 Kasper Weibel and a modified version done by Thomas Lockney, which 
 both can be found on http://ferret.davebalmain.com/trac/wiki/FerretOnRails
 
-== Project Wiki and Issue tracker
 
-http://wiki.github.com/jkraemer/acts_as_ferret/
-http://j-k.lighthouseapp.com/projects/45560-acts-as-ferret
+== Project URLs
+
+Wiki: http://wiki.github.com/jkraemer/acts_as_ferret/
+Please post issues on Lighthouse: http://j-k.lighthouseapp.com/projects/45560-acts-as-ferret
+API docs: http://rdoc.info/github/jkraemer/acts_as_ferret
+
+== Supported Rails versions
+
+From version 0.5 onwards acts_as_ferret requires Rails 3. For earlier Rails versions (2.3.x, ymmv for earlier versions)
+please use acts_as_ferret versions 0.4.x or the rails-2.3.x branch on github.
 
 == Installation
 
@@ -17,14 +24,22 @@ Aaf is available as a gem (gem install acts_as_ferret), or via git from github.c
 Github also offers tarball downloads, check out
 http://github.com/jkraemer/acts_as_ferret/tree/master .
 
-=== Set up your Rails > 2.1 project to use the acts_as_ferret gem.
 
-Add this to your project's config/environment.rb:
+=== Rails 3
 
-<tt>config.gem 'acts_as_ferret', :version => '~> 0.4.8'</tt>
+add
 
-With the gem installed, change into your RAILS_ROOT and run the supplied aaf_install script.
-This will copy rake tasks, capistrano recipes and the ferret server config and startup script
+<tt>gem 'acts_as_ferret', '>= 0.5'</tt>
+
+to your Gemfile. Bundler will pull in the jk-ferret gem as a dependency, which is an 'unofficial'
+Ferret gem built by me based on Ferret's master branch on github (the latest official ferret gem is 0.11.6
+and is missing quite some bug fixes that happened since then).
+
+After running 'bundle install', have bundler execute the aaf_install script:
+
+<tt>bundle exec aaf_install</tt>
+
+This will copy the capistrano recipe, the ferret server config and it's startup script
 into your project.
 
 In order to have the capistrano recipe loaded you'll have to patch your Capfile a bit. I use to have
@@ -33,6 +48,19 @@ a line like that in my Capfiles, loading everything found below RAILS_ROOT/lib/r
 <tt>Dir['lib/recipes/**/*.rb'].each { |plugin| load(plugin) }</tt>
 
 
+=== Rails 2.x
+
+To set up your Rails project to use the acts_as_ferret gem, add this to your project's config/environment.rb:
+
+<tt>config.gem 'acts_as_ferret', :version => '~> 0.4.8'</tt>
+
+With the gem installed, change into your RAILS_ROOT and run the supplied aaf_install script.
+This will copy rake tasks, capistrano recipes and the ferret server config and startup script
+into your project.
+
+If you're using Capistrano, patch your Capfile as described above for Rails 3.
+
+
 === Installation inside your Rails project via script/plugin
 
 script/plugin install git://github.com/jkraemer/acts_as_ferret.git

data/lib/acts_as_ferret/ferret_extensions.rb

@@ -1,4 +1,4 @@
-module Ferret
+  module Ferret
 
   module Analysis
   
@@ -94,6 +94,19 @@ module Ferret
         flush()
       end      
     end
+
+    # search for the first document with +arg+ in the +id+ field and return it's internal document number. 
+    # The +id+ field is either :id or whatever you set
+    # :id_field parameter to when you create the Index object.
+    def doc_number(id)
+      @dir.synchronize do
+        ensure_reader_open()
+        term_doc_enum = @reader.term_docs_for(@id_field, id.to_s)
+        return term_doc_enum.next? ? term_doc_enum.doc : nil
+      end
+    end
+
+    private
     
     # If +docs+ is a Hash or an Array then a batch delete will be performed.
     # If +docs+ is an Array then it will be considered an array of +id+'s. If
@@ -135,16 +148,6 @@ module Ferret
       return self
     end
 
-    # search for the first document with +arg+ in the +id+ field and return it's internal document number. 
-    # The +id+ field is either :id or whatever you set
-    # :id_field parameter to when you create the Index object.
-    def doc_number(id)
-      @dir.synchronize do
-        ensure_reader_open()
-        term_doc_enum = @reader.term_docs_for(@id_field, id.to_s)
-        return term_doc_enum.next? ? term_doc_enum.doc : nil
-      end
-    end
   end
 
   # add marshalling support to SortFields

data/lib/acts_as_ferret/local_index.rb

@@ -73,9 +73,6 @@ module ActsAsFerret
               reader.tokenized_fields unless options[:tokenized_fields]
           return qp.parse query
         else
-          # work around ferret bug in #process_query (doesn't ensure the
-          # reader is open)
-          ferret_index.send(:ensure_reader_open)
           return ferret_index.process_query(query)
         end
       end

data/lib/acts_as_ferret/version.rb

@@ -1,3 +1,3 @@
 module ActsAsFerret
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/recipes/aaf_recipes.rb

@@ -46,13 +46,15 @@ namespace :ferret do
   desc "Stop the Ferret DRb server"
   task :stop, :roles => :app do
     rails_env = fetch(:rails_env, 'production')
-    run "cd #{current_path}; script/ferret_server -e #{rails_env} stop || true"
+    ruby = fetch(:ruby, '/usr/bin/env ruby')
+    run "cd #{current_path}; #{ruby} script/ferret_server -e #{rails_env} stop || true"
   end
 
   desc "Start the Ferret DRb server"
   task :start, :roles => :app do
     rails_env = fetch(:rails_env, 'production')
-    run "cd #{current_path}; script/ferret_server -e #{rails_env} start"
+    ruby = fetch(:ruby, '/usr/bin/env ruby')
+    run "cd #{current_path}; #{ruby} script/ferret_server -e #{rails_env} start"
   end
 
   desc "Restart the Ferret DRb server"

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_ferret
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Jens Kraemer
@@ -9,29 +15,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-07 00:00:00 +02:00
+date: 2010-10-26 00:00:00 +02:00
 default_executable: aaf_install
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: jk-ferret
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 11
+        - 8
         version: 0.11.8
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rails
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
         version: "3.0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: Rails plugin that adds powerful full text search capabilities to ActiveRecord models.
 email: jk@jkraemer.net
 executables: 
@@ -46,7 +63,6 @@ files:
 - LICENSE
 - bin/aaf_install
 - config/ferret_server.yml
-- doc/README.win32
 - doc/demo/README
 - doc/demo/README_DEMO
 - doc/demo/Rakefile
@@ -213,21 +229,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
       version: 1.8.7
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: acts_as_ferret
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: acts_as_ferret - Ferret based full text search for any ActiveRecord model

data/doc/README.win32

@@ -1,23 +0,0 @@
-Credits
-=======
-
-The Win32 service support scripts have been written by
-Herryanto Siatono <herryanto@pluitsolutions.com>. 
-
-See his accompanying blog posting at
-http://www.pluitsolutions.com/2007/07/30/acts-as-ferret-drbserver-win32-service/
-
-
-Usage
-=====
-
-There are two scripts:
-
-script/ferret_service is used to install/remove/start/stop the win32 service.
-
-script/ferret_daemon is to be called by Win32 service to start/stop the
-DRbServer.
-
-Run 'ruby script/ferret_service -h' for more info.
-
-