dharma 0.9.0

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Eric Lindvall
+
+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,18 @@
+Dharma
+=======
+
+# Description
+
+A futures and promises library [modeled after Scala].
+
+![Dharma Initiative](http://wallpaperstock.net/lost-dharma-initiative_wallpapers_17255_1920x1440.jpg)
+
+
+# License
+
+Copyright (c) 2012 Eric Lindvall
+
+Published under the MIT License, see LICENSE
+
+
+[modeled after Scala]: http://docs.scala-lang.org/overviews/core/futures.html

data/Rakefile

@@ -0,0 +1,155 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+begin
+  require 'rake/rdoctask'
+rescue
+  require 'rdoc/task'
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/dharma.gemspec

@@ -0,0 +1,78 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'dharma'
+  s.version           = '0.9.0'
+  s.date              = '2013-05-24'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Ruby futures and promises library in the spirit of Scala"
+  s.description = "Ruby futures and promises library in the spirit of Scala"
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Eric Lindvall"]
+  s.email    = 'eric@5stops.com'
+  s.homepage = 'https://github.com/eric/dharma'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## If your gem includes any executables, list them here.
+  # s.executables = ["name"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  # s.add_dependency('DEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  # s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    dharma.gemspec
+    lib/dharma.rb
+    lib/dharma/future.rb
+    lib/dharma/inline_executor.rb
+    lib/dharma/kept_promise.rb
+    lib/dharma/promise.rb
+    lib/dharma/promise_actions.rb
+    lib/dharma/thread_executor.rb
+    test/future_test.rb
+    test/promise_actions_test.rb
+    test/promise_test.rb
+    test/test_helper.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/dharma.rb

@@ -0,0 +1,43 @@
+module Dharma
+  VERSION = '0.9.0'
+
+  class PromiseFailure < RuntimeError; end
+  class IllegalStateException < RuntimeError; end
+  class TimeoutException < RuntimeError; end
+
+  def self.default_executor
+    @default_executor ||= Dharma::ThreadExecutor.new
+  end
+
+  def self.default_executor=(executor)
+    @default_executor = executor
+  end
+
+  def self.promise
+    Dharma::Promise.new
+  end
+
+  def self.future(executor = default_executor, &work)
+    Dharma::Future.call(work, executor)
+  end
+
+  def self.sequence(promises)
+    if promises.is_a?(Array) && promises.length == 1
+      return promises.first
+    end
+
+    future do
+      promises.map { |p| p.result }
+    end
+  end
+
+  def self.trace_completion(tag, promise, logger = Rails.logger)
+    promise.on_complete do |value, as|
+      logger.info "#{tag}: #{as}: #{value.inspect}"
+    end
+  end
+end
+
+require 'dharma/promise'
+require 'dharma/future'
+require 'dharma/thread_executor'

data/lib/dharma/future.rb

@@ -0,0 +1,19 @@
+module Dharma
+  class Future
+    def self.call(body, executor)
+      promise = Dharma.promise
+
+      work = proc do
+        begin
+          promise.success(body.call)
+        rescue => e
+          promise.failure(e)
+        end
+      end
+
+      executor.execute(work)
+
+      promise
+    end
+  end
+end

data/lib/dharma/inline_executor.rb

@@ -0,0 +1,7 @@
+module Dharma
+  class InlineExecutor
+    def self.execute(runnable)
+      runnable.call
+    end
+  end
+end

data/lib/dharma/kept_promise.rb

@@ -0,0 +1,40 @@
+module Dharma
+  class KeptPromise
+    include Dharma::PromiseActions
+
+    def initialize(value, as)
+      @value, @as = value, as
+    end
+
+    def failure?
+      @as == :failure
+    end
+
+    def result(at_most = nil)
+      if @as == :failure
+        raise @value
+      else
+        return @value
+      end
+    end
+
+    def ready(at_most = nil)
+      return self
+    end
+
+    def value
+      @value
+    end
+
+    def completed?
+      true
+    end
+
+    def on_complete(cb = nil, &block)
+      cb ||= block
+
+      cb.call(@value, @as)
+      return
+    end
+  end
+end

data/lib/dharma/promise.rb

@@ -0,0 +1,152 @@
+require 'monitor'
+require 'dharma/promise_actions'
+require 'dharma/kept_promise'
+
+module Dharma
+  class Promise
+    include Dharma::PromiseActions
+
+    def self.successful(value)
+      KeptPromise.new(value, :success)
+    end
+
+    def self.failed(value)
+      KeptPromise.new(value, :failure)
+    end
+
+    def initialize
+      @mutex     = Monitor.new
+      @condition = @mutex.new_cond
+    end
+
+    def failure?
+      @mutex.synchronize do
+        @as == :failure
+      end
+    end
+
+    def result(at_most = nil)
+      ready(at_most)
+
+      @mutex.synchronize do
+        if @as == :failure
+          raise @value
+        else
+          return @value
+        end
+      end
+    end
+
+    def ready(at_most = nil)
+      @mutex.synchronize do
+        if @as
+          return self
+        else
+          @condition.wait(at_most ? at_most.to_f : nil)
+
+          if @as
+            return self
+          else
+            raise Dharma::TimeoutException.new("Futures timed out after [#{at_most}]")
+          end
+        end
+      end
+    end
+
+    def value
+      @mutex.synchronize do
+        if @as
+          @value
+        else
+          nil
+        end
+      end
+    end
+
+    def completed?
+      @mutex.synchronize do
+        @as != nil
+      end
+    end
+
+    def complete(value, as = nil)
+      if try_complete(value, as)
+        self
+      else
+        raise Dharma::IllegalStateException.new("Promise already completed.")
+      end
+    end
+
+    def try_complete(value, as = nil)
+      on_completed = nil
+
+      @mutex.synchronize do
+        if !@as
+          resolve_and_assign(value, as)
+
+          # Grab the value from what we stored
+          value, as = @value, @as
+
+          # Clear callbacks
+          on_completed = @on_completed
+          @on_completed = nil
+
+          # Wake everyone up
+          @condition.broadcast
+
+          # We don't need the condition anymore
+          @condition = nil
+        else
+          return false
+        end
+      end
+
+      if on_completed
+        on_completed.each { |cb| cb.call(value, as) }
+      end
+
+      return true
+    end
+
+    def on_complete(cb = nil, &block)
+      cb ||= block
+      value, as = nil
+
+      @mutex.synchronize do
+        if @as
+          value, as = @value, @as
+        else
+          (@on_completed ||= []) << cb
+          return
+        end
+      end
+
+      cb.call(value, as)
+      return
+    end
+
+    def resolve_and_assign(value, as = nil)
+      case as
+      when :failure
+        case value
+        when Exception
+          @value, @as = value, as
+        else
+          @value, @as = Dharma::PromiseFailure.new(value), as
+          @value.set_backtrace(caller)
+        end
+      when :success
+        @value, @as = value, as
+      else
+        case value
+        when LocalJumpError
+          @value, @as = value.exit_value, :success
+        when Exception
+          @value, @as = value, :failure
+        else
+          @value, @as = value, :success
+        end
+      end
+    end
+  end
+end

data/lib/dharma/promise_actions.rb

@@ -0,0 +1,75 @@
+module Dharma
+  module PromiseActions
+    def on_success(cb = nil, &block)
+      cb ||= block
+
+      on_complete do |value, as|
+        case as
+        when :success
+          cb.call(value)
+        end
+      end
+    end
+
+    def on_failure(cb = nil, &block)
+      cb ||= block
+
+      on_complete do |value, as|
+        case as
+        when :failure
+          cb.call(value)
+        end
+      end
+    end
+
+    def success(value)
+      complete(value, :success)
+    end
+
+    def failure(value)
+      complete(value, :failure)
+    end
+
+    def try_success(value)
+      try_complete(value, :success)
+    end
+
+    def try_failure(value)
+      try_complete(value, :failure)
+    end
+
+    def complete_with(other)
+      other.on_complete { |value, as| complete(value, as) }
+      self
+    end
+
+    def recover(cb = nil, &block)
+      cb ||= block
+      p = Dharma.promise
+
+      on_complete { |value| p.complete(cb.call(value)) }
+
+      p
+    end
+
+    def recover_with(cb = nil, &block)
+      cb ||= block
+      p = Dharma.promise
+
+      on_complete do |value, as|
+        case as
+        when :failure
+          begin
+            p.complete_with(cb.call(value))
+          rescue => e
+            p.failure(e)
+          end
+        else
+          p.complete(value)
+        end
+      end
+
+      p
+    end
+  end
+end

data/lib/dharma/thread_executor.rb

@@ -0,0 +1,20 @@
+module Dharma
+  class ThreadExecutor
+    def initialize
+    end
+
+    def execute(work)
+      Thread.new(work) do |work|
+        begin
+          work.call
+        rescue Exception => e
+          report_failure(e)
+        end
+      end
+    end
+
+    def report_failure(exception)
+      puts "Dharma: ThreadExecutor failure: #{exception.message} (#{exception.class})\n\t#{exception.backtrace.join("\n\t")}"
+    end
+  end
+end

data/test/future_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class FutureTest < Test::Unit::TestCase
+  def test_future
+    promise = Dharma.future() { true }
+    
+    assert promise.result
+
+    assert promise.completed?
+  end
+end

data/test/promise_actions_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class PromiseActionsTest < Test::Unit::TestCase
+  def test_on_complete_assigned_before
+    promise = Dharma.promise
+    
+    result = nil
+    
+    promise.on_complete do |value, as|
+      result = value
+    end
+    
+    promise.try_complete(1)
+    
+    assert promise.completed?
+    assert_equal 1, result
+    assert_equal 1, promise.result
+  end
+  
+  def test_on_complete_assigned_after
+    promise = Dharma.promise
+    
+    result = nil
+    
+    promise.try_complete(1)
+    
+    promise.on_complete do |value, as|
+      result = value
+    end
+    
+    assert promise.completed?
+    assert_equal 1, result
+    assert_equal 1, promise.result
+  end
+  
+  def test_on_success_callback
+    promise = Dharma.promise
+    
+    result = nil
+    
+    promise.on_success do |value|
+      result = value
+    end
+    
+    promise.try_complete(1)
+    
+    assert promise.completed?
+    assert_equal 1, result
+  end
+  
+  def try_complete_with
+    p1 = Dharma.promise
+    p2 = Dharma.promise
+    
+    p2.complete_with(p1)
+    
+    p1.complete(1)
+    
+    assert_equal 1, p2.result
+  end
+end

data/test/promise_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class PromiseTest < Test::Unit::TestCase
+  def test_new_promise_is_not_completed
+    promise = Dharma.promise
+    
+    assert !promise.completed?
+  end
+
+  def test_completed_promise_is_completed
+    promise = Dharma.promise
+    
+    assert promise.try_complete(1)
+    assert promise.completed?
+  end
+
+  def test_try_complete_twice
+    promise = Dharma.promise
+
+    assert promise.try_complete(1)
+    assert !promise.try_complete(2)
+    assert_equal 1, promise.result
+  end
+
+  def test_completing_with_an_exception
+    promise = Dharma.promise
+
+    promise.try_complete(Exception.new('broken'))
+
+    assert promise.failure?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+
+Thread.abort_on_exception = true
+
+require 'dharma'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: dharma
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Eric Lindvall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-24 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Ruby futures and promises library in the spirit of Scala
+email: eric@5stops.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dharma.gemspec
+- lib/dharma.rb
+- lib/dharma/future.rb
+- lib/dharma/inline_executor.rb
+- lib/dharma/kept_promise.rb
+- lib/dharma/promise.rb
+- lib/dharma/promise_actions.rb
+- lib/dharma/thread_executor.rb
+- test/future_test.rb
+- test/promise_actions_test.rb
+- test/promise_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/eric/dharma
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: Ruby futures and promises library in the spirit of Scala
+test_files: 
+- test/test_helper.rb