daemontor 0.0.1 → 1.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in daemontor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dan Wanek
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/{README.rdoc → README.md}

@@ -1,33 +1,34 @@
-= daemontor
+h1. Daemontor
 
 * http://github.com/zenchild/daemontor
 
-== DESCRIPTION:
+h2. DESCRIPTION
 
 If you are looking for a package that allows you to simply run a process in the background, Deamontor can help you out.  If you're looking for a package that does threading and fine grain process control you'll probably want to look elsewhere.
 
-== DEPENDENCIES
+h2. DEPENDENCIES
 
 This module depends on the fork system call so it will not run on a Windows OS.
 
-== SYNOPSIS:
+h2. SYNOPSIS
 
-	require 'rubygems'
-	require 'daemontor'
-	class Test
-		include Daemontor
-		def initialize
-			daemonize!
-		end
-	end
-	Test.new
+```ruby
+require 'rubygems'
+require 'daemontor'
+class Test
+  include Daemontor
+  def initialize
+    daemonize!
+  end
+end
+Test.new
+```
 
-See code in examples/
+**Also see code in examples/**
 
-== INSTALL:
+h2. INSTALL
 
-sudo gem install daemontor
+`gem install daemontor` or `bundle install`
 
-== LICENSE:
-
-This project is licensed under GPLv3.  See COPYING.txt for details.
+h2. LICENSE
+This project is licensed under the MIT license (See LICENSE for details).

data/Rakefile

@@ -1,25 +1,2 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/daemontor'
-
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'daemontor' do
-  self.developer 'Dan Wanek', 'dan.wanek@gmail.com'
-  self.rubyforge_name = nil
-  self.spec_extras[:licenses] = "GPLv3"
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
-end
-
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/daemontor.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/daemontor/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dan Wanek"]
+  gem.email         = ["dan.wanek@gmail.com"]
+  gem.description   = %q{Module to aid in running background processes.}
+  gem.summary       = %q{If you are looking for a gem that allows you to simply run a process in the background, Deamontor can help you out. If you're looking for a package that does threading and fine grain process control you'll probably want to look elsewhere.}
+  gem.homepage      = "http://github.com/zenchild/daemontor"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.extra_rdoc_files = %w(README.md)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "daemontor"
+  gem.require_paths = ["lib"]
+  gem.version       = Daemontor::VERSION
+end

data/examples/town_crier.rb

@@ -2,27 +2,27 @@ $: << '../lib'
 require 'daemontor'
 
 class TownCrier
-	include Daemontor
-	
-	def initialize
-		$DEBUG = true  # Set this so output doesn't go to the background in the example.
-		pid = Process.pid
-		daemonize!
-		puts "Process running in background as PID: #{Process.pid}"
-		cry
-	end
+  include Daemontor
 
-	def cry
-		loop do
-			puts "It's #{Time.now.to_s} and all is well"
-			puts "Kill the process with 'kill -INT #{Process.pid}'"
-			sleep 10
-		end
-	end
+  def initialize
+    $DEBUG = true  # Set this so output doesn't go to the background in the example.
+    pid = Process.pid
+    daemonize!
+    puts "Process running in background as PID: #{Process.pid}"
+    cry
+  end
 
-	def pid
-		return Process.pid
-	end
+  def cry
+    loop do
+      puts "It's #{Time.now.to_s} and all is well"
+      puts "Kill the process with 'kill -INT #{Process.pid}'"
+      sleep 10
+    end
+  end
+
+  def pid
+    return Process.pid
+  end
 end
 
 

data/lib/daemontor.rb

@@ -1,91 +1,66 @@
-#############################################################################
-# Copyright © 2009 Dan Wanek <dan.wanek@gmail.com>
-#
-#
-# This file is part of Daemontor.
-# 
-# Daemontor is free software: you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or (at
-# your option) any later version.
-# 
-# Daemontor is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
-# Public License for more details.
-# 
-# You should have received a copy of the GNU General Public License along
-# with Daemontor.  If not, see <http://www.gnu.org/licenses/>.
-#############################################################################
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'daemontor/version'
 
-=begin rdoc
-This modules purpose is to daemonize processes so they can be run in the background like a
-standard UNIX daemon.  When Daemontor::daemonize is called the parent process fork()s a
-new child process and calls Process.detach so we don't have to wait for the child process
-to exit.  The parent process then exits and the child process goes happily on.  Since we are
-calling Process.detach we do not need to do a double-fork
-
-Thanks to the PickAxe book for good process handling information as well as hints from
-Travis Whitton's Daemonize module: http://grub.ath.cx/daemonize/
-=end
+# This module's purpose is to daemonize processes so they can be run in the
+# background like a standard UNIX daemon.  When Daemontor::daemonize is called
+# the parent process fork()s a new child process and calls Process.detach so we
+# don't have to wait for the child process to exit.  The parent process then
+# exits and the child process goes happily on. Since we are calling
+# Process.detach we do not need to do a double-fork.
+#
+# Thanks to the PickAxe book for good process handling information as well as
+# hints from Travis Whitton's Daemonize module: http://grub.ath.cx/daemonize/
 module Daemontor
-	VERSION = '0.0.1'
-
-	# This is the function that makes it all happen.  By default the parent process
-	# will be killed off.  If you want to do something with the parent afterword pass a
-	# boolean true value and you will get access to the process back once the child is
-	# detached.
-	def daemonize!(keep_parent_alive = false)
-		puts "Doing fork " + Process.pid.to_s if $DEBUG
-
-
-		if((cpid = fork).nil?)
-			# Only the child processes should get here
-			trap("INT", proc {p_int} )
-			trap("QUIT", proc {p_quit} )
-			trap("TERM", proc {p_term} )
-			trap("KILL", proc {p_kill} )
-			unless $DEBUG
-				STDIN.reopen "/dev/null"
-				STDOUT.reopen "/dev/null", "a"
-				STDERR.reopen STDOUT
-			end
-		else
-			# Only the parent processes should get here.  We detach from a specific
-			# PID so we don't globally detach from all PIDs.  This may be handy when you need some
-			# children to return and some not to.  The logic isn't here to do that yet, but it
-			# should be relatively easy to implement with this already in place.
-			puts "Detaching from child process #{cpid}" if $DEBUG
-			Process.detach(cpid)
-			exit unless keep_parent_alive
-		end
-		return cpid
-	end
 
+  # This is the function that makes it all happen. By default the parent process
+  # will be killed off.  If you want to do something with the parent afterward
+  # pass a boolean true value and you will get access to the process once the
+  # child is detached.
+  def daemonize!(keep_parent_alive = false)
+    puts "Doing fork " + Process.pid.to_s if $DEBUG
+    if((cpid = fork).nil?)
+      # Only the child processes should get here
+      trap("INT", proc {p_int} )
+      trap("QUIT", proc {p_quit} )
+      trap("TERM", proc {p_term} )
+      trap("KILL", proc {p_kill} )
+      unless $DEBUG
+        STDIN.reopen "/dev/null"
+        STDOUT.reopen "/dev/null", "a"
+        STDERR.reopen STDOUT
+      end
+    else
+      # Only the parent processes should get here.  We detach from a specific
+      # PID so we don't globally detach from all PIDs.  This may be handy when you need some
+      # children to return and some not to.  The logic isn't here to do that yet, but it
+      # should be relatively easy to implement with this already in place.
+      puts "Detaching from child process #{cpid}" if $DEBUG
+      Process.detach(cpid)
+      exit unless keep_parent_alive
+    end
+    return cpid
+  end
 
-	# *********************************************************************************
-	# You might want to overide the following methods to do something a little smarter.
-	# *********************************************************************************
+  # *********************************************************************************
+  # You might want to overide the following methods to do something a little smarter.
+  # *********************************************************************************
 
-	def p_int
-		warn "Process interupt recieved.  Killing process"
-		p_kill
-	end
+  def p_int
+    warn "Process interupt recieved.  Killing process"
+    p_kill
+  end
 
-	def p_quit
-		warn "Process quit recieved.  Killing process"
-		p_kill
-	end
+  def p_quit
+    warn "Process quit recieved.  Killing process"
+    p_kill
+  end
 
-	def p_term
-		warn "Process termination recieved.  Killing process"
-		p_kill
-	end
+  def p_term
+    warn "Process termination recieved.  Killing process"
+    p_kill
+  end
 
-	def p_kill
-		warn "Killing process #{Process.pid.to_s}"
-		exit
-	end
+  def p_kill
+    warn "Killing process #{Process.pid.to_s}"
+    exit
+  end
 end

data/lib/daemontor/version.rb

@@ -0,0 +1,3 @@
+module Daemontor
+  VERSION = "1.0.0"
+end

data/spec/daemontor_spec.rb

@@ -4,32 +4,32 @@ require File.dirname(__FILE__) + '/spec_helper.rb'
 # it should serve its purpose.
 describe "Test basic functionality of Daemontor" do
 
-	it "should spawn a new daemon and kill it" do
-		begin
-		master_pid = Process.pid.to_s
-		pids = []
-		puts "*** PID: #{Process.pid}"
-		tester = TesterClass.new
-		puts "****** PID: #{Process.pid}"
-		retval = false
+  it "should spawn a new daemon and kill it" do
+    begin
+      master_pid = Process.pid.to_s
+      pids = []
+      puts "*** PID: #{Process.pid}"
+      tester = TesterClass.new
+      puts "****** PID: #{Process.pid}"
+      retval = false
 
-		if( Process.pid.to_s == master_pid )
-			puts "IN MASTER LOGIC: Child => #{tester.cpid}"
-			pids << tester.cpid.to_s
-			pids.each do |pid|
-				puts "KILLING PID: #{pid}"
-				Process.kill("INT", pid.to_i)
-			end
-			retval = true
-		else
-			puts "IN CHILD LOGIC"
-			tester.do_stuff
-		end
-		rescue ChildEnded => e
-			puts "Child ended appropriately"
-			retval = true
-		end
-		# if we get to this point lets just call it success :)
-		retval.should be_true
-	end
+      if( Process.pid.to_s == master_pid )
+        puts "IN MASTER LOGIC: Child => #{tester.cpid}"
+        pids << tester.cpid.to_s
+        pids.each do |pid|
+          puts "KILLING PID: #{pid}"
+          Process.kill("INT", pid.to_i)
+        end
+        retval = true
+      else
+        puts "IN CHILD LOGIC"
+        tester.do_stuff
+      end
+    rescue ChildEnded => e
+      puts "Child ended appropriately"
+      retval = true
+    end
+    # if we get to this point lets just call it success :)
+    retval.should be_true
+  end
 end

data/spec/spec_helper.rb

@@ -1,42 +1,33 @@
-begin
-  require 'spec'
-rescue LoadError
-  require 'rubygems' unless ENV['NO_RUBYGEMS']
-  gem 'rspec'
-  require 'spec'
-end
-
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'daemontor'
 
-
 class TesterClass
-	include Daemontor
-	attr_reader :cpid
-	def initialize
-		$DEBUG = true  # Set this so output doesn't go to the background in the example.
-		pid = Process.pid
-		@cpid = daemonize!(true)
-		@run = true
-	end
+  include Daemontor
+  attr_reader :cpid
+  def initialize
+    $DEBUG = true  # Set this so output doesn't go to the background in the example.
+    pid = Process.pid
+    @cpid = daemonize!(true)
+    @run = true
+  end
 
-	def do_stuff
-		while @run do
-			puts "Hello, I'm process #{Process.pid}"
-			sleep 15
-		end
-	end
+  def do_stuff
+    while @run do
+      puts "Hello, I'm process #{Process.pid}"
+      sleep 15
+    end
+  end
 
-	def p_int
-		warn "Process interupt recieved.  Killing process"
-		raise ChildEnded
-		exit
-	end
+  def p_int
+    warn "Process interupt recieved.  Killing process"
+    raise ChildEnded
+    exit
+  end
 
 end
 
 class ChildEnded < StandardError
-	def message
-		"Child Ended"
-	end
+  def message
+    "Child Ended"
+  end
 end