multitrap 0.0.1 → 0.1.0

data/lib/multitrap.rb

@@ -1,85 +1,25 @@
-require 'multitrap/version'
 require 'thread'
 
 module Multitrap
-  class Trap
-    RESERVED_SIGNALS = {
-      'BUS' => 10,
-      'SEGV' => 11,
-      'ILL' => 4,
-      'FPE' => 8,
-      'VTALRM' => 26
-    }
+  # The VERSION file must be in the root directory of the library.
+  VERSION_FILE = File.expand_path('../../VERSION', __FILE__)
 
-    def self.trap(sig, prc, old_trap, &block)
-      @multitrap ||= self.new(old_trap)
-      @multitrap.add_trap(sig, prc, &block)
-    end
+  VERSION = File.exist?(VERSION_FILE) ?
+              File.read(VERSION_FILE).chomp : '(could not find VERSION file)'
 
-    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
+  def self.jruby?
+    RUBY_ENGINE == 'jruby'
   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
+  def self.mri?
+    RUBY_ENGINE == 'ruby'
   end
-end
 
-module Kernel
-  def trap(sig, prc = nil, &block)
-    Signal.trap(sig, prc, &block)
+  def self.rbx?
+    RUBY_ENGINE == 'rbx'
   end
-  module_function :trap
 end
+
+require 'multitrap/trap'
+require 'multitrap/patched_trap'
+require 'multitrap/core_ext'

data/lib/multitrap/core_ext.rb

@@ -0,0 +1,11 @@
+case RUBY_ENGINE
+when 'ruby'
+  [Kernel, Kernel.singleton_class, Signal, Signal.singleton_class].each do |klass|
+    klass.__send__(:include, Multitrap::PatchedTrap)
+  end
+when 'rbx'
+  Signal.__send__(:include, Multitrap::PatchedTrap)
+  Signal.singleton_class.__send__(:include, Multitrap::PatchedTrap)
+when 'jruby'
+  Signal.singleton_class.__send__(:include, Multitrap::PatchedTrap)
+end

data/lib/multitrap/patched_trap.rb

@@ -0,0 +1,31 @@
+module Multitrap
+  module PatchedTrap
+    def self.included(mod)
+      original_trap = Signal.method(:trap)
+
+      mod.instance_eval do
+        define_method(:trap) do |*args, &block|
+          if args.size < 1
+            if Multitrap.rbx?
+              raise ArgumentError, "method 'trap': given 0, expected 2"
+            elsif Multitrap.jruby?
+              raise ArgumentError, "wrong number of arguments (0 for 1)"
+            else
+              raise ArgumentError, "wrong number of arguments (0 for 1..2)"
+            end
+          end
+
+          if block.nil?
+            if Multitrap.rbx? && !args[1].respond_to?(:call)
+              raise ArgumentError, "Handler must respond to #call (was #{args[1].class})"
+            elsif args[1].nil?
+              raise ArgumentError, 'tried to create Proc object without a block'
+            end
+          end
+
+          Multitrap::Trap.trap(original_trap, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/multitrap/trap.rb

@@ -0,0 +1,104 @@
+module Multitrap
+  class Trap
+    OWN_MRI_FRAME = %r{/lib/multitrap/trap.rb:[0-9]{1,3}:in `block in store_trap'}
+
+    OWN_RBX_FRAME = %r{/lib/multitrap/trap.rb:[0-9]{1,3}:in `store_trap'}
+
+    TRAVIS_FRAME = %r{lib/jruby\.jar!/jruby/kernel/signal\.rb}
+
+    RESERVED_SIGNALS = %w|BUS SEGV ILL FPE VTALRM|
+
+    KNOWN_SIGNALS = Signal.list.keys - RESERVED_SIGNALS
+
+    def self.trap(original_trap, *args, &block)
+      @@multitrap ||= new(original_trap)
+
+      signal = args[0]
+      command = args[1]
+
+      @@multitrap.store_trap(signal, command, &block)
+    end
+
+    def self.__clear_all_handlers!
+      @@multitrap ||= nil
+      @@multitrap && @@multitrap.__clear_all_handlers!
+    end
+
+    def initialize(original_trap)
+      @original_trap = original_trap
+      @trap_list = create_trap_list
+    end
+
+    def store_trap(signal, command, &block)
+      signal = signal.to_s
+      command ||= block
+
+      trap_is_nested = nested_trap?
+
+      if trap_is_nested
+        # JRuby doesn't support nested traps.
+        return if Multitrap.jruby?
+        @trap_list[signal].pop
+      end
+
+      @trap_list[signal] << command
+
+      prev_trap_handler = @original_trap.call(signal) do |signo|
+        @trap_list[signal].reverse_each do |trap_handler|
+          trap_handler.call(signo || Signal.list[signal])
+        end
+      end
+
+      if !trap_is_nested &&
+         @trap_list[signal].size == 1 &&
+         !default_handler?(prev_trap_handler) &&
+         !default_handler_path?(prev_trap_handler)
+        @trap_list[signal].unshift(prev_trap_handler)
+      end
+
+      @trap_list
+    end
+
+    def __clear_all_handlers!
+      @trap_list.keys.select {|s| KNOWN_SIGNALS.include?(s) }.each do |signal|
+        @original_trap.call(signal, 'DEFAULT')
+      end
+
+      @trap_list = create_trap_list
+    end
+
+    private
+
+    define_method(:nested_trap?) do
+      case RUBY_ENGINE
+      when 'ruby'
+        caller.any? { |stackframe| stackframe =~ OWN_MRI_FRAME }
+      when 'rbx'
+        caller.grep(OWN_RBX_FRAME).size > 1
+      when 'jruby'
+        if caller.any? { |stackframe| stackframe =~ TRAVIS_FRAME }
+          caller.grep(OWN_RBX_FRAME).size > 1
+        else
+          caller.grep(OWN_MRI_FRAME).size > 1
+        end
+      else
+        raise NotImplementedError, 'unsupported Ruby engine'
+      end
+    end
+
+    def create_trap_list
+      Hash.new { |h, k| h[k] = [] }
+    end
+
+    def default_handler?(prev)
+      ['DEFAULT', 'SYSTEM_DEFAULT', 'IGNORE'].any? { |h| h == prev }
+    end
+
+    def default_handler_path?(prev)
+      [%r{Proc:.+@kernel/loader\.rb:[0-9]{1,4}},
+       %r{Proc:.+@uri:classloader:/jruby/kernel/signal.rb:[0-9]{1,4}}].any? do |h|
+        h =~ prev.to_s
+       end
+    end
+  end
+end

metadata

@@ -1,115 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: multitrap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Kyrylo Silin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-08 00:00:00.000000000 Z
+date: 2015-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-wait
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
-email:
-- silin@kyrylo.org
+email: silin@kyrylo.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- CHANGELOG.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
+- lib/multitrap/core_ext.rb
+- lib/multitrap/patched_trap.rb
+- lib/multitrap/trap.rb
 - lib/multitrap.rb
-- lib/multitrap/version.rb
-- multitrap.gemspec
-- spec/multitrap_spec.rb
-- spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/kyrylo/multitrap
 licenses:
-- MIT
-metadata: {}
+- Zlib
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Allows Signal.trap to have multiple callbacks
-test_files:
-- spec/multitrap_spec.rb
-- spec/spec_helper.rb
-has_rdoc: 
+test_files: []

checksums.yaml

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

data/.gitignore

@@ -1,23 +0,0 @@
-*.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

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

data/CHANGELOG.md

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

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-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

@@ -1,98 +0,0 @@
-# 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

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

data/lib/multitrap/version.rb

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

data/multitrap.gemspec

@@ -1,24 +0,0 @@
-# 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

@@ -1,102 +0,0 @@
-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

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