textgoeshere-daemon-kit 0.1.8rc3

data/lib/generators/daemon_kit/ruote/templates/libexec/%app_name%-daemon.rb

@@ -0,0 +1,33 @@
+# Generated remote participant for the ruote workflow engine
+# (http://openwferu.rubyforge.org)
+
+# 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
+
+# IMPORTANT CONFIGURATION NOTE
+#
+# Please review and update 'config/amqp.yml' accordingly if you wish to use
+# AMQP as a transport mechanism for workitems sent between ruote and this
+# daemon.
+
+# Configuration of the remote participant shell
+DaemonKit::RuoteParticipants.configure do |config|
+  # Use AMQP as a workitem transport mechanism
+  config.use :amqp
+
+  # Register your classes as pseudo-participants, with work being delegated
+  # according to the 'command' parameter passed in the process definition
+  config.register Sample
+end
+
+DaemonKit::RuoteParticipants.run do
+  # Place any additional daemon-specific code in here...
+end

data/lib/generators/daemon_kit/test_unit/USAGE

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

data/lib/generators/daemon_kit/test_unit/templates/tasks/test_unit.rake

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/generators/daemon_kit/test_unit/templates/test/%app_name%_test.rb.tt

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class Test<%= app_name %> < Test::Unit::TestCase
+
+  def test_missing
+    assert false, "daemons should be tested"
+  end
+end
+

data/lib/generators/daemon_kit/test_unit/templates/test/test_helper.rb

@@ -0,0 +1,6 @@
+DAEMON_ENV = 'test' unless defined?( DAEMON_ENV )
+
+require 'test/unit'
+
+require File.dirname(__FILE__) + '/../config/environment'
+DaemonKit::Application.running!

data/lib/generators/daemon_kit/test_unit/test_unit_generator.rb

@@ -0,0 +1,20 @@
+module DaemonKit
+  module Generators
+    class TestUnitGenerator < Base
+
+      def create_tests
+        directory 'test'
+      end
+
+      def create_tasks
+        directory 'tasks'
+      end
+
+      protected
+
+      def self.source_root
+        File.expand_path( File.join( File.dirname(__FILE__), 'templates') )
+      end
+    end
+  end
+end

data/lib/generators/daemon_kit/xmpp/templates/config/pre-daemonize/xmpp.rb

@@ -0,0 +1,6 @@
+begin
+  require 'blather'
+rescue LoadError
+  $stderr.puts "Missing blather gem. Please run 'bundle install'."
+  exit 1
+end

data/lib/generators/daemon_kit/xmpp/templates/config/xmpp.yml

@@ -0,0 +1,29 @@
+# Jabber configuration file
+
+# The configuration specifies the following keys:
+# * jabber_id  - Identidy (username) of the user
+# * password   - Password used to authenticate
+# * resource   - Multiple connections can be made with the same credentials and different resources
+# * masters    - Array of Jabber ID's whose messages will be processed
+# * supporters - Additional 'buddies' to keep on roster, but messages won't be processed
+# * enable_logging - Enable Blather logging (VERY VERBOSE)
+# * require_master - Disable filtering of messages based on the sender being a 'master'
+
+defaults: &defaults
+  jabber_id: dk@jabber
+  password: secret
+  resource: daemon_kit
+  enable_logging: false
+  masters: 
+    - kenneth.kalmer@gmail.com
+  supporters:
+    - someone@gmail.com
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/lib/generators/daemon_kit/xmpp/templates/libexec/%app_name%-daemon.rb

@@ -0,0 +1,27 @@
+# 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
+
+
+DaemonKit::XMPP.run do
+  when_ready { DaemonKit.logger.info "Connected as #{jid}" }
+
+  # Auto approve subscription requests
+  subscription :request? do |s|
+    write_to_stream s.approve!
+  end
+
+  # Echo back what was said
+  message :chat?, :body do |m|
+    write_to_stream m.reply
+  end
+end

data/lib/generators/daemon_kit/xmpp/xmpp_generator.rb

@@ -0,0 +1,24 @@
+module DaemonKit
+  module Generators
+    class XmppGenerator < Base
+
+      def update_gemfile
+        append_file 'Gemfile', "gem 'blather'\n"
+      end
+
+      def create_config
+        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

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/daemon-kit.rb'}"
+puts "Loading daemon-kit gem"
+exec "#{irb} #{libs} --simple-prompt"

data/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! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/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! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+load File.dirname(__FILE__) + "/../Rakefile"
+require 'rubyforge'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+
+download = "http://rubyforge.org/projects/#{$hoe.rubyforge_name}"
+version  = $hoe.version
+
+def rubyforge_project_id
+  RubyForge.new.configure.autoconfig["group_ids"][$hoe.rubyforge_name]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/spec/abstract_logger_spec.rb

@@ -0,0 +1,126 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe DaemonKit::AbstractLogger do
+
+  before(:each) do
+    @log_file = "#{DAEMON_ROOT}/log/spec.log"
+    @logger = DaemonKit::AbstractLogger.new( @log_file )
+    @logger.level = :debug
+  end
+
+  it "should have a log level" do
+    @logger.level.should == :debug
+  end
+
+  it "should have a backend logger" do
+    @logger.logger.should_not be_nil
+  end
+
+  it "should accept a different backend" do
+    l = Logger.new('/dev/null')
+    @logger.logger = l
+    @logger.logger.should == l
+  end
+
+  it "should be able to log to STDOUT as well" do
+    @logger.copy_to_stdout = true
+
+    STDOUT.expects(:puts).with(regexp_matches(/test/))
+
+    @logger.debug "test"
+    IO.readlines( @log_file ).last.should match(/test/)
+  end
+
+  it "should log debug level messages" do
+    @logger.debug( "Debug test" )
+
+    IO.readlines( @log_file ).last.should match(/\[DEBUG\].*Debug test/)
+  end
+
+  it "should log info level messages" do
+    @logger.info( "Info test" )
+
+    IO.readlines( @log_file ).last.should match(/\[INFO\].*Info test/)
+  end
+
+  it "should log warn level messages" do
+    @logger.warn( "Warn test" )
+
+    IO.readlines( @log_file ).last.should match(/\[WARN\].*Warn test/)
+  end
+
+  it "should log error level messages" do
+    @logger.error( "Err test" )
+
+    IO.readlines( @log_file ).last.should match(/\[ERROR\].*Err test/)
+  end
+
+  it "should log fatal level messages" do
+    @logger.fatal( "Fatal test" )
+
+    IO.readlines( @log_file ).last.should match(/\[FATAL\].*Fatal test/)
+  end
+
+  it "should log unknown level messages" do
+    @logger.unknown( "Unknown test" )
+
+    IO.readlines( @log_file ).last.should match(/\[ANY\].*Unknown test/)
+  end
+
+  it "should log the caller file and line number" do
+    f = File.basename(__FILE__)
+    l = __LINE__ + 2
+
+    @logger.info( "Caller test" )
+
+    IO.readlines( @log_file ).last.should match(/#{f}:#{l}:/)
+  end
+
+  it "should log exceptions with daemon traces" do
+    fake_trace = [
+                  "/home/kenneth/daemon/libexec/daemon-daemon.rb:1:in `foo'",
+                  "/usr/lib/ruby/gems/1.8/gems/daemon-kit-0.0.1/lib/daemon_kit/abstract_logger.rb:49: in `info'"
+                 ]
+
+    e = RuntimeError.new( 'Test error' )
+    e.set_backtrace( fake_trace )
+
+    @logger.exception( e )
+
+    IO.readlines( @log_file ).last.should match(/EXCEPTION: Test error/)
+  end
+
+  it "should log exceptions without framework traces" do
+    fake_trace = [
+                  "/home/kenneth/daemon/libexec/daemon-daemon.rb:1:in `foo'",
+                  "/usr/lib/ruby/gems/1.8/gems/daemon-kit-0.0.1/lib/daemon_kit/abstract_logger.rb:49: in `info'"
+                 ]
+
+    clean_trace = @logger.clean_trace( fake_trace )
+
+    clean_trace.should include("/home/kenneth/daemon/libexec/daemon-daemon.rb:1:in `foo'")
+    clean_trace.should_not include("/usr/lib/ruby/gems/1.8/gems/daemon-kit-0.0.1/lib/daemon_kit/abstract_logger.rb:49: in `info'")
+  end
+
+  it "should support reopening log files" do
+    @logger.close
+
+    FileUtils.rm( @log_file )
+
+    @logger.info( 'Reopen')
+    IO.readlines( @log_file ).last.should match(/Reopen/)
+  end
+
+  it "should support silencing" do
+    @logger.silence do |logger|
+      logger.info "This should never be logged"
+    end
+
+    @logger.info "This should be logged"
+
+    log = IO.readlines( @log_file )
+
+    log.detect { |l| l =~ /This should never be logged/ }.should be_nil
+    log.detect { |l| l =~ /This should be logged/ }.should_not be_nil
+  end
+end

data/spec/argument_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe DaemonKit::Arguments do
+
+  describe "parsing ARGV" do
+
+    it "should extract the given command" do
+      argv = [ 'start', '-f', 'foo' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.first.should == :start
+    end
+
+    it "should have a default command if missing" do
+      argv = [ '-h' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.first.should == :run
+    end
+
+    it "should extract explicit configuration options" do
+      argv = [ 'start', '--config', 'environment=development' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.shift
+      res.first.should == [ 'environment=development' ]
+
+      res.last.should == []
+    end
+
+    it "should extract implicit configuration options" do
+      argv = [ '-e', 'production' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.shift
+      res.first.should == ['environment=production']
+
+      res.last.should == []
+    end
+
+    it "should extract daemon options" do
+      argv = [ 'start', '-h' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.shift
+      res.first.should == []
+
+      res.last.should == [ '-h' ]
+    end
+
+    it "should handle different ordered configurations easily" do
+      argv = [ '--pidfile', '/tmp/piddy', '--log', '/tmp/loggy' ]
+      res = DaemonKit::Arguments.configuration( argv )
+
+      # No additional args
+      res.last.should be_empty
+
+      res.first[0].should == "pid_file=/tmp/piddy"
+      res.first[1].should == "log_path=/tmp/loggy"
+    end
+
+    it "should handle mixed configurations easily" do
+      argv = [ '--rest', 'yes', '-l', '/tmp/loggy', '-f', 'bar' ]
+      res = DaemonKit::Arguments.configuration( argv )
+
+      res.first.should == [ 'log_path=/tmp/loggy' ]
+      res.last.should  == [ '--rest', 'yes', '-f', 'bar' ]
+    end
+  end
+end