restarts 1.0.2

data/History.txt

@@ -0,0 +1,15 @@
+=== 1.0.2 / 2008-08-21
+
+* 1 minor enhancement
+  * Fixed up the ri/rdoc
+
+=== 1.0.1 / 2008-08-21
+
+* 1 minor enhancement
+  * Added syntax for directly calling the #restart method with a restart id
+
+=== 1.0.0 / 2008-08-21
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/restarts.rb
+test/test_restarts.rb

data/README.txt

@@ -0,0 +1,70 @@
+= restarts
+
+latest code is available at http://github.com/archit/restarts/tree/master
+
+latest documentation is available at http://ore.rubyforge.org/restarts
+
+== DESCRIPTION:
+
+restarts.rb implements a new method Kernel#raise_condition which
+is similar to Kernel#raise for throwing exceptions, with the added feature
+of adding "restarts" next to the place where the exception is thrown so
+that they can be invoked from the exception handler somewhere higher
+up in the stack.
+
+== FEATURES/PROBLEMS:
+
+* kicks ass
+
+== SYNOPSIS:
+
+def do_stuff()
+  error_occured = do_something()
+  if error_occured
+    raise_with_restarts(MyException.new(...)) { |restart_id|
+      case restart_id
+      when :ID1 then do_something_more()
+      when :ID2 then do_something_even_more()
+      end
+    }
+  end
+end
+
+begin
+  do_stuff()
+rescue MyException
+  $!.restart(:ID1) if (boolean expression inolving $! data)
+end
+
+== REQUIREMENTS:
+
+None whatsoever
+
+== INSTALL:
+
+gem install restarts
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Archit Baweja
+
+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/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/restarts.rb'
+
+Hoe.new('restarts', Restarts::VERSION) do |p|
+  p.rubyforge_name = 'ore'
+  p.developer('Archit Baweja', 'architbaweja@gmail.com')
+  p.remote_rdoc_dir = 'restarts'
+end
+
+# vim: syntax=Ruby

data/lib/restarts.rb

@@ -0,0 +1,40 @@
+# restarts.rb - Implements a simple condition-restarts exception system,
+#               just like Common Lisp
+#
+# Refer to README.txt for more info
+
+module Restarts
+  VERSION = '1.0.2'
+end
+
+module Kernel
+  # Similar to the standard Kernel#raise command. Allows you to throw exceptions
+  # The benefit is though that using raise_with_restarts adds the infrastructure
+  # so that the rescue code can tell the exception to restart and recover from
+  # a specific point.
+  #
+  # See README.txt for example
+  def raise_with_restarts(condition)
+    restart = callcc do |cc|
+      # Have the continuation object accessible via the #restart method.
+      # FIXME: check for pre defined methods by the name "restart".
+      (class <<condition; self; end).class_eval do
+        define_method(:restart) do |*id|
+          if id.empty?
+            return cc
+          else
+            return cc.call(id[0])
+          end
+        end
+      end
+
+      raise condition
+    end
+
+    # This allows raise_condition to be used in the same way as regular raise
+    # Just don't give an exception.
+    #
+    # IDEA: maybe alias this to default Kernal#raise, would be nice.
+    yield restart if block_given?
+  end
+end

data/test/test_restarts.rb

@@ -0,0 +1,71 @@
+# -*- ruby -*-
+require 'restarts'
+
+class RestartsTest < Test::Unit::TestCase
+
+  class ExampleError < RuntimeError
+    def initialize(a_message)
+      @message = a_message
+    end
+  end
+  
+  class Example
+    attr_reader :restart1_used, :restart2_used
+    
+    def initialize()
+      @restart1_used = false
+      @restart2_used = false
+    end
+    
+    def i_will_raise_a_condition
+      raise_with_restarts(ExampleError.new("I'm really just a condition")) do |restart_at|
+        case restart_at
+        when :restart1 then @restart1_used = true
+        when :restart2 then @restart2_used = true
+        end 
+      end
+    end
+  end
+  
+  def setup
+    @ex = Example.new
+  end
+  
+  def test_calls_raise
+    assert_raises(ExampleError) { @ex.i_will_raise_a_condition }
+  end
+  
+  def test_restart1
+    begin
+      @ex.i_will_raise_a_condition
+    rescue ExampleError
+      $!.restart.call(:restart1)
+    end
+    
+    assert @ex.restart1_used
+    assert !@ex.restart2_used
+  end
+  
+  def test_restart2
+    begin
+      @ex.i_will_raise_a_condition
+    rescue ExampleError
+      $!.restart.call(:restart2)
+    end
+    
+    assert !@ex.restart1_used
+    assert @ex.restart2_used
+  end
+  
+  def test_alternative_syntax
+    begin
+      @ex.i_will_raise_a_condition
+    rescue ExampleError
+      $!.restart(:restart1)
+    end
+    
+    assert @ex.restart1_used
+  end
+end
+
+# vim: syntax=Ruby

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: restarts
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- Archit Baweja
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-22 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: restarts.rb implements a new method Kernel#raise_condition which is similar to Kernel#raise for throwing exceptions, with the added feature of adding "restarts" next to the place where the exception is thrown so that they can be invoked from the exception handler somewhere higher up in the stack.
+email: 
+- architbaweja@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/restarts.rb
+- test/test_restarts.rb
+has_rdoc: true
+homepage: latest code is available at http://github.com/archit/restarts/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ore
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: restarts.rb implements a new method Kernel#raise_condition which is similar to Kernel#raise for throwing exceptions, with the added feature of adding "restarts" next to the place where the exception is thrown so that they can be invoked from the exception handler somewhere higher up in the stack.
+test_files: 
+- test/test_restarts.rb