Refactoring: Enhancing code maintainability by reducing code smells.

pom.xml

@@ -81,6 +81,11 @@
 
     <dependencyManagement>
         <dependencies>
+            <dependency>
+                <groupId>org.telegram</groupId>
+                <artifactId>telegrambots</artifactId>
+                <version>6.9.7.1</version>
+            </dependency>
             <dependency>
                 <groupId>org.projectlombok</groupId>
                 <artifactId>lombok</artifactId>
@@ -135,6 +140,11 @@
                 <artifactId>slf4j-api</artifactId>
                 <version>${slf4j.version}</version>
             </dependency>
+            <dependency>
+                <groupId>ch.qos.logback</groupId>
+                <artifactId>logback-classic</artifactId>
+                <version>1.2.6</version> <!-- added dependency for refactoring empty catch clause code smell-->
+            </dependency>
             <dependency>
                 <groupId>org.apache.commons</groupId>
                 <artifactId>commons-lang3</artifactId>
@@ -218,6 +228,25 @@
                     <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                        <artifactId>jacoco-maven-plugin</artifactId>
+                        <version>0.8.5</version>
+                        <executions>
+                            <execution>
+                                <goals>
+                                    <goal>prepare-agent</goal>
+                                </goals>
+                            </execution>
+                            <execution>
+                                <id>report</id>
+                                <phase>test</phase>
+                                <goals>
+                                    <goal>report</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
             <plugin>
                 <groupId>org.sonatype.plugins</groupId>
                 <artifactId>nexus-staging-maven-plugin</artifactId>

telegrambots-abilities/pom.xml

@@ -80,6 +80,11 @@
     </properties>
 
     <dependencies>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>1.2.3</version> <!-- Added for refactoring -->
+        </dependency>
         <dependency>
             <groupId>org.telegram</groupId>
             <artifactId>telegrambots</artifactId>

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/objects/Ability.java

@@ -19,7 +19,7 @@
 import static java.lang.String.format;
 import static java.util.Objects.hash;
 import static java.util.Optional.ofNullable;
-import static org.telegram.abilitybots.api.util.AbilityUtils.isValidCommandName;
+import static org.telegram.abilitybots.api.util.AbilityUtils.isValCmdName;
 
 /**
  * An ability is a fully-fledged bot action that contains all the necessary information to process:
@@ -50,10 +50,18 @@ public final class Ability {
   private final List<Reply> replies;
   private final List<Predicate<Update>> flags;
 
+
   @SafeVarargs
   private Ability(String name, String info, Locality locality, Privacy privacy, int argNum, boolean statsEnabled, Consumer<MessageContext> action, Consumer<MessageContext> postAction, List<Reply> replies, Predicate<Update>... flags) {
-    checkArgument(isValidCommandName(name), "Method name can only contain alpha-numeric characters and underscores," +
-            " cannot be longer than 31 characters, empty or null", name);
+    // Refactored checkArgument to remove long statement code smell by renaming method name and introducing explaining variables.
+    // Explaining variables - INVALID_METHOD_NAME_ERROR and METHOD_NAME_CONSTRAINT
+    final String INVALID_METHOD_NAME_ERROR = "Method name can only contain alpha-numeric characters and underscores, " ;
+    final String METHOD_NAME_CONSTRAINT = "cannot be longer than 31 characters, and cannot be null";
+
+    // isValueCommandName renamed to isValCmdName
+    checkArgument(isValCmdName(name), INVALID_METHOD_NAME_ERROR+METHOD_NAME_CONSTRAINT, name);
+
+
     this.name = name;
     this.info = info;
 

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/objects/MessageContext.java

@@ -22,6 +22,9 @@ public class MessageContext {
   private final Update update;
   private final BaseAbilityBot bot;
 
+  // Refactored code-Added thirdArg as explaining variable to remove magic number 2
+  int thirdArg = 2;
+
   private MessageContext(Update update, User user, Long chatId, BaseAbilityBot bot, String[] arguments) {
     this.user = user;
     this.chatId = chatId;
@@ -88,7 +91,9 @@ public String secondArg() {
    */
   public String thirdArg() {
     checkLength();
-    return arguments[2 % arguments.length];
+
+    // Replaced magic number 2 with thirdArg
+    return arguments[thirdArg % arguments.length];
   }
 
   /**

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/sender/DefaultSender.java

@@ -27,6 +27,10 @@ public class DefaultSender implements MessageSender {
 
   private DefaultAbsSender bot;
 
+  /*
+  *  Refactored code - Insufficient Modularization design smell refactored by moving the methods related to send functionality
+  * and extracting class DefaultSender1.
+   */
   public DefaultSender(DefaultAbsSender bot) {
     this.bot = bot;
   }
@@ -106,34 +110,4 @@ public void getWebhookInfoAsync(SentCallback<WebhookInfo> sentCallback) throws T
   public Message sendDocument(SendDocument sendDocument) throws TelegramApiException {
     return bot.execute(sendDocument);
   }
-
-  @Override
-  public Message sendPhoto(SendPhoto sendPhoto) throws TelegramApiException {
-    return bot.execute(sendPhoto);
-  }
-
-  @Override
-  public Message sendVideo(SendVideo sendVideo) throws TelegramApiException {
-    return bot.execute(sendVideo);
-  }
-
-  @Override
-  public Message sendSticker(SendSticker sendSticker) throws TelegramApiException {
-    return bot.execute(sendSticker);
-  }
-
-  @Override
-  public Message sendAudio(SendAudio sendAudio) throws TelegramApiException {
-    return bot.execute(sendAudio);
-  }
-
-  @Override
-  public Message sendVoice(SendVoice sendVoice) throws TelegramApiException {
-    return bot.execute(sendVoice);
-  }
-
-  @Override
-  public Message sendVideoNote(SendVideoNote sendVideoNote) {
-    return null;
-  }
 }

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/sender/DefaultSender1.java

@@ -0,0 +1,53 @@
+package org.telegram.abilitybots.api.sender;
+import org.telegram.telegrambots.meta.api.methods.BotApiMethod;
+import org.telegram.telegrambots.meta.api.methods.send.*;
+import org.telegram.telegrambots.meta.api.objects.Message;
+import org.telegram.telegrambots.bots.DefaultAbsSender;
+import org.telegram.telegrambots.meta.exceptions.TelegramApiException;
+import org.telegram.telegrambots.meta.updateshandlers.SentCallback;
+
+import java.io.Serializable;
+public class DefaultSender1 implements MessageSender1{
+    private static final String TAG = MessageSender.class.getName();
+
+    private DefaultAbsSender bot;
+
+    @Override
+    public <T extends Serializable, Method extends BotApiMethod<T>, Callback extends SentCallback<T>> void executeAsync(Method method, Callback callback) throws TelegramApiException {
+
+    }
+
+    @Override
+    public <T extends Serializable, Method extends BotApiMethod<T>> T execute(Method method) throws TelegramApiException {
+        return null;
+    }
+
+    @Override
+    public Message sendPhoto(SendPhoto sendPhoto) throws TelegramApiException {
+        return bot.execute(sendPhoto);
+    }
+
+    @Override
+    public Message sendVideo(SendVideo sendVideo) throws TelegramApiException {
+        return bot.execute(sendVideo);
+    }
+
+    @Override
+    public Message sendSticker(SendSticker sendSticker) throws TelegramApiException {
+        return bot.execute(sendSticker);
+    }
+
+    @Override
+    public Message sendAudio(SendAudio sendAudio) throws TelegramApiException {
+        return bot.execute(sendAudio);
+    }
+
+    @Override
+    public Message sendVoice(SendVoice sendVoice) throws TelegramApiException {
+        return bot.execute(sendVoice);
+    }
+    @Override
+      public Message sendVideoNote(SendVideoNote sendVideoNote) {
+        return null;
+      }
+}

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/sender/MessageSender.java

@@ -54,15 +54,4 @@ public interface MessageSender {
 
   Message sendDocument(SendDocument sendDocument) throws TelegramApiException;
 
-  Message sendPhoto(SendPhoto sendPhoto) throws TelegramApiException;
-
-  Message sendVideo(SendVideo sendVideo) throws TelegramApiException;
-
-  Message sendAudio(SendAudio sendAudio) throws TelegramApiException;
-
-  Message sendVoice(SendVoice sendVoice) throws TelegramApiException;
-
-  Message sendVideoNote(SendVideoNote sendVideoNote) throws TelegramApiException;
-
-  Message sendSticker(SendSticker sendSticker) throws TelegramApiException;
 }

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/sender/MessageSender1.java

@@ -0,0 +1,39 @@
+package org.telegram.abilitybots.api.sender;
+
+
+import org.telegram.telegrambots.meta.api.methods.BotApiMethod;
+import org.telegram.telegrambots.meta.api.methods.send.*;
+import org.telegram.telegrambots.meta.api.objects.Message;
+import org.telegram.telegrambots.bots.DefaultAbsSender;
+import org.telegram.telegrambots.meta.exceptions.TelegramApiException;
+import org.telegram.telegrambots.meta.updateshandlers.SentCallback;
+
+import java.io.Serializable;
+
+/**
+ * A sender interface that replicates {@link DefaultAbsSender} methods.
+ *
+ * @author Abbas Abou Daya
+ */
+public interface MessageSender1 {
+    /*
+    * Refactored code - Interfaces related to send functionality.
+     */
+    <T extends Serializable, Method extends BotApiMethod<T>, Callback extends SentCallback<T>> void executeAsync(Method method, Callback callback) throws TelegramApiException;
+
+    <T extends Serializable, Method extends BotApiMethod<T>> T execute(Method method) throws TelegramApiException;
+
+
+    Message sendPhoto(SendPhoto sendPhoto) throws TelegramApiException;
+
+    Message sendVideo(SendVideo sendVideo) throws TelegramApiException;
+
+    Message sendAudio(SendAudio sendAudio) throws TelegramApiException;
+
+    Message sendVoice(SendVoice sendVoice) throws TelegramApiException;
+
+    Message sendVideoNote(SendVideoNote sendVideoNote) throws TelegramApiException;
+
+    Message sendSticker(SendSticker sendSticker) throws TelegramApiException;
+}
+

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/util/AbilityUtils.java

@@ -302,7 +302,9 @@ public static boolean isValidCommand(String command){
    * @param commandName the command name to be checked for validity
    * @return whether the command name is valid
    */
-  public static boolean isValidCommandName(String commandName){
+
+  // Refactored code by renaming isValueCommandName to isValCmdName method
+  public static boolean isValCmdName(String commandName){
     if (commandName == null || commandName.length() > 31) return false;
     return commandName.matches("[A-Za-z_0-9]+");
   }

telegrambots-abilities/src/test/java/org/telegram/abilitybots/api/objects/AbilityTest.java

@@ -10,9 +10,11 @@
 import static org.telegram.abilitybots.api.bot.DefaultBot.getDefaultBuilder;
 
 class AbilityTest {
+  // Refactored magic number -4 using extract method technique
+  final int inputNegativeNumber = -4;
   @Test
   void argumentsCannotBeNegative() {
-    Assertions.assertThrows(IllegalArgumentException.class, () -> getDefaultBuilder().input(-4).build());
+    Assertions.assertThrows(IllegalArgumentException.class, () -> getDefaultBuilder().input(inputNegativeNumber).build());
   }
 
   @Test

telegrambots-extensions/src/test/java/org/telegram/telegrambots/extensions/bots/commandbot/commands/BotCommandTest.java

@@ -0,0 +1,44 @@
+package org.telegram.telegrambots.extensions.bots.commandbot.commands;
+import org.junit.jupiter.api.Test;
+import org.telegram.telegrambots.meta.api.objects.Chat;
+import org.telegram.telegrambots.meta.api.objects.User;
+import org.telegram.telegrambots.meta.bots.AbsSender;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+
+public class BotCommandTest
+{
+
+    @Test
+    public void testToString()
+    {
+        // Act
+        BotCommand commandidentifier = new TestBotCommand("test","Description");
+
+        // Assert
+        assertEquals("<b>/test</b>\nDescription",commandidentifier.toString());
+    }
+
+    @Test
+    public void testcommandIdentifierStartsWithCOMMAND_INIT_CHARACTER()
+    {
+        // Arrange
+        String commandidentifier = "/YuktaGurnani";
+
+        // Act
+        String result =  commandidentifier.substring(1);
+
+        // Assert
+        assertEquals("YuktaGurnani",result);
+    }
+    private static class TestBotCommand extends BotCommand
+    {
+        public TestBotCommand(String commandIdentifier, String description){
+            super(commandIdentifier,description);
+        }
+        public void execute(AbsSender absSender, User user, Chat chat, String[] arguments)
+        {
+
+        }
+    }
+}

telegrambots-extensions/src/test/java/org/telegram/telegrambots/extensions/bots/commandbot/commands/TimedSendLongPollingBotTest.java

@@ -0,0 +1,42 @@
+package org.telegram.telegrambots.extensions.bots.commandbot.commands;
+
+import org.junit.jupiter.api.Test;
+import org.telegram.telegrambots.extensions.bots.timedbot.TimedSendLongPollingBot;
+import org.telegram.telegrambots.meta.api.objects.Update;
+import static org.mockito.Mockito.mock;
+
+
+public class TimedSendLongPollingBotTest
+{
+    @Test
+    public void testMessageProcessing()
+    {
+        // Arrange
+        TimedSendLongPollingBot testbot = new TimedSendLongPollingBot()
+        {
+            @Override
+            public String getBotUsername() {
+                return null;
+            }
+
+            @Override
+            public void onUpdateReceived(Update update)
+            {
+
+            }
+            @Override
+            public void sendMessageCallback(Long chatId, Object messageRequest)
+            {
+
+            }
+        };
+
+        // Act
+        Long chatId = 002L;
+        Object messageRequest = mock(Object.class);
+
+        // Assert
+        testbot.sendTimed(chatId,messageRequest);
+        testbot.finish();
+    }
+}