async-io 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc74a7c6901edc284210da8593a505e0eb87ff89
-  data.tar.gz: d5c4e46d022296613e94dfbcc6409727dc33dcb2
+  metadata.gz: de9c8da76ca6bc5d7065b6729d187dcc235d2ea7
+  data.tar.gz: 299c561ae952ae21a611cfa083f98b3789f89d6b
 SHA512:
-  metadata.gz: 79274376a216fce20ee3a1d8f56f2767f9a9c6cc107d20bc9780ceb4ce29c5e32f7e5a34a7ac84b6d57d55eb28cd00d4d6fd8ee32208a7e1a7015b146f5e10b4
-  data.tar.gz: dc4e658c5411145c90359ef91dc565027b8c1ed36e22abd92e4907b20958f2e3b03e9cccb3a503c443c0cdfbceb58a4204226cd6d735681e3df6cec60c4317b6
+  metadata.gz: 396a2e21a43f0048282a144737226361fe9b0c6cd1376c7cc359c8522ab1e0a20fb721397ee6a18d81bc5eb9db87a0aa36c341786a58d69f521f3a82287eab53
+  data.tar.gz: d0627c41180d5d5faa92155a4feea2ee5f75285ad54105f2f9f17fe9a6a35789b9ecc9b3c0d2f2829f6987de4c7616ef8923eb41ffbee4b187eb8fd62a0a0529

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+.tags

data/lib/async/io/binary_string.rb

@@ -0,0 +1,39 @@
+# Copyright, 2017, 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.
+
+module Async
+	module IO
+		class BinaryString < String
+			def initialize(*args)
+				super
+				
+				force_encoding(Encoding::BINARY)
+			end
+			
+			def << string
+				super
+				
+				force_encoding(Encoding::BINARY)
+			end
+			
+			alias concat <<
+		end
+	end
+end

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

@@ -0,0 +1,74 @@
+# Copyright, 2017, 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_relative '../stream'
+
+module Async
+	module IO
+		module Protocol
+			class Line
+				def initialize(stream, eol = $\)
+					@stream = stream
+					@eol = eol
+				end
+				
+				attr :stream
+				attr :eol
+				
+				def write_lines(*args)
+					if args.empty?
+						@stream.write(@eol)
+					else
+						args.each do |arg|
+							@stream.write(arg)
+							@stream.write(@eol)
+						end
+					end
+				end
+				
+				def read_line
+					@stream.read_until(@eol) or raise EOFError
+				end
+				
+				def peek_line
+					@stream.peek do |read_buffer|
+						if index = read_buffer.index(@eol)
+							return read_buffer.slice(0, index)
+						end
+					end
+					
+					raise EOFError
+				end
+				
+				def each_line
+					return to_enum(:each_line) unless block_given?
+					
+					while line = @stream.read_until(@eol)
+						yield line
+					end
+				end
+				
+				def read_lines
+					@stream.read.split(@eol)
+				end
+			end
+		end
+	end
+end

data/lib/async/io/stream.rb

@@ -18,37 +18,18 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'socket'
+require_relative 'binary_string'
 require_relative 'generic'
 
 module Async
 	module IO
-		class BinaryString < String
-			def initialize(*args)
-				super
-				
-				force_encoding(Encoding::BINARY)
-			end
-			
-			def << string
-				super
-				
-				force_encoding(Encoding::BINARY)
-			end
-			
-			alias concat <<
-		end
-		
 		class Stream
-			include Enumerable
-			
-			def initialize(io, block_size: 1024, eol: $/)
+			def initialize(io, block_size: 1024*4, sync: false)
 				@io = io
 				@eof = false
-				@sync = false
 				
 				@block_size = block_size
-				@eol = eol
+				@sync = sync
 				
 				@read_buffer = BinaryString.new
 				@write_buffer = BinaryString.new
@@ -59,38 +40,15 @@ module Async
 			# The "sync mode" of the stream. See IO#sync for full details.
 			attr_accessor :sync
 			
-			# Reads `size` bytes from the stream.  If `buffer` is provided it must
-			# reference a string which will receive the data.
-			#
-			# See IO#read for full details.
-			def read(size = nil, output_buffer = nil)
-				if size == 0
-					if output_buffer
-						output_buffer.clear
-						return output_buffer
-					else
-						return ""
-					end
-				end
-
-				until @eof
-					break if size && size <= @read_buffer.size
+			# Reads `size` bytes from the stream. If size is not specified, read until end of file.
+			def read(size = nil)
+				return "" if size == 0
+				
+				until @eof || (size && size <= @read_buffer.size)
 					fill_read_buffer
-					break unless size
 				end
 
-				buffer = consume_read_buffer(size)
-
-				if buffer && output_buffer
-					output_buffer.replace(buffer)
-					buffer = output_buffer
-				end
-
-				if size
-					return buffer
-				else
-					return buffer || ""
-				end
+				return consume_read_buffer(size)
 			end
 
 			# Writes `string` to the buffer. When the buffer is full or #sync is true the
@@ -107,9 +65,17 @@ module Async
 				return string.bytesize
 			end
 
+			# Writes `string` to the stream and returns self.
+			def <<(string)
+				write(string)
+				
+				return self
+			end
+
 			# Flushes buffered data to the stream.
 			def flush
 				syswrite(@write_buffer)
+				@write_buffer.clear
 			end
 
 			# Closes the stream and flushes any unwritten data.
@@ -119,160 +85,42 @@ module Async
 				@io.close
 			end
 
-			# Reads the next line from the stream. Lines are separated by +eol+. If
-			# +limit+ is provided the result will not be longer than the given number of
-			# bytes.
-			#
-			# +eol+ may be a String or Regexp.
-			#
-			# Unlike IO#gets the line read will not be assigned to +$_+.
-			#
-			# Unlike IO#gets the separator must be provided if a limit is provided.
-			def gets(eol = @eol, limit = nil)
-				index = @read_buffer.index(eol)
-				
-				until index || @eof
-					fill_read_buffer
-					index = @read_buffer.index(eol)
-				end
-
-				if eol.is_a?(Regexp)
-					size = index ? index+$&.bytesize : nil
-				else
-					size = index ? index+eol.bytesize : nil
-				end
-
-				if limit && limit >= 0
-					size = [size, limit].min
-				end
-
-				consume_read_buffer(size)
-			end
-
-			# Executes the block for every line in the stream where lines are separated
-			# by +eol+.
-			#
-			# See also #gets
-			def each(eol = @eol)
-				while line = self.gets(eol)
-					yield line
-				end
-			end
-			alias each_line each
-
-			# Reads lines from the stream which are separated by +eol+.
-			#
-			# See also #gets
-			def readlines(eol = @eol)
-				lines = []
-
-				while line = self.gets(eol)
-					lines << line
-				end
-
-				lines
-			end
-
-			# Reads a line from the stream which is separated by +eol+.
-			#
-			# Raises EOFError if at end of file.
-			def readline(eol=@eol)
-				gets(eol) or raise EOFError
-			end
-
-			# Reads one character from the stream.  Returns nil if called at end of
-			# file.
-			def getc
-				read(1)
-			end
-
-			# Calls the given block once for each byte in the stream.
-			def each_byte # :yields: byte
-				while c = getc
-					yield(c.ord)
-				end
-			end
-
-			# Reads a one-character string from the stream.  Raises an EOFError at end
-			# of file.
-			def readchar
-				getc or raise EOFError
-			end
-
 			# Returns true if the stream is at file which means there is no more data to be read.
 			def eof?
 				fill_read_buffer if !@eof && @read_buffer.empty?
 				
-				@eof && @read_buffer.empty?
+				return @eof && @read_buffer.empty?
 			end
+			
 			alias eof eof?
-
-			# Writes `string` to the stream and returns self.
-			def <<(string)
-				write(string)
+			
+			# Efficiently read data from the stream until encountering pattern.
+			# @param pattern [String] The pattern to match.
+			# @return [String] The contents of the stream up until the pattern, which is consumed but not returned.
+			def read_until(pattern)
+				index = @read_buffer.index(pattern)
 				
-				return self
-			end
-
-			# Writes `args` to the stream along with a record separator. See `IO#puts` for full details.
-			def puts(*args, eol: @eol)
-				if args.empty?
-					write(eol)
-				else
-					args.each do |arg|
-						string = arg.to_s
-						if string.end_with? eol
-							write(string)
-						else
-							write(string)
-							write(eol)
-						end
-					end
+				until index || @eof
+					fill_read_buffer
+					
+					index = @read_buffer.index(pattern)
 				end
 				
-				return nil
-			end
-
-			# Writes `args` to the stream. See `IO#print` for full details.
-			def print(*args)
-				args.each do |arg|
-					write(arg.to_s)
+				if line = consume_read_buffer(index)
+					consume_read_buffer(pattern.bytesize)
+					
+					return line
 				end
-				
-				return nil
-			end
-
-			# Formats and writes to the stream converting parameters under control of the format string. See `Kernel#sprintf` for format string details.
-			def printf(s, *args)
-				write(s % args)
-				
-				return nil
 			end
-
-			private
 			
-			# Write a buffer to the underlying stream.
-			# @param buffer [String] The string to write, any encoding is okay.
-			def syswrite(buffer)
-				remaining = buffer.bytesize
-				
-				# Fast path:
-				written = @io.write(buffer)
-				return if written == remaining
-				
-				# Slow path:
-				remaining -= written
-				
-				while remaining > 0
-					wrote = @io.write(buffer.byteslice(written, remaining))
-					
-					remaining -= wrote
-					written += wrote
+			def peek
+				until yield(@read_buffer) || @eof
+					fill_read_buffer
 				end
-				
-				return written
 			end
-
+			
+			private
+			
 			# Fills the buffer from the underlying stream.
 			def fill_read_buffer
 				if buffer = @io.read(@block_size)
@@ -302,6 +150,28 @@ module Async
 				
 				return result
 			end
+			
+			# Write a buffer to the underlying stream.
+			# @param buffer [String] The string to write, any encoding is okay.
+			def syswrite(buffer)
+				remaining = buffer.bytesize
+				
+				# Fast path:
+				written = @io.write(buffer)
+				return if written == remaining
+				
+				# Slow path:
+				remaining -= written
+				
+				while remaining > 0
+					wrote = @io.write(buffer.byteslice(written, remaining))
+					
+					remaining -= wrote
+					written += wrote
+				end
+				
+				return written
+			end
 		end
 	end
 end

data/lib/async/io/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module IO
-		VERSION = "0.3.0"
+		VERSION = "0.4.0"
 	end
 end

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

@@ -0,0 +1,66 @@
+# Copyright, 2017, 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/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")}
+	
+	describe '#write_lines' do
+		it "should write line" do
+			protocol.write_lines "Hello World"
+			stream.flush
+			
+			expect(io.string).to be == "Hello World\n"
+		end
+	end
+	
+	describe '#read_line' do
+		before(:each) do
+			io.puts "Hello World"
+			io.seek(0)
+		end
+		
+		it "should read one line" do
+			expect(protocol.read_line).to be == "Hello World"
+		end
+		
+		it "should be binary encoding" do
+			expect(protocol.read_line.encoding).to be == Encoding::BINARY
+		end
+	end
+	
+	describe '#read_lines' do
+		before(:each) do
+			io << "Hello\nWorld\n"
+			io.seek(0)
+		end
+		
+		it "should read multiple lines" do
+			expect(protocol.read_lines).to be == ["Hello", "World"]
+		end
+		
+		it "should be binary encoding" do
+			expect(protocol.read_lines.first.encoding).to be == Encoding::BINARY
+		end
+	end
+end

data/spec/async/io/stream_spec.rb

@@ -22,44 +22,24 @@ require 'async/io/stream'
 
 RSpec.describe Async::IO::Stream do
 	let(:io) {StringIO.new}
-	let(:stream) {Async::IO::Stream.new(io, eol: "\n")}
+	let(:stream) {Async::IO::Stream.new(io)}
 	
-	describe '#puts' do
-		it "should write line" do
-			stream.puts "Hello World"
-			stream.flush
-			
-			expect(io.string).to be == "Hello World\n"
-		end
-	end
-	
-	describe '#readline' do
-		before(:each) do
+	describe '#read' do
+		it "should read everything" do
 			io.puts "Hello World"
 			io.seek(0)
-		end
-		
-		it "should read one line" do
-			expect(stream.readline).to be == "Hello World\n"
-		end
-		
-		it "should be binary encoding" do
-			expect(stream.readline.encoding).to be == Encoding::BINARY
+			
+			expect(stream.read).to be == "Hello World\n"
+			expect(stream).to be_eof
 		end
 	end
 	
-	describe '#readlines' do
-		before(:each) do
-			io << "Hello\nWorld\n"
-			io.seek(0)
-		end
-		
-		it "should read multiple lines" do
-			expect(stream.readlines).to be == ["Hello\n", "World\n"]
-		end
-		
-		it "should be binary encoding" do
-			expect(stream.readlines.first.encoding).to be == Encoding::BINARY
+	describe '#write' do
+		it "should read one line" do
+			stream.write "Hello World\n"
+			stream.flush
+			
+			expect(io.string).to be == "Hello World\n"
 		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-io
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -96,7 +96,9 @@ files:
 - async-io.gemspec
 - lib/async/io.rb
 - lib/async/io/address.rb
+- lib/async/io/binary_string.rb
 - lib/async/io/generic.rb
+- lib/async/io/protocol/line.rb
 - lib/async/io/socket.rb
 - lib/async/io/stream.rb
 - lib/async/io/tcp_socket.rb
@@ -108,6 +110,7 @@ files:
 - spec/async/io/c10k_spec.rb
 - spec/async/io/echo_spec.rb
 - spec/async/io/generic_spec.rb
+- spec/async/io/protocol/line_spec.rb
 - spec/async/io/socket_spec.rb
 - spec/async/io/stream_spec.rb
 - spec/async/io/tcp_socket_spec.rb
@@ -143,6 +146,7 @@ test_files:
 - spec/async/io/c10k_spec.rb
 - spec/async/io/echo_spec.rb
 - spec/async/io/generic_spec.rb
+- spec/async/io/protocol/line_spec.rb
 - spec/async/io/socket_spec.rb
 - spec/async/io/stream_spec.rb
 - spec/async/io/tcp_socket_spec.rb