async-io 1.12.1 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebac6fa4a3e3537fc0fdcead5b43f10d62cff1230f69347942a35baaae853760
-  data.tar.gz: 25fe69978444982daeefd3dd9793994f6d79b53d437f992b31425fdad48d6021
+  metadata.gz: '02688119fe7ef47b527495b74b5b60d5826de683dc4bc798b63f6c61ee962049'
+  data.tar.gz: c15e88f8b47470fe35b97ba674faaa20ac39f3cbab617a47523b66c516103125
 SHA512:
-  metadata.gz: d57fd2561c7d365479be8a4721718ccccc68e5d4430ba738642c8460a22ff5f51230c4c30d2ac7668417a10cc758fedd5e1ddea17eb56408461fbba918f4a66c
-  data.tar.gz: 276196bca0ab8a3fc7681e19d636a50169cebf9ffd97c1f39189d59a3f145d019d1b82982c35d4fc17c3d689c898fb52b5d5a678950fd176abe83e6889dd396d
+  metadata.gz: 224d6230ea743a3c4d5132222d4ef74c61362fa487c8da642ee470333be2cb8656604f5b4ccec4d28e0b799c22d13207c605ad1c4a53f2614e6cbc13c7d9ccf3
+  data.tar.gz: a129eceb200dc5171465d6b6f902efcf37d2c6b4d722c5ae1b82c716e66e78a77c8585742950482006a89fc86fc166ec6d83ce641eea09b7ef0e2ceefd7326f9

data/async-io.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 	spec.has_rdoc      = "yard"
 
 	spec.add_dependency "async", "~> 1.3"
-	spec.add_development_dependency "async-rspec", "~> 1.4"
+	spec.add_development_dependency "async-rspec", "~> 1.6"
 
 	spec.required_ruby_version = '~> 2.3'
 

data/examples/chat/client.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../../lib", __dir__)
+
+require 'async/reactor'
+require 'async/io/stream'
+require 'async/io/host_endpoint'
+require 'async/io/protocol/line'
+
+class User < Async::IO::Protocol::Line
+end
+
+endpoint = Async::IO::Endpoint.parse(ARGV.pop || "tcp://localhost:7138")
+
+input = Async::IO::Protocol::Line.new(
+	Async::IO::Stream.new(
+		Async::IO::Generic.new($stdin)
+	)
+)
+
+Async::Reactor.run do |task|
+	socket = endpoint.connect
+	stream = Async::IO::Stream.new(socket)
+	user = User.new(stream)
+	
+	connection = task.async do
+		while line = user.read_line
+			puts line
+		end
+	end
+	
+	while line = input.read_line
+		user.write_lines line
+	end
+rescue EOFError
+	# It's okay, we are disconnecting, because stdin has closed.
+ensure
+	connection.stop
+	user.close
+end

data/examples/chat/server.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../../lib", __dir__)
+
+require 'set'
+
+require 'async/reactor'
+require 'async/io/host_endpoint'
+require 'async/io/protocol/line'
+
+class User < Async::IO::Protocol::Line
+	attr_accessor :name
+	
+	def login!
+		self.write_lines "Tell me your name, traveller:"
+		self.name = self.read_line
+	end
+	
+	def to_s
+		@name || "unknown"
+	end
+end
+
+class Server
+	def initialize(endpoint)
+		@endpoint = endpoint
+		@users = Set.new
+	end
+	
+	def broadcast(*message)
+		puts *message
+		
+		@users.each do |user|
+			begin
+				user.write_lines(*message)
+			rescue EOFError
+				# In theory, it's possible this will fail if the remote end has disconnected. Each user has it's own task running `#connected`, and eventually `user.read_line` will fail. When it does, the disconnection logic will be invoked. A better way to do this would be to have a message queue, but for the sake of keeping this example simple, this is by far the better option.
+			end
+		end
+	end
+	
+	def connected(user)
+		user.login!
+		
+		broadcast("#{user} has joined")
+		
+		user.write_lines("currently connected: #{@users.map(&:to_s).join(', ')}")
+		
+		while message = user.read_line
+			broadcast("#{user.name}: #{message}")
+		end
+	rescue EOFError
+		# It's okay, client has disconnected.
+	ensure
+		disconnected(user)
+	end
+	
+	def disconnected(user, reason = "quit")
+		@users.delete(user)
+		
+		broadcast("#{user} has disconnected: #{reason}")
+	end
+	
+	def run
+		Async::Reactor.run do |task|
+			@endpoint.accept do |peer|
+				stream = Async::IO::Stream.new(peer)
+				user = User.new(stream)
+				
+				@users << user
+				
+				connected(user)
+			end
+		end
+	end
+end
+
+endpoint = Async::IO::Endpoint.parse(ARGV.pop || "tcp://localhost:7138")
+server = Server.new(endpoint)
+
+server.run

data/lib/async/io/protocol/line.rb

@@ -24,7 +24,7 @@ module Async
 	module IO
 		module Protocol
 			class Line
-				def initialize(stream, eol = $\)
+				def initialize(stream, eol = $/)
 					@stream = stream
 					@eol = eol
 				end
@@ -45,6 +45,8 @@ module Async
 							@stream.write(@eol)
 						end
 					end
+					
+					@stream.flush
 				end
 				
 				def read_line

data/lib/async/io/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module IO
-		VERSION = "1.12.1"
+		VERSION = "1.12.2"
 	end
 end

data/spec/async/io/protocol/line_spec.rb

@@ -23,12 +23,19 @@ require 'async/io/protocol/line'
 RSpec.describe Async::IO::Protocol::Line do
 	let(:io) {StringIO.new}
 	let(:stream) {Async::IO::Stream.new(io)}
-	let(:protocol) {described_class.new(stream, "\n")}
+	subject {described_class.new(stream, "\n")}
+	
+	context "default line ending" do
+		subject {described_class.new(stream)}
+		
+		it "should have default eol terminator" do
+			expect(subject.eol).to_not be_nil
+		end
+	end
 	
 	describe '#write_lines' do
 		it "should write line" do
-			protocol.write_lines "Hello World"
-			stream.flush
+			subject.write_lines "Hello World"
 			
 			expect(io.string).to be == "Hello World\n"
 		end
@@ -41,11 +48,11 @@ RSpec.describe Async::IO::Protocol::Line do
 		end
 		
 		it "should read one line" do
-			expect(protocol.read_line).to be == "Hello World"
+			expect(subject.read_line).to be == "Hello World"
 		end
 		
 		it "should be binary encoding" do
-			expect(protocol.read_line.encoding).to be == Encoding::BINARY
+			expect(subject.read_line.encoding).to be == Encoding::BINARY
 		end
 	end
 	
@@ -56,11 +63,11 @@ RSpec.describe Async::IO::Protocol::Line do
 		end
 		
 		it "should read multiple lines" do
-			expect(protocol.read_lines).to be == ["Hello", "World"]
+			expect(subject.read_lines).to be == ["Hello", "World"]
 		end
 		
 		it "should be binary encoding" do
-			expect(protocol.read_lines.first.encoding).to be == Encoding::BINARY
+			expect(subject.read_lines.first.encoding).to be == Encoding::BINARY
 		end
 	end
 end

data/spec/async/io/stream_spec.rb

@@ -50,6 +50,8 @@ RSpec.describe Async::IO::Stream do
 	end
 	
 	describe '#read_until' do
+		include_context Async::RSpec::Memory
+		
 		it "can read a line" do
 			io.write("hello\nworld\n")
 			io.seek(0)
@@ -58,6 +60,15 @@ RSpec.describe Async::IO::Stream do
 			expect(stream.read_until("\n")).to be == 'world'
 			expect(stream.read_until("\n")).to be_nil
 		end
+		
+		it "minimises allocations" do
+			io.write("hello\nworld\n")
+			io.seek(0)
+			
+			expect do
+				stream.read_until("\n")
+			end.to limit_allocations(String => 3)
+		end
 	end
 	
 	describe '#flush' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-io
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.12.2
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,9 @@ files:
 - README.md
 - Rakefile
 - async-io.gemspec
-- examples/broken_ssl.rb
+- examples/chat/client.rb
+- examples/chat/server.rb
+- examples/issues/broken_ssl.rb
 - lib/async/io.rb
 - lib/async/io/address.rb
 - lib/async/io/address_endpoint.rb