return_safe_yield 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed8c383cd016ad1fceffef1a09ca15f6ba37b25a
+  data.tar.gz: 2e47f4e4a661ac223269dd4a5f9d9b6b4ce499fa
+SHA512:
+  metadata.gz: 3cb3c7d4e6ca2dfcb8635b8c1e807bdf481a78c2f0f38b5f1f918571357da80d23e658a01571e0d507bceaf91bc5181df49bccb9e6dbe5c5a5e58454acf476cf
+  data.tar.gz: 50f386297310f2a5a3c9c6907f00f64a9f923cc094ffd13ba2234ee9d89dae328ca5e934a99cc1e5b6dc4bb2a6fd1090599f7636cae4460c552291854548b253

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,77 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+  Exclude:
+    - 'local/**/*'
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - 'target/**/*'
+    - 'log/**/*'
+    - 'db/schema.rb'
+    - 'locale/translations.rb'
+    - 'lib/scratch.rb'
+
+  DisplayCopNames: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_fail
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+
+Metrics/AbcSize:
+  Enabled: False
+
+Metrics/CyclomaticComplexity:
+  Enabled: False
+
+Metrics/PerceivedComplexity:
+  Enabled: False
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+  EnforcedStyle: compact
+  SupportedStyles:
+    - nested
+    - compact

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/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at remo.fritzsche@sitrox.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Remo Fritzsche
+
+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,161 @@
+# return_safe_yield
+
+[![Gem Version](https://badge.fury.io/rbreturn_safe_yield.svg)](https://badge.fury.io/rb/return_safe_yield)
+
+[![Build Status](https://travis-ci.org/remofritzsche/return_safe_yield.svg?branch=master)](https://travis-ci.org/remofritzsche/return_safe_yield)
+
+Provides helpers for dealing with `return` statements in blocks
+and procs by either disallowing them or else ensuring that some code
+runs after yielding
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'return_safe_yield'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install return_safe_yield
+
+## Usage
+
+### The problem
+
+Consider the following code:
+
+```ruby
+def some_method(&block)
+  puts 1
+  yield
+  puts 3
+end
+
+def test
+  some_method do
+    puts 2
+    return
+  end
+end
+
+test
+```
+
+In this case, our `return` statement exits not only the method `test`, but also
+the method `some_method`. The line `puts 3` is never called.
+
+This is standard ruby behaviour. It lies in a block's responsibility to not use
+`return` if the actual block caller does not support it.
+
+But what if you're not in control of the code that actually calls your block,
+and you don't know if it's safe to use `return`? And, on the other hand, what if
+you're writing 'black box' library code that accepts blocks or procs and does
+not handle `return`s in there well?
+
+For this reason, this Gem provides two different methods for dealing with return
+statements in blocks.
+
+Note that this implementation is a bit controversal, as there is a variety of
+skilled ruby developers thinking that the responsibility always lies with a
+block's or proc's author and no special handling should be performed. So if
+you're using this library, please make sure you absolutely need it in your case.
+
+See [this StackOverflow question](http://stackoverflow.com/questions/41100983)
+for an interesting discussion of this subject.
+
+### Handle `return` statements gracefully
+
+The first solution provided by this Gem is the method
+`ReturnSafeYield.call_then_yield`. It contains a very simple `begin ... rescue ...
+ensure` construct and can be passed two blocks. The second block is always
+executed unless the first block fails, even if the first block contains a
+`return` statement.
+
+Use it as follows:
+
+```ruby
+unknown_block = proc do
+  return
+end
+
+ReturnSafeYield.call_then_yield(unknown_block) do
+  # => This line is called even though the above block contains a `return`.
+end
+
+# => This line is still not called as the `return` statement exits the current
+#    method context.
+```
+
+You can also pass arguments to the first block:
+
+```ruby
+unknown_block = proc do |arg1, arg2|
+end
+
+ReturnSafeYield.call_then_yield(unknown_block, 'arg1 value', 'arg2 value') do
+end
+```
+
+The second block receives the first block's return value as arguments (this
+does not apply if `return` is used explicitely):
+
+```ruby
+unknown_block = proc
+  'return value'
+end
+
+ReturnSafeYield.call_then_yield(unknown_block) do |arg1|
+  arg1 == 'return value' # => true
+end
+```
+
+### Fail if block / proc contains `return`
+
+The second approach offered by this Gem is the method `safe_yield`. It makes
+sure the given block does not contain a `return` statement. If it does, an
+`ReturnSafeYield::UnexpectedReturnException` exception is thrown.
+
+Use it as follows:
+
+```ruby
+unknown_block = proc do |some_argument|
+  return
+end
+
+ReturnSafeYield.safe_yield(unknown_block, some_argument)
+# => Raises an ReturnSafeYield::UnexpectedReturnException exception
+```
+
+This is the rigorous way of handling it and its use is controversial among a
+variety of rubyists.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` 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/remofritzsche/return_safe_yield. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "return_safe_yield"
+
+# 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/return_safe_yield/version.rb

@@ -0,0 +1,3 @@
+module ReturnSafeYield
+  VERSION = "0.1.1"
+end

data/lib/return_safe_yield.rb

@@ -0,0 +1,84 @@
+require 'return_safe_yield/version'
+
+module ReturnSafeYield
+  class UnexpectedReturnException < StandardError; end
+
+  # Calls the two given blocks (`first`, then `&_second`), even if the first
+  # block contains a return. The second block receives the return value of the
+  # first block as arguments.
+  #
+  # The second block is not called if the first one raises an exception.
+  #
+  # Example:
+  #
+  #   unknown_block = proc do
+  #     return
+  #   end
+  #   ReturnSafeYield.call_then_yield(unknown_block) do
+  #     # => This line is called even though the above block contains a `return`.
+  #   end
+  #
+  #   # => This line here might not be called however as the `return` statement
+  #   #    exits the current method context.
+  #
+  # You can also pass arguments to the first block:
+  #
+  #   unknown_block = proc do |arg1, arg2|
+  #   end
+  #
+  #   ReturnSafeYield.call_then_yield(unknown_block, 'arg1 value', 'arg2 value') do
+  #   end
+  #
+  # The second block receives the first block's return value as arguments (this
+  # does not apply if `return` is used explicitely):
+  #
+  #   unknown_block = proc
+  #     'return value'
+  #   end
+  #
+  #   ReturnSafeYield.call_then_yield(unknown_block) do |arg1|
+  #     arg1 == 'return value' # => true
+  #   end
+  def self.call_then_yield(first, *args, &_second)
+    exception = false
+    first_block_result = nil
+    begin
+      first_block_result = first.call(*args)
+    rescue
+      exception = true
+      fail
+    ensure
+      yield(*first_block_result) unless exception
+    end
+  end
+
+  # Yields the given block and raises a `UnexpectedReturnException` exception if
+  # the block contained a `return` statement. Thus it is safe to assume that
+  # yielding a block in this way never jumps out of your surrounding routine.
+  #
+  # Note that you cannot pass a block using `safe_yield do`, as it does not make
+  # sense to check for `return` statements in code controlled by the caller
+  # itself.
+  #
+  # Example:
+  #
+  #   unknown_block = proc do |some_argument|
+  #     return
+  #   end
+  #
+  #   ReturnSafeYield.safe_yield(unknown_block, some_argument)
+  #   # => Raises a UnexpectedReturnException exception
+  def self.safe_yield(block, *args, &cb)
+    state = :returned
+    result = block.call(*args, &cb)
+    state = :regular
+    return result
+  rescue
+    state = :exception
+    fail
+  ensure
+    if state == :returned
+      fail UnexpectedReturnException, "Block #{block.inspect} contains a `return` which it is not supposed to."
+    end
+  end
+end

data/return_safe_yield.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'return_safe_yield/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'return_safe_yield'
+  spec.version       = ReturnSafeYield::VERSION
+  spec.authors       = ['Remo Fritzsche']
+  spec.email         = ['dev@remofritzsche.com']
+
+  spec.summary       = %(
+    Provides helpers for dealing with `return` statements in blocks and procs.'
+  ).strip
+  spec.description   = %(
+    Provides helpers for dealing with `return` statements in blocks
+    and procs by either disallowing them or else ensuring that some code
+    runs after yielding.
+  ).strip
+  spec.homepage      = 'https://github.com/remofritzsche/return_safe_yield'
+  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 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: return_safe_yield
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Remo Fritzsche
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-13 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  Provides helpers for dealing with `return` statements in blocks
+      and procs by either disallowing them or else ensuring that some code
+      runs after yielding.
+email:
+- dev@remofritzsche.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/return_safe_yield.rb
+- lib/return_safe_yield/version.rb
+- return_safe_yield.gemspec
+homepage: https://github.com/remofritzsche/return_safe_yield
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Provides helpers for dealing with `return` statements in blocks and procs.'
+test_files: []