djinn 0.0.8 → 0.0.9

data/.gitignore

@@ -24,3 +24,5 @@ log
 **/*.log
 *.sqlite3
 **/*.sqlite3
+*.pid
+**/*.pid

data/README.rdoc

@@ -2,7 +2,11 @@
 
 Djinn is a very basic helper for building simple daemons.
 
-== Non-Rails Example
+== Documentation
+
+http://rdoc.info/projects/craigp/djinn
+
+== Non-Rails Example (old non-DSL way, will be deprecated soon-ish)
 
   #!/usr/bin/env ruby
 
@@ -60,9 +64,69 @@ These options will also be passed to your *perform* method, so you can include
 anything you need in the hash as well, or in the YAML file for that matter.
   
 It might seem ugly, but the solution is minimal, and so remains flexible I think. 
-The rails daemon helpers are an implementation on top of this illustrating how it 
+The Rails daemon helpers are an implementation on top of this illustrating how it 
 can be tailored to include some option parsing and so forth, and so do a little 
 more for you.
+
+== Non-Rails Example (new DSL awesomesauce)
+
+Using the same silly example, you can do this:
+
+  #!/usr/bin/env ruby
+
+  require 'rubygems'
+  require 'djinn'
+
+  class Basic
+  
+    include Djinn
+  
+    djinn do
+      on :start do
+        log "ZOMG! A Djinn?"
+      end
+  
+      on :exit do
+        log "Handling a nice graceful exit.."
+      end
+    end
+  
+  end
+
+Much cleaner and prettier, and no horrible *super* required. Available
+actions to the *on* method are *:start*, *:stop* and *:exit*
+
+Run it in the foreground in the same way:
+
+  djinn = Basic.new
+  djinn.run
+
+The actions are executed in the context of the Djinn itself, so you can
+get at the config without having to pass it around:
+
+  djinn do
+    on :start do
+      my_setting = config[:omghax]
+    end
+  end
+  
+  ...
+  
+  djinn.run { :omghax => "Groovy, baby" }
+  
+You can also give it a block to work with:
+
+  djinn.run do
+    puts "This will happen before calling the :start action"
+  end
+
+If you need to man-handle the internals and stuff, it yields itself:
+
+  djinn.run do |djinn|
+    djinn.config[:omghax] = "Groovy, baby"
+  end
+  
+The Rails Djinn's can be built in exactly the same way as this.
   
 == Rails Example
 
@@ -130,7 +194,7 @@ and monitor it with god or a similar process monitor.
   
 == TODO
 
-Lots. Keep 'em peeled.
+Lots.
 
 == Copyright
 

data/Rakefile

@@ -13,8 +13,8 @@ begin
     gem.add_development_dependency "shoulda", ">= 2.11.1"
     gem.files.exclude 'example/**/*'
     gem.test_files.exclude 'example/**/*'
-    gem.has_rdoc = true
-    gem.rubyforge_project = 'djinn'
+    # gem.has_rdoc = true
+    # gem.rubyforge_project = 'djinn'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.8
+0.0.9

data/djinn.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{djinn}
-  s.version = "0.0.8"
+  s.version = "0.0.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Craig Paterson"]
-  s.date = %q{2010-07-27}
+  s.date = %q{2010-07-28}
   s.description = %q{Helper for creating simple custom daemons}
   s.email = %q{darksavant@gmail.com}
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "djinn.gemspec",
      "lib/djinn.rb",
      "lib/djinn/base.rb",
+     "lib/djinn/dsl.rb",
      "lib/djinn/logging.rb",
      "lib/djinn/pid_file.rb",
      "lib/djinn/rails.rb",
@@ -37,7 +38,6 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/craigp/djinn}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{djinn}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Helper for creating simple custom daemons}
   s.test_files = [

data/lib/djinn.rb

@@ -1,11 +1,18 @@
+$:.unshift(File.dirname(__FILE__))
+
 require 'yaml'
 require 'djinn/base'
+require 'djinn/dsl'
 
 # This is a base implementation which handles looking for config
 # files and sets up the default locations for pid and log files
 module Djinn
 
   include Djinn::Base
+  
+  def self.included(base)
+    base.extend Djinn::Dsl
+  end
 
   private
   

data/lib/djinn/base.rb

@@ -7,10 +7,10 @@ require 'logging'
 module Djinn
   # The base class from which all Djinn spring forth
   module Base
-    
+        
     include Djinn::Tonic
     include Djinn::Logging
-    
+        
     attr_reader :config
     
     # Base implementation does nothing worthwhile, you should override this 
@@ -18,8 +18,8 @@ module Djinn
     def perform config={}
       trap('TERM') { handle_exit }
       trap('INT')  { handle_exit }
-      while true
-        log("[#{name}] Djinn is running..")
+      while
+        log("[#{name}] Djinn is running.. and doing nothing worthwhile.")
         sleep(5)
       end 
     end
@@ -27,6 +27,7 @@ module Djinn
     # Override this with useful exit code if you need to, but remember to
     # call *super* or call *exit* yourself, or your Djinn will be immortal 
     def handle_exit
+      __exit! if respond_to?(:__exit!)
       exit(0)
     end
 
@@ -36,10 +37,10 @@ module Djinn
       log "Starting #{name} in the background.."
       logfile = get_logfile(config)
       daemonize(logfile, get_pidfile(config)) do
-        yield if block_given?
+        yield(self) if block_given?
         trap('TERM') { handle_exit }
         trap('INT')  { handle_exit }
-        perform(@config)
+        (respond_to?(:__start!)) ? __start! : perform(@config)
       end
     end
 
@@ -50,8 +51,8 @@ module Djinn
       log "Starting #{name} in the foreground.."
       trap('TERM') { handle_exit }
       trap('INT')  { handle_exit }
-      yield if block_given?
-      perform(@config)
+      yield(self) if block_given?
+      (respond_to?(:__start!)) ? __start! : perform(@config)
     end
 
     # Convenience method, really just calls *stop* and then *start* for you :P
@@ -64,6 +65,8 @@ module Djinn
     # which case its all about you and the *kill* command
     def stop config={}
       @config = (config.empty?) ? load_config : config
+      yield(self) if block_given?
+      __stop! if respond_to?(:__stop!)
       pidfile = get_pidfile(@config)
       log 'No such process' and exit unless pidfile.pid
       begin
@@ -74,6 +77,7 @@ module Djinn
       ensure
         pidfile.remove
       end
+      
     end
     
     protected

data/lib/djinn/dsl.rb

@@ -0,0 +1,36 @@
+module Djinn
+  module Dsl
+  
+    def djinn &block
+      @dsl_helper = DslHelper.new(&block)
+      @dsl_helper.actions.each do |action, proc|
+        module_eval do
+          define_method "__#{action}!".intern do |*args|
+            instance_exec(&proc)
+          end
+        end
+      end
+    end
+
+    class DslHelper
+      
+      attr_accessor :actions
+      
+      def initialize &block
+        @actions = {}
+        instance_eval(&block)
+      end
+      
+      def on action, &block
+        acceptable_actions = %w(start stop exit)
+        raise DslActionError.new("\"#{action}\" is unrecognized, please use one of: #{acceptable_actions.join(', ')}") \
+          unless acceptable_actions.include?(action.to_s)
+        @actions[action] = block
+      end
+      
+    end
+    
+    class DslActionError < Exception; end
+  
+  end
+end

data/lib/djinn/rails.rb

@@ -1,27 +1,22 @@
 $:.unshift(File.join(File.dirname(__FILE__)))
 
 require 'yaml'
+
+require 'base'
 require 'rails/handlers'
+require 'dsl'
 
 module Djinn
   module Rails
     
-    require 'base'
-    require 'logging'
-    require 'pid_file'
-    require 'tonic'
-    
     include Djinn::Base
-    
-    RAILS_ROOT = File.expand_path(Dir.pwd) unless defined?(RAILS_ROOT)
 
-    class << self
-      
-      def included(base)
-        base.__send__(:extend, Djinn::Rails::Handlers)
-      end
-            
+    def self.included(base)
+      base.__send__(:extend, Djinn::Rails::Handlers)
+      base.__send__(:extend, Djinn::Dsl)
     end
+        
+    RAILS_ROOT = File.expand_path(Dir.pwd) unless defined?(RAILS_ROOT)
     
     private
         

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: djinn
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Craig Paterson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-27 00:00:00 +02:00
+date: 2010-07-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ files:
 - djinn.gemspec
 - lib/djinn.rb
 - lib/djinn/base.rb
+- lib/djinn/dsl.rb
 - lib/djinn/logging.rb
 - lib/djinn/pid_file.rb
 - lib/djinn/rails.rb
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: djinn
+rubyforge_project: 
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3