Added randomize task order option to loop task

Author: Explv

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.explv.explv_osbot_manager</groupId>
     <artifactId>explvs_aio</artifactId>
-    <version>v3.0.1</version>
+    <version>v3.1.0</version>
     <repositories>
         <repository>
             <id>local-repo</id>

src/main/java/gui/task_panels/LoopTaskPanel.java

@@ -1,6 +1,7 @@
 package gui.task_panels;
 
 import gui.fields.IntegerField;
+import gui.styled_components.StyledJCheckBox;
 import gui.styled_components.StyledJComboBox;
 import gui.styled_components.StyledJLabel;
 import gui.styled_components.StyledJPanel;
@@ -16,6 +17,7 @@
 public class LoopTaskPanel extends TaskPanel {
 
     private JTextField taskCountField;
+    private JCheckBox randomizeTasksCheckBox;
     private JComboBox<LoopDurationType> loopDurationTypeSelector;
     private JTextField iterationCountField;
     private DurationPanel durationPanel;
@@ -36,6 +38,11 @@ public class LoopTaskPanel extends TaskPanel {
 
         contentPanel.add(tasksPanel);
 
+        JPanel randomizeTasksPanel = new StyledJPanel(new FlowLayout(FlowLayout.LEFT, 5, 5));
+        randomizeTasksCheckBox = new StyledJCheckBox("Randomize task order");
+        randomizeTasksPanel.add(randomizeTasksCheckBox);
+        contentPanel.add(randomizeTasksPanel);
+
         JPanel loopTaskDurationPanel = new StyledJPanel(new FlowLayout(FlowLayout.LEFT, 5, 5));
         contentPanel.add(loopTaskDurationPanel);
 
@@ -77,15 +84,16 @@ public Task toTask() {
         LoopDurationType loopDurationType = (LoopDurationType) loopDurationTypeSelector.getSelectedItem();
 
         int taskCount = Integer.parseInt(taskCountField.getText());
+        boolean randomize = randomizeTasksCheckBox.isSelected();
 
         if (loopDurationType == LoopDurationType.ITERATIONS) {
-            return LoopTask.forIterations(taskCount, Integer.parseInt(iterationCountField.getText()));
+            return LoopTask.forIterations(taskCount, randomize, Integer.parseInt(iterationCountField.getText()));
         } else if (loopDurationType == LoopDurationType.INFINITE) {
-            return LoopTask.forIterations(taskCount, LoopTask.INFINITE_ITERATIONS);
+            return LoopTask.forIterations(taskCount, randomize, LoopTask.INFINITE_ITERATIONS);
         } else if (durationPanel.getSelectedTimeType() == DurationPanel.TimeType.MINUTES) {
-            return LoopTask.forDuration(taskCount, durationPanel.getDurationMS());
+            return LoopTask.forDuration(taskCount, randomize, durationPanel.getDurationMS());
         } else {
-            return LoopTask.untilDateTime(taskCount, durationPanel.getSelectedDateTime());
+            return LoopTask.untilDateTime(taskCount, randomize, durationPanel.getSelectedDateTime());
         }
     }
 
@@ -94,6 +102,7 @@ public JSONObject toJSON() {
         JSONObject jsonObject = new JSONObject();
         jsonObject.put("type", TaskType.LOOP.name());
         jsonObject.put("taskCount", taskCountField.getText());
+        jsonObject.put("randomize", randomizeTasksCheckBox.isSelected());
 
         LoopDurationType loopDurationType = (LoopDurationType) loopDurationTypeSelector.getSelectedItem();
 
@@ -114,6 +123,10 @@ public JSONObject toJSON() {
     public void fromJSON(JSONObject jsonObject) {
         taskCountField.setText((String) jsonObject.get("taskCount"));
 
+        if (jsonObject.containsKey("randomize")) {
+            randomizeTasksCheckBox.setSelected((boolean) jsonObject.get("randomize"));
+        }
+
         if (jsonObject.containsKey("iterationCount")) {
             iterationCountField.setText((String) jsonObject.get("iterationCount"));
             loopDurationTypeSelector.setSelectedItem(LoopDurationType.ITERATIONS);

src/main/java/script/AIO.java

@@ -30,7 +30,7 @@
 @ScriptManifest(author = "Explv", name = "Explv's AIO " + AIO.VERSION, info = "AIO", version = 0, logo = "http://i.imgur.com/58Zz0fb.png")
 public class AIO extends Script {
 
-    static final String VERSION = "v3.0.1";
+    static final String VERSION = "v3.1.0";
 
     private Gui gui;
     private Paint paint;

src/main/java/tasks/LoopTask.java

@@ -1,18 +1,21 @@
 package tasks;
 
+import tasks.break_task.BreakTask;
 import tasks.task_executor.TaskChangeListener;
 import tasks.task_executor.TaskExecutor;
 import util.Copyable;
 
 import java.time.LocalDateTime;
-import java.util.List;
+import java.util.*;
+import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
 public class LoopTask extends Task {
 
     public static final int INFINITE_ITERATIONS = -1;
 
-    private int taskCount;
+    private final int taskCount;
+    private final boolean randomize;
 
     private int numIterations;
     private long startTimeMS = -1, durationMS = -1;
@@ -26,27 +29,26 @@ public class LoopTask extends Task {
 
     private List<Task> loopTasks;
 
-    private LoopTask() {
+    private LoopTask(final int taskCount, final boolean randomize) {
         super(TaskType.LOOP);
+        this.taskCount = taskCount;
+        this.randomize = randomize;
     }
 
-    public static LoopTask forIterations(final int taskCount, final int numIterations) {
-        LoopTask loopTask = new LoopTask();
-        loopTask.taskCount = taskCount;
+    public static LoopTask forIterations(final int taskCount, final boolean randomize, final int numIterations) {
+        LoopTask loopTask = new LoopTask(taskCount, randomize);
         loopTask.numIterations = numIterations;
         return loopTask;
     }
 
-    public static LoopTask forDuration(final int taskCount, final long durationMS) {
-        LoopTask loopTask = new LoopTask();
-        loopTask.taskCount = taskCount;
+    public static LoopTask forDuration(final int taskCount, final boolean randomize, final long durationMS) {
+        LoopTask loopTask = new LoopTask(taskCount, randomize);
         loopTask.durationMS = durationMS;
         return loopTask;
     }
 
-    public static LoopTask untilDateTime(final int taskCount, final LocalDateTime endDateTime) {
-        LoopTask loopTask = new LoopTask();
-        loopTask.taskCount = taskCount;
+    public static LoopTask untilDateTime(final int taskCount, final boolean randomize, final LocalDateTime endDateTime) {
+        LoopTask loopTask = new LoopTask(taskCount, randomize);
         loopTask.endDateTime = endDateTime;
         return loopTask;
     }
@@ -57,6 +59,12 @@ public void setup(final List<Task> allTasks,
         this.startTaskIndex = this.endTaskIndex - taskCount;
 
         loopTasks = getLoopTasks(allTasks);
+
+        if (randomize) {
+            randomizeTasks(loopTasks);
+            log("Randomized tasks");
+        }
+
         taskExecutor = new TaskExecutor(loopTasks);
         taskExecutor.addTaskChangeListeners(taskChangeListeners);
     }
@@ -108,6 +116,36 @@ private List<Task> copyTasks(final List<Task> tasks) {
                 .collect(Collectors.toList());
     }
 
+    private void randomizeTasks(final List<Task> tasks) {
+        // Randomly shuffle any tasks that are not break tasks
+        randomizeTasks(tasks, task -> !(task instanceof BreakTask));
+
+        // Then randomly shuffle all break tasks
+        randomizeTasks(tasks, task -> task instanceof BreakTask);
+    }
+
+    /**
+     * Randomizes the order of tasks in a list of tasks
+     * Only tasks that match the taskPredicate will be re-ordered
+     * @param tasks List if tasks to be randomized
+     * @param taskPredicate A task predicate to determine candidates for re-ordering
+     */
+    private void randomizeTasks(final List<Task> tasks, final Predicate<Task> taskPredicate) {
+        List<Task> breakTasks = tasks.stream()
+                .filter(taskPredicate)
+                .collect(Collectors.toList());
+
+        Collections.shuffle(breakTasks);
+
+        Queue<Task> randomBreakTaskQueue = new LinkedList<>(breakTasks);
+
+        for (int i = 0; i < tasks.size(); i ++) {
+            if (taskPredicate.test(tasks.get(i))) {
+                tasks.set(i, randomBreakTaskQueue.poll());
+            }
+        }
+    }
+
     @Override
     public boolean canExit() {
         return true;
@@ -116,11 +154,11 @@ public boolean canExit() {
     @Override
     public Task copy() {
         if (endDateTime != null) {
-            return LoopTask.untilDateTime(taskCount, endDateTime);
+            return LoopTask.untilDateTime(taskCount, randomize, endDateTime);
         } else if (durationMS != -1) {
-            return LoopTask.forDuration(taskCount, durationMS);
+            return LoopTask.forDuration(taskCount, randomize, durationMS);
         }
-        return LoopTask.forIterations(taskCount, numIterations);
+        return LoopTask.forIterations(taskCount, randomize, numIterations);
     }
 
     @Override