rb-db-setup 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6af744ad5a2ffc7e175c38eeeb461941c0836b8e6b23f2d6be493018214899f0
+  data.tar.gz: f757f955460f894ab0e67bd278345bf5b562f3ecc6d0e110d26ffa434acf4c08
+SHA512:
+  metadata.gz: 0b3ad20c6a45160f633cd91fd4d1f69f8c857341e6d97e9700a810b10fc1ff18d775db701fece66b09355a99620dd183fa838ea6d9471b3e6dc2dfae9c0d7fa4
+  data.tar.gz: 4ee011658c0f273368bfd649812611b7f8d6c14b9e5c46236745515afe353149035120863ea90833c5644104e267eaeccfc8db10714f5ccb8bd27afa1fb2d182

data/README.md

@@ -0,0 +1,127 @@
+# RbDbSetup 🚀
+
+> [!NOTE]
+> This is a **personal scaffolding personal setup** created to automate the database infrastructure for my own Ruby projects. It is tailored for my specific workflow but is open for public use!
+
+## Features
+
+- **Class-Based Seeders**: Organize your seeding logic into clean, reusable classes.
+- **Central Orchestration**: Uses a `DatabaseSeeder.rb` entry point, just like Laravel's `DatabaseSeeder`.
+- **Hardened Migrations**: Automated migration scripts with fail-safe checks and naming consistency.
+- **Convenient Generators**:
+  - `rb-db-setup`: Scaffolds the entire infrastructure.
+  - `ruby make_migration.rb <name>`: Generates sanitized migration templates.
+  - `ruby make_seeder.rb <Name>`: Generates class-based seeder templates.
+- **Atomic Seeding**: Seeding runs within database transactions to ensure data integrity.
+- **Cross-Platform**: Works perfectly on Linux, macOS, and Windows.
+
+## Installation
+
+### Standard Installation
+If you've installed it as a RubyGem:
+```bash
+gem install rb-db-setup
+```
+
+### Alternative: Clone & Run (Local)
+If you have cloned the repository, you can run the tool directly from the project root:
+```bash
+ruby bin/rb-db-setup
+```
+
+### Alternative: Manual Setup (Copy & Run)
+If you just want the logic without installing a gem or cloning the whole repo, you can simply grab the `setup_db_tools.rb` script:
+1. Copy [setup_db_tools.rb](setup_db_tools.rb) to your project.
+2. Run it:
+```bash
+ruby setup_db_tools.rb
+```
+*Note: You can delete the script after it generates the infrastructure.*
+
+### GitHub One-Liner (Fastest)
+Run the latest version directly from GitHub without downloading anything:
+```bash
+ruby -e "$(curl -fsSL https://raw.githubusercontent.com/LanceDanielG/rb-db-scaffold-setup/main/setup_db_tools.rb)"
+```
+
+## Global Local Setup (Command Anywhere)
+
+If you want the `rb-db-setup` command to work in **any folder** on your machine without publishing a gem, use the included installer scripts.
+
+### Linux / macOS
+Run the installer to copy the script to `~/.local/bin` and update your PATH:
+```bash
+bash install.sh && source ~/.bashrc
+```
+
+### Windows (PowerShell)
+Run the PowerShell installer to set up a permanent command and update your User PATH:
+```powershell
+powershell -ExecutionPolicy Bypass -File install.ps1
+```
+
+Once installed, you can simply type `rb-db-setup` in any terminal window.
+
+## Usage
+
+In any new Ruby project folder, simply run:
+```bash
+rb-db-setup
+```
+
+This will automatically create the following structure:
+```text
+.
+├── db/
+│   ├── migrations/      # Your SQL/Sequel migrations
+│   └── seeds/           # Class-based seeder files
+│       └── DatabaseSeeder.rb
+├── migrate.rb           # Hardened migration runner
+├── seed.rb              # Laravel-style seeder runner
+├── make_migration.rb    # Migration generator
+└── make_seeder.rb       # Seeder generator
+```
+
+### Running Migrations
+```bash
+ruby migrate.rb
+```
+
+### Running Seeders
+To run all seeders (via `DatabaseSeeder.rb`):
+```bash
+ruby seed.rb
+```
+
+To run a specific seeder class:
+```bash
+ruby seed.rb AdminSeeder
+```
+
+## Configuration
+
+The generated scripts expect a `DATABASE_URL` environment variable. They automatically handle `.env` files if the `dotenv` gem is present in your project's `Gemfile`.
+
+## Dependencies
+
+The generated infrastructure requires:
+- `sequel`
+- `pg` (or your preferred database driver)
+- `dotenv` (optional but recommended)
+
+## Automated Publishing with GitHub Actions 🤖
+
+I've included a GitHub Action to automate the publishing of this gem to RubyGems.org.
+
+### How to set it up:
+1. **Get your API Key**: Go to [RubyGems.org Settings](https://rubygems.org/profile/edit) and generate a new API key with "Push rubygem" permissions.
+2. **Add to GitHub Secrets**: 
+   - Go to your repository on GitHub.
+   - Click **Settings** > **Secrets and variables** > **Actions**.
+   - Create a **New repository secret** named `RUBYGEMS_API_KEY` and paste your key.
+3. **Trigger a Release**:
+   - Every time you push a **tag** starting with `v` (e.g., `git tag v0.1.0 && git push origin v0.1.0`), GitHub will automatically build and publish the gem for you!
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for more information.

data/bin/rb-db-setup

@@ -0,0 +1,284 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+def create_file(path, content)
+  if File.exist?(path)
+    puts "Skipping: #{path} (already exists)"
+  else
+    File.write(path, content)
+    puts "Created: #{path}"
+  end
+end
+
+puts "--- Ruby Database Infrastructure Scaffolder ---"
+
+# 1. Create Directories
+['db/migrations', 'db/seeds'].each do |dir|
+  unless Dir.exist?(dir)
+    FileUtils.mkdir_p(dir)
+    puts "Created directory: #{dir}"
+  end
+end
+
+# 2. Templates
+MIGRATE_TEMPLATE = <<~RUBY
+  require 'sequel'
+  require 'dotenv'
+  
+  # Load environment variables
+  Dotenv.load if defined?(Dotenv)
+  
+  DATABASE_URL = ENV['DATABASE_URL']
+  MIGRATIONS_DIR = File.expand_path('db/migrations', __dir__)
+  
+  unless DATABASE_URL
+    puts "Error: DATABASE_URL environment variable is not set."
+    exit 1
+  end
+  
+  begin
+    unless Dir.exist?(MIGRATIONS_DIR)
+      puts "Error: Migrations directory not found at \#{MIGRATIONS_DIR}"
+      exit 1
+    end
+  
+    if Dir.empty?(MIGRATIONS_DIR)
+      puts "Warning: Migrations directory is empty. Nothing to do."
+      exit 0
+    end
+  
+    puts "Connecting to database..."
+    DB = Sequel.connect(DATABASE_URL)
+    Sequel.extension :migration
+  
+    # Check for mixed naming styles (Integer vs Timestamp)
+    files = Dir.children(MIGRATIONS_DIR).select { |f| f.end_with?('.rb') }
+    has_integers = files.any? { |f| f =~ /^\\d{3}_/ }
+    has_timestamps = files.any? { |f| f =~ /^\\d{14}_/ }
+  
+    if has_integers && has_timestamps
+      puts "FATAL ERROR: Mixed naming styles detected in db/migrations!"
+      puts "You have both 001_ style and 2026..._ style files."
+      puts "Sequel requires you to use only ONE style. Please delete or rename the timestamped files."
+      exit 1
+    end
+  
+    # This runs the migrator. IntegerMigrator is used by default for 001_ style files.
+    # If a VERSION env var or argument is provided, target that version.
+    target = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+    
+    if target
+      puts "Migrating to version \#{target}..."
+      Sequel::Migrator.run(DB, MIGRATIONS_DIR, target: target)
+    else
+      puts "Migrating to latest version..."
+      Sequel::Migrator.run(DB, MIGRATIONS_DIR)
+    end
+    
+    puts "Database is up to date!"
+  rescue => e
+    puts "Migration failed: \#{e.message}"
+    puts e.backtrace.join("\\n")
+  end
+RUBY
+
+SEED_TEMPLATE = <<~RUBY
+  require 'sequel'
+  require 'dotenv'
+  
+  # Load environment variables
+  Dotenv.load if defined?(Dotenv)
+  
+  DATABASE_URL = ENV['DATABASE_URL']
+  SEEDS_DIR = File.expand_path('db/seeds', __dir__)
+  
+  unless DATABASE_URL
+    puts "Error: DATABASE_URL environment variable is not set."
+    exit 1
+  end
+  
+  # Laravel-style Seeder Runner
+  module SeederRunner
+    def self.call(db, seeder_class_name)
+      # Convert string to class if needed, or handle class directly
+      klass = Object.const_get(seeder_class_name)
+      instance = klass.new
+      instance.run(db)
+    rescue NameError
+      puts "Error: Seeder class '\#{seeder_class_name}' not found."
+    rescue => e
+      puts "Error running seeder '\#{seeder_class_name}': \#{e.message}"
+      puts e.backtrace.join("\\n")
+    end
+  end
+  
+  begin
+    unless Dir.exist?(SEEDS_DIR)
+      puts "Error: Seeds directory not found at \#{SEEDS_DIR}"
+      puts "Creating directory structure..."
+      Dir.mkdir(SEEDS_DIR)
+    end
+  
+    puts "Connecting to database..."
+    DB = Sequel.connect(DATABASE_URL)
+    
+    target_argument = ARGV[0] # Optional: ruby seed.rb UserSeeder
+  
+    DB.transaction do
+      if target_argument
+        # Run a specific seeder class
+        file_path = File.join(SEEDS_DIR, "\#{target_argument}.rb")
+        if File.exist?(file_path)
+          load file_path
+          SeederRunner.call(DB, target_argument)
+        else
+          puts "Error: Seeder file '\#{target_argument}.rb' not found in \#{SEEDS_DIR}"
+          exit 1
+        end
+      else
+        # Default behavior: Run DatabaseSeeder (Laravel style)
+        db_seeder_path = File.join(SEEDS_DIR, "DatabaseSeeder.rb")
+        if File.exist?(db_seeder_path)
+          load db_seeder_path
+          SeederRunner.call(DB, "DatabaseSeeder")
+        else
+          # If no DatabaseSeeder, run all files in the folder (backup behavior)
+          puts "No DatabaseSeeder.rb found. Running all seeders in db/seeds/..."
+          seed_files = Dir.glob(File.join(SEEDS_DIR, '*.rb')).sort
+          seed_files.each do |file|
+            class_name = File.basename(file, '.rb')
+            next if class_name == 'DatabaseSeeder' # prevent double run if it exists but wasn't found (unlikely)
+            load file
+            SeederRunner.call(DB, class_name)
+          end
+        end
+      end
+    end
+    
+    puts "\\nSeeding completed successfully!"
+    
+  rescue => e
+    puts "Seeding failed: \#{e.message}"
+    puts e.backtrace.join("\\n")
+    exit 1
+  end
+RUBY
+
+MAKE_MIGRATION_TEMPLATE = <<~RUBY
+  if ARGV[0].nil?
+    puts "Usage: ruby make_migration.rb <name>"
+    exit 1
+  end
+  
+  migration_name = ARGV[0].gsub(/[^a-zA-Z0-9_]/, '').downcase
+  
+  # Find the next available version number
+  migrations_dir = 'db/migrations'
+  Dir.mkdir(migrations_dir) unless Dir.exist?(migrations_dir)
+  
+  existing_migrations = Dir.children(migrations_dir).select { |f| f =~ /^\\d{3}_/ }
+  max_version = existing_migrations.map { |f| f.split('_').first.to_i }.max || 0
+  next_version = format('%03d', max_version + 1)
+  
+  filename = "\#{migrations_dir}/\#{next_version}_\#{migration_name}.rb"
+  
+  content = <<~TEMPLATE
+    Sequel.migration do
+      up do
+        # create_table(:table_name) do
+        #   primary_key :id
+        # end
+      end
+  
+      down do
+        # drop_table(:table_name)
+      end
+    end
+  TEMPLATE
+  
+  File.write(filename, content)
+  puts "Successfully created: \#{filename}"
+RUBY
+
+MAKE_SEEDER_TEMPLATE = <<~RUBY
+  if ARGV[0].nil?
+    puts "Usage: ruby make_seeder.rb <NameSeeder>"
+    puts "Example: ruby make_seeder.rb InitialRbacSeeder"
+    exit 1
+  end
+  
+  # Sanitize the seeder name (remove non-alphanumeric chars, CamelCase it)
+  seeder_name = ARGV[0].gsub(/[^a-zA-Z0-9_]/, '').split('_').map(&:capitalize).join
+  
+  # Ensure it ends with Seeder for consistency
+  seeder_name += "Seeder" unless seeder_name.end_with?("Seeder")
+  
+  # Ensure the seeds directory exists
+  seeds_dir = 'db/seeds'
+  Dir.mkdir(seeds_dir) unless Dir.exist?(seeds_dir)
+  
+  filename = "\#{seeds_dir}/\#{seeder_name}.rb"
+  
+  if File.exist?(filename)
+    puts "Error: Seeder \#{seeder_name} already exists!"
+    exit 1
+  end
+  
+  content = <<~TEMPLATE
+    class \#{seeder_name}
+      def run(db)
+        puts "Running seeder: \#{seeder_name}..."
+        
+        # Use the db connection passed to insert data
+        # db[:table_name].find_or_create(
+        #   column: 'value'
+        # )
+        
+        puts "Finished seeder: \#{seeder_name}"
+      end
+    end
+  TEMPLATE
+  
+  File.write(filename, content)
+  puts "Successfully created: \#{filename}"
+RUBY
+
+DATABASE_SEEDER_TEMPLATE = <<~RUBY
+  class DatabaseSeeder
+    def run(db)
+      puts "Starting Database Seeder..."
+  
+      # Pattern: run_seeder(db, 'YourSeederName')
+      # run_seeder(db, 'InitialDataSeeder')
+  
+      puts "Database seeding completed!"
+    end
+  
+    private
+  
+    def run_seeder(db, class_name)
+      file_path = File.join(__dir__, "\#{class_name}.rb")
+      if File.exist?(file_path)
+        load file_path
+        klass = Object.const_get(class_name)
+        klass.new.run(db)
+      else
+        puts "Warning: Seeder file '\#{class_name}.rb' not found."
+      end
+    end
+  end
+RUBY
+
+# 3. Write Files
+create_file('migrate.rb', MIGRATE_TEMPLATE)
+create_file('seed.rb', SEED_TEMPLATE)
+create_file('make_migration.rb', MAKE_MIGRATION_TEMPLATE)
+create_file('make_seeder.rb', MAKE_SEEDER_TEMPLATE)
+create_file('db/seeds/DatabaseSeeder.rb', DATABASE_SEEDER_TEMPLATE)
+
+puts "\\nSetup complete! You can now use:"
+puts " - ruby make_migration.rb create_users"
+puts " - ruby make_seeder.rb User"
+puts " - ruby migrate.rb"
+puts " - ruby seed.rb"
+puts "\\nEnsure you have 'sequel' and 'dotenv' gems in your Gemfile."

data/lib/rb_db_setup/version.rb

@@ -0,0 +1,3 @@
+module RbDbSetup
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rb-db-setup
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Lance Daniel Gallos
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Instantly adds hardened Sequel migrations and modular seeders to any
+  Ruby project.
+email:
+- lancedanielgallos4@gmail.com
+executables:
+- rb-db-setup
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/rb-db-setup
+- lib/rb_db_setup/version.rb
+homepage: https://github.com/LanceDanielG/rb-db-scaffold-setup
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/LanceDanielG/rb-db-scaffold-setup
+  source_code_uri: https://github.com/LanceDanielG/rb-db-scaffold-setup
+  changelog_uri: https://github.com/LanceDanielG/rb-db-scaffold-setup/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/LanceDanielG/rb-db-scaffold-setup/issues
+post_install_message:
+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.4.19
+signing_key:
+specification_version: 4
+summary: A Laravel-style database infrastructure scaffolder for Ruby.
+test_files: []