bunnicula 0.2.0 → 0.2.1

data/vendor/daemon_kit/daemon-kit/TODO.txt

@@ -0,0 +1,28 @@
+= DaemonKit TODO List
+
+This is purely a drop in the bucket of what has to come...
+
+* Support for chroot'ing
+* 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)
+* [IN PROGRESS] Error handling to the degree Rails does
+  * Support for custom error handlers in the project
+* Easy configuration of an ORM of choice, including patching it if needed (ActiveRecord *cough*)
+* Improved generators for creating skeleton daemons:
+  * Evented jabber bot
+  * Empty periodic event loop
+  * Empty periodic loop (non-evented)
+  * Queue (SQS, AMQP, etc) pollers
+* Rake tasks for generating:
+  * Sys-V style init scripts
+* Plenty of docs, seriously a lot of docs
+* Specs & features, tons of them too
+* Integration tests for the specific daemons
+* Some level of thread safety, or mechanisms to ease thread safety
+* Built in utilities:
+  * Fibre pool for 1.9
+  * Some activesupport-esque functions until activesupport 3.0 hits the streets
+* DRY up the following:
+  * Loading configuration files for the daemons

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/USAGE

@@ -0,0 +1,7 @@
+Description:
+  This generator creates a new skeleton project suitable for easy
+  Ruby daemon development. The generated project is preconfigured
+  and just requires your task specific code.
+
+  Use one of the provided generators to stub out even more 
+  functionality for common daemon patterns.

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/daemon_kit_generator.rb

@@ -0,0 +1,178 @@
+class DaemonKitGenerator < RubiGen::Base
+
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  VALID_GENERATORS = ['default', 'jabber', 'cron', 'amqp', 'nanite_agent', 'ruote']
+
+  DEPLOYERS = ['none', 'capistrano']
+
+  TEST_FRAMEWORKS = [ 'rspec', 'test_unit' ]
+
+  default_options :shebang => DEFAULT_SHEBANG, :author => nil
+
+  attr_reader :daemon_name
+  attr_reader :installer
+  attr_reader :deployer
+  attr_reader :cucumber
+  attr_reader :test_framework
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @daemon_name = base_name
+    extract_options
+  end
+
+  def manifest
+    # ensure some sanity
+    unless VALID_GENERATORS.include?( installer )
+      $stderr.puts "Invalid generator: '#{installer}'."
+      $stderr.puts "Valid generators are: #{VALID_GENERATORS.join(', ')}"
+      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|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+
+      # Create stubs
+      # m.template "template.rb",  "some_file_after_erb.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.file     "file",         "some_file_copied"
+      # m.file_copy_each ["path/to/file", "path/to/file2"]
+
+      # Readme
+      m.template  "README", "README"
+      m.template  "Rakefile", "Rakefile"
+
+      # Executable
+      m.directory "bin"
+      m.template  "bin/daemon.erb", "bin/#{daemon_name}", script_options
+
+      # Generator
+      if installer == "default"
+        m.directory "libexec"
+        m.template  "libexec/daemon.erb", "libexec/#{daemon_name}-daemon.rb"
+      else
+        m.dependency installer, [daemon_name], :destination => destination_root, :collision => :force
+      end
+
+      # 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"
+      %w{ development test production }.each { |f| m.file "config/environments/#{f}.rb", "config/environments/#{f}.rb" }
+      m.directory "config/pre-daemonize"
+      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", script_options
+      m.file      "script/console", "script/console", script_options
+      m.file      "script/generate", "script/generate", script_options
+
+      # Libraries
+      m.directory "lib"
+      m.file "lib/daemon.rb", "lib/#{daemon_name}.rb", :collision => :skip
+
+      # Tasks
+      m.directory "tasks"
+
+      # Tests
+      case test_framework
+      when 'rspec'
+        m.dependency "rspec", [daemon_name], :destination => destination_root, :collision => :force
+      when 'test_unit'
+        m.dependency "test_unit", [daemon_name], :destination => destination_root, :collision => :force
+      end
+
+      if cucumber
+        m.dependency "cucumber", [], :destination => destination_root, :collision => :force
+      end
+
+      # Deployers
+      unless deployer == 'none'
+        m.dependency "deploy_#{deployer}", [daemon_name], :destination => destination_root, :collision => :force
+      end
+
+      # Others
+      m.directory "log"
+      m.directory "tmp"
+      m.directory "vendor"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a preconfigured environment for writing Ruby daemon processes.
+
+USAGE: #{spec.name} /path/to/your/daemon [options]
+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("-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("-T", "--test-with=type", String,
+              "Select your test framework.",
+              "Available test framworks: #{TEST_FRAMEWORKS.join(', ')}",
+              "Defaults to: rspec") do |test|
+        options[:test_framework] = test
+      end
+
+      opts.on("--cucumber",
+              "Install cucumber.") do
+        options[:cucumber] = true
+      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 }
+      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]
+      @installer = options[:installer] || 'default'
+      @deployer  = (options[:deployer] || 'none').strip
+      @cucumber  = options[:cucumber]  || false
+      @test_framework = options[:test_framework] || 'rspec'
+    end
+
+end

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/README

@@ -0,0 +1,48 @@
+DaemonKit README
+================
+
+DaemonKit has generated a skeleton Ruby daemon for you to build on. Please read
+through this file to ensure you get going quickly.
+
+Directories
+===========
+
+bin/
+  <%= daemon_name %> - Stub executable to control your daemon with
+
+config/
+  Environment configuration files
+
+lib/
+  Place for your libraries
+
+libexec/
+  <%= daemon_name %>.rb - Your daemon code
+
+log/
+  Log files based on the environment name
+
+spec/
+  rspec's home
+
+tasks/
+  Place for rake tasks
+
+vendor/
+  Place for unpacked gems and DaemonKit
+
+tmp/
+  Scratch folder
+
+
+Logging
+=======
+
+One of the biggest issues with writing daemons are gettign insight into what your
+daemons are doing. Logging with DaemonKit is simplified as DaemonKit creates log
+files per environment in log.
+
+On all environments except production the log level is set to DEBUG, but you can
+toggle the log level by sending the running daemon SIGUSR1 and SIGUSR2 signals.
+SIGUSR1 will toggle between DEBUG and INFO levels, SIGUSR2 will blatantly set the
+level to DEBUG.

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/Rakefile

@@ -0,0 +1,6 @@
+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/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/bin/daemon.erb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+#
+# Stub executable for <%= daemon_name %>
+
+require File.dirname(__FILE__) + '/../config/environment'
+
+DaemonKit::Application.exec( DAEMON_ROOT + '/libexec/<%= daemon_name %>-daemon.rb' )

data/vendor/daemon_kit/daemon-kit/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/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/boot.rb

@@ -0,0 +1,59 @@
+# Don't change this file!
+# Configure your daemon in config/environment.rb
+
+DAEMON_ROOT = "#{File.expand_path(File.dirname(__FILE__))}/.." unless defined?( DAEMON_ROOT )
+
+module DaemonKit
+  class << self
+    def boot!
+      unless booted?
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? DaemonKit::Initializer
+    end
+
+    def pick_boot
+      (vendor_kit? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_kit?
+      File.exists?( "#{DAEMON_ROOT}/vendor/daemon_kit" )
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      DaemonKit::Initializer.run
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{DAEMON_ROOT}/vendor/daemon_kit/lib/daemon_kit/initializer"
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      begin
+        gem 'daemon-kit'
+        require 'daemon_kit/initializer'
+      rescue Gem::LoadError => e
+        msg = <<EOF
+You are missing the daemon-kit gem. Please install the following gems:
+
+* Stable   - sudo gem install daemon-kit
+
+EOF
+        $stderr.puts msg
+        exit 1
+      end
+    end
+  end
+end
+
+DaemonKit.boot!

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/environment.rb

@@ -0,0 +1,23 @@
+# Be sure to restart your daemon when you modify this file
+
+# Uncomment below to force your daemon into production mode
+#ENV['DAEMON_ENV'] ||= 'production'
+
+# Boot up
+require File.join(File.dirname(__FILE__), 'boot')
+
+DaemonKit::Initializer.run do |config|
+
+  # The name of the daemon as reported by process monitoring tools
+  config.daemon_name = '<%= daemon_name %>'
+
+  # Force the daemon to be killed after X seconds from asking it to
+  # config.force_kill_wait = 30
+
+  # Log backraces when a thread/daemon dies (Recommended)
+  # config.backtraces = true
+
+  # Configure the safety net (see DaemonKit::Safety)
+  # config.safety_net.handler = :mail # (or :hoptoad )
+  # config.safety_net.mail.host = 'localhost'
+end

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/environments/development.rb

@@ -0,0 +1,2 @@
+# This is the same context as the environment.rb file, it is only
+# loaded afterwards and only in the development environment

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/environments/production.rb

@@ -0,0 +1,5 @@
+# This is the same context as the environment.rb file, it is only
+# loaded afterwards and only in the production environment
+
+# Change the production log level to debug
+#config.log_level = :debug

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/environments/test.rb

@@ -0,0 +1,2 @@
+# This is the same context as the environment.rb file, it is only
+# loaded afterwards and only in the test environment

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/post-daemonize/readme

@@ -0,0 +1,5 @@
+# You can place files in here to be loaded after the code is daemonized.
+#
+# All the files placed here will just be required into the running
+# process. This is the correct place to open any IO objects, establish
+# database connections, etc.

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/pre-daemonize/readme

@@ -0,0 +1,12 @@
+# You can place files in here to be loaded before the code is daemonized.
+#
+# DaemonKit looks for a file named '<config.daemon_name>.rb' and loads
+# that file first, and inside a DaemonKit::Initializer block. The
+# remaning files then simply required into the running process.
+# 
+# These files are mostly useful for operations that should fail blatantly
+# before daemonizing, like loading gems.
+#
+# Be careful not to open any form of IO in here and expecting it to be
+# open inside the running daemon since all IO instances are closed when
+# daemonizing (including STDIN, STDOUT & STDERR).

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/lib/daemon.rb

@@ -0,0 +1,2 @@
+# Your starting point for daemon specific classes. This directory is
+# already included in your load path, so no need to specify it.

data/vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/libexec/daemon.erb

@@ -0,0 +1,18 @@
+# Change this file to be a wrapper around your daemon code.
+
+# Do your post daemonization configuration here
+# At minimum you need just the first line (without the block), or a lot
+# of strange things might start happening...
+DaemonKit::Application.running! do |config|
+  # Trap signals with blocks or procs
+  # config.trap( 'INT' ) do
+  #   # do something clever
+  # end
+  # config.trap( 'TERM', Proc.new { puts 'Going down' } )
+end
+
+# Sample loop to show process
+loop do
+  DaemonKit.logger.info "I'm running"
+  sleep 60
+end

data/vendor/daemon_kit/daemon-kit/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/vendor/daemon_kit/daemon-kit/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)