Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tech-follow wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 98 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,133 @@
# Beer Commande Line Application
# Beer Command Line Application

Cette CLI prend en parametre obligatoire un fichier utiliser celui fournit(open-beer-database.csv).
## Introduction

Cette cli possede plusieurs commande possible.
L'objectif de ce projet est de réaliser un service qui sera exécuté en CLI.
Le rôle de ce service sera d'importer des données, à savoir une liste de bières, puis d'effectuer des opérations de tri et de filtre avant de les afficher et dans certains cas, les exporter.
Il faudra mettre à disposition plusieurs commandes qui effectueront chacune un tri bien spécifique.

Cette cli sera faite en pure PHP, sans framework, suivre les recommandations PSR12 pour le code style. Il est tout a fait possible d'utiliser des dependances tierces a l'aide de composer.
### Contraintes techniques
* Le projet doit être exécuté en CLI
* Il doit être développé en pure PHP (pas de framework)
* Il doit suivre les recommandation PSR12 pour le code style
* Il est tout à fait possible d'utiliser des dépendances tierces à l'aide de composer

**Prerequis**
> Avoir php et composer d'installer sur la machine.
### Prérequis

## Strongest Beer
Remonter la/les biere(s) la plus forte.
Avoir php et composer d'installé sur la machine.


### Package de départ

*It’s dangerous to go alone! Take this.*

Pour le bon déroulement du dev, vous avez à votre disposition la structure de base du projet et les données à manipuler :
* Un fichier php à exécuter en CLI qui fera appelle au service à développer
* Un fichier CSV open-beer-database.csv qui contient les données à importer
* Le dossier src contient la class Cli qui est le point de départ du service à développer



## Spécifications

### Fonctionnement générale du service

Le service doit être exécuté en CLI et prend en paramètre obligatoire :
* Le nom de la commande à exécuter
* Le chemin du fichier CSV à traiter

```
$> ./cli <nom_de_la_commande> <chemin_du_csv>
```

### Gestion des erreurs
Le service doit à minima gérer les erreurs concernant les paramètres obligatoires et le nom des commandes invalides (commands not found)


### Commandes beer:strongest
Afficher la/les bière(s) la/les plus fortes.

Commande :
```
$> ./cli beer:strongest /file/path/beer.csv
beer name - brewery - country
```

## Bitterest Beer
Trouver la/les biere(s) la/les plus amere (IBU)
Output :
```
<beer name> - <brewery> - <country>
<beer name> - <brewery> - <country>
...
```

### Bitterest Beer
Afficher la/les bière(s) la/les plus amères (IBU)

Commande :
```
$> ./cli beer:bitterest /file/path/beer.csv
beer name - brewery - country
```

## World Brewery ranking by country
Classement des pays, par nombre de brasserie
Output :
```
<beer name> - <brewery> - <country>
<beer name> - <brewery> - <country>
...
```


### World Brewery ranking by country
Afficher les pays producteurs de bière classés par nombre de brasserie

Commande
```
$> ./cli beer:ranking:brewery /file/path/beer.csv
nb_brewery - country
nb_brewery - country
nb_brewery - country
nb_brewery - country
```

Output
```
<nb_brewery> - <country name>
<nb_brewery> - <country name>
<nb_brewery> - <country name>
<nb_brewery> - <country name>
...
```

## Style ranking by name
Classement des style de bieres par nombre de reference.
Afficher les styles de bières classés par nombre de références.

Commande
```
$> ./cli beer:ranking:style /file/path/beer.csv
nb_ref - style
nb_ref - style
nb_ref - style
nb_ref - style
```

Output
```
<nb_ref> - <style>
<nb_ref> - <style>
<nb_ref> - <style>
...
```

## Ranking by alcohol
Classement des bieres par taux d'alcool
Afficher les bières classées par taux d'alcool

Commande
```
$> ./cli beer:ranking:alcohol /file/path/beer.csv
beer name - brewery - alcohol
beer name - brewery - alcohol
beer name - brewery - alcohol
beer name - brewery - alcohol
beer name - brewery - alcohol
```

Output
```
<beer name> - <brewery> - <alcohol>
<beer name> - <brewery> - <alcohol>
<beer name> - <brewery> - <alcohol>
<beer name> - <brewery> - <alcohol>
...
```

## Display

Ecrire une commande qui generera un nouveau fichiers csv, les colonnes qui doivent figurer dans ce fichiers sont:
Ecrire une commande qui générera un nouveau fichier csv, les colonnes qui doivent figurer dans ce fichier sont :
* Name
* Style
* Brewery
Expand All @@ -69,4 +136,4 @@ Ecrire une commande qui generera un nouveau fichiers csv, les colonnes qui doive
* Description
* Country
* Website