chore: Refactor

Author: ayonious

.circleci/config.yml

@@ -14,7 +14,7 @@ jobs:
         java-version: [11, 17]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v5
 
     - name: Set up JDK ${{ matrix.java-version }}
       uses: actions/setup-java@v3
@@ -31,7 +31,7 @@ jobs:
 
     - name: Upload test results
       if: always()
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: test-results-java-${{ matrix.java-version }}
         path: target/surefire-reports/

.github/workflows/build.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [ master, main ]
+  pull_request:
+    branches: [ master, main ]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v5
+    
+    - name: Setup Java
+      uses: actions/setup-java@v4
+      with:
+        java-version: '21'
+        distribution: 'temurin'
+    
+    - name: Cache Maven dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.m2
+        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+        restore-keys: ${{ runner.os }}-m2
+    
+    - name: Run tests
+      run: mvn test
+    
+    - name: Build project
+      run: mvn clean package

.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 # File Compression
 
-[![Build and Test](https://github.com/ayonious/File-Compression/actions/workflows/build.yml/badge.svg)](https://github.com/ayonious/File-Compression/actions/workflows/build.yml)
+[![CI](https://github.com/ayonious/File-Compression/workflows/CI/badge.svg)](https://github.com/ayonious/File-Compression/actions)
 [![codecov](https://codecov.io/gh/ayonious/File-Compression/branch/master/graph/badge.svg)](https://codecov.io/gh/ayonious/File-Compression)
 [![GitHub stars](https://img.shields.io/github/stars/ayonious/File-Compression?style=social)](https://github.com/ayonious/File-Compression/stargazers)
 

FileCompression.jar

@@ -13,6 +13,7 @@
         <maven.compiler.target>21</maven.compiler.target>
         <maven.compiler.release>21</maven.compiler.release>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <jacoco.version>0.8.12</jacoco.version>
     </properties>
 
     <dependencies>
@@ -67,19 +68,36 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>3.2.5</version>
+                <configuration>
+                    <argLine>
+                        --add-opens java.base/java.lang=ALL-UNNAMED
+                        --add-opens java.base/java.util=ALL-UNNAMED
+                        --add-opens java.base/sun.util.resources.cldr.provider=ALL-UNNAMED
+                        ${argLine}
+                    </argLine>
+                </configuration>
             </plugin>
 
             <!-- JaCoCo Plugin for code coverage -->
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
-                <version>0.8.11</version>
+                <version>${jacoco.version}</version>
+                <configuration>
+                    <excludes>
+                        <exclude>**/module-info.class</exclude>
+                        <exclude>sun/util/resources/**</exclude>
+                    </excludes>
+                </configuration>
                 <executions>
                     <execution>
                         <id>prepare-agent</id>
                         <goals>
                             <goal>prepare-agent</goal>
                         </goals>
+                        <configuration>
+                            <propertyName>argLine</propertyName>
+                        </configuration>
                     </execution>
                     <execution>
                         <id>report</id>

README.md

@@ -10,44 +10,45 @@
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 
-import prog.huffman.Hzipping;
-import prog.huffman.Hunzipping;
-import prog.lzw.Lzipping;
-import prog.lzw.Lunzipping;
+import prog.huffman.HuffmanCompressor;
+import prog.huffman.HuffmanDecompressor;
+import prog.lzw.LzwCompressor;
+import prog.lzw.LzwDecompressor;
+import prog.util.Constants;
 
 public class Main extends JFrame implements ActionListener {
 	// Definition of global values and items that are part of the GUI.
 
-	static public File opened_file, other_file;
-	static long past, future;
-	static JLabel redLabel, blueLabel, redScore, blueScore;
+	static public File openedFile, outputFile;
+	static long originalSize, compressedSize;
+	static JLabel originalSizeLabel, compressedSizeLabel, originalSizeValue, compressedSizeValue;
 	static JPanel buttonPanel, titlePanel, scorePanel;
-	static JButton ZH, UH, ZL, UL, EX;
+	static JButton huffmanCompressButton, huffmanDecompressButton, lzwCompressButton, lzwDecompressButton, exitButton;
 
 	public JPanel createContentPane() {
 		return MainPanel.createContentPane(this);
 	}
 
 	private void handleHuffmanCompression() {
-		Hzipping.beginHzipping(opened_file.getPath());
+		HuffmanCompressor.beginHuffmanCompression(openedFile.getPath());
 		showCompressionCompleteDialog("Zipping");
-		updateFileStats(".huffz");
+		updateFileStats(Constants.HUFFMAN_FILE_EXTENSION);
 	}
 
 	private void handleHuffmanDecompression() {
-		Hunzipping.beginHunzipping(opened_file.getPath());
+		HuffmanDecompressor.beginHuffmanDecompression(openedFile.getPath());
 		showCompressionCompleteDialog("UnZipping");
 		updateDecompressionStats();
 	}
 
 	private void handleLZWCompression() {
-		Lzipping.beginLzipping(opened_file.getPath());
+		LzwCompressor.beginLzwCompression(openedFile.getPath());
 		showCompressionCompleteDialog("Zipping");
-		updateFileStats(".LmZWp");
+		updateFileStats(Constants.LZW_FILE_EXTENSION);
 	}
 
 	private void handleLZWDecompression() {
-		Lunzipping.beginLunzipping(opened_file.getPath());
+		LzwDecompressor.beginLzwDecompression(openedFile.getPath());
 		showCompressionCompleteDialog("UnZipping");
 		updateDecompressionStats();
 	}
@@ -59,31 +60,31 @@ private void showCompressionCompleteDialog(String operation) {
 	}
 
 	private void updateFileStats(String extension) {
-		redScore.setText(opened_file.length() + "Bytes");
-		other_file = new File(opened_file.getPath() + extension);
-		future = other_file.length();
-		blueScore.setText(future + "Bytes");
+		originalSizeValue.setText(openedFile.length() + "Bytes");
+		outputFile = new File(openedFile.getPath() + extension);
+		compressedSize = outputFile.length();
+		compressedSizeValue.setText(compressedSize + "Bytes");
 	}
 
 	private void updateDecompressionStats() {
-		redScore.setText(opened_file.length() + "Bytes");
-		String s = opened_file.getPath();
+		originalSizeValue.setText(openedFile.length() + "Bytes");
+		String s = openedFile.getPath();
 		s = s.substring(0, s.length() - 6);
-		other_file = new File(s);
-		future = other_file.length();
-		blueScore.setText(future + "Bytes");
+		outputFile = new File(s);
+		compressedSize = outputFile.length();
+		compressedSizeValue.setText(compressedSize + "Bytes");
 	}
 
 	public void actionPerformed(ActionEvent e) {
-		if (e.getSource() == ZH) {
+		if (e.getSource() == huffmanCompressButton) {
 			handleHuffmanCompression();
-		} else if (e.getSource() == UH) {
+		} else if (e.getSource() == huffmanDecompressButton) {
 			handleHuffmanDecompression();
-		} else if (e.getSource() == ZL) {
+		} else if (e.getSource() == lzwCompressButton) {
 			handleLZWCompression();
-		} else if (e.getSource() == UL) {
+		} else if (e.getSource() == lzwDecompressButton) {
 			handleLZWDecompression();
-		} else if (e.getSource() == EX) {
+		} else if (e.getSource() == exitButton) {
 			System.exit(0);
 		}
 	}

pom.xml

@@ -3,10 +3,11 @@
 import javax.swing.*;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import prog.util.Constants;
 
 public class MainFrame {
     private static JFrame createMainFrame() {
-        JFrame frame = new JFrame("File Compresser");
+        JFrame frame = new JFrame("File Compressor");
         frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
         frame.setBounds(350, 170, 550, 300);
         return frame;
@@ -44,10 +45,10 @@ private static void handleFileOpen() {
         fileChooser.setFileSelectionMode(JFileChooser.FILES_AND_DIRECTORIES);
         int result = fileChooser.showOpenDialog(null);
         if (result == JFileChooser.APPROVE_OPTION) {
-            Main.opened_file = fileChooser.getSelectedFile();
-            Main.past = Main.opened_file.length();
-            Main.redScore.setText(Main.past + "Bytes");
-            Main.blueScore.setText("NotYetCalculated");
+            Main.openedFile = fileChooser.getSelectedFile();
+            Main.originalSize = Main.openedFile.length();
+            Main.originalSizeValue.setText(Main.originalSize + "Bytes");
+            Main.compressedSizeValue.setText("NotYetCalculated");
         }
     }
 
@@ -64,26 +65,26 @@ private static JMenu createHelpMenu() {
     }
 
     private static void showHowToDialog() {
-        String message = "Two algorithms are used for file compression\n" +
-                "1. Huffmans Codes\n" +
-                "2. Lampel-Ziv-Welch\n" +
-                "To compress a file first open the file then click\n" +
-                "ZIP HuffZ to zip the file using Huffmans algo.A zipped\n" +
-                "file with extension .huffz will be created in the same\n" +
-                "folder. This is the zipped file. During unzipping just open\n" +
+        String message = "Two algorithms are used for file compression:\n" +
+                "1. Huffman Coding\n" +
+                "2. Lempel-Ziv-Welch (LZW)\n" +
+                "To compress a file, first open the file then click\n" +
+                "ZIP HuffZ to zip the file using Huffman's algorithm. A compressed\n" +
+                "file with extension " + Constants.HUFFMAN_FILE_EXTENSION + " will be created in the same\n" +
+                "folder. This is the compressed file. To decompress, just open\n" +
                 "this file and click UNZIP HuffZ button.\n\n" +
-                "Same will happen for LZW. Zipped file's extension will be .LmZWp\n" +
-                "for LZW. Always make sure that during unzipping you must use\n" +
-                "the same algorithm that you used for zipping ";
+                "The same process applies for LZW. Compressed file's extension will be " + Constants.LZW_FILE_EXTENSION + "\n" +
+                "for LZW. Always make sure that during decompression you must use\n" +
+                "the same algorithm that you used for compression.";
         JOptionPane.showMessageDialog(null, message, "How To...", JOptionPane.PLAIN_MESSAGE);
     }
 
     private static void showAboutDialog() {
-        String message = "File Compresser is a software to zip and unzip files\n" +
-                "It is developed on JAVA, as a term project of\n" +
-                " Level - 2, Term - 1,Dept. of CSE,BUET.\n" +
-                "It is completed by Nahiyan Kamal (St. ID 0805006) under\n" +
-                "the supervision of Jesun Shahariar of Dept. of CSE, BUET.";
+        String message = "File Compressor is a software to compress and decompress files.\n" +
+                "It is developed in Java as a term project for\n" +
+                "Level 2, Term 1, Department of CSE, BUET.\n" +
+                "Developed by Nahiyan Kamal (Student ID: 0805006) under\n" +
+                "the supervision of Jesun Shahariar, Department of CSE, BUET.";
         JOptionPane.showMessageDialog(null, message, "About", JOptionPane.PLAIN_MESSAGE);
     }