songbird 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4b3d882caf1f2537fe3904c8e24a56fb58b0ac3edb46907f7c183e5afdaf3a9
+  data.tar.gz: dec81593f25440661a062486f6e33b4063642a52d702477b6fadd7547c1b5c15
+SHA512:
+  metadata.gz: ea0a7bcf2c5ac38d28f2f42d0150532cd5eff59aa045e8f8320830158df7d4013c28727659dd89d5a0c2f22e0565be18dd8441c8d077612aba641af8fe3d8dc3
+  data.tar.gz: 9468d3b43d4c1111bbbae0040787769d9fef9d86dc9d06a7a9fed2045d09bf4919b2625b2051230e8ad1fa297bf14f9df343a197ac585f67266aaccacccd7e9a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Elcio Nakashima
+
+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.

data/README.md

@@ -0,0 +1,116 @@
+# 🐦 Songbird
+
+Extract SQL statements from Rails migrations for manual review and execution. Perfect for debugging, review, or manual execution of schema changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'songbird'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it directly:
+
+```bash
+$ gem install songbird
+```
+
+## Usage
+
+Songbird provides Rake tasks that integrate seamlessly with your Rails application to generate SQL for migrations.
+
+### Basic Usage
+
+Generate SQL for a specific migration:
+```bash
+rake db:migrate:sql[20241201000000]
+```
+
+Running the command without a version will show usage instructions and list your three most recent migrations for easy reference.
+
+### Shortcut Commands
+
+Songbird also provides a convenient shortcut command:
+
+```bash
+rake songbird:sql[20241201000000]    # Generate SQL for specific migration
+```
+
+### Output Format
+
+The generated SQL includes helpful comments and proper formatting:
+
+```sql
+-- Generated SQL for pending Rails migrations
+-- Generated at: 2024-12-01 10:30:00 UTC
+
+-- Migration: 20241201000001 - Create users
+-- File: 20241201000001_create_users.rb
+CREATE TABLE "users" (id SERIAL PRIMARY KEY);
+ALTER TABLE "users" ADD COLUMN "name" VARCHAR NOT NULL;
+
+-- Update schema_migrations table:
+INSERT INTO schema_migrations (version) VALUES ('20241201000001');
+
+-- Migration: 20241201000002 - Add email to users
+-- File: 20241201000002_add_email_to_users.rb
+ALTER TABLE "users" ADD COLUMN "email" VARCHAR;
+
+-- Update schema_migrations table:
+INSERT INTO schema_migrations (version) VALUES ('20241201000002');
+```
+
+## Features
+
+- ✅ **Database-Agnostic** - Works with any ActiveRecord-supported database
+- ✅ **Rails Integration** - Works seamlessly with Rails migration system
+- ✅ **Schema Metadata** - Automatically generates `schema_migrations` INSERT statements
+- ✅ **Clean Output Format** - Properly commented SQL ready for database execution
+- ✅ **Specific Migration Support** - Generate SQL for individual migrations by version
+- ✅ **Complete Migration Support** - Supports all Rails migration operations by intercepting at the SQL level
+
+## Use Cases
+
+### Migration Timeouts
+When Rails migrations timeout in production due to long-running operations, they can leave migrations in an incomplete state that requires manual intervention. With Songbird:
+
+1. Run `rake db:migrate:sql[specific_migration_version]` for the failed migration
+2. Execute the generated SQL manually in your database
+3. Resume normal Rails migrations
+
+### Database Review Process
+For organizations requiring DBA approval of schema changes:
+
+1. Generate SQL using Songbird
+2. Submit SQL for review
+3. Execute approved SQL manually
+4. Update `schema_migrations` table
+
+### Complex Migration Debugging
+Debug migration issues by reviewing the generated SQL before execution:
+
+1. Generate SQL to understand what operations will be performed
+2. Identify potential issues (missing indexes, constraint violations, etc.)
+3. Modify migrations as needed
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elciok/songbird.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/songbird/migration_discoverer.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module Songbird
+  class MigrationDiscoverer
+    attr_reader :migrations_path
+
+    def initialize(migrations_path = nil)
+      @migrations_path = migrations_path || default_migrations_path
+    end
+
+    # Get all available migrations
+    def load_all_migrations
+      load_migration_files
+    end
+
+    # Load a specific migration class by version
+    def load_migration_class(version)
+      migration_info = find_migration_by_version_private(version)
+      return nil unless migration_info
+
+      # Load the migration file
+      load migration_info[:filepath]
+      
+      # Get the migration class
+      migration_info[:class_name].constantize
+    end
+    
+    # Find migration info by version
+    def find_migration_by_version(version)
+      find_migration_by_version_private(version)
+    end
+
+    # Check if migrations directory exists
+    def migrations_exist?
+      Dir.exist?(@migrations_path)
+    end
+
+    # Get the path to migrations directory
+    def migrations_path
+      @migrations_path
+    end
+
+    private
+
+    def default_migrations_path
+      if defined?(Rails)
+        # Use Rails' configured migrations paths - this is more accurate than hardcoding
+        # Rails can have multiple migration paths and this gets the primary one
+        ActiveRecord::Migrator.migrations_paths.first || Rails.root.join('db', 'migrate').to_s
+      else
+        File.join(Dir.pwd, 'db', 'migrate')
+      end
+    end
+
+    def load_migration_files
+      return [] unless migrations_exist?
+
+      migration_files = Dir.glob(File.join(@migrations_path, '*.rb')).sort
+      
+      migration_files.map do |filepath|
+        filename = File.basename(filepath, '.rb')
+        version, name = extract_version_and_name(filename)
+        
+        next unless version
+
+        {
+          version: version,
+          name: name,
+          filename: filename,
+          filepath: filepath,
+          class_name: name.camelize
+        }
+      end.compact
+    end
+
+    def extract_version_and_name(filename)
+      # Migration files follow pattern: YYYYMMDDHHMMSS_migration_name.rb
+      if match = filename.match(/\A(\d{14})_(.+)\z/)
+        version = match[1]
+        name = match[2]
+        [version, name]
+      else
+        [nil, nil]
+      end
+    end
+
+    def find_migration_by_version_private(version)
+      all_migrations = load_migration_files
+      all_migrations.find { |m| m[:version] == version.to_s }
+    end
+  end
+end

data/lib/songbird/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Songbird
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../tasks/songbird.rake', __dir__)
+    end
+  end
+end

data/lib/songbird/sql_generator.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require 'ostruct'
+require 'logger'
+require_relative 'migration_discoverer'
+
+module Songbird
+  class SQLGenerator
+    attr_reader :discoverer
+
+    def initialize(migrations_path: nil)
+      @discoverer = MigrationDiscoverer.new(migrations_path)
+    end
+
+    # Process migration request - generate SQL for a specific migration or show usage
+    def process(version: nil, output_format: :raw)
+      unless @discoverer.migrations_exist?
+        raise "Migrations directory not found: #{@discoverer.migrations_path}"
+      end
+
+      if version
+        # Generate SQL for specific migration
+        migration_info = @discoverer.find_migration_by_version(version)
+        if migration_info.nil?
+          return "-- Migration #{version} not found"
+        end
+
+        migration_sql = generate_migration_sql(migration_info)
+        schema_sql = generate_schema_migration_sql(migration_info[:version])
+        sql_statement = format_migration_block(migration_info, migration_sql, schema_sql, output_format)
+
+        case output_format
+        when :commented
+          format_with_comments([sql_statement])
+        else
+          sql_statement
+        end
+      else
+        # Show usage with recent migrations when no version specified
+        recent_migrations = @discoverer.load_all_migrations.last(3)
+
+        usage_text = <<~USAGE
+          -- Songbird: Generate SQL for Rails migrations
+          --
+          -- Usage: rake db:migrate:sql[VERSION]
+          -- Example: rake db:migrate:sql[20241201000001]
+          --
+          -- This will generate the SQL commands for the specified migration
+          -- that you can execute manually in your database.
+        USAGE
+
+        if recent_migrations.any?
+          usage_text += "\n-- Recent migrations:\n"
+          recent_migrations.reverse.each do |migration|
+            name = humanize_migration_name(migration[:name])
+            usage_text += "-- #{migration[:version]} - #{name}\n"
+          end
+        end
+
+        return usage_text
+      end
+    end
+
+    # Generate SQL for a single migration
+    def generate_migration_sql(migration_info)
+      begin
+        migration_class = @discoverer.load_migration_class(migration_info[:version])
+
+        if migration_class.nil?
+          return "-- ERROR: Could not load migration class for #{migration_info[:version]}"
+        end
+
+        # Intercept SQL at the connection execute level
+        captured_sql = []
+        connection = ActiveRecord::Base.connection
+
+        # Store original execute method
+        original_execute = connection.method(:execute)
+
+        # Override execute to capture SQL
+        connection.define_singleton_method(:execute) do |sql, name = nil|
+          captured_sql << sql.to_s
+          # Return empty result to prevent actual execution
+          ActiveRecord::Result.new([], [])
+        end
+
+        # Suppress Rails migration logging
+        original_verbose = ActiveRecord::Migration.verbose
+        original_logger = ActiveRecord::Base.logger
+
+        ActiveRecord::Migration.verbose = false
+        ActiveRecord::Base.logger = Logger.new(IO::NULL)
+
+        # Run the migration to generate SQL
+        migration_instance = migration_class.new
+        migration_instance.migrate(:up)
+
+        # Format captured SQL
+        if captured_sql.empty?
+          "-- No SQL statements captured for migration #{migration_info[:version]}"
+        else
+          captured_sql.map { |sql| format_sql_statement(sql) }.join("\n")
+        end
+
+      rescue => e
+        "-- ERROR in migration #{migration_info[:version]}: #{e.message}"
+      ensure
+        # Restore original execute method and logging
+        if connection && original_execute
+          connection.define_singleton_method(:execute, original_execute)
+        end
+
+        if defined?(original_verbose)
+          ActiveRecord::Migration.verbose = original_verbose
+        end
+
+        if defined?(original_logger)
+          ActiveRecord::Base.logger = original_logger
+        end
+      end
+    end
+
+    # Generate the schema_migrations INSERT statement
+    def generate_schema_migration_sql(version)
+      result_sql = nil
+      if defined?(ActiveRecord::SchemaMigration)
+        begin
+          # Create SchemaMigration instance with connection pool
+          pool = ActiveRecord::Tasks::DatabaseTasks.migration_connection_pool
+          schema_migration = ActiveRecord::SchemaMigration.new(pool)
+
+          # Use the instance's arel_table and replicate Rails' create_version logic
+          arel_table = schema_migration.arel_table
+          insert_manager = Arel::InsertManager.new(arel_table)
+          insert_manager.insert(arel_table[schema_migration.primary_key] => version)
+          result_sql = insert_manager.to_sql
+        rescue => e
+          puts "-- Using default INSERT command after error generating schema migration SQL: #{e.message}."
+          result_sql = nil
+        end
+      else
+        result_sql = nil
+      end
+      if result_sql.nil?
+        # Fallback
+        result_sql = "INSERT INTO schema_migrations (version) VALUES ('#{version}')"
+      end
+      result_sql
+    end
+
+
+    private
+
+    def format_sql_statement(sql)
+      # Clean up and format SQL statement
+      formatted = sql.to_s.strip
+      formatted = formatted.gsub(/\s+/, ' ') # Normalize whitespace
+      formatted += ';' unless formatted.end_with?(';')
+      formatted
+    end
+
+    def format_migration_block(migration_info, migration_sql, schema_sql, format)
+      case format
+      when :commented
+        [
+          "-- Migration: #{migration_info[:version]} - #{migration_info[:name].humanize}",
+          "-- File: #{migration_info[:filename]}.rb",
+          migration_sql,
+          "",
+          "-- Update schema_migrations table:",
+          "#{schema_sql};"
+        ].join("\n")
+      else
+        [
+          migration_sql,
+          "#{schema_sql};"
+        ].join("\n")
+      end
+    end
+
+    def format_with_comments(sql_statements)
+      [
+        "-- Generated SQL for pending Rails migrations",
+        "-- Generated at: #{Time.current}",
+        "",
+        sql_statements.join("\n\n")
+      ].join("\n")
+    end
+
+    def humanize_migration_name(name)
+      # Convert migration name from snake_case to human readable
+      name.tr('_', ' ').split.map(&:capitalize).join(' ')
+    end
+
+  end
+end

data/lib/songbird/version.rb

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

data/lib/songbird.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "songbird/version"
+require_relative "songbird/migration_discoverer"
+require_relative "songbird/sql_generator"
+
+if defined?(Rails)
+  require_relative "songbird/railtie"
+end
+
+module Songbird
+  class Error < StandardError; end
+  
+  # Main entry point for the gem
+  def self.generate_sql(version: nil, migrations_path: nil, output_format: :raw)
+    generator = SQLGenerator.new(
+      migrations_path: migrations_path
+    )
+    
+    generator.process(
+      version: version,
+      output_format: output_format
+    )
+  end
+  
+end

data/lib/tasks/songbird.rake

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'songbird'
+
+namespace :db do
+  namespace :migrate do
+    desc 'Generate SQL for migrations'
+    task :sql, [:version, :migrations_path] => :environment do |task, args|
+      begin
+        # Create SQL generator
+        generator = Songbird::SQLGenerator.new(
+          migrations_path: args[:migrations_path]
+        )
+
+        version = args[:version]
+
+        sql_output = generator.process(
+          version: version,
+          output_format: :commented
+        )
+
+        puts sql_output
+
+      rescue => e
+        puts "Error generating migration SQL: #{e.message}"
+        puts e.backtrace.first(5).join("\n") if ENV['DEBUG']
+        exit 1
+      end
+    end
+
+
+  end
+end
+
+# Add helpful shortcuts
+namespace :songbird do
+  desc 'Show SQL commands for migrations (shortcut)'
+  task :sql, [:version, :migrations_path] => 'db:migrate:sql'
+
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: songbird
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elcio Nakashima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Extract SQL statements from Rails migrations for manual review and execution.
+  Perfect for debugging, review, or manual execution of schema changes.
+email:
+- elciok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/songbird.rb
+- lib/songbird/migration_discoverer.rb
+- lib/songbird/railtie.rb
+- lib/songbird/sql_generator.rb
+- lib/songbird/version.rb
+- lib/tasks/songbird.rake
+homepage: https://github.com/elciok/songbird
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/elciok/songbird
+  source_code_uri: https://github.com/elciok/songbird
+  changelog_uri: https://github.com/elciok/songbird/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: Extract SQL statements from Rails migrations for manual review and execution.
+test_files: []