console_kit 1.1.0 → 1.2.0

data/lib/console_kit/setup.rb

@@ -3,17 +3,13 @@
 require_relative 'tenant_selector'
 require_relative 'tenant_configurator'
 require_relative 'output'
+require_relative 'setup_ui'
 
 # Core Logic for initial Setup
 module ConsoleKit
   # Does the initial setup
   module Setup
     class << self
-      ENVIRONMENT_WARNINGS = {
-        'production' => -> { Output.print_error('WARNING: You are connected to a PRODUCTION environment!') },
-        'staging' => -> { Output.print_warning('You are connected to a staging environment.') }
-      }.freeze
-
       def current_tenant = Thread.current[:console_kit_current_tenant]
 
       def current_tenant=(val)
@@ -32,6 +28,12 @@ module ConsoleKit
       def reset_current_tenant
         return warn_no_tenants unless tenants?
 
+        perform_tenant_reset
+      end
+
+      private
+
+      def perform_tenant_reset
         key = select_tenant_key
         return cancel_switch if key == :abort || key.blank?
 
@@ -41,12 +43,11 @@ module ConsoleKit
         configure(key)
       end
 
-      private
-
       def run_setup
         return if tenant_setup_successful?
 
-        ConsoleKit.configuration.validate!
+        config = ConsoleKit.configuration
+        config.validate!
         select_and_configure
       rescue StandardError => e
         handle_error(e)
@@ -62,12 +63,8 @@ module ConsoleKit
       def handle_selection_result(key)
         exit_on_key if %i[exit abort].include?(key)
 
-        case key
-        when :none
-          Output.print_info('No tenant selected. Loading without tenant configuration.')
-        when nil, ''
-          Output.print_error('Tenant selection failed. Loading without tenant configuration.')
-        end
+        skip_tenant_message if key == :none
+        Output.print_error('Tenant selection failed. Loading without tenant configuration.') if key.blank?
       end
 
       def exit_on_key
@@ -81,48 +78,20 @@ module ConsoleKit
 
         self.current_tenant = key
         Prompt.apply
-        print_tenant_banner(key)
-      end
-
-      def print_tenant_banner(key)
-        constants = ConsoleKit.configuration.tenants[key]&.[](:constants) || {}
-        env = constants[:environment]&.to_s&.downcase
-        Output.print_success("Tenant initialized: #{key}")
-        print_environment_warning(env) if env
-        print_active_connections
-      end
-
-      def print_environment_warning(env) = ENVIRONMENT_WARNINGS[env]&.call
-
-      def print_active_connections
-        names = active_connection_names
-        Output.print_info("Active connections: #{names.join(', ')}") unless names.empty?
-      end
-
-      def active_connection_names
-        ctx = context_class
-        return [] unless ctx
-
-        handlers = ConsoleKit::Connections::ConnectionManager.available_handlers(ctx)
-        handlers.map { |h| h.class.name.demodulize.delete_suffix('ConnectionHandler') }
+        SetupUI.print_tenant_banner(key, ConsoleKit.configuration)
       end
 
       def tenants = ConsoleKit.configuration.tenants
-      def context_class = ConsoleKit.configuration.context_class
       def tenants? = tenants&.any?
-      def no_tenants? = !tenants?
       def select_tenant_key = auto_select? ? tenants.keys.first : TenantSelector.select
-      def auto_select? = single_tenant? || non_interactive?
-      def single_tenant? = tenants.size == 1
-      def non_interactive? = !$stdin.tty?
+      def auto_select? = (tenants.size == 1) || !$stdin.tty?
       def warn_no_tenants = Output.print_warning('Cannot reset tenant: No tenants configured.')
-      def warn_reset = Output.print_warning("Resetting tenant: #{current_tenant}")
       def cancel_switch = Output.print_warning('Tenant switch cancelled.')
       def skip_tenant_message = Output.print_info('No tenant selected. Loading without tenant configuration.')
 
       def clear_current_tenant
         if current_tenant
-          warn_reset
+          Output.print_warning("Resetting tenant: #{current_tenant}")
           TenantConfigurator.clear
         end
         self.current_tenant = nil

data/lib/console_kit/setup_ui.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ConsoleKit
+  # UI helpers for Setup
+  module SetupUI
+    ENVIRONMENT_WARNINGS = {
+      'production' => -> { Output.print_error('!!! CAUTION: YOU ARE IN PRODUCTION ENVIRONMENT !!!') },
+      'staging' => -> { Output.print_warning('CAUTION: You are in staging environment.') }
+    }.freeze
+
+    class << self
+      def print_tenant_banner(key, config)
+        Output.print_success("Tenant initialized: #{key}")
+        print_env_warning(key, config)
+        print_active_connections
+        ConsoleKit::Connections::Dashboard.display if config.show_dashboard
+      end
+
+      private
+
+      def print_env_warning(key, config)
+        constants = config.tenants[key]&.[](:constants) || {}
+        env = constants[:environment]&.to_s&.downcase
+        ENVIRONMENT_WARNINGS[env]&.call if env
+      end
+
+      def print_active_connections
+        ctx = ConsoleKit.configuration.context_class
+        active = Connections::ConnectionManager.available_handlers(ctx).map do |handler|
+          handler.class.name.demodulize.delete_suffix('ConnectionHandler')
+        end
+
+        Output.print_info("Active connections: #{active.join(', ')}") if active.any?
+      end
+    end
+  end
+end

data/lib/console_kit/tenant_configurator.rb

@@ -2,6 +2,7 @@
 
 require_relative 'output'
 require_relative 'connections/connection_manager'
+require_relative 'connections/dashboard'
 
 module ConsoleKit
   # For tenant configuration
@@ -74,11 +75,14 @@ module ConsoleKit
       end
 
       def available_context_attributes(ctx)
-        attributes = %i[partner_identifier]
-        HANDLER_ATTRIBUTES.each do |handler, attr|
-          attributes << attr if handler_available?(handler) && ctx.respond_to?("#{attr}=")
+        attributes = ctx.respond_to?(:partner_identifier=) ? [:partner_identifier] : []
+
+        HANDLER_ATTRIBUTES.each_with_object(attributes) do |(handler, attr), list|
+          next unless ctx.respond_to?("#{attr}=")
+          next unless handler_available?(handler)
+
+          list << attr
         end
-        attributes.select { |attr| ctx.respond_to?("#{attr}=") }
       end
 
       def apply_context(constant)

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.2.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.2.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,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - 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_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