amqp-daemon-kit 0.1.8.1

data/lib/generators/daemon_kit/app/templates/Gemfile

@@ -0,0 +1,12 @@
+# If you need to 'vendor your gems' for deploying your daemons, bundler is a
+# great option. Update this Gemfile with any additional dependencies and run
+# 'bundle install' to get them all installed. Daemon-kit's capistrano
+# deployment will ensure that the bundle required by your daemon is properly
+# installed.
+
+source :gemcutter
+
+# daemon-kit
+gem 'daemon-kit'
+
+# For more information on bundler, please visit http://gembundler.com

data/lib/generators/daemon_kit/app/templates/README.tt

@@ -0,0 +1,58 @@
+daemon-kit README
+================
+
+daemon-kit has generated a skeleton Ruby daemon for you to build on. Please read
+through this file to ensure you get going quickly.
+
+Directories
+===========
+
+bin/
+  <%= app_name %> - Stub executable to control your daemon with
+
+config/
+  Environment configuration files
+
+lib/
+  Place for your libraries
+
+libexec/
+  <%= app_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 getting insight into what your
+daemons are doing. Logging with daemon-kit 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.
+
+Bundler
+=======
+
+daemon-kit uses bundler to ease the nightmare of dependency loading in Ruby 
+projects. daemon-kit and its generators all create/update the Gemfile in the
+root of the daemon. You can satisfy the project's dependencies by running
+`bundle install` from within the project root.
+
+For more information on bundler, please see http://github.com/carlhuda/bundler

data/lib/generators/daemon_kit/app/templates/Rakefile

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

data/lib/generators/daemon_kit/app/templates/bin/daemon.tt

@@ -0,0 +1,7 @@
+#
+# Stub executable for <%= app_name %>
+#
+
+require File.expand_path('../../config/environment',  __FILE__)
+
+DaemonKit::Application.exec( DAEMON_ROOT + '/libexec/<%= app_name %>-daemon.rb' )

data/lib/generators/daemon_kit/app/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/lib/generators/daemon_kit/app/templates/config/boot.rb

@@ -0,0 +1,70 @@
+# Don't change this file!
+# Configure your daemon in config/environment.rb
+
+DAEMON_ROOT = "#{File.expand_path(File.dirname(__FILE__))}/.." unless defined?( DAEMON_ROOT )
+
+# Use Bundler (preferred)
+begin
+  require File.expand_path('../../.bundle/environment', __FILE__)
+rescue LoadError
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+end
+
+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
+        require 'rubygems' unless defined?( ::Gem )
+        gem 'daemon-kit'
+        require 'daemon_kit/initializer'
+      rescue ::Gem::LoadError => e
+        msg = <<EOF
+
+You are missing the daemon-kit gem. Please install the following gem:
+
+sudo gem install daemon-kit
+
+EOF
+        $stderr.puts msg
+        exit 1
+      end
+    end
+  end
+end
+
+DaemonKit.boot!

data/lib/generators/daemon_kit/app/templates/config/environment.rb.tt

@@ -0,0 +1,26 @@
+# 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')
+
+# Auto-require default libraries and those for the current Rails environment.
+Bundler.require :default, DaemonKit.env
+
+DaemonKit::Initializer.run do |config|
+
+  # The name of the daemon as reported by process monitoring tools
+  config.daemon_name = '<%= app_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 = :hoptoad
+  # config.safety_net.hoptoad.api_key = ''
+end

data/lib/generators/daemon_kit/app/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/lib/generators/daemon_kit/app/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/lib/generators/daemon_kit/app/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/lib/generators/daemon_kit/app/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/lib/generators/daemon_kit/app/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/lib/generators/daemon_kit/app/templates/lib/%app_name%.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/lib/generators/daemon_kit/app/templates/libexec/%app_name%-daemon.rb

@@ -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/lib/generators/daemon_kit/app/templates/script/console

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

data/lib/generators/daemon_kit/app/templates/script/destroy

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

data/lib/generators/daemon_kit/app/templates/script/generate

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

data/lib/generators/daemon_kit/capistrano/capistrano_generator.rb

@@ -0,0 +1,26 @@
+module DaemonKit
+  module Generators
+    class CapistranoGenerator < Base
+
+      def update_gemfile
+        append_file 'Gemfile', "gem 'capistrano'\n"
+        append_file 'Gemfile', "gem 'capistrano-ext'\n"
+      end
+
+      def create_capfile
+        copy_file 'Capfile'
+      end
+
+      def create_config
+        directory 'config'
+      end
+
+      protected
+
+      def self.source_root
+        File.expand_path( File.join( File.dirname(__FILE__), 'templates') )
+      end
+
+    end
+  end
+end

data/lib/generators/daemon_kit/capistrano/templates/Capfile

@@ -0,0 +1,10 @@
+unless respond_to?(:namespace) # cap2 differentiator
+  $stderr.puts "Requires capistrano version 2"
+  exit 1
+end
+
+require 'config/boot'
+load DaemonKit.framework_root + '/lib/daemon_kit/deployment/capistrano.rb'
+
+Dir['config/deploy/recipes/*.rb'].each { |plugin| load(plugin) }
+load 'config/deploy.rb'

data/lib/generators/daemon_kit/capistrano/templates/USAGE

@@ -0,0 +1,10 @@
+
+Capistrano deployment configuration generator completed
+
+Usage:
+  Review the configuration files in config/deploy.rb and
+  config/deploy/*.rb
+
+  Once you're happy with the configurations, you can review
+  a list of available capistrano commands by running `cap -T'
+

data/lib/generators/daemon_kit/capistrano/templates/config/deploy.rb.tt

@@ -0,0 +1,67 @@
+# Modified capistrano recipe, based on the standard 'deploy' recipe
+# provided by capistrano but without the Rails-specific dependencies
+
+set :stages, %w(staging production)
+set :default_stage, "staging"
+require "capistrano/ext/multistage"
+
+# Set some globals
+default_run_options[:pty] = true
+set :application, "<%= app_name %>"
+
+# Deployment
+set :deploy_to, "/svc/#{application}"
+#set :user, 'someone'
+
+# Get repo configuration
+set :repository, "git@github.com:yourname/#{application}.git"
+set :scm, "git"
+set :branch, "master"
+set :deploy_via, :remote_cache
+set :git_enable_submodules, 1
+
+# No sudo
+set :use_sudo, false
+
+# File list in the config_files setting will be copied from the
+# 'deploy_to' directory into config, overwriting files from the repo
+# with the same name
+set :config_files, %w{}
+
+# List any work directories here that you need persisted between
+# deployments. They are created in 'deploy_to'/shared and symlinked
+# into the root directory of the deployment.
+set :shared_children, %w{log tmp}
+
+# Record our dependencies
+unless File.directory?( "#{DaemonKit.root}/vendor/daemon_kit" )
+  depend :remote, :gem, "daemon-kit", ">=#{DaemonKit::VERSION}"
+end
+
+# Hook into capistrano's events
+before "deploy:update_code", "deploy:check"
+
+# Setup log rotation support with every deploy (safe)
+#after 'deploy:symlink', 'deploy:logrotate'
+
+# Create some tasks related to deployment
+namespace :deploy do
+
+  desc "Get the current revision of the deployed code"
+  task :get_current_version do
+    run "cat #{current_path}/REVISION" do |ch, stream, out|
+      puts "Current revision: " + out.chomp
+    end
+  end
+
+  desc "Install log rotation script on server"
+  task :logrotate do
+    require 'erb'
+    upload_path = "#{shared_path}/system/logrotate"
+    template = File.read("config/deploy/logrotate.erb")
+    file = ERB.new(template).result(binding)
+    put file, upload_path, :mode => 0644
+    run "if [ -e /etc/logrotate.d ]; then sudo cp #{shared_path}/system/logrotate /etc/logrotate.d/#{name}; fi"
+  end
+
+end

data/lib/generators/daemon_kit/capistrano/templates/config/deploy/logrotate.erb

@@ -0,0 +1,13 @@
+<%= shared_path %>/log/*.log {
+  daily
+  missingok
+  compress
+  rotate 7
+  sharedscripts
+
+  postrotate
+    for i in <%= shared_path %>/pids/*.pid; do
+      kill -HUP `cat $i`
+    done
+  endscript
+}

data/lib/generators/daemon_kit/capistrano/templates/config/deploy/production.rb.tt

@@ -0,0 +1,6 @@
+#set :deploy_to, "/svc/<%= app_name %>" # defaults to "/u/apps/#{application}"
+#set :user, "<%= app_name %>"            # defaults to the currently logged in user
+set :daemon_env, 'production'
+
+set :domain, 'example.com'
+server domain

data/lib/generators/daemon_kit/capistrano/templates/config/deploy/staging.rb.tt

@@ -0,0 +1,6 @@
+#set :deploy_to, "/svc/<%= app_name %>" # defaults to "/u/apps/#{application}"
+#set :user, "<%= app_name %>"            # defaults to the currently logged in user
+set :daemon_env, 'staging'
+
+set :domain, 'example.com'
+server domain

data/lib/generators/daemon_kit/cron/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/lib/generators/daemon_kit/cron/cron_generator.rb

@@ -0,0 +1,24 @@
+module DaemonKit
+  module Generators
+    class CronGenerator < Base
+
+      def update_gemfile
+        append_file 'Gemfile', "gem 'rufus-scheduler', '>= 2.0.3'\n"
+      end
+
+      def create_initializers
+        directory 'config'
+      end
+
+      def create_daemon
+        directory 'libexec'
+      end
+
+      protected
+
+      def self.source_root
+        File.expand_path( File.join( File.dirname(__FILE__), 'templates') )
+      end
+    end
+  end
+end