First part of parameters implementation: introduce parameters table and parsing

Author: introfog

README.md

@@ -38,7 +38,6 @@ Explore, contribute, and customize the application according to your preferences
 - Allow working with app by using only keyboard (with correct Tabs, Esc and so on work).
 - Exclude sub-directories from command running.
 - Allow export and import config.
-- Implement dynamic fields in commands, e.g. command `git checkout -f {branch}` and you can quickly specify which branch checkout in each command run. 
 
 ## License
 GitWave is licensed under the [Apache license](LICENSE.md), providing you with the freedom to use, modify, and distribute the software.

src/main/java/com/github/introfog/gitwave/controller/ExecuteController.java

@@ -23,19 +23,33 @@
 import com.github.introfog.gitwave.model.StageFactory;
 import com.github.introfog.gitwave.model.StageFactory.FxmlStageHolder;
 import com.github.introfog.gitwave.model.dto.CommandDto;
+import com.github.introfog.gitwave.model.dto.ParameterDto;
 
 import java.io.File;
+import java.util.HashSet;
 import java.util.Objects;
+import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
 import javafx.scene.control.ButtonType;
+import javafx.scene.control.Label;
+import javafx.scene.control.TableColumn;
+import javafx.scene.control.TableView;
 import javafx.scene.control.TextField;
+import javafx.scene.control.cell.PropertyValueFactory;
+import javafx.scene.control.cell.TextFieldTableCell;
 import javafx.stage.DirectoryChooser;
 import javafx.stage.Stage;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 public class ExecuteController extends BaseController {
+    // TODO add opportunity to check if new release is available for GitWave
+    private static final Pattern CURL_BRACKETS_PATTERN = Pattern.compile("\\{(\\S+)\\}");
     private static final Logger LOGGER = LoggerFactory.getLogger(ExecuteController.class);
     private static final String GREEN_TEXT_CSS_STYLE = "-fx-text-fill: green";
     private static final String RED_TEXT_CSS_STYLE = "-fx-text-fill: red";
@@ -53,6 +67,12 @@ public class ExecuteController extends BaseController {
     @FXML
     private Button save;
 
+    @FXML
+    private Label parametersText;
+
+    @FXML
+    private TableView<ParameterDto> parametersTable;
+
     private CommandDto sourceCommand;
 
     @Override
@@ -64,18 +84,7 @@ public void initialize(FxmlStageHolder fxmlStageHolder) {
             DialogFactory.createCloseConfirmationAlert(primaryStage);
         });
 
-        command.textProperty().addListener((obs, oldText, newText) -> {
-            if (sourceCommand != null) {
-                updateFields(newText, command, true);
-            } else {
-                save.setDisable(newText.isEmpty());
-            }
-        });
-        description.textProperty().addListener((obs, oldText, newText) -> {
-            if (sourceCommand != null) {
-                updateFields(newText, description, false);
-            }
-        });
+        setUpSaveIndication();
     }
 
     @FXML
@@ -177,7 +186,23 @@ protected void foundIssue() {
         AppConfig.getInstance().getHostServices().showDocument(AppConstants.LINK_TO_GIT_CONTRIBUTING_FILE);
     }
 
-    private void updateFields(String currentMainText, TextField field, boolean isCommand) {
+    private void setUpSaveIndication() {
+        command.textProperty().addListener((obs, oldText, newText) -> {
+            parseCommandParameters();
+            if (sourceCommand != null) {
+                updateSaveIndication(newText, command, true);
+            } else {
+                save.setDisable(newText.isEmpty());
+            }
+        });
+        description.textProperty().addListener((obs, oldText, newText) -> {
+            if (sourceCommand != null) {
+                updateSaveIndication(newText, description, false);
+            }
+        });
+    }
+
+    private void updateSaveIndication(String currentMainText, TextField field, boolean isCommand) {
         final String sourceMainText = isCommand ? sourceCommand.getCommand() : sourceCommand.getDescription();
         final String sourceSecText = isCommand ? sourceCommand.getDescription() : sourceCommand.getCommand();
         final String currentSecText = isCommand ? description.getText() : command.getText();
@@ -193,6 +218,39 @@ private void updateFields(String currentMainText, TextField field, boolean isCom
         }
     }
 
+    private void parseCommandParameters() {
+        final Set<ParameterDto> parameters = new HashSet<>();
+        Matcher matcher = CURL_BRACKETS_PATTERN.matcher(command.getText());
+        while (matcher.find()) {
+            final String name = matcher.group(1);
+            parameters.add(new ParameterDto(name, ""));
+        }
+        if (parameters.isEmpty()) {
+            parametersText.setVisible(true);
+
+            parametersTable.setDisable(true);
+            parametersTable.setVisible(false);
+            parametersTable.getItems().clear();
+        } else {
+            parametersText.setVisible(false);
+
+            parametersTable.setDisable(false);
+            parametersTable.setVisible(true);
+
+            ObservableList<ParameterDto> itemList = FXCollections.observableArrayList(parameters);
+            parametersTable.getItems().clear();
+            parametersTable.setItems(itemList);
+
+            final TableColumn<ParameterDto, String> nameTableColumn = (TableColumn<ParameterDto, String>) parametersTable.getColumns().get(0);
+            nameTableColumn.setCellValueFactory(new PropertyValueFactory<>("name"));
+            nameTableColumn.setCellFactory(TextFieldTableCell.forTableColumn());
+
+            final TableColumn<ParameterDto, String> valueTableColumn = (TableColumn<ParameterDto, String>) parametersTable.getColumns().get(1);
+            valueTableColumn.setCellValueFactory(new PropertyValueFactory<>("value"));
+            valueTableColumn.setCellFactory(TextFieldTableCell.forTableColumn());
+        }
+    }
+
     private void specifySourceCommand(CommandDto commandDto) {
         save.setDisable(true);
         sourceCommand = commandDto;
@@ -203,6 +261,7 @@ private void specifySourceCommand(CommandDto commandDto) {
             description.setStyle(BLACK_TEXT_CSS_STYLE);
         } else {
             command.setText(commandDto.getCommand());
+            parseCommandParameters();
             command.setStyle(GREEN_TEXT_CSS_STYLE);
             description.setText(commandDto.getDescription());
             description.setStyle(GREEN_TEXT_CSS_STYLE);

src/main/java/com/github/introfog/gitwave/controller/ExploreController.java

@@ -33,14 +33,11 @@
 import javafx.scene.control.cell.TextFieldTableCell;
 import javafx.scene.input.KeyCode;
 import javafx.scene.input.MouseEvent;
-import javafx.scene.layout.AnchorPane;
 
 public class ExploreController extends BaseController {
     @FXML
     private TableView<CommandDto> commandsTable;
 
-    @FXML
-    private AnchorPane anchor;
     private CommandDto pickedItem;
     private final List<CommandDto> removedItems = new ArrayList<>();
 
@@ -91,14 +88,6 @@ private void setUpAndFillTable() {
         TableColumn<CommandDto, String> removeTableColumn = (TableColumn<CommandDto, String>) commandsTable.getColumns().get(2);
         removeTableColumn.setCellValueFactory(new PropertyValueFactory<>("description"));
         removeTableColumn.setCellFactory(column -> new RemoveTableCell(this));
-
-
-        anchor.widthProperty().addListener((obs, oldVal, newVal) -> {
-            double width = (newVal.doubleValue() - removeTableColumn.getWidth() - 4) * 0.5;
-            // TODO MINOR there is a bug that when user change column width manually, and after that resize window, it automatically reset user changes
-            commandTableColumn.setPrefWidth(width);
-            descriptionTableColumn.setPrefWidth(width);
-        });
     }
 
     private static class RemoveTableCell extends TableCell<CommandDto, String> {

src/main/java/com/github/introfog/gitwave/model/AppConstants.java

@@ -21,6 +21,7 @@ public final class AppConstants {
     public static final String LINK_TO_GIT_CONTRIBUTING_FILE = "https://github.com/introfog/GitWave/blob/master/CONTRIBUTING.md";
     public static final String LINK_TO_GIT_REPO = "https://github.com/introfog/GitWave";
     public static final String PATH_TO_LOGO = "/logo.png";
+    // TODO make pretty logo
 
     private AppConstants() {
         // empty

src/main/java/com/github/introfog/gitwave/model/dto/ParameterDto.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2023-2024 Dmitry Chubrick
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.github.introfog.gitwave.model.dto;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Objects;
+
+public class ParameterDto {
+    @JsonProperty("name")
+    private String name;
+    @JsonProperty("value")
+    private String value;
+
+    public ParameterDto(@JsonProperty("name") String name,
+            @JsonProperty("value") String value) {
+        this.name = name;
+        this.value = value;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
+    public void setValue(String value) {
+        this.value = value;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        ParameterDto that = (ParameterDto) o;
+        return Objects.equals(name, that.name) && Objects.equals(value, that.value);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(name, value);
+    }
+}

src/main/resources/com/github/introfog/gitwave/view/executor.fxml

@@ -9,6 +9,8 @@
 <?import javafx.scene.control.Separator?>
 <?import javafx.scene.control.SeparatorMenuItem?>
 <?import javafx.scene.control.Tab?>
+<?import javafx.scene.control.TableColumn?>
+<?import javafx.scene.control.TableView?>
 <?import javafx.scene.control.TabPane?>
 <?import javafx.scene.control.TextField?>
 <?import javafx.scene.layout.AnchorPane?>
@@ -99,7 +101,19 @@
                 </Tab>
                 <Tab text="3. Parameters">
                   <content>
-                    <AnchorPane minHeight="0.0" minWidth="0.0" prefHeight="180.0" prefWidth="200.0" />
+                    <AnchorPane minHeight="0.0" minWidth="0.0" prefHeight="180.0" prefWidth="200.0">
+                           <children>
+                              <TableView fx:id="parametersTable" disable="true" editable="true" layoutX="91.0" layoutY="-18.0" prefHeight="200.0" prefWidth="200.0" visible="false" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
+                                <columns>
+                                  <TableColumn editable="false" minWidth="100.0" prefWidth="75.0" text="Name" />
+                                  <TableColumn minWidth="100.0" prefWidth="75.0" text="Value" />
+                                </columns>
+                                 <columnResizePolicy>
+                                    <TableView fx:constant="CONSTRAINED_RESIZE_POLICY" />
+                                 </columnResizePolicy>
+                              </TableView>
+                              <Label fx:id="parametersText" layoutX="28.0" layoutY="14.0" prefHeight="50.0" prefWidth="418.0" text="Current command doesn't define any parameters. Enter your parameter in the format {parameterName}. Ensure that parameterName is not empty or contains only spaces." wrapText="true" AnchorPane.leftAnchor="20.0" AnchorPane.rightAnchor="20.0" AnchorPane.topAnchor="20.0" />
+                           </children></AnchorPane>
                   </content>
                 </Tab>
               </tabs>

src/main/resources/com/github/introfog/gitwave/view/explorer.fxml

@@ -11,6 +11,9 @@
           <TableColumn minWidth="100.0" prefWidth="-1.0" text="Description" />
             <TableColumn editable="false" maxWidth="30.0" minWidth="30.0" prefWidth="30.0" resizable="false" sortable="false" />
         </columns>
+         <columnResizePolicy>
+            <TableView fx:constant="CONSTRAINED_RESIZE_POLICY" />
+         </columnResizePolicy>
       </TableView>
    </children>
 </AnchorPane>