mr_darcy 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76e4be46dc9cdd1c3940172e1fd429cb9ca06d1e
-  data.tar.gz: c8f1944c3cf626b51599edf3337a66bc146969c6
+  metadata.gz: 5d61c338943c3f4d6e28c6cffdbe3c219d0e0786
+  data.tar.gz: 5dc024d54bee45d0c3f2b2c2dad483a8bb95b980
 SHA512:
-  metadata.gz: 37ea3db8c56a22d1f78ab6f004c06e4b4f96e98f5fb95a8824fd2adc7491c40fa957546008c8d98bfdd7899739b9d2df29e2cd48e4d51da966305dc756dc95aa
-  data.tar.gz: 3fdde3baecf7aa7fcb3a1b925084b09be2b742a405326344c83b644b9b4c21812b557ae17a3a3a0dfbdf4f8db1656dfb4ecd6016cf10c939667ad7da71dadf7e
+  metadata.gz: 158121e9b077abf2a36fe879548470fcc8338ed50aeff01ccea68b607f470d03cb24d06fdbf7a2167a904531f28f0349e761be2e6dfcef6490180acf4e57f348
+  data.tar.gz: 8daa06f36f9f7a867098adb3a89cb20cd1833157ce457aac38ff61eb81f6d5f264a9cdc862b667ce7c8e5a61284628c06401a63eb9d91ec8ca9dbb907ea818ca

data/README.md

@@ -156,6 +156,24 @@ doing async ruby:
      end
      ```
 
+#### Promise collections
+
+If you have a bunch of promises, and you'd like to know when they're all
+complete then you can use the `MrDarcy.all_promises` method:
+
+```ruby
+MrDarcy.all_promises do
+  10.times.map { |i| MrDarcy.promise { sleep 1; resolve i } }
+end.then do |values|
+  puts "All done."
+end
+```
+
+In the above example, all 10 promises will execute simultaneously, the message
+`All done.` will be printed to standard out, after approximately one second.
+
+It will also reject as soon as the first promise rejects.
+
 ### Sprinkle on some DCI goodness.
 
 [DCI](http://fulloo.info) is a method of specifying interactions between

data/lib/mr_darcy.rb

@@ -17,11 +17,10 @@ module MrDarcy
   end
 
   def all_drivers
-    drivers = %w| synchronous thread celluloid em |.map(&:to_sym)
-
+    return @drivers if @drivers && !@drivers.empty?
+    drivers ||= %w| synchronous thread celluloid em |.map(&:to_sym)
     drivers.delete :em if RUBY_ENGINE=='jruby'
-
-    drivers
+    @drivers = drivers
   end
 
   def promise opts={}, &block
@@ -29,4 +28,8 @@ module MrDarcy
     MrDarcy::Promise.new driver: driver, &block
   end
 
+  def all_promises opts={}
+    MrDarcy::Promise::Collection.new yield, opts
+  end
+
 end

data/lib/mr_darcy/deferred.rb

@@ -3,7 +3,7 @@ module MrDarcy
 
     attr_accessor :promise, :last_promise
 
-    %w| resolved? rejected? unresolved? resolve reject final result |.map(&:to_sym).each do |method|
+    %w| resolved? rejected? unresolved? resolve reject final result raise |.map(&:to_sym).each do |method|
       define_method method do |*args|
         last_promise.public_send method, *args
       end
@@ -17,7 +17,7 @@ module MrDarcy
       self.last_promise = last_promise.fail(&block)
     end
 
-    def initialize opts={}
+    def initialize opts={}, &block
       driver = opts[:driver] || MrDarcy.driver
       self.promise = MrDarcy::Promise.new(driver: driver) {}
       self.last_promise = promise

data/lib/mr_darcy/promise.rb

@@ -9,6 +9,7 @@ module MrDarcy
     autoload :Thread,       File.expand_path('../promise/thread', __FILE__)
     autoload :Celluloid,    File.expand_path('../promise/celluloid', __FILE__)
     autoload :EM,           File.expand_path('../promise/em', __FILE__)
+    autoload :Collection,   File.expand_path('../promise/collection', __FILE__)
 
     module_function
 

data/lib/mr_darcy/promise/base.rb

@@ -72,11 +72,11 @@ module MrDarcy
       end
 
       def do_reject exception
-        will_reject value
+        will_reject exception
         set_value_to exception
         state_machine_reject
         reject_child_promise
-        did_reject value
+        did_reject exception
       end
 
       def will_resolve value; end

data/lib/mr_darcy/promise/collection.rb

@@ -0,0 +1,106 @@
+require 'thread'
+
+module MrDarcy
+  module Promise
+    class Collection
+      attr_accessor :promises, :size
+
+      include Enumerable
+
+      def initialize promises, opts={}
+        @lock = Mutex.new
+        this  = self
+
+        @promises = []
+        @size     = promises.size
+        @promise  = MrDarcy.promise opts do
+          promises.each do |p|
+            this.send :add_promise, p
+          end
+        end
+      end
+
+      %w| resolved? rejected? unresolved? result raise then fail |.each do |method|
+        define_method method do |*args,&block|
+          my_promise.public_send method, *args, &block
+        end
+      end
+
+      def final
+        my_promise.final
+        self
+      end
+
+      def each &block
+        promises.each &block
+      end
+
+      def push promise
+        @lock.synchronize { @size = @size + 1 }
+        add_promise promise
+      end
+      alias << push
+
+      def size
+        @lock.synchronize { @size }
+      end
+
+      def promises
+        @lock.synchronize { @promises }
+      end
+
+      private
+
+      def add_promise promise
+        ::Kernel.raise RuntimeError, "Collection already resolved" if my_promise && resolved?
+        ::Kernel.raise RuntimeError, "Collection already rejected" if my_promise && rejected?
+        ::Kernel.raise ArgumentError, "must be thenable" unless promise.respond_to?(:then) && promise.respond_to?(:fail)
+        @lock.synchronize { @promises.push promise }
+        set_up_promise promise
+      end
+
+      def my_promise
+        @lock.synchronize { @promise }
+      end
+
+      def set_up_promise promise
+        promise.then(&method(:record_resolve))
+        promise.fail(&method(:record_reject))
+        # promise.then { |v| record_resolve v }.fail { |v| record_reject v }
+      end
+
+      def record_resolve value
+        @lock.synchronize do
+          resolve_promise if can_resolve?
+          value
+        end
+      end
+
+      # NOT THREADSAFE:
+      #   because they're called from within #record_resolve
+      #   which locks.
+      def resolve_promise
+        @promise.resolve @promises.map(&:result)
+      end
+
+      def can_resolve?
+        all_promises_present? && all_promises_resolved? && @promise.unresolved?
+      end
+
+      def all_promises_present?
+        @promises.size == @size
+      end
+
+      def all_promises_resolved?
+        @promises.all?(&:resolved?)
+      end
+      # /NOT THREADSAFE
+
+      def record_reject value
+        my_promise.reject value
+        value
+      end
+
+    end
+  end
+end

data/lib/mr_darcy/promise/thread.rb

@@ -27,6 +27,14 @@ module MrDarcy
         ::Thread.new &block
       end
 
+      def resolve_child_promise
+        ::Thread.new { super }
+      end
+
+      def reject_child_promise
+        ::Thread.new { super }
+      end
+
       def did_resolve value
         complete!
       end
@@ -48,7 +56,8 @@ module MrDarcy
       end
 
       def complete?
-        semaphore.synchronize { @complete }
+        # semaphore.synchronize { @complete }
+        @complete
       end
 
       def complete!

data/lib/mr_darcy/version.rb

@@ -1,3 +1,3 @@
 module MrDarcy
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/mr_darcy.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["james@resistor.io"]
   spec.summary       = %q{A mashup of async Promises and DCI in Ruby.}
   spec.description   = <<-EOF
-  MrDarcy takes async promises from the javascript word, DCI from Jim
+  MrDarcy takes async promises from the javascript world, DCI from Jim
   Gay's brain and sprinkles some ruby on top for great justice!
   EOF
   spec.homepage      = "https://github.com/jamesotron/MrDarcy"

data/spec/lib/mr_darcy/deferred_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe MrDarcy::Deferred do
+  %w| promise last_promise resolved? rejected? unresolved? resolve reject
+      final result raise then fail |.each do |method|
+    it { should respond_to method }
+  end
+end

data/spec/lib/mr_darcy/promise/collection_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe MrDarcy::Promise::Collection do
+  MrDarcy.all_drivers.each do |driver|
+    describe "with driver #{driver}" do
+      next if driver == :synchronous
+
+      let(:first_promise)  { MrDarcy.promise(driver: driver) { resolve 1 } }
+      let(:second_promise) { MrDarcy.promise(driver: driver) { resolve 2 } }
+      let(:third_promise)  { MrDarcy.promise(driver: driver) { resolve 3 } }
+      let(:three_promises) { [ first_promise, second_promise, third_promise ] }
+      let(:collection) { described_class.new three_promises, driver: driver }
+      subject { collection }
+
+      its(:final) { should be_an Enumerable }
+      its(:final) { should respond_to :each }
+      its(:final) { should respond_to :push }
+      its(:final) { should respond_to :<< }
+      its(:final) { should respond_to :size }
+      its(:final) { should respond_to :promises }
+      its(:final) { should respond_to :raise }
+
+      When 'all the promises resolve' do
+        its(:final)  { should be_resolved }
+        its(:result) { should eq [1,2,3] }
+      end
+
+      When 'any of the promises reject' do
+        let(:second_promise) { MrDarcy.promise(driver: driver) { reject 2 } }
+        its(:final)  { should be_rejected }
+        its(:result) { should eq 2 }
+      end
+    end
+  end
+end

data/spec/lib/mr_darcy_spec.rb

@@ -10,13 +10,19 @@ describe MrDarcy do
     subject { MrDarcy.all_drivers }
 
     When 'running on jruby' do
-      before { stub_const 'RUBY_ENGINE', 'jruby' }
+      before do
+        MrDarcy.all_drivers.clear
+        stub_const 'RUBY_ENGINE', 'jruby'
+      end
 
       it { should_not include :em }
     end
 
     Otherwise do
-      before { stub_const 'RUBY_ENGINE', 'mri'}
+      before do
+        MrDarcy.all_drivers.clear
+        stub_const 'RUBY_ENGINE', 'mri'
+      end
 
       it { should include :synchronous }
       it { should include :thread }

metadata

@@ -1,171 +1,171 @@
 --- !ruby/object:Gem::Specification
 name: mr_darcy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - James Harton
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  prerelease: false
-  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rspec
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: guard
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: guard-bundler
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: terminal-notifier-guard
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: pry
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: eventmachine
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: em-http-request
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: celluloid
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: celluloid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
-    MrDarcy takes async promises from the javascript word, DCI from Jim
+    MrDarcy takes async promises from the javascript world, DCI from Jim
     Gay's brain and sprinkles some ruby on top for great justice!
 email:
 - james@resistor.io
@@ -192,6 +192,7 @@ files:
 - lib/mr_darcy/promise/base.rb
 - lib/mr_darcy/promise/celluloid.rb
 - lib/mr_darcy/promise/child_promise.rb
+- lib/mr_darcy/promise/collection.rb
 - lib/mr_darcy/promise/dsl.rb
 - lib/mr_darcy/promise/em.rb
 - lib/mr_darcy/promise/state.rb
@@ -212,8 +213,10 @@ files:
 - spec/acceptance/simple_promise_with_fail_spec.rb
 - spec/acceptance/simple_promise_with_then_spec.rb
 - spec/lib/mr_darcy/context_spec.rb
+- spec/lib/mr_darcy/deferred_spec.rb
 - spec/lib/mr_darcy/promise/base_spec.rb
 - spec/lib/mr_darcy/promise/child_promise_spec.rb
+- spec/lib/mr_darcy/promise/collection_spec.rb
 - spec/lib/mr_darcy/promise/dsl_spec.rb
 - spec/lib/mr_darcy/promise/em_spec.rb
 - spec/lib/mr_darcy/promise/state/base_spec.rb
@@ -233,7 +236,7 @@ homepage: https://github.com/jamesotron/MrDarcy
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -248,9 +251,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
+rubyforge_project: 
 rubygems_version: 2.2.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A mashup of async Promises and DCI in Ruby.
 test_files:
@@ -262,8 +265,10 @@ test_files:
 - spec/acceptance/simple_promise_with_fail_spec.rb
 - spec/acceptance/simple_promise_with_then_spec.rb
 - spec/lib/mr_darcy/context_spec.rb
+- spec/lib/mr_darcy/deferred_spec.rb
 - spec/lib/mr_darcy/promise/base_spec.rb
 - spec/lib/mr_darcy/promise/child_promise_spec.rb
+- spec/lib/mr_darcy/promise/collection_spec.rb
 - spec/lib/mr_darcy/promise/dsl_spec.rb
 - spec/lib/mr_darcy/promise/em_spec.rb
 - spec/lib/mr_darcy/promise/state/base_spec.rb