roman-numerals-tn v1.0.0

Números romanos

Índice

• 1. Preámbulo
• 2. Resumen del proyecto
• 3. Instalación y uso de la librería
• 4. Pruebas unitarias

1. Preámbulo

La numeración romana es un sistema de numeración que se desarrolló en la Antigua Roma y se utilizó en todo el Imperio romano, manteniéndose con posterioridad a su desaparición y todavía utilizado en algunos ámbitos.

Este sistema emplea algunas letras mayúsculas como símbolos para representar ciertos valores. Los números se escriben como combinaciones de letras. Por ejemplo, el año 2020 se escribe como MMXX, donde cada M representa 1000 unidades y cada X representa 10 unidades más.

Está basado en la numeración etrusca, la cual, a diferencia de la numeración decimal que está basada en un sistema posicional, se basa en un sistema aditivo (cada signo representa un valor que se va sumando al anterior). La numeración romana posteriormente evolucionó a un sistema sustractivo, en el cual algunos signos en lugar de sumar, restan. Por ejemplo el 4 en la numeración etrusca se representaba como IIII (1+1+1+1), mientras que en la numeración romana moderna se representa como IV (1 restado a 5).

Fuente: Numeración romana - Wikipedia

2. Resumen del proyecto

En este proyecto consta de un módulo de JavaScript (instalable via npm) que permite al usuario converir números arábigos en números romanos y viceversa. El paquete (lo que instalamos a través de npm) también incluye un script ejecutable que nos permite usar la librería desde el terminal (CLI).

3. Instalación y uso de la librería

La librería y el script ejecutable (herramienta de línea de comando - CLI) están implementados en JavaScript y pueden ser ejecutados con Node.js.

Módulo instalable

• Con GitHub

npm install thainole/roman-numerals

• Como módulo de npm

npm install roman-numerals-tn

API de JavaScript

El módulo exporta un objeto con dos métodos:

• parse(str): Recibe un String como único argumento y retorna un número (Number) en caso que sea un número romano válido, en caso contrario arrojará un error especificando la causa.
• stringify(num): Recibe un número (Number) y retorna un String con la representación del número recibido como número romano. En caso de que el número esté fuera de rango (1 <= num <= 3999).

Ejemplo de uso:

const { parse, stringify } = require('usuario-de-github/roman-numerals');

console.log(parse('I') === 1); // true
console.log(parse('III') === 3); // true
console.log(parse('IX') === 9); // true
console.log(parse('MCMXLIV') === 1944); // true

console.log(stringify(1) === 'I'); // true
console.log(stringify(3) === 'III'); // true
console.log(stringify(9) === 'IX'); // true
console.log(stringify(1944) === 'MCMXLIV'); // true

Interfaz de línea de comando (CLI - Command Line Interface)

Esta interfaz ofrece dos sub-comandos (parse y stringify) además de opciones para mostrar ayuda (-h y --help) y la versión del módulo (-v y --version).

Ambos parse y stringify permiten un input como argumento de línea de comando (argv), que en este caso es el número a convertir.

• Ejecutando directamente a través de la ruta relativa al script bin/cli.js:

• Usando npx:

• Mostrando versión (-v o --version) y ayuda (-h o --help):

4. Pruebas unitarias

Las pruebas unitarias cubren el 100% de statements, functions, lines y branches. Se utilizó el framework Jest para testear las pruebas unitarias.