feat: adds lesson_28 content (#616)

Signed-off-by: Anthony D. Mays <[email protected]>

Author: anthonydmays

lesson_28/createdb/createdb.py

@@ -0,0 +1,23 @@
+import os
+import pandas as pd
+import numpy as np
+import sqlite3
+
+# Step 1: Load the CSV file into a pandas DataFrame
+media_items_df = pd.read_csv('/workspaces/code-differently-24-q1/lesson_12/io/io_app/src/main/resources/csv/media_items.csv')
+guests_df = pd.read_csv('/workspaces/code-differently-24-q1/lesson_12/io/io_app/src/main/resources/csv/guests.csv')
+checked_out_items_df = pd.read_csv('/workspaces/code-differently-24-q1/lesson_12/io/io_app/src/main/resources/csv/checked_out_items.csv')
+checked_out_items_df['due_date'] = pd.to_datetime(checked_out_items_df['due_date']).values.astype(np.int64)
+
+# Step 2: Create a connection to the SQLite database
+# Note: This will create the database file if it doesn't exist already
+os.makedirs('/workspaces/code-differently-24-q1/lesson_28/db/db_app/src/main/resources/sqlite/', exist_ok=True)
+conn = sqlite3.connect('../db/db_app/src/main/resources/sqlite/data.db')
+
+# Step 3: Write the DataFrame to the SQLite database
+media_items_df.to_sql('media_items', conn, if_exists='replace', index=False)
+guests_df.to_sql('guests', conn, if_exists='replace', index=False)
+checked_out_items_df.to_sql('checked_out_items', conn, if_exists='replace', index=False)
+
+# Don't forget to close the connection
+conn.close()

lesson_28/createdb/requirements.txt

@@ -0,0 +1 @@
+pandas

lesson_28/db/.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_28/db/.gitignore

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

lesson_28/db/db_app/build.gradle.kts

@@ -0,0 +1,76 @@
+plugins {
+    // Apply the application plugin to add support for building a CLI application in Java.
+    application
+    eclipse
+    id("com.diffplug.spotless") version "6.25.0"
+	  id("org.springframework.boot") version "3.4.0"
+    id("com.adarshr.test-logger") version "4.0.0"
+    id("io.freefair.lombok") version "8.6"
+}
+
+apply(plugin = "io.spring.dependency-management")
+
+repositories {
+    // Use Maven Central for resolving dependencies.
+    mavenCentral()
+}
+
+dependencies {
+    // Use JUnit Jupiter for testing.
+    testImplementation("com.codedifferently.instructional:instructional-lib")
+    testImplementation("org.junit.jupiter:junit-jupiter:5.11.3")
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("org.assertj:assertj-core:3.26.3")
+    testImplementation("at.favre.lib:bcrypt:0.10.2")
+
+    // This dependency is used by the application.
+    implementation("com.codedifferently.instructional:instructional-lib")
+    implementation("com.google.guava:guava:33.3.1-jre")
+    implementation("com.google.code.gson:gson:2.11.0")
+    implementation("commons-cli:commons-cli:1.6.0")
+    implementation("org.springframework.boot:spring-boot-starter")
+    implementation("org.springframework.boot:spring-boot-starter-data-jpa")
+    implementation("com.fasterxml.jackson.core:jackson-databind:2.13.0")
+    implementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.12.3")
+    implementation("com.opencsv:opencsv:5.9")
+    implementation("org.apache.commons:commons-csv:1.10.0")
+    implementation("org.xerial:sqlite-jdbc:3.36.0")
+    implementation("org.hibernate.orm:hibernate-community-dialects:6.2.7.Final") 
+}
+
+application {
+    // Define the main class for the application.
+    mainClass.set("com.codedifferently.lesson28.Lesson28")
+}
+
+tasks.named<JavaExec>("run") {
+    standardInput = System.`in`
+}
+
+tasks.named<Test>("test") {
+    // Use JUnit Platform for unit tests.
+    useJUnitPlatform()
+}
+
+
+configure<com.diffplug.gradle.spotless.SpotlessExtension> {
+
+  format("misc", {
+    // define the files to apply `misc` to
+    target("*.gradle", ".gitattributes", ".gitignore")
+
+    // define the steps to apply to those files
+    trimTrailingWhitespace()
+    indentWithTabs() // or spaces. Takes an integer argument if you don't like 4
+    endWithNewline()
+  })
+
+  java {
+    // don't need to set target, it is inferred from java
+
+    // apply a specific flavor of google-java-format
+    googleJavaFormat()
+    // fix formatting of type annotations
+    formatAnnotations()
+  }
+}

lesson_28/db/db_app/lombok.config

@@ -0,0 +1,2 @@
+# This file is generated by the 'io.freefair.lombok' Gradle plugin
+config.stopBubbling = true

lesson_28/db/db_app/src/main/java/com/codedifferently/lesson28/Lesson28.java

@@ -0,0 +1,38 @@
+package com.codedifferently.lesson28;
+
+import com.codedifferently.lesson28.cli.LibraryApp;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.CommandLineRunner;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@SpringBootApplication(scanBasePackages = "com.codedifferently")
+public class Lesson28 implements CommandLineRunner {
+  @Autowired private LibraryApp libraryApp;
+
+  public static void main(String[] args) {
+    var application = new SpringApplication(Lesson28.class);
+    application.run(args);
+  }
+
+  @Override
+  public void run(String... args) throws Exception {
+    // Don't run as an app if we're running as a JUnit test.
+    if (isJUnitTest()) {
+      return;
+    }
+
+    libraryApp.run(args);
+  }
+
+  private static boolean isJUnitTest() {
+    for (StackTraceElement element : Thread.currentThread().getStackTrace()) {
+      if (element.getClassName().startsWith("org.junit.")) {
+        return true;
+      }
+    }
+    return false;
+  }
+}

lesson_28/db/db_app/src/main/java/com/codedifferently/lesson28/cli/LibraryApp.java

@@ -0,0 +1,195 @@
+package com.codedifferently.lesson28.cli;
+
+import com.codedifferently.lesson28.factory.LibraryDataLoader;
+import com.codedifferently.lesson28.factory.LibraryDbDataLoader;
+import com.codedifferently.lesson28.factory.LibraryFactory;
+import com.codedifferently.lesson28.library.Book;
+import com.codedifferently.lesson28.library.Library;
+import com.codedifferently.lesson28.library.LibraryInfo;
+import com.codedifferently.lesson28.library.MediaItem;
+import com.codedifferently.lesson28.library.search.SearchCriteria;
+import java.util.Map;
+import java.util.Scanner;
+import java.util.Set;
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.HelpFormatter;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.apache.commons.cli.ParseException;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+@Service
+public final class LibraryApp {
+  @Autowired private LibraryDbDataLoader defaultLibraryDataLoader;
+
+  public void run(String[] args) throws Exception {
+    // Load the library using the specified loader from the command line or the default.
+    LibraryDataLoader loader = getLoaderOrDefault(args, defaultLibraryDataLoader);
+    Library library = LibraryFactory.createWithLoader(loader);
+
+    // Show stats about the loaded library to the user.
+    printLibraryInfo(library);
+
+    try (var scanner = new Scanner(System.in)) {
+      LibraryCommand command;
+      // Main application loop.
+      while ((command = promptForCommand(scanner)) != LibraryCommand.EXIT) {
+        switch (command) {
+          case SEARCH -> doSearch(scanner, library);
+          default -> System.out.println("\nNot ready yet, coming soon!");
+        }
+      }
+    }
+  }
+
+  private void printLibraryInfo(Library library) {
+    LibraryInfo info = library.getInfo();
+    Map<String, Set<MediaItem>> checkedOutItemsByGuest = info.getCheckedOutItemsByGuest();
+    int numCheckedOutItems = checkedOutItemsByGuest.values().stream().mapToInt(Set::size).sum();
+    System.out.println();
+    System.out.println("========================================");
+    System.out.println("Library id: " + library.getId());
+    System.out.println("Number of items: " + info.getItems().size());
+    System.out.println("Number of guests: " + info.getGuests().size());
+    System.out.println("Number of checked out items: " + numCheckedOutItems);
+    System.out.println("========================================");
+    System.out.println();
+  }
+
+  private static LibraryDataLoader getLoaderOrDefault(
+      String[] args, LibraryDataLoader defaultLoader) throws Exception {
+    String loaderType = getLoaderFromCommandLine(args);
+    return loaderType == null
+        ? defaultLoader
+        : Class.forName(loaderType)
+            .asSubclass(LibraryDataLoader.class)
+            .getDeclaredConstructor()
+            .newInstance();
+  }
+
+  private static String getLoaderFromCommandLine(String[] args) throws IllegalArgumentException {
+    Options options = new Options();
+    Option input = new Option("l", "loader", true, "data loader type");
+    input.setRequired(false);
+    options.addOption(input);
+    CommandLineParser parser = new DefaultParser();
+    HelpFormatter formatter = new HelpFormatter();
+    try {
+      CommandLine cmd = parser.parse(options, args);
+      return cmd.getOptionValue("loader");
+    } catch (ParseException e) {
+      System.out.println();
+      System.out.println(e.getMessage());
+      formatter.printHelp("utility-name", options);
+
+      System.exit(1);
+    }
+    return null;
+  }
+
+  private static LibraryCommand promptForCommand(Scanner scanner) {
+    var command = LibraryCommand.UNKNOWN;
+    while (command == LibraryCommand.UNKNOWN) {
+      printMenu();
+      var input = scanner.nextLine();
+      try {
+        command = LibraryCommand.fromValue(Integer.parseInt(input.trim()));
+      } catch (IllegalArgumentException e) {
+        System.out.println("Invalid command: " + input);
+      }
+    }
+    return command;
+  }
+
+  private static void printMenu() {
+    System.out.println("\nEnter the number of the desired command:");
+    System.out.println("1) << EXIT");
+    System.out.println("2) SEARCH");
+    System.out.println("3) CHECKOUT");
+    System.out.println("4) RETURN");
+    System.out.print("command> ");
+  }
+
+  private void doSearch(Scanner scanner, Library library) {
+    LibrarySearchCommand command = promptForSearchCommand(scanner);
+    if (command == LibrarySearchCommand.RETURN) {
+      return;
+    }
+    SearchCriteria criteria = getSearchCriteria(scanner, command);
+    Set<MediaItem> results = library.search(criteria);
+    printSearchResults(results);
+  }
+
+  private LibrarySearchCommand promptForSearchCommand(Scanner scanner) {
+    var command = LibrarySearchCommand.UNKNOWN;
+    while (command == LibrarySearchCommand.UNKNOWN) {
+      printSearchMenu();
+      var input = scanner.nextLine();
+      try {
+        command = LibrarySearchCommand.fromValue(Integer.parseInt(input.trim()));
+      } catch (IllegalArgumentException e) {
+        System.out.println("Invalid command: " + input);
+      }
+    }
+    return command;
+  }
+
+  private void printSearchMenu() {
+    System.out.println("\nEnter the number of the desired search criteria:");
+    System.out.println("1) << RETURN");
+    System.out.println("2) TITLE");
+    System.out.println("3) AUTHOR");
+    System.out.println("4) TYPE");
+    System.out.print("search> ");
+  }
+
+  private SearchCriteria getSearchCriteria(Scanner scanner, LibrarySearchCommand command) {
+    System.out.println();
+    switch (command) {
+      case TITLE -> {
+        System.out.println("Enter the title to search for: ");
+        System.out.print("title> ");
+        var title = scanner.nextLine();
+        return SearchCriteria.builder().title(title).build();
+      }
+      case AUTHOR -> {
+        System.out.println("Enter the author to search for: ");
+        System.out.print("author> ");
+        var author = scanner.nextLine();
+        return SearchCriteria.builder().author(author).build();
+      }
+      case TYPE -> {
+        System.out.println("Enter the type to search for: ");
+        System.out.print("type> ");
+        var type = scanner.nextLine();
+        return SearchCriteria.builder().type(type).build();
+      }
+      default -> System.out.println("Invalid search command: " + command);
+    }
+    return null;
+  }
+
+  private void printSearchResults(Set<MediaItem> results) {
+    System.out.println();
+
+    if (results.isEmpty()) {
+      System.out.println("No results found.");
+      return;
+    }
+
+    System.out.println("Search results:\n");
+    for (MediaItem item : results) {
+      System.out.println("ID: " + item.getId());
+      System.out.println("TITLE: " + item.getTitle());
+      if (item instanceof Book book) {
+        System.out.println("AUTHOR(S): " + String.join(", ", book.getAuthors()));
+      }
+      System.out.println("TYPE: " + item.getType().toUpperCase());
+      System.out.println();
+    }
+    System.out.println("Found " + results.size() + " result(s).\n");
+  }
+}

lesson_28/db/db_app/src/main/java/com/codedifferently/lesson28/cli/LibraryCommand.java

@@ -0,0 +1,28 @@
+package com.codedifferently.lesson28.cli;
+
+public enum LibraryCommand {
+  UNKNOWN(0),
+  EXIT(1),
+  SEARCH(2),
+  CHECKOUT(3),
+  RETURN(4);
+
+  private final int value;
+
+  LibraryCommand(int value) {
+    this.value = value;
+  }
+
+  public int getValue() {
+    return value;
+  }
+
+  public static LibraryCommand fromValue(int value) {
+    for (LibraryCommand command : LibraryCommand.values()) {
+      if (command.getValue() == value) {
+        return command;
+      }
+    }
+    return UNKNOWN;
+  }
+}