Zayef 🔥

A Ruby gem for generating fake data with a Moroccan touch. Perfect for testing and development!

Add this line to your application's Gemfile:

gem 'zayef'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install zayef

require 'zayef'

# Generate a full name
Zayef.name                    # => "Youssef Alaoui"

# Generate individual components
Zayef.first_name              # => "Fatima"
Zayef.last_name               # => "Bennani"

# Generate email
Zayef.email                   # => "ayoub.kabbaj@gmail.com"
Zayef.email(first_name: "Ahmed", last_name: "El Fassi")  # => "ahmed.el_fassi@yahoo.fr"

# Generate phone number (Moroccan format)
Zayef.phone                   # => "0612345678"

# Generate address
Zayef.city                    # => "Casablanca"
Zayef.address                 # => "123, Av. Hassan II, Rabat"

# Generate Moroccan-specific data
Zayef.cni_number             # => "AB123456"
Zayef.bank_account           # => "MA123456789012345678"
Zayef.postal_code            # => "20000"
Zayef.company_name           # => "Groupe Maroc"
Zayef.region                 # => "Casablanca-Settat"
Zayef.university             # => "Université Mohammed V de Rabat"
Zayef.neighborhood           # => "Medina"
Zayef.medical_specialty      # => "Médecine générale"
Zayef.profession             # => "Médecin"
Zayef.traditional_dish       # => "Couscous"
Zayef.spice                  # => "Ras-el-hanout"
Zayef.souk                   # => "Souk Semmarine"
Zayef.bank                   # => "Attijariwafa Bank"
Zayef.restaurant             # => "Café Clock"
Zayef.hotel                  # => "Riad Kniza"
Zayef.mosque                 # => "Mosquée Hassan II"
Zayef.school                 # => "Lycée Descartes"
Zayef.newspaper              # => "Le Matin"
Zayef.festival               # => "Festival de Marrakech"

• 🏠 Moroccan Names: 40+ authentic first names + 50+ family names
• 📧 Email Generation: Realistic emails with Moroccan domains (menara.ma, iam.ma, orange.ma)
• 📱 Phone Numbers: Moroccan mobile format (06/07 prefixes)
• 🏙️ Cities & Addresses: 50+ real Moroccan cities + authentic street names
• 🏡 Neighborhoods: Famous districts (Medina, Gueliz, Maarif, etc.)
• 🆔 CNI Numbers: Moroccan ID format (2 letters + 6 digits)
• 🏦 Bank Accounts: Moroccan format with MA prefix
• 📮 Postal Codes: 5-digit Moroccan postal codes

• 👨‍⚕️ Medical Specialties: 25+ Moroccan medical specialties (DabaDoc integration)
• 👔 Professions: Common Moroccan professions (médecin, ingénieur, etc.)
• 🏢 Company Names: Authentic Moroccan business naming patterns
• 🏦 Banks: All major Moroccan banks (Attijariwafa, BCP, BMCI, etc.)
• 📰 Newspapers: Moroccan media outlets (Le Matin, L'Économiste, etc.)

• 🗺️ Regions: All 12 Moroccan administrative regions
• 🎓 Universities: 12+ major Moroccan universities with full names
• 🏫 Schools: Famous Moroccan schools and lycées
• 🎭 Festivals: Major Moroccan cultural festivals
• 🕌 Mosques: Famous Moroccan mosques (Hassan II, Koutoubia, etc.)

• 🍲 Traditional Dishes: Famous Moroccan cuisine (couscous, tagine, pastilla, etc.)
• 🌶️ Spices: Moroccan spices and ingredients (ras-el-hanout, safran, etc.)
• 🏪 Souks: Traditional Moroccan markets (Souk Semmarine, Bahia, etc.)
• ☕ Cafés/Restaurants: Famous Moroccan cafés and restaurants
• 🏨 Hotels/Riads: Moroccan hotels and traditional riads

• Total Data Points: 300+ authentic Moroccan entries
• Categories: 18 different data types
• 100% Moroccan: Everything is authentically Moroccan
• No Duplicates: All data is unique and varied

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

Zayef has comprehensive test coverage with 69 RSpec tests covering all functionality.

# Run all tests
bundle exec rspec

# Run tests with coverage report
COVERAGE=true bundle exec rspec

# Run specific test file
bundle exec rspec spec/zayef/generator_spec.rb

# Run tests with documentation format
bundle exec rspec --format documentation

• ✅ Core Generators: Names, emails, phones, addresses, IDs
• ✅ Moroccan Data: Regions, universities, neighborhoods, medical specialties
• ✅ Cultural Elements: Traditional dishes, spices, souks, festivals
• ✅ Business Data: Banks, companies, newspapers, schools
• ✅ Integration Tests: End-to-end functionality testing
• ✅ Error Handling: Edge cases and validation

Current Coverage: 90%+ with comprehensive test suite

Zayef uses git-cliff for automated changelog generation based on conventional commits.

Install git-cliff:

# Using cargo (recommended)
cargo install git-cliff

# Or using homebrew (macOS)
brew install git-cliff

# Or download from GitHub releases

# Generate full changelog
./bin/generate-changelog

# Generate changelog for unreleased changes only
./bin/generate-changelog --unreleased

# Generate changelog for latest version
./bin/generate-changelog --latest

# Generate changelog up to specific tag
./bin/generate-changelog --tag v1.0.0

# Check if git-cliff is available
rake changelog:check

Use conventional commit format for better changelog organization:

# Features
git commit -m "feat: add Moroccan phone number generation"

# Bug fixes
git commit -m "fix: correct CNI number format"

# Documentation
git commit -m "docs: update README with new examples"

# Breaking changes
git commit -m "feat!: change API interface (breaking change)"

# With scope
git commit -m "feat(generator): add support for traditional dishes"

Zayef includes automated release tasks:

# Prepare release (generate changelog, bump version)
rake release:prepare

# Publish to RubyGems.org
rake release:publish

# Full release process
rake release:full

# Run all quality checks
rake

# Generate documentation
rake dev:docs

# Create conventional commit interactively
rake git:commit

# Check changelog generation
rake changelog:check

Bug reports and pull requests are welcome on GitHub at https://github.com/amqor/zayef.

1. Use Conventional Commits: Follow the conventional commit format for automatic changelog generation
2. Add Tests: Include tests for new features
3. Update Documentation: Keep README and inline documentation up to date
4. Follow Ruby Style: Use consistent Ruby coding style

The gem is available as open source under the terms of the MIT License.