async-await 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 982110e1afe4ee24f5931671df9df8036170b4b2b3cb4dcc8bc1e924739c2099
-  data.tar.gz: d6fd5e852edadf8a2b48090847225ac1df2e372ac37c4fbd126b0dc6970c9637
+  metadata.gz: 60b68ca501e24b540ab2868d13331718fedce992928ed6ac3e29ae00caa3ef82
+  data.tar.gz: 1e56657845f348d4c5657974a35c417176ddf5e63c595a8084e3fe0f7ff2f291
 SHA512:
-  metadata.gz: f05e45a97e6cac339a4f6a1bba1e59d2a78ebe7f8f0741adb95525f9c376b5c358685d7a3b68ef3df98ece474f269903fd205bc74d7002b0c6a77183f0cd943f
-  data.tar.gz: 0c43a301fb491a90611d14717885913c6934c943f2616d744e23e360bc86b43cb33cd6752dddd7edbcbff370220bbd916f23fa994d302d938f9b9f7719921e89
+  metadata.gz: 502521efb2e174c861cc324fbdb8c141e37c16ddd2c91664fd54e3b90d9e4a3bc103ef12a01b41deb4fed4d3997a2bce4820b14d9d10f3ea38f50b4b0b505810
+  data.tar.gz: 231a2b125fa5f63260ea6cfb83f06c7beab995e35c868b7d87932b4105d43b31491287081d431ecdee9ef9a906d4b051dcf3c79a49d90826511fef2d22561b15

data/lib/async/await/enumerable.rb

@@ -22,17 +22,17 @@ module Async
 	module Await
 		module Enumerable
 			def async_map(parent: Task.current, &block)
-				self.map do |*args|
+				self.map do |*arguments|
 					parent.async do
-						yield *args
+						yield(*arguments)
 					end
 				end.map(&:wait)
 			end
 			
 			def async_each(parent: Task.current, &block)
-				self.each do |*args|
+				self.each do |*arguments|
 					parent.async do
-						yield *args
+						yield(*arguments)
 					end
 				end
 				

data/lib/async/await/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module Await
-		VERSION = "0.5.0"
+		VERSION = "0.6.0"
 	end
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: async-await
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: async-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
   requirement: !ruby/object:Gem::Requirement
@@ -53,21 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: async-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,36 +80,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- async-await.gemspec
-- examples/chickens.rb
-- examples/echo.rb
-- examples/port_scanner/README.md
-- examples/port_scanner/port_scanner.go
-- examples/port_scanner/port_scanner.py
-- examples/port_scanner/port_scanner.rb
-- examples/sleep_sort.rb
 - lib/async/await.rb
 - lib/async/await/enumerable.rb
 - lib/async/await/methods.rb
 - lib/async/await/version.rb
 homepage: https://github.com/socketry/async-await
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.0
+signing_key:
 specification_version: 4
 summary: Implements the async/await pattern on top of async :)
 test_files: []

data/.editorconfig

@@ -1,6 +0,0 @@
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.3
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.7
-    - rvm: 2.6
-      env: COVERAGE=BriefSummary,Coveralls
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby

data/Gemfile

@@ -1,13 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development do
-	gem 'pry'
-	gem 'async-io', '~> 1.4'
-end
-
-group :test do
-	gem 'benchmark-ips'
-	gem 'ruby-prof', platforms: :mri
-end

data/README.md

@@ -1,95 +0,0 @@
-# Async::Await
-
-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)
-[![Coverage Status](https://coveralls.io/repos/socketry/async-await/badge.svg)](https://coveralls.io/r/socketry/async-await)
-
-[async]: https://github.com/socketry/async
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'async-await'
-```
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install async-await
-
-## Usage
-
-In any asynchronous context (e.g. a reactor), simply use the `await` function like so:
-
-```ruby
-require '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
-
-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
-
-## See Also
-
-- [async-io](https://github.com/socketry/async-io) — Asynchronous networking and sockets.
-- [async-dns](https://github.com/socketry/async-dns) — Asynchronous DNS resolver and server.
-- [async-rspec](https://github.com/socketry/async-rspec) — Shared contexts for running async specs.
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-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.

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/async-await.gemspec

@@ -1,28 +0,0 @@
-# coding: utf-8
-require_relative "lib/async/await/version"
-
-Gem::Specification.new do |spec|
-	spec.name          = "async-await"
-	spec.version       = Async::Await::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-
-	spec.summary       = "Implements the async/await pattern on top of async :)"
-	spec.homepage      = "https://github.com/socketry/async-await"
-
-	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-		f.match(%r{^(test|spec|features)/})
-	end
-	
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency "async", "~> 1.3"
-	spec.add_development_dependency "async-rspec", "~> 1.1"
-	
-	spec.add_dependency "ruby2_keywords"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rake", "~> 10.0"
-	spec.add_development_dependency "rspec", "~> 3.0"
-end

data/examples/chickens.rb

@@ -1,37 +0,0 @@
-
-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/examples/echo.rb

@@ -1,55 +0,0 @@
-
-require_relative '../lib/async/await'
-
-require 'async/io'
-require 'async/io/tcp_socket'
-
-require 'pry'
-
-class Echo
-	include Async::Await
-	include Async::IO
-	
-	async def handle(peer, address)
-		data = peer.gets
-		peer.puts("#{data} #{Time.now}")
-	ensure
-		peer.close
-	end
-	
-	async def server
-		puts "Binding server..."
-		server = TCPServer.new("127.0.0.1", 9009)
-		
-		handle(*server.accept)
-	ensure
-		server.close rescue nil
-	end
-
-	async def client
-		puts "Client connecting..."
-		client = TCPSocket.new("127.0.0.1", 9009)
-		
-		client.puts("Hello World!")
-		response = client.gets
-		
-		puts "Server said: #{response}"
-	ensure
-		client.close rescue nil
-	end
-
-	async def run
-		puts "Creating server..."
-		server
-		
-		puts "Creating client..."
-		client
-		
-		puts "Run returning..."
-	end
-end
-
-puts "Starting echo..."
-echo = Echo.new
-echo.run
-puts "Echo finished :)"

data/examples/port_scanner/README.md

@@ -1,90 +0,0 @@
-# Port Scanner
-
-A simple `connect`-based port scanner. It scans locahost for all open ports.
-
-## Usage
-
-### Go
-
-Go is pretty awesome, because when the operation would not block, it runs sequentially in the same thread. Go spins up threads and delegates work across available CPU cores.
-
-	$ go get golang.org/x/sync/semaphore
-	$ go build port_scanner.go
-	$ time ./port_scanner
-	22 open
-	139 open
-	445 open
-	3306 open
-	5355 open
-	5432 open
-	6379 open
-	9293 open
-	9292 open
-	9516 open
-	9515 open
-	12046 open
-	12813 open
-	./port_scanner  1.70s user 1.18s system 503% cpu 0.572 total
-
-### Python
-
-Python was the slowest. This is possibly due to the implementation of semaphore. It creates all 65,535 tasks, and then most of them block on the semaphore.
-
-	$ ./port_scanner.py
-	5355 open
-	5432 open
-	3306 open
-	39610 open
-	58260 open
-	12813 open
-	139 open
-	445 open
-	12046 open
-	22 open
-	9292 open
-	9293 open
-	9515 open
-	9516 open
-	6379 open
-	./port_scanner.py  11.41s user 0.88s system 98% cpu 12.485 total
-
-### Ruby
-
-Ruby performance isn't that bad. It's only about half as fast as Go, considering that Go runs across all cores, while the Ruby implementation is limited to one core.
-
-	$ ./port_scanner.rb
-	22 open
-	139 open
-	445 open
-	3306 open
-	5432 open
-	5355 open
-	6379 open
-	9516 open
-	9515 open
-	9293 open
-	9292 open
-	12046 open
-	12813 open
-	./port_scanner.rb  5.99s user 1.18s system 95% cpu 7.543 total
-
-## Notes
-
-### Why do I sometimes see high ports?
-
-Believe it or not, you can connect to your own sockets.
-
-```ruby
-require 'socket'
-a = Addrinfo.tcp("127.0.0.1", 50000)
-s = Socket.new(Socket::AF_INET,  Socket::SOCK_STREAM, 0)
-s.bind(a)
-s.connect(a)
-
-s.write("Hello World")
-=> 11
-[8] pry(main)> s.read(11)
-=> "Hello World"
-```
-
-What's happening is that your socket is implicitly binding to a high port, and at the same time it's trying to connect to it.

data/examples/port_scanner/port_scanner.go

@@ -1,107 +0,0 @@
-package main
-
-import (
-	"context"
-	"fmt"
-	"golang.org/x/sync/semaphore"
-	"net"
-	"syscall"
-	"strings"
-	"sync"
-	"time"
-)
-
-// The star of the show, of modest means,
-// used to manage the port scan for a single host.
-type PortScanner struct {
-	ip   string
-	lock *semaphore.Weighted
-}
-
-// Provides a simple wrapper to initializing a PortScanner.
-func NewPortScanner(ip string, limit uint64) *PortScanner {
-	return &PortScanner{
-		ip: ip,
-		lock: semaphore.NewWeighted(int64(limit)),
-	}
-}
-
-// Compute the maximum number of files we can open.
-func FileLimit(max uint64) uint64 {
-	var rlimit syscall.Rlimit
-	err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rlimit)
-	if err != nil {
-		panic(err)
-	}
-	
-	if (max < rlimit.Cur) {
-		return max
-	}
-	
-	return rlimit.Cur
-}
-
-// As the name might suggest, this function checks if a given port
-// is open to TCP communication. Used in conjunction with the Start function
-// to sweep over a range of ports concurrently.
-func checkPortOpen(ip string, port int, timeout time.Duration) {
-	conn, err := net.DialTimeout("tcp", fmt.Sprintf("%s:%d", ip, port), timeout)
-
-	if err != nil {
-		if strings.Contains(err.Error(), "timeout") {
-			fmt.Println(port, "timeout", err.Error())
-		} else if strings.Contains(err.Error(), "deadline exceeded") {
-			fmt.Println(port, "timeout", err.Error())
-		} else if strings.Contains(err.Error(), "refused") {
-			// fmt.Println(port, "closed", err.Error())
-		} else {
-			panic(err)
-		}
-		return
-	}
-
-	fmt.Println(port, "open")
-	conn.Close()
-}
-
-// This function is the bread and butter of this script. It manages the
-// port scanning for a given range of ports with the given timeout value
-// to deal with filtered ports by a firewall typically.
-func (ps *PortScanner) Start(start, stop int, timeout time.Duration) {
-	wg := sync.WaitGroup{}
-	defer wg.Wait()
-
-	for port := start; port <= stop; port++ {
-
-		ctx := context.TODO()
-
-		for {
-			err := ps.lock.Acquire(ctx, 1)
-			if err == nil {
-				break
-			}
-		}
-
-		wg.Add(1)
-
-		go func(ip string, port int) {
-			defer ps.lock.Release(1)
-			defer wg.Done()
-
-			checkPortOpen(ps.ip, port, timeout)
-		}(ps.ip, port)
-
-	}
-}
-
-// This function kicks off the whole shindig' and provides a
-// basic example of the internal API usage.
-func main() {
-	batch_size := FileLimit(512)
-	
-	// Create a new PortScanner for localhost.
-	ps := NewPortScanner("127.0.0.1", batch_size)
-
-	// Start scanning all the ports on localhost.
-	ps.Start(1, 65535, 1000*time.Millisecond)
-}

data/examples/port_scanner/port_scanner.py

@@ -1,36 +0,0 @@
-#!/usr/bin/env python
-
-import os, resource
-import asyncio
-
-class PortScanner:
-    def __init__(self, host="0.0.0.0", ports=range(1, 1024+1), batch_size=1024):
-        self.host       = host
-        self.ports      = ports
-        self.semaphore  = asyncio.Semaphore(value=batch_size)
-        self.loop       = asyncio.get_event_loop()
-
-    async def scan_port(self, port, timeout):
-        async with self.semaphore:
-            try:
-                future = asyncio.open_connection(self.host, port, loop=self.loop)
-                reader, writer = await asyncio.wait_for(future, timeout=timeout)
-                print("{} open".format(port))
-                writer.close()
-            except ConnectionRefusedError:
-                pass
-                # print("{} closed".format(port))
-            except asyncio.TimeoutError:
-                print("{} timeout".format(port))
-
-    def start(self, timeout=1.0):
-        self.loop.run_until_complete(asyncio.gather(
-            *[self.scan_port(port, timeout) for port in self.ports]
-            ))
-
-limits = resource.getrlimit(resource.RLIMIT_NOFILE)
-batch_size = min(512, limits[0])
-
-scanner = PortScanner(host="127.0.0.1", ports=range(1, 65535+1), batch_size=batch_size)
-
-scanner.start()

data/examples/port_scanner/port_scanner.rb

@@ -1,44 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'async/io'
-require 'async/semaphore'
-require_relative '../../lib/async/await'
-
-class PortScanner
-  include Async::Await
-  include Async::IO
-
-  def initialize(host: '0.0.0.0', ports:, batch_size: 1024)
-    @host      = host
-    @ports     = ports
-    @semaphore = Async::Semaphore.new(batch_size)
-  end
-
-  def scan_port(port, timeout)
-    with_timeout(timeout) do
-      address = Async::IO::Address.tcp(@host, port)
-      peer = Socket.connect(address)
-      puts "#{port} open"
-      peer.close
-    end
-  rescue Errno::ECONNREFUSED
-    # puts "#{port} closed"
-  rescue Async::TimeoutError
-    puts "#{port} timeout"
-  end
-
-  async def start(timeout = 1.0)
-    @ports.map do |port|
-      @semaphore.async do
-        scan_port(port, timeout)
-      end
-    end.collect(&:result)
-  end
-end
-
-limits = Process.getrlimit(Process::RLIMIT_NOFILE)
-batch_size = [512, (limits.first * 0.9).ceil].min
-
-scanner = PortScanner.new(host: "127.0.0.1", ports: Range.new(1, 65535), batch_size: batch_size)
-
-scanner.start

data/examples/sleep_sort.rb

@@ -1,29 +0,0 @@
-
-require_relative '../lib/async/await'
-
-class << self
-	include Async::Await
-	
-	async def sort_one(item, into)
-		sleep(item.to_f)
-		into << item
-		
-		puts "I've sorted #{item} for you."
-	end
-	
-	async def sort(items)
-		result = []
-		
-		items.each do |item|
-			sort_one(item, result)
-		end
-		
-		# Wait until all previous async method calls have finished executing.
-		barrier!
-		
-		return result
-	end
-end
-
-puts "Hold on, sorting..."
-puts sort([5, 2, 3, 4, 9, 2, 5, 7, 8]).result.inspect