ircparser 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b7566a57bb2e617b579c0ce2a174b66f96af0da0ed94efdeae3688f7a23cdb
-  data.tar.gz: 90e612dea1ea55b93896ebfdfb4d44880b021191120d2c49119785883b2e6bbc
+  metadata.gz: f160e7c21dcbbbbdcfb6662e8d035fe78679eb93dc2f8ee1a89700e5818ffc65
+  data.tar.gz: 137cd1cec698ae345b02a89cd4bf508359726b3353a400307cdbf4c467e70042
 SHA512:
-  metadata.gz: ec325e4e96dbd73405c3b4815be8028e0243855af8c7f3889a34ad1ab7a3325bd64c11e8fcd08b63eea7444ec08bfe1dea56a6534f7dfe6dd7640b78baa04079
-  data.tar.gz: 53a1b4419baf3a2e56f51f5ff4e6bc586ac9b7217904704a80ae6a1bc603681b87a5f0d9e174ef2edc8dc73f54fcd05e35ffe2884d603b37bfe980912e3c27df
+  metadata.gz: b3622b7fbccc84758655416346579e6b2b5f998276312383c88282c7dfdb03e25fdadd5f43b3c0f6629eadef06ad4bf9900b0f6e1391841e10bb21c917a87daf
+  data.tar.gz: 7b7d58d02649e57d9ad0ece55831e71e238746662f371bf2fb6679954068e004a6078ff0c611348b05baca45944e2ad1c491381ae117b07e1717524e1352b50d

data/lib/ircparser.rb

@@ -13,14 +13,9 @@
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 # OF THIS SOFTWARE.
 
-module IRCParser
-
-	# Public: The version of IRCParser in use.
-	VERSION = '0.7.0'
-end
-
 require_relative 'ircparser/error'
 require_relative 'ircparser/message'
 require_relative 'ircparser/prefix'
 require_relative 'ircparser/stream'
 require_relative 'ircparser/wire/rfc'
+require_relative 'ircparser/version'

data/lib/ircparser/message.rb

@@ -50,7 +50,7 @@ module IRCParser
 			return IRCParser::RFCWireFormat.objectify line
 		end
 
-		# Public: Serializes the message to a string.
+		# Public: Serializes the message to a string.
 		def to_s
 			return IRCParser::RFCWireFormat.stringify self
 		end

data/lib/ircparser/version.rb

@@ -0,0 +1,36 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015-2020 Sadie Powell <sadie@witchery.services>
+#
+# 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: The version number which is incremented when compatibility is broken.
+	VERSION_MAJOR = 1
+
+	# Public: The version number which is incremented when new features are added.
+	VERSION_MINOR = 0
+
+	# Public: The version number which is incremented when bugs are fixed.
+	VERSION_PATCH = 0
+
+	# Public: The version label which describes the status of the build.
+	VERSION_LABEL = nil
+
+	# Public: A string which contains the current version.
+	VERSION = if VERSION_LABEL.nil?
+		"#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}".freeze
+	else
+		"#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}-#{VERSION_LABEL}".freeze
+	end
+end

data/lib/ircparser/wire/rfc.rb

@@ -18,6 +18,7 @@ module IRCParser
 	# Internal: Implements objectification and stringification for the RFC wire format.
 	module RFCWireFormat
 
+		# Internal: Tokenizer for the RFC wire format.
 		class MessageTokenizer
 
 			def initialize message
@@ -32,7 +33,7 @@ module IRCParser
 				return nil if @position >= @message.length
 				old_position = @position
 				@position = @message.index(' ', old_position) || @message.length
-				return nil unless @position - old_position > 0
+				return nil unless (@position - old_position).positive?
 				token = @message.slice old_position...@position
 				@position = @message.index(/\S+/, @position) || @message.length
 				return token
@@ -60,7 +61,7 @@ module IRCParser
 
 			# Ruby really needs some kind of basic type checking.
 			unless str.is_a? String
-				raise IRCParser::Error.new(str), "message is not a String"
+				raise IRCParser::Error.new(str), 'message is not a String'
 			end
 
 			# Split the message up into an array of tokens.
@@ -70,19 +71,19 @@ module IRCParser
 
 			# Have we encountered IRCv3 message tags?
 			components[:tags] = Hash.new
-			if current_token != nil && current_token[0] == '@'
+			if !current_token.nil? && current_token[0] == '@'
 				components[:tags] = self.__objectify_tags current_token
 				current_token = tokenizer.read_middle
 			end
 
 			# Have we encountered the prefix of this message?
-			if current_token != nil && current_token[0] == ':'
+			if !current_token.nil? && current_token[0] == ':'
 				components[:prefix] = self.__objectify_prefix current_token
 				current_token = tokenizer.read_middle
 			end
 
 			# The command parameter is mandatory.
-			if current_token != nil
+			unless current_token.nil?
 				components[:command] = current_token.upcase
 				current_token = tokenizer.read_trailing
 			else
@@ -91,12 +92,12 @@ module IRCParser
 
 			# Try to parse all of the remaining parameters.
 			components[:parameters] = Array.new
-			while current_token != nil
+			while !current_token.nil?
 				components[:parameters] << current_token
 				current_token = tokenizer.read_trailing
 			end
 
-			return IRCParser::Message.new components
+			return IRCParser::Message.new **components
 		end
 
 		# Internal: Stringifies a message from an IRCParser::Message to the RFC wire format.
@@ -106,7 +107,7 @@ module IRCParser
 
 			# Ruby really needs some kind of basic type checking.
 			unless obj.is_a? IRCParser::Message
-				raise IRCParser::Error.new(obj), "message is not an IRCParser::Message"
+				raise IRCParser::Error.new(obj), 'message is not an IRCParser::Message'
 			end
 
 			# Stringify the tags.
@@ -134,13 +135,11 @@ module IRCParser
 			return buffer
 		end
 
-		private
-
 		# Internal: A regular expression which matches a n!u@h mask.
-		MATCH_PREFIX = /^:(?<nick>[^@!]+)  (?:!(?<user>[^@]+))?  (?:@(?<host>.+))?$/x
+		MATCH_PREFIX = /^:(?<nick>[^@!]+)  (?:!(?<user>[^@]+))?  (?:@(?<host>.+))?$/x.freeze
 
 		# Internal: A regular expression which matches a tag.
-		MATCH_TAG = /^(?<name>[^\s=]+?)(?:=(?<value>[^\s;]+))?$/
+		MATCH_TAG = /^(?<name>[^\s=]+?)(?:=(?<value>[^\s;]+))?$/.freeze
 
 		# Internal: The characters which need to be escaped in tag values.
 		TAG_ESCAPES = {
@@ -149,7 +148,7 @@ module IRCParser
 			'\s'   => "\s",
 			'\r'   => "\r",
 			'\n'   => "\n",
-		}
+		}.freeze
 
 		# Internal: Objectifies the prefix from the RFC wire format to an IRCParser::Prefix.
 		#
@@ -170,7 +169,7 @@ module IRCParser
 				if tag =~ MATCH_TAG
 					value = String.new
 					value_index = 0
-					while $~['value'] != nil && value_index < $~['value'].size
+					while !$~['value'].nil? && value_index < $~['value'].size
 						if $~['value'][value_index] == '\\'
 							escape = $~['value'].slice(value_index, 2)
 							if TAG_ESCAPES.include? escape
@@ -233,10 +232,10 @@ module IRCParser
 				unless value.nil? || value.empty?
 					buffer += '='
 					value.each_char do |chr|
-						if TAG_ESCAPES.has_value? chr
-							buffer += TAG_ESCAPES.key chr
+						buffer += if TAG_ESCAPES.value? chr
+							TAG_ESCAPES.key chr
 						else
-							buffer += chr
+							chr
 						end
 					end
 				end

data/test/test_message.rb

@@ -96,13 +96,12 @@ describe IRCParser::Message do
 		end
 	end
 
-
 	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 
+		it 'should consist of the correct components' do
 			_(@message.tags).must_be_empty
 			_(@message.prefix).must_be_nil
 			_(@message.command).must_equal 'COMMAND'
@@ -242,4 +241,4 @@ describe IRCParser::Message do
 			}).must_raise IRCParser::Error
 		end
 	end
-end
+end

data/test/test_prefix.rb

@@ -45,7 +45,7 @@ describe IRCParser::Prefix do
 			user: nil,
 			host: nil
 		},
-	}
+	}.freeze
 
 	PREFIXES.each do |serialized, deserialized|
 		describe 'when checking a valid prefix' do
@@ -75,7 +75,7 @@ describe IRCParser::Prefix do
 		'nick!user@',
 		'nick!@host',
 		'!user@host',
-	]
+	].freeze
 
 	MALFORMED.each do |prefix|
 		describe 'when checking an invalid user prefix' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ircparser
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sadie Powell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -63,6 +63,7 @@ files:
 - lib/ircparser/message.rb
 - lib/ircparser/prefix.rb
 - lib/ircparser/stream.rb
+- lib/ircparser/version.rb
 - lib/ircparser/wire/rfc.rb
 - test/test_message.rb
 - test/test_prefix.rb
@@ -78,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="