eventkit-promise 0.1.0 → 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 659dd4ed9bf579230b17ccab2f135bfcb4c4b33e
+  data.tar.gz: 8b936ff5b6a06c0f4617282b56ae47ab1794ff2a
+SHA512:
+  metadata.gz: 9e87f5e6c01f52b7713c52f632587c8410639c1b9a92f375046c9c357c185f687b72f32ab7d091af1bf6d6f924ee38852039f060832cd82eae8f21261eebbd86
+  data.tar.gz: 10dac44cfb149504499de52d0e6e8d95a50a1b1fbd038f2662b624bec5c03359e873ec59340904c2cb8ecd79b166c5069850eb8173377fe9591216c1f85f9a2c

data/README.md

@@ -14,6 +14,55 @@ Add this line to your application's Gemfile:
 gem 'eventkit-promise'
 ```
 
+## Configuration
+
+On fullfiled and on rejected handlers should execute asynchronously
+according to the [Promises\A+ spec]
+(https://promisesaplus.com/#point-67). So, the main dependency
+for an `Eventkit::Promise` is the object that provides the execution
+context for handlers, which we will be calling the `TaskScheduler`.
+
+In your project, you will need to define an implementation for a
+`TaskScheduler`, which sould have a `#schedule_execution` method that
+takes a block.
+
+If you're using something like Event Machine, then you could do
+something like this:
+
+```ruby
+require 'eventkit/task_scheduler'
+
+class EMTaskScheduler < EventKit::TaskScheduler
+  def schedule_execution(&block)
+    EM::next_tick(&block)
+  end
+end
+
+task_scheduler = EMTaskScheduler.new
+
+Eventkit::Promise.new(task_scheduler)
+```
+
+If you're using `Eventkit::Eventloop`, then you could do:
+
+```ruby
+require 'eventkit/task_scheduler'
+
+class NextTickScheduler < Eventkit::TaskScheduler
+  def initialize(event_loop)
+    @event_loop = event_loop
+  end
+
+  def schedule_execution(&block)
+    @event_loop.on_next_tick(&block)
+  end
+end
+
+task_scheduler = NextTickScheduler.new
+
+Eventkit::Promise.new(task_scheduler)
+```
+
 ## Usage
 
 ```ruby
@@ -21,17 +70,15 @@ require 'eventkit/promise'
 
 # Resolving a promise
 
-promise = Eventkit::Promise.new
+promise = Eventkit::Promise.new(task_scheduler)
 
 promise.then(->(value) { value + 1 })
 
 promise.resolve(1)
 
-promise.value # => 1
-
 # Rejecting a promise
 
-promise = Eventkit::Promise.new
+promise = Eventkit::Promise.new(task_scheduler)
 
 promise.then(
   ->(value) {
@@ -44,11 +91,9 @@ promise.then(
 
 promise.reject(NoMethodError.new('Undefined method #call'))
 
-promise.reason # => <NoMethodError: undefined method #call>
-
 # Chaining promises
 
-promise_a = Eventkit::Promise.new
+promise_a = Eventkit::Promise.new(task_scheduler)
 
 promise_b = promise_a
   .then(->(v) { v + 1 })
@@ -61,47 +106,32 @@ promise_b.catch { |error|
 
 promise_a.resolve(1)
 
-promise_a.value # => 1
-promise_b.value # => 4
-
 # Resolving and fullfiling with another promise
 
-promise_a = Eventkit::Promise.new
-promise_b = Eventkit::Promise.new
+promise_a = Eventkit::Promise.new(task_scheduler)
+promise_b = Eventkit::Promise.new(task_scheduler)
 
 promise_a.resolve(promise_b)
 
 promise_b.resolve('foobar')
 
-promise_a.value # => foobar
-
 # Resolving and rejecting with another promise
 
-promise_a = Eventkit::Promise.new
-promise_b = Eventkit::Promise.new
+promise_a = Eventkit::Promise.new(task_scheduler)
+promise_b = Eventkit::Promise.new(task_scheduler)
 
 promise_a.resolve(promise_b)
 
 promise_b.reject('Ooops can not continue')
 
-promise_a.reason # => 'Ooops can not continue'
-
 # Initializing with a block
 
-promise = Promise.new do |p|
+promise = Promise.new(task_scheduler) do |p|
   p.resolve('foobar')
 end
 
-promise.value # => 'foobar'
-
 ```
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/eventkit-promise/fork )

data/Rakefile

@@ -2,4 +2,3 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
-

data/eventkit-promise.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["oliver.martell@gmail.com"]
 
   spec.summary       = "Promises/A+ for Ruby"
-  spec.description   = "Ruby implementation of https://promisesaplus.com/"
+  spec.description   = "Ruby implementation of Promises/A+ https://promisesaplus.com/"
   spec.homepage      = "http://github.com/omartell/eventkit-promise"
   spec.license       = "MIT"
 
@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "eventkit-eventloop", "~> 0.1.0"
 end

data/lib/eventkit/promise.rb

@@ -1,15 +1,16 @@
 module Eventkit
   class Promise
-    VERSION = "0.1.0"
-    attr_reader :value
-    alias_method :reason, :value
+    VERSION = '1.0'
+    attr_reader :value, :task_scheduler
+    private :value
 
-    def initialize
+    def initialize(task_scheduler)
       @on_fullfiled = []
       @on_rejected  = []
       @state = :pending
+      @task_scheduler = task_scheduler
       @resolved_with_promise = false
-      yield(self) if block_given?
+      yield self if block_given?
     end
 
     def pending?
@@ -25,7 +26,7 @@ module Eventkit
     end
 
     def then(on_fullfiled_handler = nil, on_rejected_handler = nil)
-      promise = Promise.new
+      promise = Promise.new(task_scheduler)
 
       add_on_fullfiled { |value|
         begin
@@ -86,7 +87,7 @@ module Eventkit
 
     def add_on_fullfiled(&handler)
       if resolved?
-        handler.call(value)
+        schedule_execution(handler)
       else
         @on_fullfiled << handler
       end
@@ -94,7 +95,7 @@ module Eventkit
 
     def add_on_rejected(&handler)
       if rejected?
-        handler.call(value)
+        schedule_execution(handler)
       else
         @on_rejected << handler
       end
@@ -112,15 +113,18 @@ module Eventkit
       else
         @state = :resolved
         @value = value
-        @on_fullfiled.each { |handler| handler.call(value) }
+        @on_fullfiled.each(&method(:schedule_execution))
       end
     end
 
     def run_rejection(value)
       @value = value
-      @on_rejected.each { |handler| handler.call(value) }
+      @on_rejected.each(&method(:schedule_execution))
       @state = :rejected
     end
+
+    def schedule_execution(handler)
+      task_scheduler.schedule_execution { handler.call(value) }
+    end
   end
 end
-

data/lib/eventkit/task_scheduler.rb

@@ -0,0 +1,10 @@
+module Eventkit
+  class TaskScheduler
+    def schedule_execution(&handler)
+      fail NotImplementedError, <<-DOC
+Implement #schedule_execution in your class to schedule
+the execution of on_fullfiled and on_rejected handlers
+DOC
+    end
+  end
+end

metadata

@@ -1,58 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: eventkit-promise
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: '1.0'
 platform: ruby
 authors:
 - Oliver Martell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-16 00:00:00.000000000 Z
+date: 2015-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
-description: Ruby implementation of https://promisesaplus.com/
+- !ruby/object:Gem::Dependency
+  name: eventkit-eventloop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Ruby implementation of Promises/A+ https://promisesaplus.com/
 email:
 - oliver.martell@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -60,29 +69,29 @@ files:
 - Rakefile
 - eventkit-promise.gemspec
 - lib/eventkit/promise.rb
+- lib/eventkit/task_scheduler.rb
 homepage: http://github.com/omartell/eventkit-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: 1.8.23.2
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Promises/A+ for Ruby
 test_files: []