asynchro 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'eventmachine'
+
+group :development do
+  gem "bundler"
+  gem "jeweler"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Scott Tadman, The Working Group Inc.
+
+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.rdoc

@@ -0,0 +1,115 @@
+= asynchro
+
+This is a set of extensions for Test::Unit::TestCase and any plain Ruby
+classes that will be operating inside the EventMachine framework.
+
+The two primary components are:
+
+* A simple tracker that can be used to organize multiple independent blocks 
+  and ensure that they are all completed before moving on.
+* A simple state machine defining tool that can be used to map out the steps
+  required to complete an operation. This is especially useful if the process
+  will vary depending on certain conditions.
+
+== State
+
+To define a state mapping, include the Asynchro::Extensions methods and
+then use the `async_state` method:
+
+    include Asynchro::Extensions
+    ran = [ ]
+    
+    async_state do
+      start do
+        ran << :start
+        state1!
+      end
+
+      state1 do
+        ran << :state1
+        state2!
+      end
+
+      state2 do
+        ran << :state2
+        state3!
+      end
+
+      state3 do
+        ran << :state3
+        finish!
+      end
+  
+      finish do
+        ran << :finish
+      end
+    end
+
+At the end of this, the `ran` array will contain a list of all the states
+which have executed, which in this example will be all of them in order.
+
+The two pre-defined states are `start` and `finish`, where the default
+behavior is to simply finish when started.
+
+To declare a state, simply name it and supply a block to execute when
+in that particular state. Generally the `start` state is defined first
+in order to provide an entry point. The `finish` state is optional.
+
+To transition to another state from within a state, call the name of
+the state with the exclamation at the end, so for `finish` then `finish!`
+would be called. Entering a state that has not been previously defined
+will result in a warning being sent to STDERR for diagnostic purposes.
+
+If this warning is undesirable, declare the state with an empty block.
+
+Be careful to avoid entering states for which there is no exit condition
+or the execution will never successfully complete.
+
+== Tracker
+
+The tracker component is used to process multiple blocks independently, yet
+confirm that they have all completed before moving on. An example is:
+
+    include Asynchro::Extensions
+    success = false
+
+    async_tracker do
+      perform do |done|
+        done.call
+      end
+
+      perform(4) do |done|
+        4.times do
+          done.call
+        end
+      end
+  
+      finish do
+        success = true
+      end
+    end
+
+The `perform` method is used to declare something that must be performed,
+and the `finish` method will be executed once all of the declared blocks
+have executed their callback.
+
+The `perform` method takes a numerical argument that indicates the number of
+times the callback must be called in order to be completed. The default is 1.
+Negative or zero values will result in undefined behavior.
+
+Just as multiple `perform` blocks can be declared, multiple `finish` blocks
+can be supplied. These will execute in order, once, upon completion.
+
+As there is no timeout, the tracker will wait for an indefinite period of
+time if something precludes one or more of the callbacks from being executed.
+This tracker is only suitable for asynchronous code that will always trigger
+a callback of some sort within an acceptable period of time.
+
+== Other Notes
+
+Additional demonstrations of these are included in the test/ directory.
+
+== Copyright
+
+Copyright (c) 2011 Scott Tadman, The Working Group Inc. See LICENSE.txt for
+further details.

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 = "asynchro"
+  gem.homepage = "http://github.com/tadman/asynchro"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby EventMachine Async Programming Toolkit}
+  gem.description = %Q{Provides a number of tools to help make developing and testing asynchronous applications more manageable.}
+  gem.email = "github@tadman.ca"
+  gem.authors = [ "Scott Tadman" ]
+
+  # Additional dependencies are defined in the Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/lib/asynchro.rb

@@ -0,0 +1,6 @@
+module Asynchro
+  autoload(:Extensions, 'asynchro/extensions')
+  autoload(:State, 'asynchro/state')
+  autoload(:TestHelper, 'asynchro/test_helper')
+  autoload(:Tracker, 'asynchro/tracker')
+end

data/test/helper.rb

@@ -0,0 +1,21 @@
+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 'test/unit'
+
+$: << File.expand_path(File.join(*%w[ .. lib ]), File.dirname(__FILE__))
+$: << File.dirname(__FILE__)
+
+require 'asynchro'
+
+class Test::Unit::TestCase
+  include Asynchro::TestHelper
+end

data/test/test_asynchro.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAsynchro < Test::Unit::TestCase
+  def test_module
+    assert Asynchro
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: asynchro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Scott Tadman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &2152536540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152536540
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152535960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152535960
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152535400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152535400
+description: Provides a number of tools to help make developing and testing asynchronous
+  applications more manageable.
+email: github@tadman.ca
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/asynchro.rb
+- test/helper.rb
+- test/test_asynchro.rb
+homepage: http://github.com/tadman/asynchro
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby EventMachine Async Programming Toolkit
+test_files: []