graceful_shutdown 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8088de0ff9f291434ebffe3a11f66bb3017ac896
+  data.tar.gz: 018035600bc16b2c3674596d53ab0c61d32e30b7
+SHA512:
+  metadata.gz: f044965d5bbbea0cbfdadcbc88f3354dc607a65041e71bef9294749426ce19d23ef116d1d013436f9435e393afd98b3c4470886f54472d0cc38c46e15c6c73ac
+  data.tar.gz: 1ae42428f8e80cd517083ece8369923ecde8a4c1830c1b4f2ef71dc21c71d65a5f50775b88fc66c89aa4e9c82bdc303346533069ef34fed36d78302a8de11e22

data/lib/graceful_shutdown.rb

@@ -0,0 +1,64 @@
+# Catches +INT+ and +TERM+ and allows the task/program to finish execution
+# before handling the interrupt safely.
+#
+# Usage:
+#   WithGracefulShutdown do
+#     begin
+#       loop do
+#         print '.'
+#         sleep 0.5
+#       end
+#     rescue Shutdown => shutdown
+#       puts "\ngoodbye"
+#       shutdown.continue
+#     end
+#   end
+
+def WithGracefulShutdown(*signals, &block)
+  GracefulShutdown.new.handle_signals(*signals, &block)
+end
+
+class Shutdown < RuntimeError
+  def continue
+    raise self
+  end
+
+  def ignore
+    # No-Op, provided for clarity.
+  end
+end
+
+class GracefulShutdown
+  DEFAULT_SIGNALS = ['INT', 'TERM']
+  HANDLER = proc { raise Shutdown }
+
+  # Execute a block of code with signal handlers.
+  def handle_signals(*signals)
+    signals = DEFAULT_SIGNALS if signals.empty?
+
+    handlers = setup(signals)
+    yield if block_given?
+    teardown(handlers)
+  rescue Shutdown
+    teardown(handlers)
+    exit
+  end
+
+  private
+
+  # Setup signal traps, keeping track of the original handlers.
+  # NOTE If something else below this sets a trap, these traps will not
+  # be invoked.
+  def setup(signals)
+    signals.each_with_object({}) do |signal, handlers|
+      handlers[signal] = trap(signal, HANDLER)
+    end
+  end
+
+  # Restore original signal handlers.
+  def teardown(handlers)
+    handlers.each do |signal, handler|
+      trap(signal, handler)
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: graceful_shutdown
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Uruski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: You can use GracefulShutdown to catch signals and safely shutdown your
+  program.
+email: nerd@timuruski.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/graceful_shutdown.rb
+homepage: https://rubygemgem.org/graceful_shutdown
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A tiny helper for handling signals.
+test_files: []