Creare un applicazione a linea di comando con Node

All'interno di questo modulo abbiamo bisogno di leggere un file all'interno del file system, quindi bisogna importare il modulo nativo di node fs

const fs = require('fs');

Definiamo la funzione getCliente() che riceverà in input il nome del cliente cercato

function getCliente(buyerName) {}

Per leggere in modo sincrono i dati del file system, possiamo utilizzare il metodo readFileSync del modulo fs di node, passando come primo parametro 'clienti.json' e come secondo parametro 'utf-8'

const clientiJSON = fs.readFileSync('clienti.json','utf-8')

Per trasformare i dati ricevuti (di tipo stringa) in oggetti javascript usiamo la funzione JSON.parse() di Javascript

const clienti = JSON.parse(clientiJSON);

Per ricercare il cliente il cui nome è all'interno della variabile buyerName, usiamo il metodo find di Javascript con cui controlliamo se il nome di clienteItem.buyerName è uguale al nome del cliente ricercato buyerName.

const cliente = clienti.find(clienteItem => clienteItem.buyerName === buyerName)

Definiamo la costante ris con al suo interno un oggetto con la proprietà status che inizializziamo con false, una proprietà suggerimenti che inizializziamo con una stringa vuota, una proprietà cliente che inizializziamo con null

ris = {status: false, suggerimenti: '', cliente: null};

Con if(!cliente){} indichiamo che se il cliente non viene trovato, vogliamo suggerire tutti i clienti che iniziano con la prima lettera del cliente cercato. Per fare questo useremo il metodo map di javascript

        if(!cliente){
            clienti.map(clienteItem => {
                if(clienteItem.buyerName[0] === buyerName[0]) {
                    ris.suggerimenti += `${clienteItem.buyerName} \n`;
                }
            });
            return ris;

Se il cliente viene trovato, portiamo la proprietà status a true

ris.status = true;

Se il cliente viene trovato, restituiamo il cliente trovato.

ris.cliente = cliente;

Ritorniamo ris

return ris;

Esportiamo la funzione getCliente con module.exports

module.exports = {
    getCliente
}

Creazione del comando add con i vari --flag da aggiungere

Andremo a creare un istruzione che ci restituisca l'oggetto cercato attraverso il nome.

All'interno della nostra app.js definiamo il comando a cui diamo il nome di add ed assicuriamoci che corrispondano ad i vari flag: orderId,purchaseDate,paymentsDate,buyerEmail,buyerName,buyerPhoneNumber,productName,quantityPurchased,shipAddress1,shipAddress2,shipCity,shipState,shipPostalCode,shipCountry,totalOrder

const chalk = require('chalk');
const yargs = require('yargs');
const { getCliente, addCliente } = require('./app-fn');
/*
yargs.command({
    command : 'get',
    describe : 'Ricerca cliente in base al suo nome',
    builder : {
        nome :{
            describe:'Nome del cliente da cercare',
            demandOption : true,
            type: 'string'
        }
    },
    handler(argv) {
      const ris = getCliente(argv.nome);
        if(ris.status) {
            console.log(chalk.green.bold('Cliente trovato:\n'));
            console.log(ris.cliente);
        }else{
            console.log(chalk.red.bold('Cliente non trovato. Forse cercavi:\n'));
            console.log(ris.suggerimenti);
        };
    }
});
*/
yargs.command({
    command : 'add',
    describe : 'Aggiunta nuovo cliente',
    builder : {
        orderId :{
            describe:'Nome del cliente da Aggiungere',
            demandOption : true,
            type: 'string'
        },
        purchaseDate :{
            describe:'Data di acquisto',
            demandOption : true,
            type: 'string'
        },
        paymentsDate :{
            describe:'Data di Pagamento',
            demandOption : true,
            type: 'string'
        },
        buyerEmail :{
            describe:'Email del Cliente',
            demandOption : true,
            type: 'string'
        },
        buyerPhoneNumber :{
            describe:'Numero telefonico del Cliente',
            demandOption : true,
            type: 'string'
        },
        productName :{
            describe:'Nome del Prodotto Acquistato',
            demandOption : true,
            type: 'string'
        },
        quantityPurchased :{
            describe:'Quantità acquistata (in numeri)',
            demandOption : true,
            type: 'number'
        },
        shipAddress1 :{
            describe:'Indirizzo Primario del Cliente',
            demandOption : true,
            type: 'string'
        },
        shipAddress2 :{
            describe:'Indirizzo Secondario del Cliente',
            demandOption : false,
            type: 'string'
        },
        shipCity :{
            describe:'Città del Cliente',
            demandOption : true,
            type: 'string'
        },
        shipState :{
            describe:'Provincia del Cliente',
            demandOption : true,
            type: 'string'
        },
        shipPostalCode :{
            describe:'Cap del Cliente',
            demandOption : true,
            type: 'string'
        },
        shipCountry :{
            describe:'Sigla Nazione',
            demandOption : true,
            type: 'string'
        },
        totalOrder :{
            describe:'Totale dell\'ordine in Euro',
            demandOption : true,
            type: 'number'
        }
    },
    handler(argv) {
        addCliente(argv)
    }
});
yargs.parse();

• inserendo getCliente, addCliente all'interno delle graffe facciamo destrutturazione, in quanto ritorneremo un oggetto con una serie di proprietà.

Come per il comando get ed il flag nome, creiamo un comando add con tutti i vari flag che dobbiamo inserire per creare il cliente

• handler(argv){}: questa funzione conterrà al suo interno l'oggetto argv di yargs, ed in input avrà la funzione getCliente(argv.nome)
  • const ris = getCliente(argv.nome) definiamo una costante che riporta la funzione getcliente con il nome cliente da ricercare. Questa funzione viene definita in un modulo esterno (in questo caso app-fn.js)
    • if(ris.status){console.log()} indica che il cliente è stato trovato, quindi restituiamo una stringa di testo abbellita con chalk che indica che il cliente è stato trovato e restituiamo il cliente trovato
    • else{} altrimenti se il cliente non è stato trovato, restituiamo una stringa di testo abbellitta con chalk ed i relativi suggerimenti.
  • console.log(cliente)

Creazione della funzione addCliente all'interno del modulo app-fn

Dopo aver creato una funzione per cercare i clienti, vogliamo creare una funzione per aggiungere i clienti, con tutti i valori e le proprietà usati dai precedenti clienti.

Per farlo, apriamo il file app-fn.js andremo a definire la funzione addCliente()

const fs = require('fs');

function getCliente(buyerName) {
    const clientiJSON = fs.readFileSync('clienti.json','utf-8'),
        clienti = JSON.parse(clientiJSON),
        cliente = clienti.find(clienteItem => clienteItem.buyerName === buyerName),
        ris = {status: false, suggerimenti: '', cliente: null};
        
        if(!cliente){
            clienti.map(clienteItem => {
                if(clienteItem.buyerName[0] === buyerName[0]) {
                    ris.suggerimenti += `${clienteItem.buyerName} \n`;
                }
            });
            return ris;
        }
        ris.status = true;
        ris.cliente = cliente;
        return ris;

    return cliente;
};
function addCliente({orderId,purchaseDate,paymentsDate,buyerEmail,buyerName,buyerPhoneNumber,productName,quantityPurchased,shipAddress1,shipAddress2,shipCity,shipState,shipPostalCode,shipCountry,totalOrder}){
    const clientiJSON = fs.readFileSync('clienti.json','utf-8'),
            clienti = JSON.parse(clientiJSON);
    
    clienti.push({orderId,purchaseDate,paymentsDate,buyerEmail,buyerName,buyerPhoneNumber,productName,quantityPurchased,shipAddress1,shipAddress2,shipCity,shipState,shipPostalCode,shipCountry,totalOrder});
    fs.writeFileSync('clienti.json',JSON.stringify(clienti));
    console.log(clienti);
};

module.exports = {
    getCliente,
    addCliente
}

Spiegazione del modulo step by step

const fs = require('fs');

function addCliente({orderId,purchaseDate,paymentsDate,buyerEmail,buyerName,buyerPhoneNumber,productName,quantityPurchased,shipAddress1,shipAddress2,shipCity,shipState,shipPostalCode,shipCountry,totalOrder}) {}

const clientiJSON = fs.readFileSync('clienti.json','utf-8')

const clienti = JSON.parse(clientiJSON);

clienti.push({orderId,purchaseDate,paymentsDate,buyerEmail,buyerName,buyerPhoneNumber,productName,quantityPurchased,shipAddress1,shipAddress2,shipCity,shipState,shipPostalCode,shipCountry,totalOrder});

fs.writeFileSync('clienti.json',JSON.stringify(clienti));

console.log(clienti)

module.exports = {
    getCliente,
    addCliente
}

Creazione del comando del con i vari --flag da aggiungere

Andremo a creare l'ultimo comando, cioè cancellare l'utente in base al numero dell'ordine.

All'interno della nostra app.js definiamo il comando a cui diamo il nome di del ed assicuriamoci che corrisponda ad il flag --orderId

const chalk = require('chalk');
const yargs = require('yargs');
const { getCliente, addCliente, delCliente} = require('./app-fn');
/*
yargs.command({
    command : 'get',
    describe : 'Ricerca cliente in base al suo nome',
    builder : {
        nome :{
            describe:'Nome del cliente da cercare',
            demandOption : true,
            type: 'string'
        }
    },
    handler(argv) {
      const ris = getCliente(argv.nome);
        if(ris.status) {
            console.log(chalk.green.bold('Cliente trovato:\n'));
            console.log(ris.cliente);
        }else{
            console.log(chalk.red.bold('Cliente non trovato. Forse cercavi:\n'));
            console.log(ris.suggerimenti);
        };
    }
});

yargs.command({
    command : 'add',
    describe : 'Aggiunta nuovo cliente',
    builder : {
        orderId :{
            describe:'Nome del cliente da Aggiungere',
            demandOption : true,
            type: 'string'
        },
        purchaseDate :{
            describe:'Data di acquisto',
            demandOption : true,
            type: 'string'
        },
        paymentsDate :{
            describe:'Data di Pagamento',
            demandOption : true,
            type: 'string'
        },
        buyerEmail :{
            describe:'Email del Cliente',
            demandOption : true,
            type: 'string'
        },
        buyerPhoneNumber :{
            describe:'Numero telefonico del Cliente',
            demandOption : true,
            type: 'string'
        },
        productName :{
            describe:'Nome del Prodotto Acquistato',
            demandOption : true,
            type: 'string'
        },
        quantityPurchased :{
            describe:'Quantità acquistata (in numeri)',
            demandOption : true,
            type: 'number'
        },
        shipAddress1 :{
            describe:'Indirizzo Primario del Cliente',
            demandOption : true,
            type: 'string'
        },
        shipAddress2 :{
            describe:'Indirizzo Secondario del Cliente',
            demandOption : false,
            type: 'string'
        },
        shipCity :{
            describe:'Città del Cliente',
            demandOption : true,
            type: 'string'
        },
        shipState :{
            describe:'Provincia del Cliente',
            demandOption : true,
            type: 'string'
        },
        shipPostalCode :{
            describe:'Cap del Cliente',
            demandOption : true,
            type: 'string'
        },
        shipCountry :{
            describe:'Sigla Nazione',
            demandOption : true,
            type: 'string'
        },
        totalOrder :{
            describe:'Totale dell\'ordine in Euro',
            demandOption : true,
            type: 'number'
        }
    },
    handler(argv) {
        addCliente(argv)
    }
});
*/

yargs.command({
    command : 'del',
    describe : 'Cancellare cliente in base al numero dell\'ordine',
    builder : {
        orderId :{
            describe:'Numero dell\'ordine da cancellare',
            demandOption : true,
            type: 'string'
        }
    },
    handler(argv) {
        delCliente(argv.orderId);
    }
});
yargs.parse();

• inserendo getCliente, addCliente , delCliente all'interno delle graffe facciamo destrutturazione, in quanto ritorneremo un oggetto con una serie di proprietà.

Come per il comando get ed add, creiamo un comando del con con il flag orderId che dobbiamo inserire per eliminare il cliente

• handler(argv){}: questa funzione conterrà al suo interno l'oggetto argv di yargs, ed in input avrà la funzione delCliente(argv.orderId)
  • Invochiamo la funzione delCliente() passando in input argv.orderId;

Creazione della funzione delCliente all'interno del modulo app-fn

Per creare la funzione delCliente, apriamo il file app-fn.js dove andremo a definire la funzione delCliente()

const fs = require('fs');

function getCliente(buyerName) {
    const clientiJSON = fs.readFileSync('clienti.json','utf-8'),
        clienti = JSON.parse(clientiJSON),
        cliente = clienti.find(clienteItem => clienteItem.buyerName === buyerName),
        ris = {status: false, suggerimenti: '', cliente: null};
        
        if(!cliente){
            clienti.map(clienteItem => {
                if(clienteItem.buyerName[0] === buyerName[0]) {
                    ris.suggerimenti += `${clienteItem.buyerName} \n`;
                }
            });
            return ris;
        }
        ris.status = true;
        ris.cliente = cliente;
        return ris;

    return cliente;
};
function addCliente({orderId,purchaseDate,paymentsDate,buyerEmail,buyerName,buyerPhoneNumber,productName,quantityPurchased,shipAddress1,shipAddress2,shipCity,shipState,shipPostalCode,shipCountry,totalOrder}){
    const clientiJSON = fs.readFileSync('clienti.json','utf-8'),
            clienti = JSON.parse(clientiJSON);
    
    clienti.push({orderId,purchaseDate,paymentsDate,buyerEmail,buyerName,buyerPhoneNumber,productName,quantityPurchased,shipAddress1,shipAddress2,shipCity,shipState,shipPostalCode,shipCountry,totalOrder});
    fs.writeFileSync('clienti.json',JSON.stringify(clienti));
    console.log(clienti);
};

module.exports = {
    getCliente,
    addCliente
}

Spiegazione del modulo step by step

const fs = require('fs');

function addCliente(orderId) {}

const clientiJSON = fs.readFileSync('clienti.json','utf-8')

const clienti = JSON.parse(clientiJSON);

ClienteIndex = clienti.findIndex(cliente => cliente.orderId === orderId);

        if(clienteIndex === -1) {
            console.log('Cliente non trovato');
            return;
        }

clienti.splice(clienteIndex, 1);

        fs.writeFileSync('clienti.json', JSON.stringify(clienti));
        console.log(clienti);

module.exports = {
    getCliente,
    addCliente,
    delCliente
}