config-to-laravel-migrations 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 445b9a57f87e670eaecebe7422575d32b999097a84baf4e675cad5e69f629fd1
+  data.tar.gz: 0352ec7a738ae9c6f08a512ccce501b0727c87ce5c19d290ef637428d1fda4a2
+SHA512:
+  metadata.gz: 45068758acf80f56a4c4e04b26ec60a43da633acc94fa794857c5fc9b9a84e511edd7d14d0d99ef5fdf0f5eac0529e329fb67fefe08ca89fac8e252e085eec6a
+  data.tar.gz: 37d0a7127ea892b784496955ff0b09309f7f3295c6d250f99a7de6c3ed8333573ab7e99c9a10640b20c6867693dc334bb1a655d5d646891ebb50afd009482af3

data/README.md

@@ -0,0 +1,230 @@
+# Configurator
+
+### Available for hire email | suwilanji@inongo.space. Linked In Suwilanji Chipofya
+
+**Configurator** is a command-line tool that generates Laravel Eloquent migrations from YAML or JSON configuration files. It simplifies the process of defining database schemas and automates the creation of migration files for Laravel applications.
+
+---
+
+## Features
+
+- **Supports Multiple Formats**: Works with YAML and JSON configuration files.
+- **Customizable**: Define table names, columns, data types, and constraints in a simple configuration file.
+- **Scalable**: Generates migrations for multiple tables and relationships.
+- **Error Handling**: Provides clear warnings and skips invalid configurations.
+
+---
+
+## Installation
+
+### 1. Install Ruby
+
+Ensure you have Ruby installed on your system. You can check your Ruby version by running:
+
+```bash
+ruby -v
+```
+
+If Ruby is not installed, follow the official [Ruby installation guide](https://www.ruby-lang.org/en/documentation/installation/).
+
+### 2. Install the Gem
+
+You can install the `configurator` gem directly from the source:
+
+```bash
+gem install configurator
+```
+
+Alternatively, clone the repository and build the gem locally:
+
+```bash
+git clone https://github.com/suwi-lanji/configurator.git
+cd configurator
+gem build configurator.gemspec
+gem install configurator-1.0.0.gem
+```
+
+---
+
+## Usage
+
+### 1. Create a Configuration File
+
+Define your database schema in a YAML or JSON file. Here’s an example `school_managementsystem.yml` file:
+
+```yaml
+User:
+  table_name: users
+  attributes:
+    user_id: { type: int, primary_key: true }
+    username: { type: string, unique: true }
+    password_hash: { type: string }
+    email: { type: string, unique: true }
+    role_id: { type: int, foreign_key: roles.role_id }
+    institution_id: { type: int, foreign_key: institutions.institution_id }
+
+Role:
+  table_name: roles
+  attributes:
+    role_id: { type: int, primary_key: true }
+    role_name: { type: string, unique: true }
+```
+
+### 2. Generate Migrations
+
+Run the `configurator` command with your configuration file:
+
+```bash
+configurator generate school_managementsystem.yml migrations
+```
+
+This will generate Laravel migration files in the `migrations` directory.
+
+---
+
+## Example Output
+
+For the above configuration, the tool will generate the following files:
+
+#### `migrations/20250210120000_create_users_table.php`
+
+```php
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateUserTable extends Migration
+{
+    public function up()
+    {
+        Schema::create('users', function (Blueprint $table) {
+            $table->id();
+            $table->integer('user_id');
+            $table->string('username')->unique();
+            $table->string('password_hash');
+            $table->string('email')->unique();
+            $table->integer('role_id');
+            $table->foreignId('institution_id');
+            $table->timestamps();
+        });
+    }
+
+    public function down()
+    {
+        Schema::dropIfExists('users');
+    }
+}
+```
+
+#### `migrations/20250210120001_create_roles_table.php`
+
+```php
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateRoleTable extends Migration
+{
+    public function up()
+    {
+        Schema::create('roles', function (Blueprint $table) {
+            $table->id();
+            $table->integer('role_id');
+            $table->string('role_name')->unique();
+            $table->timestamps();
+        });
+    }
+
+    public function down()
+    {
+        Schema::dropIfExists('roles');
+    }
+}
+```
+
+---
+
+## Configuration File Format
+
+### YAML Format
+
+```yaml
+ModelName:
+  table_name: table_name
+  attributes:
+    column_name:
+      type: data_type
+      primary_key: true/false
+      unique: true/false
+      foreign_key: referenced_table.referenced_column
+```
+
+### JSON Format
+
+```json
+{
+  "ModelName": {
+    "table_name": "table_name",
+    "attributes": {
+      "column_name": {
+        "type": "data_type",
+        "primary_key": true/false,
+        "unique": true/false,
+        "foreign_key": "referenced_table.referenced_column"
+      }
+    }
+  }
+}
+```
+
+---
+
+## Supported Data Types
+
+The following data types are supported:
+
+- `int` → `integer`
+- `string` → `string`
+- `date` → `date`
+- `datetime` → `datetime`
+- `float` → `float`
+- `enum` → `enum`
+
+---
+
+## Contributing
+
+Contributions are welcome! Follow these steps to contribute:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Commit your changes and push to the branch.
+4. Submit a pull request.
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Support
+
+If you encounter any issues or have questions, please open an issue on the [GitHub repository](https://github.com/suwi-lanji/configurator/issues).
+
+---
+
+## Author
+
+- **Suwilanji Jack Chipofya**  
+  GitHub: [suwi-lanji](https://github.com/suwi-lanji)  
+  Email: suwilanji@inongo.space
+
+---
+
+Enjoy using **Configurator**! 🚀

data/bin/configurator

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Ensure the lib directory is in the load path
+$:.unshift File.expand_path('../lib', __dir__)
+
+require 'configurator/cli'
+
+Configurator::CLI.start(ARGV)

data/lib/configurator/cli.rb

@@ -0,0 +1,16 @@
+require 'thor'
+require 'configurator/generator'
+require 'configurator/version'
+module Configurator
+  class CLI < Thor
+    desc "generate FILE OUTPUT_DIR", "Generate Laravel migrations from a YAML or JSON file"
+    def generate(file, output_dir)
+      Generator.new(file, output_dir).generate_migrations
+    end
+
+    desc "version", "Print the version"
+    def version
+      puts Configurator::VERSION
+    end
+  end
+end

data/lib/configurator/generator.rb

@@ -0,0 +1,122 @@
+require 'yaml'
+require 'json'
+require 'fileutils'
+
+module Configurator
+  class Generator
+    DATA_TYPE_MAPPING = {
+      'int' => 'integer',
+      'string' => 'string',
+      'date' => 'date',
+      'datetime' => 'datetime',
+      'float' => 'float',
+      'enum' => 'enum'
+    }
+
+    def initialize(file, output_dir)
+      @file = file
+      @config = load_config(file)
+      @migrations_dir = output_dir
+      validate_config!
+    end
+
+    def generate_migrations
+      FileUtils.mkdir_p(@migrations_dir)
+
+      @config.each do |model, details|
+        table_name = details["table_name"]
+        attributes = details["attributes"]
+
+        unless attributes
+          puts "Warning: No attributes found for model '#{model}'. Skipping."
+          next
+        end
+
+        timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+        migration_file = "#{@migrations_dir}/#{timestamp}_create_#{table_name}_table.php"
+
+        File.open(migration_file, 'w') do |file|
+          file.write <<~PHP
+            <?php
+
+            use Illuminate\\Database\\Migrations\\Migration;
+            use Illuminate\\Database\\Schema\\Blueprint;
+            use Illuminate\\Support\\Facades\\Schema;
+
+            class Create#{model.capitalize}Table extends Migration
+            {
+                public function up()
+                {
+                    Schema::create('#{table_name}', function (Blueprint $table) {
+                        $table->id();
+            #{generate_columns(attributes).map { |col| "\t\t\t#{col};" }.join("\n")}
+                        $table->timestamps();
+                    });
+                }
+
+                public function down()
+                {
+                    Schema::dropIfExists('#{table_name}');
+                }
+            }
+          PHP
+        end
+
+        puts "Generated migration: #{migration_file}"
+      end
+
+      puts "All migrations generated in '#{@migrations_dir}' directory."
+    end
+
+    private
+
+    def load_config(file)
+      case File.extname(file)
+      when '.yaml', '.yml'
+        YAML.load_file(file)
+      when '.json'
+        JSON.parse(File.read(file), symbolize_names: true)
+      else
+        raise "Unsupported file format: #{File.extname(file)}"
+      end
+    end
+
+    def validate_config!
+      unless @config.is_a?(Hash)
+        raise "Invalid configuration: Expected a hash, got #{@config.class}"
+      end
+
+      @config.each do |model, details|
+        unless details.is_a?(Hash)
+          raise "Invalid configuration for model '#{model}': Expected a hash, got #{details.class}"
+        end
+
+        unless details["table_name"]
+          raise "Missing 'table_name' for model '#{model}'"
+        end
+
+        unless details["attributes"]
+          puts "Warning: No 'attributes' found for model '#{model}'"
+        end
+      end
+    end
+
+    def generate_columns(attributes)
+      columns = []
+      attributes.each do |attr, config|
+        type = DATA_TYPE_MAPPING[config["type"]] || 'string'
+        if type == 'enum'
+          columns << "\$table->#{type}('#{attr}', [#{config["enum"].map { |v| "'#{v}'" }.join(', ')}])"
+        elsif config["foreign_key"]
+            columns << "\$table->foreignId('#{attr}')"
+        else
+          column_def = "\$table->#{type}('#{attr}')"
+          column_def += '->unique()' if config["unique"]
+          column_def += '->nullable()' unless config["primary_key"]
+          columns << column_def
+        end
+      end
+      columns
+    end
+  end
+end

data/lib/configurator/version.rb

@@ -0,0 +1,3 @@
+module Configurator
+  VERSION = '1.0.1'
+end

data/lib/configurator.rb

@@ -0,0 +1,3 @@
+require 'configurator/version'
+require 'configurator/cli'
+require 'configurator/generator'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: config-to-laravel-migrations
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Suwilanji Jack Chipofya
+bindir: bin
+cert_chain: []
+date: 2025-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: A command-line tool to generate Laravel Eloquent migrations from YAML
+  or JSON configuration files.
+email:
+- suwilanji@inongo.space
+executables:
+- configurator
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/configurator
+- lib/configurator.rb
+- lib/configurator/cli.rb
+- lib/configurator/generator.rb
+- lib/configurator/version.rb
+homepage: https://github.com/suwi-lanji/configurator
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Generate Laravel migrations from YAML or JSON config files.
+test_files: []