insidious 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad7509659f0b9ee6452f114f372f7fe80c9fda90
-  data.tar.gz: 7d19317732b6409eddcff3bca14161d4df0f30bf
+  metadata.gz: 8485070f7631adf42bf17e80f53a3f0d19a4f174
+  data.tar.gz: 7f3b4f5e89e271c78288c53a862ff55a22d1bc8f
 SHA512:
-  metadata.gz: 71ca90b365af0c14934e9eec46d20333cbc167b4d014dcb8177edd38d239c8f24d22c10832cf0125721f69a0102272650239f6322582b24ffe6528550ca6afd6
-  data.tar.gz: 07205f48fa03b51f78a7fc208d0f2392b511ad020b1d5268a8a2ced9d662d65726c11780e991c94ebfbfb9057d0cc99194a9fc3d316673410e2536a836483370
+  metadata.gz: 9afb4f6f5fa50d56fcd7a43d70b4e3493dbe60feff439f40b9135e9b43052dcf5813b5bcc4458a8d0f11baffa2a66ff81115fe14301c68c33d9f4912f05c1424
+  data.tar.gz: e70ee2281b526eb160b3dcc1a4c94fa80321a44163b43fe0505bd73702733cb746f1f2f7ef1bccff90e38ee8f202b1d3fb94478dbd692f5bd0bf8213e524fb7d

data/README.md

@@ -3,9 +3,71 @@ Insidious [![Gem Version](http://img.shields.io/gem/v/insidious.svg)](https://ru
 
 A simple and flexible ruby gem for managing daemons.
 
-### Usage
+### Configuration
 
-Coming soon but for now check out [examples/insidious.rb](https://github.com/jamesrwhite/insidious/blob/master/examples/insidious.rb).
+````ruby
+insidious = new Insidious(
+  :pid_file => '/path/where/the/pid/will/be/saved',
+  :daemonize => true, # can be true or false but defaults to being true
+)
+````
+
+### Start a daemon
+
+````ruby
+insidious = Insidious.new(:pid_file => '/tmp/insidious.pid')
+
+insidious.start! do
+  while true
+    puts Time.now.utc
+    sleep 1
+  end
+end
+````
+
+### Stop a daemon
+
+````ruby
+insidious = Insidious.new(:pid_file => '/tmp/insidious.pid')
+
+insidious.start! { your_app }
+
+insidious.stop!
+````
+
+### Restart a daemon
+
+````ruby
+insidious = Insidious.new(:pid_file => '/tmp/insidious.pid')
+
+insidious.start! { your_app }
+
+insidious.restart! { your_app }
+````
+
+### Check the status of a daemon
+
+````ruby
+insidious = Insidious.new(:pid_file => '/tmp/insidious.pid')
+
+insidious.start! { your_app }
+
+insidious.running? # => true
+
+insidious.stop!
+
+insidious.running? # => false
+````
+
+### Get the process id of a daemon
+
+````ruby
+insidious = Insidious.new(:pid_file => '/tmp/insidious.pid')
+
+insidious.start! { your_app }
+
+insidious.pid # This will read from /tmp/insidious.pid
+````
 
 ### Credit
 

data/lib/insidious.rb

@@ -1,43 +1,12 @@
 require 'error'
 
 class Insidious
-  attr_accessor :pid_file
-  attr_accessor :pid
-  attr_accessor :stdin
-  attr_accessor :stdout
-  attr_accessor :stderr
+  attr_reader :pid_file
 
+  # Intiailise Insidious, note the correct spelling of initialise.
   def initialize(options = {})
     @daemonize = options[:daemonize].nil? ? true : options[:daemonize]
-    @pid_file = options[:pid_file]
-    @stdin = options[:stdin]
-    @stdout = options[:stdout]
-    @stderr = options[:stderr]
-  end
-
-  # Runs the daemon
-  #
-  # This will set up `INT` & `TERM` signal handlers to stop execution
-  # properly. When this signal handlers are called it will also call
-  # the #interrupt method and delete the pid file
-  def run!(&block)
-    begin
-      if @daemonize
-        Process.daemon(true, (stdin || stdout || stderr))
-      end
-
-      save_pid_file
-
-      block.call
-    rescue Interrupt, SignalException
-      interrupt
-    end
-  end
-
-  # Handles an interrupt (`SIGINT` or `SIGTERM`) properly as it
-  # deletes the pid file and calles the `stop` method.
-  def interrupt
-    File.delete(pid_file) if pid_file && File.exists?(pid_file)
+    @pid_file = options[:pid_file].nil? ? nil : File.absolute_path(options[:pid_file])
   end
 
   # Starts the daemon
@@ -51,12 +20,12 @@ class Insidious
       fail InsidiousError.new("Process is already running with PID #{pid}")
       exit 2
     else
-      if pid_file.nil? && daemonize
+      if @pid_file.nil? && daemon?
         fail InsidiousError.new('No PID file is set but daemonize is set to true')
         exit 1
       end
 
-      run!(&block)
+      run_daemon!(&block)
     end
   end
 
@@ -65,41 +34,35 @@ class Insidious
   # 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)
+    if @pid_file && File.exists?(@pid_file)
       begin
         Process.kill(:INT, pid)
-        File.delete(pid_file)
+        File.delete(@pid_file)
       rescue Errno::ESRCH
         fail InsidiousError.new("No process is running with PID #{pid}")
         exit 3
       end
     else
-      fail InsidiousError.new("Couldn't find the PID file: '#{pid_file}'")
+      fail InsidiousError.new("Couldn't find the PID file: '#{@pid_file}'")
       exit 1
     end
   end
 
-  # Restarts the daemon
+  # Restarts the daemon, just a convenience method really
   def restart!(&block)
-    if running?
-      stop!
-    end
-
+    stop! if running?
     start!(&block)
   end
 
-  # Get the pid from the pid_file
-  def pid
-    File.read(@pid_file).strip.to_i
-  end
-
-  # Returns `true` if the daemon is running
+  # Returns true if the daemon is running
   def running?
     # First check if we have a pid file and if it exists
-    if pid_file.nil? || !File.exists?(pid_file)
-      return false
-    end
+    return false if @pid_file.nil? || !File.exists?(@pid_file)
+
+    # Then make sure we have a pid
+    return false if pid.nil?
 
+    # If we can get the process id then we assume it is running
     begin
       Process.getpgid(pid)
       true
@@ -113,54 +76,45 @@ class Insidious
     @daemonize
   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))
+  # Get the pid from the pid_file
+  # TODO: should this be 'cached'?
+  def pid
+    File.read(@pid_file).strip.to_i
   end
 
-  # Set the path where the PID file will be created
-  def pid_file=(path)
-    @pid_file = File.absolute_path(path)
+  # Save the PID to the PID file specified in @pid_file
+  def pid=(pid)
+    File.open(@pid_file, 'w') do |file|
+      file.write(pid)
+    end if @pid_file
   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
+  private
 
-  # Reopens `STDOUT` for writing to `path`
+  # Runs the daemon
   #
-  # 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
+  # This will set up `INT` & `TERM` signal handlers to stop execution
+  # properly. When this signal handlers are called it will also call
+  # the #interrupt method and delete the pid file
+  def run_daemon!(&block)
+    begin
+      # Only start the process as a daemon if requested
+      Process.daemon(true) if daemon?
 
-  # 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
+      # Set the process id, this will save it to @pid_file
+      self.pid = Process.pid
 
-  private
+      # Call the block of code passed to us
+      block.call
+    # Handle interruptipns such as someone ctrl-c or killing the process
+    rescue Interrupt, SignalException
+      interrupt!
+    end
+  end
 
-  # 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)
-    end if pid_file
+  # Handle an interrupt (`SIGINT` or `SIGTERM`) by deleting the
+  # pid file if it exists
+  def interrupt!
+    File.delete(@pid_file) if @pid_file && File.exists?(@pid_file)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insidious
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - James White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-05 00:00:00.000000000 Z
+date: 2014-04-12 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -32,12 +32,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []