kennethkalmer-daemon-kit 0.1.4 → 0.1.5

data/History.txt

@@ -1,3 +1,8 @@
+== 0.1.5 2009-05-07
+
+* DaemonKit::Config class to easy the use of YAML configs internally,
+  and in generated daemons
+
 == 0.1.2 2009-04-28
 
 * Added missing rubigen dependency

data/Manifest.txt

@@ -15,6 +15,7 @@ app_generators/daemon_kit/templates/config/environments/development.rb
 app_generators/daemon_kit/templates/config/environments/production.rb
 app_generators/daemon_kit/templates/config/environments/test.rb
 app_generators/daemon_kit/templates/config/initializers/readme
+app_generators/daemon_kit/templates/lib/daemon.rb
 app_generators/daemon_kit/templates/libexec/daemon.erb
 bin/daemon_kit
 daemon_generators/amqp/USAGE
@@ -40,6 +41,7 @@ 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/config.rb
 lib/daemon_kit/cron.rb
 lib/daemon_kit/initializer.rb
 lib/daemon_kit/jabber.rb
@@ -66,6 +68,8 @@ tasks/rspec.rake
 test/test_amqp_generator.rb
 test/test_cron_generator.rb
 test/test_daemon-kit_generator.rb
+test/test_daemon_kit_config.rb
 test/test_generator_helper.rb
+test/test_helper.rb
 test/test_jabber_generator.rb
 test/test_nanite_agent_generator.rb

data/app_generators/daemon_kit/daemon_kit_generator.rb

@@ -49,7 +49,7 @@ class DaemonKitGenerator < RubiGen::Base
       # Generator
       if installer == "default"
         m.directory "libexec"
-        m.template  "libexec/daemon.erb", "libexec/#{daemon_name}.rb"
+        m.template  "libexec/daemon.erb", "libexec/#{daemon_name}-daemon.rb"
       else
         m.dependency installer, [daemon_name], :destination => destination_root, :collision => :force
       end
@@ -65,6 +65,7 @@ class DaemonKitGenerator < RubiGen::Base
 
       # Libraries
       m.directory "lib"
+      m.file "lib/daemon.rb", "lib/#{daemon_name}.rb"
 
       # Tests
       m.directory "tasks"

data/app_generators/daemon_kit/templates/lib/daemon.rb

@@ -0,0 +1 @@
+# Your starting point for daemon specific classes

data/lib/daemon_kit.rb

@@ -4,10 +4,11 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'rubygems'
 
 module DaemonKit
-  VERSION = '0.1.4'
-  
+  VERSION = '0.1.5'
+
   autoload :Initializer, 'daemon_kit/initializer'
   autoload :Application, 'daemon_kit/application'
+  autoload :Config,      'daemon_kit/config'
   autoload :Cron,        'daemon_kit/cron'
   autoload :Jabber,      'daemon_kit/jabber'
   autoload :AMQP,        'daemon_kit/amqp'

data/lib/daemon_kit/amqp.rb

@@ -11,11 +11,7 @@ module DaemonKit
     class << self
 
       def instance
-        @instance ||= (
-          config = YAML.load_file( "#{DAEMON_ROOT}/config/amqp.yml" )[DAEMON_ENV]
-          raise ArgumentError, "Missing AMQP configuration for #{DAEMON_ENV} environment" if config.nil?
-          new( config )
-        )
+        @instance ||= new
       end
 
       private :new
@@ -26,7 +22,7 @@ module DaemonKit
     end
 
     def initialize( config = {} )
-      @config = config.inject({}) { |m,c| m[c[0].to_sym] = c[1]; m } # symbolize_keys 
+      @config = DaemonKit::Config.load('amqp').to_h( true )
     end
 
     def run(&block)

data/lib/daemon_kit/config.rb

@@ -0,0 +1,64 @@
+module DaemonKit
+
+  # Simplify simple config file loading for daemons. Assumes the
+  # config files all live in DAEMON_ROOT/config and are YAML
+  # files. Loaded configs are accessed like a hash with string
+  # keys.
+  #
+  # Config files can either be keyed by environment (default behavior)
+  # or be a normal hash.
+  #
+  # Load a config by passing the filename (with or without the .yml
+  # extension) to #load.
+  #
+  # At this stage the configs are read-only.
+  #
+  # Any of the keys can be called as methods as well.
+  class Config
+
+    class << self
+
+      # Load the +config+.yml file from DAEMON_ROOT/config
+      def load( config )
+        config += '.yml' unless config =~ /\.yml$/
+
+        path = File.join( DAEMON_ROOT, 'config', config )
+
+        raise ArgumentError, "Can't find #{path}" unless File.exists?( path )
+
+        new( YAML.load_file( path ) )
+      end
+
+    end
+
+    # Expects a hash, looks for DAEMON_ENV key
+    def initialize( config_data ) #:nodoc:
+      if config_data.has_key?( DAEMON_ENV )
+        @data = config_data[ DAEMON_ENV ]
+      else
+        @data = config_data
+      end
+    end
+
+    # Pick out a config by name
+    def []( key )
+      @data[ key.to_s ]
+    end
+
+    # Return the internal hash structure used, optionally symbolizing
+    # the first level of keys in the hash
+    def to_h( symbolize = false )
+      symbolize ? @data.inject({}) { |m,c| m[c[0].to_sym] = c[1]; m } : @data
+    end
+
+    def method_missing( method_name, *args ) #:nodoc:
+      # don't match setters
+      unless method_name.to_s =~ /[\w_]+=$/
+        # pick a key if we have it
+        return @data[ method_name.to_s ] if @data.keys.include?( method_name.to_s )
+      end
+
+      super
+    end
+  end
+end

data/lib/daemon_kit/jabber.rb

@@ -12,28 +12,24 @@ module DaemonKit
     @@message_handler = nil
     @@presence_handler = nil
     @@subscription_handler = nil
-    
+
     class << self
 
       # Deliver a message to the specified jid.
       def deliver( jid, message )
         instance.connection.deliver( jid, message )
       end
-      
+
       # Use this instead of initializing, keeps it singleton
       def instance
-        @instance ||= (
-          config = YAML.load_file( "#{DAEMON_ROOT}/config/jabber.yml" )[DAEMON_ENV]
-          raise ArgumentError, "Missing Jabber configuration for #{DAEMON_ENV} environment" if config.nil?
-          new( config )
-        )
+        @instance ||= new
         @instance.startup!
       end
       private :new
 
       def run
         DaemonKit.logger.info "Starting jabber loop"
-        
+
         loop do
           process_messages
           process_updates
@@ -47,7 +43,7 @@ module DaemonKit
           end
         end
       end
-      
+
       def process_messages
         @message_handler ||= Proc.new { |m| DaemonKit.logger.info "Received message from #{m.from}: #{m.body}" }
 
@@ -62,7 +58,7 @@ module DaemonKit
         instance.connection.presence_updates { |friend, old_presence, new_presence|
           @presence_handler.call(friend, old_presence, new_presence)
         }
-        
+
       end
 
       def process_subscriptions
@@ -70,11 +66,11 @@ module DaemonKit
 
         instance.connection.subscription_requests { |friend,presence| @subscription_handler.call(friend,presence) }
       end
-        
+
       def received_messages(&block)
         @message_handler = block
       end
-      
+
       def presence_updates(&block)
         @presence_handler = block
       end
@@ -82,10 +78,12 @@ module DaemonKit
       def subscription_requests(&block)
         @subscription_handler = block
       end
-      
+
     end
 
-    def initialize( options = {} )
+    def initialize
+      options = DaemonKit::Config.load( 'jabber' )
+
       @jabber_id  = options.delete("jabber_id")
       @password   = options.delete("password")
       @resource   = options.delete("resource") || 'daemon_kit'
@@ -103,7 +101,7 @@ module DaemonKit
 
       DaemonKit.trap( 'INT', Proc.new { self.shutdown! } )
       DaemonKit.trap( 'TERM', Proc.new { self.shutdown! } )
-      
+
       @booted = true
 
       self
@@ -141,9 +139,9 @@ module DaemonKit
     def status_line
       "#{DaemonKit.configuration.daemon_name} ready for instructions"
     end
-    
+
     private
-    
+
     def connect!
       jid = @jabber_id + '/' + @resource
 
@@ -167,6 +165,6 @@ module DaemonKit
         end
       end
     end
-    
+
   end
 end

data/lib/daemon_kit/nanite/agent.rb

@@ -8,11 +8,7 @@ module DaemonKit
       class << self
 
         def instance
-          @instance ||= (
-            config = YAML.load_file( "#{DAEMON_ROOT}/config/nanite.yml" )[DAEMON_ENV]
-            raise ArgumentError, "Missing nanite configuration for #{DAEMON_ENV} environment" if config.nil?
-            new( config )
-          )
+          @instance ||= new
         end
 
         private :new
@@ -23,8 +19,8 @@ module DaemonKit
 
       end
 
-      def initialize( options = {} )
-        @config = options.inject({}) { |m,c| m[c[0].to_sym] = c[1]; m } # symbolize_keys
+      def initialize
+        @config = DaemonKit::Config.load( 'nanite' )
 
         config_agent
       end
@@ -37,7 +33,7 @@ module DaemonKit
         # Start our mapper
         mapper_thread = Thread.new do
           EM.run do
-            agent = ::Nanite.start_agent( @config )
+            agent = ::Nanite.start_agent( @config.to_h( true ) )
             block.call( agent ) if block
           end
         end

data/rubygems_generators/install_rspec/templates/spec/spec_helper.rb

@@ -8,3 +8,14 @@ end
 
 require File.dirname(__FILE__) + '/../config/boot'
 require '<%= gem_name %>'
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end

data/test/test_daemon-kit_generator.rb

@@ -43,8 +43,9 @@ class TestDaemonKitGenerator < Test::Unit::TestCase
     assert_directory_exists "config/initializers"
     assert_generated_file   "config/initializers/readme"
     assert_directory_exists "lib"
+    assert_generated_file   "lib/#{daemon_name}.rb"
     assert_directory_exists "libexec"
-    assert_generated_file   "libexec/#{daemon_name}.rb"
+    assert_generated_file   "libexec/#{daemon_name}-daemon.rb"
     assert_directory_exists "log"
     assert_directory_exists "spec"
     assert_directory_exists "tasks"

data/test/test_daemon_kit_config.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class TestDaemonKitConfig < Test::Unit::TestCase
+
+  def test_initialize_with_env_hash
+    data = {
+      'test' => {
+        'foo' => 'bar'
+      }
+    }
+
+    config = DaemonKit::Config.new( data )
+
+    assert_equal config['foo'], 'bar'
+    assert_equal config.foo, 'bar'
+  end
+
+  def test_initialize_without_env_hash
+    data = {
+      'foo' => 'bar'
+    }
+
+    config = DaemonKit::Config.new( data )
+
+    assert_equal config['foo'], 'bar'
+    assert_equal config.foo, 'bar'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+DAEMON_ENV = "test"
+
+require File.dirname(__FILE__) + '/../lib/daemon_kit'
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kennethkalmer-daemon-kit
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Kenneth Kalmer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-30 00:00:00 -07:00
+date: 2009-05-07 00:00:00 -07:00
 default_executable: daemon_kit
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,6 +82,7 @@ files:
 - app_generators/daemon_kit/templates/config/environments/production.rb
 - app_generators/daemon_kit/templates/config/environments/test.rb
 - app_generators/daemon_kit/templates/config/initializers/readme
+- app_generators/daemon_kit/templates/lib/daemon.rb
 - app_generators/daemon_kit/templates/libexec/daemon.erb
 - bin/daemon_kit
 - daemon_generators/amqp/USAGE
@@ -107,6 +108,7 @@ files:
 - lib/daemon_kit.rb
 - lib/daemon_kit/amqp.rb
 - lib/daemon_kit/application.rb
+- lib/daemon_kit/config.rb
 - lib/daemon_kit/cron.rb
 - lib/daemon_kit/initializer.rb
 - lib/daemon_kit/jabber.rb
@@ -133,7 +135,9 @@ files:
 - test/test_amqp_generator.rb
 - test/test_cron_generator.rb
 - test/test_daemon-kit_generator.rb
+- test/test_daemon_kit_config.rb
 - test/test_generator_helper.rb
+- test/test_helper.rb
 - test/test_jabber_generator.rb
 - test/test_nanite_agent_generator.rb
 has_rdoc: true
@@ -170,9 +174,11 @@ signing_key:
 specification_version: 2
 summary: 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.
 test_files: 
-- test/test_daemon-kit_generator.rb
 - test/test_generator_helper.rb
 - test/test_jabber_generator.rb
 - test/test_cron_generator.rb
 - test/test_amqp_generator.rb
 - test/test_nanite_agent_generator.rb
+- test/test_daemon-kit_generator.rb
+- test/test_daemon_kit_config.rb
+- test/test_helper.rb