tricky_signals 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bae01d6def11c743e015c04e98c535fcedffc7a
+  data.tar.gz: 6566524445724705862fd73938ac86ce5c17fe3c
+SHA512:
+  metadata.gz: a0819793f214f9ebf5462447d138621afe780fb4ad4009caf0f5dcd49a0dba779961fc3a22f791d288e0d1310cea944b7288a29e2595fdccbed1402d56b5106c
+  data.tar.gz: 0c61f0c2c319c6c5bdc2e45ccba1f69f5452c6565750ac01c2c0fca70a4a492f8291acac25f0e74fc92dd325d8c88b33d8a09e1087a27d3f5c87fb5084ee8e5b

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,8 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Vladimir Kochnev
+
+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,111 @@
+tricky_signals
+==============
+
+[![Build Status](https://travis-ci.org/marshall-lee/tricky_signals.svg)](https://travis-ci.org/marshall-lee/tricky_signals)
+
+![](https://pbs.twimg.com/media/CO4aDLlUAAAjMuA.png)
+
+This gem aims to solve the problem with...
+
+```ruby
+logger = Logger.new(STDOUT)
+trap('USR1') do
+  logger.info 'hello!'
+end
+```
+
+And then:
+
+```
+kill -USR1 <pid>
+```
+
+What we get:
+
+```
+log writing failed. can't be called from trap context
+```
+
+Looks familiar? Then `tricky_signals` is your friend!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tricky_signals'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tricky_signals
+
+## Usage
+
+### Global trap handlers
+
+```ruby
+logger = Logger.new(STDOUT)
+
+# ...
+
+TrickySignals.global.trap(:USR1) do
+  Thread.list.each do |thread|
+    logger.debug { "Thread object_id=#{thread.object_id}" }
+    if thread.backtrace
+      logger.debug { thread.backtrace.join("\n") }
+    else
+      logger.debug '<no backtrace available>'
+    end
+  end
+end
+```
+
+### Global untrap
+
+```ruby
+TrickySignals.global.untrap(:USR1)
+```
+
+### Manual starting of service
+
+```ruby
+TrickySignals.start! do |signals|
+  signals.trap(:USR1) { }
+  # subscribed to USR1
+  signals.trap(:TTIN) { }
+  # subscribed to TTIN
+  # ...
+end
+# unsubscribed from USR1 and TTIN
+```
+
+#### Manual stop
+```ruby
+signals = TrickySignals.start!
+signals.trap(:USR1) { }
+signals.trap(:TTIN) { }
+# ...
+signals.stop!
+# unsubscribed from USR1 and TTIN
+```
+
+## 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/marshall-lee/tricky_signals.
+
+
+## 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 "tricky_signals"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tricky_signals/global.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+require 'forwardable'
+
+class TrickySignals
+  class << self
+    def global
+      Global.instance
+    end
+  end
+
+  class Global < TrickySignals
+    include Singleton
+
+    class << self
+      extend Forwardable
+
+      def_delegators :instance,
+        :start!,
+        :stop!,
+        :trap,
+        :untrap,
+        :untrap_all,
+        :ignore_on,
+        :default_on,
+        :exit_on,
+        :system_default_on
+    end
+
+    def initialize
+      super
+      start!
+    end
+  end
+end

data/lib/tricky_signals/version.rb

@@ -0,0 +1,3 @@
+class TrickySignals
+  VERSION = "0.1.0"
+end

data/lib/tricky_signals.rb

@@ -0,0 +1,202 @@
+require 'thread'
+require 'monitor.rb'
+
+class TrickySignals
+  class Handlers
+  end
+
+  class << self
+    def start!
+      obj = new.start!
+      if block_given?
+        yield obj
+        obj.stop!
+      else
+        obj
+      end
+    end
+
+    def handlers_class
+      const_get(:Handlers)
+    end
+  end
+
+  include MonitorMixin
+
+  def initialize
+    super
+    @started = false
+  end
+
+  def start!
+    synchronize do
+      fail "cannot start #{self}: already started!" if @started
+      @started = true
+
+      @handlers = self.class.handlers_class.new
+      @previous = {}
+      @io_thread = start_io
+      self
+    end
+  end
+
+  def stop!
+    synchronize do
+      fail "cannot stop #{self}: not started or stopped" unless @started
+
+      untrap_all
+
+      stop_io
+      @previous = nil
+      @handlers = nil
+
+      @started = false
+      nil
+    end
+  end
+
+  def started?
+    @started
+  end
+
+  def handlers
+    synchronize do
+      check_started!
+      @handlers
+    end
+  end
+
+  def setup_handlers
+    fail 'you should pass a block to `setup_handlers`' unless block_given?
+
+    synchronize do
+      check_started!
+      @handlers.instance_eval(&proc)
+    end
+  end
+
+  def trap(signal, command = nil)
+    synchronize do
+      check_started!
+      signal = stringify_signal(signal)
+      prev_handler =
+        if block_given?
+          trap_with_block(signal, &proc)
+        else
+          trap_with_command(signal, command)
+        end
+      @previous[signal] = prev_handler unless @previous.key? signal
+      prev_handler
+    end
+  end
+
+  def untrap(signal)
+    synchronize do
+      check_started!
+      signal = stringify_signal(signal)
+      if @previous.key? signal
+        trap_with_command(signal, @previous[signal])
+        @previous.delete signal
+      end
+    end
+  end
+
+  def untrap_all
+    synchronize do
+      check_started!
+      @previous.keys.each { |signal| untrap signal }
+    end
+  end
+
+  {
+    ignore: 'IGNORE',
+    default: 'DEFAULT',
+    exit: 'EXIT',
+    system_default: 'SYSTEM_DEFAULT'
+  }.each do |name, command|
+    name = "#{name}_on"
+
+    define_method(name) do |signal, &block|
+      trap(signal, command)
+    end
+  end
+
+  private
+
+  def check_started!
+    fail "#{self} is not started yet!" unless @started
+  end
+
+  def start_io
+    @io_read, @io_write = IO.pipe
+
+    Thread.new do
+      while ios = IO.select([@io_read])
+        input = ios.first.first.gets
+        break unless input
+        signal = input.chomp
+
+        synchronize do
+          handler = @handlers.public_method("handle_#{signal}")
+          case handler.arity
+          when 0 then handler.call
+          when 1 then handler.call signal
+          when 2 then handler.call signal, @previous[signal]
+          end
+        end
+      end
+
+      @io_read.close
+    end
+  end
+
+  def stop_io
+    @io_write.close
+    @io_thread.join
+    @io_thread = nil
+    @io_read = nil
+    @io_write = nil
+  end
+
+  def trap_with_block(signal, &block)
+    @handlers.define_singleton_method("handle_#{signal}", &block)
+    Signal.trap(signal) do
+      @io_write.puts(signal)
+    end
+  end
+
+  def trap_with_command(signal, command)
+    sclass = @handlers.singleton_class
+    if sclass.method_defined?(method_name_for(signal))
+      sclass.send(:remove_method, method_name_for(signal))
+    end
+    Signal.trap(signal, command)
+  end
+
+  if Signal.respond_to? :signame
+    def signame(signal)
+      Signal.signame(signal).to_s
+    end
+  else
+    def signame(signal)
+      found = Signal.list.find { |name, i| i == signal }
+      fail ArgumentError, "unknow signal #{signal}" unless found
+      found.first.to_s
+    end
+  end
+
+  def stringify_signal(signal)
+    if signal.is_a? Fixnum
+      signame(signal)
+    else
+      signal.to_s
+    end
+  end
+
+  def method_name_for(signal)
+    "handle_#{signal}"
+  end
+end
+
+require 'tricky_signals/global'
+require 'tricky_signals/version'

data/tricky_signals.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tricky_signals/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tricky_signals"
+  spec.version       = TrickySignals::VERSION
+  spec.authors       = ["Vladimir Kochnev"]
+  spec.email         = ["hashtable@yandex.ru"]
+
+  spec.summary       = "Escaping Ruby's Signal.trap!"
+  spec.homepage      = "https://github.com/marshall-lee/tricky_signals"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: tricky_signals
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladimir Kochnev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hashtable@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tricky_signals.rb
+- lib/tricky_signals/global.rb
+- lib/tricky_signals/version.rb
+- tricky_signals.gemspec
+homepage: https://github.com/marshall-lee/tricky_signals
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Escaping Ruby's Signal.trap!
+test_files: []