daemon-kit 0.1.7 → 0.1.7.4

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,27 @@
+== 0.1.7.4 (Not released)
+
+* Enhanced deploy.rb template to check for current dk gem verion,
+  unless vendored
+* Fix bug in capistrano recipe for restarting daemons
+* Added log:truncate rake task
+* Error mails now handled by TMail
+
+== 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,3 +1,4 @@
+Configuration.txt
 History.txt
 Manifest.txt
 PostInstall.txt
@@ -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,9 +33,9 @@ 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/USAGE
 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
@@ -49,7 +54,12 @@ 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
@@ -59,11 +69,14 @@ 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/log.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
@@ -74,11 +87,18 @@ script/console
 script/destroy
 script/generate
 script/txt2html
+spec/argument_spec.rb
+spec/config_spec.rb
 spec/daemon_kit_spec.rb
+spec/error_handlers_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
@@ -88,3 +108,31 @@ test/test_generator_helper.rb
 test/test_helper.rb
 test/test_jabber_generator.rb
 test/test_nanite_agent_generator.rb
+vendor/tmail-1.2.3/tmail.rb
+vendor/tmail-1.2.3/tmail/address.rb
+vendor/tmail-1.2.3/tmail/attachments.rb
+vendor/tmail-1.2.3/tmail/base64.rb
+vendor/tmail-1.2.3/tmail/compat.rb
+vendor/tmail-1.2.3/tmail/config.rb
+vendor/tmail-1.2.3/tmail/core_extensions.rb
+vendor/tmail-1.2.3/tmail/encode.rb
+vendor/tmail-1.2.3/tmail/header.rb
+vendor/tmail-1.2.3/tmail/index.rb
+vendor/tmail-1.2.3/tmail/interface.rb
+vendor/tmail-1.2.3/tmail/loader.rb
+vendor/tmail-1.2.3/tmail/mail.rb
+vendor/tmail-1.2.3/tmail/mailbox.rb
+vendor/tmail-1.2.3/tmail/main.rb
+vendor/tmail-1.2.3/tmail/mbox.rb
+vendor/tmail-1.2.3/tmail/net.rb
+vendor/tmail-1.2.3/tmail/obsolete.rb
+vendor/tmail-1.2.3/tmail/parser.rb
+vendor/tmail-1.2.3/tmail/port.rb
+vendor/tmail-1.2.3/tmail/quoting.rb
+vendor/tmail-1.2.3/tmail/require_arch.rb
+vendor/tmail-1.2.3/tmail/scanner.rb
+vendor/tmail-1.2.3/tmail/scanner_r.rb
+vendor/tmail-1.2.3/tmail/stringio.rb
+vendor/tmail-1.2.3/tmail/utils.rb
+vendor/tmail-1.2.3/tmail/version.rb
+vendor/tmail.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.rdoc

@@ -1,6 +1,7 @@
 = Daemon Kit
 
-* http://kit.rubyforge.org/daemon (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
 
@@ -20,6 +21,7 @@ Supported generators:
 
 * Build it
 * Review TODO.txt
+* Review Configuration.txt
 
 == Synopsis
 
@@ -52,19 +54,15 @@ The AMQP generator creates a simple daemon that has all the stub code and config
 == Requirements
 
 * Ruby 1.8.6
-* daemons 1.0.10
-* rspec 1.1.11 (for writing/running your specs)
+* rspec (for writing/running your specs)
 
 == Generator Requirements
 
 Depending on the generator you choose for your daemon, it might require additional gems to run.
 
-<table>
-<tr><th>Generator</th><th>\&nbsp;</th><th>Dependencies</th></tr>
-<tr><td>jabber</td><td>\&nbsp;</td><td> xmpp4r-simple[http://xmpp4r-simple.rubyforge.org] </td></tr>
-<tr><td>cron</td><td>\&nbsp;</td><td> rufus-scheduler[http://github.com/jmettraux/rufus-scheduler] </td></tr>
-<tr><td>amqp</td><td>\&nbsp;</td><td> amqp[http://github.com/tmm1/amqp] </td></tr>
-</table>
+* jabber - xmpp4r-simple[http://xmpp4r-simple.rubyforge.org]
+* cron - rufus-scheduler[http://github.com/jmettraux/rufus-scheduler]
+* amqp - amqp[http://github.com/tmm1/amqp]
 
 == Install
 

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

@@ -65,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"
@@ -73,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"

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/bin/daemon.erb

@@ -4,4 +4,4 @@
 
 require File.dirname(__FILE__) + '/../config/environment'
 
-DaemonKit::Application.run( DAEMON_ROOT + '/libexec/<%= daemon_name %>-daemon.rb' )
+DaemonKit::Application.exec( DAEMON_ROOT + '/libexec/<%= daemon_name %>-daemon.rb' )

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

data/app_generators/daemon_kit/templates/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'daemon_kit/commands/console'

data/app_generators/daemon_kit/templates/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:daemon, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/app_generators/daemon_kit/templates/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:daemon, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/daemon_generators/amqp/templates/config/amqp.yml

@@ -4,8 +4,8 @@
 # omitted will let the gem use it's own defaults.
 
 # The configuration specifies the following keys:
-# * username - Username for the broker
-# * password - Password for the broker
+# * user - Username for the broker
+# * pass - Password for the broker
 # * host     - Hostname where the broker is running
 # * vhost    - Vhost to connect to
 # * port     - Port where the broker is running
@@ -13,8 +13,8 @@
 # * timeout  - Timeout
 
 defaults: &defaults
-  username: guest
-  password: guest
+  user: guest
+  pass: guest
   host: localhost
   vhost: /
 
@@ -25,4 +25,4 @@ test:
   <<: *defaults
 
 production:
-  <<: *defaults
+  <<: *defaults

data/daemon_generators/deploy_capistrano/deploy_capistrano_generator.rb

@@ -1,14 +1,11 @@
 class DeployCapistranoGenerator < RubiGen::Base
 
-  default_options :author => nil
-
   attr_reader :name
 
   def initialize(runtime_args, runtime_options = {})
     super
     usage if args.empty?
     @name = args.shift
-    extract_options
   end
 
   def manifest
@@ -22,33 +19,17 @@ class DeployCapistranoGenerator < RubiGen::Base
       m.template  "config/deploy/production.rb", "config/deploy/production.rb"
       m.directory "config/environments"
       m.file      "config/environments/staging.rb", "config/environments/staging.rb", :collision => :skip
+      m.readme    "USAGE"
     end
   end
 
   protected
     def banner
       <<-EOS
-Creates a ...
+Creates the required capistrano configurations for deploying your daemon code
+to remote servers.
 
-USAGE: #{$0} #{spec.name} name
+USAGE: #{$0} #{spec.name} daemon-name
 EOS
     end
-
-    def add_options!(opts)
-      # opts.separator ''
-      # opts.separator 'Options:'
-      # For each option below, place the default
-      # at the top of the file next to "default_options"
-      # opts.on("-a", "--author=\"Your Name\"", String,
-      #         "Some comment about this option",
-      #         "Default: none") { |o| options[:author] = o }
-      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
-    end
-
-    def extract_options
-      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
-      # Templates can access these value via the attr_reader-generated methods, but not the
-      # raw instance variable value.
-      # @author = options[:author]
-    end
 end