mr_darcy 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d61c338943c3f4d6e28c6cffdbe3c219d0e0786
-  data.tar.gz: 5dc024d54bee45d0c3f2b2c2dad483a8bb95b980
+  metadata.gz: a30f4cd28db6fa9241372a6ba419149e78acb95f
+  data.tar.gz: 14599ca6b1ef196eb134e82eebecf9c1a9b3da4e
 SHA512:
-  metadata.gz: 158121e9b077abf2a36fe879548470fcc8338ed50aeff01ccea68b607f470d03cb24d06fdbf7a2167a904531f28f0349e761be2e6dfcef6490180acf4e57f348
-  data.tar.gz: 8daa06f36f9f7a867098adb3a89cb20cd1833157ce457aac38ff61eb81f6d5f264a9cdc862b667ce7c8e5a61284628c06401a63eb9d91ec8ca9dbb907ea818ca
+  metadata.gz: 11879372c631def455d5b15453be331adef2187f0d0076c8cfab6297f8703feffec4e394f123f05fd110b2ebcfefc37df2a0fc7ca02755517206d49043af77e8
+  data.tar.gz: da5f40370e5d5d484ab29d9d29100d658742c2134bf82d743da90f92d8f9a0d21ed1f1c4184115b0f8b505847c23c048e8eaca3e89fbde021b13b944d0f8393d

data/README.md

@@ -33,6 +33,45 @@ MrDarcy is definitely experimental, and was mostly built over the weekend of
 amazing and sexy [@breccan](https://twitter.com/breccan) and
 [@eoinkelly](https://twitter.com/eoinkelly).
 
+### API Changes (0.4.0 and above)
+
+As of version `0.4.0` the `instance_exec` of promise blocks has been removed
+(meaning that you can't call `resolve` or `reject` from directly inside your
+promise blocks).  This is becuase `instance_exec` changes the binding of
+`self` inside the promise, and will cause calls to enclosed methods to fail.
+
+For example:
+
+```ruby
+class InstanceExecExample
+
+  def example_method
+    puts "I did a thing"
+  end
+
+  def make_promise
+    MrDarcy.promise { resolve example_method }.raise
+  end
+end
+```
+
+Will raise:
+
+```
+NameError in `block in make_promise': undefined local variable or method `example_method' for #<MrDarcy::Promise::DSL:0x007fcc542d75d0>
+```
+
+As of `0.4.0` the DSL object wll be passed to the promise block as an argument,
+therefore:
+
+```
+  def make_promise
+    MrDarcy.promise { |promise| promise.resolve example_method }.raise
+  end
+```
+
+will not raise an exception.
+
 #### Should I use MrDarcy in Production?
 
 No.
@@ -51,15 +90,15 @@ Here's an example:
 ```ruby
 # We're going to wrap an asynchronous web request using EventMachine
 # in a promise:
-data = MrDarcy.promise do
+data = MrDarcy.promise do |promise|
   EM.run do
     http = EM.HttpRequest.new('http://camp.ruby.org.nz/').get
     http.errback do
-      reject http.error
+      promise.reject http.error
       EM.stop
     end
     http.callback do
-      resolve http.response
+      promise.resolve http.response
       EM.stop
     end
   end
@@ -86,12 +125,12 @@ doing async ruby:
      or reject the promise.
 
      ```ruby
-     MrDarcy.promise do
+     MrDarcy.promise do |promise|
        accellerate_the_delorean
        if speed >= 88
-         resolve :time_flux_initiated
+         promise.resolve :time_flux_initiated
        else
-         reject :engage_service_brake
+         promise.reject :engage_service_brake
        end
      end
      ```
@@ -102,9 +141,9 @@ doing async ruby:
      `fail` calls.
 
      ```ruby
-     MrDarcy.promise do
+     MrDarcy.promise do |promise|
        i = rand
-       i > 0.5 ? resolve i : reject i
+       i > 0.5 ? promise.resolve i : promise.reject i
      end.then |value|
        # success
      end.fail |value|
@@ -118,8 +157,8 @@ doing async ruby:
      within the `fail` block to pass it along to the next `fail` block.
 
      ```ruby
-     MrDarcy.promise do
-       reject 2
+     MrDarcy.promise do |promise|
+       promise.reject 2
      end.fail |value|
        value * value
      end.then |value|
@@ -130,8 +169,8 @@ doing async ruby:
   4. Failures cascade until they're caught:
 
      ```ruby
-     MrDarcy.promise do
-       reject :fail
+     MrDarcy.promise do |promise|
+       promise.reject :fail
      end.then
        # I am skipped
      end.then
@@ -145,11 +184,11 @@ doing async ruby:
      their resolution until the new promise is resolved:
 
      ```ruby
-     MrDarcy.promise do
-       resolve 1
+     MrDarcy.promise do |promise|
+       promise.resolve 1
      end.then do |value|
-       MrDarcy.promise do
-         resolve value * 2
+       MrDarcy.promise do |p|
+         p.resolve value * 2
        end
      end.then |value|
        # I will be called with 2
@@ -163,7 +202,7 @@ 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 } }
+  10.times.map { |i| MrDarcy.promise { |p| sleep 1; p.resolve i } }
 end.then do |values|
   puts "All done."
 end
@@ -278,7 +317,7 @@ just work.
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/mr_darcy/fork )
+1. Fork it ( http://github.com/jamesotron/mr_darcy/fork )
 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`)

data/lib/mr_darcy/promise/base.rb

@@ -129,8 +129,7 @@ module MrDarcy
       def evaluate_promise &block
         begin
           dsl = DSL.new(self)
-          dsl.instance_exec dsl, &block
-          # block.call DSL.new(self)
+          block.call DSL.new(self)
         rescue Exception => e
           reject e
         end

data/lib/mr_darcy/promise/collection.rb

@@ -8,14 +8,12 @@ module MrDarcy
       include Enumerable
 
       def initialize promises, opts={}
-        @lock = Mutex.new
-        this  = self
-
+        @lock     = Mutex.new
         @promises = []
         @size     = promises.size
         @promise  = MrDarcy.promise opts do
           promises.each do |p|
-            this.send :add_promise, p
+            add_promise p
           end
         end
       end

data/lib/mr_darcy/version.rb

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

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

@@ -5,9 +5,9 @@ describe MrDarcy::Promise::Collection do
     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(:first_promise)  { MrDarcy.promise(driver: driver) { |p| p.resolve 1 } }
+      let(:second_promise) { MrDarcy.promise(driver: driver) { |p| p.resolve 2 } }
+      let(:third_promise)  { MrDarcy.promise(driver: driver) { |p| p.resolve 3 } }
       let(:three_promises) { [ first_promise, second_promise, third_promise ] }
       let(:collection) { described_class.new three_promises, driver: driver }
       subject { collection }
@@ -21,12 +21,12 @@ describe MrDarcy::Promise::Collection do
       its(:final) { should respond_to :raise }
 
       When 'all the promises resolve' do
-        its(:final)  { should be_resolved }
         its(:result) { should eq [1,2,3] }
+        its(:final)  { should be_resolved }
       end
 
       When 'any of the promises reject' do
-        let(:second_promise) { MrDarcy.promise(driver: driver) { reject 2 } }
+        let(:second_promise) { MrDarcy.promise(driver: driver) { |p| p.reject 2 } }
         its(:final)  { should be_rejected }
         its(:result) { should eq 2 }
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mr_darcy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - James Harton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler