em-sequence 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+   gem "hash-utils", ">= 0.10.0"
+   gem "eventmachine", ">= 0.12.10"
+
+# 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"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    eventmachine (0.12.10)
+    git (1.2.5)
+    hash-utils (0.10.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  eventmachine (>= 0.12.10)
+  hash-utils (>= 0.10.0)
+  jeweler (~> 1.5.2)

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,89 @@
+EventMachine Sequencer
+======================
+
+**em-sequence** provides third approach to [EventMachine][4] lightweight 
+concurrency. Runs declared methods and blocks in sequence, each in one 
+tick. So allows calls chaining with keeping the EventMachine multiplexing 
+facility on. 
+
+See an example. For first, define some (of sure, slightly non-sense) calculator class:
+
+    class Calculator
+        def some_method(var, &block)
+            block.call(1, var)
+        end
+        
+        def other_method(x, y, &block)
+            block.call(x + y)
+        end
+        
+        def another_method(z, &block)
+            block.call(z ** 2)
+        end
+    end
+
+And then declare and run multiplexed code:
+
+    EM::run do
+        EM::Sequence::new(Calculator::new).declare {
+        
+            # variable declaration
+            variable :var, 3
+     
+            # method call declaration
+            some_method(:var) { [:x, :y] }              #   | TICK 1
+                                                        #   V
+            # inline block declaration and definition
+            block(:x, :y) do |x, y|                     #   | TICK 2
+                {:x => x + 1, :y => y + 1}              #   |
+            end                                         #   V
+     
+            # some other methods
+            other_method(:x, :y) { :x }                 #   V TICK 3
+            another_method(:x)                          #   V TICK 4
+            
+        }.run! do |result|                              #   | TICK 5
+            puts result.inspect                         #   |
+        end                                             #   V
+    end
+
+It will print out the number `36`. It's the same as linear 
+non-multiplexed (and non-callbacked calculator):
+
+    # variable declaration                              #   | TICK 1
+    calc = Calculator::new                              #   |
+    var = 3                                             #   |
+                                                        #   |
+    # method call declaration                           #   |
+    x, y = calc.some_method(var)                        #   |
+                                                        #   |
+    # inline block declaration and definition           #   |
+    x += 1                                              #   |
+    y += 1                                              #   |
+                                                        #   |
+    # some other methods                                #   |
+    x = calc.other_method(x, y)                         #   |
+    result = calc.another_method(x)                     #   |
+                                                        #   |
+    puts result.inspect                                 #   V
+    
+    
+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][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+Copyright
+---------
+
+Copyright © 2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[2]: http://github.com/martinkozak/em-sequence/issues
+[3]: http://www.martinkozak.net/
+[4]: http://rubyeventmachine.com/

data/Rakefile

@@ -0,0 +1,37 @@
+# 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 = "em-sequence"
+  gem.homepage = "https://github.com/martinkozak/em-sequence"
+  gem.license = "MIT"
+  gem.summary = "Third approach to EventMachine lightweight concurrency. Runs declared methods and blocks in sequence, each in one tick. So allows calls chaining with keeping the EventMachine multiplexing facility on."
+  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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "qrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/em-sequence.gemspec

@@ -0,0 +1,59 @@
+# 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 = %q{em-sequence}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Kozák"]
+  s.date = %q{2011-02-23}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "em-sequence.gemspec",
+    "lib/em-sequence.rb",
+    "lib/em-sequence/block.rb",
+    "lib/em-sequence/method.rb",
+    "test.rb"
+  ]
+  s.homepage = %q{https://github.com/martinkozak/em-sequence}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Third approach to EventMachine lightweight concurrency. Runs declared methods and blocks in sequence, each in one tick. So allows calls chaining with keeping the EventMachine multiplexing facility on.}
+
+  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_runtime_dependency(%q<hash-utils>, [">= 0.10.0"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<hash-utils>, [">= 0.10.0"])
+      s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<hash-utils>, [">= 0.10.0"])
+    s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/lib/em-sequence.rb

@@ -0,0 +1,167 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák
+
+require 'eventmachine'
+require 'hash-utils/hash'
+require 'em-sequence/block'
+require 'em-sequence/method'
+
+##
+# Main EventMachine module.
+# @see
+#
+
+module EM
+
+    ##
+    # EventMachine sequence runner.
+    #
+    
+    class Sequence
+    
+        ##
+        # Holds target instance of the sequencer.
+        # @return [Object]
+        #
+
+        attr_accessor :target
+        @target
+        
+        ##
+        # Holds required calls stack. (So in fact sequence itself.)
+        # @return [Array]
+        #
+        
+        attr_accessor :stack
+        @stack
+        
+        ##
+        # Holds array of variables available and defined during
+        # sequence run.
+        #
+        # @return [Hash]
+        #
+        
+        attr_accessor :vars
+        @vars
+        
+        ##
+        # Returns last run sequence item result.
+        # @return Object
+        #
+        
+        attr_accessor :last
+        @last
+        
+        ##
+        # Constructor.
+        # @param [Object] target target instance for the sequence
+        
+        def initialize(target)
+            @target = target
+            @stack = [ ]
+            @vars = { }
+        end
+        
+        ##
+        # Handles method definitions in sequence declaration.
+        #
+        # @param [Symbol] name method name
+        # @param [Array] args input variables specification
+        # @param [Proc] block block which should return array of 
+        #   returned variables names
+        #
+        
+        def method_missing(name, *args, &block)
+            @stack << Method::new(@target, name, args, block)
+        end
+        
+        ##
+        # Receives the sequence declaration.
+        #
+        # @example
+        #   bar.declare do
+        #
+        #       # variable declaration
+        #       variable :var, 3
+        #
+        #       # method call declaration
+        #       some_method(:var) { [:x, :y] }
+        #
+        #       # inline block declaration and definition
+        #       block(:x, :y) do |x, y|
+        #           {:x => x + 1, :y => y + 1}
+        #       end
+        #
+        #       # some other methods
+        #       other_method(:x, :y) { :x }
+        #       another_method(:x)
+        #
+        #   end 
+        #
+        # @param [Proc] block sequence declaration
+        # @return [Sequence] itself
+        #
+        
+        def declare(&block)
+            self.instance_eval(&block)
+            return self
+        end
+        
+        alias :decl :declare
+        
+        ##
+        # Declares variable.
+        #
+        # @param [Symbol] name name of the variable
+        # @param [Object] value value of the variable
+        #
+        
+        def variable(name, value)
+            @vars[name] = value
+        end
+        
+        alias :var :variable
+        
+        ##
+        # Declares block.
+        #
+        # Given block must return Hash with variable names and values.
+        # If block is last item of the sequence, return value will be
+        # used as return value of the sequence.
+        #
+        # @param [Array] args array of arguments
+        # @param [Proc] block body of block
+        
+        def block(*args, &block)
+            @stack << Block::new(block, args)
+        end
+        
+        alias :b :block
+        alias :blk :block
+        
+        ##
+        # Runs the sequence.
+        #
+        # @param [Proc] callback callback for giving back result of lat
+        #   item of the sequence
+        #
+        
+        def run!(&callback)
+            worker = Proc::new do
+                if not @stack.empty?
+                    @stack.shift.call(@vars) do |result, returning|
+                        @vars.merge! result
+                        @last = returning
+                        
+                        EM::next_tick { worker.call() }
+                    end
+                elsif not callback.nil?
+                    EM::next_tick { callback.call(@last) }
+                end
+            end
+            
+            worker.call()
+        end
+    end
+end

data/lib/em-sequence/block.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák
+
+##
+# Main EventMachine module.
+# @see
+#
+
+module EM
+    
+    ##
+    # EventMachine sequence runner.
+    #
+    
+    class Sequence
+    
+        ##
+        # Block caller sequence item.
+        #
+    
+        class Block
+        
+            ##
+            # Holds body of the block.
+            # @return [Proc]
+            #
+            
+            attr_accessor :body
+            @body
+        
+            ##
+            # Input variables specification.
+            # @return [Array]
+            #
+            
+            attr_accessor :args
+            @args
+
+            ##
+            # Constructor.
+            #
+            # @param [Proc] body body of the block
+            # @param [Array] args input variables specification
+            #
+                        
+            def initialize(body, args)
+                @body = body
+                @args = args
+            end
+            
+            ##
+            # Calls the block.
+            #
+            # @param [Hash] vars data hash with current variables state
+            # @param [Proc] block block for giving back the call result
+            #
+            
+            def call(vars, &block)
+                call_args = vars.values_at(*@args)
+                result = @body.call(*call_args)
+                block.call(result, result)
+            end
+        end
+    end
+end

data/lib/em-sequence/method.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák
+
+##
+# Main EventMachine module.
+# @see
+#
+
+module EM
+
+    ##
+    # EventMachine sequence runner.
+    #
+    
+    class Sequence
+    
+        ##
+        # Method caller sequence item.
+        #
+    
+        class Method
+        
+            ##
+            # Holds method target object.
+            # @return [Object]
+            #
+            
+            attr_accessor :target
+            @target
+            
+            ##
+            # Holds method name.
+            # @return [Symbol]
+            #
+            
+            attr_accessor :name
+            @name
+            
+            ##
+            # Input variables specification.
+            # @return [Array]
+            #
+            
+            attr_accessor :args
+            @args
+            
+            ##
+            # Block which returns returned variables specification.
+            # @return [Proc]
+            #
+            
+            attr_accessor :metablock
+            @metablock
+            
+            ##
+            # Constructor.
+            #
+            # @param [Object] target target (parent) object instance of the call
+            # @param [Symbol] name method name
+            # @param [Array] args input variables specification
+            # @param [Proc] metablock returning variables specification block
+            #
+            
+            def initialize(target, name, args, metablock)
+                @target = target
+                @name = name
+                @args = args
+                @metablock = metablock
+            end
+            
+            ##
+            # Calls the method.
+            #
+            # @param [Hash] vars data hash with current variables state
+            # @param [Proc] block block for giving back the call result
+            #
+            
+            def call(vars, &block)
+                call_args = vars.values_at(*@args)
+                @target.send(@name, *call_args) do |*returns|
+                    result = Hash::combine(self.meta, returns)
+                    block.call(result, returns.first)
+                end
+            end
+            
+            
+            protected
+            
+            ##
+            # Returns returned values metainformations from metablock.
+            #
+            
+            def meta
+                @meta = @metablock.call() \
+                    if @meta.nil? and (not @metablock.nil?)
+                @meta = [@meta] \
+                    if @meta and (not @meta.kind_of? Array)
+                @meta = [ ] \
+                    if @meta.nil?
+                
+                return @meta
+            end
+        end
+    end
+end
+

data/test.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+# (c) 2011 Martin Kozák
+
+$:.push("./lib")
+
+require 'eventmachine'
+require 'hash-utils/hash'
+require 'em-sequence'
+require 'riot'
+
+test = nil
+
+
+class Calculator
+    def some_method(var, &block)
+        block.call(1, var)
+    end
+
+    def other_method(x, y, &block)
+        block.call(x + y)
+    end
+
+    def another_method(z, &block)
+        block.call(z ** 2)
+    end
+end
+
+EM::run do
+    EM::Sequence::new(Calculator::new).declare {
+        # variable declaration
+        variable :var, 3
+
+        # method call declaration
+        some_method(:var) { [:x, :y] }              #   | TICK 1
+                                                    #   V
+        # inline block declaration and definition
+        block(:x, :y) do |x, y|                     #   | TICK 2
+            {:x => x + 1, :y => y + 1}              #   |
+        end                                         #   V
+
+        # some other methods
+        other_method(:x, :y) { :x }                 #   V TICK 3
+        another_method(:x)                          #   V TICK 4
+    }.run! do |result|
+        test = result
+        EM::stop
+    end
+end
+
+context "Sequencer" do
+    setup { test }
+    asserts("complex sequence") { topic == 36 }
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: em-sequence
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-23 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hash-utils
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+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
+- em-sequence.gemspec
+- lib/em-sequence.rb
+- lib/em-sequence/block.rb
+- lib/em-sequence/method.rb
+- test.rb
+has_rdoc: true
+homepage: https://github.com/martinkozak/em-sequence
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2904173045210286528
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Third approach to EventMachine lightweight concurrency. Runs declared methods and blocks in sequence, each in one tick. So allows calls chaining with keeping the EventMachine multiplexing facility on.
+test_files: []
+