faussaire 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 714ee3f21dd5575ad01277d68a1ea579a30df7b291f179d668505c75f9bb3446
-  data.tar.gz: 165a13bca8e97fd6a21b9a6f7d85186ffa37591ecf49587e8a080c42f02311b1
+  metadata.gz: 10949004df2064d24fc1b476d1d67e90d974e3d6e1c6ca9f052f43559b5df927
+  data.tar.gz: 339931417621ba4209cf2196e049527c5b32ee06f6b45dfe2a484710085b548b
 SHA512:
-  metadata.gz: 9da106d7163b98fd9d1de4cf0e2e9f47bb3978a636ea0109e9d3c523e7ad260787d39737f43e6a48e8fc4893a76b14a7dc9dbe444205535a18265e084207f584
-  data.tar.gz: a601ca5524c1f5a982fad60d24743a6fa462ca53598971ff73376da4580d6b082f7c66d8ec2e8bcb16e4d91f78da60f93b11d77f7113867dec197adb59ab9b13
+  metadata.gz: ec73a9995b830915146b96f138e4a33a0fa8cd1d9c17b31c896e1d609cac83801b12367b7e4088c9680fa69bbcb2c1339388f4879a44c4f36bfcc5684781542a
+  data.tar.gz: 37897880c2a212ac0f99543ec8166471c6bcfe575328017b033b1dc1d8b4fe92a741f93450c5ee7ec73f4fcd59d1797f2163b489820cdd69cdb71aae5dfd8bb7

data/CHANGELOG.md

@@ -4,8 +4,36 @@
 
 - Initial release
 
+## [RELEASED]
+
+## [0.1.1] - 2024-09-28
+
+- First live version
+
+## [0.1.4] - 2024-10-27
+
 ## [Unreleased]
 
+## [0.1.0] - 2023-12-25
+- Initial release
+
+## [RELEASED]
+
 ## [0.1.1] - 2024-09-28
+- First live version
+
+## [0.1.6] - 2024-10-27
+### Added
+- **New `Faussaire::Piraterie` Methods**:
+  - `role`: Generates a learner status inspired by The Hacking Project.
+  - `pnj`: Provides a pirate-themed character title.
+  - `nav`: Outputs a random pirate ship type.
+  - `rage`: Produces pirate-themed swearing expressions.
+  - `excuse`: Generates excuses for project delays or absences.
+  - `potin`: Creates gossipy anecdotes about bootcamp life.
 
-- Publishing attempt
+### Enhancements
+- Improved spec coverage:
+  - Tests for duplicate values in YAML data.
+  - Format validation for data entries.
+  - Tests to confirm that each method returns a unique and expected value.

data/README.md

@@ -1,4 +1,6 @@
-# FAUSSAIRE • Au revoir Lorem Ipsum 😉
+# FAUSSAIRE • Au revoir Lorem Ipsum
+
+[![Gem Version](https://badge.fury.io/rb/faussaire.svg)](https://badge.fury.io/rb/faussaire)
 
 ### Des données authentiques, des apps réalistes, des seeds ludiques
 
@@ -29,17 +31,11 @@ Conçue pour fournir des données plus précises et moins génériques que [Fake
 
 Nous avons pour projet de proposer une version grecque dans les mois à venir, et peut-être une version "globish".
 
-Quand on aime ce qu’on fait, on aime rendre ça ludique.
-
-Comme moi, ça a dû vous arriver.
-
-Des phases de débogage interminables avec une base de données peuplée de Lorem Ipsum, ça devient vite lassant.
-
-Et puis, comment tester cette REGEX sur le format des adresses françaises si les données de test n’ont pas de numéro de département à 3 chiffres ?
+## Pourquoi utiliser Faussaire ?
 
-Mince, vous venez d’envoyer votre app en production, mais vous vous rendez compte qu’en excluant les caractères spéciaux, vous avez aussi empêché Stéphane de mettre un accent à son prénom.
+Quand on aime ce qu’on fait, on aime rendre ça ludique.
 
-La liste est interminable.
+Comme moi, ça a dû vous arriver. Des phases de débogage interminables avec une base de données peuplée de Lorem Ipsum, ça devient vite lassant. Et puis, comment tester cette REGEX sur le format des adresses françaises si les données de test n’ont pas de numéro de département à 3 chiffres ? Mince, vous venez d’envoyer votre app en production, mais vous vous rendez compte qu’en excluant les caractères spéciaux, vous avez aussi empêché Stéphane de mettre un accent à son prénom. La liste est interminable.
 
 Si comme moi, vous en avez marre de la standardisation à outrance et que vous voulez utiliser une librairie francophone, amusante et enrichissante, vous allez adorer Faussaire.
 
@@ -178,7 +174,7 @@ Faussaire::Address.full_address
 </details>
 
 <details> 
-<summary><strong>Faussaire::Bizness</strong> — <i>Brasseur de vent (phrases "corporate" dénuées de sens) et noms de marques françaises</i></summary>
+<summary><strong>Faussaire::Bizness</strong></summary>
 
 Le module `Faussaire::Bizness` génère des noms de marques françaises et des phrases clichés du monde de l'entreprise.
 
@@ -331,6 +327,39 @@ Faussaire::Name.name
 ```
 </details>
 
+<details>
+<summary><strong>Faussaire::Piraterie</strong></summary>
+
+Le module `Faussaire::Piraterie` est un hommage à The Hacking Project (THP), le bootcamp français qui réinvente l'apprentissage du code grâce à l'entraide et à l'esprit d'équipe. Ce module permet de générer des données inspirés de l'univers de la formation et a été réalisé pour être utilisé dans le cadre de la formation.
+
+```ruby
+# Génère un rôle qu'un apprenant peut avoir chez THP.
+Faussaire::Piraterie.role 
+# => "Moussaillon"
+
+# Génère un statut thématique autour de la piraterie mais qui n'est pas (encore) utilisé chez THP.
+Faussaire::Piraterie.pnj 
+# => "Siresse"
+
+# Génère un type de navire pirate.
+Faussaire::Piraterie.nav 
+# => "Frégate"
+
+# Génère un juron de pirate.
+Faussaire::Piraterie.rage 
+# => "Mille millions de mille sabords !"
+
+# Génère une excuse aléatoire pour justifier une absence, un retard ou un projet non rendu.
+Faussaire::Piraterie.excuse 
+# => "Les embruns de la mer de Frêche m'ont rendu un peu fébrile… ai-je droit à un peu de repos Capitaine ?"
+
+# Génère un potin amusant sur l'expérience d'apprentissage à THP, idéal pour le fameux Gossip Project.
+Faussaire::Piraterie.potin 
+# => "“Une bête de prime en crypto” : un corsaire influent promet une récompense au premier moussaillon qui contribue à la gem Faussaire. Des bruits de ponton racontent qu'un corsaire influent de la promo aurait mis en jeu une prime en crypto pour inciter les moussaillons à contribuer à la célèbre gem Faussaire. Vrai bonne affaire ou simple manigance ?"
+```
+</details>
+
+
 <details>
 <summary><strong>Faussaire::Tv</strong></summary>
 
@@ -456,7 +485,7 @@ Merci à toi camarade faussaire ! 🙂‍
 
 <a name="English"></a>
 
-# FAUSSAIRE • Goodbye Lorem Ipsum 😉
+# FAUSSAIRE • Goodbye Lorem Ipsum
 
 ### Authentic French Data for Realistic Apps & Fun Seeding
 
@@ -466,7 +495,7 @@ Designed to provide more accurate and less generic data than [Faker](https://git
 
 ## Table of Contents
 
-- [Why Use Faussaire?](#why-use-faussaire)
+- [Why Should I Use Faussaire ?](#why-using-faussaire-)
 - [Installation](#installation)
 - [Usage](#usage)
 - [Available Modules](#available-modules-in-faussaire)
@@ -901,4 +930,4 @@ Feel free to participate by submitting your pull requests:
 - **Issues:** Provide as many details as possible about the problem encountered and how to reproduce it.
 - **Pull Requests:** Check out [CONTRIBUTING.md](https://github.com/ikramagix/faussaire/blob/main/CONTRIBUTING.md).
 
-Merci beaucoup, fellow faussaire! 🙂‍
+Merci beaucoup, fellow faussaire! 🙂‍

data/lib/faussaire/piraterie.rb

@@ -0,0 +1,92 @@
+require 'yaml'
+
+module Faussaire
+  class Piraterie
+    DATA_PATH = File.expand_path('../../../locale/fr.yml', __FILE__)
+
+    ##
+    # Fetches and samples data based on the provided key. If the fetched data is an array,
+    # it samples a single item, otherwise returns the data directly.
+    #
+    # @param key [String] The dot-separated key used to access the data.
+    # @return [Object, nil] The data fetched and optionally sampled.
+    #
+    def self.fetch(key)
+      data = YAML.load_file(DATA_PATH)
+      result = data.dig(*key.split('.'))
+      result.is_a?(Array) ? result.sample : result
+    end
+
+    ##
+    # Produces a random The Hacking Project learner status.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faussaire::Piraterie.role #=> "Moussaillon"
+    #
+    def self.role
+      fetch('fr.faussaire.piraterie.role')
+    end
+
+    ##
+    # Produces a random pirate-themed status not used in the Hacking Project.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faussaire::Piraterie.pnj #=> "Siresse"
+    #
+    def self.pnj
+      fetch('fr.faussaire.piraterie.pnj')
+    end
+
+    ##
+    # Produces a random pirate boat type.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faussaire::Piraterie.nav #=> "Frégate"
+    #
+    def self.nav
+      fetch('fr.faussaire.piraterie.nav')
+    end
+    
+    ##
+    # Produces a random pirate swearing.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faussaire::Piraterie.rage #=> "Mille millions de mille sabords !"
+    #
+    def self.rage
+      fetch('fr.faussaire.piraterie.rage')
+    end
+
+    ##
+    # Produces a random excuse for not delivering a project or being absent.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faussaire::Piraterie.excuse #=> "Les embruns de la mer de Frêche m'ont rendu un peu fébrile… ai-je droit à un peu de repos Capitaine ?"
+    #
+    def self.excuse
+      fetch('fr.faussaire.piraterie.excuse')
+    end
+
+    ##
+    # Produces a random made-up gossip about The Hacking Project experience.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faussaire::Piraterie.potin #=> "Il paraît qu’un moussaillon préfère naviguer en eaux troubles avec des commits non testés !"
+    #
+    def self.potin
+      fetch('fr.faussaire.piraterie.potin')
+    end
+  end
+end

data/lib/faussaire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faussaire
-  VERSION = "0.1.1"
+  VERSION = "0.1.6"
 end

data/lib/faussaire.rb

@@ -13,6 +13,7 @@ require_relative 'faussaire/gardinerie'
 require_relative 'faussaire/citation'
 require_relative 'faussaire/cosmos'
 require_relative 'faussaire/music'
+require_relative 'faussaire/piraterie'
 
 
 module Faussaire