all-dat-base 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c2b11162bf07161b5bb121db4a7c677f9b161e75736c3f135a4e3e9e4e502bd
+  data.tar.gz: 032e1731b6a02e5f06568eb6bf1da7a402f67c6ff1879db1f36aedb46bd9bcca
+SHA512:
+  metadata.gz: bbe0d03ee649d8265b3a190977262873208fbf15dd2446ac4a118e028e876b93db161808f982cb546e0af6df588bdd48df7d05b2c18e185568e27bb131dcd58d
+  data.tar.gz: 350b8b76d4180ca77be77d745564d4d25692e7cc226640601ad81be9cc2b36c0c36655af12ce6042a7131dd00afea77313db0691e0a88adefd639ab8bbda2034

data/README.md

@@ -0,0 +1,117 @@
+# All About Dat Base 🚀
+
+A Rails generator that makes connecting your Rails application to Supabase database as easy as running one command!
+
+## Features
+
+- 🎯 Interactive environment selection (Development, Production, or Both)
+- 🔐 Uses Rails encrypted credentials (no dotenv needed)
+- 📝 Automatically configures `database.yml`
+- 🎨 Beautiful CLI with arrow key navigation
+- 📋 Clear step-by-step instructions
+- 🔄 Preserves multi-database setup for production
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'all-about-dat-base'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Run the generator in your Rails application:
+
+```bash
+bin/rails new-base:install
+```
+
+The generator will:
+
+1. **Ask you which environments to configure** - Use arrow keys to select:
+   - Development only
+   - Production only  
+   - Both development and production
+
+2. **Update your `database.yml`** with the appropriate Supabase configuration
+
+3. **Provide clear instructions** for setting up your Rails credentials
+
+## What it does
+
+### Database Configuration
+
+The generator updates your `config/database.yml` to use Rails credentials:
+
+```yaml
+development:
+  <<: *default
+  url: <%= Rails.application.credentials.database_url %>
+
+production:
+  primary: &primary_production
+    <<: *default
+    url: <%= Rails.application.credentials.database_url %>
+  # ... preserves your multi-database setup
+```
+
+### Credentials Setup
+
+After running the generator, you'll get instructions to:
+
+1. Edit your Rails credentials:
+   ```bash
+   EDITOR="code --wait" rails credentials:edit
+   ```
+
+2. Add your Supabase connection string:
+   ```yaml
+   # Database configuration
+   database_url: postgresql://postgres.your-ref:[YOUR-PASSWORD]@aws-0-region.pooler.supabase.com:6543/postgres
+   ```
+
+## Getting Your Supabase Connection String
+
+1. Go to [Supabase Dashboard](https://supabase.com/dashboard)
+2. Select your project
+3. Navigate to: **Settings → Database**
+4. Find **"Connection string"** section
+5. Select **"Transaction pooler"** (recommended)
+6. Copy the connection string
+
+## Benefits
+
+- ✅ **No dotenv gem needed** - Uses Rails built-in encrypted credentials
+- ✅ **Same database everywhere** - Perfect for development with production data
+- ✅ **Regular Rails commands** - No prefixes needed: `rails g model`, `rails db:migrate`
+- ✅ **Secure** - Credentials are encrypted and safe for version control
+- ✅ **Multi-database support** - Preserves your production cache/queue/cable databases
+
+## Testing Your Setup
+
+After configuration, test your connection:
+
+```bash
+rails db:version
+rails console
+# Then: ActiveRecord::Base.connection.execute('SELECT version()').first
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/all-about-dat-base.
+
+## 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,5 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+task default: :spec

data/all-dat-base.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/all-dat-base/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "all-dat-base"
+  spec.version = AllDatBase::VERSION
+  spec.authors = ["kungsamu"]
+  spec.email = ["skung89@gmail.com"]
+
+  spec.summary = "Rails generator for easy Supabase database configuration"
+  spec.description = "A Rails generator that provides interactive setup for Supabase database configuration with environment selection and credential management."
+  spec.homepage = "https://github.com/thebaowarrior/all-dat-base-gem"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z 2>/dev/null`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Dependencies
+  spec.add_dependency "rails", ">= 6.0"
+  spec.add_dependency "tty-prompt", "~> 0.23"
+  
+  # Development dependencies
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

data/lib/all-dat-base/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AllDatBase
+  VERSION = "0.1.0"
+end

data/lib/all-dat-base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "all-dat-base/version"
+
+module AllDatBase
+  class Error < StandardError; end
+
+  # Main module for the All Dat Base gem
+  # Provides Rails generators for Supabase database configuration
+end
+
+# Load Rails generators if Rails is available
+if defined?(Rails)
+  require_relative "generators/new_base/install/install_generator"
+end

data/lib/generators/new_base/install/install_generator.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'tty-prompt'
+
+module NewBase
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Configure your Rails application to use Supabase database"
+      
+      source_root File.expand_path('templates', __dir__)
+      
+      def install_supabase_config
+        say "🚀 Welcome to All About Dat Base - Supabase Configuration Generator!", :green
+        say ""
+        
+        # Interactive environment selection
+        prompt = TTY::Prompt.new
+        
+        environment_choice = prompt.select(
+          "Which environments do you want to configure for Supabase?",
+          [
+            { name: "Development only", value: :development },
+            { name: "Production only", value: :production },
+            { name: "Both development and production", value: :both }
+          ],
+          symbols: { marker: "❯" }
+        )
+        
+        say ""
+        say "📝 Configuring database.yml for #{environment_choice}...", :blue
+        
+        # Generate database.yml based on selection
+        generate_database_config(environment_choice)
+        
+        say ""
+        say "✅ Database configuration updated!", :green
+        say ""
+        
+        # Provide credentials instructions
+        show_credentials_instructions
+      end
+      
+      private
+      
+      def generate_database_config(environment_choice)
+        # Read existing database.yml or create new one
+        database_yml_path = Rails.root.join('config', 'database.yml')
+        
+        if File.exist?(database_yml_path)
+          say "📄 Backing up existing database.yml to database.yml.backup", :yellow
+          FileUtils.cp(database_yml_path, "#{database_yml_path}.backup")
+        end
+        
+        # Generate new database.yml
+        template_content = generate_database_yml_content(environment_choice)
+        
+        File.write(database_yml_path, template_content)
+        say "📝 Updated config/database.yml", :green
+      end
+      
+      def generate_database_yml_content(environment_choice)
+        content = <<~YAML
+          # PostgreSQL configuration for Supabase
+          # Generated by All About Dat Base gem
+          
+          default: &default
+            adapter: postgresql
+            encoding: unicode
+            pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+
+        YAML
+        
+        case environment_choice
+        when :development
+          content += development_config + test_config_local + production_config_local
+        when :production
+          content += development_config_local + test_config_local + production_config
+        when :both
+          content += development_config + test_config + production_config
+        end
+        
+        content
+      end
+      
+      def development_config
+        <<~YAML
+          development:
+            <<: *default
+            url: <%= Rails.application.credentials.database_url %>
+
+        YAML
+      end
+      
+      def development_config_local
+        <<~YAML
+          development:
+            <<: *default
+            database: #{Rails.application.class.module_parent_name.underscore}_development
+
+        YAML
+      end
+      
+      def test_config
+        <<~YAML
+          test:
+            <<: *default
+            url: <%= Rails.application.credentials.database_url %>
+
+        YAML
+      end
+      
+      def test_config_local
+        <<~YAML
+          test:
+            <<: *default
+            database: #{Rails.application.class.module_parent_name.underscore}_test
+
+        YAML
+      end
+      
+      def production_config
+        <<~YAML
+          production:
+            primary: &primary_production
+              <<: *default
+              url: <%= Rails.application.credentials.database_url %>
+            cache:
+              <<: *primary_production
+              database: #{Rails.application.class.module_parent_name.underscore}_production_cache
+              migrations_paths: db/cache_migrate
+            queue:
+              <<: *primary_production
+              database: #{Rails.application.class.module_parent_name.underscore}_production_queue
+              migrations_paths: db/queue_migrate
+            cable:
+              <<: *primary_production
+              database: #{Rails.application.class.module_parent_name.underscore}_production_cable
+              migrations_paths: db/cable_migrate
+        YAML
+      end
+      
+      def production_config_local
+        <<~YAML
+          production:
+            primary: &primary_production
+              <<: *default
+              database: #{Rails.application.class.module_parent_name.underscore}_production
+              username: #{Rails.application.class.module_parent_name.underscore}
+              password: <%= ENV["#{Rails.application.class.module_parent_name.underscore.upcase}_DATABASE_PASSWORD"] %>
+            cache:
+              <<: *primary_production
+              database: #{Rails.application.class.module_parent_name.underscore}_production_cache
+              migrations_paths: db/cache_migrate
+            queue:
+              <<: *primary_production
+              database: #{Rails.application.class.module_parent_name.underscore}_production_queue
+              migrations_paths: db/queue_migrate
+            cable:
+              <<: *primary_production
+              database: #{Rails.application.class.module_parent_name.underscore}_production_cable
+              migrations_paths: db/cable_migrate
+        YAML
+      end
+      
+      def show_credentials_instructions
+        say "🔐 NEXT STEP: Configure your Rails credentials", :cyan
+        say "=" * 60, :cyan
+        say ""
+        say "1. Run this command to edit your Rails credentials:", :white
+        say ""
+        say "   EDITOR=\"code --wait\" rails credentials:edit", :yellow
+        say ""
+        say "2. Copy and paste this into your credentials file:", :white
+        say ""
+        say "   # Database configuration", :green
+        say "   database_url: postgresql://postgres.clwfpjefrgrnzqnaxnlk:[YOUR-PASSWORD]@aws-1-ap-southeast-1.pooler.supabase.com:6543/postgres", :green
+        say ""
+        say "3. Replace [YOUR-PASSWORD] with your actual Supabase password", :white
+        say ""
+        say "4. Make sure to URL-encode special characters in your password:", :white
+        say "   @ becomes %40", :yellow
+        say "   # becomes %23", :yellow
+        say "   & becomes %26", :yellow
+        say ""
+        say "5. Get your connection string from:", :white
+        say "   • Supabase Dashboard → Settings → Database", :blue
+        say "   • Select 'Transaction pooler' (recommended)", :blue
+        say ""
+        say "6. Test your connection:", :white
+        say "   rails db:version", :yellow
+        say ""
+        say "🎉 You're all set! Your Rails app is now configured for Supabase!", :green
+        say "=" * 60, :cyan
+        say ""
+        say "💡 Pro tip: You can run this generator again anytime with:", :blue
+        say "   bin/rails generate new_base:install", :yellow
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: all-dat-base
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kungsamu
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A Rails generator that provides interactive setup for Supabase database
+  configuration with environment selection and credential management.
+email:
+- skung89@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- all-dat-base.gemspec
+- lib/all-dat-base.rb
+- lib/all-dat-base/version.rb
+- lib/generators/new_base/install/install_generator.rb
+homepage: https://github.com/thebaowarrior/all-dat-base-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thebaowarrior/all-dat-base-gem
+  source_code_uri: https://github.com/thebaowarrior/all-dat-base-gem
+  changelog_uri: https://github.com/thebaowarrior/all-dat-base-gem/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Rails generator for easy Supabase database configuration
+test_files: []