Merge pull request #5 from MartinFiorde/maf-practice

Practica finalizada

Author: MartinFiorde

jobs-search-reporter/src/main/java/com/platzi/jobsearch/CommanderFunctions.java

@@ -8,20 +8,6 @@
 import java.util.function.Supplier;
 
 public interface CommanderFunctions {
-    /**
-     * JCommander permite generar opciones de terminal de cualquier clase, por eso el primer parametro es
-     * de tipo Object.
-     *
-     * @param object Clase de la cual se generaran los argumentos de JCommander
-     * @return una instancia de JCommander. Idealmente con CLIArguments como objeto pasado.
-     */
-    static JCommander buildCommander(Object object) {
-        return JCommander
-                .newBuilder()
-                .addObject(object)
-                .build();
-    }
-
     /**
      * Con esta funcion, facilitamos crear una configuracion inicial de JCommander, pidiendo el nombre del
      * programa y un Supplier de tipo T para los argumentos. Asi podemos usar alguna funcion que nos devuelva
@@ -33,7 +19,11 @@ static JCommander buildCommander(Object object) {
      * @return una instancia de {@link JCommander} ya configurada con el nombre y los argumentos.
      */
     static <T> JCommander buildCommanderWithName(String name, Supplier<T> argumentsSupplier) {
-        JCommander jCommander = buildCommander(argumentsSupplier.get());
+        // JCommander permite generar opciones de terminal de cualquier clase, por eso se le agrega un object con el metodo addObject(...)
+        // argumentsSupplier.get() es la clase de la cual se generaran los argumentos de JCommander
+        // Queda definida una instancia de JCommander. Idealmente con CLIArguments como objeto pasado.
+        JCommander jCommander = JCommander.newBuilder().addObject(argumentsSupplier.get()).build();
+
         jCommander.setProgramName(name);
         return jCommander;
     }
@@ -45,18 +35,14 @@ static <T> JCommander buildCommanderWithName(String name, Supplier<T> argumentsS
     static Optional<List<Object>> parseArguments(
             JCommander jCommander,
             String[] arguments,
-            OnCommandError onCommandError
-    ) {
-        List<Object> result;
+            OnCommandError onCommandError) { // en caso que las validaciones de CLIKeywordValidaror o CLIHelpValidator fallen, se generará un ParameterException
         try {
             jCommander.parse(arguments);
-
             return Optional.of(jCommander.getObjects());
-        } catch (ParameterException exception) {
+        } catch (ParameterException exception) { // atrapará el parameter exception y devuelve un optional vacio
             onCommandError.onError(jCommander);
+            return Optional.empty();
         }
-
-        return Optional.empty();
     }
 
     @FunctionalInterface

jobs-search-reporter/src/main/java/com/platzi/jobsearch/JobSearch.java

@@ -21,31 +21,22 @@ public static void main(String[] args) {
         JCommander jCommander = buildCommanderWithName("job-search", CLIArguments::newInstance);
 
         //Obtenemos las opciones que se le dieron a JCommander
-        Stream<CLIArguments> streamOfCLI =
-                //Nos retorna un Optional<List<Object>>
-                parseArguments(jCommander, args, JCommander::usage)
-                        //En caso de un Optional.empty()
-                        .orElse(Collections.emptyList())
+        Stream<CLIArguments> streamOfCLI = parseArguments(jCommander, args, JCommander::usage) //Nos retorna un Optional<List<Object>>
+                        .orElse(Collections.emptyList()) //En caso de un Optional.empty()
                         .stream()
                         .map(CLIArguments.class::cast); // map(obj -> (CLIArguments) obj) give same result
 
         //Tomamos nuestro Stream y obtenemos las opciones que se dieron en el CLI
         Optional<CLIArguments> cliOptional = streamOfCLI
-                //Solo nos interesan los casos donde no sea la solicitud de ayuda
-                .filter(cli -> !cli.isHelp())
-                //Y que contengan un keyword, en otros caso no tenemos que buscar
-                .filter(cli -> cli.getKeyword() != null)
+                .filter(cli -> !cli.isHelp()) //Solo nos interesan los casos donde no sea la solicitud de ayuda
+                .filter(cli -> cli.getKeyword() != null) //Y que contengan un keyword, en otros caso no tenemos que buscar
                 .findFirst();
 
         //Si el Optional tiene un dato, lo convertimos a Map<String,Object>
         cliOptional.map(CLIFunctions::toMap)
-                //Convertimos el Map en un request
-                .map(JobSearch::executeRequest)
-                //Aun seguimos operando sobre un Optional… en caso de que no hubiera datos
-                //Generamos un stream vacio
-                .orElse(Stream.empty())
-                //Imprimos los datos por pantalla.
-                .forEach(System.out::println);
+                .map(JobSearch::executeRequest) //Convertimos el Map en un request
+                .orElse(Stream.empty()) //Aun seguimos operando sobre un Optional… en caso de que no hubiera datos generamos un stream vacio
+                .forEach(System.out::println); //Imprimos los datos por pantalla.
     }
 
     private static Stream<JobPosition> executeRequest(Map<String, Object> options) {

jobs-search-reporter/src/main/java/com/platzi/jobsearch/cli/CLIArguments.java

@@ -44,7 +44,7 @@ public final class CLIArguments {
     private boolean isMarkdown = false;
 
     @Parameter(
-            names = "--help",
+            names = {"--help", "-h"},
             help = true,
             validateWith = CLIHelpValidator.class,
             description = "Muestra esta ayuda")

jobs-search-reporter/src/main/java/com/platzi/jobsearch/cli/CLIKeywordValidator.java

@@ -11,7 +11,7 @@
 public class CLIKeywordValidator implements IParameterValidator {
     @Override
     public void validate(String name, String value) throws ParameterException {
-        if (!value.matches("^[a-zA-Z]+[0-9]*$")) {
+        if (!value.matches("^[a-zA-Z]+\\d*$")) {
             System.err.println("Keyword: " + value + " no es un Keyword valido, keywords deben ser alfanumericas.\n");
             throw new ParameterException("Only alphanumerics are supported");
         }

modules/src/main/java/com/platzi/functional_student_practice/_20_job_search_reporter/C30A40JobSearchReporter.java

@@ -0,0 +1,13 @@
+package com.platzi.functional_student_practice._20_job_search_reporter;
+
+public class C30A40JobSearchReporter {
+    /*
+        al 24 de julio de 2024, la API https://jobs.github.com/api se encuentra fuera de servicio, por lo que no se
+        puede realizar practica real sobre los conceptos desarrollados en clase. Las clases y los contenidos se siguen
+        de manera teórica de aquí en adelante, usando como referencia el código del directorio root/jobs-search-reporter
+        y los conceptos desarrollados en videos y recursos del curso https://platzi.com/cursos/java-funcional/
+
+        Link al repositorio de un compañero que aplica los conceptos sobre la API de rick y morty,
+        pero de forma más limitada: https://github.com/barreracarlosandres/CLIRickAndMorty
+     */
+}