sigurd 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87854913818982a8f760090652f1a5f23984d7e9b4c6636a9bd9504bc23a92eb
-  data.tar.gz: 186bbe65f6b7b8a4bc6fd8c6241673322db2379f5e84e5b3809b0550951b901b
+  metadata.gz: 75efcb785b0d995dae7843c66db4ad72955b2a7d3574af71c41aea634f5f8358
+  data.tar.gz: 4fb1c060a723a5d827fc76bdf23da681904d05ad458dca3653106557d8de4b17
 SHA512:
-  metadata.gz: 89db617898198aeefb795e3e5ea93d287b7d23bd39841af5a8ca264c9aff2aae4b717f609039ab0a41414de5c8d1fc4a1eb231797aa25f6f5c1ee46ba091f05f
-  data.tar.gz: 60eeb987aabb420dd01129ae6d8bd0811239283f964854763847094f7b7953b0250f47f97020c02859382b8d5d0d4369516644cb6a8a0b4f3768e2fd18593a97
+  metadata.gz: 4c933ceb70894580031de2cd35af38910c9fc896497c0f60e4e4a72d707663c68c80dc6f4c9739bc1cc342080ad6479f3e5855d541c3d3f37516ada1d19b9218
+  data.tar.gz: a5d0795a16a10342e75ee45e8ddf09e5fdbab3ec86d7b1c5e2500dda96e8889f70d5ec1e980c81f8d98df5a230dd906b5de25d8f84b57e3ebffdc9b6e99bb2e1

data/CHANGELOG.md

@@ -7,5 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+## [0.0.2] - 2020-11-25
+- Allow to access the executor from outside the signal handler.
+
 ## [0.0.1] - 2020-06-02
 - Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sigurd (0.0.1)
+    sigurd (0.0.2)
       concurrent-ruby (~> 1)
       exponential-backoff
 

data/README.md

@@ -1,2 +1,99 @@
 # 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.1'
+```
+
+# 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.
+
+## 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

@@ -35,7 +35,7 @@ module Sigurd
 
   private
 
-    attr_reader :reader, :writer, :signal_queue, :executor
+    attr_reader :reader, :writer, :signal_queue, :runner
 
     # https://stackoverflow.com/questions/29568298/run-code-when-signal-is-sent-but-do-not-trap-the-signal-in-ruby
     def prepend_handler(signal)

data/lib/sigurd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sigurd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Orner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-11-25 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: []
@@ -165,11 +165,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 +186,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: