zayef 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec36e9eb4ae50aaddeceec5f5a26d6de587815080b5e7f3377d817bf4d363b11
-  data.tar.gz: 6e508fbad03aa8f2c729f3f1a36ab0c99f8bb8cb9d797c65de1b6828e68537ac
+  metadata.gz: 565621873c8f06c24474847a9239b7babec6ac143af0efde3e7d42cf093925a4
+  data.tar.gz: 78b62ab7e1e9d3df2f9ae6a2941f02557544d12da9ec5c4b742d23d4a2fe6f3c
 SHA512:
-  metadata.gz: d53a109a4739104bf9fab3ed54156e6aa91080d7e0daa7e69b63d7075f511daab4e48d4b21d93ea544fb1c47ca9d733e9f1611382f800abbd410b6ad56e6ea02
-  data.tar.gz: f002dbb520af617f3737c5cf9606c6acd29076f6cdcc9764f447704d3e7c8956229bb21a4f5544702a833f407a02e9d51b7eb5d5fc75ee2c31f661d8965d6282
+  metadata.gz: cafc0e782d7a28ad2d9e9c5d69f13ee209b54ed4733263ff2b242ceb4ffa688b5b3f1c25b000347bd08f655963f1a75168e4c582c7fe52ee752fe4ed390f419d
+  data.tar.gz: 81db1d298f9006987db408fdbb2dfe9a635902f90aaf3177ffc73ad50bc7f5e7c238316c20e2176efe310657f5d3aee4fd44d783212558f44a02d77a01b89006

data/.rspec

@@ -0,0 +1,6 @@
+--require spec_helper
+--color
+--format documentation
+--order random
+
+

data/.rspec_status

@@ -0,0 +1,71 @@
+example_id                                 | status | run_time        |
+------------------------------------------ | ------ | --------------- |
+./spec/zayef/generator_spec.rb[1:1:1]      | passed | 0.00023 seconds |
+./spec/zayef/generator_spec.rb[1:1:2]      | passed | 0.00011 seconds |
+./spec/zayef/generator_spec.rb[1:2:1]      | passed | 0.00006 seconds |
+./spec/zayef/generator_spec.rb[1:2:2]      | passed | 0.00005 seconds |
+./spec/zayef/generator_spec.rb[1:3:1]      | passed | 0.00007 seconds |
+./spec/zayef/generator_spec.rb[1:3:2]      | passed | 0.00026 seconds |
+./spec/zayef/generator_spec.rb[1:4:1]      | passed | 0.00152 seconds |
+./spec/zayef/generator_spec.rb[1:4:2]      | passed | 0.00015 seconds |
+./spec/zayef/generator_spec.rb[1:4:3]      | passed | 0.0001 seconds  |
+./spec/zayef/generator_spec.rb[1:4:4:1]    | passed | 0.00008 seconds |
+./spec/zayef/generator_spec.rb[1:5:1]      | passed | 0.00096 seconds |
+./spec/zayef/generator_spec.rb[1:5:2]      | passed | 0.00009 seconds |
+./spec/zayef/generator_spec.rb[1:6:1]      | passed | 0.00006 seconds |
+./spec/zayef/generator_spec.rb[1:6:2]      | passed | 0.00011 seconds |
+./spec/zayef/generator_spec.rb[1:7:1]      | passed | 0.00007 seconds |
+./spec/zayef/generator_spec.rb[1:7:2]      | passed | 0.00008 seconds |
+./spec/zayef/generator_spec.rb[1:7:3]      | passed | 0.00007 seconds |
+./spec/zayef/generator_spec.rb[1:8:1]      | passed | 0.00036 seconds |
+./spec/zayef/generator_spec.rb[1:8:2]      | passed | 0.00009 seconds |
+./spec/zayef/generator_spec.rb[1:9:1]      | passed | 0.00069 seconds |
+./spec/zayef/generator_spec.rb[1:9:2]      | passed | 0.0007 seconds  |
+./spec/zayef/generator_spec.rb[1:10:1]     | passed | 0.00393 seconds |
+./spec/zayef/generator_spec.rb[1:10:2]     | passed | 0.00008 seconds |
+./spec/zayef/generator_spec.rb[1:11:1]     | passed | 0.00006 seconds |
+./spec/zayef/generator_spec.rb[1:11:2]     | passed | 0.00008 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:1:1]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:1:2]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:1:3]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:2:1]  | passed | 0.00006 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:2:2]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:3:1]  | passed | 0.00006 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:3:2]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:4:1]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:4:2]  | passed | 0.00006 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:4:3]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:5:1]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:5:2]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:6:1]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:6:2]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:6:3]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:7:1]  | passed | 0.00008 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:7:2]  | passed | 0.00006 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:8:1]  | passed | 0.00006 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:8:2]  | passed | 0.00006 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:9:1]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:9:2]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:9:3]  | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:10:1] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:10:2] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:11:1] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:11:2] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:12:1] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:12:2] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:13:1] | passed | 0.00006 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:13:2] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:14:1] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:14:2] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:15:1] | passed | 0.00005 seconds |
+./spec/zayef/moroccan_data_spec.rb[1:15:2] | passed | 0.00013 seconds |
+./spec/zayef_spec.rb[1:1:1]                | passed | 0.0008 seconds  |
+./spec/zayef_spec.rb[1:2:1]                | passed | 0.00014 seconds |
+./spec/zayef_spec.rb[1:2:2]                | passed | 0.00013 seconds |
+./spec/zayef_spec.rb[1:2:3]                | passed | 0.00029 seconds |
+./spec/zayef_spec.rb[1:2:4]                | passed | 0.00011 seconds |
+./spec/zayef_spec.rb[1:3:1]                | passed | 0.00008 seconds |
+./spec/zayef_spec.rb[1:3:2]                | passed | 0.00009 seconds |
+./spec/zayef_spec.rb[1:4:1]                | passed | 0.00011 seconds |
+./spec/zayef_spec.rb[1:4:2]                | passed | 0.00011 seconds |
+./spec/zayef_spec.rb[1:5:1]                | passed | 0.00099 seconds |

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - 'log/**/*'
+    - 'coverage/**/*'
+    - 'spec/fixtures/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/NestedGroups:
+  Max: 4

data/.simplecov

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/vendor/'
+  add_filter '/tmp/'
+
+  add_group 'Libraries', 'lib/'
+
+  minimum_coverage 90
+  maximum_coverage_drop 5
+
+  # Exclude files that don't need coverage
+  add_filter do |source_file|
+    source_file.filename =~ /version\.rb$/
+  end
+end
+
+

data/CHANGELOG.md

@@ -5,6 +5,38 @@ 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.2.0] - 2025-09-23
+
+### Features
+- **feat**: Complete refactoring following "Less Code, Better Result" philosophy
+- **feat**: Generic helper methods (`pick`, `random_number`, `random_code`, `weighted_pick`)
+- **feat**: External data files for maintainability (JSON format)
+- **feat**: Data loader module with caching and error handling
+- **feat**: Parameterized profile generation with constraints (age, gender, city)
+- **feat**: Consistent data generation (city-district matching, email consistency)
+- **feat**: Weighted sampling for realistic distributions
+- **feat**: Streaming support for large datasets (JSON/CSV)
+- **feat**: Modern Ruby with keyword arguments and safe navigation
+- **feat**: Performance improvements with cached data loading
+
+### Improvements
+- **refactor**: Eliminated repetitive `.sample` calls with generic helpers
+- **refactor**: Moved data constants to external JSON files
+- **refactor**: Added parameterization support for all major methods
+- **refactor**: Improved consistency across all data generation methods
+- **refactor**: Better error handling and fallback mechanisms
+
+### Breaking Changes
+- Some method signatures changed to support keyword parameters
+- Data constants moved from code to external JSON files
+- Profile methods now return more consistent data structures
+
+## [0.1.1] - 2025-09-17
+
+### Features
+- **feat**: Enhanced gem description with Moroccan flag emoji and Arabic text
+- **feat**: Improved presentation and marketing copy for RubyGems.org
+
 ## [0.1.0] - 2025-09-17
 
 ### Features

data/CONTRIBUTING.md

@@ -0,0 +1,281 @@
+# Contributing to Zayef 🔥
+
+Thank you for your interest in contributing to Zayef! This document provides guidelines and information for contributors.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Development Workflow](#development-workflow)
+- [Testing](#testing)
+- [Code Style](#code-style)
+- [Submitting Changes](#submitting-changes)
+- [Reporting Issues](#reporting-issues)
+- [Documentation](#documentation)
+
+## Code of Conduct
+
+This project follows a code of conduct to ensure a welcoming environment for all contributors. By participating, you agree to:
+
+- Be respectful and inclusive
+- Focus on constructive feedback
+- Accept responsibility for mistakes
+- Show empathy towards other contributors
+- Help create a positive community
+
+## Getting Started
+
+### Prerequisites
+
+- Ruby 2.7+ (check version with `ruby -v`)
+- Bundler (`gem install bundler`)
+- Git
+
+### Quick Setup
+
+1. Fork the repository on GitHub
+2. Clone your fork:
+   ```bash
+   git clone https://github.com/your-username/zayef.git
+   cd zayef
+   ```
+3. Set up the development environment:
+   ```bash
+   bin/setup
+   ```
+4. Verify everything works:
+   ```bash
+   bundle exec ruby demo.rb
+   ```
+
+## Development Setup
+
+### Installing Dependencies
+
+```bash
+bundle install
+```
+
+### Available Development Tasks
+
+Zayef uses Rake for development tasks. Run `rake -T` to see all available tasks:
+
+```bash
+# Run all quality checks (tests, docs, etc.)
+rake
+
+# Run tests
+rake dev:test
+
+# Generate documentation
+rake dev:docs
+
+# Check code quality
+rake dev:quality
+
+# Generate changelog
+rake changelog:full
+
+# Check if git-cliff is available
+rake changelog:check
+
+# Create conventional commit interactively
+rake git:commit
+```
+
+## Development Workflow
+
+### 1. Choose an Issue
+
+- Check existing [issues](https://github.com/amqor/zayef/issues) on GitHub
+- Look for issues labeled `good first issue` or `help wanted`
+- Comment on the issue to indicate you're working on it
+
+### 2. Create a Feature Branch
+
+```bash
+# Create and switch to a new branch
+git checkout -b feature/your-feature-name
+
+# Or for bug fixes
+git checkout -b fix/issue-number-description
+```
+
+### 3. Make Your Changes
+
+- Write tests first (TDD approach)
+- Follow the existing code style
+- Add documentation for new features
+- Ensure all tests pass
+
+### 4. Test Your Changes
+
+```bash
+# Run the full test suite
+rake dev:test
+
+# Run specific tests
+bundle exec rspec spec/path/to/test.rb
+
+# Run the demo to verify functionality
+bundle exec ruby demo.rb
+```
+
+## Testing
+
+### Running Tests
+
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run specific test file
+bundle exec rspec spec/zayef/generator_spec.rb
+
+# Run with coverage
+bundle exec rspec --coverage
+```
+
+### Writing Tests
+
+- Place test files in `spec/` directory
+- Use descriptive test names
+- Test both positive and negative scenarios
+- Include edge cases
+
+Example test structure:
+```ruby
+RSpec.describe Zayef::Generator do
+  describe '#first_name' do
+    it 'returns a Moroccan first name' do
+      name = Zayef.first_name
+      expect(Zayef::Generator::MOROCCAN_FIRST_NAMES).to include(name)
+    end
+  end
+end
+```
+
+## Code Style
+
+### Ruby Style Guidelines
+
+- Follow the [Ruby Style Guide](https://rubystyle.guide/)
+- Use 2 spaces for indentation (no tabs)
+- Keep lines under 80 characters when possible
+- Use meaningful variable and method names
+- Add comments for complex logic
+
+### Commit Messages
+
+This project uses [Conventional Commits](https://conventionalcommits.org/):
+
+```bash
+# Features
+git commit -m "feat: add support for traditional Moroccan dishes"
+
+# Bug fixes
+git commit -m "fix: correct CNI number format validation"
+
+# Documentation
+git commit -m "docs: update README with new usage examples"
+
+# Breaking changes
+git commit -m "feat!: change API interface (breaking change)"
+
+# With scope
+git commit -m "feat(generator): add support for new data categories"
+```
+
+### Code Organization
+
+- Keep methods small and focused
+- Use private methods for internal logic
+- Group related functionality in modules/classes
+- Add YARD documentation comments
+
+## Submitting Changes
+
+### Pull Request Process
+
+1. **Update Documentation**: Update README.md and any relevant documentation
+2. **Update Changelog**: Add an entry to CHANGELOG.md (use `rake changelog:unreleased`)
+3. **Test Thoroughly**: Ensure all tests pass and add new tests for your changes
+4. **Update Version**: If making breaking changes, update version in `lib/zayef/version.rb`
+
+### Pull Request Template
+
+When submitting a PR, include:
+
+- **Description**: What changes were made and why
+- **Type of Change**: Bug fix, feature, documentation, etc.
+- **Breaking Changes**: Any breaking changes and migration guide
+- **Testing**: How the changes were tested
+- **Screenshots**: If UI changes were made
+
+### Review Process
+
+- All PRs require review before merging
+- Address review comments promptly
+- Keep discussions focused and productive
+- Be open to feedback and suggestions
+
+## Reporting Issues
+
+### Bug Reports
+
+When reporting bugs, please include:
+
+- **Ruby Version**: `ruby -v`
+- **Gem Version**: `gem list zayef`
+- **OS**: Operating system and version
+- **Steps to Reproduce**: Clear, minimal steps to reproduce the issue
+- **Expected Behavior**: What you expected to happen
+- **Actual Behavior**: What actually happened
+- **Error Messages**: Any error messages or stack traces
+
+### Feature Requests
+
+For feature requests, please provide:
+
+- **Use Case**: Describe the problem you're trying to solve
+- **Proposed Solution**: How you think it should work
+- **Alternatives**: Other solutions you've considered
+- **Additional Context**: Screenshots, examples, or references
+
+## Documentation
+
+### Types of Documentation
+
+1. **README.md**: User-facing documentation
+2. **CHANGELOG.md**: Version history and changes
+3. **Code Comments**: YARD-style comments in the code
+4. **Inline Documentation**: Comments explaining complex logic
+
+### Documentation Standards
+
+- Use clear, simple language
+- Include code examples where helpful
+- Keep documentation up to date with code changes
+- Test documentation examples
+
+### Generating Documentation
+
+```bash
+# Generate YARD documentation
+rake dev:docs
+
+# View documentation
+open doc/index.html
+```
+
+## Recognition
+
+Contributors will be recognized in:
+- CHANGELOG.md for their contributions
+- Git history
+- Future release announcements
+
+Thank you for contributing to Zayef! Your help makes this project better for everyone. 🇲🇦
+
+