multi_block 1.0 → 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5e8f01ab709dd3be84548791a9b7b67e43bd350
+  data.tar.gz: 2137ce5ca59fb9fbdcd9eefc303998e1bda61071
+SHA512:
+  metadata.gz: 38d32e968578403ca6f2bdf1e0dfde082d589a4d0d755b4e0febed43c61deec346521f5af7ad66f4d1504a87ac603781b6affcfea8b2d430e27dffa3155892fe
+  data.tar.gz: 6b75186f120a1008aeb5ade1aafb374264d8e046d7e64fa905e937b261c516f9325ad00a75e9457b818e09cfbf122b9e636783c4b4fe463a7f03dc9e6a0bf9a9

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+rvm:
+- ruby-head
+- 2.2.1
+- 2.2.0
+- 2.1.5
+- 2.1.4
+- 2.1.3
+- 2.1.2
+- 2.1.1
+- 2.1.0
+- 2.0.0
+- rbx-2
+- jruby-head
+- jruby-9000
+

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+== 1.1.0 (master)
+* Updates for 2015 Rubies, drop support for Ruby 1
+* Simplify activating Array extension via: require 'multi_block/array'
+
+== 1.0.0
+* Initial Release

data/{LICENSE.txt → MIT-LICENSE.txt}

@@ -1,6 +1,6 @@
 The MIT LICENSE
 
-Copyright (c) 2011 Jan Lelis
+Copyright (c) 2011, 2015 Jan Lelis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,38 +1,19 @@
-= MultiBlock
+= MultiBlock {<img src="https://badge.fury.io/rb/multi_block.svg" />}[http://badge.fury.io/rb/multi_block] {<img src="https://travis-ci.org/janlelis/multi_block.png" />}[https://travis-ci.org/janlelis/multi_block]
 
-MultiBlock is a mini framework for passing multiple blocks to methods. It uses "named procs" to accomplish this in a nice way. The receiving method can either yield all blocks, or just call specific ones, identified by order or name.
+MultiBlock is a mini framework for passing multiple blocks to methods. It uses {named procs}[https://github.com/janlelis/named_proc] to accomplish this with a simple syntax. The receiving method can either yield all blocks, or just call specific ones, identified by order or name.
 
-These gem was build during a codebrawl contest. You might also take a look at the other entries: http://codebrawl.com/contests/methods-taking-multiple-blocks
 
 == Setup
 
-    gem install multi_block
+Add to Gemfile:
 
-== Named Procs
-A named proc acts like a normal proc, but has got a name attribute. You can create it by calling a method with the desired name on +proc+:
+    gem 'multi_block'
 
-    >> a = proc.even?{ |e| e.even? }
-    => #<NamedProc:0x00000001ffc340@(irb):1>
-    >> a.name
-    => :even?
-    >> a[42]
-    => false
 
-In the same way, you can create lambdas:
-
-    >> b = lambda.doubler{ |e| e * 2 }
-    => #<NamedProc:0x000000020685e0@(irb):7 (lambda)>
-    >> b.name
-    => :doubler
-    >> b[21]
-    => 42
-    >> b.lambda?
-    => true
-
-== MultiBlock Usage
+== Usage
 === Defining methods that use multiple blocks
 
-The first argument given to yield always defines the desired block(s). The other arguments get directly passed to the block(s). So these are example calls to the block:
+The first argument given to yield always defines the desired block(s). The other arguments get directly passed to the block(s):
 
     yield                                            # calls all given procs without args
     yield :success                                   # calls :success proc without args
@@ -43,26 +24,31 @@ The first argument given to yield always defines the desired block(s). The other
     yield success: "Code Brawl!",                    # calls each keyed proc,
           error:   [500, "Internal Brawl Error"]     #       values are the args
 
+
+=== Calling methods with multiple blocks
+
 Consider these two example methods:
 
+    # calls the :success block if everything worked well
     def ajax
-      yield rand(6) != 0 ? :success : :error # calls the :success block if everything worked well
+      yield rand(6) != 0 ? :success : :error
     end
 
+    # calls the n-th block
     def dice
       random_number = rand(6)
-      yield random_number, random_number + 1 # calls the n-th block
+      yield random_number, random_number + 1
     end
 
-=== Calling methods with multiple blocks
 
-It's done by calling the +blocks+ helper method:
+Multiple blocks can be passed using +blocks+:
 
     ajax &blocks[
-      proc.success do puts "Yeah!" end,
-      proc.error   do puts "Error..." end,
+      proc.success{ puts "Yeah!"    },
+      proc.error  { puts "Error..." },
     ]
 
+
 The dice method could, for example, be called in this way:
 
     dice &blocks[
@@ -74,22 +60,24 @@ The dice method could, for example, be called in this way:
       proc{ rand(42) != 0 ? ":)"  : ":D"},
     ]
 
+
 == Bonus sugar: Array extension
 
-If you like the slim <tt>&to_proc</tt> operator, you can further optimize the syntax by calling:
+If you like the slim <tt>&to_proc</tt> operator, you can further optimize the syntax by activating the core extension for array:
 
-    Array.send :include, MultiBlock::Array
+    require 'multi_block/array'
 
-Now, it's getting real hot:
+Now you do not need the +blocks+ helper anymore. Instead just do:
 
     do_something, some_argument, &[
-      proc.easy_way do
+      proc.easy_way{
         # do it the easy way
-      end,
-      
-      proc.complex_way do
+      },
+      proc.complex_way{
         # use complex heuristics, etc.
-      end,
+      },
     ]
 
-== J-_-L
+
+== MIT License
+See the original gist: https://gist.github.com/4b2f5fd0b45118e46d0f

data/lib/multi_block.rb

@@ -1,74 +1,6 @@
-# encoding: utf-8
 require 'named_proc'
 
-module MultiBlock
-  # multiple block transformation method,
-  # sorry for the method length and the code dup ;)
-  def self.[](*proc_array)
-    # Create hash representation, proc_array will still get used sometimes
-    proc_hash = {}
-    proc_array.each{ |proc|
-      proc_hash[proc.name] = proc if proc.respond_to?(:name)
-    }
-    
-    # Build yielder proc
-    Proc.new{ |*proc_names_and_args|
-      if proc_names_and_args.empty? # call all procs
-        ret = proc_array.map(&:call)
-        
-        proc_array.size == 1 ? ret.first : ret
-      else
-        proc_names, *proc_args = *proc_names_and_args
-        
-        if proc_names.is_a? Hash # keys: proc_names, values: args
-          proc_names.map{ |proc_name, proc_args|
-            proc = proc_name.is_a?(Integer) ? proc_array[proc_name] : proc_hash[proc_name.to_sym]
-            proc or raise LocalJumpError, "wrong block name given (#{proc_name})"
-            
-            [proc, Array(proc_args)]
-          }.map{ |proc, proc_args|
-            proc.call(*proc_args)
-          }
-          
-        else
-          ret = Array(proc_names).map{ |proc_name|
-            proc = proc_name.is_a?(Integer) ? proc_array[proc_name] : proc_hash[proc_name.to_sym]
-            proc or raise LocalJumpError, "wrong block name given (#{proc_name})"
-            
-            [proc, Array(proc_args)]
-          }.map{ |proc, proc_args|
-            proc.call(*proc_args)
-          }
+require_relative 'multi_block/version'
+require_relative 'multi_block/implementation'
+require_relative 'multi_block/core_ext'
 
-          ret.size == 1 ? ret.first : ret
-          
-        end
-      end
-    }
-  end
-  
-  # low level mixins
-  module Object
-    private
-    
-    # to_proc helper, see README
-    def blocks
-      MultiBlock#[]
-    end
-    
-    # alias procs blocks
-    # alias b     blocks
-  end
-  
-  ::Object.send :include, ::MultiBlock::Object
-
-  # Bonus array mixin (if you want to)
-  module Array
-    # see README for an example
-    def to_proc
-      ::MultiBlock[*self]
-    end
-  end
-  
-  # ::Array.send :include, MultiBlock::Array
-end

data/lib/multi_block/array.rb

@@ -0,0 +1,3 @@
+class Array
+  include MultiBlock::Array
+end

data/lib/multi_block/core_ext.rb

@@ -0,0 +1,3 @@
+class Object
+  include MultiBlock::Object
+end

data/lib/multi_block/implementation.rb

@@ -0,0 +1,61 @@
+module MultiBlock
+  # Multiple block transformation method
+  def self.[](*proc_array)
+    # Create hash representation, proc_array will still get used sometimes
+    proc_hash = {}
+    proc_array.each{ |proc|
+      proc_hash[proc.name] = proc if proc.respond_to?(:name)
+    }
+    
+    # Build yielder proc
+    Proc.new{ |*proc_names_and_args|
+      if proc_names_and_args.empty? # call all procs
+        ret = proc_array.map(&:call)
+        
+        proc_array.size == 1 ? ret.first : ret
+      else
+        proc_names, *proc_args = *proc_names_and_args
+        
+        if proc_names.is_a? Hash # keys: proc_names, values: args
+          proc_names.map{ |proc_name, proc_args|
+            proc = proc_name.is_a?(Integer) ? proc_array[proc_name] : proc_hash[proc_name.to_sym]
+            proc or raise LocalJumpError, "wrong block name given (#{proc_name})"
+            
+            [proc, Array(proc_args)]
+          }.map{ |proc, proc_args|
+            proc.call(*proc_args)
+          }
+          
+        else
+          ret = Array(proc_names).map{ |proc_name|
+            proc = proc_name.is_a?(Integer) ? proc_array[proc_name] : proc_hash[proc_name.to_sym]
+            proc or raise LocalJumpError, "wrong block name given (#{proc_name})"
+            
+            [proc, Array(proc_args)]
+          }.map{ |proc, proc_args|
+            proc.call(*proc_args)
+          }
+
+          ret.size == 1 ? ret.first : ret
+          
+        end
+      end
+    }
+  end
+  
+  # Low level mixins
+  module Object
+    private
+    
+    def blocks
+      MultiBlock
+    end
+  end
+
+  # Optional Array mixin
+  module Array
+    def to_proc
+      ::MultiBlock[*self]
+    end 
+  end 
+end

data/lib/multi_block/version.rb

@@ -0,0 +1,3 @@
+module MultiBlock
+  VERSION = "1.1".freeze
+end

data/multi_block.gemspec

@@ -1,19 +1,20 @@
 # -*- encoding: utf-8 -*-
-require 'rubygems' unless defined? Gem
+
+require File.expand_path('../lib/multi_block/version', __FILE__)
  
 Gem::Specification.new do |s|
   s.name        = "multi_block"
-  s.version     = 1.0
+  s.version     = MultiBlock::VERSION
   s.authors     = ["Jan Lelis"]
   s.email       = "mail@janlelis.de"
-  s.homepage    = "https://gist.github.com/4b2f5fd0b45118e46d0f"
+  s.homepage    = "https://github.com/janlelis/multi_block"
   s.summary     = 'MultiBlock is a mini framework for passing multiple blocks to methods.'
   s.description = 'MultiBlock is a mini framework for passing multiple blocks to methods. It uses "named procs" to accomplish this in a nice way. The receiving method can either yield all blocks, or just call specific ones, identified by order or name. '
-  s.required_ruby_version     = '>= 1.9.2'
-  s.files = Dir.glob %w{multi_block.gemspec lib/multi_block.rb spec/multi_block_spec.rb}
-  s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
+  s.required_ruby_version = '>= 1.9.3'
+  s.files = Dir.glob %w{multi_block.gemspec lib/multi_block.rb lib/multi_block/version.rb lib/multi_block/implementation.rb lib/multi_block/core_ext.rb lib/multi_block/array.rb spec/multi_block_spec.rb}
+  s.extra_rdoc_files = ["README.rdoc", "MIT-LICENSE.txt", "CHANGELOG.rdoc", ".travis.yml"]
   s.license = 'MIT'
-  s.add_dependency 'named_proc'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rspec-core'
+  s.add_dependency 'named_proc', '~> 1.1'
+  s.add_development_dependency 'rspec', '~> 3.2'
+  s.add_development_dependency 'rake', '~> 10.4'
 end

data/spec/multi_block_spec.rb

@@ -1,83 +1,109 @@
 # encoding: utf-8
 require_relative '../lib/multi_block'
 
-describe "blocks" do
+describe "Object#blocks" do
   it "returns the MutliBlock constant (for calling [] on it)" do
-    blocks.should == MultiBlock
+    expect( blocks ).to be MultiBlock
   end
 end
 
-describe MultiBlock, "#[]" do
-  it "yield without args: calls every block and returns array of results" do
-    def null
-      yield
-    end
-  
-    null(&blocks[
-      proc{5},
-      proc{6},
-    ]).should == [5,6]
-  end
+describe "MultiBlock#[]" do
+  describe "yield without arguments" do
+    it "calls every block and returns array of results" do
+      def null
+        yield
+      end
   
-  it "yield with symbol: calls the specified proc, other args get passed" do
-    def symbol
-      yield :success, "Code Brawl!"
+      expect( null(&blocks[
+        proc{5},
+        proc{6},
+      ]) ).to eq [5,6]
     end
-    
-    symbol(&blocks[
-      proc{5},
-      proc.success{|e| e.swapcase},
-      proc.error{6},
-    ]).should == "cODE bRAWL!"
   end
-  
-  it 'yield with symbol: raises LocalJumpError if proc name is wrong' do
-    def wrong_name
-      yield :wrong, "Code Brawl!"
-    end
+
+  describe "yield with symbol" do
+    it "calls the specified proc, other args get passed" do
+      def symbol
+        yield :success, "Code Brawl!"
+      end
     
-    proc do
-      wrong_name(&blocks[
+      expect( symbol(&blocks[
         proc{5},
         proc.success{|e| e.swapcase},
         proc.error{6},
-      ])
-    end.should raise_exception(LocalJumpError)
-  end
+      ]) ).to eq "cODE bRAWL!"
+    end
   
-  it "yield with integer: calls the n-th proc, other args get passed" do
-    def integer
-      yield 2
+    it 'will raise LocalJumpError if proc name is wrong' do
+      def wrong_name
+        yield :wrong, "Code Brawl!"
+      end
+    
+      expect{
+        wrong_name(&blocks[
+          proc{5},
+          proc.success{|e| e.swapcase},
+          proc.error{6},
+        ])
+      }.to raise_exception(LocalJumpError)
     end
+  end
+
+  describe "yield with integer" do
+    it "calls the n-th proc, other args get passed" do
+      def integer
+        yield 2
+      end
     
-    integer(&blocks[
-      proc{5},
-      proc.success{|e| e.swapcase},
-      proc.error{6},
-    ]).should == 6
+      expect( integer(&blocks[
+        proc{5},
+        proc.success{|e| e.swapcase},
+        proc.error{6},
+      ]) ).to eq 6
+    end
   end
-  
-  it "yield with array: calls all procs, indentified by symbol or integer, other args get passed" do
-    def array
-      yield [:success, :error], "Code Brawl!"
+
+  describe "yield with array" do
+    it "calls all procs, indentified by symbol or integer, other args get passed" do
+      def array
+        yield [:success, :error], "Code Brawl!"
+      end
+    
+      expect( array(&blocks[
+        proc{5},
+        proc.success{|e| e.swapcase},
+        proc.error{|e| e.downcase},
+      ]) ).to eq ["cODE bRAWL!", "code brawl!"]
     end
+  end
+
+  describe "yield with hash" do
+    it "takes keys as proc names and passes values as proc args" do
+      def hash
+        yield success: "Code Brawl!", error: [500, "Internal Brawl Error"]
+      end
     
-    array(&blocks[
-      proc{5},
-      proc.success{|e| e.swapcase},
-      proc.error{|e| e.downcase},
-    ]).should == ["cODE bRAWL!", "code brawl!"]
+      expect( hash(&blocks[
+        proc{5},
+        proc.success{|e| e.swapcase},
+        proc.error{|no, msg| "Error #{no}: #{msg}"},
+      ]).sort ).to eq ["Error 500: Internal Brawl Error", "cODE bRAWL!"]
+    end
   end
-  
-  it "yield with hash: takes keys as proc names and passes values as proc args" do
-    def hash
-      yield success: "Code Brawl!", error: [500, "Internal Brawl Error"]
+end
+
+describe "Array#to_proc" do
+  it "works without blocks helper" do
+    def another_method
+      yield
     end
-    
-    hash(&blocks[
+
+    proc_array = [
       proc{5},
-      proc.success{|e| e.swapcase},
-      proc.error{|no, msg| "Error #{no}: #{msg}"},
-    ]).sort.should == ["Error 500: Internal Brawl Error", "cODE bRAWL!"]
+      proc{6},
+    ]
+    proc_array.send :extend, MultiBlock::Array
+  
+    expect( another_method(&proc_array) ).to eq [5,6]
   end
 end

metadata

@@ -1,50 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: multi_block
 version: !ruby/object:Gem::Version
-  version: '1.0'
-  prerelease: 
+  version: '1.1'
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-24 00:00:00.000000000Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: named_proc
-  requirement: &13586400 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *13586400
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13583220 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :development
   prerelease: false
-  version_requirements: *13583220
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: &13582300 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
-  version_requirements: *13582300
-description: ! 'MultiBlock is a mini framework for passing multiple blocks to methods.
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: 'MultiBlock is a mini framework for passing multiple blocks to methods.
   It uses "named procs" to accomplish this in a nice way. The receiving method can
   either yield all blocks, or just call specific ones, identified by order or name. '
 email: mail@janlelis.de
@@ -52,36 +60,43 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.rdoc
-- LICENSE.txt
+- MIT-LICENSE.txt
+- CHANGELOG.rdoc
+- ".travis.yml"
 files:
-- multi_block.gemspec
+- ".travis.yml"
+- CHANGELOG.rdoc
+- MIT-LICENSE.txt
+- README.rdoc
 - lib/multi_block.rb
+- lib/multi_block/array.rb
+- lib/multi_block/core_ext.rb
+- lib/multi_block/implementation.rb
+- lib/multi_block/version.rb
+- multi_block.gemspec
 - spec/multi_block_spec.rb
-- README.rdoc
-- LICENSE.txt
-homepage: https://gist.github.com/4b2f5fd0b45118e46d0f
+homepage: https://github.com/janlelis/multi_block
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: MultiBlock is a mini framework for passing multiple blocks to methods.
 test_files: []