djinn 0.0.9 → 0.1.0

data/README.rdoc

@@ -2,10 +2,17 @@
 
 Djinn is a very basic helper for building simple daemons.
 
+In Arabian mythology a Djinn is a supernatural creature which occupies a 
+parallel world to that of mankind.
+
 == Documentation
 
 http://rdoc.info/projects/craigp/djinn
 
+== Installation
+
+  gem install djinn
+
 == Non-Rails Example (old non-DSL way, will be deprecated soon-ish)
 
   #!/usr/bin/env ruby
@@ -21,7 +28,10 @@ http://rdoc.info/projects/craigp/djinn
     # in Djinn, which does nothing useful. Make sure your method accepts
     # a config hash, even if it doesn't use it.
     def perform options
-      log "ZOMG! A Djinn?"
+      while
+        log "ZOMG! A Djinn?"
+        sleep(5)
+      do
     end
   
     # Strictly optional, lets you do stuff when the Djinn daemon stops.
@@ -83,7 +93,10 @@ Using the same silly example, you can do this:
   
     djinn do
       on :start do
-        log "ZOMG! A Djinn?"
+        while
+          log "ZOMG! A Djinn?"
+          sleep(5)
+        end
       end
   
       on :exit do
@@ -94,7 +107,7 @@ Using the same silly example, you can do this:
   end
 
 Much cleaner and prettier, and no horrible *super* required. Available
-actions to the *on* method are *:start*, *:stop* and *:exit*
+actions to the *on* method are :start, :stop and :exit
 
 Run it in the foreground in the same way:
 
@@ -126,7 +139,11 @@ If you need to man-handle the internals and stuff, it yields itself:
     djinn.config[:omghax] = "Groovy, baby"
   end
   
-The Rails Djinn's can be built in exactly the same way as this.
+Starting in the background is the same as before, call *start* instead of *run*:
+
+  djinn.start
+  
+The Rails Djinns can be built in exactly the same way as this.
   
 == Rails Example
 
@@ -139,6 +156,7 @@ times a book has been read.
 Create a file in RAILS_ROOT/lib or somewhere similar:
 
   require 'djinn/rails'
+  require 'eventmachine'
 
   class BookDjinn
   
@@ -163,6 +181,38 @@ Create a file in RAILS_ROOT/lib or somewhere similar:
     end
 
   end
+  
+(And, the new more awesome way:)
+
+  require 'djinn/rails'
+  require 'eventmachine'
+
+  class BookDjinn
+  
+    BOOK_WORKER_INTERVAL = 5
+  
+    include Djinn::Rails
+
+    djinn do
+    
+      on :start do
+        EM.run do
+          log "Workers will run every #{BOOK_WORKER_INTERVAL} secs"
+          EM::PeriodicTimer.new(BOOK_WORKER_INTERVAL) do
+            log "There are #{Book.count} book(s) in the database"
+            log "Updating read counts for all books.."
+            Book.all.each &:read!
+          end
+        end
+      end
+
+      on :exit do
+        EM.stop
+      end
+      
+    end
+
+  end
 
 Right, now you need to start it somehow. The easiest way is to create a file 
 in RAILS_ROOT/scripts and pop this in it:

data/Rakefile

@@ -18,9 +18,9 @@ begin
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
-  Jeweler::RubyforgeTasks.new do |rubyforge|
-    rubyforge.doc_task = "rdoc"
-  end
+  # Jeweler::RubyforgeTasks.new do |rubyforge|
+  #   rubyforge.doc_task = "rdoc"
+  # end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.1.0

data/djinn.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{djinn}
-  s.version = "0.0.9"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Craig Paterson"]

data/lib/djinn.rb

@@ -4,8 +4,8 @@ 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
+# In Arabian mythology a Djinn is a supernatural creature which occupies a 
+# parallel world to that of mankind
 module Djinn
 
   include Djinn::Base

data/lib/djinn/dsl.rb

@@ -1,6 +1,8 @@
 module Djinn
+  # Defines the awesomesauce DSL for a whole new generation of Djinn
   module Dsl
   
+    # Start your Djinn definition
     def djinn &block
       @dsl_helper = DslHelper.new(&block)
       @dsl_helper.actions.each do |action, proc|
@@ -21,6 +23,7 @@ module Djinn
         instance_eval(&block)
       end
       
+      # Define an action that will be performed by a Djinn
       def on action, &block
         acceptable_actions = %w(start stop exit)
         raise DslActionError.new("\"#{action}\" is unrecognized, please use one of: #{acceptable_actions.join(', ')}") \
@@ -30,6 +33,7 @@ module Djinn
       
     end
     
+    # This error means you screwed something up in your action definition 
     class DslActionError < Exception; end
   
   end

data/lib/djinn/logging.rb

@@ -1,31 +1,33 @@
 module Djinn
+  # Logging Helper Class of Awesomeness
   module Logging
-    
-    def djinn_log msg
-      puts "#{Time.now.strftime("%m/%d/%Y %H:%M:%S")}: #{msg}"
-      STDOUT.flush
-    end
-  
+      
+    # Log something to STDOUT, or wherever it's been redirected to
     def log msg
       puts "#{Time.now.strftime("%m/%d/%Y %H:%M:%S")}: #{msg}"
       STDOUT.flush
     end
   
+    # Make some text *green*
     def green text
       colorize 32, text
     end
 
+    # Make some text *red*
     def red text
       colorize 31, text
     end
   
+    # Make some text *cyan*
     def cyan text
       colorize 36, text
     end
 
-    def colorize color, text
-      "\033[#{color}m#{text}\033[0m"
-    end
+    private
+
+      def colorize color, text
+        "\033[#{color}m#{text}\033[0m"
+      end
   
   end
 end

data/lib/djinn/pid_file.rb

@@ -1,4 +1,5 @@
 module Djinn
+  # pid files are what bind your Djinn to the material plane
   class PidFile
 
     attr_reader :file
@@ -19,7 +20,7 @@ module Djinn
       File.open(@file, "w") { |f| f.write($$) }
     end
 
-    def ensure_empty!(msg = nil)
+    def ensure_empty(msg = nil)
       if self.pid
         $stdout.puts msg if msg
         exit 1

data/lib/djinn/rails.rb

@@ -7,6 +7,7 @@ require 'rails/handlers'
 require 'dsl'
 
 module Djinn
+  # The basis for all Djinn that want to soar among the Rails stars
   module Rails
     
     include Djinn::Base

data/lib/djinn/tonic.rb

@@ -1,24 +1,20 @@
 module Djinn
+  # This play on words kills me everytime. I'm that lame.
   module Tonic
   
+    # Send your Djinn off to frolic in the ether
     def daemonize(logfile, pidfile, &block)
-    
-      pidfile.ensure_empty! "ERROR: It looks like I'm already running. Not starting."
-    
+      pidfile.ensure_empty("It looks like I'm already running. Not starting.")
       puts "Djinn is leaving process #{$$}"
-    
-      srand # Split rand streams between spawning and daemonized process
-      #fork and exit # Fork and exit from the parent
+      
+      srand # split rand streams between spawning and daemonized process
+      
       fork do
-    
         puts "Daemonizing on process #{$$}" 
         # puts system("ps aux | grep #{$$}")
     
-        # trap('TERM') { do_exit }
-        # trap('INT') { do_exit }
-        
-        #Dir.chdir "/"   # Release old working directory
-        File.umask 0000 # Ensure sensible umask
+        #Dir.chdir "/" # release old working directory
+        File.umask 0000 # ensure sensible umask
     
         puts 'Making sure all file descriptors are closed'
         ObjectSpace.each_object(IO) do |io|
@@ -30,16 +26,14 @@ module Djinn
           end
         end
         
-        puts "Writing PID file: #{pidfile.file}"
-        pidfile.create
-    
-        puts 'Detaching from the controlling terminal'
+        pidfile.create # write PID file
+        
+        # detach from controlling terminal
         unless sess_id = Process.setsid
-          raise 'cannot detach from controlling terminal'
+          raise 'Cannot detach from controlling terminal'
         end
     
-        # Redirect IO
-        puts "Logging to: #{logfile}"
+        # redirect IO
         STDIN.reopen('/dev/null')
         STDOUT.reopen(logfile, 'a')
         STDERR.reopen(STDOUT)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: djinn
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Craig Paterson