djinn 0.1.6 → 0.1.7

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/djinn.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{djinn}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Craig Paterson"]
@@ -14,14 +14,12 @@ Gem::Specification.new do |s|
   s.email = %q{darksavant@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.rdoc",
-    "README.rdoc.old"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
     "LICENSE",
     "README.rdoc",
-    "README.rdoc.old",
     "Rakefile",
     "VERSION",
     "djinn.gemspec",

data/lib/djinn/rails/handlers.rb

@@ -18,6 +18,7 @@ module Djinn
         @definition.prepare(djinn.config.update(config))
         
         unless djinn.config[:__stop]
+          yield djinn if block_given?
           if djinn.config[:__daemonize]
             djinn.start do
               ENV["RAILS_ENV"] = djinn.config[:rails_env] || "development"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: djinn
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - Craig Paterson
@@ -43,12 +43,10 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
-- README.rdoc.old
 files: 
 - .document
 - LICENSE
 - README.rdoc
-- README.rdoc.old
 - Rakefile
 - VERSION
 - djinn.gemspec

data/README.rdoc.old

@@ -1,251 +0,0 @@
-= Djinn
-
-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
-
-  require 'rubygems'
-  require 'djinn'
-
-  class Basic
-  
-    include Djinn
-  
-    # Not providing a "perform" method falls back to the base method 
-    # in Djinn, which does nothing useful. Make sure your method accepts
-    # a config hash, even if it doesn't use it.
-    def perform options
-      while
-        log "ZOMG! A Djinn?"
-        sleep(5)
-      do
-    end
-  
-    # Strictly optional, lets you do stuff when the Djinn daemon stops.
-    # The call to "super" is required, or your daemon will never die
-    def handle_exit
-      log "Handling a nice graceful exit.."
-      super
-    end
-  
-  end
-
-Run it in the foreground like this:
-
-  djinn = Basic.new
-  djinn.run
-  
-But running it in the background is sort of the point. A bit contrived, but
-this is the general idea:
-
-  djinn.start
-  sleep(10)
-  djinn.stop
-  
-Assuming you didn't sleep there your script would end and the daemon would
-detach and run in the background until it dies or gets killed. You can wrap
-argument parsing around that if you want, or do it in any other way. By default 
-the daemon will look for a config YAML file in same directory as you executed it
-from, named the same as the Djinn class, so in this case *basic.yml*. It will by
-default create the pid and log files in the same way. You can change this by 
-putting it in the config file or supplying an options hash:
-
-  options = {
-    'pid_file_path' => 'path/to/pid/file',
-    'log_file_path' => 'path/to/log/file'
-  }
-  
-  djinn.start(options)
-  
-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 
-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
-        while
-          log "ZOMG! A Djinn?"
-          sleep(5)
-        end
-      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
-  
-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
-
-There's a simple example in the example directory if you check the code out, but
-here's the gist of it.
-
-Assumes a scenario where you have a Book model that keeps a count of how many
-times a book has been read.  
-
-Create a file in RAILS_ROOT/lib or somewhere similar:
-
-  require 'djinn/rails'
-  require 'eventmachine'
-
-  class BookDjinn
-  
-    BOOK_WORKER_INTERVAL = 5
-  
-    include Djinn::Rails
-
-    def perform config
-      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
-
-    def handle_exit
-      EM.stop
-      super
-    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:
-
-  #!/usr/bin/env ruby
-  require 'rubygems'
-  require File.join(File.dirname(__FILE__), '../lib/book_djinn')
-  BookDjinn.go ARGV
- 
-Righto, now start it from RAILS_ROOT:
-
-  ruby script/book_djinn
-  
-Okay, but that defaults to _run_, which starts it in the foreground and also 
-uses the rails development environment by default. Try this:
-
-  ruby script/book_djinn --help
-  
-That should give you a better idea of what's going on, then try this:
-
-  ruby script/book_djinn start -e production
-  
-Yay, we have a daemon running in the background! To stop it:
-
-  ruby script/book_djinn stop
-  
-That gives you more-or-less everything you need to build something basic
-and monitor it with god or a similar process monitor.
-  
-== TODO
-
-Lots.
-
-== Copyright
-
-Copyright (c) 2010 Craig Paterson. See LICENSE for details.