pidfile 0.2.0

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Samuel Mullen
+ 
+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,46 @@
+= PidFile
+
+http://github.com/samullen/pidfile
+
+A basic library for creating lockfiles for processes
+
+This library works with Ruby 1.8 and 1.9 and is licensed under the MIT License.
+
+== Installation
+
+The pidfile gem is hosted on RubyGems.org (http://rubygems.org). This
+requires that you have http://rubygems.org in your gem sources.
+
+Install the pidfile gem: 
+
+  sudo gem install pidfile
+
+== Gettings Started
+
+The pidfile gem is easy to use and only requires the addition of a single line 
+of code; something like this:
+
+  pf = PidFile.new unless PidFile.running?
+
+Of course there is other functionality, but if you are just wanting to keep a
+process from running more than once, this is all you need.
+
+
+=== Arguments
+
+PidFile creates file to store the process ID (PID).  By default, process ID
+(PID) files are created in /tmp upon instantiation and are given the same name
+as the calling script with a .pid extension. Process ID files are removed when
+the creating program exits.
+
+Each argument, :pidfile and :piddir, can be changed upon instantiation of the 
+class. 
+
+==== Example:
+
+  PidFile.new(:piddir => '/var/lock', :pidfile => "awesome.pid")
+
+== Copyright
+
+Copyright(c) 2010 Samuel Mullen (samullen). See LICENSE for details
+

data/Rakefile

@@ -0,0 +1,51 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require 'rubygems'
+require 'lib/pidfile'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+ 
+lib_dir = File.expand_path('lib')
+test_dir = File.expand_path('test')
+
+gem_spec = Gem::Specification.new do |s|
+  s.name = "pidfile"
+  s.version = PidFile::VERSION
+  s.authors = ["Samuel Mullen"]
+  s.email = "samullen@gmail.com"
+  s.homepage = "http://github.com/samullen/pidfile"
+  s.summary = "A basic library for creating lockfiles for processes"
+  s.authors = ["Samuel Mullen"]
+  s.email = "samullen@gmail.com"
+  s.test_files = Dir['test/**/*.rb']
+  s.description = false
+  s.files = [
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+#     "examples/functional.rb",
+#     "examples/objectoriented.rb",
+    "lib/pidfile.rb",
+  ] + s.test_files
+end
+
+Rake::TestTask.new(:test) do |test|
+  test.libs = [lib_dir, test_dir]
+  test.pattern = 'test/**/*rb'
+  test.verbose = true
+end
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end
+
+desc "Install the gem locally"
+task :install => [:test, :gem] do
+  sh %{gem install pkg/#{gem_spec.name}-#{gem_spec.version}}
+end
+
+desc "Remove the pkg directory and all of its contents."
+task :clean => :clobber_package
+
+task :default => [:test, :gem]

data/lib/pidfile.rb

@@ -0,0 +1,124 @@
+class PidFile
+  attr_accessor :pidfile, :piddir
+
+  VERSION = '0.2.0'
+
+  DEFAULT_OPTIONS = {
+    :pidfile => File.basename($0, File.extname($0)) + ".pid",
+    :piddir => '/tmp',
+  }
+
+  def initialize(*args)
+    opts = {}
+
+    case
+    when args.length == 0 then
+    when args.length == 1 && args[0].class == Hash then
+      arg = args.shift
+
+      if arg.class == Hash
+        opts = arg
+      end
+    else
+      raise ArgumentError, "new() expects hash or hashref as argument"
+    end
+
+    opts = DEFAULT_OPTIONS.merge opts
+
+    @piddir     = opts[:piddir]
+    @pidfile    = opts[:pidfile]
+    @fh         = nil
+
+    create_pidfile
+
+    at_exit { release }
+  end
+
+  # Returns the fullpath to the file containing the process ID (PID)
+  def pidpath
+    File.join(@piddir, @pidfile)
+  end
+
+  # Returns the PID, if any, of the instantiating process
+  def pid
+    return @pid unless @pid.nil?
+
+    if self.pidfile_exists?
+      @pid = open(self.pidpath, 'r').read.to_i
+    else
+      @pid = nil
+    end
+  end
+
+  # Boolean stating whether this process is alive and running
+  def alive?
+    return false unless self.pid && (self.pid == Process.pid)
+
+    self.class.process_exists?(self.pid)
+  end
+
+  # does the pidfile exist?
+  def pidfile_exists?
+    self.class.pidfile_exists?(pidpath)
+  end
+
+  # unlock and remove the pidfile. Sets pid to nil
+  def release
+    unless @fh.nil?
+      @fh.flock(File::LOCK_UN)
+      remove_pidfile
+    end
+    @pid = nil
+  end
+
+  # returns the modification time of the pidfile
+  def locktime
+    File.mtime(self.pidpath)
+  end
+
+  # class method for determining the existence of pidfile
+  def self.pidfile_exists?(path=nil)
+    path ||= File.join(DEFAULT_OPTIONS[:piddir], DEFAULT_OPTIONS[:pidfile])
+
+    File.exists?(path)
+  end
+
+  # boolean stating whether the calling program is already running
+  def self.running?(path=nil)
+    path ||= File.join(DEFAULT_OPTIONS[:piddir], DEFAULT_OPTIONS[:pidfile])
+
+    if pidfile_exists?(path)
+      pid = open(path, 'r').read.to_i
+    else
+      pid = nil
+    end
+
+    return false unless pid && (pid != Process.pid)
+
+    process_exists?(pid)
+  end
+
+private
+
+  # Writes the process ID to the pidfile and defines @pid as such
+  def create_pidfile
+    @fh = open(self.pidpath, "w")
+    @fh.flock(File::LOCK_EX | File::LOCK_NB) || raise
+    @pid = Process.pid
+    @fh.puts @pid
+  end
+
+  # removes the pidfile. 
+  def remove_pidfile
+    File.unlink(self.pidpath) if self.pidfile_exists?
+  end
+
+  def self.process_exists?(process_id)
+    begin
+      Process.kill(0, process_id)
+      true
+    rescue Errno::ESRCH, TypeError # "PID is NOT running or is zombied
+      false
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: pidfile
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Samuel Mullen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-14 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: "false"
+email: samullen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/pidfile.rb
+has_rdoc: true
+homepage: http://github.com/samullen/pidfile
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A basic library for creating lockfiles for processes
+test_files: []
+