dbrunner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bf5a4c41deeb515230a7178d9ae3bb1876e8fffef64932d4911005d3e1fa76c
+  data.tar.gz: '020932585333a7a27deb2a7fba7d18503ae29c2e02ef447966ac2a687ffcfc69'
+SHA512:
+  metadata.gz: 153fc5bd1f58f7faee1b36e0da8111b5a9dffb48e7244f950794fbafe3d0f0888d2f3a008588f47e6d147fe98fb8bf8c12bcde618a86ea07598453d99969ff4d
+  data.tar.gz: 2c5354a75b3e0860cc9c2f5eb8653666641f9e51b1cdea20b8dfe44a812a2efb9c261ffc46221c2d290d5179cdb927c89632e1070a919fd353eb88257a9e6ba8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Josh Brody
+
+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,74 @@
+# dbrunner
+
+`rails dbrunner` — run SQL like `rails runner` runs Ruby.
+
+Rails has `runner`, `console`, and `dbconsole`. Now it has `dbrunner`.
+
+## Install
+
+```ruby
+gem "dbrunner"
+```
+
+## Usage
+
+```bash
+# inline SQL
+bin/rails dbrunner "SELECT * FROM users LIMIT 5"
+
+# from a file
+bin/rails dbrunner query.sql
+
+# from stdin
+echo "SELECT 1" | bin/rails dbrunner -
+
+# JSON output
+bin/rails dbrunner -f json "SELECT * FROM users LIMIT 5"
+
+# CSV output
+bin/rails dbrunner -f csv "SELECT * FROM users"
+
+# specific database (multi-db)
+bin/rails dbrunner --db secondary "SELECT 1"
+
+# specific environment
+bin/rails dbrunner -e production "SELECT count(*) FROM users"
+```
+
+## Output formats
+
+**Table** (default):
+
+```
+id | email              | created_at
+---+--------------------+--------------------------
+1  | alice@example.com  | 2026-01-15 08:30:00 UTC
+2  | bob@example.com    | 2026-02-20 14:15:00 UTC
+
+2 row(s)
+```
+
+**JSON** (`-f json`):
+
+```json
+[
+  { "id": 1, "email": "alice@example.com" },
+  { "id": 2, "email": "bob@example.com" }
+]
+```
+
+**CSV** (`-f csv`):
+
+```
+id,email
+1,alice@example.com
+2,bob@example.com
+```
+
+## How it works
+
+The gem registers a Rails command at `rails/commands/dbrunner/dbrunner_command.rb`. Rails discovers it automatically through its command lookup paths — no railtie or initializer needed. It uses `ActiveRecord::Base.lease_connection` to execute queries through your existing database configuration.
+
+## License
+
+MIT

data/lib/dbrunner/version.rb

@@ -0,0 +1,3 @@
+module Dbrunner
+  VERSION = "0.1.0"
+end

data/lib/dbrunner.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "dbrunner/version"

data/lib/rails/commands/dbrunner/dbrunner_command.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require "rails/command/environment_argument"
+
+module Rails
+  module Command
+    class DbrunnerCommand < Base # :nodoc:
+      include EnvironmentArgument
+
+      class_option :database, aliases: "--db", type: :string,
+        desc: "Specify the database to use."
+
+      class_option :format, aliases: "-f", type: :string, enum: %w[table csv json], default: "table",
+        desc: "Output format (table, csv, json)"
+
+      desc "dbrunner [<'SQL'> | <filename.sql> | -]",
+        "Run SQL in the context of your database"
+      def perform(sql_or_file = nil, *)
+        unless sql_or_file
+          help
+          exit 1
+        end
+
+        if respond_to?(:boot_application!, true)
+          boot_application!
+        else
+          require_application_and_environment!
+        end
+
+        sql = resolve_sql(sql_or_file)
+        connection = resolve_connection
+
+        begin
+          result = connection.exec_query(sql)
+        rescue ::ActiveRecord::StatementInvalid => e
+          error e.message
+          exit 1
+        end
+
+        if result.columns.any?
+          render(result)
+        else
+          say "#{result.rows.length} row(s) affected"
+        end
+      end
+
+      private
+        def resolve_sql(sql_or_file)
+          if sql_or_file == "-"
+            $stdin.read
+          elsif File.exist?(sql_or_file)
+            File.read(sql_or_file)
+          else
+            sql_or_file
+          end
+        end
+
+        def resolve_connection
+          require APP_PATH
+          ::ActiveRecord::Base.configurations = ::Rails.application.config.database_configuration
+
+          env = ::Rails::Command.environment
+
+          if options[:database]
+            configs_for_options = { env_name: env, name: options[:database] }
+            configs_for_options[:include_hidden] = true if Gem::Version.new(::ActiveRecord::VERSION::STRING) >= Gem::Version.new("7.1")
+            db_config = ::ActiveRecord::Base.configurations.configs_for(**configs_for_options)
+
+            unless db_config
+              raise ::ActiveRecord::AdapterNotSpecified,
+                "'#{options[:database]}' database is not configured for '#{env}'."
+            end
+          else
+            db_config = ::ActiveRecord::Base.configurations.find_db_config(env)
+
+            unless db_config
+              raise ::ActiveRecord::AdapterNotSpecified,
+                "No database configured for '#{env}'."
+            end
+          end
+
+          ::ActiveRecord::Base.establish_connection(db_config)
+
+          if ::ActiveRecord::Base.respond_to?(:lease_connection)
+            ::ActiveRecord::Base.lease_connection
+          else
+            ::ActiveRecord::Base.connection
+          end
+        end
+
+        def render(result)
+          case options[:format]
+          when "json"
+            render_json(result)
+          when "csv"
+            render_csv(result)
+          else
+            render_table(result)
+          end
+        end
+
+        def render_json(result)
+          require "json"
+          rows = result.rows.map { |row| result.columns.zip(row).to_h }
+          say JSON.pretty_generate(rows)
+        end
+
+        def render_csv(result)
+          require "csv"
+          say CSV.generate { |csv|
+            csv << result.columns
+            result.rows.each { |row| csv << row }
+          }
+        end
+
+        def render_table(result)
+          columns = result.columns
+          rows = result.rows.map { |row| row.map { |v| v.nil? ? "NULL" : v.to_s } }
+
+          widths = columns.each_with_index.map do |col, i|
+            [col.length, *rows.map { |r| r[i].length }].max
+          end
+
+          header = columns.each_with_index.map { |col, i| col.ljust(widths[i]) }.join(" | ")
+          separator = widths.map { |w| "-" * w }.join("-+-")
+
+          say header
+          say separator
+          rows.each do |row|
+            say row.each_with_index.map { |val, i| val.ljust(widths[i]) }.join(" | ")
+          end
+          say ""
+          say "#{rows.length} row(s)"
+        end
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: dbrunner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Brody
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: Adds a `rails dbrunner` command that executes SQL against your database.
+  Accepts inline SQL, .sql files, or stdin. Outputs as table, CSV, or JSON.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/dbrunner.rb
+- lib/dbrunner/version.rb
+- lib/rails/commands/dbrunner/dbrunner_command.rb
+homepage: https://github.com/joshmn/dbrunner
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.1
+specification_version: 4
+summary: rails dbrunner — run SQL like rails runner runs Ruby
+test_files: []