async-await 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9ca5c47e0eeb5844d8ba1b976b9329aef2547891
-  data.tar.gz: 7ff3f0202c5a3bea737c00c4736c9c10630e3565
+SHA256:
+  metadata.gz: 398571ced4108922b98d708046659830492d51ba7846f9ce5ae91166986fdfe7
+  data.tar.gz: '09bd9a8c418d7fe0414c278df43eb67dd801048d2d9fa6d32d5df50af78724bd'
 SHA512:
-  metadata.gz: 54008f2ce863fdb91c273544c96a9d81f0efbb79c320f4e046ceaa0746da5c391fbe428644eeaeada9001b9c11abe341f9e78e9b8285563e27dc22cb3f914a1c
-  data.tar.gz: ac673acb00ea9348add082cb960d381e5223c3071adb945fad40b3e035cd4a973f46cb23d7c465d58e9ad2119b8ccba9c90b3ad114e5816beaab6ca90582c331
+  metadata.gz: 9682a9abf5b336acd4b201a020ec4247701fb90ed505ffdad3cf315334719fe261cdaf2bb7df1d98b6a112c39aa30582058dc2c7a0ea5678f20eb66256d49b84
+  data.tar.gz: 55f7314d172c4ebe1eaea3afc142628cd402ddcd20e7b210bc733f38830d169c9e4da518327b1cffe60dbda109734519d56f9f6aee9d7316ac46fedac4f7e3d9

data/.travis.yml

@@ -3,11 +3,10 @@ sudo: false
 dist: trusty
 cache: bundler
 rvm:
-  - 2.0
-  - 2.1
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
   - jruby-head
   - ruby-head
   - rbx-3

data/Gemfile

@@ -1,6 +1,15 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in async-await.gemspec
 gemspec
+
+group :development do
+	gem 'pry'
+end
+
+group :test do
+	gem 'benchmark-ips'
+	gem 'ruby-prof', platforms: :mri
+	
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -1,6 +1,6 @@
 # Async::Await
 
-Implements the async/await pattern for [async].
+Implements the async/await pattern for Ruby using [async].
 
 [![Build Status](https://secure.travis-ci.org/socketry/async-await.svg)](http://travis-ci.org/socketry/async-await)
 [![Code Climate](https://codeclimate.com/github/socketry/async-await.svg)](https://codeclimate.com/github/socketry/async-await)
@@ -31,9 +31,32 @@ In any asynchronous context (e.g. a reactor), simply use the `await` function li
 ```ruby
 require 'async/await'
 
-Async.await do
-  # ... any operation here.
+
+require_relative '../lib/async/await'
+
+class Coop
+	include Async::Await
+	
+	async def count_chickens(area_name)
+		3.times do |i|
+			sleep rand
+			
+			puts "Found a chicken in the #{area_name}!"
+		end
+	end
+
+	async def count_all_chickens
+		# These methods all run at the same time.
+		count_chickens("garden")
+		count_chickens("house")
+		
+		# We wait for the result
+		count_chickens("tree").wait
+	end
 end
+
+coop = Coop.new
+coop.count_all_chickens
 ```
 
 ## Contributing

data/async-await.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 	
 	spec.require_paths = ["lib"]
 
-	spec.add_dependency "async", "~> 1.0"
+	spec.add_dependency "async", "~> 1.3"
 	spec.add_development_dependency "async-rspec", "~> 1.1"
 
 	spec.add_development_dependency "bundler", "~> 1.15"

data/examples/chickens.rb

@@ -0,0 +1,37 @@
+
+require_relative '../lib/async/await'
+
+class Coop
+	include Async::Await
+	
+	async def count_chickens(area_name)
+		3.times do |i|
+			sleep rand
+			
+			puts "Found a chicken in the #{area_name}!"
+		end
+	end
+
+	async def find_chicken(areas)
+		puts "Searching for chicken..."
+		
+		sleep rand * 5
+		
+		return areas.sample
+	end
+
+	async def count_all_chickens
+		# These methods all run at the same time.
+		count_chickens("garden")
+		count_chickens("house")
+		count_chickens("tree")
+		
+		# Wait for all previous async work to complete...
+		barrier!
+		
+		puts "There was a chicken in the #{find_chicken(["garden", "house", "tree"]).wait}"
+	end
+end
+
+coop = Coop.new
+coop.count_all_chickens

data/lib/async/await.rb

@@ -1,4 +1,4 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -18,11 +18,26 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require "async/await/version"
+require_relative 'await/version'
+require_relative 'await/methods'
 
 module Async
-	def self.await(&block)
-		# Initial "blocking" implementation
-		yield
+	module Await
+		def self.included(klass)
+			klass.include(Methods)
+			klass.extend(self)
+		end
+		
+		def async(name)
+			original_method = instance_method(name)
+			
+			remove_method(name)
+			
+			define_method(name) do |*args|
+				Async::Reactor.run do |task|
+					original_method.bind(self).call(*args)
+				end
+			end
+		end
 	end
 end

data/lib/async/await/methods.rb

@@ -0,0 +1,39 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'async/reactor'
+
+module Async
+	module Await
+		module Methods
+			def sleep(*args)
+				Async::Task.current.sleep(*args)
+			end
+
+			def await(&block)
+				block.call.wait
+			end
+
+			def barrier!
+				Async::Task.current.children.each(&:wait)
+			end
+		end
+	end
+end

data/lib/async/await/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module Await
-		VERSION = "0.0.0"
+		VERSION = "0.1.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-await
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,9 @@ files:
 - README.md
 - Rakefile
 - async-await.gemspec
+- examples/chickens.rb
 - lib/async/await.rb
+- lib/async/await/methods.rb
 - lib/async/await/version.rb
 homepage: https://github.com/socketry/async-await
 licenses: []
@@ -115,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Implements the async/await pattern on top of async :)