chore: init commit

Author: sadegh19b

LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2025 Sadegh Barzegar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+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. 

README.md

@@ -0,0 +1,96 @@
+# Iran Provinces and Cities for Laravel
+
+A Laravel package for Iran provinces and cities seeder and models.
+
+_Supports Laravel 8 to 12._
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require sadegh19b/laravel-iran-cities
+```
+
+## Quick Start
+
+1. Generate models, migrations, and seeder:
+```bash
+php artisan iran-cities:generate --all
+```
+
+2. Run migrations:
+```bash
+php artisan migrate
+```
+
+3. Run the seeder:
+```bash
+php artisan db:seed --class="Database\Seeders\IranProvincesAndCitiesSeeder"
+```
+
+4. Use the models:
+```php
+use App\Models\Province;
+use App\Models\City;
+
+// Get all provinces
+$provinces = Province::all();
+
+// Get cities of a province
+$province = Province::find(1);
+$cities = $province->cities;
+```
+
+## Generate Stubs
+
+### Generate All
+
+To generate models, migrations, and seeder:
+
+```bash
+php artisan iran-cities:generate --all
+```
+
+### Generate Specific
+
+You can also generate specific files:
+
+```bash
+php artisan iran-cities:generate --models
+php artisan iran-cities:generate --migrations
+php artisan iran-cities:generate --seeder
+```
+
+## Usage
+
+### Get All Provinces or Cities
+
+```php
+use App\Models\Province;
+
+$provinces = Province::all();
+$cities = City::all();
+```
+
+### Get Cities of a Province
+
+```php
+use App\Models\Province;
+
+$province = Province::find(1);
+$cities = $province->cities;
+```
+
+### Get Province of a City
+
+```php
+use App\Models\City;
+
+$city = City::find(1);
+$province = $city->province;
+```
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,29 @@
+{
+    "name": "sadegh19b/laravel-iran-cities",
+    "description": "A Laravel package for Iran provinces and cities seeder and models",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Sadegh Barzegar",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "dev",
+    "autoload": {
+        "psr-4": {
+            "Sadegh19b\\LaravelIranCities\\": "src/"
+        }
+    },
+    "require": {
+        "php": "^8.0",
+        "illuminate/support": "^8.0|^9.0|^10.0|^11.0|^12.0"
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Sadegh19b\\LaravelIranCities\\LaravelIranCitiesServiceProvider"
+            ]
+        }
+    }
+}

src/Commands/GenerateCommand.php

@@ -0,0 +1,173 @@
+<?php
+
+namespace Sadegh19b\LaravelIranCities\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\File;
+
+class GenerateCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'iran-cities:generate
+                            {--models : Generate Province and City models}
+                            {--migrations : Generate migrations for provinces and cities tables}
+                            {--seeder : Generate Iran Provinces and Cities seeder}
+                            {--all : Generate all files (models, migrations, and seeders)}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Generate Iran Provinces and Cities models, migrations, and seeders';
+
+    private $modelNamespace = 'App\\Models';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle()
+    {
+        if ($this->option('all')) {
+            $this->makeModels();
+            $this->makeMigrations();
+            $this->makeSeeder();
+            
+            $this->info('All Province City files have been generated.');
+            return;
+        }
+
+        if ($this->option('models')) {
+            $this->makeModels();
+        }
+
+        if ($this->option('migrations')) {
+            $this->makeMigrations();
+        }
+
+        if ($this->option('seeder')) {
+            $this->makeSeeder();
+        }
+
+        if (!$this->option('models') && !$this->option('migrations') && !$this->option('seeder')) {
+            $this->error('Please specify what to generate (--model, --migration, --seeder, or --all)');
+        }
+    }
+
+    /**
+     * Generate models from stubs.
+     *
+     * @return void
+     */
+    protected function makeModels(): void
+    {
+        $this->info('Generating Province and City models...');
+
+        // Generate Province model
+        $this->generateFromStub(
+            $this->findStub('models/Province.stub'),
+            app_path('Models/Province.php'),
+            ['{{ namespace }}' => $this->modelNamespace]
+        );
+        
+        // Generate City model
+        $this->generateFromStub(
+            $this->findStub('models/City.stub'),
+            app_path('Models/City.php'),
+            ['{{ namespace }}' => $this->modelNamespace]
+        );
+
+        $this->info('Models generated successfully.');
+    }
+
+    /**
+     * Generate migrations from stubs.
+     *
+     * @return void
+     */
+    protected function makeMigrations(): void
+    {
+        $this->info('Generating migrations...');
+        
+        // Generate provinces migration
+        $provincesTimestamp = date('Y_m_d_His');
+        $this->generateFromStub(
+            $this->findStub('migrations/create_provinces_table.stub'),
+            database_path("migrations/{$provincesTimestamp}_create_provinces_table.php"),
+            ['{{ model_namespace }}' => $this->modelNamespace]
+        );
+        
+        // Generate cities migration with a timestamp 1 second later
+        sleep(1);
+        $citiesTimestamp = date('Y_m_d_His');
+        $this->generateFromStub(
+            $this->findStub('migrations/create_cities_table.stub'),
+            database_path("migrations/{$citiesTimestamp}_create_cities_table.php"),
+            ['{{ model_namespace }}' => $this->modelNamespace]
+        );
+
+        $this->info('Migrations generated successfully.');
+    }
+
+    /**
+     * Generate seeder from stub.
+     *
+     * @return void
+     */
+    protected function makeSeeder(): void
+    {
+        $this->info('Generating IranProvincesAndCitiesSeeder...');
+
+        $this->generateFromStub(
+            $this->findStub('seeders/IranProvincesAndCitiesSeeder.stub'),
+            database_path('seeders/IranProvincesAndCitiesSeeder.php'),
+            [
+                '{{ model_namespace }}' => $this->modelNamespace
+            ]
+        );
+
+        $this->info('Seeder generated successfully.');
+    }
+
+    /**
+     * Find the stub file path.
+     *
+     * @param string $stubName
+     * @return string
+     */
+    protected function findStub(string $stubName): string
+    {
+        $customPath = base_path("stubs/vendor/sadegh19b/laravel-iran-cities/src/stubs/{$stubName}");
+        
+        if (File::exists($customPath)) {
+            return $customPath;
+        }
+        
+        return __DIR__ . "/../stubs/{$stubName}";
+    }
+
+    /**
+     * Generate a file from a stub.
+     *
+     * @param string $stubPath
+     * @param string $targetPath
+     * @param array $replacements
+     * @return void
+     */
+    protected function generateFromStub(string $stubPath, string $targetPath, array $replacements): void
+    {
+        $content = File::get($stubPath);
+        
+        foreach ($replacements as $search => $replace) {
+            $content = str_replace($search, $replace, $content);
+        }
+        
+        File::put($targetPath, $content);
+        
+        $this->line("Created: " . $targetPath);
+    }
+} 

src/LaravelIranCitiesServiceProvider.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Sadegh19b\LaravelIranCities;
+
+use Illuminate\Support\ServiceProvider;
+use Sadegh19b\LaravelIranCities\Commands\GenerateCommand;
+
+class LaravelIranCitiesServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     */
+    public function register(): void
+    {
+        //
+    }
+
+    /**
+     * Bootstrap services.
+     */
+    public function boot(): void
+    {
+        // Register commands
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                GenerateCommand::class,
+            ]);
+        }
+    }
+} 

src/stubs/migrations/create_cities_table.stub

@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    public function up(): void
+    {
+        Schema::create('cities', function (Blueprint $table): void {
+            $table->id();
+            $table->string('name');
+            $table->foreignId('province_id')->constrained()->cascadeOnDelete();
+            $table->timestamps();
+        });
+    }
+    
+    public function down(): void
+    {
+        Schema::dropIfExists('cities');
+    }
+};