promise.rb 0.2.1 → 0.3.0

data/.travis.yml

@@ -3,11 +3,11 @@ rvm:
   - 1.9.3
   - 2.0.0
   - jruby-19mode
-  - rbx-19mode
+  - rbx
   - ruby-head
   - jruby-head
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-script: bundle exec rake ci:metrics -t
+script: bundle exec rake -t metrics:coverage ci

data/Gemfile

@@ -9,5 +9,12 @@ gem 'fuubar',   git: 'https://github.com/lgierth/fuubar.git',
                 ref: 'static-percentage'
 gem 'awesome_print'
 
+platform :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubysl-json', '~> 2.0'
+  gem 'rubinius', '~> 2.0'
+  gem 'racc'
+end
+
 # Added by devtools
 eval_gemfile 'Gemfile.devtools'

data/README.md

@@ -1,4 +1,90 @@
-promise
-=======
+# promise.rb [![Build Status](https://travis-ci.org/lgierth/promise.rb.png?branch=master)](https://travis-ci.org/lgierth/promise.rb) [![Code Climate](https://codeclimate.com/github/lgierth/promise.rb.png)](https://codeclimate.com/github/lgierth/promise.rb) [![Coverage Status](https://coveralls.io/repos/lgierth/promise.rb/badge.png?branch=master)](https://coveralls.io/r/lgierth/promise.rb?branch=master)
 
-Promises/A+ for Ruby
+Ruby implementation of the [Promises/A+ spec](http://promisesaplus.com/).
+100% mutation coverage, tested on 1.9, 2.0, Rubinius, and JRuby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'promise.rb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install promise.rb
+
+## Usage
+
+promise.rb doesn't come with a way of scheduling callback dispatch.
+
+```ruby
+require 'promise'
+
+class MyPromise < Promise
+  def defer(callback, arg)
+    callback.dispatch(arg)
+  end
+end
+```
+
+The above scheduling mechanism violates the following section of the spec:
+
+> onFulfilled or onRejected must not be called until the execution context
+> stack contains only platform code.
+
+Compliance can be achieved, for example, by running an event reactor like
+EventMachine:
+
+```ruby
+require 'promise'
+require 'eventmachine'
+
+class MyPromise < Promise
+  def defer(callback, arg)
+    EM.next_tick { callback.dispatch(arg) }
+  end
+end
+```
+
+Now you can create MyPromise objects, and fullfil (or reject) them, as well as
+add callbacks to them:
+
+```ruby
+def nonblocking_stuff
+  promise = MyPromise.new
+  EM.next_tick { promise.fulfill('value') }
+  promise
+end
+
+nonblocking_stuff.then { |value| p value }
+nonblocking_stuff.then(proc { |value| p value })
+```
+
+Rejection works similarly:
+
+```ruby
+def failing_stuff
+  promise = MyPromise.new
+  EM.next_tick { promise.reject('reason') }
+  promise
+end
+
+failing_stuff.then(proc { |value| }, proc { |reason| p reason })
+```
+
+## License
+
+Hatetepe is licensed under the [MIT License](http://opensource.org/licenses/MIT).
+See LICENSE.txt for details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 12
+threshold: 14
 total_score: 49

data/config/reek.yml

@@ -57,7 +57,7 @@ TooManyInstanceVariables:
 TooManyMethods:
   enabled: true
   exclude: []
-  max_methods: 11
+  max_methods: 13
 TooManyStatements:
   enabled: true
   exclude:

data/lib/promise.rb

@@ -34,14 +34,20 @@ class Promise
     next_promise
   end
 
-  def fulfill(value)
+  def sync
+    wait if pending?
+    fail reason if rejected?
+    value
+  end
+
+  def fulfill(value = nil)
     dispatch(@on_fulfill, value) do
       @state = :fulfilled
       @value = value
     end
   end
 
-  def reject(reason)
+  def reject(reason = nil)
     dispatch(@on_reject, reason) do
       @state = :rejected
       @reason = reason
@@ -61,7 +67,7 @@ class Promise
     if pending?
       yield
       arg.freeze
-      callbacks.each { |callback| defer(callback, arg) }
+      callbacks.each { |callback| dispatch!(callback, arg) }
     end
 
     # Callback#assume_state uses #dispatch as returned_promise's on_fulfill
@@ -74,15 +80,19 @@ class Promise
 
   def maybe_dispatch(fulfill_callback, reject_callback)
     if fulfilled?
-      defer(fulfill_callback, value)
+      dispatch!(fulfill_callback, value)
     end
 
     if rejected?
-      defer(reject_callback, reason)
+      dispatch!(reject_callback, reason)
     end
   end
 
-  def defer(callback, arg)
-    callback.dispatch(arg)
+  def dispatch!(callback, arg)
+    defer { callback.dispatch(arg) }
+  end
+
+  def defer
+    yield
   end
 end

data/lib/promise/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 class Promise
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/promise_spec.rb

@@ -7,8 +7,12 @@ describe Promise do
 
   let(:value) { double('value') }
   let(:other_value) { double('other_value') }
-  let(:reason) { double('reason') }
-  let(:other_reason) { double('other_reason') }
+  let(:reason) do
+    StandardError.new('reason').tap { |ex| ex.set_backtrace(caller) }
+  end
+  let(:other_reason) do
+    StandardError.new('other_reason').tap { |ex| ex.set_backtrace(caller) }
+  end
 
   describe '3.1.1 pending' do
     it 'transitions to fulfilled' do
@@ -337,11 +341,39 @@ describe Promise do
     it 'does not return anything' do
       expect(subject.fulfill(nil)).to eq(nil)
     end
+
+    it 'does not require a value' do
+      subject.fulfill
+      expect(subject.value).to be(nil)
+    end
   end
 
   describe '#reject' do
     it 'does not return anything' do
       expect(subject.reject(nil)).to eq(nil)
     end
+
+    it 'does not require a reason' do
+      subject.reject
+      expect(subject.reason).to be(nil)
+    end
+  end
+
+  describe '#sync' do
+    it 'waits for fulfillment' do
+      allow(subject).to receive(:wait) { subject.fulfill(value) }
+      expect(subject.sync).to be(value)
+    end
+
+    it 'waits for rejection' do
+      allow(subject).to receive(:wait) { subject.reject(reason) }
+      expect { subject.sync }.to raise_error(reason)
+    end
+
+    it 'waits if pending' do
+      subject.fulfill(value)
+      expect(subject).not_to receive(:wait)
+      expect(subject.sync).to be(value)
+    end
   end
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: promise.rb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
+  prerelease: 
 platform: ruby
 authors:
 - Lars Gierth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-19 00:00:00.000000000 Z
+date: 2013-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -56,26 +59,27 @@ files:
 homepage: https://github.com/lgierth/promise
 licenses:
 - MIT
-metadata: {}
 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: 2.1.5
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Promises/A+ for Ruby
 test_files:
 - spec/promise_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NGFmYWVmYmRmNWEyMjkyYmMwY2Y0NjA2OWE1YzBjZTM2NTlkNzFmMA==
-  data.tar.gz: !binary |-
-    ODg2NzU0ZjFmZTZjY2YzODFlYzJiYzUwMWE1OGQ2NWE4MGVlYTM0ZQ==
-SHA512:
-  metadata.gz: !binary |-
-    NzA4MmZhMGJiNTliYWIxZjQ5NmY1YTc2NTE5ZTQzY2Y1MTEzNzEyZGVjY2Yy
-    MjdkODk5ZGYxMjMwMjZiYjUzODdmZmY2YzIxNDk1M2Y3ZWQ1M2RkMjdhY2Jl
-    MTRhNzY2M2E4NWExNjY1OTg3OTYzYmI2NzY0MzZlNDE3ZmI2YWY=
-  data.tar.gz: !binary |-
-    N2MxOTAzZWMzMmUyNGY4MTVhODEwZWYwODNhNmRkYmMwYjU1MWNjNTI3ZGQz
-    MTZhZDliZWQyZWRjNmVkN2E4MDA5YzhhZjBmMDkxMTYxNTQzYTRkZWU3N2Ix
-    MTgyZGMyZTNiMjJiMTczZDRmNTA4ZjEzMDE2MDZhMjc4YmI4ZWY=