mimi-signal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0eaf7ad67ee461b781fc1f1dad8211b55bfa8402
+  data.tar.gz: 32d0c1354c9965c8341b2dd35eaac502d306ed59
+SHA512:
+  metadata.gz: 676e87a4d4c36804ce7bb67108956f4eab5767952b3cb96951e10c93394e35cd7a1690968fbfa565220029d19f517b1e83ced712ae5d74dc06da507c2801e55e
+  data.tar.gz: 35fb4e4a1c79b0e54d46fbb0153d1cadc92b8cb228aaf32d109c860037faaf7e88c93563079287c8ce334131feddc848850db3502b0cbb4cd4ae64f703809e24

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at alex@kukushk.in. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mimi-signal.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Kukushkin
+
+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.md

@@ -0,0 +1,97 @@
+# Mimi::Signal
+
+Asynchronous processing of trapped signals, solving the limitations of the
+[Ruby trap context](https://www.google.de/search?q=ruby+trap+context).
+
+#### Problem:
+```ruby
+logger = Logger.new(STDOUT)
+
+trap('INT') do
+  logger.warn 'Interrupted' # => (ThreadError) can't be called from trap context
+  # shutdown gracefully ... never executed :(
+end
+```
+
+#### Solution:
+```ruby
+require 'mimi/signal'
+
+logger = Logger.new(STDOUT)
+
+Mimi::Signal.trap('INT') do
+  logger.warn 'Interrupted' # works!
+  # shutdown gracefully ...
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mimi-signal'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mimi-signal
+
+## Usage
+
+Setting up a signal handler:
+```ruby
+require 'mimi/signal'
+
+Mimi::Signal.trap('INT') do
+  # do my stuff
+end
+```
+
+Setting up multiple signal handlers:
+```ruby
+require 'mimi/signal'
+
+Mimi::Signal.trap('INT', 'TERM') do
+  # this will be invoked on SIGINT or SIGTERM
+end
+
+Mimi::Signal.trap('INT') do
+  # this will be invoked on SIGINT in addition to the handler above
+end
+```
+
+Stopping the signal handlers, untrapping the previously trapped signals:
+```ruby
+require 'mimi/signal'
+
+Mimi::Signal.trap('TERM') do
+  # something
+end
+
+Mimi::Signal.trap('INT') do
+  # something
+end
+
+Mimi::Signal.stop # untraps INT and TERM, reverting the handlers to the original handlers
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kukushkin/mimi-signal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mimi/signal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mimi/signal/version.rb

@@ -0,0 +1,5 @@
+module Mimi
+  class Signal
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/mimi/signal.rb

@@ -0,0 +1,84 @@
+require 'mimi/core'
+
+# Asynchronous processing of trapped signals
+#
+# Example:
+#   logger = Logger.new(STDOUT)
+#
+#   trap('INT') do
+#     logger.warn 'Interrupted' # => (ThreadError) can't be called from trap context
+#     # shutdown gracefully ...
+#   end
+#
+# Solution:
+#   logger = Logger.new(STDOUT)
+#
+#   Mimi::Signal.trap('INT') do
+#     logger.warn 'Interrupted' # works!
+#     # shutdown gracefully ...
+#   end
+#
+#
+module Mimi
+  class Signal
+    attr_reader :signal
+
+    private
+
+    def initialize(signal, &block)
+      self.class.handlers[signal.to_sym] ||= { old_trap: nil, blocks: [] }
+      self.class.handlers[signal.to_sym][:blocks].push(block)
+      self.class.handlers[signal.to_sym][:old_trap] ||=
+        Kernel.trap(signal) do
+          puts "#{self} got signal #{signal}"
+          self.class.queue << signal.to_sym
+        end
+      self.class.start
+    end
+
+    # Traps a signal (or multiple signals) and installs the signal handler
+    #
+    # @param [Array<String,Symbol>] signals
+    #
+    def self.trap(*signals, &block)
+      signals.each { |s| new(s, &block) }
+    end
+
+    # Starts the background thread which monitors queued signals.
+    # Invoked implicitly when any signal handler is installed
+    #
+    def self.start
+      return if @thread
+      @thread = Thread.new do
+        loop do
+          signal = queue.pop # it's blocking
+          handlers[signal][:blocks].each(&:call) if handlers[signal]
+        end
+      end
+    end
+
+    # Stops the Mimi::Signal, untraps all trapped signals
+    #
+    def self.stop
+      return unless @thread
+      handlers.keys.each do |signal|
+        Kernel.trap(signal, handlers[signal][:old_trap])
+      end
+      @thread.kill
+      @thread = nil
+      @handlers = nil
+    end
+
+    private # -ish class methods
+
+    def self.handlers
+      @handlers ||= {}
+    end
+
+    def self.queue
+      @queue ||= Queue.new
+    end
+  end # class Signal
+end # module Mimi
+
+require_relative 'signal/version'

data/mimi-signal.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mimi/signal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mimi-signal'
+  spec.version       = Mimi::Signal::VERSION
+  spec.authors       = ['Alex Kukushkin']
+  spec.email         = ['alex@kukushk.in']
+
+  spec.summary       = 'Asynchronous signal trap'
+  spec.description   = 'Asynchronous processing of trapped signals'
+  spec.homepage      = 'https://github.com/kukushkin/mimi-signal'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mimi-core', '~> 0.1'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mimi-signal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Kukushkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mimi-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: Asynchronous processing of trapped signals
+email:
+- alex@kukushk.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mimi/signal.rb
+- lib/mimi/signal/version.rb
+- mimi-signal.gemspec
+homepage: https://github.com/kukushkin/mimi-signal
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Asynchronous signal trap
+test_files: []