io-stream 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e86dd2d0db65582e6b9655493776e1f3fa16c8d22af92d40c7c2f1ae374c7ee
-  data.tar.gz: e6299a23d03c263361f04bae8ec29c3d0b70c2f19d6cdfe64ff601d6b7bb7c64
+  metadata.gz: e7580fa6412067d9c5e341d3f81de6f9cd8134cc04fb1b2666bafc0a9685cc99
+  data.tar.gz: 76040e83616e06be4c7c0bbdfd89d019542b8d5eaa44c56af5e474acda870983
 SHA512:
-  metadata.gz: 16d2aff35b208b029c2b917cd6a423d5ee54547939a39e5575f2641d8060b793a03a5a0903a885216142d99369ba80f8941d35ab07739a11c95d2c98dfa1d3cd
-  data.tar.gz: af90134348a217f72fe90dea4cab0c2c4e7fc6b7a2c27345b865642191c9aa0bdda16b2e1856114d1e42bbf7f9c6be7bb506daa8cb9724baae2fdf1534dcc85e
+  metadata.gz: 9ac128c5e456067d97b9477ed715fc2d4b0698b3d01e2cb6884dfa2b28128b09a860cba4480f8b0a161c2d13c4ac956c00ddafee1b949f8f63f602e7ad277185
+  data.tar.gz: a381be911bb16224c57ad364dc8e4e85ce74616523360cbf62ab04d84747d3b47b133291c41dbac5e346cc01485dc85f2237f82c17a6612cf5404283d2be5c2e

data/lib/io/stream/generic.rb

@@ -18,6 +18,9 @@ module IO::Stream
 	# The maximum read size when appending to IO buffers. Defaults to 8MB.
 	MAXIMUM_READ_SIZE = ENV.fetch("IO_STREAM_MAXIMUM_READ_SIZE", BLOCK_SIZE * 128).to_i
 	
+	class LimitError < StandardError
+	end
+	
 	class Generic
 		def initialize(block_size: BLOCK_SIZE, maximum_read_size: MAXIMUM_READ_SIZE)
 			@eof = false
@@ -85,26 +88,37 @@ module IO::Stream
 			read_partial(size) or raise EOFError, "Encountered eof while reading data!"
 		end
 		
-		# 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, offset = 0, chomp: true)
+		private def index_of(pattern, offset, limit)
 			# We don't want to split on the pattern, so we subtract the size of the pattern.
 			split_offset = pattern.bytesize - 1
-			
+
 			until index = @read_buffer.index(pattern, offset)
 				offset = @read_buffer.bytesize - split_offset
 				
 				offset = 0 if offset < 0
 				
-				return unless fill_read_buffer
+				return nil if limit and offset >= limit
+				return nil unless fill_read_buffer
 			end
 			
-			@read_buffer.freeze
-			matched = @read_buffer.byteslice(0, index+(chomp ? 0 : pattern.bytesize))
-			@read_buffer = @read_buffer.byteslice(index+pattern.bytesize, @read_buffer.bytesize)
-			
-			return matched
+			return index
+		end
+		
+		# Efficiently read data from the stream until encountering pattern.
+		# @parameter pattern [String] The pattern to match.
+		# @parameter offset [Integer] The offset to start searching from.
+		# @parameter limit [Integer] The maximum number of bytes to read, including the pattern (even if chomped).
+		# @returns [String | Nil] The contents of the stream up until the pattern, which is consumed but not returned.
+		def read_until(pattern, offset = 0, limit: nil, chomp: true)
+			if index = index_of(pattern, offset, limit)
+				return nil if limit and index >= limit
+				
+				@read_buffer.freeze
+				matched = @read_buffer.byteslice(0, index+(chomp ? 0 : pattern.bytesize))
+				@read_buffer = @read_buffer.byteslice(index+pattern.bytesize, @read_buffer.bytesize)
+				
+				return matched
+			end
 		end
 		
 		def peek(size = nil)
@@ -124,8 +138,45 @@ module IO::Stream
 			return @read_buffer
 		end
 		
-		def gets(separator = $/, **options)
-			read_until(separator, **options)
+		def gets(separator = $/, limit = nil, chomp: false)
+			# Compatibility with IO#gets:
+			if separator.is_a?(Integer)
+				limit = separator
+				separator = $/
+			end
+			
+			# We don't want to split in the middle of the separator, so we subtract the size of the separator from the start of the search:
+			split_offset = separator.bytesize - 1
+			
+			offset = 0
+			
+			until index = @read_buffer.index(separator, offset)
+				offset = @read_buffer.bytesize - split_offset
+				offset = 0 if offset < 0
+				
+				# If a limit was given, and the offset is beyond the limit, we should return up to the limit:
+				if limit and offset >= limit
+					# As we didn't find the separator, there is nothing to chomp either.
+					return consume_read_buffer(limit)
+				end
+				
+				# If we can't read any more data, we should return what we have:
+				return consume_read_buffer unless fill_read_buffer
+			end
+			
+			# If the index of the separator was beyond the limit:
+			if limit and index >= limit
+				# Return up to the limit:
+				return consume_read_buffer(limit)
+			end
+			
+			# Freeze the read buffer, as this enables us to use byteslice without generating a hidden copy:
+			@read_buffer.freeze
+			
+			line = @read_buffer.byteslice(0, index+(chomp ? 0 : separator.bytesize))
+			@read_buffer = @read_buffer.byteslice(index+separator.bytesize, @read_buffer.bytesize)
+			
+			return line
 		end
 		
 		private def drain(buffer)
@@ -148,8 +199,8 @@ module IO::Stream
 		
 		# Writes `string` to the buffer. When the buffer is full or #sync is true the
 		# buffer is flushed to the underlying `io`.
-		# @param string the string to write to the buffer.
-		# @return the number of bytes appended to the buffer.
+		# @parameter string [String] the string to write to the buffer.
+		# @returns [Integer] the number of bytes appended to the buffer.
 		def write(string, flush: false)
 			@writing.synchronize do
 				@write_buffer << string
@@ -292,7 +343,7 @@ module IO::Stream
 		end
 		
 		# Consumes at most `size` bytes from the buffer.
-		# @param size [Integer|nil] The amount of data to consume. If nil, consume entire buffer.
+		# @parameter size [Integer|nil] The amount of data to consume. If nil, consume entire buffer.
 		def consume_read_buffer(size = nil)
 			# If we are at eof, and the read buffer is empty, we can't consume anything.
 			return nil if @eof && @read_buffer.empty?

data/lib/io/stream/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2023-2024, by Samuel Williams.
 
 module IO::Stream
-	VERSION = "0.4.3"
+	VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-stream
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies: []
 description:
 email:

metadata.gz.sig

@@ -1,3 +1,5 @@
-:9
�wK�+W��t����>��"������*�6Fǟ�*�b8]9�ȳ���KUl��hA<>WXf�ȃ/-�5��N���^�^
-@8A�ډ�^�i��i!M?���jY������7�O�4;ͦ1�Čƴ5��A�+�.H�W��:o4˔}��'�Nk���*��҆�
-u�
+�,)Ka�,x}Wjv_���G���ǁ���_C��S��C����k!�h��`Ȕ�A���l�+�����X���$��u�����G��ǭ��H���]��N�/�&b$�>C�}ۛfA]���⍣4m��Ⴑvȏ��R�z
+$
+l������G� ����
+���x޻�|�&7�*V�Q�l�6Z#>y��\�x�E�
+�6��}[Wsc��<������'
�vP��O������:N)�Sn�!��2��:�gp�K.@7�\�y8yᵚO��\��'��8�^N��/�V�@��k���d0pݵ]��#�Vs%���I(9kX��eO76�