revenant 0.0.2 → 0.0.3

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Wilson Bilkovich
+
+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

@@ -0,0 +1,67 @@
+= revenant
+
+* http://github.com/wilson/revenant
+
+== DESCRIPTION:
+
+Death is only a beginning. Failure will not be forgotten.
+
+== FEATURES:
+
+* Dead simple distributed locking
+* Start as many masters as you want, only one will execute at a time
+* Currently supports MySQL GET_LOCK()
+
+== SYNOPSIS:
+
+Have some work that needs to be done without worrying about mutual exclusion?
+Lots of scheduled jobs to coordinate that must not interfere?
+Want that work to keep happening when servers die?
+
+#!/usr/bin/env ruby
+require 'revenant'
+task = revenant(:example)
+task.on_load { require 'config/environment.rb' }
+task.on_exit { something_to_do_last }
+# start working and exit the parent process:
+task.run { some_work_protected_by_mysql_lock }
+
+Want to run without a distributed lock?
+task.lock_function { true }
+Want your code to sleep forever?
+task.lock_function { false }
+
+See the 'example' directory for more.
+
+== REQUIREMENTS:
+
+* mysql (not a dependency, but you will probably want it)
+
+== INSTALL:
+
+* gem install revenant
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Wilson Bilkovich
+
+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/example/daemon

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+# Load a copy of revenant relative to this dir.
+# In real code, you could use Bundler or RubyGems or similar.
+require 'rubygems'
+$: << File.expand_path("../../lib", __FILE__)
+require 'revenant'
+
+# Make a new task identified as 'example'.
+# Yields that task to the block in case you want to reuse configuration steps.
+# task.daemon = true is set by default. Set it to false if you want to
+# run in the foreground without forking.
+task = revenant(:example) do |t|
+  # Set a couple of options that are only used in daemon mode.
+  t.log_file = "/tmp/example.log"
+
+  # One instance of this per box:
+  t.pid_file = "/tmp/example.pid"
+  # or you could generate a different pid file for every invocation:
+  # t.pid_file = "/tmp/example-#{$$}.pid"
+  # all such processes that share a name would share a lock.
+
+  # assume we never need to check for a lock once it has been acquired
+  # t.relock_every = nil
+end
+
+# Runs after a fork
+task.on_load do
+  # If we were using ActiveRecord here, the connection object
+  # would automatically be determined. Let's connect by hand instead.
+  require 'mysql'
+  conn = Mysql.connect(nil, "root", nil, nil, nil, "/tmp/mysql.sock")
+  Revenant::MySQL.connection = conn
+
+  puts "*** #{task.script} forked into pid #{$$}"
+end
+
+task.on_exit do
+  puts "[#{$$}] running your cleanup code"
+end
+
+# While we have the lock, do some work.
+count = 0
+task.run do
+  count += 1
+  puts "[#{$$}] work loops: #{count}"
+end
+
+# In daemon mode, control will not reach this point.
+# With: task.daemon = false
+# we would continue executing code here after the task was told to
+# stop.
+#
+# Generally you should use 'on_exit' instead of just expecting
+# code after the 'run' block to execute.
+
+puts "[#{$$}] documentation is out of date"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: revenant
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2010-06-06 00:00:00.000000000 Z
+date: 2014-04-20 00:00:00.000000000 Z
 dependencies: []
 description: A framework for building reliable distributed workers.
 email: wilson@supremetyrant.com
@@ -17,12 +17,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README
 - lib/locks/mysql.rb
 - lib/plugins/daemon.rb
 - lib/revenant/manager.rb
 - lib/revenant/pid.rb
 - lib/revenant/task.rb
 - lib/revenant.rb
+- example/daemon
 homepage: http://github.com/wilson/revenant
 licenses: []
 post_install_message: 
@@ -43,8 +46,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.7
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Distributed daemons that just will not die.
 test_files: []