callback-batch 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.5.2"
+  gem "riot", ">= 0.12.3"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    riot (0.12.5)
+      rr
+    rr (1.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (>= 1.5.2)
+  riot (>= 0.12.3)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+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,77 @@
+Callback Batch
+==============
+
+**callback-batch** provides ability to run more callbacked methods 
+of single or more objects by elegant, readable and transparent way 
+in a linear sequence, so subsequently in single batch.
+
+Two classes are available, *sequencer* and more general *batch*.
+Batch supports more objects in one batch, sequencer is syntactic
+sugar in fact for single object.
+  
+See some trivial examples:
+
+    require "callback-batch"
+    
+    class Foo
+        def foo1
+            yield :foo1
+        end
+        def foo2
+            yield :foo2
+        end
+    end
+    
+    class Bar
+        def bar1
+            yield :bar1
+        end
+        def bar2
+            yield :bar2
+        end    
+    end
+    
+    
+    ### Sequencer
+    
+    s = CallbackSequencer::new(Foo::new)
+    s.foo1
+    s.foo2
+    
+    s.execute do      # now will be both methods executed
+        p s.results   # will contain [:foo1, :foo2]
+    end
+
+    ### Batch
+
+    s = CallbackBatch::new
+    f = Foo::new
+    b = Bar::new
+    
+    s.take(f).foo1
+    s.take(b).bar2
+    
+    s.execute do      # now will be both methods executed
+        p s.results   # will contain [:foo1, :bar2]
+    end
+    
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][9] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+
+Copyright
+---------
+
+Copyright © 2011 [Martin Kozák][10]. See `LICENSE.txt` for
+further details.
+
+[9]: http://github.com/martinkozak/callback-batch/issues
+[10]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "callback-batch"
+  gem.homepage = "http://github.com/martinkozak/callback-batch"
+  gem.license = "MIT"
+  gem.summary = "Provides ability to run more callbacked methods of single or more objects by elegant, readable and transparent way in a linear sequence, so subsequently in single batch."
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/callback-batch.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "callback-batch"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Koz\u{e1}k"]
+  s.date = "2011-10-17"
+  s.email = "martinkozak@martinkozak.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "callback-batch.gemspec",
+    "lib/callback-batch.rb",
+    "test"
+  ]
+  s.homepage = "http://github.com/martinkozak/callback-batch"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Provides ability to run more callbacked methods of single or more objects by elegant, readable and transparent way in a linear sequence, so subsequently in single batch."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.5.2"])
+      s.add_development_dependency(%q<riot>, [">= 0.12.3"])
+    else
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.5.2"])
+      s.add_dependency(%q<riot>, [">= 0.12.3"])
+    end
+  else
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.5.2"])
+    s.add_dependency(%q<riot>, [">= 0.12.3"])
+  end
+end
+

data/lib/callback-batch.rb

@@ -0,0 +1,242 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net) 
+
+##
+# Sequencer for running batches upon single object.
+#
+
+class CallbackSequencer
+
+    ##
+    # Holds the batch object.
+    # @return [EM::Batch]
+    # 
+    
+    attr_accessor :batch
+    @batch
+
+    ##
+    # Holds the target object.
+    # @return [Object]
+    #         
+    
+    attr_accessor :target
+    @target
+    
+    ##
+    # Constructor.
+    # @param [Object] target  target object
+    #
+    
+    def initialize(target)
+        @batch = CallbackBatch::new
+        @target = target
+    end
+    
+    ##
+    # Handles missing method calls. Puts them to the 
+    # processing batch.
+    #
+    # @param [Symbol] name  name of the method
+    # @param [Array] *args  arguments
+    # 
+    
+    def method_missing(name, *args)
+        @batch.put(@target, name, args)
+    end
+    
+    ##
+    # Executes the batch.
+    # @param [Proc] callback
+    #
+    
+    def execute(&callback)
+        @batch.execute(&callback)
+    end
+    
+    alias :"execute!" :execute
+    
+    ##
+    # Returns all calls results.
+    # @return [Array]
+    #
+    
+    def results
+        @batch.results
+    end
+end
+
+##
+# Batch of the objects and method names with arguments for runninng 
+# on a series.
+#
+
+class CallbackBatch
+
+    ##
+    # Holds the call stack of the ordered calls.
+    # @return [Array]  the stack
+    #
+    
+    attr_accessor :stack
+    @stack
+    
+    ##
+    # Holds array with results of all calls.
+    # @return [Array]
+    
+    attr_reader :results
+    @results
+    
+    ##
+    # Constructor.
+    #
+    
+    def initialize
+        @stack = [ ]
+        @results = [ ]
+    end
+    
+    ##
+    # Puts call order to the batch. If block given, treat arguments 
+    # as its arguments. In otherwise expects object, method name 
+    # and arguments array.
+    #
+    # @param [Array] *args  see above
+    # @param [Proc] &block see above
+    #
+    
+    def put(*args, &block)
+        if block.nil?
+            object, method, args = args
+            args = [] if args.nil?
+        else
+            object = nil
+            method = block
+        end
+            
+        @stack << [object, method, args]
+    end
+    
+    ##
+    # Wraps object by method call receiver and catches all calls
+    # including arguments to the batch.
+    # 
+    # @param [Object] target  target object
+    # @return [EM::Batch::Call]  an calls catcher
+    #
+    
+    def take(target)
+        Call::new(self, target)
+    end
+    
+    ##
+    # Executes the batch.
+    #
+    # @param [Proc] callback
+    # @yield result of last call
+    #
+
+    def execute(&callback)
+        caller = nil
+        result = nil
+    
+        iterator = Proc::new do
+            object, method, args = @stack.shift
+            if object.nil? and method.kind_of? Proc
+                method.call(*args, &caller)
+            elsif not method.nil?
+                self.schedule_call do
+                    if method == :exec
+                        object.exec(*args, &caller)
+                    else
+                        object.send(method, *args, &caller)
+                    end
+                end
+            elsif not callback.nil?
+                yield *result
+            end
+        end
+        
+        caller = Proc::new do |*res|
+            self.schedule_tick do
+                if res.length == 1
+                    result = res.first
+                else
+                    result = res
+                end
+                  
+                @results << result
+                iterator.call()
+            end
+        end
+        
+        iterator.call()
+    end
+    
+    alias :"execute!" :execute
+    
+    ##
+    # Schedules next tick execution.
+    # @yield
+    #
+    
+    def schedule_tick
+        yield
+    end
+    
+    ##
+    # Schedules next call execution.
+    # @yield
+    #
+    
+    def schedule_call
+        yield
+    end
+end
+
+##
+# Calls catcher.
+#
+
+class CallbackBatch::Call
+
+    ##
+    # Holds parent batch object.
+    # @return [EM::Batch]
+    #
+    
+    attr_reader :batch
+    @batch
+    
+    ##
+    # Holds the wrapped object.
+    # @return [Object]
+    #
+    
+    attr_accessor :target
+    @target
+    
+    ## 
+    # Constructor.
+    #
+    # @param [EM::Batch] batch  parent batch
+    # @param [Object] target  target object for wrap
+    #
+    
+    def initialize(batch, target)
+        @batch = batch
+        @target = target
+    end
+    
+    ##
+    # Missing methods catcher which puts the calls to parent batch.
+    #
+    # @param [Symbol] name  method name
+    # @param [Array] *args  method arguments list
+    #
+    
+    def method_missing(name, *args)
+        @batch.put(@target, name, args)
+    end
+end

data/test

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+$:.push("./lib")
+$:.unshift("./lib")
+
+require "callback-batch"
+require "riot"
+
+class Foo
+    def b1(&block)
+        yield :b1
+    end
+    def b2(&block)
+        yield :b2
+    end
+end
+
+context "CallbackBatch" do
+    asserts("#execute") do
+        q = CallbackBatch::new
+        f = Foo::new
+        q.take(f).b1
+        q.take(f).b2
+        q.execute!
+        
+        q.results == [:b1, :b2]
+    end
+end
+
+context "CallbackSequence" do
+    asserts("#execute") do
+        q = CallbackSequencer::new(Foo::new)
+        q.b1
+        q.b2
+        q.execute!
+        
+        q.results = [:b1, :b2]
+    end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: callback-batch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Martin Kozák
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &11537560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *11537560
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &11535840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *11535840
+- !ruby/object:Gem::Dependency
+  name: riot
+  requirement: &11514840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.3
+  type: :development
+  prerelease: false
+  version_requirements: *11514840
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- callback-batch.gemspec
+- lib/callback-batch.rb
+- test
+homepage: http://github.com/martinkozak/callback-batch
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2991511423613802839
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Provides ability to run more callbacked methods of single or more objects
+  by elegant, readable and transparent way in a linear sequence, so subsequently in
+  single batch.
+test_files: []