daemonz 0.3.0 → 0.3.1

data/README.textile

@@ -4,9 +4,14 @@ bq. Automatically starts and stops the daemons in a Rails application.
 
 h2. Installation
 
-Install with:
+Add the following entry to your Gemfile:
 <pre>
-script/plugin install git://github.com/costan/daemonz.git
+gem 'daemonz'
+</pre>
+
+After running <code>bundle install</code> generate the default configuration:
+<pre>
+rails g daemonz:config
 </pre>
 
 You don't need to do anything in your code for daemonz to work. It will start
@@ -31,7 +36,7 @@ The scaffolded code includes the configuration file, a daemon skeleton using the
 <code>simple-daemon</code> gem, and an integration test skeleton.
 
 <pre>
-script/generate daemon YourDaemonName
+rails g daemon YourDaemonName
 </pre>
 
 h2. Testing

data/Rakefile

@@ -1,22 +1,19 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the daemonz plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the daemonz plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Daemonz'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+require "rake"
+ 
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "daemonz"
+    gem.summary = "Automatically starts and stops the daemons in a Rails application"
+    gem.email = "victor@costan.us"
+    gem.homepage = "http://github.com/costan/daemonz"
+    gem.authors = ["Victor Costan"]
+    gem.files = Dir["*", "{lib}/**/*"]
+    gem.add_dependency 'simple-daemon'
+    gem.add_dependency 'zerg_support'
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/daemonz.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{daemonz}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
@@ -18,16 +18,27 @@ Gem::Specification.new do |s|
     "MIT-LICENSE",
      "README.textile",
      "Rakefile",
+     "VERSION",
      "config_template.yml",
      "daemonz.gemspec",
      "init.rb",
      "lib/daemonz.rb",
      "lib/daemonz/config.rb",
+     "lib/daemonz/generators/config/config_generator.rb",
+     "lib/daemonz/generators/config/templates/config.yml",
+     "lib/daemonz/generators/config/templates/prepackaged/ferret.yml",
+     "lib/daemonz/generators/config/templates/prepackaged/starling.yml",
+     "lib/daemonz/generators/daemon/daemon_generator.rb",
+     "lib/daemonz/generators/daemon/templates/config.yml",
+     "lib/daemonz/generators/daemon/templates/daemon.rb.erb",
+     "lib/daemonz/generators/daemon/templates/integration_test.rb.erb",
      "lib/daemonz/killer.rb",
      "lib/daemonz/logging.rb",
      "lib/daemonz/manage.rb",
      "lib/daemonz/master.rb",
-     "lib/daemonz/process.rb"
+     "lib/daemonz/process.rb",
+     "lib/daemonz/railtie.rb",
+     "lib/daemonz/tasks/daemonz_tasks.rake"
   ]
   s.homepage = %q{http://github.com/costan/daemonz}
   s.rdoc_options = ["--charset=UTF-8"]

data/lib/daemonz/config.rb

@@ -17,7 +17,7 @@ module Daemonz
   
   def self.disabled_without_cache!
     return true if config[:disabled]
-    return true if config[:disabled_in].include? RAILS_ENV
+    return true if config[:disabled_in].include? Rails.root
     config[:disabled_for].any? do |suffix|
       suffix == $0[-suffix.length, suffix.length]
     end
@@ -27,7 +27,7 @@ module Daemonz
   def self.configure(config_file, options = {})
     load_configuration config_file
     
-    config[:root_path] ||= RAILS_ROOT
+    config[:root_path] ||= Rails.root
     if options[:force_enabled]
       config[:disabled] = false
       config[:disabled_for] = []
@@ -38,7 +38,7 @@ module Daemonz
       config[:disabled_in] ||= ['test']
     end
     config[:disabled] = false if config[:disabled] == 'false'
-    config[:master_file] ||= File.join RAILS_ROOT, "tmp", "pids", "daemonz.master.pid"
+    config[:master_file] ||= Rails.root.join "tmp", "pids", "daemonz.master.pid"
     
     config[:logger] &&= options[:override_logger]
     self.configure_logger
@@ -77,7 +77,7 @@ module Daemonz
       end
     else
       logger.warn "Daemonz configuration not found - #{config_file}"
-      @config = {}
+      @config = { :disabled => true }
     end
   end
   

data/lib/daemonz/generators/config/config_generator.rb

@@ -0,0 +1,21 @@
+# :nodoc: namespace
+module Daemonz
+# :nodoc: namespace
+module Generators
+  
+class ConfigGenerator < Rails::Generators::Base
+  def self.source_root
+    @source_root ||= File.expand_path 'templates', File.dirname(__FILE__)
+  end
+    
+  def create_configuration
+    copy_file 'config.yml', 'config/daemonz.yml'
+    
+    empty_directory 'config/daemonz'
+    copy_file 'prepackaged/ferret.yml', 'config/daemonz/ferret.yml'
+    copy_file 'prepackaged/starling.yml', 'config/daemonz/starling.yml'
+  end  
+end  # class Daemonz::Generators::ConfigGenerator
+
+end  # namespace Daemonz::Generators
+end  # namespace Daemonz

data/lib/daemonz/generators/config/templates/config.yml

@@ -0,0 +1,36 @@
+# Configuration file for the daemonz plugin.
+
+---
+:daemons: 
+  # Daemon configurations placed here will be read as if they were in a file in
+  # config/daemonz. This is more maintainable if you only have one daemon.
+
+# The base path for daemon binaries specified in binary, start_binary and
+# stop_binary.
+:root_path: <%= Rails.root %>
+
+# Where daemonz should log - set to stdout, stderr, or rails.
+:logger: stdout
+
+# Set to true to completely disable daemonz, and not load any plugins.
+:disabled: false
+
+# daemonz is loaded every time the Rails framework is loaded. Sometimes
+# (e.g. when performing migrations) daemons aren't required, so we shouldn't
+# have to wait for the few seconds it takes to start / stop daemons.
+
+# Daemons will not be started / stopped when the name of the binary that's
+# loading Rails ($0) is one of the following.
+:disabled_for: 
+- 'rake'
+- 'script/generate'
+- 'script/destroy'
+- 'script/plugin'
+# Assuming you don't want to wait for daemons to start most of the times when
+# you pull up a console. You can always start / stop them up by hand with
+# rake daemons:start / rake daemons:stop, or you can remove the line below.
+- 'irb'
+
+# Daemons will not be started for the following environments. 
+:disabled_in:
+- 'test'

data/lib/daemonz/generators/config/templates/prepackaged/ferret.yml

@@ -0,0 +1,38 @@
+# Daemonz example: configuration for ferret.
+#
+# daemonz starts the daemons according to the alphabetic order of their 
+# configuration file names. start_order can be used to override this order.
+# Daemons will be stopped in the reverse order of their starting order.
+#
+# daemonz likes to ensure that multiple instances of a daemon don't run at the
+# same time, as this can be fatal for daemons with on-disk state, like ferret.
+# So daemonz ensures that a daemon is dead before starting it, and right after
+# stopping it. This is achieved using the following means:
+#   * Stop commands: first, daemonz uses the stop command supplied in the daemon
+#                    configuration
+#   * PID files: if the daemon has .pid files, daemonz tries to read the file
+#                and find the corresponding processes, then tree-kills them
+#   * Process table: if possible, daemonz dumps the process table, looks for the 
+#                    processes that look like the daemon, and tree-kills them
+#   * Pattern matching: processes whose command lines have the same arguments as
+#                       those given to daemon "look like" that daemon
+#   * Tree killing: a daemon is killed by killing its main process, together
+#                   with all processes descending from that process; a process
+#                   is first sent SIGTERM and, if it's still alive after a
+#                   couple of seconds, it's sent a SIGKILL
+
+---
+ferret:
+  # Ferret uses different binaries to be started and stopped. 
+  :start_binary: script/ferret_server
+  :stop_binary: script/ferret_server
+  # The arguments to be given to the start and stop commands.
+  # Note that this file is processed with Erb, like your views.
+  :start_args: -e <%= Rails.env %> start
+  :stop_args: -e <%= Rails.env %> stop
+  # Time to wait after sending the stop command, before killing the daemon.
+  :delay_before_kill: 0.35
+  # Pattern for the PID file(s) used by the daemon.
+  :pids: tmp/pids/ferret*.pid
+  # daemonz will ignore this daemon configuration when this flag is true
+  :disabled: true

data/lib/daemonz/generators/config/templates/prepackaged/starling.yml

@@ -0,0 +1,43 @@
+# Daemonz example: configuration for running starling.
+#
+# daemonz starts the daemons according to the alphabetic order of their 
+# configuration file names. start_order can be used to override this order.
+# Daemons will be stopped in the reverse order of their starting order.
+#
+# daemonz likes to ensure that multiple instances of a daemon don't run at the
+# same time, as this can be fatal for daemons with on-disk state, like ferret.
+# So daemonz ensures that a daemon is dead before starting it, and right after
+# stopping it. This is achieved using the following means:
+#   * Stop commands: first, daemonz uses the stop command supplied in the daemon
+#                    configuration
+#   * PID files: if the daemon has .pid files, daemonz tries to read the file
+#                and find the corresponding processes, then tree-kills them
+#   * Process table: if possible, daemonz dumps the process table, looks for the 
+#                    processes that look like the daemon, and tree-kills them
+#   * Pattern matching: processes whose command lines have the same arguments as
+#                       those given to daemon "look like" that daemon
+#   * Tree killing: a daemon is killed by killing its main process, together
+#                   with all processes descending from that process; a process
+#                   is first sent SIGTERM and, if it's still alive after a
+#                   couple of seconds, it's sent a SIGKILL
+
+---
+starling:
+  # The same binary is used to start and stop starling.
+  :binary: starling
+  # The binary name will not be merged with root_path.
+  :absolute_binary: true
+  :start_args: -d -h 127.0.0.1 -p 16020 -P <%= Rails.root.join 'tmp', 'pids', 'starling.pid' %> -q <%= Rails.root.join 'tmp' %> -L <%= Rails.root.join 'log', 'starling.log' %>
+  # No arguments are needed to stop starling.
+  :stop_args: ''
+  # Pattern for the PID file(s) used by the daemon.
+  :pids: tmp/pids/starling*.pid
+  # Override for the patterns used to identify the daemon's processes.
+  :kill_patterns: <%= Rails.root.join 'log', 'starling.log' %>
+  # Time to wait after sending the stop command, before killing the daemon.
+  :delay_before_kill: 0.2
+  # Override the daemon startup order. Starling consumer daemons should have
+  # their start_order set to 2, so starling is running when they start.
+  :start_order: 1
+  # daemonz will ignore this daemon configuration when this flag is true
+  :disabled: true

data/lib/daemonz/generators/daemon/daemon_generator.rb

@@ -0,0 +1,24 @@
+# :nodoc: namespace
+module Daemonz
+# :nodoc: namespace
+module Generators
+  
+class DaemonGenerator < Rails::Generators::NamedBase
+  def self.source_root
+    @source_root ||= File.expand_path 'templates', File.dirname(__FILE__)
+  end
+  
+  def create_harness
+    empty_directory 'config/daemonz'
+    template "config.yml", "config/daemonz/#{file_name}.yml"
+      
+    empty_directory 'script/background'
+    template 'daemon.rb.erb', "script/background/#{file_name}.rb"
+      
+    empty_directory 'test/integration'
+    template 'integration_test.rb.erb', "test/integration/#{file_name}_test.rb"
+  end
+end  # class Daemon::Generators::DaemonGenerator
+
+end  # namespace Daemon::Generators
+end  # namespace Daemon

data/lib/daemonz/generators/daemon/templates/config.yml

@@ -0,0 +1,39 @@
+# Automatically generated daemon configuration for <%= file_name %>.
+#
+# daemonz starts the daemons according to the alphabetic order of their 
+# configuration file names. start_order can be used to override this order.
+# Daemons will be stopped in the reverse order of their starting order.
+#
+# daemonz likes to ensure that multiple instances of a daemon don't run at the
+# same time, as this can be fatal for daemons with on-disk state, like ferret.
+# So daemonz ensures that a daemon is dead before starting it, and right after
+# stopping it. This is achieved using the following means:
+#   * Stop commands: first, daemonz uses the stop command supplied in the daemon
+#                    configuration
+#   * PID files: if the daemon has .pid files, daemonz tries to read the file
+#                and find the corresponding processes, then tree-kills them
+#   * Process table: if possible, daemonz dumps the process table, looks for the 
+#                    processes that look like the daemon, and tree-kills them
+#   * Pattern matching: processes whose command lines have the same arguments as
+#                       those given to daemon "look like" that daemon
+#   * Tree killing: a daemon is killed by killing its main process, together
+#                   with all processes descending from that process; a process
+#                   is first sent SIGTERM and, if it's still alive after a
+#                   couple of seconds, it's sent a SIGKILL
+
+---
+<%= file_name %>:
+  # Pattern for the PID file(s) used by the daemon.
+  :pids: tmp/<%= class_name %>.pid
+  # The same binary is used to start and stop <% file_name %>.  
+  :binary: script/background/<%= file_name %>.rb 
+  # The arguments to be given to the start and stop commands.
+  :start_args: start <%= '<%= Rails.env %' + '>' %>
+  :stop_args: stop
+  # Time to wait after sending the stop command, before killing the daemon.    
+  :delay_before_kill: 1.0
+  # If this is a consumer of another daemon (like starling), make sure the start
+  # order index is bigger than the other daemons' start order index. 
+  :start_order: 1
+  # daemonz will ignore this daemon configuration when this flag is true    
+  :disabled: false

data/lib/daemonz/generators/daemon/templates/daemon.rb.erb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+# Load Rails.
+ENV['RAILS_ENV'] = ARGV[1] if ARGV[1]
+require File.dirname(__FILE__) + '/../../config/environment.rb'
+
+# TODO: More ARGV-based setup here.
+
+
+# Restore timestamps in the log.
+class Logger
+  def format_message(severity, timestamp, progname, msg)
+    "#{severity[0,1]} [#{timestamp} PID:#{$$}] #{progname}: #{msg}\n"
+  end
+end
+
+
+require 'simple-daemon'
+class <%= class_name %> < SimpleDaemon::Base
+  SimpleDaemon::WORKING_DIRECTORY = Rails.root.join 'log'
+  
+  def self.start    
+    STDOUT.sync = true
+    @logger = Logger.new(STDOUT)
+    @logger.level = Rails.env.production?
+    if Rails.env.development?
+      # Disable SQL logging in debugging.
+			# This is handy if your daemon queries the database often.
+      ActiveRecord::Base.logger.level = Logger::INFO
+    end
+		
+    @logger.info "Starting daemon #{self.name}"		
+        
+    loop do 
+      begin
+        # TODO: execute some tasks in the background repeatedly
+        
+        # YOUR CODE HERE
+        
+        # Optional. Sleep between tasks.
+        Kernel.sleep 1
+      rescue Exception => e
+        # This gets thrown when we need to get out.
+        raise if e.kind_of? SystemExit
+				
+        @logger.error "Error in daemon #{self.name} - #{e.class.name}: #{e}"
+        @logger.info e.backtrace.join("\n")
+        
+        # If something bad happened, it usually makes sense to wait for some
+        # time, so any external issues can settle.
+        Kernel.sleep 5
+      end
+    end
+  end
+  
+  def self.stop
+    @logger.info "Stopping daemon #{self.name}"
+  end
+end
+
+<%= class_name %>.daemonize

data/lib/daemonz/generators/daemon/templates/integration_test.rb.erb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class <%= class_name %>Test < ActionController::IntegrationTest
+  fixtures :all
+  
+  # Normally, Rails runs the entire test in a transaction, so the database
+  # changes done in test are isolated from the database changes made by daemons.
+  # The line can be removed if the test and the daemon don't communicate via the
+  # database.
+  self.use_transactional_fixtures = false
+
+  test "daemon interactions" do
+	  # stuff that should be done before the daemon runs (e.g. database setup)
+		
+    Daemonz.with_daemons do
+		  # test interactions with the daemon
+    end
+  end
+end

data/lib/daemonz/logging.rb

@@ -1,7 +1,8 @@
 module Daemonz
-  @logger = RAILS_DEFAULT_LOGGER
-  class <<self
-    attr_reader :logger
+  @logger = Rails.logger
+  
+  def self.logger
+    @logger || Rails.logger
   end
   
   def self.configure_logger
@@ -13,7 +14,9 @@ module Daemonz
       @logger = Logger.new(STDERR)
       @logger.level = Logger::DEBUG
     when 'rails'
-      @logger = RAILS_DEFAULT_LOGGER
+      @logger = Rails.logger
+    else
+      @logger = Rails.logger   
     end
   end
 end

data/lib/daemonz/manage.rb

@@ -13,7 +13,7 @@ module Daemonz
   
   # Complete startup used by rake:start and at Rails plug-in startup.
   def self.safe_start(options = {})
-    daemonz_config = File.join(RAILS_ROOT, 'config', 'daemonz.yml')
+    daemonz_config = Rails.root.join 'config', 'daemonz.yml'
     Daemonz.configure daemonz_config, options
     
     if Daemonz.config[:is_master]
@@ -25,7 +25,7 @@ module Daemonz
   # Complete shutdown used by rake:start and at Rails application exit.
   def self.safe_stop(options = {})
     if options[:configure]
-      daemonz_config = File.join(RAILS_ROOT, 'config', 'daemonz.yml')
+      daemonz_config = Rails.root.join 'config', 'daemonz.yml'
       Daemonz.configure daemonz_config, options
     end
     if Daemonz.config[:is_master]

data/lib/daemonz/railtie.rb

@@ -0,0 +1,24 @@
+require 'daemonz'
+require 'rails'
+
+# :nodoc: namespace
+module Daemonz
+
+# Railtie for the daemonz plugin.
+class Railtie < Rails::Railtie
+  initializer :control_daemon_processes do
+    Daemonz.safe_start
+    at_exit { Daemonz.safe_stop unless Daemonz.keep_daemons_at_exit }
+  end
+
+  rake_tasks do
+    load 'daemonz/tasks/daemonz_tasks.rake'    
+  end
+  
+  generators do
+    require 'daemonz/generators/config/config_generator.rb'
+    require 'daemonz/generators/daemon/daemon_generator.rb'
+  end
+end  # class Daemonz::Railtie
+
+end  # namespace Daemonz

data/lib/daemonz/tasks/daemonz_tasks.rake

@@ -0,0 +1,14 @@
+namespace :daemons do
+  desc "(testing only) Starts the daemons in config/daemonz.yml"
+  task :start => :environment do
+    Daemonz.safe_start :force_enabled => true, :override_logger => 'stdout'
+    Daemonz.keep_daemons_at_exit = true 
+  end
+
+  desc "(testing only) Stops the daemons in config/daemonz.yml"
+  task :stop => :environment do
+    Daemonz.safe_stop :force_enabled => true, :configure => true,
+                      :override_logger => 'stdout'
+    Daemonz.keep_daemons_at_exit = true                      
+  end  
+end

data/lib/daemonz.rb

@@ -8,3 +8,5 @@ require 'daemonz/logging.rb'
 require 'daemonz/manage.rb'
 require 'daemonz/master.rb'
 require 'daemonz/process.rb'
+
+require 'daemonz/railtie.rb' if defined?(Rails)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Victor Costan
@@ -53,16 +53,27 @@ files:
 - MIT-LICENSE
 - README.textile
 - Rakefile
+- VERSION
 - config_template.yml
 - daemonz.gemspec
 - init.rb
 - lib/daemonz.rb
 - lib/daemonz/config.rb
+- lib/daemonz/generators/config/config_generator.rb
+- lib/daemonz/generators/config/templates/config.yml
+- lib/daemonz/generators/config/templates/prepackaged/ferret.yml
+- lib/daemonz/generators/config/templates/prepackaged/starling.yml
+- lib/daemonz/generators/daemon/daemon_generator.rb
+- lib/daemonz/generators/daemon/templates/config.yml
+- lib/daemonz/generators/daemon/templates/daemon.rb.erb
+- lib/daemonz/generators/daemon/templates/integration_test.rb.erb
 - lib/daemonz/killer.rb
 - lib/daemonz/logging.rb
 - lib/daemonz/manage.rb
 - lib/daemonz/master.rb
 - lib/daemonz/process.rb
+- lib/daemonz/railtie.rb
+- lib/daemonz/tasks/daemonz_tasks.rake
 has_rdoc: true
 homepage: http://github.com/costan/daemonz
 licenses: []