simple_pid 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 watsonian
+
+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

@@ -0,0 +1,55 @@
+= simple_pid
+
+This is a simple library for managing pid files. It was extracted from Kenneth
+Kalmer's excellent daemon-kit project (http://github.com/kennethkalmer/daemon-kit).
+The daemon-kit framework is amazing for bootstrapping your daemons, but if
+you need something more lightweight (e.g., a single file daemon), then you're
+out of luck (for now). In the mean time, there weren't any obvious, simple
+pid file management libraries that you could trust. This one works well and
+has facilities to ensure the process the pid file is pointing to is still running,
+so you can handle stale pid files easily.
+
+= Usage
+
+Some samples of the most common uses:
+
+ require 'rubygems'
+ require 'simple_pid'
+ 
+ pid = SimplePid.new("/path/to/your.pid")
+ 
+ if pid.exists?
+   unless pid.running?
+     pid.cleanup
+     pid.write!
+   end
+ else
+   pid.write!
+ end
+
+Most of the above is fairly self-explanatory. You can accomplish all of the
+above by calling:
+
+ SimplePid.drop("/path/to/your.pid")
+
+And you can cleanup quickly with:
+
+ SimplePid.cleanup("/path/to/your.pid")
+
+The above cleanup class method returns true if the process wasn't running
+and the cleanup was actually run. It returns false if the process was still
+running and no cleanup occurred.
+
+You can check to see if the process is running and exit with an error message
+if it is like this:
+
+ pid.ensure_stopped!
+
+The current contents of the pid file can always be accessed like this:
+
+ pid.pid
+
+== Copyright
+
+Copyright (c) 2010 Joel Watson. Portions copyright Kenneth
+Kalmer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simple_pid"
+    gem.summary = %Q{A simple, but complete library for managing pidfiles.}
+    gem.description = %Q{A simple, but complete library for managing pidfiles.}
+    gem.email = "watsonian@gmail.com"
+    gem.homepage = "http://github.com/watsonian/simple_pid"
+    gem.authors = ["watsonian"]
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_pids #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/core_ext.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/core_ext/string'

data/lib/core_ext/string.rb

@@ -0,0 +1,25 @@
+# Extracted from Kenneth Kalmer's excellent daemon-kit project
+# on GitHub: http://github.com/kennethkalmer/daemon-kit
+
+require 'pathname'
+
+class String
+
+  # Assuming the string is a file or path name, convert it into an
+  # absolute path.
+  def to_absolute_path
+    # Pathname is incompatible with Windows, but Windows doesn't have
+    # real symlinks so File.expand_path is safe.
+    if RUBY_PLATFORM =~ /(:?mswin|mingw)/
+      File.expand_path( self )
+
+      # Otherwise use Pathname#realpath which respects symlinks.
+    else
+      begin
+        File.expand_path( Pathname.new( self ).realpath.to_s )
+      rescue Errno::ENOENT
+        File.expand_path( Pathname.new( self ).cleanpath.to_s )
+      end
+    end
+  end
+end

data/lib/simple_pid.rb

@@ -0,0 +1,84 @@
+# Much of this was extracted from Kenneth Kalmer's excellent
+# daemon-kit project on GitHub: http://github.com/kennethkalmer/daemon-kit
+
+require File.dirname(__FILE__) + '/core_ext'
+
+class SimplePid
+  def initialize(path)
+    @path = path.to_absolute_path
+  end
+  
+  def self.drop(path)
+    p = self.new(path)
+    if p.exists?
+      unless p.running?
+        p.cleanup
+        p.write!
+      end
+    else
+      p.write!
+    end
+  end
+  
+  def self.cleanup(path)
+    p = self.new(path)
+    if p.running?
+      return false
+    else
+      p.cleanup
+      return true
+    end
+  end
+  
+  def self.cleanup!(path)
+    p = self.new(path)
+    p.cleanup if p.exists?
+  end
+
+  def exists?
+    File.exists?(@path)
+  end
+
+  # Returns true if the process is running
+  def running?
+    return false unless self.exists?
+
+    # Check if process is in existence
+    # The simplest way to do this is to send signal '0'
+    # (which is a single system call) that doesn't actually
+    # send a signal
+    begin
+      Process.kill(0, self.pid)
+      return true
+    rescue Errno::ESRCH
+      return false
+    rescue ::Exception   # for example on EPERM (process exists but does not belong to us)
+      return true
+    #rescue Errno::EPERM
+    #  return false
+    end
+  end
+
+  # Return the pid contained in the pidfile, or nil
+  def pid
+    return nil unless self.exists?
+
+    File.open( @path ) { |f| return f.gets.to_i }
+  end
+
+  def ensure_stopped!
+    if self.running?
+      puts "Process already running with id #{self.pid}"
+      exit 1
+    end
+  end
+
+  def cleanup
+    File.delete(@path) rescue Errno::ENOENT
+  end
+  alias zap cleanup
+
+  def write!
+    File.open(@path, 'w') { |f| f.puts Process.pid }
+  end
+end

data/simple_pid.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_pid}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["watsonian"]
+  s.date = %q{2010-05-30}
+  s.description = %q{A simple, but complete library for managing pidfiles.}
+  s.email = %q{watsonian@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/core_ext.rb",
+     "lib/core_ext/string.rb",
+     "lib/simple_pid.rb",
+     "simple_pid.gemspec",
+     "test/helper.rb",
+     "test/test_simple_pid.rb"
+  ]
+  s.homepage = %q{http://github.com/watsonian/simple_pid}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple, but complete library for managing pidfiles.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_simple_pid.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simple_pid'
+
+class Test::Unit::TestCase
+end

data/test/test_simple_pid.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSimplePid < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: simple_pid
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- watsonian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A simple, but complete library for managing pidfiles.
+email: watsonian@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/core_ext.rb
+- lib/core_ext/string.rb
+- lib/simple_pid.rb
+- simple_pid.gemspec
+- test/helper.rb
+- test/test_simple_pid.rb
+has_rdoc: true
+homepage: http://github.com/watsonian/simple_pid
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple, but complete library for managing pidfiles.
+test_files: 
+- test/helper.rb
+- test/test_simple_pid.rb