zayef 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a9db0bd834b1eca144fac50af59308ab319c26805d60581c924c6090d359a34
+  data.tar.gz: 760c63144ff6461b4d53877ddde502f69aae45e73679651d329133028f204f01
+SHA512:
+  metadata.gz: 768176f603f08df8337c2a18e0b82155590f74f928b2db8ced5e1146c19c9d59720eebdb79d1eed2f539ed7d073bbaf1109243e3fc2a2cd6ba28587c92fdfc1d
+  data.tar.gz: e3ee2d91968c2170ab6a9ea13f3a32493ccd133faa53ae2ce0344a99907a480d2ef220e0234070cd8f0812b46546fedb6b832d5722f42eae4223c2f8dd778937

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-09-17
+
+### Features
+- **feat**: Initial release of Zayef - Moroccan data generator
+- **feat**: Add comprehensive Moroccan names (40+ first names, 50+ family names)
+- **feat**: Add 50+ authentic Moroccan cities and towns
+- **feat**: Add Moroccan phone number generation (06/07 prefixes)
+- **feat**: Add authentic Moroccan email domains (menara.ma, iam.ma, orange.ma)
+- **feat**: Add Moroccan CNI number generation (2 letters + 6 digits)
+- **feat**: Add Moroccan bank account generation with MA prefix
+- **feat**: Add 5-digit Moroccan postal codes
+- **feat**: Add Moroccan company name generation with authentic patterns
+- **feat**: Add all 12 Moroccan administrative regions
+- **feat**: Add 12 major Moroccan universities with full names
+- **feat**: Add 20+ famous Moroccan neighborhoods and districts
+- **feat**: Add 25+ Moroccan medical specialties (perfect for DabaDoc)
+- **feat**: Add common Moroccan professions
+- **feat**: Add 15+ traditional Moroccan dishes (couscous, tagine, pastilla, etc.)
+- **feat**: Add 20+ Moroccan spices and ingredients (ras-el-hanout, safran, etc.)
+- **feat**: Add 15+ famous Moroccan souks and markets
+- **feat**: Add all major Moroccan banks (Attijariwafa, BCP, BMCI, etc.)
+- **feat**: Add famous Moroccan restaurants and cafés
+- **feat**: Add Moroccan hotels and traditional riads
+- **feat**: Add famous Moroccan mosques (Hassan II, Koutoubia, etc.)
+- **feat**: Add Moroccan schools and educational institutions
+- **feat**: Add Moroccan newspapers and media outlets
+- **feat**: Add major Moroccan festivals and cultural events
+- **feat**: Add automated changelog generation with git-cliff
+- **feat**: Add comprehensive Rake tasks for development and release
+- **feat**: Add conventional commit support
+- **feat**: Add MIT license
+- **feat**: Add extensive documentation and examples
+
+### Miscellaneous Tasks
+- **chore**: Set up project structure with proper Ruby gem conventions
+- **chore**: Configure git-cliff for automated changelog generation
+- **chore**: Add comprehensive Rakefile with development and release tasks
+- **chore**: Create executable changelog generation script
+- **chore**: Add demo script showcasing gem capabilities
+- **chore**: Configure git repository with proper .gitignore

data/README.md

@@ -0,0 +1,210 @@
+# Zayef 🔥
+
+A Ruby gem for generating fake data with a Moroccan touch. Perfect for testing and development!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zayef'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install zayef
+
+## Usage
+
+```ruby
+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"
+```
+
+## Features
+
+### 🎯 **Personal Information**
+- 🏠 **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
+
+### 🏢 **Professional & Business**
+- 👨‍⚕️ **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.)
+
+### 🎓 **Education & Culture**
+- 🗺️ **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.)
+
+### 🍽️ **Culture & Lifestyle**
+- 🍲 **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
+
+### 📊 **Statistics**
+- **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
+
+## Development
+
+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.
+
+### 📝 Automated Changelog
+
+Zayef uses [git-cliff](https://github.com/orhun/git-cliff) for automated changelog generation based on conventional commits.
+
+#### Installation
+
+Install git-cliff:
+```bash
+# Using cargo (recommended)
+cargo install git-cliff
+
+# Or using homebrew (macOS)
+brew install git-cliff
+
+# Or download from GitHub releases
+```
+
+#### Usage
+
+```bash
+# 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
+```
+
+#### Conventional Commits
+
+Use conventional commit format for better changelog organization:
+
+```bash
+# 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"
+```
+
+### 🚀 Release Process
+
+Zayef includes automated release tasks:
+
+```bash
+# Prepare release (generate changelog, bump version)
+rake release:prepare
+
+# Publish to RubyGems.org
+rake release:publish
+
+# Full release process
+rake release:full
+```
+
+### 📋 Development Tasks
+
+```bash
+# Run all quality checks
+rake
+
+# Generate documentation
+rake dev:docs
+
+# Create conventional commit interactively
+rake git:commit
+
+# Check changelog generation
+rake changelog:check
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amqor/zayef.
+
+### 📝 Contributing Guidelines
+
+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
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/clean"
+
+# Changelog tasks
+namespace :changelog do
+  desc "Generate changelog for unreleased changes"
+  task :unreleased do
+    sh "./bin/generate-changelog --unreleased"
+  end
+
+  desc "Generate changelog for latest version"
+  task :latest do
+    sh "./bin/generate-changelog --latest"
+  end
+
+  desc "Generate full changelog"
+  task :full do
+    sh "./bin/generate-changelog"
+  end
+
+  desc "Check if git-cliff is available"
+  task :check do
+    if system("git-cliff --version > /dev/null 2>&1")
+      puts "✅ git-cliff is available"
+    else
+      puts "❌ git-cliff is not installed"
+      puts "Run: cargo install git-cliff"
+    end
+  end
+end
+
+# Release tasks
+namespace :release do
+  desc "Prepare for release (generate changelog, bump version, commit)"
+  task :prepare do
+    puts "🚀 Preparing release..."
+
+    # Check git status
+    unless system("git diff --quiet")
+      puts "❌ Working directory is not clean. Commit or stash changes first."
+      exit 1
+    end
+
+    # Generate changelog
+    puts "📝 Generating changelog..."
+    sh "./bin/generate-changelog --unreleased"
+
+    # Ask for version bump type
+    puts "📋 Choose version bump:"
+    puts "  1. patch (0.1.0 -> 0.1.1)"
+    puts "  2. minor (0.1.0 -> 0.2.0)"
+    puts "  3. major (0.1.0 -> 1.0.0)"
+    print "Enter choice (1-3): "
+
+    choice = STDIN.gets.chomp
+    bump_type = case choice
+                when "1" then "patch"
+                when "2" then "minor"
+                when "3" then "major"
+                else
+                  puts "❌ Invalid choice"
+                  exit 1
+                end
+
+    puts "🔄 Bumping version (#{bump_type})..."
+    sh "gem bump --version #{bump_type}"
+
+    puts "✅ Release preparation complete!"
+    puts "📋 Next steps:"
+    puts "  1. Review the generated CHANGELOG.md"
+    puts "  2. Run: rake release:publish"
+  end
+
+  desc "Publish gem to RubyGems.org"
+  task :publish do
+    puts "📦 Publishing gem to RubyGems.org..."
+
+    # Build the gem
+    sh "gem build zayef.gemspec"
+
+    # Get the gem filename
+    version = File.read("lib/zayef/version.rb").match(/VERSION = "(.+)"/)[1]
+    gem_file = "zayef-#{version}.gem"
+
+    unless File.exist?(gem_file)
+      puts "❌ Gem file #{gem_file} not found"
+      exit 1
+    end
+
+    # Push to RubyGems
+    sh "gem push #{gem_file}"
+
+    puts "✅ Gem published successfully!"
+    puts "🎉 Zayef v#{version} is now live on RubyGems.org!"
+  end
+
+  desc "Full release process (prepare + publish)"
+  task full: [:prepare, :publish]
+end
+
+# Development tasks
+namespace :dev do
+  desc "Run tests and linting"
+  task :test do
+    puts "🧪 Running tests..."
+    # Add test commands here when tests are added
+    puts "✅ Tests complete"
+  end
+
+  desc "Generate documentation"
+  task :docs do
+    puts "📚 Generating documentation..."
+    sh "yardoc lib/**/*.rb"
+  end
+
+  desc "Check code quality"
+  task quality: [:test, :docs] do
+    puts "✅ Code quality checks complete"
+  end
+end
+
+# Git tasks
+namespace :git do
+  desc "Create conventional commit"
+  task :commit do
+    puts "📝 Creating conventional commit..."
+    puts "Available commit types:"
+    puts "  feat:     A new feature"
+    puts "  fix:      A bug fix"
+    puts "  docs:     Documentation only changes"
+    puts "  style:    Changes that do not affect the meaning of the code"
+    puts "  refactor: A code change that neither fixes a bug nor adds a feature"
+    puts "  perf:     A code change that improves performance"
+    puts "  test:     Adding missing tests or correcting existing tests"
+    puts "  chore:    Changes to the build process or auxiliary tools"
+
+    print "Enter commit type: "
+    type = STDIN.gets.chomp
+
+    print "Enter scope (optional): "
+    scope = STDIN.gets.chomp
+    scope = "(#{scope})" unless scope.empty?
+
+    print "Enter commit message: "
+    message = STDIN.gets.chomp
+
+    full_message = "#{type}#{scope}: #{message}"
+    sh "git add ."
+    sh "git commit -m '#{full_message}'"
+
+    puts "✅ Commit created: #{full_message}"
+  end
+end
+
+# Default task
+task default: ["changelog:check", "dev:quality"]
+
+# Clean up generated files
+CLEAN.include("*.gem", "CHANGELOG.md", "doc/")

data/cliff.toml

@@ -0,0 +1,65 @@
+# git-cliff configuration file
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+body = """
+{%- if version %}\
+    ## [{{ version | trim_start(matches="(v|V)") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{%- else -%}
+    ## [unreleased]
+{%- endif %}\
+
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}**{{commit.scope}}**: {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}
+    {%- endfor -%}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/amqor/zayef/pull/${2}))"},
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^refactor", group = "Refactoring"},
+    { message = "^style", group = "Styling"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore\\(release\\): prepare for", skip = true},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { body = ".*security", group = "Security"},
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "v[0-9]*"
+# regex for skipping tags
+skip_tags = "v0.1.0-beta.1"
+# regex for ignoring tags
+ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"

data/demo.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require './lib/zayef'
+
+puts '🚀 ZAYEF - Moroccan Data Generator Demo 🚀'
+puts '=' * 60
+
+# Show that quotes work correctly
+puts '📋 Sample Data with Quoted Names & Cities:'
+puts ''
+
+3.times do |i|
+  puts "Sample #{i+1}:"
+  puts "  Name: #{Zayef.name}"
+  puts "  City: #{Zayef.city}"
+  puts "  Email: #{Zayef.email}"
+  puts "  Specialty: #{Zayef.medical_specialty}"
+  puts "  Dish: #{Zayef.traditional_dish}"
+  puts "  Bank: #{Zayef.bank}"
+  puts ''
+end
+
+puts '✅ MOROCCAN_LAST_NAMES and MOROCCAN_CITIES now have quotes!'
+puts '✅ All 300+ Moroccan data entries working perfectly!'
+puts '=' * 60