console_kit 1.1.0 → 1.3.0

data/lib/console_kit/tenant_selector.rb

@@ -21,9 +21,12 @@ module ConsoleKit
 
       def attempt_selection
         print_tenant_selection_menu
-        selection = parse_user_selection
-        return :abort if selection == :abort
+        process_selection(parse_user_selection)
+      end
+
+      def process_selection(selection)
         return :retry unless selection
+        return selection if selection == :abort
 
         selection.is_a?(Integer) ? resolve_selection(selection) : selection
       end
@@ -34,8 +37,9 @@ module ConsoleKit
       end
 
       def menu_items
+        tenants = ConsoleKit.tenants.keys
         items = ['0. Skip (load without tenant configuration)']
-        ConsoleKit.tenants.keys.each_with_index do |key, index|
+        tenants.each_with_index.map do |key, index|
           items << "#{index + 1}. #{key} (partner: #{tenant_partner(key)})"
         end
         items
@@ -53,7 +57,7 @@ module ConsoleKit
       end
 
       def find_tenant_by_name(input)
-        match = ConsoleKit.tenants.keys.find { |k| k.to_s.casecmp(input).zero? }
+        match = ConsoleKit.tenants.keys.find { |key| key.to_s.casecmp(input).zero? }
         return match if match
 
         handle_invalid_input("Invalid selection: '#{input}'. Please enter a number or tenant name.")

data/lib/console_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConsoleKit
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

data/lib/console_kit.rb

@@ -44,6 +44,12 @@ module ConsoleKit
       configuration.context_class = val
     end
 
+    def show_dashboard = configuration.show_dashboard
+
+    def show_dashboard=(val)
+      configuration.show_dashboard = val
+    end
+
     def current_tenant = Setup.current_tenant
     def reset_current_tenant = Setup.reset_current_tenant
     def enable_pretty_output = configuration.pretty_output = true

data/lib/generators/console_kit/templates/console_kit.rb

@@ -37,6 +37,10 @@ Rails.application.config.after_initialize do
     # Toggle pretty output on/off (default: true)
     config.pretty_output = true
 
+    # Show connection dashboard on tenant switch (default: false)
+    # When false, use the `dashboard` command in the console to display on-demand
+    # config.show_dashboard = true
+
     if config.tenants.nil?
       warn '[ConsoleKit] Warning: `tenants` is not configured. ' \
            'Please set it in config/initializers/console_kit.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_kit
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Soumyadeep Pal
@@ -10,19 +10,47 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.2.1
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.2.1
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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'
 description: Adds tenant selection to Rails consoles
 email:
 - soumyadeeppal2001@gmail.com
@@ -30,30 +58,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
+- ".DS_Store"
+- ".reek.yml.new"
 - LICENSE.txt
-- README.md
-- SECURITY.md
 - lib/console_kit.rb
 - lib/console_kit/configuration.rb
 - lib/console_kit/connections/base_connection_handler.rb
 - lib/console_kit/connections/connection_manager.rb
+- lib/console_kit/connections/dashboard.rb
+- lib/console_kit/connections/diagnostic_helpers.rb
 - lib/console_kit/connections/elasticsearch_connection_handler.rb
 - lib/console_kit/connections/mongo_connection_handler.rb
 - lib/console_kit/connections/redis_connection_handler.rb
 - lib/console_kit/connections/sql_connection_handler.rb
+- lib/console_kit/connections/table_formatter.rb
+- lib/console_kit/connections/table_renderer.rb
 - lib/console_kit/console_helpers.rb
 - lib/console_kit/output.rb
 - lib/console_kit/prompt.rb
 - lib/console_kit/railtie.rb
 - lib/console_kit/setup.rb
+- lib/console_kit/setup_ui.rb
 - lib/console_kit/tenant_configurator.rb
+- lib/console_kit/tenant_configurator/context_wrapper.rb
+- lib/console_kit/tenant_orchestrator.rb
 - lib/console_kit/tenant_selector.rb
 - lib/console_kit/version.rb
 - lib/generators/console_kit/install_generator.rb
 - lib/generators/console_kit/templates/console_kit.rb
-- sig/console_kit.rbs
 homepage: https://github.com/Soumyadeep-ai/console_kit
 licenses:
 - MIT

data/CHANGELOG.md

@@ -1,109 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-This project adheres to [Semantic Versioning](https://semver.org/).
-
----
-
-## [1.1.0] - 2026-03-14
-### Added
-- **Redis Connection Handler:** Automatic Redis DB selection per tenant via `Redis.current.select`, with graceful fallback for Redis v5+ where `Redis.current` is deprecated.
-- **Elasticsearch Connection Handler:** Sets a per-tenant Elasticsearch index name prefix via thread-local storage and `Elasticsearch::Model.index_name_prefix=` (when available).
-- **Console Helpers:** New `switch_tenant`, `tenant_info`, and `tenants` methods available in the Rails console for quick tenant management.
-- **Custom Console Prompt:** IRB and Pry prompts now display the active tenant name (e.g., `[acme] main:001>`).
-- **Tenant Banner:** On successful tenant initialization, a banner now shows the tenant name, environment safety warnings (production in red, staging in yellow), and a summary of active connections.
-- **Environment Safety Warnings:** Production and staging environments are flagged with color-coded warnings at tenant setup time.
-- New tenant configuration keys: `redis_db`, `elasticsearch_prefix`, and `environment`.
-
-### Changed
-- `TenantConfigurator` now manages `tenant_redis_db` and `tenant_elasticsearch_prefix` context attributes alongside existing ones.
-- Generator template updated with examples for the new configuration keys.
-
----
-
-## [1.0.0] - 2026-03-01
-### Added
-- **Global Configuration Persistence:** ConsoleKit settings now persist across the entire session and across multiple threads.
-- **Isolated Tenant Selection:** Each thread maintains its own tenant selection for safety, while sharing the global configuration.
-- **Seamless Rails Reloading:** Full support for Rails `reload!`; your selected tenant and context are now automatically preserved after code reloads.
-- **Reliable Tenant Switching:** Switching or clearing tenants now correctly resets all database connections (SQL and MongoDB) to their default state.
-- **Flexible Tenant Selection:** Users can now select tenants by typing their names (case-insensitive) in addition to index numbers.
-- **Session Control:** Added support for `exit` or `quit` commands directly at the selection prompt to terminate the console session.
-- **Safe Mode:** Added a "Skip" option (0) to load the console without any tenant configuration.
-- **Improved Configuration Validation:** Enhanced startup checks to provide clearer feedback if the configuration or context class is incorrectly defined.
-- **Custom SQL Base Class:** New configuration option to specify a custom base class for SQL connections.
-
-### Changed
-- **Modernized CLI Interface:** Redesigned the tenant selection menu and prompts for a cleaner, more intuitive user experience.
-- **Enhanced Error Feedback:** Improved messaging for invalid selections and missing configurations.
-- **Optimized Performance:** Refactored internal discovery and configuration logic for better reliability in large applications.
-
-### Fixed
-- Fixed a bug where tenant context was lost after running `reload!` in the Rails console.
-- Fixed an issue where database connections could remain tied to a previous tenant after the context was cleared.
-- Resolved all stability and code quality warnings.
-- Fixed timestamp formatting in console output.
-
----
-
-## [0.1.5] - 2025-10-12
-### Added
-- Minor Bug Fixes
-
----
-
-## [0.1.4] - 2025-09-30
-### Added
-- Minor Fixes and Improvements
-
----
-
-## [0.1.3] - 2025-08-12
-### Added
-- `ConsoleKit.current_tenant` method to retrieve the current tenant at runtime.
-- `ConsoleKit.reset_current_tenant` to reset tenant selection.
-- `pretty_output` configuration added with ability to manually toggle CLI verbosity.
-
-### Changed
-- Refactored internal logic for improved maintainability and future extensibility.
-- Enhanced test coverage for better reliability and edge case handling.
-
----
-
-## [0.1.2] - 2025-07-23
-### Added
-- Changelog added.
-- Readme and installation instructions added.
-
----
-
-## [0.1.1] - 2025-07-21
-### Added
-- Initial generator: `console_kit:install` to scaffold configuration.
-- RSpec test suite to support core features.
-
-### Changed
-- Applied RuboCop fixes for code consistency and style.
-
----
-
-## [0.1.0] - 2025-07-09
-
-- Initial release
-
-### Added
-- Core setup logic for ConsoleKit:
-  - `ConsoleKit.setup`
-  - Tenant selection via CLI.
-  - Tenant-specific database configuration.
-  - Colorized console output for improved UX.
-
-[1.1.0]: https://github.com/Soumyadeep-ai/console_kit/releases/tag/v1.1.0
-[1.0.0]: https://github.com/Soumyadeep-ai/console_kit/releases/tag/v1.0.0
-[0.1.5]: https://github.com/Soumyadeep-ai/console_kit/releases/tag/v0.1.5
-[0.1.4]: https://github.com/Soumyadeep-ai/console_kit/releases/tag/v0.1.4
-[0.1.3]: https://github.com/Soumyadeep-ai/console_kit/releases/tag/v0.1.3
-[0.1.2]: https://github.com/Soumyadeep-ai/console_kit/releases/tag/v0.1.2
-[0.1.1]: https://github.com/Soumyadeep-ai/console_kit/releases/tag/v0.1.1
-[0.1.0]: https://github.com/Soumyadeep-ai/console_kit/releases/tag/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[report here](https://github.com/Soumyadeep-ai/console_kit/issues).
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -1,163 +0,0 @@
-# ConsoleKit
-
-![Gem Version](https://img.shields.io/gem/v/console_kit.svg)
-![Gem Downloads](https://img.shields.io/gem/dt/console_kit.svg)
-![Build Status](https://github.com/Soumyadeep-ai/console_kit/actions/workflows/release.yml/badge.svg)
-![License](https://img.shields.io/github/license/Soumyadeep-ai/console_kit)
-![Ruby](https://img.shields.io/badge/ruby-%3E=3.1.0-red)
-
-A simple and flexible multi-tenant console setup toolkit for Rails applications.
-
-ConsoleKit helps you manage tenant-specific database connections (SQL, MongoDB, Redis, Elasticsearch) and context configuration via an easy CLI interface and Rails integration.
-
-## Installation
-
-Install the gem and add to the application's Gemfile by executing:
-
-```ruby
-bundle add console_kit
-```
-
-Additionally you can also add this line to your application's Gemfile:
-
-```ruby
-gem 'console_kit'
-```
-
-And then execute:
-
-```ruby
-bundle install
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```ruby
-gem install console_kit
-```
-
-## Usage
-
-After installing, generate the initializer and configuration files by running:
-
-```ruby
-rails generate console_kit:install
-```
-
-Then, edit config/initializers/console_kit.rb to define your tenants and context class. Example format:
-
-```ruby
-ConsoleKit.configure do |config|
-  config.tenants = {
-    tenant_one: {
-      constants: {
-        shard: :tenant_one_db,
-        mongo_db: :tenant_one_mongo,
-        partner_code: 'partnerA',
-        redis_db: 1,
-        elasticsearch_prefix: 'tenant_one',
-        environment: 'production'
-      }
-    },
-    tenant_two: {
-      constants: {
-        shard: :tenant_two_db,
-        mongo_db: :tenant_two_mongo,
-        partner_code: 'partnerB',
-        redis_db: 2,
-        elasticsearch_prefix: 'tenant_two',
-        environment: 'staging'
-      }
-    }
-  }
-
-  config.context_class = CurrentContext
-
-  # Optional: Toggle pretty CLI output
-  config.pretty_output = true
-end
-```
-
-## Supported Connections
-
-ConsoleKit automatically detects and manages connections for:
-
-| Connection      | Gem Required    | Config Key               | Behavior                                        |
-|-----------------|-----------------|--------------------------|------------------------------------------------|
-| SQL (ActiveRecord) | `activerecord` | `shard`               | Calls `establish_connection` on your base class |
-| MongoDB         | `mongoid`       | `mongo_db`              | Calls `Mongoid.override_database`              |
-| Redis           | `redis`         | `redis_db`              | Calls `Redis.current.select(db)`               |
-| Elasticsearch   | `elasticsearch` | `elasticsearch_prefix`  | Sets `Elasticsearch::Model.index_name_prefix=` |
-
-Handlers are only activated when their corresponding gem is loaded.
-
-## Console Usage
-
-When launching the Rails console, ConsoleKit will prompt you to select a tenant (if multiple tenants are configured). On selection, a tenant banner is displayed showing the tenant name, environment safety warnings, and active connections.
-
-### Selection Options:
-- **Number or Name:** Select a tenant by its index or name (case-insensitive).
-- **0 (Skip):** Load the console without any tenant configuration.
-- **exit / quit:** Immediately terminate the console session.
-
-### Console Helpers
-
-The following helper methods are available in your Rails console:
-
-```ruby
-# Switch to a different tenant
-switch_tenant
-
-# Print details about the current tenant
-tenant_info
-
-# List all available tenants
-tenants
-```
-
-### Custom Prompt
-
-ConsoleKit automatically sets your IRB/Pry prompt to show the active tenant:
-
-```
-[tenant_one] main:001>
-```
-
-### Other Methods
-
-```ruby
-# Get current tenant
-ConsoleKit.current_tenant
-# => :tenant_one
-
-# Reset and re-select tenant
-ConsoleKit.reset_current_tenant
-
-# Toggle pretty output
-ConsoleKit.enable_pretty_output
-ConsoleKit.disable_pretty_output
-```
-
-### Environment Warnings
-
-When a tenant has an `environment` key in its constants:
-- **production**: A red warning is displayed at setup time.
-- **staging**: A yellow warning is displayed at setup time.
-
-## 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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at [Console Kit](https://github.com/Soumyadeep-ai/console_kit). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Soumyadeep-ai/console_kit/blob/main/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the ConsoleKit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Soumyadeep-ai/console_kit/blob/main/CODE_OF_CONDUCT.md).

data/SECURITY.md

@@ -1,31 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-We do **not maintain multiple supported versions**. Only the latest released version is eligible for security updates.
-
-Once a new version is released, the previous version is branched and locked, and will no longer receive updates — including security patches.
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 1.1.0   | :white_check_mark: |
-| 1.0.0   | :x:                |
-| 0.1.5   | :x:                |
-| 0.1.4   | :x:                |
-| 0.1.3   | :x:                |
-| 0.1.2   | :x:                |
-| 0.1.1   | :x:                |
-| 0.1.0   | :x:                |
-
-## Reporting a Vulnerability
-
-If you discover a security vulnerability, please use the GitHub [Security Advisories](https://github.com/Soumyadeep-ai/console_kit/security/advisories/new) feature to report it privately.
-
-We follow this process:
-- All reported vulnerabilities are reviewed promptly.
-- A new version with security fixes will be released.
-- Once validated, we will publish an advisory and issue a patched release if necessary.
-
-Please avoid disclosing vulnerabilities publicly until we’ve had a chance to review and respond.
-
-For more details, visit [GitHub Docs: Reporting a Vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).

data/sig/console_kit.rbs

@@ -1,4 +0,0 @@
-module ConsoleKit
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end