sigurd 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87854913818982a8f760090652f1a5f23984d7e9b4c6636a9bd9504bc23a92eb
-  data.tar.gz: 186bbe65f6b7b8a4bc6fd8c6241673322db2379f5e84e5b3809b0550951b901b
+  metadata.gz: 78b91ee76ef004d00edc84bba38adfdc5c53987574ab27f4843a555553d5753a
+  data.tar.gz: 786a1fe84d80e7b37f920c1b977e6a2957cd6b174bb86c34a82eb0785e7760db
 SHA512:
-  metadata.gz: 89db617898198aeefb795e3e5ea93d287b7d23bd39841af5a8ca264c9aff2aae4b717f609039ab0a41414de5c8d1fc4a1eb231797aa25f6f5c1ee46ba091f05f
-  data.tar.gz: 60eeb987aabb420dd01129ae6d8bd0811239283f964854763847094f7b7953b0250f47f97020c02859382b8d5d0d4369516644cb6a8a0b4f3768e2fd18593a97
+  metadata.gz: 03edd2b5c68e976c9b3b0de4395dc448b8b95c28939547e6d2eb6ebe1376bae177e6da7de92e8f5aed99a6b51bc81b9ba06b32a263ad3d65252b81b23544f714
+  data.tar.gz: 54cea634f6d9d674816f6553506cbff6f018fb10298a685315bd512f68834ac83abe1d139549e335d5dffdbb398decd9edf4ceecbb8c1ab88946114b517876be

data/.gitignore

@@ -37,3 +37,5 @@
 .rvmrc
 
 .idea
+
+Gemfile.lock

data/CHANGELOG.md

@@ -7,5 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+## [0.1.0] - 2022-07-20
+- Added `exit_on_signal` to exit instead of raising a `SignalException`. Fixes #1.
+
+## [0.0.3] - 2020-11-25
+- Allow to access the executor from outside the signal handler.
+- Use `require "sigurd"` without having to require files individually.
+
 ## [0.0.1] - 2020-06-02
 - Initial release.

data/README.md

@@ -1,2 +1,106 @@
 # sigurd
-Small gem to manage executing looping processes and signal handling
+Small gem to manage executing looping processes and signal handling.
+
+<p align="center">
+  <a href="https://badge.fury.io/rb/sigurd"><img src="https://badge.fury.io/rb/sigurd.svg" alt="Gem Version" height="18"></a>
+  <a href="https://codeclimate.com/github/flipp-oss/sigurd/maintainability"><img src="https://api.codeclimate.com/v1/badges/a5fc45a193abadc4e45b/maintainability" /></a>
+</p>
+
+# Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'sigurd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sigurd
+
+# Versioning
+
+We use a version of semver for this gem. Any change in previous behavior 
+(something works differently or something old no longer works)
+is denoted with a bump in the minor version (0.4 -> 0.5). Patch versions 
+are for bugfixes or new functionality which does not affect existing code. You
+should be locking your Gemfile to the minor version:
+
+```ruby
+gem 'sigurd', '0.0.3'
+```
+
+# Usage
+
+Sigurd exposes two classes for use with a third class. The ideas is as follows:
+
+* You have any object which responds to the `start` and `stop` methods.
+  This object is called a "Runner". When the `stop` method is called,
+  the runner should gracefully shut down.
+* You create an `Executor` class - this manages a thread pool for a
+  list of runners.
+* You create a `SignalHandler` which is the topmost object. This will
+  handle the signals sent by the system and gracefully forward the
+  requests. You pass the executor into the SignalHandler.
+* Finally, you call `start` on the `SignalHandler` to begin the execution.
+
+Sample code:
+
+```ruby
+class TestRunner
+
+def start
+  loop do
+    break if @signal_to_stop
+    # do some logic here
+  end
+end
+
+  def stop
+    @signal_to_stop = true
+  end
+end
+
+runners = (1..2).map { TestRunner.new }
+executor = Sigurd::Executor.new(runners, sleep_seconds: 5, logger: Logger.new(STDOUT))
+Sigurd::SignalHandler.new(executor).run!
+```
+
+If you have only a single runner, you can pass it into the `SignalHandler`
+directly, without using an `Executor`:
+
+```ruby
+  Sigurd::SignalHandler.new(runner).run!
+```
+
+By default, if any of your runners fails, Sigurd will use an exponential
+backoff to wait before restarting it. You can instead use the `sleep_seconds`
+setting to always sleep a fixed amount of time before retrying. There
+is no limit to retries.
+
+## Configuration
+
+By default, sigurd will exit the process when a TERM, KILL or QUIT signal is received. You can change this 
+behavior to instead raise the original `SignalException` by setting
+
+    Sigurd.exit_on_signal = true
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/flipp-oss/sigurd .
+
+### Linting
+
+Sigurd uses Rubocop to lint the code. Please run Rubocop on your code 
+before submitting a PR.
+
+---
+<p align="center">
+  Sponsored by<br/>
+  <a href="https://corp.flipp.com/">
+    <img src="support/flipp-logo.png" title="Flipp logo" style="border:none;"/>
+  </a>
+</p>

data/lib/sigurd/signal_handler.rb

@@ -5,6 +5,7 @@ module Sigurd
   # signals to ask them to stop nicely.
   class SignalHandler
     SIGNALS = %i(INT TERM QUIT).freeze
+    attr_reader :runner
 
     # Takes any object that responds to the `start` and `stop` methods.
     # @param runner[#start, #stop]
@@ -20,10 +21,15 @@ module Sigurd
       @runner.start
 
       loop do
-        case signal_queue.pop
+        signal = signal_queue.pop
+        case signal
         when *SIGNALS
           @runner.stop
-          break
+          if Sigurd.exit_on_signal
+            exit 0
+          else
+            raise(SignalException, signal)
+          end
         else
           ready = IO.select([reader, writer])
 
@@ -35,14 +41,13 @@ module Sigurd
 
   private
 
-    attr_reader :reader, :writer, :signal_queue, :executor
+    attr_reader :reader, :writer, :signal_queue
 
     # https://stackoverflow.com/questions/29568298/run-code-when-signal-is-sent-but-do-not-trap-the-signal-in-ruby
     def prepend_handler(signal)
       previous = Signal.trap(signal) do
-        previous = -> { raise SignalException, signal } unless previous.respond_to?(:call)
         yield
-        previous.call
+        previous.call if previous&.respond_to?(:call)
       end
     end
 

data/lib/sigurd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sigurd
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/sigurd.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
 require 'sigurd/version'
+require 'sigurd/executor'
+require 'sigurd/signal_handler'
 
 # :nodoc:
 module Sigurd
+
+  class << self
+    attr_accessor :exit_on_signal
+  end
+
 end

data/spec/signal_handler_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'sigurd/signal_handler'
+require 'sigurd'
 
 RSpec.describe Sigurd::SignalHandler do
   describe '#run!' do
@@ -11,8 +11,22 @@ RSpec.describe Sigurd::SignalHandler do
       expect(runner).to receive(:stop)
 
       signal_handler = described_class.new(runner)
-      signal_handler.send(:unblock, described_class::SIGNALS.first)
-      signal_handler.run!
+      Thread.new { sleep 1; Process.kill('TERM', 0) }
+      expect { signal_handler.run! }.to raise_error(SignalException)
     end
+
+    context 'when exit_on_signal is true' do
+      it 'should raise a SignalException' do
+        Sigurd.exit_on_signal = true
+        runner = TestRunners::TestRunner.new
+        expect(runner).to receive(:start)
+        expect(runner).to receive(:stop)
+
+        signal_handler = described_class.new(runner)
+        Thread.new { sleep 1; Process.kill('TERM', 0) }
+        expect { signal_handler.run! }.to raise_error(SystemExit)
+      end
+    end
+
   end
 end

data/spec/spec_helper.rb

@@ -55,4 +55,8 @@ RSpec.configure do |config|
     mocks.yield_receiver_to_any_instance_implementation_blocks = true
     mocks.verify_partial_doubles = true
   end
+
+  config.before(:each) do
+    Sigurd.exit_on_signal = false
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sigurd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Orner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.27'
-description: 
+description:
 email:
 - daniel.orner@flipp.com
 executables: []
@@ -153,7 +153,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.md
 - README.md
@@ -165,11 +164,12 @@ files:
 - spec/executor_spec.rb
 - spec/signal_handler_spec.rb
 - spec/spec_helper.rb
+- support/flipp-logo.png
 homepage: ''
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Small gem to manage executing looping processes and signal handling.
 test_files:

data/Gemfile.lock

@@ -1,103 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sigurd (0.0.1)
-      concurrent-ruby (~> 1)
-      exponential-backoff
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    exponential-backoff (0.0.4)
-    ffi (1.13.0)
-    formatador (0.2.5)
-    guard (2.16.2)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    guard-rubocop (1.3.0)
-      guard (~> 2.0)
-      rubocop (~> 0.20)
-    listen (3.2.1)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.5)
-    method_source (1.0.0)
-    nenv (0.3.0)
-    notiffany (0.1.3)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.0.0)
-    rb-fsevent (0.10.4)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    regexp_parser (1.7.0)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rspec_junit_formatter (0.4.1)
-      rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.85.0)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.0.3)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    rubocop-rspec (1.39.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    shellany (0.0.1)
-    thor (1.0.1)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  guard (~> 2)
-  guard-rspec (~> 4)
-  guard-rubocop (~> 1)
-  rspec (~> 3)
-  rspec_junit_formatter (~> 0.3)
-  rubocop (~> 0.72)
-  rubocop-rspec (~> 1.27)
-  sigurd!
-
-BUNDLED WITH
-   2.1.2