fallen 0.0.1 → 0.0.2

data/.gitignore

@@ -1 +1,3 @@
 *.gem
+.yardoc
+doc/

data/.yardopts

@@ -0,0 +1,3 @@
+--markup=markdown
+lib/**/*.rb -
+README.md UNLICENSE

data/README.md

@@ -11,7 +11,7 @@ module Azazel
   
   def self.run
     while running?
-      puts "My name is Legion"
+      puts "Time is on my side... Yes it is..."
       sleep 666
     end
   end
@@ -20,7 +20,7 @@ end
 Azazel.start!
 ```
 
-This will print _My name is Legion_ every 666 seconds on `STDOUT`. You can stop the daemon by pressing `CTRL+c`.
+This will print _Time is on my side... Yes it is.._ every 666 seconds on `STDOUT`. You can stop the daemon by pressing `CTRL+c`.
 
 ## Control your daemon
 `Fallen` accepts the following methods:

data/fallen.gemspec

@@ -2,12 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name        = "fallen"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.summary     = "A simpler daemon library"
   s.description = "A simpler way to create Ruby fallen angels, better known as daemons"
   s.authors     = ["Leandro López"]
   s.email       = ["inkel.ar@gmail.com"]
-  s.homepage    = "https://github.com/inkel/fallen"
+  s.homepage    = "http://inkel.github.com/fallen"
+  s.license     = "UNLICENSE"
+
+  s.required_ruby_version = '>= 1.9.2'
 
   s.files       = `git ls-files`.split("\n")
 end

data/lib/fallen.rb

@@ -5,37 +5,68 @@ module Fallen
   @stdout  = nil
   @stderr  = nil
 
+  # Detachs this fallen angel from current process and runs it in
+  # background
+  #
+  # @note Unless `STDIN`, `STDOUT` or `STDERR` are redirected to a
+  #   file, these will be redirected to `/dev/null`
   def daemonize!
-    Process.daemon true
+    Process.daemon true, (@stdin || @stdout || @stderr)
   end
 
+  # Changes the working directory
+  #
+  # All paths will be relative to the working directory unless they're
+  # specified as absolute paths.
+  #
+  # @param [String] path of the new workng directory
   def chdir! path
     Dir.chdir File.absolute_path(path)
   end
 
+  # Path where the PID file will be created
   def pid_file path
     @pid_file = File.absolute_path(path)
   end
 
+  # Reopens `STDIN` for reading from `path`
+  #
+  # This path is relative to the working directory unless an absolute
+  # path is given.
   def stdin path
     @stdin = File.absolute_path(path)
     STDIN.reopen @stdin
   end
 
+  # Reopens `STDOUT` for writing to `path`
+  #
+  # This path is relative to the working directory unless an absolute
+  # path is given.
   def stdout path
     @stdout = File.absolute_path(path)
     STDOUT.reopen @stdout, "a"
   end
 
+  # Reopens `STDERR` for writing to `path`
+  #
+  # This path is relative to the working directory unless an absolute
+  # path is given.
   def stderr path
     @stderr = File.absolute_path(path)
     STDERR.reopen @stderr, "a"
   end
 
+  # Returns `true` if the fallen angel is running
   def running?
     @running
   end
 
+  # Brings the fallen angel to life
+  #
+  # If a PID file was provided it will try to store the current
+  # PID. If this files exists it will try to check if the stored PID
+  # is already running, in which case `Fallen` will exit with an error
+  # code.
   def start!
     if @pid_file && File.exists?(@pid_file)
       pid = File.read(@pid_file).strip
@@ -51,6 +82,11 @@ module Fallen
     end
   end
 
+  # Runs the fallen angel
+  #
+  # This will set up `INT` & `TERM` signal handlers to stop execution
+  # properly. When this signal handlers are called it will also call
+  # the `stop` callback method.
   def run!
     save_pid_file
     @running = true
@@ -59,6 +95,10 @@ module Fallen
     run
   end
 
+  # Stops fallen angel execution
+  #
+  # This method only works when a PID file is given, otherwise it will
+  # exit with an error.
   def stop!
     if @pid_file && File.exists?(@pid_file)
       pid = File.read(@pid_file).strip
@@ -74,10 +114,12 @@ module Fallen
     end
   end
 
+  # Callback method to be run when fallen angel stops
   def stop; end
 
   private
 
+  # Save the falen angel PID to the PID file specified in `pid_file`
   def save_pid_file
     File.open(@pid_file, "w") do |fp|
       fp.write(Process.pid)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fallen
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000 Z
+date: 2012-09-08 00:00:00.000000000 Z
 dependencies: []
 description: A simpler way to create Ruby fallen angels, better known as daemons
 email:
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - README.md
 - UNLICENSE
 - examples/azazel.rb
@@ -26,8 +27,9 @@ files:
 - fallen.gemspec
 - lib/fallen.rb
 - lib/fallen/cli.rb
-homepage: https://github.com/inkel/fallen
-licenses: []
+homepage: http://inkel.github.com/fallen
+licenses:
+- UNLICENSE
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -37,7 +39,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -51,3 +53,4 @@ signing_key:
 specification_version: 3
 summary: A simpler daemon library
 test_files: []
+has_rdoc: