feat: adds Tyran's prime_java and prime_python with a README.md (#137)

Author: RiceViz

lesson_04/tyranricejr/README.md

@@ -0,0 +1,79 @@
+# IsPrimeNumber Functionality Between Python & Java
+
+This markdown file compares the implementation of a function that checks if a number is prime in both Python and Java. It includes code snippets for each language, test cases to verify correctness, and an explanation of the logic used. The document also highlights key differences between the two languages in terms of syntax, type handling, and function usage.
+
+## Python Implementation
+
+### IsPrimeNumber.py Snippet
+```python
+    def IsAPrimeNumber(num):
+        if num <= 1:
+            return False
+        for i in range(2, int(num**0.5) + 1):
+            if num % i == 0:
+                return False
+        return True
+```
+
+### IsPrimeNumberTest.py Snippet
+```python
+    def IsAPrimeNumberTest(num):
+        self.assertTrue(IsAPrimeNumber.IsAPrimeNumber(11))
+        self.assertFalse(IsAPrimeNumber.IsAPrimeNumber(9))
+        self.assertFalse(IsAPrimeNumber.IsAPrimeNumber(0))
+```    
+
+## JavaScript Implementation
+
+### IsPrimeNumber.java
+```java
+    public boolean isPrime(int number) {
+        if (number <= 1) {
+            return false;
+        }
+        for (int i = 2; i <= Math.sqrt(number); i++) {
+            if (number % i == 0) {
+                return false;
+            }
+        }
+        return true;
+    }
+```
+
+### IsPrimeNumberTest.java
+```java
+    @BeforeEach
+    public void setUp() {
+        primeChecker = new IsAPrimeNumber();
+    }
+
+    public boolean isPrimeTest(int number) {
+        assertTrue(primeChecker.isPrime(11));
+        assertFalse(primeChecker.isPrime(9));
+        assertFalse(primeChecker.isPrime(-3));
+    }
+```
+
+## Explanation
+
+I define a function that determines whether a given integer is a prime number. The function returns `True` if the number is prime, and `False` otherwise. The logic checks if the number is less than or equal to 1 (not prime), then iterates from 2 up to the square root of the number to see if any divisor exists. If a divisor is found, the function returns false; otherwise, it returns true.
+
+Test cases are also provided in both languages to verify the correctness of the function, ensuring that known prime and non-prime numbers are handled as expected.
+
+The following sections provide code snippets and further explanation for each implementation.
+
+
+## Differences
+
+### 1. Syntax:  
+- Python uses indentation to define code blocks, while Java uses curly braces `{}`.
+- Python function definitions use `def`, whereas Java uses explicit type declarations (`public boolean`).
+- Python uses `True`/`False` (capitalized), Java uses `true`/`false` (lowercase).
+
+### 2. Type Coercion:  
+- Python is dynamically typed, so variable types are inferred at runtime.
+- Java is statically typed, requiring explicit type declarations for variables and function return types.
+
+### 3. Function Calls:  
+- In Python, functions can be called directly without creating an object if defined at the module level.
+- In Java, non-static methods require creating an instance of the class before calling the method (e.g., `primeChecker.isPrime(11)`).

lesson_04/tyranricejr/prime_java/.gitattributes

@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+

lesson_04/tyranricejr/prime_java/.gitignore

@@ -0,0 +1,5 @@
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+build

lesson_04/tyranricejr/prime_java/app/build.gradle.kts

@@ -0,0 +1,48 @@
+/*
+ * This file was generated by the Gradle 'init' task.
+ *
+ * This generated file contains a sample Java application project to get you started.
+ * For more details on building Java & JVM projects, please refer to https://docs.gradle.org/8.8/userguide/building_java_projects.html in the Gradle documentation.
+ */
+
+plugins {
+    // Apply the application plugin to add support for building a CLI application in Java.
+    application
+    java
+}
+
+repositories {
+    // Use Maven Central for resolving dependencies.
+    mavenCentral()
+}
+
+dependencies {
+    // Use JUnit Jupiter for testing.
+    testImplementation("org.junit.jupiter:junit-jupiter:5.10.2")
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher:1.10.2")
+
+    // This dependency is used by the application.
+    implementation("com.google.guava:guava:33.2.0-jre")
+
+    implementation("org.apache.commons:commons-text:1.10.0")
+}
+
+// Apply a specific Java toolchain to ease working on different environments.
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(21)
+    }
+}
+
+application {
+    // Define the main class for the application.
+    mainClass.set("prime_java.IsAPrimeNumber")
+}
+
+tasks.named<Test>("test") {
+    // Use JUnit Platform for unit tests.
+    useJUnitPlatform()
+    testLogging {
+        events("PASSED", "FAILED", "SKIPPED", "STANDARD_OUT", "STANDARD_ERROR")
+    }
+}

lesson_04/tyranricejr/prime_java/app/src/main/java/prime_java/IsAPrimeNumber.java

@@ -0,0 +1,42 @@
+/*
+ * This source file was generated by the Gradle 'init' task
+ */
+package prime_java;
+
+/*
+ * Title: IsAPrimeNumber.java
+ * 
+ * Description: This class contains a method to check if a number is prime.
+ * 
+ * Created by: Tyran Rice Jr.
+ * Date: 2023-10-01
+ */
+public class IsAPrimeNumber {
+
+    /*
+     * Title: isPrime
+     * 
+     * Description: This method checks if a given number is prime.
+     * 
+     * Parameters:
+     * - number: an integer to check for primality.
+     * 
+     * Returns:
+     * - true if the number is prime, false otherwise.
+     */
+    public boolean isPrime(int number) {
+        if (number <= 1) {
+            return false;
+        }
+        for (int i = 2; i <= Math.sqrt(number); i++) {
+            if (number % i == 0) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    public static void main(String[] args) {
+
+    }
+}

lesson_04/tyranricejr/prime_java/app/src/test/java/prime_java/IsAPrimeNumberTest.java

@@ -0,0 +1,73 @@
+/*
+ * This source file was generated by the Gradle 'init' task
+ */
+package prime_java;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/*
+ * Title: IsAPrimeNumberTest.java
+ * 
+ * Description: This class contains unit tests for the IsAPrimeNumber class.
+ * 
+ * Created by: Tyran Rice Jr.
+ * Date: 2023-10-01
+ */
+class IsAPrimeNumberTest {
+
+    IsAPrimeNumber primeChecker;
+
+    /*
+     * Title: setUp
+     * 
+     * Description: This method initializes the IsAPrimeNumber instance before each test.
+     * 
+     * Parameters: None
+     * 
+     * Returns: None
+     */
+    @BeforeEach
+    public void setUp() {
+        primeChecker = new IsAPrimeNumber();
+    }
+
+    /*
+     * Title: testIsPrime
+     * 
+     * Description: This method tests the isPrime method for prime numbers.
+     */
+    @Test
+    public void testIsPrime() {
+        assertTrue(primeChecker.isPrime(11));
+        assertTrue(primeChecker.isPrime(2));
+        assertTrue(primeChecker.isPrime(3));
+    }
+
+    /*
+     * Title: testIsNotPrime
+     * 
+     * Description: This method tests the isPrime method for non-prime numbers.
+     */
+    @Test
+    public void testIsNotPrime() {
+        assertFalse(primeChecker.isPrime(4));
+        assertFalse(primeChecker.isPrime(9));
+        assertFalse(primeChecker.isPrime(10));
+    }
+
+    /*
+     * Title: testEdgeCases
+     * 
+     * Description: This method tests the isPrime method for edge cases.
+     */
+    @Test 
+    public void testEdgeCases() {
+        assertFalse(primeChecker.isPrime(1));
+        assertFalse(primeChecker.isPrime(0));
+        assertFalse(primeChecker.isPrime(-3));
+    }
+}

lesson_04/tyranricejr/prime_java/gradle/libs.versions.toml

@@ -0,0 +1,10 @@
+# This file was generated by the Gradle 'init' task.
+# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format
+
+[versions]
+guava = "33.0.0-jre"
+junit-jupiter = "5.10.2"
+
+[libraries]
+guava = { module = "com.google.guava:guava", version.ref = "guava" }
+junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-jupiter" }

lesson_04/tyranricejr/prime_java/gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists