CipherStream/CipherStreamJava
1
0
Fork 0
Code Issues 2 Packages Projects Releases 1 Wiki Activity

Caesar cipher is implemented

Browse Source
This commit is contained in:
Mattrixwv
2021-07-25 15:57:53 -04:00
parent aaa2031274
commit 4f8b440c59
4 changed files with 293 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
.gitignore vendored
View File

@@ -1,49 +1,8 @@
# These are some examples of commonly ignored file patterns. #Ignore all build files
# You should customize this list as applicable to your project.
# Learn more about .gitignore:
# https://www.atlassian.com/git/tutorials/saving-changes/gitignore
# Node artifact files
node_modules/
dist/
# Compiled Java class files
*.class
# Compiled Python bytecode
*.py[cod]
# Log files
*.log
# Package files
*.jar
# Maven
target/ target/
dist/
# JetBrains IDE #Ignore my vscode files
.idea/ .vscode/
.settings/
# Unit test reports .classpath
TEST*.xml .project
# Generated by MacOS
.DS_Store
# Generated by Windows
Thumbs.db
# Applications
*.app
*.exe
*.war
# Large media files
*.mp4
*.tiff
*.avi
*.flv
*.mov
*.wmv

93
pom.xml Normal file
View File

@@ -0,0 +1,93 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>mattrixwv</groupId>
<artifactId>CipherStreamJava</artifactId>
<version>1.0-SNAPSHOT</version>
<name>CipherStreamJava</name>
<url>http://www.mattrixwv.com</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>14</maven.compiler.source>
<maven.compiler.target>14</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<!--Ensure maven is the correct version-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>3.0.0-M3</version>
<executions>
<execution>
<id>enforce-maven</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<requireMavenVersion>
<version>3.6.3</version>
</requireMavenVersion>
</rules>
</configuration>
</execution>
</executions>
</plugin>
<!--Clean lifecycle, see https://maven.apache.org/ref/current/maven-core-lifecycles.html#clean_Lifecycle-->
<plugin>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
</plugin>
<!--Default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging-->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.2.0</version>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
</plugin>
<plugin>
<artifactId>maven-surefile-plugin</artifactId>
<version>3.0.0-M5</version>
</plugin>
<plugin>
<artifactId>maven-jar-plugin</artifactId>
<version>3.2.0</version>
</plugin>
<plugin>
<artifactId>maven-install-plugin</artifactId>
<version>3.0.0-M1</version>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<version>3.0.0-M1</version>
</plugin>
<!--Site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle-->
<plugin>
<artifactId>maven-site-plugin</artifactId>
<version>3.9.1</version>
</plugin>
<plugin>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.1.1</version>
</plugin>
</plugins>
</build>
</project>

121
src/main/java/mattrixwv/CipherStreamJava/Caesar.java Normal file
View File

@@ -0,0 +1,121 @@
//CipherStreamJava/src/main/java/mattrixwv/CipherStreamJava/Caesar.java
//Matthew Ellison
// Created: 07-25-21
//Modified: 07-25-21
//This is the declaration of the Caesar class
package mattrixwv.CipherStreamJava;
public class Caesar{
private String inputString; //The string that needs encoded/decoded
private String outputString; //The encoded/decoded string
public static final String version = "1.0"; //The current version number for the library
private int shift; //The amount that you need to shift each letter
//Sets shift and makes sure it is within the propper bounds
private void setShift(int shiftAmount){
//If you shift more than 26 you will just be wrapping back around again
shift = shiftAmount % 26;
}
//Sets the input string
private void setInputString(String inputString){
this.inputString = inputString;
}
//Encodes the inputString and stores the result in outputString
private String encode(){
for(int cnt = 0;cnt < inputString.length();++cnt){
char temp = inputString.charAt(cnt); //A temperary holder for the current working character
//If it is an upper case letter shift it and wrap if necessary
if(Character.isUpperCase(temp)){
temp += shift;
//Wrap around if the letter is now out of bounds
if(temp < 'A'){
temp += 26;
}
else if(temp > 'Z'){
temp -= 26;
}
}
//If it is a lower case letter shift it and wrap if necessary
else if(Character.isLowerCase(temp)){
temp += shift;
//Wrap around if the letter is now out of bounds
if(temp < 'a'){
temp += 26;
}
else if(temp > 'z'){
temp -= 26;
}
}
//If it is whitespace, number, or punctuation just let it pass through
//Add it to the output string
outputString += temp;
}
return outputString;
}
//Decodes the inputString and stores the result in outputString
private String decode(){
for(int cnt = 0;cnt < inputString.length();++cnt){
char temp = inputString.charAt(cnt); //A temperary holder for the current working character
//If it is an upper case letter shift it and wrap if necessary
if(Character.isUpperCase(temp)){
temp -= shift;
if(temp < 'A'){
temp += 26;
}
else if(temp > 'Z'){
temp -= 26;
}
}
//If it is a lower case letter shift it and wrap if necessary
else if(Character.isLowerCase(temp)){
temp -= shift;
if(temp < 'a'){
temp += 26;
}
else if(temp > 'z'){
temp -= 26;
}
}
//If it is whitespace, number, or punctuation just let it pass through
//Add it to the output string
outputString += temp;
}
return outputString;
}
//Constructor
public Caesar(){
reset();
}
//Returns the inputString
public String getInputString(){
return inputString;
}
//Returns shift
public int getShift(){
return shift;
}
//Returns the outputString
public String getOutputString(){
return outputString;
}
//Sets the shift and inputString and encodes the message
public String encode(int shiftAmount, String inputString){
reset();
setShift(shiftAmount);
setInputString(inputString);
return encode();
}
//Sets the shift and inputString and decodes the message
public String decode(int shiftAmount, String inputString){
reset();
setShift(shiftAmount);
setInputString(inputString);
return decode();
}
//Makes sure all of the variables are empty
public void reset(){
inputString = outputString = "";
shift = 0;
}
}

73
src/test/java/mattrixwv/CipherStreamJava/TestCaesar.java Normal file
View File

@@ -0,0 +1,73 @@
//CipherStreamJava/src/main/java/mattrixwv/CipherStreamJava/TestCaesar.java
//Matthew Ellison
// Created: 07-25-21
//Modified: 07-25-21
//These are the tests for the Caesar class
package mattrixwv.CipherStreamJava;
import static org.junit.Assert.assertEquals;
import org.junit.Test;
public class TestCaesar{
@Test
public void testDecode(){
//Test 1
Caesar cipher = new Caesar();
String input = "def";
int shift = 3;
String correctOutput = "abc";
String output = cipher.decode(shift, input);
assertEquals("Caesar Decoding failed the first test - Expected: " + correctOutput + "; actual: " + output, correctOutput, output);
//Test 2
input = "def";
shift = 29;
correctOutput = "abc";
output = cipher.decode(shift, input);
assertEquals("Caesar Decoding failed the second test - Expected: " + correctOutput + "; actual: " + output, correctOutput, output);
//Test 3
input = "Qeb nrfzh yoltk clu grjmp lsbo - qeb ixwv ald";
shift = -3;
correctOutput = "The quick brown fox jumps over - the lazy dog";
output = cipher.decode(shift, input);
assertEquals("Caesar Decoding failed the third test - Expected: " + correctOutput + "; actual: " + output, correctOutput, output);
//Test 4
input = "Qeb nrfzh yoltk clu grjmp lsbo - qeb ixwv ald";
shift = 23;
correctOutput = "The quick brown fox jumps over - the lazy dog";
output = cipher.decode(shift, input);
assertEquals("Caesar Decoding failed the fourth test - Expected: " + correctOutput + "; actual: " + output, correctOutput, output);
}
@Test
public void testEncode(){
//Test 1
Caesar cipher = new Caesar();
String input = "abc";
int shift = 3;
String correctOutput = "def";
String output = cipher.encode(shift, input);
assertEquals("Caesar Encoding failed the first test - Expected: " + correctOutput + "; actual: " + output, correctOutput, output);
//Test 2
input = "abc";
shift = 29;
correctOutput = "def";
output = cipher.encode(shift, input);
assertEquals("Caesar Encoding failed the second test - Expected: " + correctOutput + "; actual" + output, correctOutput, output);
//Test 3
input = "The quick brown fox jumps over - the lazy dog";
shift = -3;
correctOutput = "Qeb nrfzh yoltk clu grjmp lsbo - qeb ixwv ald";
output = cipher.encode(shift, input);
assertEquals("Caesar Encoding failed the third test - Expected: " + correctOutput + "; actual: " + output, correctOutput, output);
//Test 4
input = "The quick brown fox jumps over - the lazy dog";
shift = 23;
correctOutput = "Qeb nrfzh yoltk clu grjmp lsbo - qeb ixwv ald";
output = cipher.encode(shift, input);
assertEquals("Caesar Encoding failed the third test - Expected: " + correctOutput + "; actual: " + output, correctOutput, output);
}
}