multitrap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f34b3f14dfb6b3271c98561b1a9dd6bde507947a
+  data.tar.gz: df07859ab58e19de64a97b6ab417b408476e55ca
+SHA512:
+  metadata.gz: 46b7369e7ce17076171ca335951f16f1b4d0f94d1ff5b6e641542d520ea512f7d7d71aa54de76c31f0c5228ac85f93e31f64319df4b1f76263bc1c250dbadb20
+  data.tar.gz: f2f5d7b4abfb0ea065967e7910f01d5e9d7c09838243c26371285d642b3bf0fbb40720156a9d394d0d480708171b7ffd8e76ca79bb63dc5989a50fa72a60df2a

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+Multitrap changelog
+===================
+
+### v0.0.1 (September 7, 2014)
+
+* Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kyrylo Silin
+
+MIT License
+
+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,98 @@
+# Multitrap
+
+The idea is to be able to attach multiple callbacks for `Signal.trap`.
+
+```ruby
+require 'multitrap'
+
+trap('INT') do
+  puts 111
+end
+
+trap('INT') do
+  puts 222
+end
+
+Process.kill('INT', $$)
+
+# Outputs:
+# 111
+# 222
+```
+
+Currently, the library doesn't achieve the goal. I want to make the gem
+unobtrusive: the user installs it and it "just works". However, it's not
+possible due to a limitation of MRI. If you earlier had defined traps and then
+required Multitrap, it would discard your previously defined callbacks.
+
+```ruby
+trap('INT') do
+  puts 111
+end
+
+require 'multitrap'
+
+trap('INT') do
+  puts 222
+end
+
+trap('INT') do
+  puts 333
+end
+
+Process.kill('INT', $$)
+
+# Outputs:
+# 222
+# 333
+```
+
+However, it's possible to bypass this limitation. Just redefine your trap
+when Multitrap is loaded.
+
+```ruby
+trap_proc = trap('INT') do
+  puts 111
+end
+
+require 'multitrap'
+
+trap('INT', trap_proc)
+
+trap('INT') do
+  puts 222
+end
+
+Process.kill('INT', $$)
+
+# Outputs:
+# 111
+# 222
+# 333
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multitrap'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multitrap
+
+## Limitations
+
+### Rubies
+
+* MRI 2.1
+
+### Known bugs
+
+* recursive traps are broken (fixable)
+* overwrites traps defined before the loading of the library ([not fixable,
+  requires patching MRI](https://bugs.ruby-lang.org/issues/10211))

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/multitrap.rb

@@ -0,0 +1,85 @@
+require 'multitrap/version'
+require 'thread'
+
+module Multitrap
+  class Trap
+    RESERVED_SIGNALS = {
+      'BUS' => 10,
+      'SEGV' => 11,
+      'ILL' => 4,
+      'FPE' => 8,
+      'VTALRM' => 26
+    }
+
+    def self.trap(sig, prc, old_trap, &block)
+      @multitrap ||= self.new(old_trap)
+      @multitrap.add_trap(sig, prc, &block)
+    end
+
+    def initialize(old_trap)
+      @old_trap = old_trap
+      @traps = {}
+      @mutex = Mutex.new
+    end
+
+    def recursion?
+      frame = caller.find do |f|
+        f =~ %r{multitrap/lib/multitrap\.rb.+`block in add_trap'}
+      end
+
+      true if frame
+    end
+
+    def add_trap(sig, prc, &block)
+      if RESERVED_SIGNALS.key?(sig)
+        raise ArgumentError, "can't trap reserved signal SIG#{sig}"
+      end
+
+      unless Signal.list.key?(sig)
+        raise ArgumentError, "unsupported signal SIG#{sig}"
+      end
+
+      prc ||= block
+
+      if prc.nil?
+        raise ArgumentError, "tried to create Proc object without a block"
+      end
+
+      @traps[sig] ||= []
+
+      @mutex.synchronize do
+        if recursion?
+          @traps[sig].pop
+        else
+          @traps[sig].push(prc || block)
+        end
+      end
+
+      @old_trap.call(sig) do
+        @traps[sig].each do |trap_handler|
+          trap_handler.call(Signal.list[sig])
+        end
+      end
+
+      @traps
+    end
+  end
+end
+
+module Signal
+  class << self
+    alias_method :old_trap, :trap
+    protected :old_trap
+
+    def trap(sig, prc = nil, &block)
+      Multitrap::Trap.trap(sig, prc, method(:old_trap), &block)
+    end
+  end
+end
+
+module Kernel
+  def trap(sig, prc = nil, &block)
+    Signal.trap(sig, prc, &block)
+  end
+  module_function :trap
+end

data/lib/multitrap/version.rb

@@ -0,0 +1,3 @@
+module Multitrap
+  VERSION = "0.0.1"
+end

data/multitrap.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multitrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multitrap"
+  spec.version       = Multitrap::VERSION
+  spec.authors       = ["Kyrylo Silin"]
+  spec.email         = ["silin@kyrylo.org"]
+  spec.summary       = %q{Allows Signal.trap to have multiple callbacks}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/multitrap_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Multitrap::Trap do
+  describe "#trap" do
+    describe "recursive" do
+      it "unwinds the stack" do
+        number = nil
+
+        trap('INT') do
+          trap('INT') do
+            number = 42
+          end
+        end
+
+        Process.kill('INT', $$)
+        expect(number).to be_nil
+
+        Process.kill('INT', $$)
+        expect(number).to eq(42)
+      end
+    end
+
+    it "adds multiple callbacks" do
+      shared = []
+
+      3.times do |i|
+        trap('INT') { shared << i }
+      end
+
+      Process.kill('INT', $$)
+
+      expect(shared).to eq([0, 1, 2])
+    end
+
+    it "supports proc syntax" do
+      shared = []
+
+      3.times do |i|
+        trap('INT', proc { shared << i })
+      end
+
+      Process.kill('INT', $$)
+
+      expect(shared).to eq([0, 1, 2])
+    end
+
+    it "ignores block if proc is given" do
+      shared = []
+
+      3.times do |i|
+        trap('INT', proc { shared << i }) do
+          shared << i+100
+        end
+      end
+
+      Process.kill('INT', $$)
+
+      expect(shared).to eq([0, 1, 2])
+    end
+
+    it "binds to multiple signals" do
+      shared_int = []
+      shared_info = []
+
+      3.times do |i|
+        trap('INT') { shared_int << i }
+      end
+
+      3.times do |i|
+        trap('INFO') { shared_info << i+100 }
+      end
+
+      Process.kill('INT', $$)
+      Process.kill('INFO', $$)
+
+      expect(shared_int).to eq([0, 1, 2])
+      expect(shared_info).to eq([100, 101, 102])
+    end
+
+    it "yields signal's number" do
+      number = nil
+
+      trap('INT') { |signo| number = signo }
+
+      Process.kill('INT', $$)
+
+      expect(number).to eq(2)
+    end
+
+    it "raises ArgumentError if signal doesn't exist" do
+      expect{
+        trap('DONUTS') { }
+      }.to raise_error(ArgumentError, /unsupported signal SIGDONUTS/)
+    end
+
+    it "raises ArgumentError if signal is reserved" do
+      expect{
+        trap('ILL') {}
+      }.to raise_error(ArgumentError, /can't trap reserved signal SIGILL/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler'
+require 'pry'
+require 'multitrap'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: multitrap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kyrylo Silin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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:
+- silin@kyrylo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multitrap.rb
+- lib/multitrap/version.rb
+- multitrap.gemspec
+- spec/multitrap_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Allows Signal.trap to have multiple callbacks
+test_files:
+- spec/multitrap_spec.rb
+- spec/spec_helper.rb
+has_rdoc: