rescue-any 0.1.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.1 (09/10/2013)
+
+* First, experimental release - [@erik-eide](https://github.com/erik-eide).

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Erik Eide
+
+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,47 @@
+RescueAny
+==========
+
+[![Build Status](https://travis-ci.org/erik-eide/rescue-any.png)](https://travis-ci.org/erik-eide/rescue-any) [![Code Climate](https://codeclimate.com/github/erik-eide/rescue-any.png)](https://codeclimate.com/github/erik-eide/rescue-any)
+
+An experimental library for declarative exception handling in Ruby.
+
+Inspired by Rails's declarative [rescue_from](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/rescuable.rb)
+method, this is a bit of an experimental attempt to try something similar that can be used with any Ruby class, as well as to just mess
+around with a little meta-programming.
+
+## Usage
+
+```ruby
+class RemoteUser
+  include RescueAny
+
+  rescue_any RuntimeError, on: [:create, :update, :delete], with: lambda {|ex| puts 'ohoh: ' + ex.message }
+
+  def create
+    raise RuntimeError.new("raised by #create")
+  end
+
+  def update
+    raise RuntimeError.new("raised by #update")
+  end
+
+  def delete
+    raise RuntimeError.new("raised by #delete")
+  end
+end
+ ```
+
+## Contributing
+
+Feel free to contribute or correct, just:
+
+* Fork this project.
+* Write specs, make them pass.
+* Updated [CHANGELOG](CHANGELOG.md).
+* Make a pull request, bonus for topic branches.
+
+## Copyright and License
+
+Copyright (c) 2013, Erik Eide and [Contributors](CHANGELOG.md).
+
+This project is licensed under the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+Bundler.setup(:default, :development)
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/rescue_any/version.rb

@@ -0,0 +1,3 @@
+module RescueAny
+  VERSION = '0.1.1'
+end

data/lib/rescue_any.rb

@@ -0,0 +1,96 @@
+require 'rescue_any/version'
+
+module RescueAny
+
+  def self.included(base)
+    class << base
+      attr_accessor :rescue_statements
+    end
+
+    base.rescue_statements = {}
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    # Rescue exceptions raised by an object's instance methods.
+    #
+    # <tt>rescue_any</tt> receives an exception class, and a trailing hash
+    # containing a <tt>on:</tt> option listing one or more method names to
+    # apply the rescue to, and a <tt>with:</tt> option containing a code block
+    # for handling the exception.
+    #
+    # The handling block can receive either zero or one argument, in the latter,
+    # it will be passed the rescued exception.
+    #
+    #  class RemoteUser
+    #    include RescueAny
+    #
+    #    rescue_any RuntimeError, on: [:create, :update, :delete], with: lambda {|ex| puts 'ohoh: ' + ex.message }
+    #
+    #    def create
+    #      raise RuntimeError.new("raised by #create")
+    #    end
+    #
+    #    def update
+    #      raise RuntimeError.new("raised by #update")
+    #    end
+    #
+    #    def delete
+    #      raise RuntimeError.new("raised by #delete")
+    #    end
+    #  end
+    #
+    # Exceptions raised inside the handler are not caught and will propogate
+    # up to the client class.
+    def rescue_any(exception_klass, options = {})
+
+      unless exception_klass.is_a?(Class) && exception_klass <= Exception
+        raise ArgumentError.new('First argument must be an Exception or sub-class of Exception')
+      end
+
+      unless options[:with]
+        raise ArgumentError.new('Expected a handler, supply an option hash that as :with key as an argument')
+      end
+
+      method_block = options[:with]
+      method_names = [options.fetch(:on, [])].flatten
+
+      method_names.each do |method_name|
+        rescue_statements[method_name] ||= {}
+        rescue_statements[method_name][exception_klass] = method_block
+      end
+    end
+
+    def method_added(method_name)
+      if rescue_statements.keys.include?(method_name)
+        alias_method_name = "#{method_name}_without_rescue_any".to_sym
+
+        unless self.instance_methods.include?(alias_method_name)
+          self.send(:alias_method, alias_method_name, method_name)
+          self.send(:define_method, method_name) do
+            begin
+              self.send(alias_method_name)
+            rescue Exception => ex
+              exception_handled = false
+
+              exceptions_and_rescue_blocks = self.class.instance_eval { rescue_statements[method_name] }
+              exceptions_and_rescue_blocks.keys.each do |rescue_exception|
+                if ex.instance_of? rescue_exception
+                  self.class.instance_eval do
+                    rescue_handler = rescue_statements[method_name][rescue_exception]
+                    rescue_handler.arity != 0 ? rescue_handler.call(ex) : rescue_handler.call
+                  end
+                  exception_handled = true
+                  break
+                end
+              end
+
+              raise ex unless exception_handled
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rescue_any.gemspec

@@ -0,0 +1,16 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "rescue_any/version"
+
+Gem::Specification.new do |s|
+  s.name = "rescue-any"
+  s.version = RescueAny::VERSION
+  s.authors = [ "Erik Eide" ]
+  s.email = "gdayerik@facebook.com"
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = [ "lib" ]
+  s.homepage = "http://github.com/erik-eide/rescue-any"
+  s.licenses = [ "MIT" ]
+  s.summary = "Declarative exception handling for Ruby"
+end

data/spec/rescue_any/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RescueAny do
+  it "has a version" do
+    RescueAny::VERSION.should_not be_nil
+  end
+end

data/spec/rescue_any_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+describe RescueAny do
+
+  let(:subject_class) { Class.new }
+  let(:subject) { subject_class.new }
+
+  before :each do
+    subject_class.class_eval do
+      include RescueAny
+    end
+  end
+
+  describe '.rescue_any' do
+    context 'without an exception' do
+      it 'raises an ArgumentError for nil' do
+        expect {
+          subject_class.class_eval do
+            rescue_any nil, :on => :create, :with => lambda { |ex| "#{ex} caught by rescue_any" }
+          end
+        }.to raise_error ArgumentError
+      end
+
+      it 'raises an ArgumentError for something other than a class' do
+        expect {
+          subject_class.class_eval do
+            rescue_any 'StandardError', :on => :create, :with => lambda { |ex| "#{ex} caught by rescue_any" }
+          end
+        }.to raise_error ArgumentError
+      end
+
+      it 'raises an ArgumentError for something other than an Exception or sub-class' do
+        expect {
+          subject_class.class_eval do
+            rescue_any Object, :on => :create, :with => lambda { |ex| "#{ex} caught by rescue_any" }
+          end
+        }.to raise_error ArgumentError
+      end
+    end
+
+    context 'for one method' do
+      before :each do
+        subject_class.class_eval do
+          rescue_any StandardError, :on => :create, :with => lambda { |ex| "#{ex} caught by rescue_any" }
+        end
+      end
+
+      it 'will rescue the given exception' do
+        subject_class.class_eval do
+          def create
+            raise StandardError.new("Raised by #create")
+          end
+        end
+
+        expect { subject.create }.to_not raise_error
+      end
+
+      it 'will not rescue other exception types' do
+        subject_class.class_eval do
+          def create
+            raise ArgumentError.new("ArgumentError raised by #create")
+          end
+        end
+
+        expect { subject.create }.to raise_error
+      end
+    end
+
+    context 'for a list of methods' do
+      before :each do
+        subject_class.class_eval do
+          rescue_any StandardError, :on => [:create, :update], :with => lambda { |ex| "#{ex} caught by rescue_any" }
+        end
+      end
+
+      it 'will rescue the given exception' do
+        subject_class.class_eval do
+          def create
+            raise StandardError.new("Raised by #create")
+          end
+
+          def update
+            raise StandardError.new("Raised by #update")
+          end
+        end
+
+        expect { subject.create }.to_not raise_error
+        expect { subject.update }.to_not raise_error
+      end
+    end
+
+    context 'when you forget to specify any methods' do
+      before :each do
+        subject_class.class_eval do
+          rescue_any StandardError, :with => lambda { |ex| "#{ex} caught by rescue_any" }
+
+          def create
+            raise StandardError.new("Raised by #create")
+          end
+
+          def update
+            raise StandardError.new("Raised by #update")
+          end
+        end
+      end
+
+      it "just won't rescue anything" do
+        expect { subject.create }.to raise_error
+        expect { subject.update }.to raise_error
+      end
+    end
+
+    context "with a lambda handler" do
+      it "it receives an invocation" do
+        expect(Kernel).to receive(:puts)
+
+        subject_class.class_eval do
+          rescue_any StandardError, :on => :create, :with => lambda { |ex| Kernel.puts(ex.message) }
+
+          def create
+            raise StandardError.new("Raised by #create")
+          end
+        end
+
+        expect { subject.create }.to_not raise_error
+      end
+
+      it 'propagates exceptions from within the handler' do
+        subject_class.class_eval do
+          rescue_any StandardError, :on => :create, :with => lambda { raise Exception.new("Raised by .rescue_any handler") }
+
+          def create
+            raise StandardError.new("Raised by #create")
+          end
+        end
+
+        expect { subject.create }.to raise_error Exception
+      end
+    end
+
+    context 'without a handler' do
+      it 'raises an argument error' do
+        expect {
+          subject_class.class_eval do
+            rescue_any StandardError, :on => :create
+          end
+        }.to raise_error ArgumentError
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'rescue_any'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: rescue-any
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Erik Eide
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-09-14 00:00:00 Z
+dependencies: []
+
+description: 
+email: gdayerik@facebook.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rescue_any.rb
+- lib/rescue_any/version.rb
+- rescue_any.gemspec
+- spec/rescue_any/version_spec.rb
+- spec/rescue_any_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/erik-eide/rescue-any
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.26
+signing_key: 
+specification_version: 3
+summary: Declarative exception handling for Ruby
+test_files: []
+