studium 0.18.7

data/lib/studium/java/studium/AskExamQuestion.java

@@ -0,0 +1,461 @@
+package studium;
+
+import java.io.*;
+import java.util.*;
+import java.util.concurrent.TimeUnit;
+/*
+ * Or more specific imports. This may have to be decided at
+ * a later time which variant to use.
+ */
+import java.io.File;
+import java.io.IOException;
+import java.util.Random;
+import java.nio.file.Files;
+
+import studium.Base;
+
+public class AskExamQuestion extends Base {
+
+  public static int n_exam_questions_in_total = 0;
+  public static int n_exam_answers_in_total   = 0;
+
+  public static String last_exam_question_answer_line_was = "";
+
+  /*
+   * SLEEP_FOR_N_SECONDS
+   */
+  private static final double SLEEP_FOR_N_SECONDS = 2.5;
+
+  /*
+   * use_this_exam_topic_file
+   */
+  public static String use_this_exam_topic_file;
+
+  /*
+   * LAST_EXAM_QUESTION_FILE
+   */
+  public static final String LAST_EXAM_QUESTION_FILE =
+    /*"/tmp/Studium/java/last_exam_question_file.md";*/
+    "/home/x/Temp/studium/java/last_exam_question_file.md";
+
+  public static final String COLOUR_RESET  = "\u001b[0m";
+
+  public static final String COLOUR_BLACK  = "\u001b[0;30m"; // BLACK
+  public static final String COLOUR_RED    = "\u001b[0;31m"; // RED
+  public static final String COLOUR_GREEN  = "\u001b[0;32m"; // GREEN
+  public static final String COLOUR_YELLOW = "\u001b[0;33m"; // YELLOW
+  public static final String COLOUR_BLUE   = "\u001b[0;34m"; // BLUE
+  public static final String COLOUR_PURPLE = "\u001b[0;35m"; // PURPLE
+  public static final String COLOUR_CYAN   = "\u001b[0;36m"; // CYAN
+  public static final String COLOUR_WHITE  = "\u001b[0;37m"; // WHITE
+
+  /* Bold Colour variants */
+  public static final String COLOUR_BOLD_BLACK  = "\u001b[1;30m"; // BOLD BLACK
+  public static final String COLOUR_BOLD_RED    = "\u001b[1;31m"; // BOLD RED
+  public static final String COLOUR_BOLD_GREEN  = "\u001b[1;32m"; // BOLD GREEN
+  public static final String COLOUR_BOLD_YELLOW = "\u001b[1;33m"; // BOLD YELLOW
+  public static final String COLOUR_BOLD_BLUE   = "\u001b[1;34m"; // BOLD BLUE
+  public static final String COLOUR_BOLD_PURPLE = "\u001b[1;35m"; // BOLD PURPLE
+  public static final String COLOUR_BOLD_CYAN   = "\u001b[1;36m"; // BOLD CYAN
+  public static final String COLOUR_BOLD_WHITE  = "\u001b[1;37m"; // BOLD WHITE
+    
+  public static String[] commandline_arguments;
+
+  /*
+   * DIRECTORY_EXAM_TOPICS
+   */
+  public static String DIRECTORY_EXAM_TOPICS;
+
+  /*
+   * Main constructor (def initialize)
+   */
+  public AskExamQuestion() {
+     reset(); /* This must be called here, to initialize the primary variables. */
+     run();
+  }
+
+  /*
+   * remove_HTML_tags_from()
+   */
+  String remove_HTML_tags_from(String i) {
+    return i.replaceAll("\\<[^>]*>","");
+  }
+
+  /*
+   * sleep_for_n_seconds()
+   */
+  void sleep_for_n_seconds(long n_seconds) {
+    try
+    {
+      Thread.sleep(
+        (long) n_seconds * 1000
+      ); /* Sleep here. */
+    }
+    catch(InterruptedException ex)
+    {
+      Thread.currentThread().interrupt();
+    }
+  }
+
+  /*
+   * word_wrap()
+   *
+   * Note that the regex used here will NOT wrap after
+   * words, so it is not ideal.
+   */
+  String word_wrap(String i) {
+    return i.replaceAll(
+      "(?<=\\G.{80})",
+      "\n"
+    );
+  }
+
+  /*
+   * ask_delayed_question_then_reveal_the_answer()
+   */
+  void ask_delayed_question_then_reveal_the_answer(
+      String question,
+      String answer,
+      double n_seconds
+    )
+  {
+    if (!question.endsWith("?")) {
+      question = question + "?";
+    }
+
+    question = remove_HTML_tags_from(question);
+
+    if (question.length() > 80) {
+      question = word_wrap(question);
+    }
+
+    e(
+      COLOUR_GREEN+
+      question+
+      COLOUR_RESET
+    ); /* question tag */
+    sleep_for_n_seconds((long) n_seconds);
+
+    answer = remove_HTML_tags_from(answer);
+
+    if (answer.length() > 80) {
+      answer = word_wrap(answer);
+    }
+
+    show_this_answer(answer);
+  }
+
+  /*
+   * show_this_answer()
+   */
+  void show_this_answer(String i) { /* answer tag */
+
+    if (i.contains("URL: ")) {
+      i = i.replaceAll("URL: ", ""); /* Remove this substring in that event. */
+    }
+
+    e(
+      "\n"+
+      COLOUR_BOLD_BLACK+
+      "  "+
+      i+
+      COLOUR_RESET+
+      "\n"
+    ); 
+  }
+
+  /*
+   *
+   */
+  void reset() {
+en("WIR SIND NUN IN RESET");
+   /*
+    * Specify our base-directory. This is presently hardcoded;
+    * at a later time we may modify this assumption.
+    */
+    if ( new File(Constants.ruby_studium()).isDirectory() ) {
+      DIRECTORY_EXAM_TOPICS = Constants.ruby_studium()+"/exam_topics/";
+    }
+    else { /* else hardcoded it */
+      DIRECTORY_EXAM_TOPICS = "/home/x/programming/ruby/src/studium/lib/studium/exam_topics/";
+    }
+    /*
+     * Next we can show some debug information:
+     */
+     /*
+     en(
+       COLOUR_RED+"DEBUG INFORMATION: The directory path is at: "+
+       DIRECTORY_EXAM_TOPICS
+     ); 
+     en(COLOUR_RED+"DEbug: RUBY_STUDIUM was set to "+Constants.ruby_studium());
+     */
+  }
+
+  /*
+   * return_a_random_exam_file()
+   *
+   * This method will return a random exam file.
+   */
+  String return_a_random_exam_file() {
+    File this_directory = new File(DIRECTORY_EXAM_TOPICS);
+    String[] files = this_directory.list();
+    int random_index = new Random().nextInt(files.length);
+
+    String target_file = DIRECTORY_EXAM_TOPICS+files[random_index];
+
+    File x = new File(target_file);
+    if (x.isFile()) {
+en("DEBUG INFO: Yes this is a file -> "+target_file);
+    }
+
+    return target_file;
+  }
+
+  /*
+   * menu()                                                          (menu tag)
+   */
+  void menu() {
+e("NUN SIND WIR IN MENU()");
+pp(commandline_arguments);
+    if (commandline_arguments.length > 0) {
+      for (String string : commandline_arguments) {
+        /* --help */
+        if ("--help".equals(string)) {
+          show_help();
+          exit_the_program();
+        }
+        else {
+          /* check whether the target file exists */
+          String target = DIRECTORY_EXAM_TOPICS+string;
+
+          File x = new File(target);
+          if (x.isFile()) {
+            /*en("YES "+target+" exists!");*/
+            use_this_exam_topic_file = target;
+          }
+        }
+      }
+    }
+    else {
+      /*
+      * Pick a random file next.
+      */
+      use_this_exam_topic_file = return_a_random_exam_file();
+    }
+  }
+
+  void exit_the_program() {
+    System.exit(0);
+  }
+
+  /*
+   * n()
+   */
+  void n() {
+    en("");
+  }
+  /*
+   * show_help()
+   */
+  void show_help() {
+    en("The following help options are available:");
+    n();
+    e("  Bla Bla abla.");
+    n();
+  }
+
+  /*
+   * ask_the_question_then_show_the_answer_from()
+   */
+  void ask_the_question_then_show_the_answer_from(String result) {
+    store_the_last_question_asked(result);
+    /*
+     * This has a question/answer part, so determine the two components next.
+     */
+    if(result.contains("? A:")) {
+      /* The return type of split() function is type of array. */
+      String[] splitted = result.split("\\? A:");
+      String question = String.join(" ", splitted[0]);
+      String answer   = String.join(" ", splitted[1]);
+      
+      ask_delayed_question_then_reveal_the_answer(question, answer, SLEEP_FOR_N_SECONDS);
+
+    }
+    else if (result.contains(" ? ")) {
+      String[] splitted = result.split(" ? ");
+      String question = String.join(" ", splitted[0]);
+      String answer   = String.join(" ", splitted[1]);
+      ask_delayed_question_then_reveal_the_answer(question, answer, SLEEP_FOR_N_SECONDS);
+    }
+    else if (result.contains("? ")) {
+      String[] splitted = result.split("\\? ");
+      String question = String.join(" ", splitted[0]);
+      String answer   = String.join(" ", splitted[1]);
+      ask_delayed_question_then_reveal_the_answer(question, answer, SLEEP_FOR_N_SECONDS);
+    }
+    else if (result.contains(". A: ")) {
+      String[] splitted = result.split(". A: ");
+      String question = String.join(" ", splitted[0]);
+      String answer   = String.join(" ", splitted[1]);
+
+      ask_delayed_question_then_reveal_the_answer(question, answer, SLEEP_FOR_N_SECONDS);
+
+    }
+    else {
+      e(result);
+    }
+    
+  }
+
+  /*
+   * report_how_many_exam_questions_were_found()
+   */
+  void report_how_many_exam_questions_were_found() {
+    en(
+      "n exam questions: "+
+      String.valueOf(n_exam_questions_in_total)
+    );
+  }
+
+  /*
+   * report_how_many_exam_answers_were_found()
+   */
+  void report_how_many_exam_answers_were_found() {
+    String n = String.valueOf(n_exam_answers_in_total);
+    en(
+      "n exam answers:   "+n+
+      "\n"
+    );
+  }
+ 
+
+  /*
+   * store_the_last_question_asked()                                (store tag)
+   */
+  void store_the_last_question_asked(String result) {
+
+    try {
+      File this_file = new File(LAST_EXAM_QUESTION_FILE);
+    
+      if (this_file.isFile()) {
+        new File(LAST_EXAM_QUESTION_FILE).delete();
+      }
+      if (this_file.createNewFile()) { /* create the file in this clause here */
+        /*en("Store into "+this_file.getName());*/
+        Files.writeString(this_file.toPath(), result);
+      } else {
+        en("In line 351: File already exists.");
+      }
+    }
+    catch (IOException error) {
+      en("An error occurred.");
+      error.printStackTrace();
+    }
+
+  }
+
+  /*
+   * report_the_exam_question_file_that_will_be_used()
+   */
+  void report_the_exam_question_file_that_will_be_used() {
+    e(
+      "Picking a question from "+
+      COLOUR_BOLD_BLUE+
+      "the following file:\n\n  "+
+      COLOUR_RESET+
+      use_this_exam_topic_file
+    );
+    e();
+  }
+
+  /*
+   * store_the_last_exam_question_file_used()
+   */
+  void store_the_last_exam_question_file_used() {
+    
+    try {
+      File this_file = new File(LAST_EXAM_QUESTION_FILE);
+      en("Trying to create a file at "+LAST_EXAM_QUESTION_FILE+" next:");
+      if (this_file.isFile()) {
+        en("Deleting the file "+use_this_exam_topic_file+" next.");
+        en("(This has been disabled for now, though.)");
+        /*new File(use_this_exam_topic_file).delete();*/
+      }
+      if (this_file.createNewFile()) { /* create the file in this clause here */
+        Files.writeString(this_file.toPath(), use_this_exam_topic_file);
+      } else {
+        en("In line 405: The file at "+this_file.getPath()+" already exists.");
+      }
+    }
+    catch (IOException error) {
+      en("An error occurred.");
+      error.printStackTrace();
+    }
+
+  }
+
+  /*
+   * run()                                                            (run tag)
+   */
+  void run() {
+    menu();
+    store_the_last_exam_question_file_used();
+    liner();
+    report_the_exam_question_file_that_will_be_used();
+    liner();
+
+    /*
+     * Ok - at this point target_file contains the path to our
+     * desired file.
+     */
+    File f = new File(use_this_exam_topic_file);
+    String result = null;
+    Random rand = new Random(); /* This will provide the randomness part. */
+
+    n_exam_questions_in_total = 0;
+    n_exam_answers_in_total   = 0;
+    int n = 0;
+
+    try
+    {
+      Scanner sc = new Scanner(f);
+      while (sc.hasNext()) {
+        String line = sc.nextLine();
+        if (line.startsWith("#")) { /* ignore comments */
+        }
+        else if (line.trim().isEmpty()) {
+          /* ignore empty lines as well */
+        }
+        else if (line.trim().endsWith(" []")) {
+          /* ignore lines that end with [] as well */
+          n_exam_answers_in_total += 1;
+        }
+        else {
+          n += 1;
+          n_exam_questions_in_total += 1;
+          if (rand.nextInt(n) == 0) {
+            result = line;
+          }
+        }
+      }
+      sc.close(); /* Don't forget to close the scanner again. */
+      last_exam_question_answer_line_was = result;
+      report_how_many_exam_questions_were_found();
+      report_how_many_exam_answers_were_found();
+      ask_the_question_then_show_the_answer_from(result);
+    }
+    catch (FileNotFoundException exception) {
+      en("File error: " + exception.getMessage());
+    }
+
+  }
+
+  /*
+   * main()
+   */
+  public static void main(String[] args) throws IOException {
+    commandline_arguments = args;
+    AskExamQuestion x = new AskExamQuestion();
+  }
+
+}

data/lib/studium/java/studium/Base.java

@@ -0,0 +1,123 @@
+package studium;
+
+import java.util.Arrays;
+import java.io.File;
+import java.nio.file.Files;
+
+import studium.Constants;
+
+public class Base {
+
+  /*
+   * === pp()
+   *
+   * This variant handles double 2D-Arrays as its input.
+   */
+  void pp(double[][] array) {
+    System.out.println(
+      Arrays.deepToString(array)
+    );
+  };
+  void pp(String[] array) {
+    System.out.println(
+      Arrays.toString(array)
+    );
+  };
+
+  /*
+   * === pp()
+   *
+   * Variant for file-arrays.
+   */
+  void pp(File[] array) {
+    System.out.println(
+      Arrays.toString(array)
+    );
+  }
+
+  /*
+   * === pp()
+   */
+  void pp(double[] array) {
+    System.out.println(
+      Arrays.toString(array)
+    );
+  };
+
+  /*
+   * === pp()
+   */
+  void pp(int[] array) {
+    System.out.println(
+      Arrays.toString(array)
+    );
+  };
+  void pp(int[][] array) {
+    System.out.println(
+      Arrays.deepToString(array)
+    );
+  };
+
+  /*
+   * Main constructor (def initialize)
+   *
+   * Deliberately do not call any methods here.
+   */
+  public Base() {
+    /* run(); */
+  }
+
+  /*
+   * run()                                               (run tag)
+   */
+  void run() {
+    /* add content here */
+  }
+  /*
+   * liner()
+   */
+  void liner() {
+    en("――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――");
+  }
+
+  /*
+   * return_exam_topics_files()
+   */
+  public File[] return_exam_topics_files() {
+    String directory_to_the_exam_topics =
+      "/home/x/programming/ruby/src/studium/lib/studium/exam_topics/";
+    
+    File[] array = new File(directory_to_the_exam_topics).listFiles();
+    return array;
+  }
+
+  /*
+   * e()
+   */
+  public static void e() {
+    System.out.println("");
+  }
+
+  /*
+   * (e tag)
+   */
+  public static void e(String i) {
+    System.out.println(i);
+  }
+
+  public static void e(int i) {
+    System.out.println(i);
+  }
+
+  public static void en(String i) {
+    System.out.println(i);
+  }
+
+  /*
+   * main()
+   */
+  /*public static void main(String[] args) {
+    Base x = new Base();
+  }*/
+
+}

data/lib/studium/java/studium/Constants.java

@@ -0,0 +1,122 @@
+package studium;
+
+import java.util.Arrays;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+public class Constants {
+
+  /*
+   * RUBY_STUDIUM
+   */
+  public static String RUBY_STUDIUM = System.getenv("RUBY_STUDIUM");
+
+  /*
+   * Constants.ruby_studium()
+   */
+  public static String ruby_studium() {
+    return RUBY_STUDIUM;
+  }
+  /*
+   * === USERS_X
+   */
+  private static final String USERS_X = "/home/x/";
+
+  /*
+   * === FILE_DAILY_QUESTIONS_SOLVED
+   */
+  private static final String FILE_DAILY_QUESTIONS_SOLVED =
+    "/home/x/programming/ruby/src/studium/lib/studium/yaml/daily_questions_solved/daily_questions_solved.yml";
+
+  /*
+   * file_daily_questions_solved()
+   */
+  public static String file_daily_questions_solved() {
+    return FILE_DAILY_QUESTIONS_SOLVED;
+  }
+
+  /*
+   * === LOG_DIRECTORY
+   */
+  public static final String LOG_DIRECTORY = USERS_X+"Temp/studium/";
+
+  /*
+   * log_directory()
+   *
+   * This method will return a String such as "/home/x/Temp/studium/".
+   *
+   * Usage example:
+   *
+   *   System.out.println(Constants.log_directory());
+   *
+   */
+  public static final String log_directory() {
+    return LOG_DIRECTORY;
+  }
+  /*
+   * === N
+   */
+  private static final String N = "\n";
+
+  /*
+   * === T
+   */
+  private static final String T = "\t";
+
+  /*
+   * === THRESHOLD_VALUE_N_EXAMS_AT_MAXIMUM
+   *
+   * See the ruby file constants.rb for a description of this
+   * variable.
+   */
+  private static final int THRESHOLD_VALUE_N_EXAMS_AT_MAXIMUM = 1000;
+
+  void pp(double[][] array) {
+    System.out.println(
+      Arrays.deepToString(array)
+    );
+  };
+  void pp(double[] array) {
+    System.out.println(
+      Arrays.toString(array)
+    );
+  };
+  void pp(int[] array) {
+    System.out.println(
+      Arrays.toString(array)
+    );
+  };
+  void pp(int[][] array) {
+    System.out.println(
+      Arrays.deepToString(array)
+    );
+  };
+
+  /*
+   * Main constructor (def initialize)
+   */
+  public Constants() {
+    run();
+  }
+
+  /*
+   * run()                                               (run tag)
+   */
+  void run() {
+    en(USERS_X);
+    System.out.println(THRESHOLD_VALUE_N_EXAMS_AT_MAXIMUM);
+  }
+
+  public static void e(String i) {
+    System.out.print(i);
+  }
+
+  public static void en(String i) {
+    System.out.println(i);
+  }
+
+  public static void main(String[] args) {
+    var x = new Constants();
+  }
+
+}