Merge pull request #20 from Gikkman/dev-0.6

up-to-0.6

Author: Gikkman

.gitignore

@@ -132,3 +132,6 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 .idea/
+
+# IntelliJ Idea
+/twirc.iml

README.md

@@ -22,19 +22,25 @@ Include the following in your pom.xml
     <dependency>
         <groupId>com.github.gikkman</groupId>
 	<artifactId>Java-Twirk</artifactId>
-	<version>0.5</version>
+	<version>0.6</version>
     </dependency>
 </dependencies>
 ```
 Or simply download the latest version of the library jar from the release page.
 
 ## Changes
-There has been some new features in version 0.5, but nothing that is breaking backwards compability. New features include:
-* Whispers (This was removed in 0.4, but is now back. Twitch said they'd remove it , but they haven't so far so...)
-* Support for new sub-streak logic
-* Updated the example
-* Added even more tests
-* Touched up on some JavaDoc
+There has only been minor changes between 0.5 and 0.6. Nothing that should break backwards compatibility. Fixes include:
+* Fixed NumberFormatException on modified emotes
+  * Twitch changed the emote IDs from always being a number to sometimes being a number_string -.-' Its fixed now
+* Fixed SockerClosedException stacktrace printing on some locales
+  * I think I fixed it at least, but this one is hard to test since there are so many locales.
+* Updated the emotes parse for a safer and faster implementation.
+  * This deprecates a previously public method (`EmoteParse.parseEmote(String, String)`), and the new method is package private. There isn't really any need to call these methods from outside the library
+* Twirk will not only show the "User X was not online" or "User X was already online", when in verbose mode.
+  * This happened when we see a leave/part message but didn't track the user correctly. I felt like it was not needed unless you want the verbose output
+* Updated the example a bit
+* Started to move towards proper JUnit tests
+  * My home rolled test setup wasn't very user friendly, so now I started moving to user regular `@Test` tests. I'll eventually convert all tests to this format 
 
 And probably some more...
 

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>com.gikk</groupId>
     <artifactId>twirc</artifactId>
-    <version>0.5.0</version>
+    <version>0.6.0</version>
     <packaging>jar</packaging>
 
     <name>twirc</name>

src/example/java/com/gikk/twirk/BotExample.java

@@ -33,7 +33,9 @@ public static void main(String[] args) throws IOException, InterruptedException{
 		twirk.addIrcListener( getOnDisconnectListener(twirk) );
 		twirk.addIrcListener( new PatternCommandExample(twirk) );
 		twirk.addIrcListener( new PrefixCommandExample(twirk) );
-		
+
+		System.out.println("\nTo exit this example, type .quit and press Enter\n");
+
 		twirk.connect();	//Connect to Twitch
 
 		//As long as we don't type .quit into the command prompt, send everything we type as a message to twitch

src/example/java/com/gikk/twirk/commands/CommandExampleBase.java

@@ -9,6 +9,10 @@
 import java.util.Set;
 
 public abstract class CommandExampleBase implements TwirkListener {
+	/**
+	 * A PREFIX_COMMAND are the classical commands that starts with a certain pattern (e.g. !time)
+	 * A CONTENT_COMMAND is a command that looks for a certain pattern in the message (e.g. this is !tick)
+	 */
 	public enum CommandType{ PREFIX_COMMAND, CONTENT_COMMAND };
 
 	//***********************************************************************************************

src/example/java/com/gikk/twirk/commands/PatternCommandExample.java

@@ -6,7 +6,7 @@
 import com.gikk.twirk.types.users.TwitchUser;
 
 public class PatternCommandExample extends CommandExampleBase{
-	private static String PATTERN = "tick";
+	private static String PATTERN = "!tick";
 
 	private final Twirk twirk;
 
@@ -27,6 +27,6 @@ protected USER_TYPE getMinUserPrevilidge() {
 
 	@Override
 	protected void performCommand(String command, TwitchUser sender, TwitchMessage message) {
-		twirk.channelMessage("Tock");
+		twirk.channelMessage("tock");
 	}
 }

src/main/java/com/gikk/twirk/InputThread.java

@@ -63,10 +63,10 @@ public void run() {
 	            }
 	            catch (IOException e) {
 	            	//This probably means we force closed the socket. In case something else occurred, we print the StackTrace
-	            	String message = e.getMessage();
-	            	if( (message.contains("Socket Closed")) ){
+	            	String message = e.getMessage().toLowerCase();
+	            	if( (message.toLowerCase().contains("socket closed")) ){
 	            		//Ignore
-	            	} else if ( message.contains("Connection reset") || message.contains("Stream closed")) {
+	            	} else if ( message.contains("connection reset") || message.contains("stream closed")) {
 	            		System.err.println( message );
 	            	}
 	            	else {

src/main/java/com/gikk/twirk/TwirkMaintainanceListener.java

@@ -29,14 +29,16 @@ public void onAnything(String line) {
 	@Override
 	public void onJoin(String joinedNick) {
 		if( !instance.online.add( joinedNick ) ) {
-            System.out.println(" was already listed as online...." + "\tUser " + joinedNick);
+			if(instance.verboseMode)
+            	System.out.println("\tUser " + joinedNick + " was already listed as online....");
         }
 	}
 
 	@Override
 	public void onPart(String partedNick) {
 		if( !instance.online.remove( partedNick ) ) {
-            System.out.println("\tUser " + partedNick + " was not listed as online....");
+			if(instance.verboseMode)
+				System.out.println("\tUser " + partedNick + " was not listed as online....");
         }
 	}
 

src/main/java/com/gikk/twirk/types/emote/EmoteParser.java

@@ -1,88 +1,22 @@
 package com.gikk.twirk.types.emote;
 
-import java.util.LinkedList;
-import java.util.List;
-
-public class EmoteParser {
-	private static final String EMOTES_IDENTIFIER = "emotes=";
-
-	public static List<Emote> parseEmotes(String content, String tag) {
-		/* Emotes come in sets formated like this:
-		 *
-		 * emotes=15614:0-6/4685:8-13,15-21		(Message = tmrToad tmrHat tmrHat)
-		 *
-		 * The first number indicates the emotes ID. The emote ID is follower by a :
-		 * The numbers separated by a - indicates the indices in the message that makes up the emote.
-		 *     If an emote appears several times in a message, the different index ranges are separated by a ,
-		 *
-		 * So we find the begining of the emotes section and the end of the section.
-		 * Then, check that the message actually contains an emotes section and that
-		 * the emote section actually contains data.
-		 */
-		List<Emote> emotes = new LinkedList<>();
-
-		int begin = tag.indexOf( EMOTES_IDENTIFIER );
-		int end =   tag.indexOf(';', begin );
-		if( begin == -1 || begin + EMOTES_IDENTIFIER.length() == end){
-			return emotes;
-		}
-
-		/* This segment is a head ache, but here is a basic idea of what it is doing:
-		 * Iterate through the emotes-section.
-		 *    The first part will be the emote ID. it is terminated by a :
-		 *    The second part is the emote's start index. It is terminated by a -
-		 *    The third part is the emote's end index. It is terminated EITHER by a / or a , or by the segment ending
-		 *       If terminated by a , the emote is present more than once in the message. So the next part will be a new begin index
-		 *       If terminated by a / there is another emote in the message. The next part is a new emote ID
-		 *       If terminated by the segment ending we simply finish the last begin-end pair and we are done
-		 */
-		String emotesString = tag.substring( begin + EMOTES_IDENTIFIER.length(), end);
+import com.gikk.twirk.types.TagMap;
 
-		EmoteImpl emote = new EmoteImpl();
-		StringBuilder str = new StringBuilder();
-		String emoteID = "", beginIndex = "";
-		for( char c : emotesString.toCharArray() ){
-			switch(c) {
-			case ':':
-				emoteID = str.toString();
-				str.setLength(0);
-				break;
-			case '-' :
-				beginIndex = str.toString();
-				str.setLength(0);
-				break;
-			case ',':
-				addIndices(emote, beginIndex, str.toString() );
-				str.setLength(0);
-				break;
-			case '/':
-				finalizeEmote(content, emotes, emote, emoteID, beginIndex, str.toString() );
-				emote = new EmoteImpl();
-				str.setLength(0);
-				break;
-			default:
-				str.append(c);
-			}
-		}
-		//The emotes segment ended, so we finish the current emote's begin-end pair, then we're done
-		finalizeEmote(content, emotes, emote, emoteID, beginIndex, str.toString());
-
-		return emotes;
-	}
-
-	private static void finalizeEmote(String content, List<Emote> emotes, EmoteImpl emote, String emoteID, String beginIndex, String endIndex) {
-		int begin = Integer.parseInt( beginIndex );
-		int end   = Integer.parseInt( endIndex ) + 1;	//The end index we receive from Twitch is inclusive, but Java is almost always exclusive
-		emote.addIndices(begin, end);
-
-		emote.setEmoteID( Integer.parseInt( emoteID ) );
-		emote.setPattern( content.substring(begin, end) );
-		emotes.add(emote);
-	}
+import java.util.List;
 
-	private static void addIndices(EmoteImpl emote, String beginIndex, String endIndex){
-		int begin = Integer.parseInt( beginIndex );
-		int end   = Integer.parseInt( endIndex ) + 1;
-		emote.addIndices(begin, end);
-	}
+public interface EmoteParser {
+    /**
+     * @deprecated Use {{@link #parseEmotes(TagMap, String)} instead. This will be removed in a future release}
+     */
+    @Deprecated
+    static List<Emote> parseEmotes(String content, String tag) {
+        TagMap tagMap = TagMap.getDefault(tag);
+        return new EmoteParserImpl().parseEmotes(tagMap, content);
+    }
+
+    static EmoteParser getDefaultImplementation() {
+        return new EmoteParserImpl();
+    }
+
+    List<Emote> parseEmotes(TagMap tagMap, String content);
 }

src/main/java/com/gikk/twirk/types/emote/EmoteParserImpl.java

@@ -0,0 +1,85 @@
+package com.gikk.twirk.types.emote;
+
+import com.gikk.twirk.types.TagMap;
+import com.gikk.twirk.types.TwitchTags;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class EmoteParserImpl implements EmoteParser {
+
+	@Override
+	public List<Emote> parseEmotes(TagMap tagMap, String content) {
+		/* Emotes come in sets formatted like this:
+		 *
+		 * emotes=15614:0-6/4685:8-13,15-21		(Message = tmrToad tmrHat tmrHat)
+		 *
+		 * The first number indicates the emotes ID. The emote ID is follower by a :
+		 * The numbers separated by a - indicates the indices in the message that makes up the emote.
+		 *     If an emote appears several times in a message, the different index ranges are separated by a ,
+		 *
+		 * Thankfully the tagmap does the extraction for us, but this piece of information is left here for reference
+		 */
+
+		/* This segment is a head ache, but here is a basic idea of what it is doing:
+		 * Iterate through the emotes-section.
+		 *    The first part will be the emote ID. it is terminated by a :
+		 *    The second part is the emote's start index. It is terminated by a -
+		 *    The third part is the emote's end index. It is terminated EITHER by a / or a , or by the segment ending
+		 *       If terminated by a , the emote is present more than once in the message. So the next part will be a new begin index
+		 *       If terminated by a / there is another emote in the message. The next part is a new emote ID
+		 *       If terminated by the segment ending we simply finish the last begin-end pair and we are done
+		 */
+		List<Emote> emotes = new ArrayList<>();
+		String emotesString = tagMap.getAsString(TwitchTags.EMOTES);
+		if(emotesString == null || emotesString.isEmpty()) return emotes;
+
+		EmoteImpl emote = new EmoteImpl();
+		StringBuilder str = new StringBuilder();
+		String emoteID = "", beginIndex = "";
+		for( char c : emotesString.toCharArray() ){
+			switch(c) {
+			case ':':
+				emoteID = str.toString();
+				str.setLength(0);
+				break;
+			case '-' :
+				beginIndex = str.toString();
+				str.setLength(0);
+				break;
+			case ',':
+				addIndices(emote, beginIndex, str.toString() );
+				str.setLength(0);
+				break;
+			case '/':
+				finalizeEmote(content, emotes, emote, emoteID, beginIndex, str.toString() );
+				emote = new EmoteImpl();
+				str.setLength(0);
+				break;
+			default:
+				str.append(c);
+			}
+		}
+		//The emotes segment ended, so we finish the current emote's begin-end pair, then we're done
+		finalizeEmote(content, emotes, emote, emoteID, beginIndex, str.toString());
+
+		return emotes;
+	}
+
+	private static void finalizeEmote(String content, List<Emote> emotes, EmoteImpl emote, String emoteID, String beginIndex, String endIndex) {
+		int begin = Integer.parseInt( beginIndex );
+		int end   = Integer.parseInt( endIndex ) + 1;	//The end index we receive from Twitch is inclusive, but Java is almost always exclusive
+		emote.addIndices(begin, end);
+
+                if(emoteID.contains("_")) emoteID = emoteID.substring(0, emoteID.indexOf("_"));
+		emote.setEmoteID( Integer.parseInt( emoteID ) );
+		emote.setPattern( content.substring(begin, end) );
+		emotes.add(emote);
+	}
+
+	private static void addIndices(EmoteImpl emote, String beginIndex, String endIndex){
+		int begin = Integer.parseInt( beginIndex );
+		int end   = Integer.parseInt( endIndex ) + 1;
+		emote.addIndices(begin, end);
+	}
+}