em-dextras 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p180@em-dextras --create

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rafael de F. Ferreira
+
+MIT License
+
+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,37 @@
+# Em::Dextras
+Utilities to help working with EventMachine Deferrables. Includes probes for
+asynchronous tests and a DSL to chain deferrables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'em-dextras'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install em-dextras
+
+## Usage
+
+Documentation is currently lacking, fixing this is our number 1 priority.
+
+The project offers:
+ * A DSL to structure asynchronous computations, inspired by [SoundCloud empipelines](https://github.com/soundcloud/empipelines)
+   and [future composition](http://code.technically.us/post/17965128229/fables-of-the-reconstruction-part-3-leibniz-saw-all)
+ * Methods to help test deferrable based code
+   - Low-level probing 
+   - Syntatic sugar as RSpec matchers
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/em-dextras.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/em-dextras/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rafael de F. Ferreira"]
+  gem.email         = ["public@rafaelferreira.net"]
+  gem.description   = %q{Utilities to help working with EventMachine deferrables.}
+  gem.summary       = %q{Utilities to help working with EventMachine Deferrables. Includes probes for asynchronous tests and a DSL to chain deferrables.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "em-dextras"
+  gem.require_paths = ["lib"]
+  gem.version       = Em::Dextras::VERSION
+
+  gem.add_runtime_dependency("eventmachine", [">= 0.12.10"])
+  gem.add_development_dependency("rspec")
+
+  gem.add_development_dependency("guard")
+  gem.add_development_dependency("guard-rspec")
+  gem.add_development_dependency("rb-inotify")
+end

data/lib/em-dextras/chains/synchronous_stage.rb

@@ -0,0 +1,14 @@
+module EMDextras::Chains::SynchronousStage
+  def invoke(input)
+    raise NotImplementedError.new("You must implement #invoke.")
+  end
+
+  def todo(input)
+    begin 
+      value = invoke(input)
+      EMDextras::Chains::Deferrables.succeeded value
+    rescue  => exception
+      EMDextras::Chains::Deferrables.failed exception
+    end
+  end
+end

data/lib/em-dextras/chains.rb

@@ -0,0 +1,78 @@
+module EMDextras
+  module Chains
+    module Deferrables
+      def self.succeeded(*args)
+        deferrable = EventMachine::DefaultDeferrable.new
+        deferrable.succeed(*args)
+        deferrable
+      end
+      def self.failed(*args)
+        deferrable = EventMachine::DefaultDeferrable.new
+        deferrable.fail(*args)
+        deferrable
+      end
+    end
+
+    PipeSetup = Struct.new(:monitoring, :options) do
+      def inform_exception!(error_value, stage)
+        self.monitoring.inform_exception! error_value, stage
+      end
+    end
+
+    def self.pipe(zero, monitoring, stages, options = {})
+      run_chain zero, stages, PipeSetup.new(monitoring, options)
+    end
+
+    def self.run_chain input, stages, pipe_setup
+      return if stages.empty?
+
+      stage, *rest = *stages
+
+      puts "Running #{stage}(#{input})" if pipe_setup.options[:debug]
+
+      if stage == :split
+        split_chain(input, rest, pipe_setup)
+        return
+      end
+
+
+      deferrable = call(stage, input, pipe_setup)
+      deferrable.callback do |value|
+        run_chain value, rest, pipe_setup
+      end
+      deferrable.errback do |error_value|
+        pipe_setup.inform_exception! error_value, stage
+      end
+    end
+
+    private
+    def self.split_chain input, rest, pipe_setup
+      new_options = pipe_setup.options.clone
+
+      context = new_options[:context]
+      if context && context.respond_to?(:split)
+        new_options[:context] = context.split 
+      end
+
+      new_pipe_setup =  PipeSetup.new(pipe_setup.monitoring, new_options)
+
+      unless input.respond_to? :each
+        pipe_setup.inform_exception! ArgumentError.new(":split stage expects enumerable input. \"#{input}\" is not enumerable."), :split
+        return
+      end
+      input.each do |value|
+        run_chain value, rest, new_pipe_setup
+      end
+    end
+
+    def self.call(stage, input, pipe_setup)
+      todo_method = stage.method(:todo)
+      case todo_method.arity
+      when 1
+        stage.todo(input)
+      when 2
+        stage.todo(input, pipe_setup.options[:context])
+      end
+    end
+  end
+end

data/lib/em-dextras/spec/event_machine_probes.rb

@@ -0,0 +1,66 @@
+
+# Receives two blocks as options: :action and :check.
+# The :action block should trigger an asynchronous operation, or in other words,
+# it should take a callback block as a parameter.
+# If the :action block is not given, a default action
+# is provided, that simply schedules the callback to
+# be run on the next tick of the event machine.
+#
+# The :check block should verify some desired property (it should indicate
+# a failed verification by throwing an exception). The :check block will be
+# called from the callback given to :action. One way to think about it is that
+# the :check block is what you'd directly pass as a callback to the action block
+# were it not for the need to probe periodically.
+#
+# If the verification done by the :check block succeeds, this method will stop
+# EventMachine and return normally. If the verification fails, it will retry after
+# an interval (configurable via the :interval option). This will happen until
+# a timeout expires (configurable via the :timeout option, in seconds), in
+# which case the method will raise the verification exception
+def probe_event_machine(options)
+  action = options[:action] || forwarding_action
+  check = options[:check]
+  timeout = options[:timeout] || 5
+  interval = options[:interval] || 0.2
+  debug = !!options[:debug]
+
+  probe_start_time = Time.new
+
+  exceptions = []
+  code = Proc.new do |arguments|
+    begin
+      puts "call to check" if debug
+      check.call(arguments)
+      puts "check succeeded, will stop event loop" if debug
+      EM.stop_event_loop
+    rescue Exception => exception
+      puts "check failed" if debug
+      exceptions << exception
+      if (Time.now - probe_start_time) < timeout
+        puts "will retry action after #{interval} seconds" if debug
+        EM.add_timer(interval) do
+          puts "retrying action" if debug
+          action.call(code)
+        end
+      else
+        puts "timeout exceeded. stop trying" if debug
+        EM.stop_event_loop
+        raise MultipleExceptions, "Exceptions while probing:\n\t#{exceptions.map(&:message).uniq.join(";\nand exception:\t")}"
+      end
+    end
+  end
+
+  puts "initial call to action" if debug
+  action.call(code)
+end
+
+
+class MultipleExceptions < RuntimeError
+end
+
+def forwarding_action
+  return Proc.new {|callback|
+    EM.next_tick Proc.new { callback.call([])}
+  }
+end 
+

data/lib/em-dextras/spec/spec_matchers.rb

@@ -0,0 +1,73 @@
+if defined?(RSpec)
+  RSpec::Matchers.define :succeed_with do |expected|
+    match_unless_raises Exception do |actual_deferred|
+      resolved_value = nil
+      actual_deferred.callback do |value|
+        resolved_value = value
+      end
+      actual_deferred.errback do |error|
+        if error.is_a? Exception
+          raise error
+        else
+          raise "Callback error: #{error.inspect}"
+        end
+      end
+
+      probe_event_machine :check => (lambda do |ignored|
+        resolved_value.should == expected
+      end), :timeout => 1
+    end
+  end
+
+  RSpec::Matchers.define :be_successful do |expected|
+    match_unless_raises Exception do |actual_deferred|
+      done = false
+      actual_deferred.callback do
+        done = true
+      end
+      actual_deferred.errback do |error|
+        if error.is_a? Exception
+          raise error
+        else
+          raise "Callback error: #{error.inspect}"
+        end
+      end
+
+      probe_event_machine :check => (lambda do |ignored|
+        done
+      end), :timeout => 1
+    end
+  end
+
+  RSpec::Matchers.define :be_a_failure do |expected|
+    match_unless_raises Exception do |actual_deferred|
+      done = false
+      actual_deferred.callback do
+        raise "Expected error but was success"
+      end
+      actual_deferred.errback do |error|
+        done = true
+      end
+
+      probe_event_machine :check => (lambda do |ignored|
+        done
+      end), :timeout => 1
+    end
+  end
+
+  RSpec::Matchers.define :fail_with do |expected|
+    match_unless_raises Exception do |actual_deferred|
+      resolved_value = nil
+      actual_deferred.errback do |value|
+        resolved_value = value
+      end
+      actual_deferred.callback do |error|
+        raise "Should have failed, but succedded with #{error}"
+      end
+
+      probe_event_machine :check => (lambda do |ignored|
+        resolved_value.should == expected
+      end), :timeout => 1
+    end
+  end
+end

data/lib/em-dextras/spec/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Tyrrell
+  VERSION = '0.0.7'
+end

data/lib/em-dextras/spec.rb

@@ -0,0 +1,10 @@
+require "em-dextras/spec/event_machine_probes"
+require "em-dextras/spec/spec_matchers.rb"
+
+require "eventmachine"
+
+module EMDextras
+  module Spec
+    # Your code goes here...
+  end
+end

data/lib/em-dextras/version.rb

@@ -0,0 +1,5 @@
+module Em
+  module Dextras
+    VERSION = "0.0.1"
+  end
+end

data/lib/em-dextras.rb

@@ -0,0 +1,10 @@
+require "em-dextras/version"
+
+require "em-dextras/chains"
+require "em-dextras/chains/synchronous_stage"
+
+require "eventmachine"
+
+module EMDextras
+  # Your code goes here...
+end

data/spec/em-dextras/chains/synchronous_stage_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path('spec/spec_helper')
+
+describe EMDextras::Chains::SynchronousStage do
+  class PasstroughSynchronousStage
+    include EMDextras::Chains::SynchronousStage
+    def invoke(input)
+      "Got #{input}"
+    end
+  end
+
+  class FailingSynchronousStage
+    include EMDextras::Chains::SynchronousStage
+    def invoke(input_exception)
+      raise input_exception
+    end
+  end
+
+  context "success:" do 
+    subject { PasstroughSynchronousStage.new }
+
+    it "should pass the return value of the invoke method to the next stage" do
+      EM.run do 
+        deferred = subject.todo "the input"
+        deferred.should succeed_with "Got the input"
+      end
+    end
+  end
+
+  context "failure:" do
+    subject { FailingSynchronousStage.new }
+
+    it "should return a failed deferred" do
+      EM.run do
+        exception = ArgumentError.new "an exception"
+        deferred = subject.todo exception
+        deferred.should fail_with exception
+      end
+    end
+  end
+end

data/spec/em-dextras/chains_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe EMDextras::Chains do 
+  class ProduceStage
+    def initialize(result)
+      @result = result
+    end
+
+    def todo(ignored_input)
+      EMDextras::Chains::Deferrables.succeeded @result
+    end
+  end
+
+  class SpyStage
+    def initialize(inputs)
+      @inputs = inputs
+    end
+
+    def todo(input)
+      @inputs << input
+      EMDextras::Chains::Deferrables.succeeded input
+    end
+  end
+
+  class ErrorStage
+    def todo(input)
+      EMDextras::Chains::Deferrables.failed "Failed with #{input}"
+    end
+  end
+
+  class StopStage
+    def todo(input)
+      EM.stop
+      EMDextras::Chains::Deferrables.succeeded input
+    end
+  end
+
+  class ContextualStage
+    attr :context
+    def todo(input, context)
+      @context = context
+      EMDextras::Chains::Deferrables.succeeded input
+    end
+  end
+
+  let(:monitoring) { mock.as_null_object }
+  
+  it "should chain todo stages" do
+    EM.run do 
+      inputs = []
+
+      EMDextras::Chains.pipe("input", monitoring, [
+        SpyStage.new(inputs),
+        SpyStage.new(inputs),
+        StopStage.new
+      ])
+
+      inputs.should == ["input", "input"]
+    end
+  end
+
+  it "should notify monitoring of any exceptions" do
+    EM.run do
+      monitoring.should_receive(:inform_exception!) do 
+        EM.stop
+      end
+
+      EM.add_timer(2) do
+        fail("timeout")
+      end
+
+      EMDextras::Chains.pipe("anything", monitoring, [ErrorStage.new]);
+    end
+  end
+
+  it "should pass a 'context' object if given and the stage takes one" do
+    contextual_stage = ContextualStage.new
+    
+    EM.run do 
+      EMDextras::Chains.pipe("anything", monitoring, [
+        contextual_stage,
+        StopStage.new
+      ], :context => "the context")
+
+      probe_event_machine :check => lambda {|x|
+        contextual_stage.context.should == "the context"
+      }
+    end
+  end
+
+  context "when given a :split stage" do 
+    context "and the input is enumberable" do
+      it "should invoke the next step the given number of times" do
+        EM.run do
+          final_inputs = []
+
+          EMDextras::Chains.pipe("anything", monitoring, [
+            ProduceStage.new([1,2,3]),
+            :split,
+            SpyStage.new(final_inputs),
+            StopStage.new
+          ])
+
+          final_inputs.should =~ [1,2,3]
+        end
+      end
+
+      it "should split the given context" do
+        before = ContextualStage.new
+        after = ContextualStage.new
+
+        first_context  = double("first context")
+        second_context = double("second context")
+
+        first_context.stub(:split).and_return second_context
+
+        EM.run do 
+          EMDextras::Chains.pipe("anything", monitoring, [
+            before,
+            ProduceStage.new([1,2]),
+            :split,
+            after
+          ], :context => first_context)
+
+          probe_event_machine :check => lambda {|x|
+            before.context.should == first_context
+            after.context.should == second_context
+          }
+        end
+      end
+    end
+
+    context "and the input is not enumberable" do
+      it "will terminate the chain and report the error as an exception" do
+        EM.run do 
+          monitoring.should_receive(:inform_exception!) do 
+            EM.stop
+          end
+
+          EM.add_timer(2) do
+            fail("timeout")
+          end
+
+          EMDextras::Chains.pipe("anything", monitoring, [
+            ProduceStage.new(:not_enumberable_input),
+            :split,
+            SpyStage.new([]),
+            StopStage.new
+          ])
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require './lib/em-dextras'
+
+require 'em-dextras/spec'

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: em-dextras
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rafael de F. Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.10
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Utilities to help working with EventMachine deferrables.
+email:
+- public@rafaelferreira.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- em-dextras.gemspec
+- lib/em-dextras.rb
+- lib/em-dextras/chains.rb
+- lib/em-dextras/chains/synchronous_stage.rb
+- lib/em-dextras/spec.rb
+- lib/em-dextras/spec/event_machine_probes.rb
+- lib/em-dextras/spec/spec_matchers.rb
+- lib/em-dextras/spec/version.rb
+- lib/em-dextras/version.rb
+- spec/em-dextras/chains/synchronous_stage_spec.rb
+- spec/em-dextras/chains_spec.rb
+- spec/spec_helper
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Utilities to help working with EventMachine Deferrables. Includes probes
+  for asynchronous tests and a DSL to chain deferrables.
+test_files:
+- spec/em-dextras/chains/synchronous_stage_spec.rb
+- spec/em-dextras/chains_spec.rb
+- spec/spec_helper
+- spec/spec_helper.rb