lockfile 1.1.0 → 1.3.0

metadata

@@ -1,19 +1,17 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: "0.8"
+rubygems_version: 0.8.11
 specification_version: 1
 name: lockfile
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2004-11-01
-summary: A ruby library for creating NFS safe lockfiles
+  version: 1.3.0
+date: 2005-11-03 00:00:00.000000 -07:00
+summary: lockfile
 require_paths: 
-  - "."
   - lib
-author: "-a"
-email: Ara.T.Howard@noaa.gov
-homepage: http://www.codeforpeople.com/lib/ruby/lockfile/
+email: ara.t.howard@noaa.gov
+homepage: http://codeforpeople.com/lib/ruby/lockfile/
 rubyforge_project: 
-description: A ruby library for creating NFS safe lockfiles
+description: 
 autorequire: lockfile
 default_executable: 
 bindir: bin
@@ -26,34 +24,19 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
         version: 0.0.0
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+  - Ara T. Howard
 files: 
-  - install.rb
-  - VERSION
-  - BUGS
-  - lib
-  - bin
-  - samples
-  - doc
-  - lockfile.gemspec
-  - lockfile-1.1.0.gem
-  - README
   - lib/lockfile.rb
-  - lib/lockfile-1.1.0.rb
+  - lib/lockfile-1.3.0.rb
   - bin/rlock
-  - samples/a.rb
-  - samples/nfsstore.rb
-  - samples/test.db
-  - samples/test.db~
-  - doc/rlock.help
+  - bin/rlock-1.3.0
 test_files: []
-rdoc_options: 
-  - "--main"
-  - README
-extra_rdoc_files: 
-  - README
-  - doc/rlock.help
-executables: 
-  - rlock
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
 extensions: []
 requirements: []
 dependencies: []

data/BUGS

@@ -1,3 +0,0 @@
-none known
-
-email Ara.T.Howard@noaa.gov with any reports please!

data/README

@@ -1,165 +0,0 @@
-= URLS
-
-http://raa.ruby-lang.org/project/lockfile/
-http://www.codeforpeople.com/lib/ruby/lockfile/
-
-= SYNOPSIS
-
-lib/lockfile.rb : a ruby library for creating NFS safe lockfiles
-
-bin/rlock : ruby command line tool which uses this library to create
-          lockfiles. run 'rlock -h' for more info
-
-= INSTALL
-
-  sudo ruby install.rb
-
-
-= BASIC ALGORITHIM
-
-  * create a globally uniq filename in the same filesystem as the desired
-    lockfile - this can be nfs mounted
-
-  * link(2) this file to the desired lockfile, ignore all errors
-
-  * stat the uniq filename and desired lockfile to determine is they are the
-    same, use only stat.rdev and stat.ino - ignore stat.nlink as NFS can cause
-    this report incorrect values 
-
-  * iff same, you have lock.  either return or run optional code block with
-    optional refresher thread keeping lockfile fresh during execution of code
-    block, ensuring that the lockfile is removed..
-
-  * iff not same try again a few times in rapid succession (poll), then, iff
-    this fails, sleep using incremental backoff time.  optionally remove
-    lockfile if it is older than a certain time, timeout if more than a certain
-    amount of time has passed attempting to lock file.
-
-
-= BASIC USAGE
-
-1)
-    lockfile = Lockfile.new 'file.lock'
-    begin
-      lockfile.lock
-      p 42
-    ensure
-      lockfile.unlock
-    end
-
-
-2)
-    require 'pstore'           # which is NOT nfs safe on it's own
-
-    opts = {                   # the keys can be symbols or strings
-
-      :retries        => nil,  # we will try forever to aquire the lock
-
-      :sleep_inc      => 2,    # we will sleep 2 seconds longer than the
-                               # previous sleep after each retry, cycling from
-                               # min_sleep upto max_sleep downto min_sleep upto
-                               # max_sleep, etc., etc.
-
-      :min_sleep      => 2,    # we will never sleep less than 2 seconds
-
-      :max_sleep      => 32,   # we will never sleep longer than 32 seconds
-
-      :max_age        => 1024, # we will blow away any files found to be older
-                               # than this (lockfile.thief? #=> true)
-
-      :suspend        => 64,   # iff we steal the lock from someone else - wait
-                               # this long to give them a chance to realize it
-
-      :refresh        => 8,    # we will spawn a bg thread that touches file
-                               # every 8 sec.  this thread also causes a
-                               # StolenLockError to be thrown if the lock
-                               # disappears from under us - note that the
-                               # 'detection' rate is limited to the refresh
-                               # interval - this is a race condition
-
-      :timeout        => nil,  # we will wait forever 
-
-      :poll_retries   => 16,   # the initial attempt to grab a lock is done in a
-                               # polling fashion, this number controls how many
-                               # times this is done - the total polling attempts
-                               # are considered ONE actual attempt (see retries
-                               # above)
-
-      :poll_max_sleep => 0.08, # when polling a very brief sleep is issued
-                               # between attempts, this is the upper limit of
-                               # that sleep timeout 
-
-      :debug => true,          # trace execution step on stdout
-    }
-
-    pstore = PStore.new 'file.db'
-    lockfile = Lockfile.new 'file.db.lock', opts 
-    lockfile.lock do
-      pstore.transaction do
-        pstore[:last_update_time] = Time.now
-      end
-    end
-
-3) same as 1 above - Lockfile.new takes a block and ensures unlock is called 
-
-    Lockfile.new('file.lock') do
-      p 42
-    end
-
-4) watch locking algorithim in action
-
-    Lockfile.debug = true
-    Lockfile.new('file.lock') do
-      p 42
-    end
-
-you can also set debugging via the ENV var LOCKFILE_DEBUG, eg.
-
-    ~ > LOCKFILE_DEBUG=true rlock lockfile
-
-= SAMPLES
-
-  * see samples/a.rb
-  * see samples/nfsstore.rb
-  * see bin/rlock
-
-= AUTHOR
-
--a
-
-= EMAIL
-
-Ara.T.Howard@noaa.gov
-
-= BUGS
-
-> 1
-
-further notifications to email above
-
-= HISTORY
-
-  1.0.1:
-    - fixed bugette in sleep cycle where repeated locks with same lockfile would
-      not reset the cycle at the start of each lock
-  1.0.0:
-    - allow rertries to be nil, meaning to try forever
-    - default timeout is now nil - never timeout
-    - default refresh is now 8
-    - fixed bug where refresher thread was not actually touching lockfile! (ouch)
-    - added cycle method to timeouts
-        1-2-3-2-1-2-3-1...
-      pattern is constructed using min_sleep, sleep_inc, max_sleep
-  0.3.0:
-    - removed use of yaml in favour of hand parsing the lockfile contents, the
-      file as so small it just wasn't worth and i have had one core dump when yaml
-      failed to parse a (corrupt) file
-  0.2.0:
-    - added an initial polling style attempt to grab lock before entering normal
-      sleep/retry loop.  this has really helped performance when lock is under
-      heavy contention: i see almost no sleeping done by any of in the interested
-      processes
-  0.1.0:
-    - added ability of Lockfile.new to accept a block
-  0.0.0:
-    - initial version

data/VERSION

@@ -1 +0,0 @@
-1.1.0

data/doc/rlock.help

@@ -1,88 +0,0 @@
-= NAME
-rlock v0.0.0
-
-= SYNOPSIS
-    rlock [options]+ file.lock [program [-- [options]+] [args]+]
-
-= DESCRIPTTION
-rlock creates NFS resistent lockfiles
-
-= ENVIRONMENT
-LOCKFILE_DEBUG=1 will show internal actions of the library
-
-= DIAGNOSTICS
-    success => $? == 0
-    failure => $? != 0
-
-= AUTHOR
-ara.t.howard@noaa.gov
-
-= BUGS
-> 1
-
-= OPTIONS
-
-    -r, --retries=n
-    -a, --max_age=n
-    -s, --sleep_inc=n
-    -p, --max_sleep=n
-    -u, --suspend=n
-    -t, --timeout=n
-    -f, --refresh=n
-    -d, --debug
-    -v=0-4|debug|info|warn|error|fatal
-        --verbosity
-    -l, --log=path
-        --log_age=log_age
-        --log_size=log_size
-    -h, --help
-
-= EXAMPLES
-
-0) simple usage - just create a file.lock in an atomic fashion 
-
-    ~ > rlock file.lock
-
-1) safe usage - create a file.lock, execute a command, and remove file.lock
-
-    ~ > rlock file.lock ls file.lock
-
-2) same as above, but logging verbose messages 
-
-    ~ > rlock -v4 file.lock ls file.lock
-
-3) same as above, but logging verbose messages and showing actions internal to 
-lockfile library
-
-    ~ > rlock -v4 -d file.lock ls file.lock
-
-4) same as above
-
-    ~ > LOCKFILE_DEBUG=1 rlock -v4 file.lock ls file.lock
-
-5) same as above
-
-    ~ > export LOCKFILE_DEBUG=1
-    ~ > rlock -v4 file.lock ls file.lock
-
-6) note that you need to tell the option parser to stop parsing rlock options if 
-you intend to pass options to 'program' 
-
-    ~ > rlock -v4 -d file.lock -- ls -ltar file.lock
-
-without the '--' rlock would consume the '-ltar' options, parsing it
-as the logfile name 'tar'
-
-7) lock file.lock and exec 'program' - remove the file.lock if it is older than 4242 seconds
-
-    ~ > rlock --max_age=4242 file.lock program 
-
-8) lock file.lock and exec 'program' - remove the file.lock if it is older
-than 4242 seconds, also spawn a background thread which will refresh
-file.lock every 8 seonds will 'program' is executing
-
-    ~ > rlock --max_age=4242 --refresh=8 file.lock program 
-
-9) same as above, but fail if file.lock cannot be obtained within 1 minute
-
-    ~ > rlock --max_age=4242 --refresh=8 --timeout=60 file.lock program 

data/install.rb

@@ -1,143 +0,0 @@
-#!/usr/bin/env ruby
-require 'rbconfig'
-require 'find'
-require 'ftools'
-require 'tempfile'
-include Config
-
-LIBDIR      = "lib"
-LIBDIR_MODE = 0644
-
-BINDIR      = "bin"
-BINDIR_MODE = 0755
-
-
-$srcdir            = CONFIG["srcdir"]
-$version           = CONFIG["MAJOR"]+"."+CONFIG["MINOR"]
-$libdir            = File.join(CONFIG["libdir"], "ruby", $version)
-$archdir           = File.join($libdir, CONFIG["arch"])
-$site_libdir       = $:.find {|x| x =~ /site_ruby$/}
-$bindir            = CONFIG["bindir"]
-$ruby_install_name = CONFIG['ruby_install_name'] || CONFIG['RUBY_INSTALL_NAME']
-$ruby              = File.join($bindir, $ruby_install_name || 'ruby')
-
-if !$site_libdir
-  $site_libdir = File.join($libdir, "site_ruby")
-elsif $site_libdir !~ %r/#{Regexp.quote($version)}/
-  $site_libdir = File.join($site_libdir, $version)
-end
-
-def install_rb(srcdir=nil, destdir=nil, mode=nil, bin=nil)
-#{{{
-  path   = []
-  dir    = []
-  Find.find(srcdir) do |f|
-    next unless FileTest.file?(f)
-    next if (f = f[srcdir.length+1..-1]) == nil
-    next if (/CVS$/ =~ File.dirname(f))
-    path.push f
-    dir |= [File.dirname(f)]
-  end
-  for f in dir
-    next if f == "."
-    next if f == "CVS"
-    File::makedirs(File.join(destdir, f))
-  end
-  for f in path
-    next if (/\~$/ =~ f)
-    next if (/^\./ =~ File.basename(f))
-    unless bin
-      File::install(File.join(srcdir, f), File.join(destdir, f), mode, true)
-    else
-      from = File.join(srcdir, f)
-      to = File.join(destdir, f)
-      shebangify(from) do |sf|
-        $deferr.print from, " -> ", File::catname(from, to), "\n"
-        $deferr.printf "chmod %04o %s\n", mode, to 
-        File::install(sf, to, mode, false)
-      end
-    end
-  end
-#}}}
-end
-def shebangify f
-#{{{
-  open(f) do |fd|
-    buf = fd.read 42 
-    if buf =~ %r/^\s*#\s*!.*ruby/o
-      ftmp = Tempfile::new("#{ $$ }_#{ File::basename(f) }")
-      begin
-        fd.rewind
-        ftmp.puts "#!#{ $ruby  }"
-        while((buf = fd.read(8192)))
-          ftmp.write buf
-        end
-        ftmp.close
-        yield ftmp.path
-      ensure
-        ftmp.close!
-      end
-    else
-      yield f
-    end
-  end
-#}}}
-end
-def ARGV.switch
-#{{{
-  return nil if self.empty?
-  arg = self.shift
-  return nil if arg == '--'
-  if arg =~ /^-(.)(.*)/
-    return arg if $1 == '-'
-    raise 'unknown switch "-"' if $2.index('-')
-    self.unshift "-#{$2}" if $2.size > 0
-    "-#{$1}"
-  else
-    self.unshift arg
-    nil
-  end
-#}}}
-end
-def ARGV.req_arg
-#{{{
-  self.shift || raise('missing argument')
-#}}}
-end
-
-
-#
-# main program
-#
-
-libdir = $site_libdir
-bindir = $bindir
-
-begin
-  while switch = ARGV.switch
-    case switch
-    when '-d', '--destdir'
-      libdir = ARGV.req_arg
-    when '-l', '--libdir'
-      libdir = ARGV.req_arg
-    when '-b', '--bindir'
-      bindir = ARGV.req_arg
-    when '-r', '--ruby'
-      $ruby = ARGV.req_arg
-    else
-      raise "unknown switch #{switch.dump}"
-    end
-  end
-rescue
-  STDERR.puts $!.to_s
-  STDERR.puts File.basename($0) + 
-    " -d <destdir>" +
-    " -l <libdir>" +
-    " -b <bindir>"
-    " -r <ruby>"
-  exit 1
-end    
-
-install_rb(LIBDIR, libdir, LIBDIR_MODE)
-install_rb(BINDIR, bindir, BINDIR_MODE, bin=true)
-