ircparser 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1262a7e23aab10553888d9d4221bd92135b2946c9eb62926151e922cf6bcc28
-  data.tar.gz: 1211d6f79d995dc880eae1f289bcd73cc9c6f2ecf4cd2bb7198e25aa10343114
+  metadata.gz: c6b7566a57bb2e617b579c0ce2a174b66f96af0da0ed94efdeae3688f7a23cdb
+  data.tar.gz: 90e612dea1ea55b93896ebfdfb4d44880b021191120d2c49119785883b2e6bbc
 SHA512:
-  metadata.gz: c3863279345f02af5357738b2c54488289259ad7f304da349663892af23f3cbe819a506175d139caf35edfb42d1db511289b89dba0e3fe82dea51baec989611a
-  data.tar.gz: 9dcca8e8329dd38534fec6dc95e88bae6e1cc3ad601f9983bc52c47484f4526c99bca64b450a88230f8ac330656b377edf24a8b9cd8238b09256697acbd7adb6
+  metadata.gz: ec325e4e96dbd73405c3b4815be8028e0243855af8c7f3889a34ad1ab7a3325bd64c11e8fcd08b63eea7444ec08bfe1dea56a6534f7dfe6dd7640b78baa04079
+  data.tar.gz: 53a1b4419baf3a2e56f51f5ff4e6bc586ac9b7217904704a80ae6a1bc603681b87a5f0d9e174ef2edc8dc73f54fcd05e35ffe2884d603b37bfe980912e3c27df

data/lib/ircparser.rb

@@ -16,7 +16,7 @@
 module IRCParser
 
 	# Public: The version of IRCParser in use.
-	VERSION = '0.6.2'
+	VERSION = '0.7.0'
 end
 
 require_relative 'ircparser/error'

data/lib/ircparser/stream.rb

@@ -38,8 +38,12 @@ module IRCParser
 		def append data
 			(@buffer ||= '') << data
 			while @buffer.slice! /(.*?)\r?\n/
-				message = IRCParser::Message.parse $1
-				@block.call message
+				begin
+					message = IRCParser::Message.parse $1
+					@block.call message, nil
+				rescue IRCParser::Error => error
+					@block.call nil, error
+				end
 			end
 		end
 	end

data/lib/ircparser/wire/rfc.rb

@@ -18,6 +18,41 @@ module IRCParser
 	# Internal: Implements objectification and stringification for the RFC wire format.
 	module RFCWireFormat
 
+		class MessageTokenizer
+
+			def initialize message
+				@message = message
+				# Skip any preceding whitespace. This is technically invalid but
+				# is implemented by several servers in the wild.
+				@position = message.index(/\S/) || 0
+			end
+
+			# Internal: Retrieves a space delimited token from the message.
+			def read_middle
+				return nil if @position >= @message.length
+				old_position = @position
+				@position = @message.index(' ', old_position) || @message.length
+				return nil unless @position - old_position > 0
+				token = @message.slice old_position...@position
+				@position = @message.index(/\S+/, @position) || @message.length
+				return token
+			end
+
+			# Internal: Retrieves a space delimited token that may be a <trailing> parameter.
+			#
+			# message - The message to retrieve the token from.
+			def read_trailing
+				return nil if @position >= @message.length
+				if @message[@position] == ':'
+					token = @message[@position+1..-1]
+					@position = @message.length
+					return token
+				end
+				return read_middle
+			end
+
+		end
+
 		# Internal: Objectifies a message from the RFC wire format to an IRCParser::Message.
 		#
 		# str - A String containing a message in the RFC wire format.
@@ -28,31 +63,28 @@ module IRCParser
 				raise IRCParser::Error.new(str), "message is not a String"
 			end
 
-			# Skip any preceding whitespace. This is technically invalid but
-			# is implemented by several servers in the wild.
-			message = str.lstrip
-
 			# Split the message up into an array of tokens.
-			current_token = self.__get_token message
+			tokenizer = MessageTokenizer.new str
+			current_token = tokenizer.read_middle
 			components = Hash.new
 
 			# Have we encountered IRCv3 message tags?
 			components[:tags] = Hash.new
 			if current_token != nil && current_token[0] == '@'
 				components[:tags] = self.__objectify_tags current_token
-				current_token = self.__get_token message
+				current_token = tokenizer.read_middle
 			end
 
 			# Have we encountered the prefix of this message?
 			if current_token != nil && current_token[0] == ':'
 				components[:prefix] = self.__objectify_prefix current_token
-				current_token = self.__get_token message
+				current_token = tokenizer.read_middle
 			end
 
 			# The command parameter is mandatory.
 			if current_token != nil
 				components[:command] = current_token.upcase
-				current_token = self.__get_final_token message
+				current_token = tokenizer.read_trailing
 			else
 				raise IRCParser::Error.new(str), 'message is missing the command name'
 			end
@@ -61,7 +93,7 @@ module IRCParser
 			components[:parameters] = Array.new
 			while current_token != nil
 				components[:parameters] << current_token
-				current_token = self.__get_final_token message
+				current_token = tokenizer.read_trailing
 			end
 
 			return IRCParser::Message.new components
@@ -119,40 +151,6 @@ module IRCParser
 			'\n'   => "\n",
 		}
 
-		# Internal: Retrieves a space delimited token from the buffer.
-		#
-		# buffer - The buffer to retrieve the token from.
-		def self.__get_token buffer
-			return nil if buffer.empty?
-			position = buffer.index ' '
-			if position == nil
-				token = buffer.clone
-				buffer.clear
-				return token
-			end
-			token = buffer.slice! 0...position
-			position = buffer.index /\S+/
-			if position == nil
-				buffer.clear
-			else
-				buffer.slice! 0...position
-			end
-			return token
-		end
-
-		# Internal: Retrieves a space delimited token that may be a <trailing> parameter.
-		#
-		# buffer - The buffer to retrieve the token from.
-		def self.__get_final_token buffer
-			return nil if buffer.empty?
-			if buffer[0] == ':'
-				token = buffer[1..-1]
-				buffer.clear
-				return token
-			end
-			return self.__get_token buffer
-		end
-
 		# Internal: Objectifies the prefix from the RFC wire format to an IRCParser::Prefix.
 		#
 		# token - A String containing the prefix in the RFC wire format.
@@ -170,10 +168,9 @@ module IRCParser
 			tags = Hash.new
 			token[1..-1].split(';').each do |tag|
 				if tag =~ MATCH_TAG
-					value = nil
+					value = String.new
 					value_index = 0
 					while $~['value'] != nil && value_index < $~['value'].size
-						value ||= String.new
 						if $~['value'][value_index] == '\\'
 							escape = $~['value'].slice(value_index, 2)
 							if TAG_ESCAPES.include? escape
@@ -233,7 +230,7 @@ module IRCParser
 			tags.each.with_index do |tag, idx|
 				key, value = tag
 				buffer += key
-				unless value.nil?
+				unless value.nil? || value.empty?
 					buffer += '='
 					value.each_char do |chr|
 						if TAG_ESCAPES.has_value? chr

data/test/test_message.rb

@@ -25,7 +25,7 @@ describe IRCParser::Message do
 			@message = IRCParser::Message.parse @text
 		end
 		it 'should consist of the correct components' do
-			tags = { 'tag1' => 'value1', 'tag2' => nil, 'vendor1/tag3' => 'value2', 'vendor2/tag4' => nil }
+			tags = { 'tag1' => 'value1', 'tag2' => '', 'vendor1/tag3' => 'value2', 'vendor2/tag4' => '' }
 			parameters = [ 'param1', 'param2', 'param3 param3' ]
 
 			_(@message.tags).must_equal tags
@@ -64,7 +64,7 @@ describe IRCParser::Message do
 			@message = IRCParser::Message.parse @text
 		end
 		it 'should consist of the correct components' do
-			tags = { 'tag1' => 'value1', 'tag2' => nil, 'vendor1/tag3' => 'value2', 'vendor2/tag4' => nil }
+			tags = { 'tag1' => 'value1', 'tag2' => '', 'vendor1/tag3' => 'value2', 'vendor2/tag4' => '' }
 			parameters = [ 'param1', 'param2', 'param3 param3' ]
 
 			_(@message.tags).must_equal tags
@@ -83,7 +83,7 @@ describe IRCParser::Message do
 			@message = IRCParser::Message.parse @text
 		end
 		it 'should consist of the correct components' do
-			tags = { 'tag1' => 'value1', 'tag2' => nil, 'vendor1/tag3' => 'value2', 'vendor2/tag4' => nil }
+			tags = { 'tag1' => 'value1', 'tag2' => '', 'vendor1/tag3' => 'value2', 'vendor2/tag4' => '' }
 			parameters = [ 'param1', 'param2', 'param3 param3' ]
 
 			_(@message.tags).must_equal tags

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ircparser
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Sadie Powell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-31 00:00:00.000000000 Z
+date: 2020-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest