ircparser 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80f2730b5d589fcd3a7f2933f67650173af4aefb
-  data.tar.gz: 68c6c1b781a5c9e8b0f4c22cb81c7f1222cc3d1f
+  metadata.gz: 5beae91923832297ad9f4005057e85283b072981
+  data.tar.gz: 788844a68185df07bc39ab2106e7606dee8e43e4
 SHA512:
-  metadata.gz: 4d01aac7f7ec5f8b19cbc7a0c27adb956811935a33849d8814edac7b6cd62dc3cc909f8d4b54416edca1d72574edd713e7d7f808dc3b75f046e6b3a266c12473
-  data.tar.gz: 8b111b9e848cc008ccc3e4525096a323fc67a12a611909c6c580569bffb26543f054e033d04839e71aa35beee6f9d3a5e9b16258c9847cc92a5f0aca9f08fa2f
+  metadata.gz: 7ed4efc1b2e78605eb68f8b0a8964995d69d861a124f8342d2a759ac037daa43904c1ab7ff50d3f5a39d2c482482f3a6cd653da8b1bedd4e094f9345e2b36bf5
+  data.tar.gz: d9c63829d0f9f462caedc2e285968b35096c3c8bb469c59dad73cb3536427da79e0e930d3d2fe722efaea77e27d30d8c6715b6d1290544fe4ed03096e895cc3c

data/lib/ircparser.rb

@@ -16,9 +16,9 @@
 module IRCParser
 
 	# Public: The version of IRCParser in use.
-	VERSION = '0.4.1'
+	VERSION = '0.5.0'
 end
 
 require_relative 'ircparser/error'
 require_relative 'ircparser/message'
-require_relative 'ircparser/source'
+require_relative 'ircparser/prefix'

data/lib/ircparser/message.rb

@@ -36,17 +36,17 @@ module IRCParser
 		# Public: An array of command parameters.
 		attr_reader :parameters
 
-		# Public: The source of this command or nil if unsourced.
-		attr_reader :source
+		# Public: The prefix of this command or nil if unprefixd.
+		attr_reader :prefix
 
 		# Public: A hash of IRCv3 message tags.
 		attr_reader :tags
 
 		# Public: Initialize a new message.
-		def initialize command: String.new, parameters: Array.new, source: nil, tags: Hash.new
+		def initialize command: String.new, parameters: Array.new, prefix: nil, tags: Hash.new
 			@command    = command
 			@parameters = parameters
-			@source     = source
+			@prefix     = prefix
 			@tags       = tags
 		end
 
@@ -70,9 +70,9 @@ module IRCParser
 				current_token = __get_token buffer
 			end
 
-			# Have we encountered the source of this message?
+			# Have we encountered the prefix of this message?
 			if current_token != nil && current_token[0] == ':'
-				components[:source] = IRCParser::Source.new current_token[1..-1]
+				components[:prefix] = IRCParser::Prefix.new current_token[1..-1]
 				current_token = __get_token buffer
 			end
 
@@ -106,10 +106,10 @@ module IRCParser
 				buffer += ' '
 			end
 
-			# Serialize the source.
-			unless source.nil?
+			# Serialize the prefix.
+			unless prefix.nil?
 				buffer += ':'
-				buffer += source.to_s
+				buffer += prefix.to_s
 				buffer += ' '
 			end
 

data/lib/ircparser/prefix.rb

@@ -0,0 +1,54 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+# fee is hereby granted, provided that the above copyright notice and this permission notice appear
+# in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+# OF THIS SOFTWARE.
+
+module IRCParser
+
+	# Public: Represents the prefix of an IRC message.
+	class Prefix
+
+		# Internal: A regular expression which matches a n!u@h mask.
+		MATCH_PREFIX = /^(?<nick>[^@!]+)  (?:!(?<user>[^@]+))?  (?:@(?<host>.+))?$/x
+
+		# Public: The hostname of this prefix or nil if no hostname was given.
+		attr_reader :host
+
+		# Public: The nickname of this user.
+		attr_reader :nick
+
+		# Public: The username of this prefix or nil if no username was given.
+		attr_reader :user
+
+		# Public: Initialise a new message prefix from a serialised prefix.
+		#
+		# prefix - Either a n!u@h mask or a server name.
+		def initialize prefix
+			if MATCH_PREFIX =~ prefix
+				@nick = $~[:nick]
+				@user = $~[:user]
+				@host = $~[:host]
+			else
+				raise IRCParser::Error.new(prefix), 'prefix is not a user mask or server name'
+			end
+		end
+
+		# Public: serialises this prefix to the network form.
+		def to_s
+			buffer = @nick
+			buffer += "!#{@user}" unless @user.nil?
+			buffer += "@#{@host}" unless @host.nil?
+			return buffer
+		end
+	end
+end

data/test/test_message.rb

@@ -19,7 +19,7 @@ require 'ircparser'
 require 'minitest/autorun'
 
 describe IRCParser::Message do
-	describe 'when checking a valid message with tags and a source' do
+	describe 'when checking a valid message with tags and a prefix' do
 		before do
 			@text = '@tag1=value1;tag2;vendor1/tag3=value2;vendor2/tag4 :irc.example.com COMMAND param1 param2 :param3 param3'
 			@message = IRCParser::Message.parse @text
@@ -29,8 +29,8 @@ describe IRCParser::Message do
 			parameters = [ 'param1', 'param2', 'param3 param3' ]
 
 			@message.tags.must_equal tags
-			@message.source.wont_be_nil
-			@message.source.host.must_equal 'irc.example.com'
+			@message.prefix.wont_be_nil
+			@message.prefix.nick.must_equal 'irc.example.com'
 			@message.command.must_equal 'COMMAND'
 			@message.parameters.must_equal parameters
 		end
@@ -39,7 +39,7 @@ describe IRCParser::Message do
 		end
 	end
 
-	describe 'when checking a valid message with a source but no tags' do
+	describe 'when checking a valid message with a prefix but no tags' do
 		before do
 			@text = ':irc.example.com COMMAND param1 param2 :param3 param3'
 			@message = IRCParser::Message.parse @text
@@ -48,8 +48,8 @@ describe IRCParser::Message do
 			parameters = [ 'param1', 'param2', 'param3 param3' ]
 
 			@message.tags.must_be_empty
-			@message.source.wont_be_nil
-			@message.source.host.must_equal 'irc.example.com'
+			@message.prefix.wont_be_nil
+			@message.prefix.nick.must_equal 'irc.example.com'
 			@message.command.must_equal 'COMMAND'
 			@message.parameters.must_equal parameters
 		end
@@ -58,7 +58,7 @@ describe IRCParser::Message do
 		end
 	end
 
-	describe 'when checking a valid message with tags but no source' do
+	describe 'when checking a valid message with tags but no prefix' do
 		before do
 			@text = '@tag1=value1;tag2;vendor1/tag3=value2;vendor2/tag4 COMMAND param1 param2 :param3 param3'
 			@message = IRCParser::Message.parse @text
@@ -68,7 +68,7 @@ describe IRCParser::Message do
 			parameters = [ 'param1', 'param2', 'param3 param3' ]
 
 			@message.tags.must_equal tags
-			@message.source.must_be_nil
+			@message.prefix.must_be_nil
 			@message.command.must_equal 'COMMAND'
 			@message.parameters.must_equal parameters
 		end
@@ -77,7 +77,7 @@ describe IRCParser::Message do
 		end
 	end
 
-	describe 'when checking a valid message with tags but no source' do
+	describe 'when checking a valid message with tags but no prefix' do
 		before do
 			@text = '@tag1=value1;tag2;vendor1/tag3=value2;vendor2/tag4 COMMAND param1 param2 :param3 param3'
 			@message = IRCParser::Message.parse @text
@@ -87,7 +87,7 @@ describe IRCParser::Message do
 			parameters = [ 'param1', 'param2', 'param3 param3' ]
 
 			@message.tags.must_equal tags
-			@message.source.must_be_nil
+			@message.prefix.must_be_nil
 			@message.command.must_equal 'COMMAND'
 			@message.parameters.must_equal parameters
 		end
@@ -97,14 +97,14 @@ describe IRCParser::Message do
 	end
 
 
-	describe 'when checking a valid message with no tags, source or parameters' do
+	describe 'when checking a valid message with no tags, prefix or parameters' do
 		before do
 			@text = 'COMMAND'
 			@message = IRCParser::Message.parse @text
 		end
 		it 'should consist of the correct components' do 
 			@message.tags.must_be_empty
-			@message.source.must_be_nil
+			@message.prefix.must_be_nil
 			@message.command.must_equal 'COMMAND'
 			@message.parameters.must_be_empty
 		end

data/test/test_prefix.rb

@@ -0,0 +1,60 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+# fee is hereby granted, provided that the above copyright notice and this permission notice appear
+# in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+# OF THIS SOFTWARE.
+
+$LOAD_PATH.unshift "#{Dir.pwd}/lib"
+
+require 'ircparser'
+require 'minitest/autorun'
+
+describe IRCParser::Prefix do
+	PREFIXES = {
+		'nick!user@host'  => { nick: 'nick',            user: 'user', host: 'host' },
+		'nick!user'       => { nick: 'nick',            user: 'user', host: nil    },
+		'nick@host'       => { nick: 'nick',            user: nil,    host: 'host' },
+		'nick'            => { nick: 'nick',            user: nil,    host: nil    },
+		'irc.example.com' => { nick: 'irc.example.com', user: nil,    host: nil    },
+	}
+
+	PREFIXES.each do |serialized, deserialized|
+		describe 'when checking a valid prefix' do
+			before do
+				@prefix = IRCParser::Prefix.new serialized
+			end
+			it 'should consist of the correct components' do
+				%i(nick user host).each do |component|
+					if deserialized[component].nil?
+						@prefix.send(component).must_be_nil
+					else
+						@prefix.send(component).must_equal deserialized[component]
+					end
+				end
+			end
+			it 'should serialise back to the same text' do
+				@prefix.to_s.must_equal serialized
+			end
+		end
+	end
+
+	describe 'when checking an invalid user prefix' do
+		it 'should throw an IRCParser::Error when components are missing' do
+			proc { IRCParser::Prefix.new 'nick!@' }.must_raise IRCParser::Error
+			proc { IRCParser::Prefix.new '!user@' }.must_raise IRCParser::Error
+			proc { IRCParser::Prefix.new '!@host' }.must_raise IRCParser::Error
+			proc { IRCParser::Prefix.new 'nick!user@' }.must_raise IRCParser::Error
+			proc { IRCParser::Prefix.new 'nick!@host' }.must_raise IRCParser::Error
+			proc { IRCParser::Prefix.new '!user@host' }.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.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Peter "SaberUK" Powell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -67,9 +67,9 @@ files:
 - lib/ircparser.rb
 - lib/ircparser/error.rb
 - lib/ircparser/message.rb
-- lib/ircparser/source.rb
+- lib/ircparser/prefix.rb
 - test/test_message.rb
-- test/test_source.rb
+- test/test_prefix.rb
 homepage: https://github.com/SaberUK/ircparser
 licenses:
 - ISC

data/lib/ircparser/source.rb

@@ -1,79 +0,0 @@
-# IRCParser - Internet Relay Chat Message Parser
-#
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
-#
-# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
-# fee is hereby granted, provided that the above copyright notice and this permission notice appear
-# in all copies.
-#
-# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
-# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
-# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
-# OF THIS SOFTWARE.
-
-module IRCParser
-
-	# Public: Represents the source of an IRC message.
-	class Source
-
-		# Internal: A regular expression which matches a n!u@h mask.
-		MATCH_USER = /^(?<nick>[^@!]+)     (?:!(?<user>[^@]+))?     (?:@(?<host>.+))?$/x
-
-		# Internal: A regular expression which matches a server name.
-		MATCH_SERVER = /^(?<host>\S+\.\S+)$/
-
-		# Public: The hostname of this source.
-		attr_reader :host
-
-		# Public: The nickname of this user or nil if the source is a server.
-		attr_reader :nick
-
-		# Public: The username of this user or nil if the source is a server.
-		attr_reader :user
-
-		# Public: Initialise a new message source from a serialised source.
-		#
-		# source - Either a n!u@h mask or a server name.
-		def initialize source
-			if MATCH_SERVER =~ source
-				@type = :server
-				@host = $~[:host]
-			elsif MATCH_USER =~ source
-				@type = :user
-				@nick = $~[:nick]
-				@user = $~[:user]
-				@host = $~[:host]
-			else
-				raise IRCParser::Error.new(source), 'source is not a user mask or server name'
-			end
-		end
-
-		# Public: Whether this source represents a user.
-		def is_user?
-			return @type == :user
-		end
-
-		# Public: Whether this source represents a server.
-		def is_server?
-			return @type == :server
-		end
-
-		# Public: The name by which this source can be identified.
-		def name
-			return is_user? ? @nick : @host
-		end
-
-		# Public: serialises this source to the serialised form.
-		def to_s
-			if is_user?
-				buffer = @nick
-				buffer += "!#{@user}" unless @user.nil?
-				buffer += "@#{@host}" unless @host.nil?
-				return buffer
-			end
-			return @host
-		end
-	end
-end

data/test/test_source.rb

@@ -1,78 +0,0 @@
-# IRCParser - Internet Relay Chat Message Parser
-#
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
-#
-# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
-# fee is hereby granted, provided that the above copyright notice and this permission notice appear
-# in all copies.
-#
-# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
-# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
-# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
-# OF THIS SOFTWARE.
-
-$LOAD_PATH.unshift "#{Dir.pwd}/lib"
-
-require 'ircparser'
-require 'minitest/autorun'
-
-describe IRCParser::Source do
-	describe 'when checking a valid server source' do
-		before do
-			@text = 'irc.example.com'
-			@source = IRCParser::Source.new @text
-		end
-		it 'should consist of the correct components' do
-			@source.nick.must_be_nil
-			@source.user.must_be_nil
-			@source.host.must_equal 'irc.example.com'
-		end
-		it 'should be a server not a user' do
-			@source.is_server?.must_equal true
-			@source.is_user?.must_equal false
-		end
-		it 'should serialise back to the same text' do
-			@source.to_s.must_equal @text
-		end
-	end
-
-	USER_MASKS = {
-		'nick!user@host' => { nick: 'nick', user: 'user', host: 'host' },
-		'nick!user'      => { nick: 'nick', user: 'user', host: nil    },
-		'nick@host'      => { nick: 'nick', user: nil,    host: 'host' },
-		'nick'           => { nick: 'nick', user: nil,    host: nil    }
-	}
-
-	USER_MASKS.each do |serialized, deserialized|
-		describe 'when checking a valid user source' do
-			before do
-				@source = IRCParser::Source.new serialized
-			end
-			it 'should consist of the correct components' do
-				@source.nick.must_equal deserialized[:nick]
-				@source.user.must_equal deserialized[:user]
-				@source.host.must_equal deserialized[:host]
-			end
-			it 'should be a user not a server' do
-				@source.is_server?.must_equal false
-				@source.is_user?.must_equal true
-			end
-			it 'should serialise back to the same text' do
-				@source.to_s.must_equal serialized
-			end
-		end
-	end
-
-	describe 'when checking an invalid user source' do
-		it 'should throw an IRCParser::Error when components are missing' do
-			proc { IRCParser::Source.new 'nick!@' }.must_raise IRCParser::Error
-			proc { IRCParser::Source.new '!user@' }.must_raise IRCParser::Error
-			proc { IRCParser::Source.new '!@host' }.must_raise IRCParser::Error
-			proc { IRCParser::Source.new 'nick!user@' }.must_raise IRCParser::Error
-			proc { IRCParser::Source.new 'nick!@host' }.must_raise IRCParser::Error
-			proc { IRCParser::Source.new '!user@host' }.must_raise IRCParser::Error
-		end
-	end
-end