exceptional_fork 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 747654a03842e5bf513885263e928420649bc789
+  data.tar.gz: 209e893bffed33cf0610551a228f11c1509580f2
+SHA512:
+  metadata.gz: 5266e24496d23f343040a1c7fb8820e4513f6162acea0fb1bc9a4fd8a15e3ce8b23d42741a9801e935ab96c320354f0380a369db91f3783569c14d6549eeb17c
+  data.tar.gz: 1cc0e5f91b46b08dccf7c7870e0551e30dad4eac681af03491e3368ce9484f8c757240061b4a3e52ac45fc587c9497f5aace93441f4ee29d4981121511a350df

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.14"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Julik Tarkhanov
+
+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.rdoc

@@ -0,0 +1,33 @@
+= exceptional_fork
+
+Fork with a block and wait until the forked child exits.
+Any exceptions raised within the block will be re-raised from this
+in the parent process (where you call it from).
+
+    ExceptionalFork.fork_and_wait { raise "Explosion! "} # raises a RuntimeError
+
+or for something that runs longer:
+
+    ExceptionalFork.fork_and_wait do
+      perform_long_running_job! # this raises some EOFError or another
+    end
+    #=> EOFError... # more data and the backtrace.
+
+It is not guaranteed that all the exception metadata will be reinstated due to
+marshaling/unmarshaling mechanics, but it helps debugging nevertheless.
+
+== Contributing to exceptional_fork
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require File.dirname(__FILE__) + '/lib/exceptional_fork'
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.version = ExceptionalFork::VERSION
+  gem.name = "exceptional_fork"
+  gem.homepage = "http://github.com/julik/exceptional_fork"
+  gem.license = "MIT"
+  gem.summary = %Q{ Raise exceptions from the forked child process in the parent }
+  gem.description = %Q{ Uses pipes to re-raise exceptions. Something better than an exit code has to exist. }
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "exceptional_fork #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/exceptional_fork.rb

@@ -0,0 +1,72 @@
+module ExceptionalFork
+  VERSION = '1.0.0'
+  
+  # Fork with a block and wait until the forked child exits.
+  # Any exceptions raised within the block will be re-raised from this
+  # in the parent process (where you call it from).
+  #
+  #   ExceptionalFork.fork_and_wait { raise "Explosion! "} # raises a RuntimeError
+  #
+  # or for something that runs longer:
+  #
+  #   ExceptionalFork.fork_and_wait do
+  #     perform_long_running_job! # this raises some EOFError or another
+  #   end
+  #   #=> EOFError... # more data and the backtrace.
+  #
+  # It is not guaranteed that all the exception metadata will be reinstated due to
+  # marshaling/unmarshaling mechanics, but it helps debugging nevertheless.
+  def fork_and_wait
+    # Redirect the exceptions in the child to the pipe. When we get a non-zero
+    # exit code we can read from that pipe to obtain the exception.
+    reader, writer = IO.pipe
+    
+    # Run the block in a forked child
+    pid = fork_with_error_output(writer) { yield }
+  
+    # Wait for the forked process to exit
+    Process.wait(pid)
+  
+    writer.close rescue IOError # Close the writer so that we can read from the reader
+    child_error = reader.read # Read the error output
+    reader.close rescue IOError # Do not leak pipes since the process might be long-lived
+  
+    if $?.exitstatus != 0 # If the process exited uncleanly capture the error
+      unmarshaled_error, backtrace_in_child = Marshal.load(child_error)
+      # Pick up the exception 
+      reconstructed_error = unmarshaled_error.exception
+      
+      # Reconstruct the backtrace
+      if reconstructed_error.respond_to?(:set_backtrace)
+        reconstructed_error.set_backtrace(backtrace_in_child)
+      end
+      
+      raise reconstructed_error # ..and re-raise it in this (parent) process
+    end
+  end
+  
+  def fork_with_error_output(errors_pipe)
+    pid = Process.fork do
+      # Tracking if the op failed
+      success = false
+      begin
+        # Run the closure passed to the fork_with_error_output method
+        yield
+        success = true
+      rescue Exception => exception
+        # Write a YAML dump of the exception and the backtrace to the error
+        # pipe, so that we can re-raise it in the parent process ;-)
+        error_payload = [exception, exception.backtrace.to_a]
+        errors_pipe.puts(Marshal.dump(error_payload))
+        errors_pipe.flush
+      ensure
+        Process.exit! success # Exit maintaining the status code
+      end
+    end
+  
+    # Return the PID of the forked child
+    pid
+  end
+  
+  extend self
+end

data/spec/exceptional_fork_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ExceptionalFork" do
+  it "re-raises the exception from a subprocess" do
+    expect(Process).to receive(:fork).and_call_original
+    
+    pid_of_parent = Process.pid
+    begin
+      ExceptionalFork.fork_and_wait do
+        raise "This is process #{Process.pid} calling"
+      end
+      expect(false).to eq(true), "This should never be reached"
+    rescue RuntimeError => e
+      matches = (e.message =~ /This is process (\d+) calling/)
+      expect(matches).not_to be_nil
+      expect($1).not_to eq(pid_of_parent.to_s)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'exceptional_fork'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: exceptional_fork
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: " Uses pipes to re-raise exceptions. Something better than an exit code
+  has to exist. "
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/exceptional_fork.rb
+- spec/exceptional_fork_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/julik/exceptional_fork
+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: Raise exceptions from the forked child process in the parent
+test_files: []