absolver 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c76e2d96ca20824c08be83d405a482c3868f17f734d7bd8bde2c167b7da5595a
+  data.tar.gz: cddc7a5991121d3bcdfddfde761399211df4f4410860e3a9b6b04b45ae597d11
+SHA512:
+  metadata.gz: 0d38a00d96c571ce019ace9a2a21145ed8c390d932f71aebfcaea9d191602542732515fafd9baed186cc72f74c8ba66ce23562db75b6b591f0346bd24cc2cdd9
+  data.tar.gz: b5e418beeb6af4ed83c1582cfcf2d3723b6761d8be8df0094a48111cc94fc4c408d20042c94cd5bcb3bdc81cc8016b6da32e7b266f60d5eec9367c65560487de

data/Gemfile

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

data/README.md

@@ -0,0 +1,59 @@
+absolver
+===
+
+Absolver is a small little gem that allows setting the cause of a Ruby exception. Consider this example:
+
+```ruby
+err = begin
+  begin
+    1 / 0
+  rescue => e
+    raise RuntimeError, 'foo'
+  end
+rescue => e
+  e
+end
+```
+
+Notice that I raised a `RuntimeError` _inside_ a `rescue` block. In Ruby 2.1 and later, doing so will set the inner exception's `#cause` attribute to the outer exception. In other words:
+
+```ruby
+err        # => #<RuntimeError: foo>
+err.cause  # => #<ZeroDivisionError: divided by 0>
+```
+
+Cool, thanks Ruby!
+
+What if I want to change the cause though? Maybe I don't really want to include the cause when reporting to an external error monitoring service, for example. Sadly, Ruby doesn't let you do that:
+
+```ruby
+err.cause = nil
+# NoMethodError (undefined method `cause=' for #<RuntimeError: foo>)
+```
+
+What's a programmer to do? Use absolver!
+
+```ruby
+require 'absolver'
+
+Absolver.set_cause(err, nil)
+
+err.cause  # => nil
+```
+
+Absolver uses [Fiddle](https://ruby-doc.org/stdlib-2.5.0/libdoc/fiddle/rdoc/Fiddle.html) to safely set the `cause` attribute of the `Exception` object. Basically it reaches down into Ruby's internals to adjust the value of the `cause` instance variable, which normally isn't exposed to your program.
+
+Absolver also includes a small monkeypatch that adds `cause=` to `Exception`. Because many people dislike monkeypatches, you have to opt-in:
+
+```ruby
+require 'absolver/exception'
+err.cause = nil
+```
+
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -0,0 +1,15 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+require 'absolver'
+
+Bundler::GemHelper.install_tasks
+
+task default: :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/absolver.gemspec

@@ -0,0 +1,21 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'absolver/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'absolver'
+  s.version  = ::Absolver::VERSION
+  s.authors  = ['Cameron Dutro']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'http://github.com/camertron/absolver'
+
+  s.description = s.summary = 'Allows setting the cause of Ruby exceptions.'
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+
+  s.require_path = 'lib'
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'README.md', 'Rakefile', 'absolver.gemspec']
+end

data/lib/absolver.rb

@@ -0,0 +1,38 @@
+require 'fiddle'
+
+module Absolver
+  class << self
+    def set_cause(exc, new_cause)
+      rb_ivar_set(exc, 'cause', new_cause)
+    end
+
+    private
+
+    def rb_ivar_set(mod, str, new_val)
+      id = rb_intern_str(str)
+      m = Fiddle.dlwrap(mod)
+      nv = Fiddle.dlwrap(new_val)
+      Fiddle.dlunwrap(rb_ivar_set_func.call(m, id, nv))
+    end
+
+    def rb_ivar_set_func
+      @rb_ivar_set_func ||= Fiddle::Function.new(
+        Fiddle::Handle::DEFAULT['rb_ivar_set'],
+        [Fiddle::TYPE_VOIDP] * 3,  # arguments
+        Fiddle::TYPE_VOIDP         # return type
+      )
+    end
+
+    def rb_intern_str(str)
+      rb_intern_str_func.call(Fiddle.dlwrap(str))
+    end
+
+    def rb_intern_str_func
+      @rb_intern_str_func ||= Fiddle::Function.new(
+        Fiddle::Handle::DEFAULT['rb_intern_str'],
+        [Fiddle::TYPE_VOIDP],  # arguments
+        Fiddle::TYPE_VOIDP     # return type
+      )
+    end
+  end
+end

data/lib/absolver/exception.rb

@@ -0,0 +1,7 @@
+require 'absolver'
+
+class Exception
+  def cause=(new_cause)
+    Absolver.set_cause(self, new_cause)
+  end
+end

data/lib/absolver/version.rb

@@ -0,0 +1,3 @@
+module Absolver
+  VERSION = '1.0.0'
+end

data/spec/absolver_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Absolver do
+  describe '.set_cause' do
+    let(:exc) { begin; 1 / 0; rescue => e; e; end }
+    let(:cause) { RuntimeError.new('foobar') }
+
+    it 'sets the cause on an exception' do
+      expect { Absolver.set_cause(exc, cause) }.to(
+        change { exc.cause }.from(nil).to(cause)
+      )
+    end
+
+    it 'allows the cause to be set to nil' do
+      Absolver.set_cause(exc, cause)
+
+      expect { Absolver.set_cause(exc, nil) }.to(
+        change { exc.cause }.from(cause).to(nil)
+      )
+    end
+  end
+end

data/spec/exception_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Exception do
+  describe '#cause=' do
+    let(:exc) { begin; 1 / 0; rescue => e; e; end }
+    let(:cause) { RuntimeError.new('foobar') }
+
+    it 'allows the cause to be set' do
+      expect { exc.cause = cause }.to(
+        change { exc.cause }.from(nil).to(cause)
+      )
+    end
+
+    it 'allows the cause to be set to nil' do
+      exc.cause = cause
+
+      expect { exc.cause = nil }.to(
+        change { exc.cause }.from(cause).to(nil)
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.push(__dir__)
+
+require 'rspec'
+require 'absolver'
+require 'absolver/exception'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: absolver
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-27 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Allows setting the cause of Ruby exceptions.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- absolver.gemspec
+- lib/absolver.rb
+- lib/absolver/exception.rb
+- lib/absolver/version.rb
+- spec/absolver_spec.rb
+- spec/exception_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/camertron/absolver
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Allows setting the cause of Ruby exceptions.
+test_files: []