switchblock 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d63a531ba8a7f9eb73e9a61af6f5db773bf6dad4
+  data.tar.gz: 316df4c6f8809f3c0322bf16f8d2ea3e2b4e7145
+SHA512:
+  metadata.gz: f15078869af57b8b50af31f5cfaade53c6ee2a601bd5d3051c2a743626a0cb82483681b3d31f6c0cff570f64363b13f5ca798dcc3ac137ee487e91b0c0eb56ef
+  data.tar.gz: 8852f1870c7b7e8fe1b9ff755bc570325db821b06a9285035805678ecd49c69e51fc98ae0740f145daa7826e038858ee7f4049309aa9f7cf3fa7c17b4fb28bdb

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,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,121 @@
+# Switchblock - A way to pass multiple blocks to a method
+
+Switchblock is a module mixin that adds a simple way to pass multiple blocks to methods to your classes. It does this by creating an object that acts as a switch block.
+
+## Usage
+
+First, you must ```include Switchblock``` in your class (or your program). You can now write methods that take multiple blocks using the "it_to" method like this:
+
+```ruby
+def did_we_succeed?(success)
+  if success
+    yield it_to "success"
+  else
+    yield it_to "failure"
+  end
+end
+
+did_we_succeed?(true) do |s|
+  s.success {"Yes!!"}
+  s.failure {"Aw... Bummer..."}
+end
+
+=> "Yes!!"
+```
+
+The call to it_to will give you BlockSwitcher, which will take care of the block you give to the method and execute just the subblock(s) you want.
+
+## Features
+
+As seen in the usage example, you can pass an unlimited number of subblocks to your BlockSwitcher. These will be executed if the method you call on the BlockSwitcher matches whatever name you specified in the "yield it_to" call.
+
+### Switches
+
+Switches are really simple, just make up a name and use it to call one your subblocks by yielding to it in your "yield it_to" call. The first argument to "it_to" is the name of the block you want to call. You can use anything that has a #to_sym method.
+
+```ruby
+def yield_name(name)
+  yield it_to name
+end
+
+yield_name("Larry") do |s|
+  s.larry {"Hi, Larry!}
+end
+
+=> "Hi, Larry!"
+```
+
+Instead of blocks, you can also use a proc as the argument to a switch.
+
+```ruby
+larry_greeter = lambda {"Hi, Larry"}
+
+yield_name("Larry") do |s|
+  s.larry larry_greeter
+end
+
+=> "Hi, Larry!"
+```
+
+Any additional arguments you yield after the switch name will be passed on to your subblock.
+
+```ruby
+def even_or_odd(x)
+  if x.even?
+    yield it_to "even", x
+  else
+    yield it_to "odd", x
+  end
+end
+
+even_or_odd(5) do |s|
+  s.even {|x| "#{x} is an even number" }
+  s.odd {|x| "#{x} is an odd number" }
+end
+
+=> "5 is an odd number"
+```
+
+The return value of your "yield it_to" call will be the return value of the last executed subblock. If nothing at all is executed, the whole block will return nil. It will raise an error if you use "ensure" (see below).
+
+### Special Switches
+You can use any name for your switch, but "else", "always" and "ensure" have a special meaning and are treated differently.
+
+#### always
+
+You can use "always" as often as you wish, just as normal switches, and it will always execute no matter what.
+
+#### else
+
+You should use "else" only as the last switch of your switchblock. The block you give to it will only execute if no previous block executed before. You can use this to implement default behaviour.
+
+#### ensure
+You should use "ensure" only as as the last switch of your switchblock. It will ignore all passed blocks and arguments. It makes sure that at least one of your switches was called during execution and will raise a NothingExecutedError otherwise.
+
+You can use this to protect against typos. For example, you mistype and write "yield it_to 'succes'" and you have no idea why the block passed to "s.success" in your switchblock is not executed. Using ensure will give you a nice error message in this case, telling you what should have been executed and what was actually present.
+
+Needless to say, you should probably not use "ensure" together with "always" or "else". You can though, if you are really clever (or just feel like it).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'switchblock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install switchblock
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/switchblock/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

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 "switchblock"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/switchblock.rb

@@ -0,0 +1,43 @@
+require "switchblock/version"
+require "blankslate"
+
+module Switchblock
+
+  class NothingExecutedError < Exception; end
+
+  class BlockSwitcher < BlankSlate
+
+    def initialize(called_block, args)
+      @called_block = called_block
+      @args = args
+      @ret = nil
+      @called = false
+      @callees = []
+    end
+
+    def ensure
+      raise NothingExecutedError, "Nothing got executed! Expected one of #{@callees.inspect}, but only got #{@called_block}" if not @called
+    end
+
+    def method_missing(method,*args, &block)
+      if (method.downcase == @called_block.to_sym.downcase or method == :always) or (@called == false and method == :else) then
+        @called = true
+        if args.size > 0 then
+          @ret = args.first.call(*@args)
+        else
+          @ret = block.call(*@args)
+        end
+      end
+      # For error reporting
+      @callees << method
+      @callees.uniq!
+      # Always return something meaningful
+      @ret
+    end
+  end
+
+  private
+  def it_to(called_block, *args)
+    BlockSwitcher.new(called_block, args)
+  end
+end

data/lib/switchblock/version.rb

@@ -0,0 +1,3 @@
+module Switchblock
+  VERSION = "1.0.0"
+end

data/switchblock.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'switchblock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "switchblock"
+  spec.version       = Switchblock::VERSION
+  spec.authors       = ["Roger Braun"]
+  spec.email         = ["roger@rogerbraun.net"]
+
+  spec.summary       = %q{A module that helps you pass multiple blocks to a method.}
+  spec.homepage      = "http://github.com/rogerbraun/switchblock"
+
+  spec.license       = 'GPL-3.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "blankslate"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: switchblock
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Roger Braun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blankslate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- roger@rogerbraun.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/switchblock.rb
+- lib/switchblock/version.rb
+- switchblock.gemspec
+homepage: http://github.com/rogerbraun/switchblock
+licenses:
+- GPL-3.0
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A module that helps you pass multiple blocks to a method.
+test_files: []