Agrega interactividad a tu aplicación

En este capítulo, obtendrás práctica directa con la sintaxis de Dart. Aprenderás a leer la entrada del usuario, imprimir información de uso y crear una interacción básica de línea de comandos.

Antes de comenzar este capítulo, asegúrate de tener:

• Completado el Capítulo 1 y tener un entorno de desarrollo de Dart en funcionamiento.
• Familiaridad con conceptos básicos de programación (variables, tipos de datos, flujo de control).

Agrega alguna funcionalidad básica a tu aplicación de línea de comandos Dartpedia y luego explora la sintaxis de Dart para ella.

1. Implementa el comando version en cli/bin/cli.dart: Agrega lógica para manejar un comando version, el cual imprime la versión actual de la CLI. Usa una sentencia if para verificar si el primer argumento proporcionado es version. También necesitarás una constante version.

   Primero, por encima de tu función main, declara una variable const para la versión. El valor de una variable const nunca se puede cambiar después de haber sido establecido:

   dart

   const version = '0.0.1'; // Add this line
   

   content_copy

   A continuación, modifica tu función main para verificar el argumento version:

   dart

   void main(List<String> arguments) {
     if (arguments.isEmpty) {
       print('Hello, Dart!');
     } else if (arguments.first == 'version') {
       print('Dartpedia CLI version $version');
     }
   }
   

   content_copy

   La sintaxis $version se llama interpolación de cadenas. Te permite incrustar el valor de la variable directamente en una cadena prefijando el nombre de la variable con un signo $.

2. Prueba el comando version: Ejecuta tu aplicación con el argumento version:

   bash

   dart bin/cli.dart version
   

   content_copy

   Ahora deberías ver:

   bash

   Dartpedia CLI version 0.0.1
   

   content_copy

   Si ejecutas tu aplicación sin argumentos, aún verás "Hello, Dart!".

3. Agrega una función printUsage: Para hacer la salida más amigable para el usuario, crea una función separada para mostrar la información de uso. Coloca esta función fuera y debajo de tu función main.

   dart

   void printUsage() { // Add this new function
     print(
       "The following commands are valid: 'help', 'version', 'search <ARTICLE-TITLE>'"
     );
   }
   

   content_copy

   search es el comando que eventualmente buscará en Wikipedia.

4. Implementa el comando help y refina main: Ahora, integra el comando help usando una sentencia else if, y limpia el comportamiento predeterminado para llamar a la función printUsage.

   Modifica tu función main para que se vea así:

   dart

   void main(List<String> arguments) {
     if (arguments.isEmpty || arguments.first == 'help') {
       printUsage(); // Change this from 'Hello, Dart!'
     } else if (arguments.first == 'version') {
       print('Dartpedia CLI version $version');
     } else {
       printUsage(); // Catch-all for any unrecognized command.
     }
   }
   

   content_copy

5. Comprende la estructura if/else y las variables: Ahora que has implementado el flujo de control en la función main, revisa el código que se agregó para ello.

   • arguments.isEmpty comprueba si no se proporcionaron argumentos de línea de comandos.
   • arguments.first accede al primerísimo argumento, que estás usando como nuestro comando.
   • version se declara como una const. Esto significa que su valor se conoce en tiempo de compilación y no puedes cambiarlo durante el tiempo de ejecución.
   • arguments es una variable normal (no constante) porque su contenido puede cambiar durante el tiempo de ejecución en función de la entrada del usuario.

   Ejecuta tu aplicación con el argumento help. Deberías ver impresa la información de uso:

   bash

   dart bin/cli.dart help
   

   content_copy

   Además, intenta ejecutarlo sin ningún argumento:

   bash

   dart bin/cli.dart
   

   content_copy

   Ten en cuenta que continúa mostrando la información de uso. En este punto, cualquier comando que no hayas definido también imprimirá la información de uso. Este es el comportamiento esperado por ahora.

Next, implementa un comando search básico que tome como entrada el título de un artículo. A medida que construyes esta funcionalidad, trabajarás con manipulación de List, comprobaciones de nulos e interpolación de cadenas.

1. Integra el comando search en main: Primero, modifica la función main en cli/bin/cli.dart para incluir una rama else if que maneje el comando search. Por ahora, solo imprime un mensaje de marcador de posición.

   dart

   void main(List<String> arguments) {
     if (arguments.isEmpty || arguments.first == 'help') {
       printUsage();
     } else if (arguments.first == 'version') {
       print('Dartpedia CLI version $version');
     } else if (arguments.first == 'search') {
       // Add this new block:
       print('Search command recognized!');
     } else {
       printUsage();
     }
   }
   

   content_copy

2. Prueba el nuevo comando: Ejecuta tu aplicación con el comando search:

   bash

   dart bin/cli.dart search
   

   content_copy

   Deberías ver:

   bash

   Search command recognized!
   

   content_copy

3. Define la función searchWikipedia: El comando search eventualmente ejecutará la lógica central de tu aplicación llamando a una función llamada searchWikipedia. Por ahora, haz que searchWikipedia imprima los argumentos que se le pasan con el comando search. Coloca esta nueva función debajo de main.

   dart

   // ... (your existing main function)
   ​
   void searchWikipedia(List<String>? arguments) { // Add this new function and add ? to arguments type
     print('searchWikipedia received arguments: $arguments');
   }
   ​
   // ... (your existing printUsage() function)
   

   content_copy

   Aspectos destacados del código anterior:

   • List<String>? arguments significa que la propia lista arguments puede ser null.

4. Llama a la función searchWikipedia desde la función main: Ahora, modifica el bloque del comando search en main para llamar a searchWikipedia y pasarle cualquier argumento que venga después del propio comando search. Usa arguments.sublist(1) para obtener todos los argumentos a partir del segundo. Si no se proporcionan argumentos después de search, pasa null a searchWikipedia.

   dart

   void main(List<String> arguments) {
     if (arguments.isEmpty || arguments.first == 'help') {
       printUsage();
     } else if (arguments.first == 'version') {
       print('Dartpedia CLI version $version');
     } else if (arguments.first == 'search') {
       // Add this new block:
       final inputArgs = arguments.length > 1 ? arguments.sublist(1) : null;
       searchWikipedia(inputArgs);
     } else {
       printUsage();
     }
   }
   

   content_copy

   Aspectos destacados del código anterior:

   • Las variables final solo se pueden establecer una vez y se usan cuando nunca se tiene la intención de volver a cambiar la variable en el código.
   • arguments.sublist(1) crea una nueva lista que contiene todos los elementos de la lista arguments después del primer elemento (que era search).
   • arguments.length > 1 ? ... : null; es un operador condicional (ternario). Asegura que si no se proporcionan argumentos después del comando search, inputArgs se convierte en null, coincidiendo con el comportamiento del código de ejemplo para el parámetro arguments de searchWikipedia que es de tipo List<String>?.

5. Prueba searchWikipedia con argumentos: Usando la línea de comandos, ejecuta la aplicación con el título de un artículo de prueba:

   bash

   dart bin/cli.dart search Dart Programming
   

   content_copy

   Deberías ver:

   bash

   searchWikipedia received arguments: [Dart, Programming]
   

   content_copy

   A continuación, ejecuta el mismo comando sin los argumentos adicionales:

   bash

   dart bin/cli.dart search
   

   content_copy

   Deberías ver:

   bash

   searchWikipedia received arguments: null
   

   content_copy

6. Maneja el título del artículo faltante y la entrada del usuario con el comando stdin: Es más amigable para el usuario solicitarle información si no proporciona el título de un artículo en la línea de comandos. Usa stdin.readLineSync() para esto.

   Primero, añade la importación necesaria en la parte superior de tu archivo cli/bin/cli.dart:

   dart

   import 'dart:io'; // Add this line at the top
   

   content_copy

   dart:io es una librería principal del SDK de Dart y proporciona APIs para trabajar con archivos, directorios, sockets, clientes y servidores HTTP, y más.

   Ahora, actualiza tu función searchWikipedia.

   dart

   void searchWikipedia(List<String>? arguments) {
     final String articleTitle;
   ​
     // If the user didn't pass in arguments, request an article title.
     if (arguments == null || arguments.isEmpty) {
       print('Please provide an article title.');
       // Await input and provide a default empty string if the input is null.
       articleTitle = stdin.readLineSync() ?? '';
     } else {
       // Otherwise, join the arguments into a single string.
       articleTitle = arguments.join(' ');
     }
   ​
     print('Current article title: $articleTitle');
   }
   

   content_copy

   Este bloque de código anterior introduce algunos conceptos clave:

   • Declara una variable final String articleTitle. Esto permite que el análisis estático detecte que articleTitle será un String y no será nulo.
   • Luego, una sentencia if/else comprueba si se proporcionaron argumentos de línea de comandos para la búsqueda.
   • Si faltan argumentos, solicita información al usuario, lee la entrada usando stdin.readLineSync() y maneja de forma segura los casos en los que no se proporciona ninguna entrada.
   • Si los argumentos están presentes, usa arguments.join(' ') para combinarlos en una sola cadena de búsqueda.

   Aspectos destacados del código anterior:

   • stdin.readLineSync() ?? '' lee la entrada del usuario. Aunque stdin.readLineSync() puede devolver nulo, el operador de coalescencia nula (??) se usa para proporcionar una cadena vacía ('') como alternativa si la entrada es nula. Esta es una forma concisa de asegurar que la variable sea una cadena no nula.
   • arguments.join(' ') concatena todos los elementos de la lista arguments en una sola cadena, usando un espacio como separador. Por ejemplo, ['Dart', 'Programming'] se convierte en "Dart Programming". Esto es crucial para tratar las entradas de línea de comandos de varias palabras como una única frase de búsqueda.
   • El análisis estático de Dart puede detectar que articleTitle se garantiza que se inicializará cuando se ejecute la sentencia print. Sin importar qué camino se tome a través del cuerpo de esta función, la variable no acepta nulos (non-nullable).

7. Termina searchWikipedia para imprimir resultados de búsqueda simulados: Actualiza searchWikipedia para mostrar mensajes que parezcan que nuestro programa encontró algo. Esto nos ayuda a ver lo que hará nuestro programa terminado sin construir todo realmente en este momento. Solo verás estos mensajes si incluyes una consulta de búsqueda al ejecutar el programa.

   Por ejemplo: dart bin/cli.dart search Dart Programming.

   dart

   void searchWikipedia(List<String>? arguments) {
     final String articleTitle;
   ​
     // If the user didn't pass in arguments, request an article title.
     if (arguments == null || arguments.isEmpty) {
       print('Please provide an article title.');
       // Await input and provide a default empty string if the input is null.
       articleTitle = stdin.readLineSync() ?? '';
     } else {
       // Otherwise, join the arguments into a single string.
       articleTitle = arguments.join(' ');
     }
   ​
     print('Looking up articles about "$articleTitle". Please wait.');
     print('Here ya go!');
     print('(Pretend this is an article about "$articleTitle")');
   }
   

   content_copy

8. Final Test Run with both scenarios:

   Ahora que la simulación del artículo está configurada, prueba la función searchWikipedia de diferentes maneras:

   bash

   dart bin/cli.dart search Dart Programming
   

   content_copy

   Deberías ver:

   bash

   Looking up articles about "Dart Programming". Please wait.
   Here ya go!
   (Pretend this is an article about "Dart Programming")
   

   content_copy

   Ejecutar sin argumentos (escribe "Flutter Framework" cuando se te solicite):

   bash

   dart bin/cli.dart search
   

   content_copy
   bash

   Please provide an article title.
   Flutter Framework
   

   content_copy

   Ahora has construido con éxito el comando search básico con el manejo de la entrada del usuario, tratando correctamente las entradas de la línea de comandos de varias palabras como una sola frase de búsqueda en la salida.

En el próximo capítulo, te sumergirás en la programación asíncrona y aprenderás cómo obtener datos de la API de Wikipedia usando el paquete http. Esto permitirá que tu aplicación recupere datos reales y se los muestre al usuario.