return_bang 1.0

data.tar.gz.sig

@@ -0,0 +1,2 @@
+9L�C��M�}
+߁Z�z��ܦ/⊢V��U�^�׭����בlRg�-�$��6���)�G(�s�i�

data/.autotest

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/autorun'
+end
+

data/History.txt

@@ -0,0 +1,5 @@
+=== 1.0 / 2011-12-20
+
+* Major enhancements
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/return_bang.rb
+lib/return_bang/everywhere.rb
+test/test_return_bang.rb

data/README.rdoc

@@ -0,0 +1,84 @@
+= return_bang
+
+home :: https://github.com/drbrain/return_bang
+rdoc :: http://docs.seattlerb.org/return_bang
+bugs :: https://github.com/drbrain/return_bang/issues
+
+== Description
+
+return_bang implements non-local exits from methods.  Use return_bang to exit
+back to a processing loop from deeply nested code, or just to confound your
+enemies *and* your friends!  What could possibly go wrong?
+
+== Features
+
+* Implements non-local exits for methods
+* Nestable
+* Named and stack-based exit points, go exactly where you need to be
+* Ignores pesky ensure blocks for when you really, really need to return
+
+== Synopsis
+
+  require 'return_bang/everywhere'
+
+  def some_method
+    deeply_nested
+    # never reached
+  end
+
+  def deeply_nested
+    return!
+  end
+
+  return_here do
+    some_method
+  end
+  # resumes here
+
+== Testimonials
+
+"you'll wind up with your cock in /dev/null somehow" -- slyphon
+
+"Haha! Right! This skips ensure… SO EVIL‼‼" -- drbrain
+
+"This is so evil that 6 def test_… have turned into: 16 tests, 65 assertions,
+18 failures, 7 errors" -- drbrain
+
+== Install
+
+  sudo gem install return_bang
+
+== Developers
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== License
+
+(The MIT License)
+
+Copyright (c) Eric Hodel
+
+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,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :minitest
+Hoe.plugin :git
+
+Hoe.spec 'return_bang' do
+  developer 'Eric Hodel', 'drbrain@segment7.net'
+
+  rdoc_locations << 'docs.seattlerb.org:/data/www/docs.seattlerb.org/return_bang/'
+
+  self.readme_file = 'README.rdoc'
+  self.extra_rdoc_files << 'README.rdoc'
+end
+
+# vim: syntax=ruby

data/lib/return_bang.rb

@@ -0,0 +1,148 @@
+begin
+  require 'continuation'
+rescue LoadError
+  # in 1.8 it's built-in
+end
+
+##
+# ReturnBang is allows you to perform non-local exits from your methods.  One
+# potential use of this is in a web framework so that a framework-provided
+# utility methods can jump directly back to the request loop.
+#
+# return_here is used to designate where execution should be resumed.  Return
+# points may be arbitrarily nested.  #return! resumes at the previous resume
+# point, #return_to returns to a named return point.
+#
+# require 'return_bang' gives you a module you may include only in your
+# application or library code.  require 'return_bang/everywhere' includes
+# ReturnBang in Object, so it is only recommended for application code use.
+#
+# Example:
+#
+#   include ReturnBang
+#
+#   def framework_loop
+#     loop do
+#       # setup code
+#
+#       return_here do
+#         user_code
+#       end
+#
+#       # resume execution here
+#     end
+#   end
+#
+#   def render_error_and_return message
+#     # generate error
+#
+#     return!
+#   end
+#
+#   def user_code
+#     user_utility_method
+#     # these lines never reached
+#     # ...
+#   end
+#
+#   def user_utility_method
+#     render_error_and_return "blah" if some_condition
+#     # these lines never reached
+#     # ...
+#   end
+
+module ReturnBang
+
+  VERSION = '1.0'
+
+  ##
+  # Raised when attempting to return! when you haven't registered a location
+  # to return to, or are trying to return to a named point that wasn't
+  # registered.
+
+  class NonLocalJumpError < StandardError
+  end
+
+  def _return_bang_names # :nodoc:
+    Thread.current[:return_bang_names] ||= {}
+  end
+
+  if {}.respond_to? :key then # 1.9
+    def _return_bang_pop # :nodoc:
+      return_point = _return_bang_stack.pop
+
+      _return_bang_names.delete _return_bang_names.key _return_bang_stack.length
+
+      return_point
+    end
+  else # 1.8
+    def _return_bang_pop # :nodoc:
+      return_point = _return_bang_stack.pop
+      value = _return_bang_stack.length
+
+      _return_bang_names.delete _return_bang_names.index value
+
+      return_point
+    end
+  end
+
+  def _return_bang_stack # :nodoc:
+    Thread.current[:return_bang_stack] ||= []
+  end
+
+  ##
+  # Returns to the last return point in the stack.  If no return points have
+  # been registered a NonLocalJumpError is raised.  +value+ is returned at the
+  # registered return point.
+
+  def return! value = nil
+    raise NonLocalJumpError, 'nowhere to return to' if
+      _return_bang_stack.empty?
+
+    _return_bang_pop.call value
+  end
+
+  ##
+  # Registers a return point to jump back to.  If a +name+ is given return_to
+  # can jump here.
+
+  def return_here name = nil
+    raise ArgumentError, "#{name} is already registered as a return point" if
+      _return_bang_names.include? name
+
+    value = callcc do |cc|
+      _return_bang_names[name] = _return_bang_stack.length if name
+      _return_bang_stack.push cc
+
+      begin
+        yield
+      ensure
+        _return_bang_pop
+      end
+    end
+
+    # here is where the magic happens
+    unwind_to = Thread.current[:unwind_to]
+
+    return! value if unwind_to and _return_bang_stack.length > unwind_to
+
+    return value
+  end
+
+  ##
+  # Returns to the return point +name+.  +value+ is returned at the registered
+  # return point.
+
+  def return_to name, value = nil
+    unwind_to = _return_bang_names.delete name
+
+    raise NonLocalJumpError, "return point :nonexistent was not set" unless
+      unwind_to
+
+    Thread.current[:unwind_to] = unwind_to
+
+    return! value
+  end
+
+end
+

data/lib/return_bang/everywhere.rb

@@ -0,0 +1,7 @@
+require 'return_bang'
+
+##
+# require 'return_bang/kernel' adds #return! to all objects
+
+include ReturnBang
+

data/test/test_return_bang.rb

@@ -0,0 +1,83 @@
+require 'minitest/autorun'
+require 'return_bang'
+
+class TestReturnBang < MiniTest::Unit::TestCase
+
+  include ReturnBang
+
+  def setup
+    @after_a = false
+    @after_e = false
+  end
+
+  def teardown
+    assert_empty _return_bang_stack
+    assert_empty _return_bang_names
+  end
+
+  def test_return_bang_no_return_here
+    e = assert_raises NonLocalJumpError do
+      return!
+    end
+
+    assert_equal 'nowhere to return to', e.message
+  end
+
+  def test_return_here
+    result = return_here do a end
+
+    refute @after_a, 'return! did not skip after_a'
+
+    assert_equal 42, result
+  end
+
+  def test_return_here_name
+    result = return_here :name do d end
+
+    refute @after_e, 'return_to did not skip after_e'
+
+    assert_equal 43, result
+  end
+
+  def test_return_here_name_no_return_bang
+    result = return_here :name do c end
+
+    assert_equal 24, result
+  end
+
+  def test_return_here_nest
+    result = return_here do
+      return_here do
+        a
+      end
+    end
+
+    refute @after_a, 'return! did not skip after_a'
+
+    assert_equal 42, result
+  end
+
+  def test_return_here_no_return_bang
+    result = return_here do c end
+
+    assert_equal 24, result
+  end
+
+  def test_return_to_no_return_here
+    e = assert_raises NonLocalJumpError do
+      return_to :nonexistent
+    end
+
+    assert_equal 'return point :nonexistent was not set', e.message
+  end
+
+  def a() b; @after_a = true end
+  def b() return! 42 end
+
+  def c() 24 end
+
+  def d() return_here do e end; @after_e = true end
+  def e() return_to :name, 43 end
+
+end
+

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: return_bang
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Eric Hodel
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
+  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
+  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
+  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
+  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
+  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
+  x52qPcexcYZR7w==
+  -----END CERTIFICATE-----
+
+date: 2011-12-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  type: :development
+  version_requirements: *id002
+description: |-
+  return_bang implements non-local exits from methods.  Use return_bang to exit
+  back to a processing loop from deeply nested code, or just to confound your
+  enemies *and* your friends!  What could possibly go wrong?
+email: 
+- drbrain@segment7.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/return_bang.rb
+- lib/return_bang/everywhere.rb
+- test/test_return_bang.rb
+- .gemtest
+homepage: https://github.com/drbrain/return_bang
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: return_bang
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: return_bang implements non-local exits from methods
+test_files: 
+- test/test_return_bang.rb

metadata.gz.sig

@@ -0,0 +1,2 @@
+`"t�TW��nW��G$��c�=gTV�=�z|
��t"�;� ��Jv�_�X2��:����,����V��|c��xD��ܫ�s�]�}F�$�E�'uJ�{���۔Y���t������
4KϞ2���E�j����u�ԕ�'�U��A��y����$��ޅ
+稼�F�
D�!
�c����9 RsJ��҇�AF�a��y�=s`O�YQ�Z�w��~�~j�otɋ[1�臼�A��[�a_�`