kennethkalmer-daemon-kit 0.1.6 → 0.1.7.3

data/Configuration.txt

@@ -0,0 +1,58 @@
+= Configuring your daemon
+
+daemon-kit provides a multitude of ways to configure your daemon, this document
+will outline the different options available to you.
+
+== Configuration files and #DaemonKit::Config
+
+#DaemonKit::Config gives you easy access to any YAML configuration
+files you have in your <em>config</em> directory.
+
+You can access the configuration files like this:
+
+  config = DaemonKit::Config.load('sample')
+
+The above snippet relies on the presence of a <em>config/sample.yml</em> file.
+
+#DaemonKit::Config is environment aware, so configuration files are
+parsed for a top-level key that is the same as the value of
+<em>DAEMON_ENV</em>, and if present is loaded into the object as the
+configuration data. If the key is not present, the whole YAML
+document is exposed as configuration data.
+
+== Command line arguments
+
+The most flexible way to configure your daemon is through command line
+arguments, or switches.
+
+DaemonKit includes a couple of its own arguments that can be used:
+
+  -e ENV (or --env ENV) to set the daemon environment
+  --pid /path/to/pidfile to set the path to a pidfile
+  -v shows the DaemonKit version
+  -h shows a useful help message
+
+=== Custom arguments
+
+It is possible for you to specify your own arguments as well, by
+updating the <em>config/arguments.rb</em> file. This file is eval'd
+inside #DaemonKit::Arguments and gives you access to the following two
+variables:
+
+* opts - Instance of OptionParser[http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html]
+* @options - A standard Ruby hash that you can populate and access later
+
+Your custom arguments can be accessed like this:
+
+  DaemonKit.arguments.options
+
+=== Advanced Configuration
+
+All the writable attributes of the default #DaemonKit::Configuration
+instance call also be modified from the command line using the special
+<em>--config</em> arguments:
+
+  --config force_kill_wait=30
+
+This happens after <em>config/environment.rb</em> is processed, so all
+command line arguments will overwrite those values.

data/History.txt

@@ -1,3 +1,19 @@
+== 0.1.7.3 2009-05-31
+
+* Removed dependency on daemons gem, now handled in house
+* New argument management
+* Some more docs
+
+== 0.1.7.1 2009-05-28
+
+* Fixed some minor issue with Capistrano support
+* Added support for generating dog/monit configuration files via rake
+* Initial implementation of ./script/* utilities
+
+== 0.1.7 2009-05-26
+
+* Capistrano deployment support
+
 == 0.1.6 2009-05-13
 
 * DaemonKit::Safety class to handle the trapping and logging of

data/Manifest.txt

@@ -1,7 +1,8 @@
+Configuration.txt
 History.txt
 Manifest.txt
 PostInstall.txt
-README.textile
+README.rdoc
 Rakefile
 TODO.txt
 app_generators/daemon_kit/USAGE
@@ -9,6 +10,7 @@ app_generators/daemon_kit/daemon_kit_generator.rb
 app_generators/daemon_kit/templates/README
 app_generators/daemon_kit/templates/Rakefile
 app_generators/daemon_kit/templates/bin/daemon.erb
+app_generators/daemon_kit/templates/config/arguments.rb
 app_generators/daemon_kit/templates/config/boot.rb
 app_generators/daemon_kit/templates/config/environment.rb
 app_generators/daemon_kit/templates/config/environments/development.rb
@@ -18,6 +20,9 @@ app_generators/daemon_kit/templates/config/post-daemonize/readme
 app_generators/daemon_kit/templates/config/pre-daemonize/readme
 app_generators/daemon_kit/templates/lib/daemon.rb
 app_generators/daemon_kit/templates/libexec/daemon.erb
+app_generators/daemon_kit/templates/script/console
+app_generators/daemon_kit/templates/script/destroy
+app_generators/daemon_kit/templates/script/generate
 bin/daemon_kit
 daemon_generators/amqp/USAGE
 daemon_generators/amqp/amqp_generator.rb
@@ -28,6 +33,13 @@ daemon_generators/cron/USAGE
 daemon_generators/cron/cron_generator.rb
 daemon_generators/cron/templates/config/initializers/cron.rb
 daemon_generators/cron/templates/libexec/daemon.rb
+daemon_generators/deploy_capistrano/deploy_capistrano_generator.rb
+daemon_generators/deploy_capistrano/templates/Capfile
+daemon_generators/deploy_capistrano/templates/USAGE
+daemon_generators/deploy_capistrano/templates/config/deploy.rb
+daemon_generators/deploy_capistrano/templates/config/deploy/production.rb
+daemon_generators/deploy_capistrano/templates/config/deploy/staging.rb
+daemon_generators/deploy_capistrano/templates/config/environments/staging.rb
 daemon_generators/jabber/USAGE
 daemon_generators/jabber/jabber_generator.rb
 daemon_generators/jabber/templates/config/initializers/jabber.rb
@@ -42,8 +54,14 @@ daemon_generators/nanite_agent/templates/libexec/daemon.rb
 lib/daemon_kit.rb
 lib/daemon_kit/amqp.rb
 lib/daemon_kit/application.rb
+lib/daemon_kit/arguments.rb
+lib/daemon_kit/commands/console.rb
 lib/daemon_kit/config.rb
+lib/daemon_kit/console_daemon.rb
+lib/daemon_kit/core_ext.rb
+lib/daemon_kit/core_ext/string.rb
 lib/daemon_kit/cron.rb
+lib/daemon_kit/deployment/capistrano.rb
 lib/daemon_kit/error_handlers/base.rb
 lib/daemon_kit/error_handlers/hoptoad.rb
 lib/daemon_kit/error_handlers/mail.rb
@@ -51,11 +69,13 @@ lib/daemon_kit/initializer.rb
 lib/daemon_kit/jabber.rb
 lib/daemon_kit/nanite.rb
 lib/daemon_kit/nanite/agent.rb
-lib/daemon_kit/patches/force_kill_wait.rb
+lib/daemon_kit/pid_file.rb
 lib/daemon_kit/safety.rb
 lib/daemon_kit/tasks.rb
 lib/daemon_kit/tasks/environment.rake
 lib/daemon_kit/tasks/framework.rake
+lib/daemon_kit/tasks/god.rake
+lib/daemon_kit/tasks/monit.rake
 rubygems_generators/install_rspec/USAGE
 rubygems_generators/install_rspec/install_rspec_generator.rb
 rubygems_generators/install_rspec/templates/spec.rb
@@ -66,15 +86,22 @@ script/console
 script/destroy
 script/generate
 script/txt2html
+spec/argument_spec.rb
+spec/config_spec.rb
 spec/daemon_kit_spec.rb
+spec/fixtures/env.yml
+spec/fixtures/noenv.yml
 spec/initializer_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
 tasks/rspec.rake
+templates/god/god.erb
+templates/monit/monit.erb
 test/test_amqp_generator.rb
 test/test_cron_generator.rb
 test/test_daemon-kit_generator.rb
 test/test_daemon_kit_config.rb
+test/test_deploy_capistrano_generator.rb
 test/test_generator_helper.rb
 test/test_helper.rb
 test/test_jabber_generator.rb

data/PostInstall.txt

@@ -1,5 +1,5 @@
 
-For more information on daemon-kit, see http://daemon-kit.rubyforge.org
+For more information on daemon-kit, see http://kit.rubyforge.org/daemon-kit
 
 To get started quickly run 'daemon_kit' without any arguments
 

data/{README.textile → README.rdoc}

@@ -1,8 +1,11 @@
-h1. Daemon Kit
+= Daemon Kit
 
-* http://daemon-kit.rubyforge.org/ (coming soon)
+* http://kit.rubyforge.org/daemon-kit/rdoc/
+* http://kit.rubyforge.org/daemon-kit (coming soon)
+* http://groups.google.com/group/daemon-kit (daemon-kit@googlegroups.com)
+* #daemon-kit on Freenode
 
-h2. Description
+== Description
 
 Daemon Kit aims to simplify creating Ruby daemons by providing a sound application skeleton (through a generator), task specific generators (jabber bot, etc) and robust environment management code.
 
@@ -14,12 +17,13 @@ Supported generators:
 * Evented and non-evented loops (coming soon)
 * Queue poller (SQS, AMQP, etc) (coming soon)
 
-h2. Features/Problems
+== Features/Problems
 
 * Build it
 * Review TODO.txt
+* Review Configuration.txt
 
-h2. Synopsis
+== Synopsis
 
   $ daemon-kit [/path/to/your/daemon] [options]
 
@@ -29,46 +33,54 @@ The above command generates a skeleton daemon environment for you to adapt.
 
 Use the 'jabber' generator instead of the default one.
 
-h2. Generators
+== Generators
 
 Currently only two generators exist, a 'default' generator and a 'jabber' generator.
 
 The default generator creates a simple daemon with an infinite loop inside that you can adapt.
 
-h3. Jabber Generator
+=== Jabber Generator
 
 The jabber generator creates a simple daemon that leverages the "xmpp4r-simple":http://xmpp4r-simple.rubyforge.org/ gem to process inbound messages. The daemon will manage the roster and other little tasks, leaving you to provide the hooks for processing messages, presence notifications and subscription request.
 
-h3. Cron Generator
+=== Cron Generator
 
 The cron generator creates a simple daemon that leverages the "rufus-scheduler":http://github.com/jmettraux/rufus-scheduler gem to create a simple cron-lie daemon. Please be aware that this daemon could never be a replacement for the battle-tested "cron utility":http://www.gentoo.org/doc/en/cron-guide.xml shipped standard with most *nix distributions.
 
-h3. AMQP Consumer Generator
+=== AMQP Consumer Generator
 
 The AMQP generator creates a simple daemon that has all the stub code and configuration in place to help you write AMQP consumers quickly and effectively. The generated daemon relies on the presence of the "amqp":http://github.com/tmm1/amqp gem.
 
-h2. Requirements
+== Requirements
 
 * Ruby 1.8.6
-* daemons 1.0.10
-* rspec 1.1.11 (for writing/running your specs)
+* rspec (for writing/running your specs)
 
-h3. Generator Requirements
+== Generator Requirements
 
 Depending on the generator you choose for your daemon, it might require additional gems to run.
 
-|.Generator|.Dependencies|
-|jabber|"xmpp4r-simple":http://xmpp4r-simple.rubyforge.org/|
-|cron|"rufus-scheduler":http://github.com/jmettraux/rufus-scheduler|
-|amqp|"amqp":http://github.com/tmm1/amqp|
+* jabber - xmpp4r-simple[http://xmpp4r-simple.rubyforge.org]
+* cron - rufus-scheduler[http://github.com/jmettraux/rufus-scheduler]
+* amqp - amqp[http://github.com/tmm1/amqp]
 
-h2. Install
+== Install
+
+Currently recommended to stick to the git repo:
 
   $ git clone git://github.com/kennethkalmer/daemon-kit.git
   $ rake gem
   $ gem install pkg/daemon-kit-X.X.X.gem
 
-h2. License
+Development versions are available as gems from github:
+
+  $ gem install kennethkalmer-daemon-kit -s http://gems.github.com
+
+Stable versions, when released are available directly from Rubyforge:
+
+  $ gem install daemon-kit
+
+== License
 
 (The MIT License)
 

data/Rakefile

@@ -1,4 +1,3 @@
-
 %w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/daemon_kit'
 
@@ -9,15 +8,14 @@ $hoe = Hoe.new('daemon-kit', DaemonKit::VERSION) do |p|
   p.developer('Kenneth Kalmer', 'kenneth.kalmer@gmail.com')
   p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   p.post_install_message = IO.read( 'PostInstall.txt' ) # TODO remove if post-install message not required
-  p.rubyforge_name       = p.name # TODO this is default value
+  p.rubyforge_name       = 'kit' # TODO this is default value
   p.extra_deps = [
-                  ['daemons','>= 1.0.10'],
                   ['rubigen', '>= 1.5.2']
                  ]
   p.extra_dev_deps = [
                       ['newgem', ">= #{::Newgem::VERSION}"]
                      ]
-  
+
   p.clean_globs |= %w[**/.DS_Store tmp *.log]
   path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
   p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')

data/TODO.txt

@@ -3,22 +3,18 @@ DaemonKit TODO List
 
 This is purely a drop in the bucket of what has to come...
 
-* [DONE] Easy way to trap signals
 * [IN PROGRESS] Error handling to the degree Rails does
 * Easy configuration of an ORM of choice, including patching it if needed (ActiveRecord *cough*)
 * Improved generators for creating skeleton daemons:
-  * [DONE] Jabber bot
   * Evented jabber bot
   * Empty periodic event loop
   * Empty periodic loop (non-evented)
   * Queue (SQS, AMQP, etc) pollers
 * Rake tasks for generating:
-  * god configs
   * Sys-V style init scripts
-* Pre-built capistrano configs for easy deployment
 * Support for dropping privileges
 * Support for chroot'ing
-* Improved and cleaned up logging
+* Improved and cleaned up logging, support logrotating (via HUP)
 * Plenty of docs, seriously a lot of docs
 * Specs & features, tons of them too
 * Integration tests for the specific daemons
@@ -29,4 +25,9 @@ This is purely a drop in the bucket of what has to come...
   * Some activesupport-esque functions until activesupport 3.0 hits the streets
 * DRY up the following:
   * Loading configuration files for the daemons
+* Altering process names (fully and temporary appending)
+* bleak_house support
+* Support for tweaking REE environment variables prior to launch (bash wrapper)
+* Clustering support (run multiple workers out of same project)
+
 * DON'T FORGET 1.9 SUPPORT

data/app_generators/daemon_kit/daemon_kit_generator.rb

@@ -5,10 +5,13 @@ class DaemonKitGenerator < RubiGen::Base
 
   VALID_GENERATORS = ['default', 'jabber', 'cron', 'amqp', 'nanite_agent']
 
+  DEPLOYERS = ['none', 'capistrano']
+
   default_options :shebang => DEFAULT_SHEBANG, :author => nil
 
   attr_reader :daemon_name
   attr_reader :installer
+  attr_reader :deployer
 
   def initialize(runtime_args, runtime_options = {})
     super
@@ -26,6 +29,12 @@ class DaemonKitGenerator < RubiGen::Base
       exit 1
     end
 
+    unless DEPLOYERS.include?( deployer )
+      $stderr.puts "Invalid deployment mechanism: '#{deployer}'."
+      $stderr.puts "Valid deployers are: #{DEPLOYERS.join(', ')}"
+      exit 1
+    end
+
     script_options = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
 
     record do |m|
@@ -56,6 +65,7 @@ class DaemonKitGenerator < RubiGen::Base
 
       # Config/Environment
       m.directory "config"
+      m.file      "config/arguments.rb", "config/arguments.rb"
       m.file      "config/boot.rb", "config/boot.rb"
       m.template  "config/environment.rb", "config/environment.rb"
       m.directory "config/environments"
@@ -64,6 +74,10 @@ class DaemonKitGenerator < RubiGen::Base
       m.file      "config/pre-daemonize/readme", "config/pre-daemonize/readme"
       m.directory "config/post-daemonize"
       m.file      "config/post-daemonize/readme", "config/post-daemonize/readme"
+      m.directory "script"
+      m.file      "script/destroy", "script/destroy"
+      m.file      "script/console", "script/console"
+      m.file      "script/generate", "script/generate"
 
       # Libraries
       m.directory "lib"
@@ -75,6 +89,11 @@ class DaemonKitGenerator < RubiGen::Base
       # Tests
       m.dependency "install_rspec", [daemon_name], :destination => destination_root, :collision => :force
 
+      # Deployers
+      unless deployer == 'none'
+        m.dependency "deploy_#{deployer}", [daemon_name], :destination => destination_root, :collision => :force
+      end
+
       # Others
       m.directory "log"
       m.directory "tmp"
@@ -102,12 +121,21 @@ EOS
       # opts.on("-a", "--author=\"Your Name\"", String,
       #         "Some comment about this option",
       #         "Default: none") { |o| options[:author] = o }
+
       opts.on("-i", "--install=generator", String,
               "Select a generator to use (other than the default).",
               "Available generators: #{VALID_GENERATORS.join(', ')}",
               "Defaults to: default") do |installer|
         options[:installer] = installer
       end
+
+      opts.on("-d", "--deploy-with=config", String,
+              "Select an optional deployment mechanism.",
+              "Available deployers: #{DEPLOYERS.join(', ')}",
+              "Defaults to: none") do |deploy|
+        options[:deployer] = deploy
+      end
+
       opts.on("-r", "--ruby=path", String,
               "Path to the Ruby binary of your choice (otherwise scripts use env, dispatchers current path).",
               "Default: #{DEFAULT_SHEBANG}") { |x| options[:shebang] = x }
@@ -120,6 +148,7 @@ EOS
       # raw instance variable value.
       # @author = options[:author]
       @installer = options[:installer] || 'default'
+      @deployer  = (options[:deployer] || 'none').strip
     end
 
 end

data/app_generators/daemon_kit/templates/Rakefile

@@ -1,4 +1,6 @@
-require 'rubygems'
+require File.dirname(__FILE__) + '/config/boot'
+
+require 'rake'
 require 'daemon_kit/tasks'
 
 Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |rake| load rake }

data/app_generators/daemon_kit/templates/config/arguments.rb

@@ -0,0 +1,12 @@
+# Argument handling for your daemon is configured here.
+#
+# You have access to two variables when this file is
+# parsed. The first is +opts+, which is the object yielded from
+# +OptionParser.new+, the second is +@options+ which is a standard
+# Ruby hash that is later accessible through
+# DaemonKit.arguments.options and can be used in your daemon process.
+
+# Here is an example:
+# opts.on('-f', '--foo FOO', 'Set foo') do |foo|
+#  @options[:foo] = foo
+# end

data/app_generators/daemon_kit/templates/config/boot.rb

@@ -1,7 +1,7 @@
 # Don't change this file!
 # Configure your daemon in config/environment.rb
 
-DAEMON_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?( DAEMON_ROOT )
+DAEMON_ROOT = "#{File.expand_path(File.dirname(__FILE__))}/.." unless defined?( DAEMON_ROOT )
 
 module DaemonKit
   class << self
@@ -36,7 +36,7 @@ module DaemonKit
       require "#{DAEMON_ROOT}/vendor/daemon_kit/lib/daemon_kit/initializer"
     end
   end
-  
+
   class GemBoot < Boot
     def load_initializer
       begin