acts_as_ferret 0.4.7 → 0.4.8.rails3

data/README

@@ -21,9 +21,8 @@ http://github.com/jkraemer/acts_as_ferret/tree/master .
 
 Add this to your project's config/environment.rb:
 
-<tt>config.gem 'acts_as_ferret', :version => '~> 0.4.7'</tt>
+<tt>config.gem 'acts_as_ferret', :version => '~> 0.4.8'</tt>
 
-With Rails 3 of course instead you have to update your Gemfile, but I guess you already knew that ;-) 
 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.
@@ -43,6 +42,37 @@ No additional setup needed.
 
 == Usage
 
+There are two ways to make your models searchable with aaf. The option to configure acts_as_ferret with
+a single configuration file has been introduced because it makes more sense when a single index holds multiple
+models - it's simply more logicl to define that index and tell which models should go into it than to call
+acts_as_ferret in each model pointing to the same index every time.
+
+=== central configuration file
+
+With this option, all acts_as_ferret indexes are configured in a single file, RAILS_ROOT/config/aaf.rb:
+
+ActsAsFerret::define_index( 'my_index',
+                            :models => {
+                              SomeModel => {
+                                :fields => {
+                                  :name => { :boost => 4, :store => :yes, :via => :ferret_title },
+                                  :foo => { :store => :no,  :index => :untokenized },
+                                  :baz => { :store => :yes, :via => :ferret_content }
+                                }
+                              }
+                            } )
+
+ActsAsFerret::define_index( 'some_other_index',
+                            :models => {
+                              Foo => { :fields => { ... } },
+                              Bar => { ... },
+                            } )
+
+
+As you can see for every index you want to define there's a single call, and each model that should go
+into the index gets it's own ferret options hash (see the acts_as_ferret class method docs for all available options).
+
+=== In your models (the old fashioned way)
 include the following in your model class (specifiying the fields you want to get indexed):
 
 <tt>acts_as_ferret :fields => [ :title, :description ]</tt>
@@ -55,6 +85,10 @@ less results).
 
 Please see ActsAsFerret::ActMethods#acts_as_ferret for more information.
 
+== Known issues
+
+aaf is not yet ready for Rails3. Feel free to submit patches!
+
 == License
 
 Released under the MIT license.

data/acts_as_ferret.gemspec

@@ -5,8 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 7
-  version: 0.4.7
+  - 8
+  - rails3
+  version: 0.4.8.rails3
 platform: ruby
 authors: 
 - Jens Kraemer
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-06 13:50:00 +02:00
+date: 2010-07-13 14:10:00 +02:00
 default_executable: aaf_install
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -208,7 +209,7 @@ files:
 - doc/demo/vendor/plugins/will_paginate/test/pagination_test.rb
 - doc/monit-example
 - doc/README.win32
-- init.rb
+- rails/init.rb
 - install.rb
 - lib
 - lib/act_methods.rb

data/config/ferret_server.yml

@@ -2,8 +2,8 @@
 # host: where to reach the DRb server (used by application processes to contact the server)
 # port: which port the server should listen on
 # socket: where the DRb server should create the socket (absolute path), this setting overrides host:port configuration
-# pid_file: location of the server's pid file (relative to RAILS_ROOT)
-# log_file: log file (default: RAILS_ROOT/log/ferret_server.log
+# pid_file: location of the server's pid file (relative to Rails.root)
+# log_file: log file (default: Rails.root/log/ferret_server.log
 # log_level: log level for the server's logger
 production:
   host: localhost

data/lib/act_methods.rb

@@ -26,7 +26,7 @@ module ActsAsFerret #:nodoc:
     #      to determine if it should be indexed or not.
     #
     # index_dir:: declares the directory where to put the index for this class.
-    #             The default is RAILS_ROOT/index/RAILS_ENV/CLASSNAME. 
+    #             The default is Rails.root/index/Rails.env/CLASSNAME. 
     #             The index directory will be created if it doesn't exist.
     #
     # reindex_batch_size:: reindexing is done in batches of this size, default is 1000
@@ -75,7 +75,7 @@ module ActsAsFerret #:nodoc:
         # set up AR hooks
         after_create  :ferret_create
         after_update  :ferret_update
-        after_destroy :ferret_destroy      
+        after_destroy :ferret_destroy
       end
 
       cattr_accessor :aaf_configuration

data/lib/acts_as_ferret.rb

@@ -82,7 +82,7 @@ require 'rdig_adapter'
 #                    whatever reason.
 #
 # remote:: Set this to false to force acts_as_ferret into local (non-DRb) mode even if
-#          config/ferret_server.yml contains a section for the current RAILS_ENV
+#          config/ferret_server.yml contains a section for the current Rails.env
 #          Usually you won't need to touch this option - just configure DRb for
 #          production mode in ferret_server.yml.
 #
@@ -107,7 +107,7 @@ module ActsAsFerret
   @@index_using_classes = {}
   def self.index_using_classes; @@index_using_classes end
 
-  @@logger = Logger.new "#{RAILS_ROOT}/log/acts_as_ferret.log"
+  @@logger = Logger.new "#{Rails.root || '.'}/log/acts_as_ferret.log"
   @@logger.level = ActiveRecord::Base.logger.level rescue Logger::DEBUG
   mattr_accessor :logger
 
@@ -145,10 +145,15 @@ module ActsAsFerret
   remote?
 
 
-  # Globally declares an index.
+  # Declares an index.
   #
-  # This method is also used to implicitly declare an index when you use the
-  # acts_as_ferret call in your class. Returns the created index instance.
+  # Use this method to define your indexes in a global initializer (i.e. config/initializers/aaf.rb).
+  # This is especially useful if you want to have multiple classes share the same index for cross-model
+  # searching as you only need a single call to declare the index for all models.
+  #
+  # This method is also used internally to declare an index when you use the
+  # acts_as_ferret call inside your class (which in turn can be omitted if the initializer is used).
+  # Returns the created index instance.
   #
   # === Options are:
   #
@@ -250,7 +255,7 @@ module ActsAsFerret
 
   def self.load_config
     # using require_dependency to make the reloading in dev mode work.
-    require_dependency "#{RAILS_ROOT}/config/aaf.rb"
+    require_dependency "#{Rails.root}/config/aaf.rb"
     ActsAsFerret::logger.info "loaded configuration file aaf.rb"
   rescue LoadError
   ensure
@@ -513,10 +518,10 @@ module ActsAsFerret
 
   
   # make sure the default index base dir exists. by default, all indexes are created
-  # under RAILS_ROOT/index/RAILS_ENV
+  # under Rails.root/index/Rails.env
   def self.init_index_basedir
-    index_base = "#{RAILS_ROOT}/index"
-    @@index_dir = "#{index_base}/#{RAILS_ENV}"
+    index_base = "#{Rails.root || '.'}/index"
+    @@index_dir = "#{index_base}/#{Rails.env}"
   end
   
   mattr_accessor :index_dir

data/lib/ferret_server.rb

@@ -14,9 +14,9 @@ module ActsAsFerret
       DEFAULTS = {
         'host'      => 'localhost',
         'port'      => '9009',
-        'cf'        => "#{RAILS_ROOT}/config/ferret_server.yml",
-        'pid_file'  => "#{RAILS_ROOT}/log/ferret_server.pid",
-        'log_file'  => "#{RAILS_ROOT}/log/ferret_server.log",
+        'cf'        => "#{Rails.root}/config/ferret_server.yml",
+        'pid_file'  => "#{Rails.root}/log/ferret_server.pid",
+        'log_file'  => "#{Rails.root}/log/ferret_server.log",
         'log_level' => 'debug',
         'socket'    => nil,
         'script'    => nil
@@ -27,8 +27,8 @@ module ActsAsFerret
       def initialize (file=DEFAULTS['cf'])
         @everything = YAML.load(ERB.new(IO.read(file)).result)
         raise "malformed ferret server config" unless @everything.is_a?(Hash)
-        @config = DEFAULTS.merge(@everything[RAILS_ENV] || {})
-        if @everything[RAILS_ENV]
+        @config = DEFAULTS.merge(@everything[Rails.env] || {})
+        if @everything[Rails.env]
           @config['uri'] = socket.nil? ? "druby://#{host}:#{port}" : "drbunix:#{socket}"
         end
       end
@@ -46,7 +46,7 @@ module ActsAsFerret
     # search requests from models declared to 'acts_as_ferret :remote => true'
     #
     # Usage: 
-    # - modify RAILS_ROOT/config/ferret_server.yml to suit your needs. 
+    # - modify Rails.root/config/ferret_server.yml to suit your needs. 
     # - environments for which no section in the config file exists will use 
     #   the index locally (good for unit tests/development mode)
     # - run script/ferret_server to start the server:
@@ -73,7 +73,7 @@ module ActsAsFerret
         ActiveRecord::Base.logger = @logger = Logger.new(@cfg.log_file)
         ActiveRecord::Base.logger.level = Logger.const_get(@cfg.log_level.upcase) rescue Logger::DEBUG
         if @cfg.script
-          path = File.join(RAILS_ROOT, @cfg.script) 
+          path = File.join(Rails.root, @cfg.script) 
           load path
           @logger.info "loaded custom startup script from #{path}"
         end
@@ -82,14 +82,14 @@ module ActsAsFerret
       ################################################################################
       # start the server as a daemon process
       def start
-        raise "ferret_server not configured for #{RAILS_ENV}" unless (@cfg.uri rescue nil)
+        raise "ferret_server not configured for #{Rails.env}" unless (@cfg.uri rescue nil)
         platform_daemon { run_drb_service }
       end
 
       ################################################################################
       # run the server and block until it exits
       def run
-        raise "ferret_server not configured for #{RAILS_ENV}" unless (@cfg.uri rescue nil)
+        raise "ferret_server not configured for #{Rails.env}" unless (@cfg.uri rescue nil)
         run_drb_service
       end
 

data/lib/instance_methods.rb

@@ -103,7 +103,7 @@ module ActsAsFerret #:nodoc:
       end
       true # signal success to AR
     end
-    def ferret_update; ferret_create end
+    alias :ferret_update :ferret_create
     
 
     # remove from index

data/lib/server_manager.rb

@@ -17,11 +17,11 @@ OptionParser.new do |optparser|
     exit
   end
   
-  optparser.on('-R', '--root=PATH', 'Set RAILS_ROOT to the given string') do |r|
+  optparser.on('-R', '--root=PATH', 'Set Rails.root to the given string') do |r|
     $ferret_server_options['root'] = r
   end
 
-  optparser.on('-e', '--environment=NAME', 'Set RAILS_ENV to the given string') do |e|
+  optparser.on('-e', '--environment=NAME', 'Set Rails.env to the given string') do |e|
     $ferret_server_options['environment'] = e
   end
 
@@ -37,19 +37,32 @@ OptionParser.new do |optparser|
 end
 
 ################################################################################
+
+def determine_rails_root
+  possible_rails_roots = [
+    $ferret_server_options['root'],
+    (defined?(FERRET_SERVER) ? File.join(File.dirname(FERRET_SERVER), '..') : nil),
+    File.join(File.dirname(__FILE__), *(['..']*4)),
+    '.'
+  ].compact
+  # take the first dir where environment.rb can be found
+  possible_rails_roots.find{ |dir| File.readable?(File.join(dir, 'config', 'environment.rb')) }
+end
+
 begin
   ENV['FERRET_USE_LOCAL_INDEX'] = 'true'
   ENV['RAILS_ENV'] = $ferret_server_options['environment']
-  
   # determine RAILS_ROOT unless already set
-  RAILS_ROOT = $ferret_server_options['root'] || File.join(File.dirname(__FILE__), *(['..']*4)) unless defined? RAILS_ROOT
-  # check if environment.rb is present
-  rails_env_file = File.join(RAILS_ROOT, 'config', 'environment')
-  raise "Unable to find Rails environment.rb at \n#{rails_env_file}.rb\nPlease use the --root option of ferret_server to point it to your RAILS_ROOT." unless File.exists?(rails_env_file+'.rb')
-  # load it
-  require rails_env_file
-
-  require 'acts_as_ferret'
+  Rails.root = determine_rails_root
+  
+  begin
+    require File.join(Rails.root, 'config', 'environment')
+  rescue LoadError
+    puts "Unable to find Rails environment.rb in any of these locations:\n#{possible_rails_roots.join("\n")}\nPlease use the --root option of ferret_server to point it to your Rails.root."
+    raise $!
+  end
+
+  # require 'acts_as_ferret'
   ActsAsFerret::Remote::Server.new.send($ferret_server_action)
 rescue Exception => e
   $stderr.puts(e.message)

data/lib/unix_daemon.rb

@@ -13,7 +13,7 @@ module ActsAsFerret
           trap("TERM") { exit(0) }
           sess_id = Process.setsid
           STDIN.reopen("/dev/null")
-          STDOUT.reopen("#{RAILS_ROOT}/log/ferret_server.out", "a")
+          STDOUT.reopen("#{Rails.root}/log/ferret_server.out", "a")
           STDERR.reopen(STDOUT)
           block.call
         end

data/script/ferret_server

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+FERRET_SERVER = File.expand_path(__FILE__)
+
 begin
   require File.join(File.dirname(__FILE__), '../vendor/plugins/acts_as_ferret/lib/server_manager')
 rescue LoadError

metadata

@@ -1,12 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_ferret
 version: !ruby/object:Gem::Version 
+  hash: -428173559
   prerelease: false
   segments: 
   - 0
   - 4
-  - 7
-  version: 0.4.7
+  - 8
+  - rails3
+  version: 0.4.8.rails3
 platform: ruby
 authors: 
 - Jens Kraemer
@@ -14,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-06 13:50:00 +02:00
+date: 2010-07-13 14:10:00 +02:00
 default_executable: aaf_install
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -167,7 +170,7 @@ files:
 - doc/demo/vendor/plugins/will_paginate/test/pagination_test.rb
 - doc/monit-example
 - doc/README.win32
-- init.rb
+- rails/init.rb
 - install.rb
 - lib/act_methods.rb
 - lib/acts_as_ferret.rb
@@ -213,6 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -220,13 +224,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: acts_as_ferret
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: acts_as_ferret - Ferret based full text search for any ActiveRecord model