muscle 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Neighman
+
+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.textile

@@ -0,0 +1,47 @@
+h1. Muscle
+
+A very simple library for parallelizing slow actions.  
+Built with api access in mind, where you need to access an external service which may take a while.
+
+Within web frameworks, using muscle you can setup your api/external requests and they will be fetched in the background.
+You are free to move on with rendering output while the action is executed in the background.  Muscle will only block when
+you ask for the result of an action that has not yet completed.  This is not intended to replace a background queue system like rabbitmq or delayed-job.  The intention of muscle is that it's more for when you need to bring data in from an external source, rather than push data out.
+
+For example:
+  
+<pre><code>
+  m = Muscle.new do |m|
+    m.action(:action_name) do
+      # some slow action
+      # the result of the block is returned as the value of the action
+    end
+    
+    m.action(:another, :timeout => 1.2) do
+      # some unreliable action.
+    end
+    
+    # Setup a special timeout handler for the second action
+    # by default timeouts are set to 5 seconds
+    m.on_timeout(:another) do
+      "Sorry but :action timed out"
+    end
+  end
+</code></pre>
+
+Actions start executing as soon as they're declared, but don't block until they're accessed.
+Since no timeout handler is setup on :action_name when accessed it will raise a Timeout::Error if it has timed out.
+
+<pre><code>
+  # Get the results of a single action
+  m[:action_name] #<-- will block for the result if not yet finished
+  
+  # Iterate through all actions in declared order
+  m.each do |result|
+    # process results
+  end
+</code></pre>
+
+
+== Copyright
+
+Copyright (c) 2009 Daniel Neighman. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "muscle"
+    gem.summary = "Muscle is a simple parralellizer for slow actions"
+    gem.email = "has.sox@gmail.com"
+    gem.homepage = "http://github.com/hassox/muscle"
+    gem.authors = ["Daniel Neighman"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "muscle #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

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

data/example/api_example.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "muscle")
+require 'net/http'
+
+@m = Muscle.new do |m|
+  m.action(:github) do
+    Net::HTTP.start("github.com"){|h| h.get("/")}
+  end
+  m.action(:google) do
+    Net::HTTP.start("google.com"){|h| h.get("/")}
+  end
+end
+
+# actions are threaded and fetched in the background.  Blocking does not occur until they are accessed
+
+@m[:github] # <-- blocks until the page is loaded

data/lib/muscle.rb

@@ -0,0 +1,102 @@
+require 'timeout'
+class Muscle
+  include Enumerable
+  
+  def initialize
+    @threads, @values, @names, @timeouts = {}, {}, [], {}
+    yield self
+  end
+  
+  # Use this to declare actions for the muscle to perform
+  # 
+  # Example:
+  #
+  # m = Muscle.new do |m|
+  #   m.action(:github) do
+  #     Net::HTTP.start("github.com"){|h| h.get("/")}
+  #   end
+  #   m.action(:failblog) do
+  #     Net::HTTP.start("failblog.com"){|h| h.get("/")}
+  #   end
+  # end
+  #
+  # This will setup a muscle to fetch the page from github.com/ and failblog.com/
+  # and make them available in the muscle.  The pages are fetched in the background
+  # and will not block until you access the results of the action
+  # 
+  # options - 
+  #   +timeout+ A default timeout of 5 seconds is included.  Set this option for custom timeouts
+  # 
+  # :api: pulbic
+  def action(name = random_name, opts = {}, &block)
+    opts[:timeout] ||= 5
+    @names << name
+    @threads[name] = Thread.new{Timeout::timeout(opts[:timeout], &block)}
+    name
+  end
+  
+  # Use this to set a timeout on a given action, or on all actions
+  #
+  # Example
+  #   m.on_timeout(:foo){|name| "#{name} timed out"}
+  #   m.on_timeout(:bar){|name| "#{name} timed out"}
+  #
+  # This example sets a return value for timed out actions and replaces the exception with the
+  # results of the block.  If no timeout is set, the original timeout exception is returned.
+  #
+  # You can also mass declare on_timeout hooks to respond in the same way.
+  # The above example would compress to
+  #   m.on_timeout(:foo, :bar){|name| "#{name} timed out"}
+  #
+  # You can also setup a catch all timeout response as a fall back like this
+  # 
+  #   m.on_timeout{|name| "#{name} timed out"}
+  #
+  # You can mix and match as many on_timeout handlers as you need.  Named handlers will take precedence
+  # over the non-named handlers
+  #
+  # :api: public
+  def on_timeout(*names, &block)
+    names = [:any] if names.empty?
+    names.each do |n|
+      @timeouts[n] = block
+    end
+  end
+  
+  # Access the results of the slow action
+  # if the action is not yet completed, the process will block until it's done.
+  # 
+  # :api: public
+  def [](name)
+    return @values[name] unless @values[name].nil?
+    begin
+      if @threads[name]
+        @values[name] = @threads[name].join.value
+        @threads.delete(name)
+      end
+      @values[name]
+    rescue Timeout::Error => e
+      if to = (@timeouts[name] || @timeouts[:any])
+        to.call(name)
+      else
+        raise e
+      end
+    end
+  end
+  
+  # Iterate through the results of each action in declared order.
+  # Will block on any uncompleted action
+  #
+  # :api: public
+  def each
+    @names.each{|n| yield self[n]}
+  end
+  
+  private
+  # provides a random name to an action if one was not specified
+  def random_name
+    letters ||= ("a".."z").to_a + ("A".."Z").to_a
+    (0..15).inject(""){ |out,i| out << letters[rand(letters.length - 1)] }
+  end
+  
+end

data/muscle.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{muscle}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Neighman"]
+  s.date = %q{2009-07-18}
+  s.email = %q{has.sox@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "example/api_example.rb",
+     "lib/muscle.rb",
+     "muscle.gemspec",
+     "spec/muscle_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/hassox/muscle}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Muscle is a simple parralellizer for slow actions}
+  s.test_files = [
+    "spec/muscle_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/muscle_spec.rb

@@ -0,0 +1,95 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'net/http'
+
+describe "Muscle" do
+  
+  it "should allow me to setup many calls in threads" do
+    start_time =  Time.now.to_f
+    m = Muscle.new do |m|
+      m.action(:foo) do 
+        sleep 1
+        :foo
+      end
+      m.action(:bar) do
+        0.5
+        :bar
+      end
+      m.action(:baz) do
+        sleep 1
+        :baz
+      end
+    end # Muscle.new
+    end_time = Time.now.to_f
+    (end_time - start_time).should < 1.2
+    
+    m[:foo].should == :foo
+    m[:bar].should == :bar
+    m[:baz].should == :baz
+  end
+  
+  it "should walk through the output of the actions in declared order" do
+    m = Muscle.new do |m|
+      m.action(:foo) do
+        sleep 0.25
+        :foo
+      end
+      m.action(:bar) do
+        sleep 0.1
+        :bar
+      end
+      m.action do
+        :unamed
+      end
+    end #{ Muscle
+    m.map{|f| f}.should == [:foo, :bar, :unamed]
+  end
+  
+  it "should allow me to set a timeout on a particular action" do
+    m = Muscle.new do |m|
+      m.action(:foo, :timeout => 0.1) do
+        sleep 2
+      end
+    end
+    lambda do 
+      m[:foo]
+    end.should raise_error(Timeout::Error)
+  end
+  
+  it "should allow me to set a timeout result" do
+    m = Muscle.new do |m|
+      m.action(:foo, :timeout => 0.1) do
+        sleep 2
+      end
+
+      m.on_timeout(:foo) do |name|
+        "#{name.inspect} Timed Out"
+      end 
+    end # Muscle
+    m[:foo].should == ":foo Timed Out"
+  end
+  
+  it "Should allow me to setup a catch all timeout" do
+    m = Muscle.new do |m|
+      m.action(:foo, :timeout => 0.1){sleep 2}
+      m.action(:bar, :timeout => 0.1){sleep 2}
+      m.on_timeout do |name|
+        "#{name.inspect} timed out"
+      end
+    end # Muscle
+    m[:foo].should == ":foo timed out"
+    m[:bar].should == ":bar timed out"
+  end
+  
+  it "should allow me to setup an on_timeout for many actions" do
+    m = Muscle.new do |m|
+      m.action(:foo, :timeout => 0.1){sleep 2}
+      m.action(:bar, :timeout => 0.1){sleep 2}
+      m.action(:baz, :timeout => 0.1){sleep 2}
+      m.on_timeout(:foo, :baz){|n| "Special: #{n.inspect} timed out"}
+      m.on_timeout{|n| "Plain: #{n.inspect} timed out"}
+    end # Muscle
+    m[:foo].should == "Special: :foo timed out"
+    m[:baz].should == "Special: :baz timed out"
+    m[:bar].should == "Plain: :bar timed out"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'spec'
+
+# $LOAD_PATH.unshift(File.dirname(__FILE__))
+# $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'muscle')
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: muscle
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Neighman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-18 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: 
+email: has.sox@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- example/api_example.rb
+- lib/muscle.rb
+- muscle.gemspec
+- spec/muscle_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hassox/muscle
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Muscle is a simple parralellizer for slow actions
+test_files: 
+- spec/muscle_spec.rb
+- spec/spec_helper.rb