named_return 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f252510b6986e02f0ef431ca08b045c722092bc
+  data.tar.gz: 91bf016d226be3a6ff5221212835c9e62fc39b1a
+SHA512:
+  metadata.gz: ac5b138b9d6bb2e5f8e62348367273279a13ca3dbe89cc5defa8bd05577642a171be5bf33677950d18ceee9ee0f88f980d7165da04b741102f51366a36ccde88
+  data.tar.gz: 70659daf030d1dbec058b62d713cf5ed2e77ca2c0335c676c76af6c6f914f6d5f2fd500275a6f3b47ca1224fe9705763a8372a807eecf8c9182d0556c3a8396a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in named_return.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Simon George
+
+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,41 @@
+# NamedReturn
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/named_return`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'named_return'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install named_return
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/named_return.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "named_return"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/named_return/core.rb

@@ -0,0 +1,44 @@
+require "named_return/proxy"
+
+module NamedReturn
+  # Mix in to your class to make the magic happen.
+  module Core
+    # Class methods that get extended.
+    module ClassMethods
+      # "decorator" to call before defining a method to wrap that method
+      def named_return
+        _named_return_proxy.wrap_method = true
+      end
+
+      # local configuration, e.g. `Foo.named_return_config.test = true`
+      def named_return_config
+        _named_return_proxy.config
+      end
+
+      def method_added(name)
+        _named_return_proxy.wrap self, instance_method(name)
+      end
+
+      def singleton_method_added(name)
+        _named_return_proxy.wrap self, method(name), :_singleton
+      end
+    end
+
+    class << self
+      # raw options that later get set on config
+      attr_accessor :options
+    end
+
+    # Set config options local to your class.
+    def self.[](**options)
+      clone.tap { |cls| cls.options = options }
+    end
+
+    def self.included(obj)
+      proxy = Proxy.new(options || {}) # creating a closure
+      obj.send(:define_singleton_method, :_named_return_proxy) { proxy }
+      # obj.send(:private, :_named_return_proxy)
+      obj.extend clone.const_get(:ClassMethods)
+    end
+  end
+end

data/lib/named_return/proxy.rb

@@ -0,0 +1,39 @@
+require "named_return/wrapped_method"
+
+module NamedReturn
+  # The Core mixin calls this class to wrap methods with the catch DSL.
+  class Proxy
+    attr_accessor :wrap_method, :config
+
+    def initialize(**options)
+      @config = NamedReturn.config.clone
+      options.each { |option, value| config.send(:"#{option}=", value) }
+    end
+
+    def wrap(obj, meth, singleton = nil)
+      @wrap_method ||= config.auto_wrap?(meth.name, singleton)
+      return unless @wrap_method == true # not just truthy, true for reals
+
+      @wrap_method = :overriding # this prevents infinite loops :P
+      wrapped_method = WrappedMethod.new meth, config
+      override_method(obj, wrapped_method, singleton)
+      @wrap_method = nil
+    end
+
+    private
+
+    def override_method(obj, wrapped, singleton)
+      base = self
+      obj.send(:"define#{singleton}_method", wrapped.name) do |*args, &block|
+        wrapped.reset(self)
+        # skip the magic if test mode is on
+        return wrapped.call_original(*args, &block) if base.config.test
+
+        return wrapped unless block
+
+        block.call(wrapped)
+        wrapped.call(*args)
+      end
+    end
+  end
+end

data/lib/named_return/version.rb

@@ -0,0 +1,3 @@
+module NamedReturn
+  VERSION = "0.1.0".freeze
+end

data/lib/named_return/wrapped_method.rb

@@ -0,0 +1,87 @@
+module NamedReturn
+  # Wrapper to store the original method with a DSL to catch named returns.
+  class WrappedMethod
+    attr_reader :config
+
+    # Wrap a method with catch DSL and pass in config.
+    def initialize(method, config)
+      @method = method
+      @config = config
+    end
+
+    # Get wrapped method name.
+    def name
+      @method.name
+    end
+
+    # DSL to add nested catch statements.
+    def on(label, &block)
+      @callbacks[label] = block
+    end
+
+    # Prepare for next run.
+    def reset(bind)
+      @callbacks = {}
+      @response = {}
+      bind(bind)
+    end
+
+    # Call the wrapped method with catches inserted by the DSL.
+    def call(*args, &block)
+      return_pair = recursive_catch(@callbacks.to_a, *args, &block)
+      label, value = @response.first
+      value = return_pair unless label # important swizzle for no `on` blocks
+
+      if value.is_a?(Array) && value.first == :return
+        # NB in this case `label` will be wrong (nil or outermost `catch`),
+        # so we return a value where first element is the "real" label :return
+        # and the last element is the actual value returned
+        handle_return(value.last)
+      else
+        @callbacks[label].call(value)
+      end
+    end
+
+    # Call the wrapped method directly.
+    def call_original(*args, &block)
+      @method.call(*args, &block)
+    end
+
+    private
+
+    # Ensure the wrapped method is bound to the correct instance if necessary.
+    def bind(obj)
+      return if obj.class == Class
+
+      @method = @method.unbind if @method.respond_to? :unbind
+      @method = @method.bind(obj)
+    end
+
+    def recursive_catch(callbacks, *args, &block)
+      # this return format allows returns to be "re-thrown" or raised
+      return [:return, call_original(*args, &block)] if callbacks.empty?
+
+      label, _callback = callbacks.pop
+      # the all important catch, throws zip up the stack here
+      @response[label] = catch(label) do
+        # recurse using __method__ so renaming is less brittle
+        send __method__, callbacks, *args, &block
+      end
+    end
+
+    def handle_return(value)
+      case config.return
+      when :raise
+        # there may be a better exception but ArgumentError get the point over
+        raise ArgumentError, "returned without throwing", caller(2)
+      when :throw
+        # we're not really re-throwing, just faking the behaviour ;)
+        raise UncaughtThrowError.new(:return, value), "uncaught throw :return",
+          caller(2) unless @callbacks[:return]
+        @callbacks[:return].call(value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/named_return.rb

@@ -0,0 +1,39 @@
+require "named_return/version"
+require "named_return/core"
+
+# Named return paths using throw and a DSL around catch.
+module NamedReturn
+  DefaultConfig = Struct.new(
+    # valid config options
+    *%i(return only class_only except class_except test)
+  ) do
+    # Sets defaults.
+    def initialize
+      self.return = false
+      self.only = []
+      self.class_only = []
+    end
+
+    # Should a method be wrapped by named_return?
+    def auto_wrap?(name, singleton)
+      if singleton
+        class_only.include?(name) ||
+          (class_except && !class_except.include?(name))
+      else
+        only.include?(name) || (except && !except.include?(name))
+      end
+    end
+  end
+
+  # Global configuration block.
+  def self.configure
+    @config = DefaultConfig.new
+    yield(@config) if block_given?
+    @config
+  end
+
+  # Get configuration.
+  def self.config
+    @config || configure
+  end
+end

data/named_return.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "named_return/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "named_return"
+  spec.version       = NamedReturn::VERSION
+  spec.authors       = ["Simon George"]
+  spec.email         = ["simon@sfcgeorge.co.uk"]
+
+  spec.summary       = "Named return paths using `throw` and DSL around catch"
+  spec.description   = "Named return paths using `throw` and DSL around catch"
+  spec.homepage      = "https://www.sfcgeorge.co.uk/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: named_return
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon George
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Named return paths using `throw` and DSL around catch
+email:
+- simon@sfcgeorge.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/named_return.rb
+- lib/named_return/core.rb
+- lib/named_return/proxy.rb
+- lib/named_return/version.rb
+- lib/named_return/wrapped_method.rb
+- named_return.gemspec
+homepage: https://www.sfcgeorge.co.uk/
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Named return paths using `throw` and DSL around catch
+test_files: []