faussaire 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0213da4b19f2fbc6e263b0f2a29b5379f0091ac5cd02388015a5552fb9aa711d
-  data.tar.gz: b661cdc72edf617ca8260699727efe298287c0d6b9e738415f60879bbc21a9f5
+  metadata.gz: 1eb436d18fc3136abaff8d38dae0c1053f1cb9752ca9c766e98070b5c8a6e34b
+  data.tar.gz: 6d2b5dda0f6a3982d53e7c4c422e62182f76ec17f9d4cccfb3d9ff2f67d8481e
 SHA512:
-  metadata.gz: b6433e318c575d2c2bb46a32e15a2e13dd7421d9a4417e15138810ded78d7953f491b202782d2c810f145b1877ea7aad8016810c6698bb7dfb041c4e6c36f2c3
-  data.tar.gz: 0615dd20a53a17bcff6720d4f7cec66724c432f3112c5c1310a89a771d9a1a4d71b2549f9ed0370739f75625796df76f3c45ec6071ac0a8877b1bee7132911bb
+  metadata.gz: c24c884ff5bd1dcfa97e4367a4c86efb6a6d6107b26618c22e17d977c90153a230db79d0214221f7b37637ed543648677581147930b8222cfec5b35b6b5fa21c
+  data.tar.gz: 40a83e42ed0c7871f1df5f0b0191ef98b9a0529746579e0f40ce769372dc3b1f53f20f0e781ebaa9d3f465605ce35e12de172084a51e8fb6dfeb83a754b56f5d

data/CHANGELOG.md

@@ -1,11 +1,44 @@
 ## [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.
+
+### 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.
+
+## [1.0.0] - 2024-11-23
+### Added
+- **New `Faussaire::Tv.netflix` Method**:
+  - Generates a random Netflix Original title from a cleaned dataset of 1033 TV shows, movies, stand-up comedy specials, and more.
+  - Example: `Faussaire::Tv.netflix` => `"Squid Game"`
+
+### Enhancements
+- **Duplicate Check Refactoring**:
+  - Improved duplicate detection logic in YAML datasets for TV.
+  - Added `netflix` subset to duplicate-checking specs.
+
+- **Readme Updates**:
+  - Added examples for the new `Faussaire::Tv.netflix` method.
+  - Updated documentation to reflect the expanded dataset.
+
+- **Ruby Version Update**:
+  - Adjusted the required Ruby version to address a `rubocop` PR conflict issue.
+  - Standardized capitalization in the `license.txt` file.

data/LICENSE.txt

@@ -20,16 +20,30 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
-----
-
-Additional Terms on Data Ownership & Usage
-
-The dataset included in this software, including but not limited to the `fr.yml` file and other data files (the "Dataset"), is the property of the original creator and is protected under applicable intellectual property laws. The following additional terms apply specifically to the Dataset:
-
-1. Educational Use Only: The Dataset may be used, modified, and distributed for educational purposes only as part of copies or substantial portions of the Software. Any other use of the Dataset is strictly prohibited without prior written authorization from the copyright holder.
-
-2. Restricted Use for Other Projects: The Dataset, including the `fr.yml` file, may not be extracted, used, or incorporated into other projects or software without explicit prior authorization from the copyright holder. This restriction applies regardless of whether the other project is for commercial or non-commercial purposes.
-
-3. Authorization Required: For any use of the Dataset outside the scope of these terms, including but not limited to commercial use or incorporation into other software, explicit authorization must be obtained from the copyright holder. Please contact [hello@ikramagix.com] for inquiries and permissions.
-
-These additional terms do not modify the MIT License as it applies to the Software itself. The Software remains available under the terms of the MIT License, while the Dataset is subject to the above restrictions.
+ADDITIONAL TERMS ON DATA OWNERSHIP AND USAGE:
+
+The dataset included in this software, including but not limited to the `fr.yml` 
+file and other data files (the "Dataset"), is the property of the original creator 
+and is protected under applicable intellectual property laws. The following 
+additional terms apply specifically to the Dataset:
+
+1. EDUCATIONAL USE ONLY: 
+The Dataset may be used, modified, and distributed for educational purposes only 
+as part of copies or substantial portions of the Software. Any other use of the 
+Dataset is strictly prohibited without prior written authorization from the 
+copyright holder.
+
+2. RESTRICTED USE FOR OTHER PROJECTS: 
+The Dataset, including the `fr.yml` file, may not be extracted, used, or 
+incorporated into other projects or software without explicit prior authorization 
+from the copyright holder. This restriction applies regardless of whether the other 
+project is for commercial or non-commercial purposes.
+
+3. AUTHORIZATION REQUIRED: For any use of the Dataset outside the scope of these terms, 
+including but not limited to commercial use or incorporation into other software, explicit 
+authorization must be obtained from the copyright holder. 
+Please contact [hello@ikramagix.com] for inquiries and permissions.
+
+These additional terms do not modify the MIT License as it applies to the Software itself. 
+The Software remains available under the terms of the MIT License, while the Dataset is 
+subject to the above restrictions.

data/README.md

@@ -1,30 +1,28 @@
 # FAUSSAIRE • Au revoir Lorem Ipsum
 
 [![Gem Version](https://badge.fury.io/rb/faussaire.svg)](https://badge.fury.io/rb/faussaire)
+<p align="left">
+   <a href="#english">
+     <img src="hello.png" alt="English" width="50" height="50">
+   </a>
+   <br>
+   <a href="#english">
+     Hey! You can also README in English!
+   </a>
+</p>
 
 ### Des données authentiques, des apps réalistes, des seeds ludiques
 
 **Faussaire** est une alternative made in France à la gem [Faker](https://github.com/faker-ruby/faker) en Ruby.
 
-Conçue pour fournir des données plus précises et moins génériques que [Faker](https://github.com/faker-ruby/faker), elle dispose actuellement d'un set français exhaustif, réaliste et culturellement pertinent pour vos projets Ruby francophones.
-
-> [!NOTE]
-> <p align="center">
->   <a href="#english">
->     <img src="hello.png" alt="English" width="50" height="50">
->   </a>
->   <br>
->   <a href="#english">
->     Hey! You can also README in English!
->   </a>
-> </p>
+Conçue pour fournir des données plus précises et plus diverses, elle dispose actuellement d'un set français exhaustif, réaliste et culturellement pertinent pour vos projets Ruby francophones.
 
 ## Table des matières
 
 - [Pourquoi utiliser Faussaire ?](#pourquoi-utiliser-faussaire-)
+- [Modules Disponibles](#modules-disponibles)
 - [Installation](#installation)
 - [Utilisation](#utilisation)
-- [Modules Disponibles](#modules-disponibles-dans-faussaire)
 - [Développement](#vous-voulez-participer-)
 - [Licence](#licence)
 - [Contribution](#il-manquerait-pas-un-petit-quelque-chose-)
@@ -35,15 +33,7 @@ Nous avons pour projet de proposer une version grecque dans les mois à venir, e
 
 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 ?
-
-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.
+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.
 
@@ -57,53 +47,7 @@ C'est quand même plus drôle d'avoir une liste d'AOC, un générateur de phrase
 
 - _Qualité des données:_ Proposer des options de génération de données soigneusement élaborés, précises et complètes, qu'il s'agisse de contextes professionnels ou de références culturelles.
 
-## Installation
-
-Avant de commencer, vérifiez que Ruby et RubyGems sont bien installés sur votre machine. Vous pouvez utiliser les commandes suivantes :
-
-_Pour Ruby :_
-
-```bash
-ruby -v
-```
-
-Cela affichera la version de Ruby installée, si Ruby est bien installé.
-
-_Pour RubyGems :_
-
-```bash
-gem -v
-```
-
-Cela affichera la version de RubyGems installée, si RubyGems est bien installé.
-
-Ensuite, vous pouvez installer **Faussaire** directement via RubyGems :
-
-```bash
-gem install faussaire
-```
-
-Vous pouvez également l'ajouter à votre Gemfile :
-
-```ruby
-gem 'faussaire'
-```
-
-et lancez la commande suivante pour l'installer :
-
-```bash
-bundle install
-```
-
-## Utilisation
-
-Pour utiliser **Faussaire** dans vos applications Ruby, il suffit de charger la gem :
-
-```ruby
-require 'faussaire'
-```
-
-## Modules Disponibles dans Faussaire
+## Modules Disponibles
 
 <details>
 <summary><strong>Faussaire::Ancien</strong></summary>
@@ -182,7 +126,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.
 
@@ -243,9 +187,7 @@ Faussaire::Cosmos.exploration
 Le module `Faussaire::Creamerie` génère des données liées aux produits laitiers français, parfait pour des applications ou des démonstrations liées à l'alimentation.
 
 ```ruby
-# Génère un type de lait al
-
-éatoire.
+# Génère un type de lait aléatoire.
 Faussaire::Creamerie.milk_type 
 # => "Lait de bufflonne"
 
@@ -335,12 +277,51 @@ 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>
 
 Le module `Faussaire::Tv` génère des données factices liées à la télévision, y compris des titres d'émissions, des influenceurs, des couples célèbres, des chaînes TV, ainsi que des détails spécifiques liés au Festival de Cannes.
 
 ```ruby
+
+# Génère un titre de contenu Netflix Originals (séries, films, one-man show, etc...).
+# Plus de 1033 propositions !
+Faussaire::Tv.netflix 
+# => "Squid Game"
+
 # Génère un titre d'émission de télévision aléatoire.
 Faussaire::Tv.show 
 # => "Marjolaine et les Millionnaires"
@@ -351,7 +332,7 @@ Faussaire::Tv.influencer
 
 # Génère un couple célèbre de la télévision aléatoire.
 Faussaire::Tv.famous_couples 
-# => "J.Lo et Diddy (2000)"
+# => "Marilyn Monroe et Joe DiMaggio (1953)"
 
 # Génère un nom de chaîne TV aléatoire.
 Faussaire::Tv.channel 
@@ -419,6 +400,52 @@ Faussaire::Wine.licocorico
 ```
 </details>
 
+## Installation
+
+Avant de commencer, vérifiez que Ruby et RubyGems sont bien installés sur votre machine. Vous pouvez utiliser les commandes suivantes :
+
+_Pour Ruby :_
+
+```bash
+ruby -v
+```
+
+Cela affichera la version de Ruby installée, si Ruby est bien installé.
+
+_Pour RubyGems :_
+
+```bash
+gem -v
+```
+
+Cela affichera la version de RubyGems installée, si RubyGems est bien installé.
+
+Ensuite, vous pouvez installer **Faussaire** directement via RubyGems :
+
+```bash
+gem install faussaire
+```
+
+Vous pouvez également l'ajouter à votre Gemfile :
+
+```ruby
+gem 'faussaire'
+```
+
+et lancez la commande suivante pour l'installer :
+
+```bash
+bundle install
+```
+
+## Utilisation
+
+Pour utiliser **Faussaire** dans vos applications Ruby, il suffit de charger la gem :
+
+```ruby
+require 'faussaire'
+```
+
 ## Vous voulez participer ?
 
 Pour configurer l'environnement de développement pour **Faussaire** :
@@ -790,7 +817,13 @@ Faussaire::Name.name
 The `Faussaire::Tv` module generates fake data related to television, including show titles, influencers, famous couples, TV channels, and specific details related to the Cannes Film Festival.
 
 ```ruby
-# Generates a random television show title.
+
+# Generates a Netflix Originals title (TV shows, movies, stand-up comedies, etc.).
+# Over 1,033 real possibilities
+Faussaire::Tv.netflix
+# => "Squid Game"
+
+# Generates a random French reality TV show title.
 Faussaire::Tv.show 
 # => "Marjolaine et les Millionnaires"
 
@@ -800,7 +833,7 @@ Faussaire::Tv.influencer
 
 # Generates a random famous television couple.
 Faussaire::Tv.famous_couples 
-# => "J.Lo et Diddy (2000)"
+# => "Marilyn Monroe et Joe DiMaggio (1953)"
 
 # Generates a random TV channel name.
 Faussaire::Tv.channel 

data/faussaire.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "Faussaire is a Ruby gem that allows you to effortlessly generate a diverse set of fake data in multiple languages, including French and Greek. Whether you're developing and testing applications or need placeholder content for design mockups, Faussaire provides a simple and flexible way to create realistic-looking data on demand."
   spec.homepage = "https://github.com/ikramagix/faussaire"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ikramagix/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/tv.rb

@@ -169,5 +169,17 @@ module Faussaire
     def self.channel
       fetch('fr.faussaire.tv.channel')
     end
+
+    ##
+    # Produces a random Netflix program.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faussaire::Tv.netflix #=> "Stranger Things"
+    #
+    def self.netflix
+      fetch('fr.faussaire.tv.netflix')
+    end
   end
 end

data/lib/faussaire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faussaire
-  VERSION = "0.1.3"
+  VERSION = "1.0.0"
 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