promise.rb 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7dee00af5f45fbb9d9d19bf97268b908b0134d2
-  data.tar.gz: 75cc57634668e4d7f0b0f0e8200b89b46ecd04e0
+  metadata.gz: d1c5730ef1d6a9d4aca9152d2d0b0978d3599bf9
+  data.tar.gz: 7bf7f65107907530efb5befd130d8257c95b1ebd
 SHA512:
-  metadata.gz: a825e41f6f0c09abacfca43c33cb9aaf7715f32f6a3de6d73b5733db48808d55231155f9490a80e54a64d063afad1227a90e7bb3f4cb2b3a6d3e6c6019312275
-  data.tar.gz: 43cc9b875210365d96cf180ad306da81d18bb9dd38a66411f8b8ce3fbf9385d2687463f1d5ab1737d45763d2a2d953c44979cd9efe023ce3e9f9ea413ae6f4d6
+  metadata.gz: b91773b745efae988afbcdd56080fac09398f72e781266e92b755128a3f606fc09f63299849a729c2b6e1ced9cc1cdc46581beb6880949c7ea2748516994cff3
+  data.tar.gz: 7ca9447a4c2766299ccc9d941dd2a25d68a65a1626ff3407726966ed85157bc0c25873bf53c5eecd2a6e683c093a6217f354be5712c38602d5d02f7e7f8bb3c5

data/.travis.yml

@@ -6,7 +6,6 @@ rvm:
   - 2.1
   - 2.2
   - jruby
-  - rbx-3.14
 matrix:
   fast_finish: true
 before_install:

data/CHANGELOG.md

@@ -1,10 +1,17 @@
 # promise.rb changelog
 
+## 0.7.2 (November 15, 2016)
+
+### Features
+
+* Add support for calling sync on the result of Promise.all (pull #24)
+* Add Promise.sync to unwrap an object that may be a promise. (#25)
+
 ## 0.7.1 (June 15, 2016)
 
 ### Features
 
-* Add Promise.map_value for chaining a promise or plain value
+* Add Promise.map_value for chaining a promise or plain value (pull #17)
 
 ## 0.7.0 (February 24, 2016)
 

data/Gemfile

@@ -4,6 +4,12 @@ source 'https://rubygems.org'
 
 gemspec
 
+if Gem.ruby_version < Gem::Version.new('2.0')
+  # gems that no longer support ruby 1.9.3
+  gem 'json', '~> 1.8.3'
+  gem 'tins', '~> 1.6.0'
+  gem 'term-ansicolor', '~> 1.3.2'
+end
 if Gem.ruby_version >= Gem::Version.new('2.1')
   gem 'devtools', '~> 0.1.4'
 end
@@ -11,7 +17,7 @@ gem 'fuubar', '~> 2.0.0'
 gem 'awesome_print'
 
 gem 'rake'
-gem 'rspec', '~> 3.4.0'
+gem 'rspec', '~> 3.5'
 gem 'rspec-its'
 gem 'coveralls', '~> 0.8.9'
 

data/README.md

@@ -6,7 +6,7 @@ tested on MRI 1.9, 2.0, 2.1, 2.2, Rubinius, and JRuby.
 
 Similar projects:
 
-- [concurrent-ruby](https://github.com/jdantonio/concurrent-ruby), Promises/A(+) implementation, thread based
+- [concurrent-ruby](https://github.com/jdantonio/concurrent-ruby), Promises/A(+) inspired implementation, thread based
 - [ruby-thread](https://github.com/meh/ruby-thread), thread/mutex/condition variable based, thread safe
 - [promise](https://github.com/bhuga/promising-future), a.k.a. promising-future, classic promises and futures, thread based
 - [celluloid-promise](https://github.com/cotag/celluloid-promise), inspired by Q, backed by a Celluloid actor

data/config/reek.yml

@@ -52,7 +52,7 @@ NilCheck:
 RepeatedConditional:
   enabled: true
   exclude: []
-  max_ifs: 3
+  max_ifs: 4
 TooManyInstanceVariables:
   enabled: true
   exclude: []
@@ -64,7 +64,7 @@ TooManyStatements:
   exclude:
   - initialize
   - each
-  max_statements: 5
+  max_statements: 6
 UncommunicativeMethodName:
   enabled: true
   exclude: []

data/config/rubocop.yml

@@ -99,3 +99,6 @@ GuardClause:
 
 Alias:
   EnforcedStyle: prefer_alias_method
+
+Metrics/ClassLength:
+  Enabled: false

data/lib/promise.rb

@@ -8,9 +8,11 @@ require 'promise/group'
 
 class Promise
   Error = Class.new(RuntimeError)
+  BrokenError = Class.new(Error)
 
   include Promise::Progress
 
+  attr_accessor :source
   attr_reader :state, :value, :reason
 
   def self.resolve(obj)
@@ -30,6 +32,10 @@ class Promise
     end
   end
 
+  def self.sync(obj)
+    obj.is_a?(Promise) ? obj.sync : obj
+  end
+
   def initialize
     @state = :pending
     @callbacks = []
@@ -51,7 +57,7 @@ class Promise
     on_fulfill ||= block
     next_promise = self.class.new
 
-    add_callback(Callback.new(self, on_fulfill, on_reject, next_promise))
+    add_callback(Callback.new(on_fulfill, on_reject, next_promise))
     next_promise
   end
 
@@ -61,17 +67,21 @@ class Promise
   alias_method :catch, :rescue
 
   def sync
-    wait if pending?
+    if pending?
+      wait
+      raise BrokenError if pending?
+    end
     raise reason if rejected?
     value
   end
 
   def fulfill(value = nil)
     if Promise === value
-      Callback.assume_state(value, self)
+      value.add_callback(self)
     else
       dispatch do
         @state = :fulfilled
+        @source = nil
         @value = value
       end
     end
@@ -81,14 +91,37 @@ class Promise
   def reject(reason = nil)
     dispatch do
       @state = :rejected
+      @source = nil
       @reason = reason_coercion(reason || Error)
     end
   end
 
+  # Override to support sync on a promise without a source or to wait
+  # for deferred callbacks on the source
+  def wait
+    while source
+      saved_source = source
+      saved_source.wait
+      break if saved_source.equal?(source)
+    end
+  end
+
+  protected
+
+  # Override to defer calling the callback for Promises/A+ spec compliance
   def defer
     yield
   end
 
+  def add_callback(callback)
+    if pending?
+      @callbacks << callback
+      callback.source = self
+    else
+      dispatch!(callback)
+    end
+  end
+
   private
 
   def reason_coercion(reason)
@@ -101,14 +134,6 @@ class Promise
     reason
   end
 
-  def add_callback(callback)
-    if pending?
-      @callbacks << callback
-    else
-      dispatch!(callback)
-    end
-  end
-
   def dispatch
     if pending?
       yield
@@ -118,6 +143,12 @@ class Promise
   end
 
   def dispatch!(callback)
-    defer { callback.call }
+    defer do
+      if fulfilled?
+        callback.fulfill(value)
+      else
+        callback.reject(reason)
+      end
+    end
   end
 end

data/lib/promise/callback.rb

@@ -2,38 +2,42 @@
 
 class Promise
   class Callback
-    def self.assume_state(source, target)
-      on_fulfill = target.method(:fulfill)
-      on_reject = target.method(:reject)
-      source.then(on_fulfill, on_reject)
-    end
+    attr_accessor :source
 
-    def initialize(promise, on_fulfill, on_reject, next_promise)
-      @promise = promise
+    def initialize(on_fulfill, on_reject, next_promise)
       @on_fulfill = on_fulfill
       @on_reject = on_reject
       @next_promise = next_promise
+      @next_promise.source = self
     end
 
-    def call
-      if @promise.fulfilled?
-        call_block(@on_fulfill, @promise.value)
+    def fulfill(value)
+      if @on_fulfill
+        call_block(@on_fulfill, value)
       else
-        call_block(@on_reject, @promise.reason)
+        @next_promise.fulfill(value)
       end
     end
 
-    def call_block(block, param)
-      if block
-        begin
-          @next_promise.fulfill(block.call(param))
-        rescue => ex
-          @next_promise.reject(ex)
-        end
+    def reject(reason)
+      if @on_reject
+        call_block(@on_reject, reason)
       else
-        self.class.assume_state(@promise, @next_promise)
+        @next_promise.reject(reason)
       end
     end
+
+    def wait
+      source.wait
+    end
+
+    private
+
+    def call_block(block, param)
+      @next_promise.fulfill(block.call(param))
+    rescue => ex
+      @next_promise.reject(ex)
+    end
   end
   private_constant :Callback
 end

data/lib/promise/group.rb

@@ -1,5 +1,6 @@
 class Promise
   class Group
+    attr_accessor :source
     attr_reader :promise
 
     def initialize(result_promise, inputs)
@@ -9,15 +10,22 @@ class Promise
       if @remaining.zero?
         promise.fulfill(inputs)
       else
+        promise.source = self
         chain_inputs
       end
     end
 
+    def wait
+      each_promise do |input_promise|
+        input_promise.wait if input_promise.pending?
+      end
+    end
+
     private
 
     def chain_inputs
       on_fulfill = method(:on_fulfill)
-      on_reject = promise.method(:reject)
+      on_reject = promise.public_method(:reject)
       each_promise do |input_promise|
         input_promise.then(on_fulfill, on_reject)
       end

data/lib/promise/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 class Promise
-  VERSION = '0.7.1'.freeze
+  VERSION = '0.7.2'.freeze
 end

data/promise.rb.gemspec

@@ -6,7 +6,7 @@ require 'promise/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'promise.rb'
-  spec.version       = Promise::VERSION
+  spec.version       = Promise::VERSION.dup
   spec.authors       = ['Lars Gierth']
   spec.email         = ['lars.gierth@gmail.com']
   spec.description   = %q{Promises/A+ for Ruby}

data/spec/spec_helper.rb

@@ -19,6 +19,7 @@ end
 
 require 'promise'
 require_relative 'support/delayed_promise'
+require_relative 'support/promise_loader'
 
 require 'awesome_print'
 require 'devtools/spec_helper' if Gem.ruby_version >= Gem::Version.new('2.1')

data/spec/support/promise_loader.rb

@@ -0,0 +1,13 @@
+class PromiseLoader
+  def self.lazy_load(promise, &block)
+    promise.source = new(&block)
+  end
+
+  def initialize(&block)
+    @block = block
+  end
+
+  def wait
+    @block.call
+  end
+end

data/spec/unit/promise_spec.rb

@@ -476,6 +476,58 @@ describe Promise do
         expect(subject).not_to receive(:wait)
         expect(subject.sync).to be(value)
       end
+
+      it 'waits for source by default' do
+        PromiseLoader.lazy_load(subject) { subject.fulfill(1) }
+        p2 = subject.then { |v| v + 1 }
+        expect(p2).to be_pending
+        expect(p2.sync).to eq(2)
+        expect(p2.source).to eq(nil)
+      end
+
+      it 'waits for source that is fulfilled with a promise' do
+        PromiseLoader.lazy_load(subject) { subject.fulfill(1) }
+        p2 = subject.then do |v|
+          Promise.new.tap do |p3|
+            PromiseLoader.lazy_load(p3) { p3.fulfill(v + 1) }
+          end
+        end
+        expect(p2).to be_pending
+        expect(p2.sync).to eq(2)
+        expect(p2.source).to eq(nil)
+      end
+
+      it 'waits for source rejection' do
+        PromiseLoader.lazy_load(subject) { subject.reject(reason) }
+        p2 = subject.then { |v| v + 1 }
+        expect { p2.sync }.to raise_error(reason)
+        expect(p2.source).to eq(nil)
+      end
+
+      it 'raises for promise without a source by default' do
+        expect { subject.sync }.to raise_error(Promise::BrokenError)
+      end
+
+      it 'raises if source.wait leaves promise pending' do
+        PromiseLoader.lazy_load(subject) {}
+        expect { subject.sync }.to raise_error(Promise::BrokenError)
+      end
+    end
+
+    describe '.sync' do
+      it 'returns non-promise argument' do
+        expect(Promise.sync(42)).to eq(42)
+      end
+
+      it 'calls sync on promise argument' do
+        PromiseLoader.lazy_load(subject) { subject.fulfill(123) }
+        expect(Promise.sync(subject)).to eq(123)
+      end
+
+      it 'calls sync on promise of another class' do
+        promise = Class.new(Promise).resolve('a')
+        expect(Class.new(Promise).sync(promise)).to eq('a')
+      end
     end
 
     describe '.resolve' do
@@ -575,6 +627,30 @@ describe Promise do
         p1.fulfill(1.0)
         expect(result.sync).to eq([1.0, 2])
       end
+
+      it 'returns a promise that can sync promises of another class' do
+        p1 = DelayedPromise.new
+        DelayedPromise.deferred << -> { p1.fulfill('a') }
+
+        result = Promise.all([p1, Promise.resolve(:b), 3])
+
+        expect(result).to be_pending
+        expect(result.sync).to eq(['a', :b, 3])
+      end
+
+      it 'sync on result does not call wait on resolved promises' do
+        p1 = Class.new(Promise) do
+          def wait
+            raise 'wait not expected'
+          end
+        end.resolve(:one)
+        p2 = DelayedPromise.new
+        DelayedPromise.deferred << -> { p2.fulfill(:two) }
+
+        result = Promise.all([p1, p2])
+
+        expect(result.sync).to eq([:one, :two])
+      end
     end
 
     describe '.map_value' do

metadata

@@ -1,24 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: promise.rb
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Lars Gierth
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,12 +54,13 @@ files:
 - promise.rb.gemspec
 - spec/spec_helper.rb
 - spec/support/delayed_promise.rb
+- spec/support/promise_loader.rb
 - spec/unit/promise_spec.rb
 homepage: https://github.com/lgierth/promise
 licenses:
 - Public Domain
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -74,13 +75,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.8
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
 specification_version: 4
 summary: Ruby implementation of the Promises/A+ spec
 test_files:
 - spec/spec_helper.rb
 - spec/support/delayed_promise.rb
+- spec/support/promise_loader.rb
 - spec/unit/promise_spec.rb
-has_rdoc: