slash_console 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce5c167ad7075f34ff8836dc4542fc2a94c21d3c68e2097d355efa04be522b36
+  data.tar.gz: 46dcff4326683797e0b8a5b988cf79de48a3c23f74acd337588f52fca9e99cc4
+SHA512:
+  metadata.gz: 12eaf5f35101ebd8c2f5e8aa0090fd7d45add33cae544d5f94801c22236d078a70f860a8512b41e65df17c32a80326129fa570b4d4b19746264ede8a7cc332b8
+  data.tar.gz: d63d18e2a67194c9bea7af62dfc4ca2b8d7c2ca61120c1955d35ac80f931821ceb7d159b111f2e8b332d8f3ada8a5ba44359903443a957275fd70987ff953620

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2025 FIRSTDRAFT, LLC
+
+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,95 @@
+# SlashConsole
+
+A Rails engine that provides a web-based console interface at `/rails/console`, allowing easy access to a Rails console in both development and production environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "slash_console"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+That's it! Navigate to `/rails/console` in your browser.
+
+## Usage
+
+### Development
+
+In development, no authentication is required. Simply visit:
+
+```
+http://localhost:3000/rails/console
+```
+
+### Production
+
+For production use, authentication is **required**. Set these environment variables:
+
+```bash
+ADMIN_USERNAME="choose_your_own_username"
+ADMIN_PASSWORD="choose_your_own_strong_password"
+```
+
+Without these environment variables, you'll see an error message explaining what needs to be configured.
+
+⚠️ **Security Warning**: This gem provides direct access to your Rails console. In production:
+
+- Only use for applications where the security trade-offs are acceptable. Basically, only for toy apps; never where real user data is at risk. For serious apps, SSH into the server and run `rails console` at the command-line.
+- Make up a strong, unique `ADMIN_PASSWORD` for each app.
+
+## How It Works
+
+SlashConsole is a lightweight wrapper around the excellent `web-console` gem. It:
+
+1. Provides a dedicated route for console access (instead of only on error pages).
+2. Renders a full-page console interface.
+3. Uses basic authentication when in production.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Running Tests
+
+```bash
+bundle exec rake test
+```
+
+### Linting
+
+This project uses [Standard](https://github.com/standardrb/standard) for Ruby style:
+
+```bash
+bundle exec standardrb
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/firstdraft/slash_console.
+
+### Development Setup
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes
+4. Run tests and linting
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Acknowledgments
+
+This gem is built on top of the [web-console](https://github.com/rails/web-console) gem. Many thanks to the Rails team and web-console contributors for their excellent work.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/stylesheets/slash_console/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/slash_console/application_controller.rb

@@ -0,0 +1,4 @@
+module SlashConsole
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/slash_console/console_controller.rb

@@ -0,0 +1,31 @@
+module SlashConsole
+  class ConsoleController < ApplicationController
+    layout false
+
+    skip_before_action :verify_authenticity_token, if: -> { defined?(verify_authenticity_token) }
+
+    before_action :ensure_credentials_configured, if: -> { Rails.env.production? }
+    before_action :authenticate_user, if: -> { Rails.env.production? }
+
+    def index
+      console
+      render :index
+    end
+
+    private
+
+    def ensure_credentials_configured
+      if ENV["ADMIN_USERNAME"].blank? || ENV["ADMIN_PASSWORD"].blank?
+        render plain: 'Before you can access the console, you must set environment variables called "ADMIN_USERNAME" and "ADMIN_PASSWORD".',
+          status: :service_unavailable
+      end
+    end
+
+    def authenticate_user
+      authenticate_or_request_with_http_basic("Rails Console") do |username, password|
+        ActiveSupport::SecurityUtils.secure_compare(username, ENV["ADMIN_USERNAME"]) &&
+          ActiveSupport::SecurityUtils.secure_compare(password, ENV["ADMIN_PASSWORD"])
+      end
+    end
+  end
+end

data/app/views/layouts/slash_console/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Slash console</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "slash_console/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/slash_console/console/index.html.erb

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails Console</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+    html, body {
+      height: 100%;
+      margin: 0;
+      padding: 0;
+      overflow: hidden;
+    }
+
+    /* Hide all content - console will fill the page */
+    body > * {
+      display: none !important;
+    }
+
+    /* Ensure the web-console div fills the entire viewport */
+    #console {
+      display: block !important;
+      position: fixed !important;
+      top: 0 !important;
+      left: 0 !important;
+      right: 0 !important;
+      bottom: 0 !important;
+      width: 100vw !important;
+      height: 100vh !important;
+      z-index: 999999 !important;
+    }
+  </style>
+</head>
+<body>
+  <!-- The console helper will inject the web-console here -->
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+SlashConsole::Engine.routes.draw do
+  get "console" => "console#index", :as => :console
+  root to: "console#index"
+end

data/lib/slash_console/engine.rb

@@ -0,0 +1,11 @@
+module SlashConsole
+  class Engine < ::Rails::Engine
+    isolate_namespace SlashConsole
+
+    initializer "slash_console.mount_engine" do |app|
+      app.routes.prepend do
+        mount SlashConsole::Engine => "/rails", :as => :slash_console_engine
+      end
+    end
+  end
+end

data/lib/slash_console/version.rb

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

data/lib/slash_console.rb

@@ -0,0 +1,6 @@
+require "slash_console/version"
+require "slash_console/engine"
+require "web-console"
+
+module SlashConsole
+end

data/lib/tasks/slash_console_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :slash_console do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: slash_console
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Raghu Betina
+bindir: bin
+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: '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: web-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Rails engine that provides a web-based console interface at /rails/console,
+  with production authentication support.
+email:
+- raghu@firstdraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/slash_console/application.css
+- app/controllers/slash_console/application_controller.rb
+- app/controllers/slash_console/console_controller.rb
+- app/views/layouts/slash_console/application.html.erb
+- app/views/slash_console/console/index.html.erb
+- config/routes.rb
+- lib/slash_console.rb
+- lib/slash_console/engine.rb
+- lib/slash_console/version.rb
+- lib/tasks/slash_console_tasks.rake
+homepage: https://github.com/firstdraft/slash_console
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/firstdraft/slash_console
+  source_code_uri: https://github.com/firstdraft/slash_console
+  changelog_uri: https://github.com/firstdraft/slash_console/blob/main/CHANGELOG.md
+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.7.1
+specification_version: 4
+summary: Mountable Rails console at /rails/console
+test_files: []