acts_as_ferret 0.4.1 → 0.4.2

data/script/ferret_daemon

@@ -0,0 +1,94 @@
+# Ferret Win32 Service Daemon, called by Win 32 service, 
+# created by Herryanto Siatono <herryanto@pluitsolutions.com>
+#
+# see doc/README.win32 for usage instructions
+#
+require 'optparse'
+require 'win32/service'
+include Win32
+
+# Read options
+options = {}
+ARGV.options  do |opts|
+  opts.banner = 'Usage: ferret_daemon [options]'
+  opts.on("-l", "--log FILE", "Daemon log file") {|file| options[:log] = file }  
+  opts.on("-c","--console","Run Ferret server on console.") {options[:console] = true}
+  opts.on_tail("-h","--help", "Show this help message") {puts opts; exit}
+  opts.on("-e", "--environment ENV ", "Rails environment") {|env|
+    options[:environment] = env
+    ENV['RAILS_ENV'] = env
+  }
+  opts.parse!
+end
+
+require File.dirname(__FILE__) + '/../config/environment'
+
+# Ferret Win32 Service Daemon, called by Win 32 service, 
+# to run on the console, use -c or --console option.
+module Ferret
+  class FerretDaemon < Daemon
+    # Standard logger to redirect STDOUT and STDERR to a log file
+    class FerretStandardLogger
+      def initialize(logger)
+        @logger = logger
+      end
+      
+      def write(s)
+        @logger.info s
+      end
+    end
+    
+    def initialize(options={})
+      @options = options
+      
+      # initialize logger
+      if options[:log]      
+        @logger = Logger.new @options[:log]
+      else 
+        @logger = Logger.new RAILS_ROOT + "/log/ferret_service_#{RAILS_ENV}.log"
+      end
+      
+      # redirect stout and stderr to Ferret logger if running as windows service
+      $stdout = $stderr = FerretStandardLogger.new(@logger) unless @options[:console]
+      
+      log "Initializing FerretDaemon..."
+      if @options[:console]
+      	self.service_init
+      	self.service_main
+      end
+    end
+    
+    def service_main
+      log "Service main enterred..."
+      
+      while running?
+        log "Listening..."
+        sleep
+      end
+      
+      log "Service main exit..."
+    end
+    
+    def service_init
+      log "Starting Ferret DRb server..."
+      ActsAsFerret::Remote::Server.start
+      log "FerretDaemon started."    
+    end
+    
+    def service_stop
+      log "Stopping service..."
+      DRb.stop_service
+      log "FerretDaemon stopped."
+    end
+    
+    def log(msg)
+      @logger.info msg 
+      puts msg if @options[:console]
+    end
+  end
+end
+
+if __FILE__ == $0
+  d = Ferret::FerretDaemon.new(options)
+  d.mainloop
+end

data/script/ferret_server

@@ -1,18 +1,2 @@
 #!/usr/bin/env ruby
-
-# Ferret DRb server launcher script
-#
-# Place doc/ferret_server.yml into RAILS_ROOT/config and fit to taste.
-#
-# Start this script with script/runner and RAILS_ENV set.
-#
-# to run the unit tests against the drb server, start it with
-# RAILS_ENV=test script/runner script/ferret_server
-# and run your tests with the AAF_REMOTE environment variable set to a
-# non-empty value
-
-
-ActsAsFerret::Remote::Server.start
-DRb.thread.join
-
-
+require File.join(File.dirname(__FILE__), '../vendor/plugins/acts_as_ferret/lib/server_manager')

data/script/ferret_service

@@ -0,0 +1,178 @@
+# Ferret Win32 Service Daemon install script 
+# created by Herryanto Siatono <herryanto@pluitsolutions.com>
+#
+# see doc/README.win32 for usage instructions
+#
+require 'optparse'
+require 'win32/service'
+include Win32
+
+module Ferret
+  # Parse and validate service command and options
+  class FerretServiceCommand
+    COMMANDS = ['install', 'remove', 'start', 'stop', 'help']
+    BANNER = "Usage: ruby script/ferret_service <command> [options]"
+    
+    attr_reader :options, :command
+    
+    def initialize
+      @options = {}
+    end
+    
+    def valid_command?      
+      COMMANDS.include?@command
+    end
+    
+    def valid_options?
+      @options[:name] and !@options[:name].empty?
+    end
+    
+    def print_command_list
+      puts BANNER 
+      puts "\nAvailable commands:\n"
+      puts COMMANDS.map {|cmd| " - #{cmd}\n"}
+      puts "\nUse option -h for each command to help."
+      exit
+    end
+    
+    def validate_options
+      errors = []
+      errors << "Service name is required." unless @options[:name]
+      
+      if (errors.size > 0)
+        errors << "Error found. Use: 'ruby script/ferret_service #{@command} -h' for to get help."
+        puts errors.join("\n")
+        exit
+      end
+    end
+    
+    def run(args)
+      @command = args.shift      
+      @command = @command.dup.downcase if @command
+      
+      # validate command and options      
+      print_command_list unless valid_command? or @command == 'help'
+      
+      opts_parser = create_options_parser
+      begin
+        opts_parser.parse!(args)
+      rescue OptionParser::ParseError => e
+        puts e
+        puts opts_parser
+      end
+      
+      # validate required options
+      validate_options
+    end
+    
+    def create_options_parser
+      opts_parser = OptionParser.new
+      opts_parser.banner = BANNER
+      opts_parser.on("-n", "--name=NAME", "Service name") {|name| @options[:name] = name }
+      opts_parser.on_tail("-t", "--trace",  "Display stack trace when exception thrown") { @options[:trace] = true }
+      opts_parser.on_tail("-h", "--help",   "Show this help message") { puts opts_parser; exit }
+      
+      if ['install'].include?@command
+        opts_parser.on("-d", "--display=NAME", "Service display name") {|name| @options[:display] = name }
+        
+        opts_parser.on("-l", "--log FILE", "Service log file") {|file| @options[:log] = file }  
+        opts_parser.on("-e",     "--environment ENV ",    "Rails environment") { |env|
+          @options[:environment] = env
+          ENV['RAILS_ENV'] = env
+        }    
+      end
+      opts_parser
+    end
+  end
+  
+  # Install, Remove, Start and Stop Ferret DRb server Win32 service
+  class FerretService
+    FERRET_DAEMON = 'ferret_daemon'
+    
+    def initialize
+    end
+    
+    def install
+      svc = Service.new
+      
+      begin
+        if Service.exists?(@options[:name])
+          puts "Service name '#{@options[:name]}' already exists."
+          return
+        end 
+        
+        svc.create_service do |s|
+          s.service_name = @options[:name]
+          s.display_name = @options[:display]
+          s.binary_path_name = binary_path_name
+          s.dependencies = []
+        end
+        
+        svc.close
+        puts "'#{@options[:name]}' service installed."
+      rescue => e
+        handle_error(e)
+      end
+    end
+    
+    def remove
+      begin
+        Service.stop(@options[:name])
+      rescue
+      end
+      
+      begin
+        Service.delete(@options[:name])    
+        puts "'#{@options[:name]}' service removed."
+      rescue => e      
+        handle_error(e)
+      end
+    end
+    
+    def start
+      begin
+        Service.start(@options[:name])
+        puts "'#{@options[:name]}' successfully started."
+      rescue => e
+        handle_error(e)
+      end 
+    end
+    
+    def stop
+      begin
+        Service.stop(@options[:name])
+        puts "'#{@options[:name]}' successfully stopped.\n"
+      rescue => e
+        handle_error(e)
+      end 
+    end
+    
+    def run(args)
+      svc_cmd = FerretServiceCommand.new
+      svc_cmd.run(args)
+      @options = svc_cmd.options
+      self.send(svc_cmd.command.to_sym)
+    end
+    
+    protected  
+    def handle_error(e)
+      if @options[:trace]
+        raise e
+      else
+        puts e
+      end
+    end
+    
+    def binary_path_name
+      path = ""
+      path << "#{ENV['RUBY_HOME']}/bin/" if ENV['RUBY_HOME']
+      path << "ruby.exe "
+      path << File.expand_path("script/" + FERRET_DAEMON)
+      path << " -e #{@options[:environment]} " if @options[:environment]
+      path << " -l #{@options[:log]} " if @options[:log]
+      path
+    end
+  end
+end
+
+Ferret::FerretService.new.run(ARGV)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: acts_as_ferret
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
-date: 2007-07-17 00:00:00 +02:00
+  version: 0.4.2
+date: 2007-11-18 00:00:00 +01:00
 summary: acts_as_ferret - Ferret based full text search for any ActiveRecord model
 require_paths: 
 - lib
@@ -13,7 +13,7 @@ homepage: http://projects.jkraemer.net/acts_as_ferret
 rubyforge_project: 
 description: 
 autorequire: acts_as_ferret
-default_executable: 
+default_executable: aaf_install
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
@@ -29,42 +29,50 @@ post_install_message:
 authors: 
 - Jens Kraemer
 files: 
-- script
-- config
-- doc
 - lib
-- LICENSE
-- rakefile
-- init.rb
-- install.rb
-- README
-- script/ferret_start
-- script/ferret_stop
-- script/ferret_server
-- config/ferret_server.yml
-- lib/ferret_server.rb
-- lib/more_like_this.rb
-- lib/shared_index.rb
 - lib/ferret_cap_tasks.rb
-- lib/local_index.rb
-- lib/multi_index.rb
-- lib/remote_index.rb
 - lib/acts_as_ferret.rb
-- lib/ferret_result.rb
-- lib/shared_index_class_methods.rb
+- lib/multi_index.rb
 - lib/ferret_extensions.rb
-- lib/index.rb
+- lib/more_like_this.rb
 - lib/instance_methods.rb
 - lib/class_methods.rb
+- lib/ferret_server.rb
+- lib/shared_index.rb
+- lib/local_index.rb
+- lib/remote_index.rb
+- lib/index.rb
 - lib/act_methods.rb
+- lib/shared_index_class_methods.rb
+- lib/ferret_result.rb
+- lib/search_results.rb
+- lib/bulk_indexer.rb
+- lib/server_manager.rb
+- lib/unix_daemon.rb
+- LICENSE
+- rakefile
+- init.rb
+- README
+- script
+- script/ferret_daemon
+- script/ferret_service
+- script/ferret_server
+- doc
+- doc/monit-example
+- doc/README.win32
+- config
+- config/ferret_server.yml
+- install.rb
+- bin
+- bin/aaf_install
 test_files: []
 
 rdoc_options: []
 
 extra_rdoc_files: []
 
-executables: []
-
+executables: 
+- aaf_install
 extensions: []
 
 requirements: []

data/script/ferret_start

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-# Ferret DRb server launcher script
-#
-# Place doc/ferret_server.yml into RAILS_ROOT/config and fit to taste. Start
-# it with RAILS_ENV set to the desired environment.
-#
-#
-# To run the demo project's unit tests against the drb server, start it with
-# 
-# RAILS_ENV=test script/ferret_start 
-#
-# and run your tests with the AAF_REMOTE environment variable set to a 
-# non-empty value:
-#
-# AAF_REMOTE=true rake
-#
-# The server writes a log file in log/ferret_server.log, it's 
-# STDOUT gets redirected to log/ferret_server.out
-
-ENV['FERRET_USE_LOCAL_INDEX'] = 'true'
-require File.dirname(__FILE__) + '/../config/boot'
-require RAILS_ROOT + '/config/environment'
-
-
-config = ActsAsFerret::Remote::Config.load
-@pid_file = config['pid_file']
-
-def write_pid_file
-  raise "No PID file defined" if @pid_file.blank?
-  open(@pid_file,"w") {|f| f.write(Process.pid) }
-end
-
-def safefork
-  tryagain = true
-
-  while tryagain
-    tryagain = false
-    begin
-      if pid = fork
-        return pid
-      end
-    rescue Errno::EWOULDBLOCK
-      sleep 5
-      tryagain = true
-    end
-  end
-end
-
-safefork and exit
-at_exit do
-  File.unlink(@pid_file) if @pid_file && File.exists?(@pid_file) && File.read(@pid_file).to_i == Process.pid
-end
-print "Starting ferret DRb server..."
-trap("TERM") { exit(0) }
-sess_id = Process.setsid
-
-
-begin
-  ActsAsFerret::Remote::Server.start
-  write_pid_file
-  puts "Done."
-  STDIN.reopen "/dev/null"                                 # Free file descriptors and
-  STDOUT.reopen "#{RAILS_ROOT}/log/ferret_server.out", "a" # point them somewhere sensible
-  STDERR.reopen STDOUT                                     # STDOUT/STDERR should go to a logfile
-rescue
-  $stderr.puts "Error starting ferret DRb server: #{$!}"
-  $stderr.puts $!.backtrace
-  exit(1)
-end
-DRb.thread.join
-
-# vim:set filetype=ruby:

data/script/ferret_stop

@@ -1,26 +0,0 @@
-#!/usr/bin/env script/runner
-
-config = ActsAsFerret::Remote::Config.load
-
-def send_signal(signal, pid_file)
-  pid = open(pid_file).read.to_i
-  print "Sending #{signal} to ferret_server with PID #{pid}..."
-  begin
-    Process.kill(signal, pid)
-  rescue Errno::ESRCH
-    puts "Process does not exist. Not running. Removing stale pid file anyway."
-    File.unlink(pid_file)
-  end
-
-  puts "Done."
-end
-
-pid_file = config['pid_file']
-puts "Stopping ferret_server..."
-if File.file?(pid_file)
-  send_signal("TERM", pid_file) 
-else
-  puts "no pid file found"
-end
-
-# vim:set filetype=ruby: