ircparser 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da792a06cf218e905c4c4cd558b1624edfd17ef7
-  data.tar.gz: 07a24306c369d4a1e509522121b4fb93354f7a9f
+  metadata.gz: 92dadfe64e680ca4a8e87efc3bbf8f9b323ebf52
+  data.tar.gz: 27e1d86d7da77c90fbe766e43a365387c752ad6f
 SHA512:
-  metadata.gz: 302fe93bd63fc4598a98e3c3014632e3f506a28ecd5bcedcab29077addb522842c54fccd71e792171508b91f3e7d0fde12314ffd8ec48ce53d166d75f2a5f094
-  data.tar.gz: 245d04b36d85a0d50735a10526afc33cc1f446ae97aaef8127c912cbf117e835c92a6fc51a1292686fbf8a9ec187484aaa7196656c2423e67e5f3678232b5db6
+  metadata.gz: b2a992ef089e0250747811676135662d1b1f9f5645611a817716b9769d5bd9651ea0c02c3ae93807988d34e1f2c8cda23051d649ec2ca1d4318dd8ebd53feba0
+  data.tar.gz: 5385967062ce610246d25cc3296f2f0656a278ba653103684c291419551310121a92c01875062728bdfce2f2f97a42b1fe15c97449353a3d7b3d822c43c2bfad

data/lib/ircparser.rb

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

data/lib/ircparser/message.rb

@@ -39,7 +39,7 @@ module IRCParser
 		# Public: The source of this command or nil if unsourced.
 		attr_reader :source
 
-		# Public: A hash of IRCv3.2 message tags.
+		# Public: A hash of IRCv3 message tags.
 		attr_reader :tags
 
 		# Public: Initialize a new message.
@@ -59,33 +59,38 @@ module IRCParser
 			raise IRCParser::Error.new(line), "line is not a string" unless line.is_a? String
 
 			# Split the message up into an array of tokens.
-			tokens = line.split ' '
-			current_index = 0
+			buffer = line.clone
+			current_token = __get_token buffer
 			components = Hash.new
 
-			# Have we encountered IRCv3.2 message tags?
+			# Have we encountered IRCv3 message tags?
 			components[:tags] = Hash.new
-			if current_index < tokens.size && tokens[current_index][0] == '@'
-				components[:tags] = __parse_tags tokens[current_index]
-				current_index += 1
+			if current_token != nil && current_token[0] == '@'
+				components[:tags] = __parse_tags current_token
+				current_token = __get_token buffer
 			end
 
 			# Have we encountered the source of this message?
-			if current_index < tokens.size && tokens[current_index][0] == ':'
-				components[:source] = IRCParser::Source.new tokens[current_index][1..-1]
-				current_index += 1
+			if current_token != nil && current_token[0] == ':'
+				components[:source] = IRCParser::Source.new current_token[1..-1]
+				current_token = __get_token buffer
 			end
 
 			# The command parameter is mandatory.
-			if current_index < tokens.size
-				components[:command] = tokens[current_index]
-				current_index += 1
+			if current_token != nil
+				components[:command] = current_token.upcase
+				current_token = __get_final_token buffer
 			else
 				raise IRCParser::Error.new(line), 'message is missing the command name'
 			end
 
 			# Try to parse all of the remaining parameters.
-			components[:parameters] = __parse_parameters tokens[current_index..-1]
+			components[:parameters] = Array.new
+			while current_token != nil
+				components[:parameters] << current_token
+				current_token = __get_final_token buffer
+			end
+
 			return IRCParser::Message.new components
 		end
 
@@ -120,20 +125,34 @@ module IRCParser
 
 		private
 
-		# Internal: Parse parameters from network form to an Array.
+		# Internal: Retrieves a space delimited token from the buffer.
 		#
-		# token - A list of tags in network form.
-		def self.__parse_parameters tokens
-			parameters = Array.new
-			tokens.each_with_index do |token, index|
-				if token[0] == ':'
-					last_token = tokens[index..-1].join ' '
-					parameters << last_token[1..-1]
-					break
-				end
-				parameters << token
+		# data - 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
-			return parameters
+			token = buffer.slice! 0...position
+			position = buffer.index /\S+/
+			buffer.slice! 0...position
+			return token
+		end
+
+		# Internal: Retrieves a space delimited token that may be a <trailing> parameter.
+		#
+		# data - 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 __get_token buffer
 		end
 
 		# Internal: Parse tags from network form to a Hash.
@@ -159,10 +178,15 @@ module IRCParser
 		def __serialize_parameters
 			buffer = String.new
 			@parameters.each_with_index do |parameter, index|
+				trailing = parameter.include? ' '
+				if trailing && index != @parameters.size-1
+					raise IRCParser::Error.new(parameter), "only the last parameter may contain spaces"
+				end
+
 				buffer += ' '
-				if parameter.include? ' '
+				if trailing || parameter.empty?
 					buffer += ':'
-					buffer += parameters[index..-1].join ' '
+					buffer += parameter
 					break
 				end
 				buffer += parameter

data/test/test_message.rb

@@ -130,4 +130,41 @@ describe IRCParser::Message do
 		end
 	end
 
+	describe 'when checking we can handle multiple consecutive spaces in a <trailing> parameter' do
+		before do
+			@text = 'COMMAND :param1  param1  '
+			@message = IRCParser::Message.parse @text
+		end
+		it 'should parse the trailing parameter properly' do
+			@message.parameters.size.must_equal 1
+			@message.parameters[0].must_equal 'param1  param1  '
+		end
+		it 'should serialize the trailing parameter properly' do
+			@message.to_s.must_equal @text
+		end
+	end
+
+	describe 'when checking we can handle an empty <trailing> parameter' do
+		before do
+			@text = 'COMMAND :'
+			@message = IRCParser::Message.parse @text
+		end
+		it 'should parse the trailing parameter properly' do
+			@message.parameters.size.must_equal 1
+			@message.parameters[0].must_equal ''
+		end
+		it 'should serialize the trailing parameter properly' do
+			@message.to_s.must_equal @text
+		end
+	end
+
+	describe 'when checking we can handle serialising malformed parameters' do
+		it 'should throw an IRCParser::Error when a non <trailing> parameter contains spaces' do
+			proc {
+				message = IRCParser::Message.new command: 'COMMAND', parameters: [ 'param1 param1', 'param2' ]
+				message.to_s
+			}.must_raise IRCParser::Error
+		end
+	end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ircparser
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Peter "SaberUK" Powell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -58,7 +58,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.5
-description: A standards compliant parser for the IRCv3.2 message format.
+description: A standards compliant parser for the IRCv3 message format.
 email: petpow@saberuk.com
 executables: []
 extensions: []
@@ -90,8 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: An IRCv3.2 message parser.
+summary: An IRCv3 message parser.
 test_files: []