async-io 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b747d80615958a841ef56cbdb4d1aaa71a3cf3b1
-  data.tar.gz: b613b3dea61e0345267a52c458b51cd7c3ec7993
+  metadata.gz: 3fbd77d42c8f025d30053dc7e421240f1f2c68fa
+  data.tar.gz: 402ee863245252e8e3f19723876301650c9e6439
 SHA512:
-  metadata.gz: 23605b1a8f9ef861b7657d15f5b41abc6ca5efe63cc09a67da2cb7b3f14c9776964a76adf9ec1f044233576339ad963a6f1b18c4acbb239c806e3514857e1b67
-  data.tar.gz: bae87bb2a744df43d33c21ea8fe59ff37adee72c5fc9901b36ea456c0702763acf61d935039ec54fe1597a3a334da3307dc517fbef84d805462ae072750dacc1
+  metadata.gz: dae197ce5e7a47b42b3ec929777ab4baae97182f6e5c3fda6953223c983f1d9cc0f4034c495c12aa6a5e742b520aa138b17633ed667989fc8e714dad6e8a670e
+  data.tar.gz: 3ccb61d3e991fd5d52beabca6e6da9ee834adc637803c42405bd101446ba3dbbc7927119391a14b09605557346715947c5234be66e61fd944332a3984cfbd762

data/.travis.yml

@@ -2,16 +2,18 @@ language: ruby
 sudo: false
 dist: trusty
 cache: bundler
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - jruby-head
-  - ruby-head
-  - rbx-3
+
 matrix:
+  include:
+    - rvm: 2.0
+    - rvm: 2.1
+    - rvm: 2.2
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: ruby-head
+    - rvm: rbx-3
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/README.md

@@ -31,10 +31,10 @@ Basic echo server (from `spec/async/io/echo_spec.rb`):
 ```ruby
 require 'async/io'
 
-def echo_server(server_address)
+def echo_server(endpoint)
 	Async::Reactor.run do |task|
 		# This is a synchronous block within the current task:
-		Async::IO::Socket.accept(server_address) do |client|
+		endpoint.accept do |client|
 			# This is an asynchronous block within the current reactor:
 			data = client.read(512)
 			
@@ -46,9 +46,9 @@ def echo_server(server_address)
 	end
 end
 
-def echo_client(server_address, data)
+def echo_client(endpoint, data)
 	Async::Reactor.run do |task|
-		Async::IO::Socket.connect(server_address) do |peer|
+		endpoint.connect do |peer|
 			result = peer.write(data)
 			
 			message = peer.read(512)
@@ -59,12 +59,12 @@ def echo_client(server_address, data)
 end
 
 Async::Reactor.run do
-	server_address = Async::IO::Address.tcp('0.0.0.0', 9000)
+	endpoint = Async::IO::Endpoint.tcp('0.0.0.0', 9000)
 	
-	server = echo_server(server_address)
+	server = echo_server(endpoint)
 	
 	5.times.collect do |i|
-		echo_client(server_address, "Hello World #{i}")
+		echo_client(endpoint, "Hello World #{i}")
 	end.each(&:wait)
 	
 	server.stop

data/async-io.gemspec

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

data/lib/async/io.rb

@@ -22,7 +22,7 @@ require 'async'
 
 require_relative "io/generic"
 require_relative "io/socket"
-require_relative "io/address"
+require_relative "io/endpoint"
 require_relative "io/version"
 
 module Async

data/lib/async/io/{address.rb → endpoint.rb}

@@ -23,34 +23,37 @@ require 'uri'
 
 module Async
 	module IO
-		class Address < Struct.new(:specification, :options)
+		Address = Addrinfo
+		
+		class Endpoint < Struct.new(:specification, :options)
 			include ::Socket::Constants
 			include Comparable
 			
 			class << self
 				def parse(string, **options)
 					uri = URI.parse(string)
-					self.__send__(uri.scheme, uri.host, uri.port, **options)
+					self.send(uri.scheme, uri.host, uri.port, **options)
 				end
 				
 				def tcp(*args, **options)
-					self.new([:tcp, *args], **options)
+					self.new(Address.tcp(*args), **options)
 				end
 				
 				def udp(*args, **options)
-					self.new([:udp, *args], **options)
+					self.new(Address.udp(*args), **options)
 				end
 				
 				def unix(*args, **options)
-					self.new([:unix, *args], **options)
+					self.new(Address.unix(*args), **options)
 				end
 				
 				def each(specifications, &block)
 					specifications.each do |specification|
 						if specification.is_a? self
 							yield specification
+						elsif specification.is_a? Array
+							yield self.send(*specification)
 						else
-							# Perhaps detect options here?
 							yield self.new(specification)
 						end
 					end
@@ -61,43 +64,43 @@ module Async
 				super(specification, options)
 			end
 			
-			def == other
-				self.to_sockaddr == other.to_sockaddr
-			end
-			
-			def <=> other
-				self.to_sockaddr <=> other.to_sockaddr
-			end
-			
 			def to_sockaddr
-				addrinfo.to_sockaddr
+				address.to_sockaddr
 			end
 			
 			# This is how addresses are internally converted, e.g. within `Socket#sendto`.
 			alias to_str to_sockaddr
 			
-			def socktype
-				addrinfo.socktype
+			def address
+				@address ||= case specification
+					when Addrinfo
+						specification
+					when ::BasicSocket, BasicSocket
+						specification.local_address
+				else
+					raise ArgumentError, "Not sure how to convert #{specification} into address!"
+				end
 			end
 			
-			# Preferred accessor for socket type.
-			alias type socktype
-			
-			def afamily
-				addrinfo.afamily
+			# SOCK_STREAM, SOCK_DGRAM, SOCK_RAW, etc.
+			def socket_type
+				address.socktype
 			end
 			
-			# Preferred accessor for address family.
-			alias family afamily
+			# PF_* eg PF_INET etc, normally identical to AF_* constants.
+			def socket_domain
+				address.afamily
+			end
 			
-			# def connect? accept? DatagramHandler StreamHandler
+			# IPPROTO_TCP, IPPROTO_UDP, IPPROTO_IPX, etc.
+			def socket_protocol
+				address.protocol
+			end
 			
 			def bind(&block)
 				case specification
 				when Addrinfo
 					Socket.bind(specification, **options, &block)
-				when Array
-					Socket.bind(Addrinfo.send(*specification), **options, &block)
 				when ::BasicSocket
 					yield Socket.new(specification)
 				when BasicSocket
@@ -118,31 +121,14 @@ module Async
 			
 			def connect(&block)
 				case specification
-				when Addrinfo, Array
-					Socket.connect(self, &block)
+				when Addrinfo
+					Socket.connect(specification, &block)
 				when ::BasicSocket
 					yield Async::IO.try_convert(specification)
 				when BasicSocket
 					yield specification
 				else
-					raise ArgumentError, "Not sure how to bind to #{specification}!"
-				end
-			end
-			
-			private
-			
-			def addrinfo
-				@addrinfo ||= case specification
-					when Addrinfo
-						specification
-					when Array
-						Addrinfo.send(*specification)
-					when ::BasicSocket
-						specification.local_address
-					when BasicSocket
-						specification.local_address
-				else
-					raise ArgumentError, "Not sure how to convert #{specification} into address!"
+					raise ArgumentError, "Not sure how to connect to #{specification}!"
 				end
 			end
 		end

data/lib/async/io/socket.rb

@@ -102,10 +102,10 @@ module Async
 			# @param remote_address [Addrinfo] The remote address to connect to.
 			# @param local_address [Addrinfo] The local address to bind to before connecting.
 			# @option protcol [Integer] The socket protocol to use.
-			def self.connect(remote_address, local_address = nil, protocol: 0, task: Task.current)
+			def self.connect(remote_address, local_address = nil, task: Task.current)
 				task.annotate "connecting to #{remote_address.inspect}"
 				
-				wrapper = build(remote_address.afamily, remote_address.socktype, protocol) do |socket|
+				wrapper = build(remote_address.afamily, remote_address.socktype, remote_address.protocol) do |socket|
 					socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_REUSEADDR, true)
 					
 					if local_address

data/lib/async/io/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module IO
-		VERSION = "0.5.0"
+		VERSION = "1.0.0"
 	end
 end

data/spec/async/io/c10k_spec.rb

@@ -56,6 +56,8 @@ RSpec.describe "echo client/server" do
 				client.write(data)
 			end
 		end
+	ensure
+		puts "echo_server: #{$!.inspect}"
 	end
 	
 	def echo_client(server_address, data, responses)

data/spec/async/io/echo_spec.rb

@@ -23,7 +23,7 @@ require 'async/io'
 RSpec.describe "echo client/server" do
 	include_context Async::RSpec::Reactor
 	
-	let(:server_address) {Async::IO::Address.new([:tcp, '0.0.0.0', 9000])}
+	let(:server_address) {Async::IO::Address.tcp('0.0.0.0', 9000)}
 	
 	def echo_server(server_address)
 		Async::Reactor.run do |task|

data/spec/async/io/{address_spec.rb → endpoint_spec.rb}

@@ -18,28 +18,28 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'async/io/address'
+require 'async/io/endpoint'
 
-RSpec.describe Async::IO::Address do
+RSpec.describe Async::IO::Endpoint do
 	include_context Async::RSpec::Reactor
 	
-	describe Async::IO::Address.new([:tcp, '0.0.0.0', 1234]) do
+	describe Async::IO::Endpoint.tcp('0.0.0.0', 1234) do
 		it "should be a tcp binding" do
-			expect(subject.socktype).to be == ::Socket::SOCK_STREAM
+			expect(subject.socket_type).to be == ::Socket::SOCK_STREAM
 		end
 		
 		it "should generate valid address" do
-			expect(subject).to be == Addrinfo.tcp('0.0.0.0', 1234)
+			expect(subject.address).to be == Async::IO::Address.tcp('0.0.0.0', 1234)
 		end
 	end
 	
-	describe Async::IO::Address.new(TCPServer.new('0.0.0.0', 1234)) do
+	describe Async::IO::Endpoint.new(TCPServer.new('0.0.0.0', 1234)) do
 		it "should be a tcp binding" do
-			expect(subject.socktype).to be == ::Socket::SOCK_STREAM
+			expect(subject.socket_type).to be == ::Socket::SOCK_STREAM
 		end
 		
 		it "should generate valid address" do
-			expect(subject).to be == Addrinfo.tcp('0.0.0.0', 1234)
+			expect(subject.address).to be == Async::IO::Address.tcp('0.0.0.0', 1234)
 		end
 	end
 end

data/spec/spec_helper.rb

@@ -19,6 +19,21 @@ end
 require "bundler/setup"
 require "async/io"
 
+# This is useful for specs, but I hesitate to monkey patch a core class in the library itself.
+class Addrinfo
+	def == other
+		self.to_s == other.to_s
+	end
+	
+	def != other
+		self.to_s != other.to_s
+	end
+	
+	def <=> other
+		self.to_s <=> other.to_s
+	end
+end
+
 # Shared rspec helpers:
 require "async/rspec"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-io
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-15 00:00:00.000000000 Z
+date: 2017-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,8 +95,8 @@ files:
 - Rakefile
 - async-io.gemspec
 - lib/async/io.rb
-- lib/async/io/address.rb
 - lib/async/io/binary_string.rb
+- lib/async/io/endpoint.rb
 - lib/async/io/generic.rb
 - lib/async/io/protocol/line.rb
 - lib/async/io/socket.rb
@@ -106,9 +106,9 @@ files:
 - lib/async/io/unix_socket.rb
 - lib/async/io/version.rb
 - lib/async/io/wrap/tcp.rb
-- spec/async/io/address_spec.rb
 - spec/async/io/c10k_spec.rb
 - spec/async/io/echo_spec.rb
+- spec/async/io/endpoint_spec.rb
 - spec/async/io/generic_spec.rb
 - spec/async/io/protocol/line_spec.rb
 - spec/async/io/socket_spec.rb
@@ -142,9 +142,9 @@ signing_key:
 specification_version: 4
 summary: Provides support for asynchonous TCP, UDP, UNIX and SSL sockets.
 test_files:
-- spec/async/io/address_spec.rb
 - spec/async/io/c10k_spec.rb
 - spec/async/io/echo_spec.rb
+- spec/async/io/endpoint_spec.rb
 - spec/async/io/generic_spec.rb
 - spec/async/io/protocol/line_spec.rb
 - spec/async/io/socket_spec.rb